Wordpress 3.5.2
[autoinstalls/wordpress.git] / wp-admin / includes / file.php
index 04bb40392e05907c1b22f27d0e7454cf7e3766bc..96b6db45c032c70559bdffc601eec01cb907d90c 100644 (file)
@@ -1,6 +1,8 @@
 <?php
 /**
 <?php
 /**
- * File contains all the administration image manipulation functions.
+ * 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
  *
  * @package WordPress
  * @subpackage Administration
@@ -65,7 +67,7 @@ function get_file_description( $file ) {
                        return sprintf( __( '%s Page Template' ), _cleanup_header_comment($name[1]) );
        }
 
                        return sprintf( __( '%s Page Template' ), _cleanup_header_comment($name[1]) );
        }
 
-       return basename( $file );
+       return trim( basename( $file ) );
 }
 
 /**
 }
 
 /**
@@ -79,10 +81,10 @@ function get_file_description( $file ) {
 function get_home_path() {
        $home = get_option( 'home' );
        $siteurl = get_option( 'siteurl' );
 function get_home_path() {
        $home = get_option( 'home' );
        $siteurl = get_option( 'siteurl' );
-       if ( $home != '' && $home != $siteurl ) {
-               $wp_path_rel_to_home = str_replace($home, '', $siteurl); /* $siteurl - $home */
-               $pos = strpos($_SERVER["SCRIPT_FILENAME"], $wp_path_rel_to_home);
-               $home_path = substr($_SERVER["SCRIPT_FILENAME"], 0, $pos);
+       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;
                $home_path = trailingslashit( $home_path );
        } else {
                $home_path = ABSPATH;
@@ -157,7 +159,7 @@ function list_files( $folder = '', $levels = 100 ) {
  * 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,
  * 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.
+ * while the directory can either be passed as well, or by leaving it blank, default to a writable temporary directory.
  *
  * @since 2.6.0
  *
  *
  * @since 2.6.0
  *
@@ -225,6 +227,7 @@ function validate_file_to_edit( $file, $allowed_files = '' ) {
  * @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 ).
  * @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 ) {
  * @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 ) {
@@ -240,7 +243,7 @@ function wp_handle_upload( &$file, $overrides = false, $time = null ) {
        // 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['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.
+       // 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'] );
 
        if ( isset( $file['error'] ) && !is_numeric( $file['error'] ) && $file['error'] )
                return $upload_error_handler( $file, $file['error'] );
 
@@ -261,7 +264,7 @@ function wp_handle_upload( &$file, $overrides = false, $time = null ) {
                __( "Failed to write file to disk." ),
                __( "File upload stopped by extension." ));
 
                __( "Failed to write file to disk." ),
                __( "File upload stopped by extension." ));
 
-       // All tests are on by default. Most can be turned off by $override[{test_name}] = false;
+       // 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;
        $test_form = true;
        $test_size = true;
        $test_upload = true;
@@ -325,8 +328,14 @@ function wp_handle_upload( &$file, $overrides = false, $time = null ) {
 
        // Move the file to the uploads dir
        $new_file = $uploads['path'] . "/$filename";
 
        // 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'] ) );
+       if ( false === @ move_uploaded_file( $file['tmp_name'], $new_file ) ) {
+               if ( 0 === strpos( $uploads['basedir'], ABSPATH ) )
+                       $error_path = str_replace( ABSPATH, '', $uploads['basedir'] ) . $uploads['subdir'];
+               else
+                       $error_path = basename( $uploads['basedir'] ) . $uploads['subdir'];
+
+               return $upload_error_handler( $file, sprintf( __('The uploaded file could not be moved to %s.' ), $error_path ) );
+       }
 
        // Set correct file permissions
        $stat = stat( dirname( $new_file ));
 
        // Set correct file permissions
        $stat = stat( dirname( $new_file ));
@@ -343,8 +352,8 @@ function wp_handle_upload( &$file, $overrides = false, $time = null ) {
 }
 
 /**
 }
 
 /**
- * Handle sideloads, which is the process of retriving a media item from another server instead of
- * a traditional media upload.  This process involves sanitizing the filename, checking extensions
+ * 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
  * for mime type, and moving the file to the appropriate directory within the uploads directory.
  *
  * @since 2.6.0
@@ -357,9 +366,10 @@ function wp_handle_upload( &$file, $overrides = false, $time = null ) {
  * @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 ).
  * @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 ).
  */
  * @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 ) {
+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 ) {
        // The default error handler.
        if (! function_exists( 'wp_handle_upload_error' ) ) {
                function wp_handle_upload_error( &$file, $message ) {
@@ -387,7 +397,7 @@ function wp_handle_sideload( &$file, $overrides = false ) {
                __( "Failed to write file to disk." ),
                __( "File upload stopped by extension." ));
 
                __( "Failed to write file to disk." ),
                __( "File upload stopped by extension." ));
 
-       // All tests are on by default. Most can be turned off by $override[{test_name}] = false;
+       // All tests are on by default. Most can be turned off by $overrides[{test_name}] = false;
        $test_form = true;
        $test_size = true;
 
        $test_form = true;
        $test_size = true;
 
@@ -436,7 +446,7 @@ function wp_handle_sideload( &$file, $overrides = false ) {
        }
 
        // A writable uploads dir will pass this test. Again, there's no point overriding this one.
        }
 
        // A writable uploads dir will pass this test. Again, there's no point overriding this one.
-       if ( ! ( ( $uploads = wp_upload_dir() ) && false === $uploads['error'] ) )
+       if ( ! ( ( $uploads = wp_upload_dir( $time ) ) && false === $uploads['error'] ) )
                return $upload_error_handler( $file, $uploads['error'] );
 
        $filename = wp_unique_filename( $uploads['path'], $file['name'], $unique_filename_callback );
                return $upload_error_handler( $file, $uploads['error'] );
 
        $filename = wp_unique_filename( $uploads['path'], $file['name'], $unique_filename_callback );
@@ -448,7 +458,11 @@ function wp_handle_sideload( &$file, $overrides = false ) {
        // Move the file to the uploads dir
        $new_file = $uploads['path'] . "/$filename";
        if ( false === @ rename( $file['tmp_name'], $new_file ) ) {
        // Move the file to the uploads dir
        $new_file = $uploads['path'] . "/$filename";
        if ( false === @ rename( $file['tmp_name'], $new_file ) ) {
-               return $upload_error_handler( $file, sprintf( __('The uploaded file could not be moved to %s.' ), $uploads['path'] ) );
+               if ( 0 === strpos( $uploads['basedir'], ABSPATH ) )
+                       $error_path = str_replace( ABSPATH, '', $uploads['basedir'] ) . $uploads['subdir'];
+               else
+                       $error_path = basename( $uploads['basedir'] ) . $uploads['subdir'];
+               return $upload_error_handler( $file, sprintf( __('The uploaded file could not be moved to %s.' ), $error_path ) );
        }
 
        // Set correct file permissions
        }
 
        // Set correct file permissions
@@ -466,7 +480,7 @@ function wp_handle_sideload( &$file, $overrides = false ) {
 
 /**
  * Downloads a url to a local temporary file using the WordPress HTTP Class.
 
 /**
  * Downloads a url to a local temporary file using the WordPress HTTP Class.
- * Please note, That the calling function must unlink() the  file.
+ * Please note, That the calling function must unlink() the file.
  *
  * @since 2.5.0
  *
  *
  * @since 2.5.0
  *
@@ -483,7 +497,7 @@ function download_url( $url, $timeout = 300 ) {
        if ( ! $tmpfname )
                return new WP_Error('http_no_file', __('Could not create Temporary file.'));
 
        if ( ! $tmpfname )
                return new WP_Error('http_no_file', __('Could not create Temporary file.'));
 
-       $response = wp_remote_get( $url, array( 'timeout' => $timeout, 'stream' => true, 'filename' => $tmpfname ) );
+       $response = wp_remote_get( $url, array( 'timeout' => $timeout, 'stream' => true, 'filename' => $tmpfname, 'reject_unsafe_urls' => true ) );
 
        if ( is_wp_error( $response ) ) {
                unlink( $tmpfname );
 
        if ( is_wp_error( $response ) ) {
                unlink( $tmpfname );
@@ -499,7 +513,7 @@ function download_url( $url, $timeout = 300 ) {
 }
 
 /**
 }
 
 /**
- * Unzip's a specified ZIP file to a location on the Filesystem via the WordPress Filesystem Abstraction.
+ * Unzips a specified ZIP file to a location on the Filesystem via the WordPress Filesystem Abstraction.
  * Assumes that WP_Filesystem() has already been called and set up. Does not extract a root-level __MACOSX directory, if present.
  *
  * Attempts to increase the PHP Memory limit to 256M before uncompressing,
  * Assumes that WP_Filesystem() has already been called and set up. Does not extract a root-level __MACOSX directory, if present.
  *
  * Attempts to increase the PHP Memory limit to 256M before uncompressing,
@@ -628,7 +642,7 @@ function _unzip_file_ziparchive($file, $to, $needed_dirs = array() ) {
                        return new WP_Error('extract_failed', __('Could not extract file from archive.'), $info['name']);
 
                if ( ! $wp_filesystem->put_contents( $to . $info['name'], $contents, FS_CHMOD_FILE) )
                        return new WP_Error('extract_failed', __('Could not extract file from archive.'), $info['name']);
 
                if ( ! $wp_filesystem->put_contents( $to . $info['name'], $contents, FS_CHMOD_FILE) )
-                       return new WP_Error('copy_failed', __('Could not copy file.'), $to . $info['filename']);
+                       return new WP_Error('copy_failed', __('Could not copy file.'), $to . $info['name']);
        }
 
        $z->close();
        }
 
        $z->close();
@@ -813,7 +827,7 @@ function WP_Filesystem( $args = false, $context = false ) {
                return false;
 
        if ( !$wp_filesystem->connect() )
                return false;
 
        if ( !$wp_filesystem->connect() )
-               return false; //There was an erorr connecting to the server.
+               return false; //There was an error connecting to the server.
 
        // Set the permission constants if not already set.
        if ( ! defined('FS_CHMOD_DIR') )
 
        // Set the permission constants if not already set.
        if ( ! defined('FS_CHMOD_DIR') )
@@ -826,7 +840,7 @@ function WP_Filesystem( $args = false, $context = false ) {
 
 /**
  * Determines which Filesystem Method to use.
 
 /**
  * Determines which Filesystem Method to use.
- * The priority of the Transports are: Direct, SSH2, FTP PHP Extension, FTP Sockets (Via Sockets class, or fsoxkopen())
+ * The priority of the Transports are: Direct, SSH2, FTP PHP Extension, FTP Sockets (Via Sockets class, or fsockopen())
  *
  * Note that the return value of this function can be overridden in 2 ways
  *  - By defining FS_METHOD in your <code>wp-config.php</code> file
  *
  * Note that the return value of this function can be overridden in 2 ways
  *  - By defining FS_METHOD in your <code>wp-config.php</code> file
@@ -864,7 +878,7 @@ function get_filesystem_method($args = array(), $context = false) {
 }
 
 /**
 }
 
 /**
- * Displays a form to the user to request for their FTP/SSH details in order to  connect to the filesystem.
+ * Displays a form to the user to request for their FTP/SSH details in order to connect to the filesystem.
  * All chosen/entered details are saved, Excluding the Password.
  *
  * Hostnames may be in the form of hostname:portnumber (eg: wordpress.org:2467) to specify an alternate FTP/SSH port.
  * All chosen/entered details are saved, Excluding the Password.
  *
  * Hostnames may be in the form of hostname:portnumber (eg: wordpress.org:2467) to specify an alternate FTP/SSH port.
@@ -876,7 +890,7 @@ function get_filesystem_method($args = array(), $context = false) {
  * @param string $form_post the URL to post the form to
  * @param string $type the chosen Filesystem method in use
  * @param boolean $error if the current request has failed to connect
  * @param string $form_post the URL to post the form to
  * @param string $type the chosen Filesystem method in use
  * @param boolean $error if the current request has failed to connect
- * @param string $context The directory which is needed access to, The write-test will be performed on  this directory by get_filesystem_method()
+ * @param string $context The directory which is needed access to, The write-test will be performed on this directory by get_filesystem_method()
  * @param string $extra_fields Extra POST fields which should be checked for to be included in the post.
  * @return boolean False on failure. True on success.
  */
  * @param string $extra_fields Extra POST fields which should be checked for to be included in the post.
  * @return boolean False on failure. True on success.
  */
@@ -945,7 +959,7 @@ function request_filesystem_credentials($form_post, $type = '', $error = false,
        if ( !empty($credentials) )
                extract($credentials, EXTR_OVERWRITE);
        if ( $error ) {
        if ( !empty($credentials) )
                extract($credentials, EXTR_OVERWRITE);
        if ( $error ) {
-               $error_string = __('<strong>Error:</strong> There was an error connecting to the server, Please verify the settings are correct.');
+               $error_string = __('<strong>ERROR:</strong> There was an error connecting to the server, Please verify the settings are correct.');
                if ( is_wp_error($error) )
                        $error_string = esc_html( $error->get_error_message() );
                echo '<div id="message" class="error"><p>' . $error_string . '</p></div>';
                if ( is_wp_error($error) )
                        $error_string = esc_html( $error->get_error_message() );
                echo '<div id="message" class="error"><p>' . $error_string . '</p></div>';
@@ -1055,5 +1069,3 @@ submit_button( __( 'Proceed' ), 'button', 'upgrade' );
 <?php
        return false;
 }
 <?php
        return false;
 }
-
-?>