<?php

/**

 * 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 Administration

 */

/** The descriptions for theme files. */

$wp_file_descriptions = array(

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	'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' ),

);

/**

 * Get the description for standard WordPress theme files and other various standard

 * WordPress files

 *

 * @since 1.5.0

 *

 * @uses _cleanup_header_comment

 * @uses $wp_file_descriptions

 * @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

 */

function get_file_description( $file ) {

	global $wp_file_descriptions;

	if ( isset( $wp_file_descriptions[basename( $file )] ) ) {

		return $wp_file_descriptions[basename( $file )];

	}

	elseif ( file_exists( $file ) && is_file( $file ) ) {

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

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

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

	}

	return trim( basename( $file ) );

}

/**

 * Get the absolute filesystem path to the root of the WordPress installation

 *

 * @since 1.5.0

 *

 * @uses get_option

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

 */

function get_home_path() {

	$home = get_option( 'home' );

	$siteurl = get_option( 'siteurl' );

	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 $home_path;

}

/**

 * Get the real file system path to a file to edit within the admin

 *

 * If the $file is index.php or .htaccess this function will assume it is relative

 * to the install root, otherwise it is assumed the file is relative to the wp-content

 * directory

 *

 * @since 1.5.0

 *

 * @uses get_home_path

 * @uses WP_CONTENT_DIR full filesystem path to the wp-content directory

 * @param string $file filesystem path relative to the WordPress install directory or to the wp-content directory

 * @return string full file system path to edit

 */

function get_real_file_to_edit( $file ) {

	if ('index.php' == $file || '.htaccess' == $file ) {

		$real_file = get_home_path() . $file;

	} else {

		$real_file = WP_CONTENT_DIR . $file;

	}

	return $real_file;

}

/**

 * 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

 *

 * @param string $folder Full path to folder

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

 * @return bool|array False on failure, Else array of files

 */

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

	if ( empty($folder) )

		return false;

	if ( ! $levels )

		return false;

	$files = array();

	if ( $dir = @opendir( $folder ) ) {

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

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

				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;

}

/**

 * Returns a filename of a Temporary unique file.

 * Please note that the calling function must unlink() this itself.

 *

 * The filename is based off the passed parameter or defaults to the current unix timestamp,

 * while the directory can either be passed as well, or by leaving it blank, default to a writable temporary directory.

 *

 * @since 2.6.0

 *

 * @param string $filename (optional) Filename to base the Unique file off

 * @param string $dir (optional) Directory to store the file in

 * @return string a writable filename

 */

function wp_tempnam($filename = '', $dir = '') {

	if ( empty($dir) )

		$dir = get_temp_dir();

	$filename = basename($filename);

	if ( empty($filename) )

		$filename = time();

	$filename = preg_replace('|\..*$|', '.tmp', $filename);

	$filename = $dir . wp_unique_filename($dir, $filename);

	touch($filename);

	return $filename;

}

/**

 * Make sure that the file that was requested to edit, is allowed to be edited

 *

 * Function will die if if you are not allowed to edit the file

 *

 * @since 1.5.0

 *

 * @uses wp_die

 * @uses validate_file

 * @param string $file file the users is attempting to edit

 * @param array $allowed_files Array of allowed files to edit, $file must match an entry exactly

 * @return null

 */

function validate_file_to_edit( $file, $allowed_files = '' ) {

	$code = validate_file( $file, $allowed_files );

	if (!$code )

		return $file;

	switch ( $code ) {

		case 1 :

			wp_die( __('Sorry, can’t edit files with “..” in the name. If you are trying to edit a file in your WordPress home directory, you can just type the name of the file in.' ));

		//case 2 :

		//	wp_die( __('Sorry, can’t call files with their real path.' ));

		case 3 :

			wp_die( __('Sorry, that file cannot be edited.' ));

	}

}

/**

 * Handle PHP uploads in WordPress, sanitizing file names, checking extensions for mime type,

 * and moving the file to the appropriate directory within the uploads directory.

 *

 * @since 2.0

 *

 * @uses wp_handle_upload_error

 * @uses apply_filters

 * @uses is_multisite

 * @uses wp_check_filetype_and_ext

 * @uses current_user_can

 * @uses wp_upload_dir

 * @uses wp_unique_filename

 * @uses delete_transient

 * @param array $file Reference to a single element of $_FILES. Call the function once for each uploaded file.

 * @param array $overrides Optional. An associative array of names=>values to override default variables with extract( $overrides, EXTR_OVERWRITE ).

 * @param string $time Optional. Time formatted in 'yyyy/mm'.

 * @return array On success, returns an associative array of file attributes. On failure, returns $overrides['upload_error_handler'](&$file, $message ) or array( 'error'=>$message ).

 */

function wp_handle_upload( &$file, $overrides = false, $time = null ) {

	// The default error handler.

	if ( ! function_exists( 'wp_handle_upload_error' ) ) {

		function wp_handle_upload_error( &$file, $message ) {

			return array( 'error'=>$message );

		}

	}

	$file = apply_filters( 'wp_handle_upload_prefilter', $file );

	// You may define your own function and pass the name in $overrides['upload_error_handler']

	$upload_error_handler = 'wp_handle_upload_error';

	// You may have had one or more 'wp_handle_upload_prefilter' functions error out the file. Handle that gracefully.

	if ( isset( $file['error'] ) && !is_numeric( $file['error'] ) && $file['error'] )

		return $upload_error_handler( $file, $file['error'] );

	// You may define your own function and pass the name in $overrides['unique_filename_callback']

	$unique_filename_callback = null;

	// $_POST['action'] must be set and its value must equal $overrides['action'] or this:

	$action = 'wp_handle_upload';

	// Courtesy of php.net, the strings that describe the error indicated in $_FILES[{form field}]['error'].

	$upload_error_strings = array( false,

		__( "The uploaded file exceeds the upload_max_filesize directive in php.ini." ),

		__( "The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form." ),

		__( "The uploaded file was only partially uploaded." ),

		__( "No file was uploaded." ),

		'',

		__( "Missing a temporary folder." ),

		__( "Failed to write file to disk." ),

		__( "File upload stopped by extension." ));

	// All tests are on by default. Most can be turned off by $overrides[{test_name}] = false;

	$test_form = true;

	$test_size = true;

	$test_upload = true;

	// If you override this, you must provide $ext and $type!!!!

	$test_type = true;

	$mimes = false;

	// Install user overrides. Did we mention that this voids your warranty?

	if ( is_array( $overrides ) )

		extract( $overrides, EXTR_OVERWRITE );

	// A correct form post will pass this test.

	if ( $test_form && (!isset( $_POST['action'] ) || ($_POST['action'] != $action ) ) )

		return call_user_func($upload_error_handler, $file, __( 'Invalid form submission.' ));

	// A successful upload will pass this test. It makes no sense to override this one.

	if ( $file['error'] > 0 )

		return call_user_func($upload_error_handler, $file, $upload_error_strings[$file['error']] );

	// A non-empty file will pass this test.

	if ( $test_size && !($file['size'] > 0 ) ) {

		if ( is_multisite() )

			$error_msg = __( 'File is empty. Please upload something more substantial.' );

		else

			$error_msg = __( 'File is empty. Please upload something more substantial. This error could also be caused by uploads being disabled in your php.ini or by post_max_size being defined as smaller than upload_max_filesize in php.ini.' );

		return call_user_func($upload_error_handler, $file, $error_msg);

	}

	// A properly uploaded file will pass this test. There should be no reason to override this one.

	if ( $test_upload && ! @ is_uploaded_file( $file['tmp_name'] ) )

		return call_user_func($upload_error_handler, $file, __( 'Specified file failed upload test.' ));

	// A correct MIME type will pass this test. Override $mimes or use the upload_mimes filter.

	if ( $test_type ) {

		$wp_filetype = wp_check_filetype_and_ext( $file['tmp_name'], $file['name'], $mimes );

		extract( $wp_filetype );

		// Check to see if wp_check_filetype_and_ext() determined the filename was incorrect

		if ( $proper_filename )

			$file['name'] = $proper_filename;

		if ( ( !$type || !$ext ) && !current_user_can( 'unfiltered_upload' ) )

			return call_user_func($upload_error_handler, $file, __( 'Sorry, this file type is not permitted for security reasons.' ));

		if ( !$ext )

			$ext = ltrim(strrchr($file['name'], '.'), '.');

		if ( !$type )

			$type = $file['type'];

	} else {

		$type = '';

	}

	// A writable uploads dir will pass this test. Again, there's no point overriding this one.

	if ( ! ( ( $uploads = wp_upload_dir($time) ) && false === $uploads['error'] ) )

		return call_user_func($upload_error_handler, $file, $uploads['error'] );

	$filename = wp_unique_filename( $uploads['path'], $file['name'], $unique_filename_callback );

	// Move the file to the uploads dir

	$new_file = $uploads['path'] . "/$filename";

	if ( false === @ move_uploaded_file( $file['tmp_name'], $new_file ) )

		return $upload_error_handler( $file, sprintf( __('The uploaded file could not be moved to %s.' ), $uploads['path'] ) );

	// Set correct file permissions

	$stat = stat( dirname( $new_file ));

	$perms = $stat['mode'] & 0000666;

	@ chmod( $new_file, $perms );

	// Compute the URL

	$url = $uploads['url'] . "/$filename";

	if ( is_multisite() )

		delete_transient( 'dirsize_cache' );

	return apply_filters( 'wp_handle_upload', array( 'file' => $new_file, 'url' => $url, 'type' => $type ), 'upload' );

}

/**

 * Handle sideloads, which is the process of retrieving a media item from another server instead of

 * a traditional media upload. This process involves sanitizing the filename, checking extensions

 * for mime type, and moving the file to the appropriate directory within the uploads directory.

 *

 * @since 2.6.0

 *

 * @uses wp_handle_upload_error

 * @uses apply_filters

 * @uses wp_check_filetype_and_ext

 * @uses current_user_can

 * @uses wp_upload_dir

 * @uses wp_unique_filename

 * @param array $file an array similar to that of a PHP $_FILES POST array

 * @param array $overrides Optional. An associative array of names=>values to override default variables with extract( $overrides, EXTR_OVERWRITE ).

 * @param string $time Optional. Time formatted in 'yyyy/mm'.

 * @return array On success, returns an associative array of file attributes. On failure, returns $overrides['upload_error_handler'](&$file, $message ) or array( 'error'=>$message ).

 */

function wp_handle_sideload( &$file, $overrides = false, $time = null ) {

	// The default error handler.

	if (! function_exists( 'wp_handle_upload_error' ) ) {

		function wp_handle_upload_error( &$file, $message ) {

			return array( 'error'=>$message );

		}

	}

	// You may define your own function and pass the name in $overrides['upload_error_handler']

	$upload_error_handler = 'wp_handle_upload_error';

	// You may define your own function and pass the name in $overrides['unique_filename_callback']

	$unique_filename_callback = null;

	// $_POST['action'] must be set and its value must equal $overrides['action'] or this:

	$action = 'wp_handle_sideload';

	// Courtesy of php.net, the strings that describe the error indicated in $_FILES[{form field}]['error'].

	$upload_error_strings = array( false,

		__( "The uploaded file exceeds the <code>upload_max_filesize</code> directive in <code>php.ini</code>." ),

		__( "The uploaded file exceeds the <em>MAX_FILE_SIZE</em> directive that was specified in the HTML form." ),

		__( "The uploaded file was only partially uploaded." ),

		__( "No file was uploaded." ),

		'',

		__( "Missing a temporary folder." ),

		__( "Failed to write file to disk." ),

		__( "File upload stopped by extension." ));

	// All tests are on by default. Most can be turned off by $overrides[{test_name}] = false;

	$test_form = true;

	$test_size = true;

	// If you override this, you must provide $ext and $type!!!!

	$test_type = true;

	$mimes = false;

	// Install user overrides. Did we mention that this voids your warranty?

	if ( is_array( $overrides ) )

		extract( $overrides, EXTR_OVERWRITE );

	// A correct form post will pass this test.

	if ( $test_form && (!isset( $_POST['action'] ) || ($_POST['action'] != $action ) ) )

		return $upload_error_handler( $file, __( 'Invalid form submission.' ));

	// A successful upload will pass this test. It makes no sense to override this one.

	if ( ! empty( $file['error'] ) )

		return $upload_error_handler( $file, $upload_error_strings[$file['error']] );