]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-admin/includes/file.php
WordPress 4.5-scripts
[autoinstalls/wordpress.git] / wp-admin / includes / file.php
index 55125f6c73858db8622aff39e9f5a2e00d40a12e..72f5e2209bccaa2f1227979ac01b308b0c53abd4 100644 (file)
@@ -1,47 +1,60 @@
 <?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 Administration
+ * @subpackage Filesystem
+ * @since 2.3.0
  */
 
 /** 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 )' ),
+       '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'        => __( 'Static Front 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' ),
+       // 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-layout.css'         => __( 'Stylesheet' ),
+       'wp-comments.php'       => __( 'Comments Template' ),
        'wp-comments-popup.php' => __( 'Popup Comments Template' ),
+       'comments-popup.php'    => __( 'Popup Comments' ),
 );
 
 /**
@@ -50,20 +63,23 @@ $wp_file_descriptions = array(
  *
  * @since 1.5.0
  *
- * @uses $wp_file_descriptions
+ * @global array $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
+ * @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;
-
-       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]) );
+       global $wp_file_descriptions, $allowed_files;
+
+       $relative_pathinfo = pathinfo( $file );
+       $file_path = $allowed_files[ $file ];
+       if ( isset( $wp_file_descriptions[ basename( $file ) ] ) && '.' === $relative_pathinfo['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 ) ) {
+                       return sprintf( __( '%s Page Template' ), _cleanup_header_comment( $name[1] ) );
+               }
        }
 
        return trim( basename( $file ) );
@@ -146,7 +162,7 @@ function wp_tempnam( $filename = '', $dir = '' ) {
                $dir = get_temp_dir();
        }
 
-       if ( empty( $filename ) || '.' == $filename ) {
+       if ( empty( $filename ) || '.' == $filename || '/' == $filename ) {
                $filename = time();
        }
 
@@ -154,14 +170,23 @@ function wp_tempnam( $filename = '', $dir = '' ) {
        $temp_filename = basename( $filename );
        $temp_filename = preg_replace( '|\.[^.]*$|', '', $temp_filename );
 
-       // If the folder is falsey, use it's parent directory name instead
+       // If the folder is falsey, use its parent directory name instead.
        if ( ! $temp_filename ) {
                return wp_tempnam( dirname( $filename ), $dir );
        }
 
+       // Suffix some random data to avoid filename conflicts
+       $temp_filename .= '-' . wp_generate_password( 6, false );
        $temp_filename .= '.tmp';
        $temp_filename = $dir . wp_unique_filename( $dir, $temp_filename );
-       touch( $temp_filename );
+
+       $fp = @fopen( $temp_filename, 'x' );
+       if ( ! $fp && is_writable( $dir ) && file_exists( $temp_filename ) ) {
+               return wp_tempnam( $filename, $dir );
+       }
+       if ( $fp ) {
+               fclose( $fp );
+       }
 
        return $temp_filename;
 }
@@ -169,7 +194,7 @@ function wp_tempnam( $filename = '', $dir = '' ) {
 /**
  * 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
+ * Function will die if you are not allowed to edit the file
  *
  * @since 1.5.0
  *
@@ -199,6 +224,7 @@ function validate_file_to_edit( $file, $allowed_files = '' ) {
  * 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.
  *
+ * @access private
  * @since 4.0.0
  *
  * @see wp_handle_upload_error
@@ -209,7 +235,7 @@ function validate_file_to_edit( $file, $allowed_files = '' ) {
  * @param string      $action    Expected value for $_POST['action'].
  * @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, $time, $action ) {
        // The default error handler.
        if ( ! function_exists( 'wp_handle_upload_error' ) ) {
@@ -340,7 +366,9 @@ function _wp_handle_upload( &$file, $overrides, $time, $action ) {
        if ( 'wp_handle_upload' === $action ) {
                $move_new_file = @ move_uploaded_file( $file['tmp_name'], $new_file );
        } else {
-               $move_new_file = @ rename( $file['tmp_name'], $new_file );
+               // use copy and unlink because rename breaks streams.
+               $move_new_file = @ copy( $file['tmp_name'], $new_file );
+               unlink( $file['tmp_name'] );
        }
 
        if ( false === $move_new_file ) {
@@ -382,7 +410,8 @@ function _wp_handle_upload( &$file, $overrides, $time, $action ) {
                'file' => $new_file,
                'url'  => $url,
                'type' => $type
-       ), 'wp_handle_sideload' === $action ? 'sideload' : 'upload' ); }
+       ), 'wp_handle_sideload' === $action ? 'sideload' : 'upload' );
+}
 
 /**
  * Wrapper for _wp_handle_upload(), passes 'wp_handle_upload' action.
@@ -440,7 +469,7 @@ function wp_handle_sideload( &$file, $overrides = false, $time = null ) {
 
 
 /**
- * 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.
  *
  * @since 2.5.0
@@ -516,6 +545,8 @@ function verify_file_md5( $filename, $expected_md5 ) {
  *
  * @since 2.5.0
  *
+ * @global WP_Filesystem_Base $wp_filesystem Subclass
+ *
  * @param string $file Full path and filename of zip archive
  * @param string $to Full path on the filesystem to extract archive to
  * @return mixed WP_Error on failure, True on success
@@ -558,7 +589,7 @@ function unzip_file($file, $to) {
         *
         * @param bool $ziparchive Whether to use ZipArchive. Default true.
         */
-       if ( class_exists( 'ZipArchive' ) && apply_filters( 'unzip_file_use_ziparchive', true ) ) {
+       if ( class_exists( 'ZipArchive', false ) && apply_filters( 'unzip_file_use_ziparchive', true ) ) {
                $result = _unzip_file_ziparchive($file, $to, $needed_dirs);
                if ( true === $result ) {
                        return $result;
@@ -579,6 +610,8 @@ function unzip_file($file, $to) {
  * @see unzip_file
  * @access private
  *
+ * @global WP_Filesystem_Base $wp_filesystem Subclass
+ *
  * @param string $file Full path and filename of zip archive
  * @param string $to Full path on the filesystem to extract archive to
  * @param array $needed_dirs A partial list of required folders needed to be created.
@@ -677,6 +710,8 @@ function _unzip_file_ziparchive($file, $to, $needed_dirs = array() ) {
  * @see unzip_file
  * @access private
  *
+ * @global WP_Filesystem_Base $wp_filesystem Subclass
+ *
  * @param string $file Full path and filename of zip archive
  * @param string $to Full path on the filesystem to extract archive to
  * @param array $needed_dirs A partial list of required folders needed to be created.
@@ -769,6 +804,8 @@ function _unzip_file_pclzip($file, $to, $needed_dirs = array()) {
  *
  * @since 2.5.0
  *
+ * @global WP_Filesystem_Base $wp_filesystem Subclass
+ *
  * @param string $from source directory
  * @param string $to destination directory
  * @param array $skip_list a list of files/folders to skip copying
@@ -823,13 +860,13 @@ function copy_dir($from, $to, $skip_list = array() ) {
  *
  * @since 2.5.0
  *
- * @param array  $args                         Optional. Connection args, These are passed directly to
- *                                             the `WP_Filesystem_*()` classes. Default false.
- * @param string $context                      Optional. Context for {@see get_filesystem_method()}.
- *                                             Default false.
- * @param bool   $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable.
- *                                             Default false.
- * @return null|boolean false on failure, true on success.
+ * @global WP_Filesystem_Base $wp_filesystem Subclass
+ *
+ * @param array|false  $args                         Optional. Connection args, These are passed directly to
+ *                                                   the `WP_Filesystem_*()` classes. Default false.
+ * @param string|false $context                      Optional. Context for get_filesystem_method(). Default false.
+ * @param bool         $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. Default false.
+ * @return null|bool false on failure, true on success.
  */
 function WP_Filesystem( $args = false, $context = false, $allow_relaxed_file_ownership = false ) {
        global $wp_filesystem;
@@ -841,7 +878,7 @@ function WP_Filesystem( $args = false, $context = false, $allow_relaxed_file_own
        if ( ! $method )
                return false;
 
-       if ( ! class_exists("WP_Filesystem_$method") ) {
+       if ( ! class_exists( "WP_Filesystem_$method" ) ) {
 
                /**
                 * Filter the path for a specific filesystem method class file.
@@ -902,6 +939,8 @@ function WP_Filesystem( $args = false, $context = false, $allow_relaxed_file_own
  *
  * @since 2.5.0
  *
+ * @global callable $_wp_filesystem_direct_method
+ *
  * @param array  $args                         Optional. Connection details. Default empty array.
  * @param string $context                      Optional. Full path to the directory that is tested
  *                                             for being writable. Default false.
@@ -984,17 +1023,23 @@ function get_filesystem_method( $args = array(), $context = false, $allow_relaxe
  *
  * @since 2.5.
  *
- * @todo Properly mark optional arguments as such
+ * @global string $pagenow
  *
- * @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 array $extra_fields Extra POST fields which should be checked for to be included in the post.
- * @param bool $allow_relaxed_file_ownership Whether to allow Group/World writable.
- * @return boolean False on failure. True on success.
+ * @param string $form_post                    The URL to post the form to.
+ * @param string $type                         Optional. Chosen type of filesystem. Default empty.
+ * @param bool   $error                        Optional. Whether the current request has failed to connect.
+ *                                             Default false.
+ * @param string $context                      Optional. Full path to the directory that is tested
+ *                                             for being writable. Default false.
+ * @param array  $extra_fields                 Optional. Extra POST fields which should be checked for
+ *                                             to be included in the post. Default null.
+ * @param bool   $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable.
+ *                                             Default false.
+ *
+ * @return bool False on failure, true on success.
  */
-function request_filesystem_credentials($form_post, $type = '', $error = false, $context = false, $extra_fields = null, $allow_relaxed_file_ownership = false ) {
+function request_filesystem_credentials( $form_post, $type = '', $error = false, $context = false, $extra_fields = null, $allow_relaxed_file_ownership = false ) {
+       global $pagenow;
 
        /**
         * Filter the filesystem credentials form output.
@@ -1004,15 +1049,16 @@ function request_filesystem_credentials($form_post, $type = '', $error = false,
         *
         * @since 2.5.0
         *
-        * @param mixed  $output       Form output to return instead. Default empty.
-        * @param string $form_post    URL to POST the form to.
-        * @param string $type         Chosen type of filesystem.
-        * @param bool   $error        Whether the current request has failed to connect.
-        *                             Default false.
-        * @param string $context      Full path to the directory that is tested for
-        *                             being writable.
-        * @param bool $allow_relaxed_file_ownership Whether to allow Group/World writable.
-        * @param array  $extra_fields Extra POST fields.
+        * @param mixed  $output                       Form output to return instead. Default empty.
+        * @param string $form_post                    The URL to post the form to.
+        * @param string $type                         Chosen type of filesystem.
+        * @param bool   $error                        Whether the current request has failed to connect.
+        *                                             Default false.
+        * @param string $context                      Full path to the directory that is tested for
+        *                                             being writable.
+        * @param bool   $allow_relaxed_file_ownership Whether to allow Group/World writable.
+        *                                             Default false.
+        * @param array  $extra_fields                 Extra POST fields.
         */
        $req_cred = apply_filters( 'request_filesystem_credentials', '', $form_post, $type, $error, $context, $extra_fields, $allow_relaxed_file_ownership );
        if ( '' !== $req_cred )
@@ -1069,7 +1115,7 @@ function request_filesystem_credentials($form_post, $type = '', $error = false,
                        $stored_credentials['hostname'] .= ':' . $stored_credentials['port'];
 
                unset($stored_credentials['password'], $stored_credentials['port'], $stored_credentials['private_key'], $stored_credentials['public_key']);
-               if ( ! defined( 'WP_INSTALLING' ) ) {
+               if ( ! wp_installing() ) {
                        update_option( 'ftp_credentials', $stored_credentials );
                }
                return $credentials;
@@ -1126,7 +1172,14 @@ jQuery(function($){
 </script>
 <form action="<?php echo esc_url( $form_post ) ?>" method="post">
 <div id="request-filesystem-credentials-form" class="request-filesystem-credentials-form">
-<h3 id="request-filesystem-credentials-title"><?php _e( 'Connection Information' ) ?></h3>
+<?php
+// Print a H1 heading in the FTP credentials modal dialog, default is a H2.
+$heading_tag = 'h2';
+if ( 'plugins.php' === $pagenow || 'plugin-install.php' === $pagenow ) {
+       $heading_tag = 'h1';
+}
+echo "<$heading_tag id='request-filesystem-credentials-title'>" . __( 'Connection Information' ) . "</$heading_tag>";
+?>
 <p id="request-filesystem-credentials-desc"><?php
        $label_user = __('Username');
        $label_pass = __('Password');
@@ -1164,7 +1217,8 @@ jQuery(function($){
        </label>
 </div>
 <?php if ( isset($types['ssh']) ) : ?>
-<h4><?php _e('Authentication Keys') ?></h4>
+<fieldset>
+<legend><?php _e( 'Authentication Keys' ); ?></legend>
 <label for="public_key">
        <span class="field-title"><?php _e('Public Key:') ?></span>
        <input name="public_key" type="text" id="public_key" aria-describedby="auth-keys-desc" value="<?php echo esc_attr($public_key) ?>"<?php disabled( defined('FTP_PUBKEY') ); ?> />
@@ -1173,10 +1227,11 @@ jQuery(function($){
        <span class="field-title"><?php _e('Private Key:') ?></span>
        <input name="private_key" type="text" id="private_key" value="<?php echo esc_attr($private_key) ?>"<?php disabled( defined('FTP_PRIKEY') ); ?> />
 </label>
+</fieldset>
 <span id="auth-keys-desc"><?php _e('Enter the location on the server where the public and private keys are located. If a passphrase is needed, enter that in the password field above.') ?></span>
 <?php endif; ?>
-<h4><?php _e('Connection Type') ?></h4>
-<fieldset><legend class="screen-reader-text"><span><?php _e('Connection Type') ?></span></legend>
+<fieldset>
+<legend><?php _e( 'Connection Type' ); ?></legend>
 <?php
        $disabled = disabled( (defined('FTP_SSL') && FTP_SSL) || (defined('FTP_SSH') && FTP_SSH), true, false );
        foreach ( $types as $name => $text ) : ?>
@@ -1222,7 +1277,7 @@ function wp_print_request_filesystem_credentials_modal() {
                <div class="notification-dialog" role="dialog" aria-labelledby="request-filesystem-credentials-title" tabindex="0">
                        <div class="request-filesystem-credentials-dialog-content">
                                <?php request_filesystem_credentials( site_url() ); ?>
-                       <div>
+                       </div>
                </div>
        </div>
        <?php