<?php

/**

 * Filesystem API: Top-level functionality

 *

 * Functions for reading, writing, modifying, and deleting files on the file system.

 * Includes functionality for theme-specific files as well as operations for uploading,

 * archiving, and rendering output when necessary.

 *

 * @package WordPress

 * @subpackage Filesystem

 * @since 2.3.0

 */

/** The descriptions for theme files. */

$wp_file_descriptions = array(

	'functions.php'         => __( 'Theme Functions' ),

	'header.php'            => __( 'Theme Header' ),

	'footer.php'            => __( 'Theme Footer' ),

	'sidebar.php'           => __( 'Sidebar' ),

	'comments.php'          => __( 'Comments' ),

	'searchform.php'        => __( 'Search Form' ),

	'404.php'               => __( '404 Template' ),

	'link.php'              => __( 'Links Template' ),

	// Archives.

	'index.php'             => __( 'Main Index Template' ),

	'archive.php'           => __( 'Archives' ),

	'author.php'            => __( 'Author Template' ),

	'taxonomy.php'          => __( 'Taxonomy Template' ),

	'category.php'          => __( 'Category Template' ),

	'tag.php'               => __( 'Tag Template' ),

	'home.php'              => __( 'Posts Page' ),

	'search.php'            => __( 'Search Results' ),

	'date.php'              => __( 'Date Template' ),

	// Content.

	'singular.php'          => __( 'Singular Template' ),

	'single.php'            => __( 'Single Post' ),

	'page.php'              => __( 'Single Page' ),

	'front-page.php'        => __( 'Homepage' ),

	'privacy-policy.php'    => __( 'Privacy Policy Page' ),

	// Attachments.

	'attachment.php'        => __( 'Attachment Template' ),

	'image.php'             => __( 'Image Attachment Template' ),

	'video.php'             => __( 'Video Attachment Template' ),

	'audio.php'             => __( 'Audio Attachment Template' ),

	'application.php'       => __( 'Application Attachment Template' ),

	// Embeds.

	'embed.php'             => __( 'Embed Template' ),

	'embed-404.php'         => __( 'Embed 404 Template' ),

	'embed-content.php'     => __( 'Embed Content Template' ),

	'header-embed.php'      => __( 'Embed Header Template' ),

	'footer-embed.php'      => __( 'Embed Footer Template' ),

	// Stylesheets.

	'style.css'             => __( 'Stylesheet' ),

	'editor-style.css'      => __( 'Visual Editor Stylesheet' ),

	'editor-style-rtl.css'  => __( 'Visual Editor RTL Stylesheet' ),

	'rtl.css'               => __( 'RTL Stylesheet' ),

	// Other.

	'my-hacks.php'          => __( 'my-hacks.php (legacy hacks support)' ),

	'.htaccess'             => __( '.htaccess (for rewrite rules )' ),

	// Deprecated files.

	'wp-layout.css'         => __( 'Stylesheet' ),

	'wp-comments.php'       => __( 'Comments Template' ),

	'wp-comments-popup.php' => __( 'Popup Comments Template' ),

	'comments-popup.php'    => __( 'Popup Comments' ),

);

/**

 * Gets the description for standard WordPress theme files.

 *

 * @since 1.5.0

 *

 * @global array $wp_file_descriptions Theme file descriptions.

 * @global array $allowed_files        List of allowed files.

 *

 * @param string $file Filesystem path or filename.

 * @return string Description of file from $wp_file_descriptions or basename of $file if description doesn't exist.

 *                Appends 'Page Template' to basename of $file if the file is a page template.

 */

function get_file_description( $file ) {

	global $wp_file_descriptions, $allowed_files;

	$dirname   = pathinfo( $file, PATHINFO_DIRNAME );

	$file_path = $allowed_files[ $file ];

	if ( isset( $wp_file_descriptions[ basename( $file ) ] ) && '.' === $dirname ) {

		return $wp_file_descriptions[ basename( $file ) ];

	} elseif ( file_exists( $file_path ) && is_file( $file_path ) ) {

		$template_data = implode( '', file( $file_path ) );

		if ( preg_match( '|Template Name:(.*)$|mi', $template_data, $name ) ) {

			/* translators: %s: Template name. */

			return sprintf( __( '%s Page Template' ), _cleanup_header_comment( $name[1] ) );

		}

	}

	return trim( basename( $file ) );

}

/**

 * Gets the absolute filesystem path to the root of the WordPress installation.

 *

 * @since 1.5.0

 *

 * @return string Full filesystem path to the root of the WordPress installation.

 */

function get_home_path() {

	$home    = set_url_scheme( get_option( 'home' ), 'http' );

	$siteurl = set_url_scheme( get_option( 'siteurl' ), 'http' );

	if ( ! empty( $home ) && 0 !== strcasecmp( $home, $siteurl ) ) {

		$wp_path_rel_to_home = str_ireplace( $home, '', $siteurl ); /* $siteurl - $home */

		$pos                 = strripos( str_replace( '\\', '/', $_SERVER['SCRIPT_FILENAME'] ), trailingslashit( $wp_path_rel_to_home ) );

		$home_path           = substr( $_SERVER['SCRIPT_FILENAME'], 0, $pos );

		$home_path           = trailingslashit( $home_path );

	} else {

		$home_path = ABSPATH;

	}

	return str_replace( '\\', '/', $home_path );

}

/**

 * Returns a listing of all files in the specified folder and all subdirectories up to 100 levels deep.

 *

 * The depth of the recursiveness can be controlled by the $levels param.

 *

 * @since 2.6.0

 * @since 4.9.0 Added the `$exclusions` parameter.

 *

 * @param string   $folder     Optional. Full path to folder. Default empty.

 * @param int      $levels     Optional. Levels of folders to follow, Default 100 (PHP Loop limit).

 * @param string[] $exclusions Optional. List of folders and files to skip.

 * @return string[]|false Array of files on success, false on failure.

 */

function list_files( $folder = '', $levels = 100, $exclusions = array() ) {

	if ( empty( $folder ) ) {

		return false;

	}

	$folder = trailingslashit( $folder );

	if ( ! $levels ) {

		return false;

	}

	$files = array();

	$dir = @opendir( $folder );

	if ( $dir ) {

		while ( ( $file = readdir( $dir ) ) !== false ) {

			// Skip current and parent folder links.

			if ( in_array( $file, array( '.', '..' ), true ) ) {

				continue;

			}

			// Skip hidden and excluded files.

			if ( '.' === $file[0] || in_array( $file, $exclusions, true ) ) {

				continue;

			}

			if ( is_dir( $folder . $file ) ) {

				$files2 = list_files( $folder . $file, $levels - 1 );

				if ( $files2 ) {

					$files = array_merge( $files, $files2 );

				} else {

					$files[] = $folder . $file . '/';

				}

			} else {

				$files[] = $folder . $file;

			}

		}

		closedir( $dir );

	}

	return $files;

}

/**

 * Gets the list of file extensions that are editable in plugins.

 *

 * @since 4.9.0

 *

 * @param string $plugin Path to the plugin file relative to the plugins directory.

 * @return string[] Array of editable file extensions.

 */

function wp_get_plugin_file_editable_extensions( $plugin ) {

	$default_types = array(

		'bash',

		'conf',

		'css',

		'diff',

		'htm',

		'html',

		'http',

		'inc',

		'include',

		'js',

		'json',

		'jsx',

		'less',

		'md',

		'patch',

		'php',

		'php3',

		'php4',

		'php5',

		'php7',

		'phps',

		'phtml',

		'sass',

		'scss',

		'sh',

		'sql',

		'svg',

		'text',

		'txt',

		'xml',

		'yaml',

		'yml',

	);

	/**

	 *

	 * @since 2.8.0

	 * @since 4.9.0 Added the `$plugin` parameter.

	 *

	 * @param string[] $default_types An array of editable plugin file extensions.

	 * @param string   $plugin        Path to the plugin file relative to the plugins directory.

	 */

	$file_types = (array) apply_filters( 'editable_extensions', $default_types, $plugin );

	return $file_types;

}

/**

 * Gets the list of file extensions that are editable for a given theme.

 *

 * @since 4.9.0

 *

 * @param WP_Theme $theme Theme object.

 * @return string[] Array of editable file extensions.

 */

function wp_get_theme_file_editable_extensions( $theme ) {

	$default_types = array(

		'bash',

		'conf',

		'css',

		'diff',

		'htm',

		'html',

		'http',

		'inc',

		'include',

		'js',

		'json',

		'jsx',

		'less',

		'md',

		'patch',

		'php',

		'php3',

		'php4',

		'php5',

		'php7',

		'phps',

		'phtml',

		'sass',

		'scss',

		'sh',

		'sql',

		'svg',

		'text',

		'txt',

		'xml',

		'yaml',

		'yml',

	);

	/**

	 *

	 * @since 4.4.0

	 *

	 * @param string[] $default_types An array of editable theme file extensions.

	 */

	$file_types = apply_filters( 'wp_theme_editor_filetypes', $default_types, $theme );

	// Ensure that default types are still there.

	return array_unique( array_merge( $file_types, $default_types ) );

}

/**

 * Prints file editor templates (for plugins and themes).

 *

 * @since 4.9.0

 */

function wp_print_file_editor_templates() {

	?>

	<script type="text/html" id="tmpl-wp-file-editor-notice">

		<div class="notice inline notice-{{ data.type || 'info' }} {{ data.alt ? 'notice-alt' : '' }} {{ data.dismissible ? 'is-dismissible' : '' }} {{ data.classes || '' }}">

			<# if ( 'php_error' === data.code ) { #>

				<p>

					<?php

					printf(

						/* translators: 1: Line number, 2: File path. */

						__( 'Your PHP code changes were rolled back due to an error on line %1$s of file %2$s. Please fix and try saving again.' ),

						'{{ data.line }}',

						'{{ data.file }}'

					);

					?>

				</p>

				<pre>{{ data.message }}</pre>

			<# } else if ( 'file_not_writable' === data.code ) { #>

				<p>

					<?php

					printf(

						/* translators: %s: Documentation URL. */

						__( 'You need to make this file writable before you can save your changes. See <a href="%s">Changing File Permissions</a> for more information.' ),

						__( 'https://wordpress.org/support/article/changing-file-permissions/' )

					);

					?>

				</p>

			<# } else { #>

				<p>{{ data.message || data.code }}</p>

				<# if ( 'lint_errors' === data.code ) { #>

					<p>

						<# var elementId = 'el-' + String( Math.random() ); #>

						<input id="{{ elementId }}"  type="checkbox">

						<label for="{{ elementId }}"><?php _e( 'Update anyway, even though it might break your site?' ); ?></label>

					</p>

				<# } #>

			<# } #>

			<# if ( data.dismissible ) { #>

				<button type="button" class="notice-dismiss"><span class="screen-reader-text"><?php _e( 'Dismiss' ); ?></span></button>

			<# } #>

		</div>

	</script>

	<?php

}

/**

 * Attempts to edit a file for a theme or plugin.

 *

 * When editing a PHP file, loopback requests will be made to the admin and the homepage

 * to attempt to see if there is a fatal error introduced. If so, the PHP change will be

 * reverted.

 *

 * @since 4.9.0

 *

 * @param string[] $args {

 *     Args. Note that all of the arg values are already unslashed. They are, however,

 *     coming straight from `$_POST` and are not validated or sanitized in any way.

 *

 *     @type string $file       Relative path to file.

 *     @type string $plugin     Path to the plugin file relative to the plugins directory.

 *     @type string $theme      Theme being edited.

 *     @type string $newcontent New content for the file.

 *     @type string $nonce      Nonce.

 * }

 * @return true|WP_Error True on success or `WP_Error` on failure.

 */

function wp_edit_theme_plugin_file( $args ) {

	if ( empty( $args['file'] ) ) {

		return new WP_Error( 'missing_file' );

	}

	if ( 0 !== validate_file( $args['file'] ) ) {

		return new WP_Error( 'bad_file' );

	}

	if ( ! isset( $args['newcontent'] ) ) {

		return new WP_Error( 'missing_content' );

	}

	if ( ! isset( $args['nonce'] ) ) {

		return new WP_Error( 'missing_nonce' );

	}

	$file    = $args['file'];

	$content = $args['newcontent'];

	$plugin    = null;

	$theme     = null;

	$real_file = null;

	if ( ! empty( $args['plugin'] ) ) {

		$plugin = $args['plugin'];

		if ( ! current_user_can( 'edit_plugins' ) ) {

			return new WP_Error( 'unauthorized', __( 'Sorry, you are not allowed to edit plugins for this site.' ) );

		}

		if ( ! wp_verify_nonce( $args['nonce'], 'edit-plugin_' . $file ) ) {

			return new WP_Error( 'nonce_failure' );

		}

		if ( ! array_key_exists( $plugin, get_plugins() ) ) {

			return new WP_Error( 'invalid_plugin' );

		}

		if ( 0 !== validate_file( $file, get_plugin_files( $plugin ) ) ) {

			return new WP_Error( 'bad_plugin_file_path', __( 'Sorry, that file cannot be edited.' ) );

		}

		$editable_extensions = wp_get_plugin_file_editable_extensions( $plugin );