Ticket #31616: 31616.3.diff

src/wp-admin/includes/file.php

@@ -910 +910 @@
 
         $context = trailingslashit( $context );
 
-        if ( ! $method ) {
+        static $results = array();
 
-                $temp_file_name = $context . 'temp-write-test-' . time();
-                $temp_handle = @fopen($temp_file_name, 'w');
-                if ( $temp_handle ) {
+        // saving hash for static cache; file reads/writes are to be avoided when possible
+        $hash = md5(serialize($args) . $context . $allow_relaxed_file_ownership);
+        if ( ! isset($results[$hash])) {
 
-                        // Attempt to determine the file owner of the WordPress files, and that of newly created files
-                        $wp_file_owner = $temp_file_owner = false;
-                        if ( function_exists('fileowner') ) {
-                                $wp_file_owner = @fileowner( __FILE__ );
-                                $temp_file_owner = @fileowner( $temp_file_name );
-                        }
+                if ( ! $method ) {
 
-                        if ( $wp_file_owner !== false && $wp_file_owner === $temp_file_owner ) {
-                                // WordPress is creating files as the same owner as the WordPress files,
-                                // this means it's safe to modify & create new files via PHP.
-                                $method = 'direct';
-                                $GLOBALS['_wp_filesystem_direct_method'] = 'file_owner';
-                        } elseif ( $allow_relaxed_file_ownership ) {
-                                // The $context directory is writable, and $allow_relaxed_file_ownership is set, this means we can modify files
-                                // safely in this directory. This mode doesn't create new files, only alter existing ones.
-                                $method = 'direct';
-                                $GLOBALS['_wp_filesystem_direct_method'] = 'relaxed_ownership';
+                        $temp_file_name = $context . 'temp-write-test-' . time();
+                        $temp_handle    = @fopen( $temp_file_name, 'w' );
+                        if ( $temp_handle ) {
+
+                                // Attempt to determine the file owner of the WordPress files, and that of newly created files
+                                $wp_file_owner = $temp_file_owner = false;
+                                if ( function_exists( 'fileowner' ) ) {
+                                        $wp_file_owner   = @fileowner( __FILE__ );
+                                        $temp_file_owner = @fileowner( $temp_file_name );
+                                }
+
+                                if ( $wp_file_owner !== false && $wp_file_owner === $temp_file_owner ) {
+                                        // WordPress is creating files as the same owner as the WordPress files,
+                                        // this means it's safe to modify & create new files via PHP.
+                                        $method                                  = 'direct';
+                                        $GLOBALS['_wp_filesystem_direct_method'] = 'file_owner';
+                                } elseif ( $allow_relaxed_file_ownership ) {
+                                        // The $context directory is writable, and $allow_relaxed_file_ownership is set, this means we can modify files
+                                        // safely in this directory. This mode doesn't create new files, only alter existing ones.
+                                        $method                                  = 'direct';
+                                        $GLOBALS['_wp_filesystem_direct_method'] = 'relaxed_ownership';
+                                }
+
+                                @fclose( $temp_handle );
+                                @unlink( $temp_file_name );
                         }
+                }
 
-                        @fclose($temp_handle);
-                        @unlink($temp_file_name);
+                if ( ! $method && isset($args['connection_type']) && 'ssh' == $args['connection_type'] && extension_loaded('ssh2') && function_exists('stream_get_contents') ) $method = 'ssh2';
+                if ( ! $method && extension_loaded('ftp') ) $method = 'ftpext';
+                if ( ! $method && ( extension_loaded('sockets') || function_exists('fsockopen') ) ) $method = 'ftpsockets'; //Sockets: Socket extension; PHP Mode: FSockopen / fwrite / fread
+
+                /**
+                 * Filter the filesystem method to use.
+                 *
+                 * @since 2.6.0
+                 *
+                 * @param string $method  Filesystem method to return.
+                 * @param array  $args    An array of connection details for the method.
+                 * @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.
+                 */
+                $results[$hash] = apply_filters( 'filesystem_method', $method, $args, $context, $allow_relaxed_file_ownership );
+        }
+
+        return $results[$hash];
+}
+
+/**
+ * Get the filesystem credentials needed to connect to the site
+ *
+ * @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 mixed Credentials that are found, not guaranteed to contain all information
+ */
+function get_filesystem_credentials($form_post, $type = '', $error = false, $context = false, $extra_fields = null, $allow_relaxed_file_ownership = false) {
+
+        /** This filter is documented in wp-includes/file.php */
+        $credentials = apply_filters( 'request_filesystem_credentials', '', $form_post, $type, $error, $context, $extra_fields, $allow_relaxed_file_ownership );
+        if ( '' !== $credentials ) {
+                return $credentials;
+        }
+
+        if ( empty($type) ) {
+                $type = get_filesystem_method( array(), $context, $allow_relaxed_file_ownership );
+        }
+
+        if ( 'direct' == $type ) {
+                return array( 'connection_type' => 'direct' );
+        }
+
+        $credentials = get_option('ftp_credentials', array( 'hostname' => '', 'username' => ''));
+
+        // If defined, set it to that, Else, If POST'd, set it to that, If not, Set it to whatever it previously was(saved details in option)
+        $credentials['hostname'] = defined('FTP_HOST') ? FTP_HOST : (!empty($_POST['hostname']) ? wp_unslash( $_POST['hostname'] ) : $credentials['hostname']);
+        $credentials['username'] = defined('FTP_USER') ? FTP_USER : (!empty($_POST['username']) ? wp_unslash( $_POST['username'] ) : $credentials['username']);
+        $credentials['password'] = defined('FTP_PASS') ? FTP_PASS : (!empty($_POST['password']) ? wp_unslash( $_POST['password'] ) : '');
+
+        // Check to see if we are setting the public/private keys for ssh
+        $credentials['public_key'] = defined('FTP_PUBKEY') ? FTP_PUBKEY : (!empty($_POST['public_key']) ? wp_unslash( $_POST['public_key'] ) : '');
+        $credentials['private_key'] = defined('FTP_PRIKEY') ? FTP_PRIKEY : (!empty($_POST['private_key']) ? wp_unslash( $_POST['private_key'] ) : '');
+
+        // Sanitize the hostname, Some people might pass in odd-data:
+        $credentials['hostname'] = preg_replace('|\w+://|', '', $credentials['hostname']); //Strip any schemes off
+
+        if ( strpos($credentials['hostname'], ':') ) {
+                list( $credentials['hostname'], $credentials['port'] ) = explode(':', $credentials['hostname'], 2);
+                if ( ! is_numeric($credentials['port']) )
+                        unset($credentials['port']);
+        } else {
+                unset($credentials['port']);
+        }
+
+        if ( ( defined( 'FTP_SSH' ) && FTP_SSH ) || ( defined( 'FS_METHOD' ) && 'ssh2' == FS_METHOD ) ) {
+                $credentials['connection_type'] = 'ssh';
+        } elseif ( ( defined( 'FTP_SSL' ) && FTP_SSL ) && 'ftpext' == $type ) { //Only the FTP Extension understands SSL
+                $credentials['connection_type'] = 'ftps';
+        } elseif ( ! empty( $_POST['connection_type'] ) ) {
+                $credentials['connection_type'] = wp_unslash( $_POST['connection_type'] );
+        } elseif ( ! isset( $credentials['connection_type'] ) ) { //All else fails (And it's not defaulted to something else saved), Default to FTP
+                $credentials['connection_type'] = 'ftp';
+        }
+
+        return $credentials;
+}
+
+/**
+ * Check credentials for required parameters
+ *
+ * @param array  $credentials   Credentials to check required parameters
+ *
+ * @return bool  True when all required parameters have been set for supplied type, False when anything is missing
+ */
+function usable_filesystem_credentials($credentials) {
+        // We need something to check against
+        if ( empty( $credentials ) ) {
+                return false;
+        }
+
+        // All the checks required an array for parameters; exit if we got something else
+        if ( ! is_array( $credentials ) ) {
+                return false;
+        }
+
+        if ( 'direct' == $credentials['connection_type'] ) {
+                return true;
+        }
+
+        // SSH needs public and private key
+        if ( isset($credentials['connection_type']) && 'ssh' == $credentials['connection_type'] ) {
+                if ( ! isset( $credentials['public_key'], $credentials['private_key'] ) ) {
+                        return false;
                 }
-        }
 
-        if ( ! $method && isset($args['connection_type']) && 'ssh' == $args['connection_type'] && extension_loaded('ssh2') && function_exists('stream_get_contents') ) $method = 'ssh2';
-        if ( ! $method && extension_loaded('ftp') ) $method = 'ftpext';
-        if ( ! $method && ( extension_loaded('sockets') || function_exists('fsockopen') ) ) $method = 'ftpsockets'; //Sockets: Socket extension; PHP Mode: FSockopen / fwrite / fread
+                return ( ! empty( $credentials['public_key'] ) && ! empty( $credentials['private_key'] ) );
+        }
 
-        /**
-         * Filter the filesystem method to use.
-         *
-         * @since 2.6.0
-         *
-         * @param string $method  Filesystem method to return.
-         * @param array  $args    An array of connection details for the method.
-         * @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.
-         */
-        return apply_filters( 'filesystem_method', $method, $args, $context, $allow_relaxed_file_ownership );
+        // Other connection methods need hostname, password and username
+        if ( ! isset( $credentials['password'], $credentials['username'], $credentials['hostname'] ) ) {
+                return false;
+        }
+
+        return ( ! empty( $credentials['password'] ) && ! empty( $credentials['username'] ) && ! empty( $credentials['hostname'] ) );
 }
 
 /**
@@ -982 +1094 @@
  * @return boolean 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 ) {
-
         /**
          * Filter the filesystem credentials form output.
          *
@@ -1001 +1112 @@
          * @param bool $allow_relaxed_file_ownership Whether to allow Group/World writable.
          * @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 )
-                return $req_cred;
+        $credentials = apply_filters( 'request_filesystem_credentials', '', $form_post, $type, $error, $context, $extra_fields, $allow_relaxed_file_ownership );
+        if ( '' !== $credentials ) {
+                return $credentials;
+        }
 
-        if ( empty($type) ) {
+        if ( empty( $type ) ) {
                 $type = get_filesystem_method( array(), $context, $allow_relaxed_file_ownership );
         }
 
-        if ( 'direct' == $type )
+        if ( 'direct' == $type ) {
                 return true;
+        }
 
-        if ( is_null( $extra_fields ) )
-                $extra_fields = array( 'version', 'locale' );
+        $credentials = get_filesystem_credentials( $form_post, $type, $error, $context, $extra_fields, $allow_relaxed_file_ownership );
 
-        $credentials = get_option('ftp_credentials', array( 'hostname' => '', 'username' => ''));
+        if ( 'direct' == $credentials['connection_type'] ) {
+                return true;
+        }
 
-        // If defined, set it to that, Else, If POST'd, set it to that, If not, Set it to whatever it previously was(saved details in option)
-        $credentials['hostname'] = defined('FTP_HOST') ? FTP_HOST : (!empty($_POST['hostname']) ? wp_unslash( $_POST['hostname'] ) : $credentials['hostname']);
-        $credentials['username'] = defined('FTP_USER') ? FTP_USER : (!empty($_POST['username']) ? wp_unslash( $_POST['username'] ) : $credentials['username']);
-        $credentials['password'] = defined('FTP_PASS') ? FTP_PASS : (!empty($_POST['password']) ? wp_unslash( $_POST['password'] ) : '');
+        if ( ! $error && usable_filesystem_credentials( $credentials ) ) {
 
-        // Check to see if we are setting the public/private keys for ssh
-        $credentials['public_key'] = defined('FTP_PUBKEY') ? FTP_PUBKEY : (!empty($_POST['public_key']) ? wp_unslash( $_POST['public_key'] ) : '');
-        $credentials['private_key'] = defined('FTP_PRIKEY') ? FTP_PRIKEY : (!empty($_POST['private_key']) ? wp_unslash( $_POST['private_key'] ) : '');
-
-        // Sanitize the hostname, Some people might pass in odd-data:
-        $credentials['hostname'] = preg_replace('|\w+://|', '', $credentials['hostname']); //Strip any schemes off
-
-        if ( strpos($credentials['hostname'], ':') ) {
-                list( $credentials['hostname'], $credentials['port'] ) = explode(':', $credentials['hostname'], 2);
-                if ( ! is_numeric($credentials['port']) )
-                        unset($credentials['port']);
-        } else {
-                unset($credentials['port']);
-        }
-
-        if ( ( defined( 'FTP_SSH' ) && FTP_SSH ) || ( defined( 'FS_METHOD' ) && 'ssh2' == FS_METHOD ) ) {
-                $credentials['connection_type'] = 'ssh';
-        } elseif ( ( defined( 'FTP_SSL' ) && FTP_SSL ) && 'ftpext' == $type ) { //Only the FTP Extension understands SSL
-                $credentials['connection_type'] = 'ftps';
-        } elseif ( ! empty( $_POST['connection_type'] ) ) {
-                $credentials['connection_type'] = wp_unslash( $_POST['connection_type'] );
-        } elseif ( ! isset( $credentials['connection_type'] ) ) { //All else fails (And it's not defaulted to something else saved), Default to FTP
-                $credentials['connection_type'] = 'ftp';
-        }
-        if ( ! $error &&
-                        (
-                                ( !empty($credentials['password']) && !empty($credentials['username']) && !empty($credentials['hostname']) ) ||
-                                ( 'ssh' == $credentials['connection_type'] && !empty($credentials['public_key']) && !empty($credentials['private_key']) )
-                        ) ) {
                 $stored_credentials = $credentials;
-                if ( !empty($stored_credentials['port']) ) //save port as part of hostname to simplify above code.
+                if ( ! empty( $stored_credentials['port'] ) ) //save port as part of hostname to simplify retrievement code
+                {
                         $stored_credentials['hostname'] .= ':' . $stored_credentials['port'];
+                }
 
-                unset($stored_credentials['password'], $stored_credentials['port'], $stored_credentials['private_key'], $stored_credentials['public_key']);
+                unset( $stored_credentials['password'], $stored_credentials['port'], $stored_credentials['private_key'], $stored_credentials['public_key'] );
+
                 if ( ! defined( 'WP_INSTALLING' ) ) {
                         update_option( 'ftp_credentials', $stored_credentials );
                 }
+
                 return $credentials;
         }
+
+        // Display the credentials form to the user
+        request_filesystem_credentials_form( $form_post, $credentials, $type, $error, $context, $extra_fields );
+
+        // Nothing usable has been found yet.
+        return false;
+}
+
+/**
+ * Write the form needed to input credentials needed to connect for the specified type
+ *
+ * @param string $form_post the URL to post the form to
+ * @param $credentials
+ * @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.
+ */
+function request_filesystem_credentials_form($form_post, $credentials, $type = '', $error = false, $context = null, $extra_fields = null, $allow_relaxed_file_ownership = false) {
+        if ( empty( $type ) ) {
+                $type = get_filesystem_method( array(), $context, $allow_relaxed_file_ownership );
+        }
+
+        if ( ! is_array($credentials)) {
+                $credentials = array();
+        }
+
         $hostname = isset( $credentials['hostname'] ) ? $credentials['hostname'] : '';
         $username = isset( $credentials['username'] ) ? $credentials['username'] : '';
         $public_key = isset( $credentials['public_key'] ) ? $credentials['public_key'] : '';
@@ -1068 +1182 @@
         $port = isset( $credentials['port'] ) ? $credentials['port'] : '';
         $connection_type = isset( $credentials['connection_type'] ) ? $credentials['connection_type'] : '';
 
+        if ( is_null( $extra_fields ) )
+                $extra_fields = array( 'version', 'locale' );
+
         if ( $error ) {
                 $error_string = __('<strong>ERROR:</strong> There was an error connecting to the server, Please verify the settings are correct.');
                 if ( is_wp_error($error) )
@@ -1190 +1307 @@
 </div>
 </form>
 <?php
-        return false;
+
 }

tests/phpunit/tests/filesystem/credentials.php

@@ +1 @@
+<?php
+
+/**
+ * @group filesystem
+ * @group wp-filesystem
+ */
+
+class Tests_Filesystem_Credentials extends WP_UnitTestCase {
+        /**
+         *
+         */
+        function test_get_filesystem_credentials() {
+                // test direct type
+                $credentials = get_filesystem_credentials('', 'direct');
+                $this->assertInternalType( 'array', $credentials );
+                $this->assertArrayHasKey( 'connection_type', $credentials );
+                $this->assertEquals( 'direct', $credentials['connection_type'] );
+
+                // test SSH
+                $credentials = get_filesystem_credentials('', 'ssh');
+                $this->assertInternalType( 'array', $credentials );
+
+                $this->assertArrayHasKey( 'connection_type', $credentials );
+                $this->assertArrayHasKey( 'private_key', $credentials );
+                $this->assertArrayHasKey( 'public_key', $credentials );
+                $this->assertArrayHasKey( 'hostname', $credentials );
+                $this->assertArrayHasKey( 'username', $credentials );
+                $this->assertArrayHasKey( 'password', $credentials );
+
+                $this->assertEquals( '', $credentials['private_key'] );
+                $this->assertEquals( '', $credentials['public_key'] );
+                $this->assertEquals( '', $credentials['hostname'] );
+                $this->assertEquals( '', $credentials['username'] );
+                $this->assertEquals( '', $credentials['password'] );
+
+                $_POST['hostname'] = rand_str();
+                $_POST['private_key'] = rand_str();
+                $_POST['public_key'] = rand_str();
+                $_POST['username'] = rand_str();
+                $_POST['password'] = rand_str();
+
+                $credentials = get_filesystem_credentials('', 'ftp');
+
+                $this->assertEquals( $_POST['private_key'], $credentials['private_key'] );
+                $this->assertEquals( $_POST['public_key'], $credentials['public_key'] );
+                $this->assertEquals( $_POST['hostname'], $credentials['hostname'] );
+                $this->assertEquals( $_POST['username'], $credentials['username'] );
+                $this->assertEquals( $_POST['password'], $credentials['password'] );
+
+                unset($_POST['hostname'], $_POST['private_key'], $_POST['public_key'], $_POST['username'], $_POST['password']);
+
+
+                // test filter override:
+                add_filter( 'request_filesystem_credentials', array('Tests_Filesystem_Credentials', '__filesystem_credentials'), 10, 3);
+
+                $credentials = get_filesystem_credentials('', 'ssh');
+                $_credentials = Tests_Filesystem_Credentials::__filesystem_credentials('', '', 'ssh');
+
+                $this->assertEquals( $_credentials, $credentials);
+
+                // clean up filter
+                remove_filter( 'request_filesystem_credentials', array('Tests_Filesystem_Credentials', '__filesystem_credentials'), 10, 3);
+        }
+
+        /**
+         *
+         */
+        function test_usable_filesystem_credentials() {
+                $credentials = array('connection_type' => 'direct');
+
+                $this->assertTrue( usable_filesystem_credentials( $credentials ) );
+
+                // ssh: only one that needs public/private keys
+                $credentials = get_filesystem_credentials( '', 'ssh' );
+                $credentials['connection_type'] = 'ssh';
+
+                $this->assertFalse( usable_filesystem_credentials( $credentials ) );
+
+                $credentials['private_key'] = $credentials['public_key'] = 'a_value';
+                $this->assertTrue( usable_filesystem_credentials( $credentials ) );
+
+                // ssh2
+                $credentials['connection_type'] = 'ssh2';
+                $this->assertFalse( usable_filesystem_credentials( $credentials ) );
+
+                $credentials = array(
+                        'hostname' => 'a',
+                        'username' => 'b',
+                        'password' => 'c',
+                        'connection_type' => 'ssh2'
+                );
+                $this->assertTrue( usable_filesystem_credentials( $credentials ) );
+
+
+                // ftp
+                $credentials = array(
+                        'hostname' => '',
+                        'username' => '',
+                        'password' => '',
+                        'connection_type' => 'ftp'
+                );
+                $this->assertFalse( usable_filesystem_credentials( $credentials ) );
+
+                $credentials = array(
+                        'hostname' => 'a',
+                        'username' => 'b',
+                        'password' => 'c',
+                        'connection_type' => 'ftp'
+                );
+                $this->assertTrue( usable_filesystem_credentials( $credentials ) );
+        }
+
+        /** Helper functions */
+        public static function __filesystem_credentials($empty, $form_url, $type) {
+                switch ($type) {
+                        case 'ssh':
+                                $credentials = array(
+                                        'connection_type' => 'ssh',
+                                        'private_key' => 'b',
+                                        'public_key' => 'c'
+                                );
+                                break;
+                        default:
+                                $credentials = array(
+                                        'hostname' => 'a',
+                                        'username' => 'b',
+                                        'password' => 'c',
+                                        'connection_type' => 'ftp'
+                                );
+                                break;
+                }
+
+                return $credentials;
+        }
+}