WordPress 4.3

[autoinstalls/wordpress.git] / wp-admin / includes / class-wp-filesystem-base.php

diff --git a/wp-admin/includes/class-wp-filesystem-base.php b/wp-admin/includes/class-wp-filesystem-base.php
index 4630f710ea7cda4e3b2d7a2c590f792889c1192e..80d92501ad6a9cb15abfe4f5d9556b8befcc135b 100644 (file)
--- a/wp-admin/includes/class-wp-filesystem-base.php
+++ b/wp-admin/includes/class-wp-filesystem-base.php
@@ -24,11 +24,10 @@ class WP_Filesystem_Base {
        /**
         * Cached list of local filepaths to mapped remote filepaths.
         *
        /**
         * Cached list of local filepaths to mapped remote filepaths.
         *

-        * @access private

         * @since 2.7.0
         * @var array
         */
         * @since 2.7.0
         * @var array
         */

-       private $cache = array();
+       public $cache = array();

 
        /**
         * The Access method of the current connection, Set automatically.
 
        /**
         * The Access method of the current connection, Set automatically.


@@ -39,57 +38,9 @@ class WP_Filesystem_Base {
         */
        public $method = '';
 
         */
        public $method = '';
 

-       /**
-        * Make private properties readable for backwards compatibility.
-        *
-        * @since 4.0.0
-        * @access public
-        *
-        * @param string $name Property to get.
-        * @return mixed Property.
-        */
-       public function __get( $name ) {
-               return $this->$name;
-       }
-
-       /**
-        * Make private properties settable for backwards compatibility.
-        *
-        * @since 4.0.0
-        * @access public
-        *
-        * @param string $name  Property to set.
-        * @param mixed  $value Property value.
-        * @return mixed Newly-set property.
-        */
-       public function __set( $name, $value ) {
-               return $this->$name = $value;
-       }
-
-       /**
-        * Make private properties checkable for backwards compatibility.
-        *
-        * @since 4.0.0
-        * @access public
-        *
-        * @param string $name Property to check if set.
-        * @return bool Whether the property is set.
-        */
-       public function __isset( $name ) {
-               return isset( $this->$name );
-       }
+       public $errors = null;

 
 

-       /**
-        * Make private properties un-settable for backwards compatibility.
-        *
-        * @since 4.0.0
-        * @access public
-        *
-        * @param string $name Property to unset.
-        */
-       public function __unset( $name ) {
-               unset( $this->$name );
-       }
+       public $options = array();

 
        /**
         * Return the path on the remote filesystem of ABSPATH.
 
        /**
         * Return the path on the remote filesystem of ABSPATH.


@@ -217,10 +168,9 @@ class WP_Filesystem_Base {
         * @since 2.7.0
         *
         * @param string $folder the folder to locate.
         * @since 2.7.0
         *
         * @param string $folder the folder to locate.

-        * @return string The location of the remote path.
+        * @return string|false The location of the remote path, false on failure.

         */
        public function find_folder( $folder ) {
         */
        public function find_folder( $folder ) {

-

                if ( isset( $this->cache[ $folder ] ) )
                        return $this->cache[ $folder ];
 
                if ( isset( $this->cache[ $folder ] ) )
                        return $this->cache[ $folder ];
 


@@ -280,13 +230,12 @@ class WP_Filesystem_Base {
         *
         * Expects Windows sanitized path.
         *
         *
         * Expects Windows sanitized path.
         *

-        * @access private

         * @since 2.7.0
         *
         * @param string $folder The folder to locate.
         * @param string $base   The folder to start searching from.
         * @param bool   $loop   If the function has recursed, Internal use only.
         * @since 2.7.0
         *
         * @param string $folder The folder to locate.
         * @param string $base   The folder to start searching from.
         * @param bool   $loop   If the function has recursed, Internal use only.

-        * @return string The location of the remote path.
+        * @return string|false The location of the remote path, false to cease looping.

         */
        public function search_for_folder( $folder, $base = '.', $loop = false ) {
                if ( empty( $base ) || '.' == $base )
         */
        public function search_for_folder( $folder, $base = '.', $loop = false ) {
                if ( empty( $base ) || '.' == $base )


@@ -317,7 +266,7 @@ class WP_Filesystem_Base {
                         */
                        if ( isset($files[ $key ]) ){
 
                         */
                        if ( isset($files[ $key ]) ){
 

-                               // Lets try that folder:
+                               // Let's try that folder:

                                $newdir = trailingslashit(path_join($base, $key));
                                if ( $this->verbose )
                                        printf( "\n" . __('Changing to %s') . "<br/>\n", $newdir );
                                $newdir = trailingslashit(path_join($base, $key));
                                if ( $this->verbose )
                                        printf( "\n" . __('Changing to %s') . "<br/>\n", $newdir );


@@ -361,7 +310,7 @@ class WP_Filesystem_Base {
         * @return string The *nix-style representation of permissions.
         */
        public function gethchmod( $file ){
         * @return string The *nix-style representation of permissions.
         */
        public function gethchmod( $file ){

-               $perms = $this->getchmod($file);
+               $perms = intval( $this->getchmod( $file ), 8 );

                if (($perms & 0xC000) == 0xC000) // Socket
                        $info = 's';
                elseif (($perms & 0xA000) == 0xA000) // Symbolic Link
                if (($perms & 0xC000) == 0xC000) // Socket
                        $info = 's';
                elseif (($perms & 0xA000) == 0xA000) // Symbolic Link


@@ -402,6 +351,17 @@ class WP_Filesystem_Base {
                return $info;
        }
 
                return $info;
        }
 

+       /**
+        * Gets the permissions of the specified file or filepath in their octal format
+        *
+        * @since 2.5.0
+        * @param string $file
+        * @return string the last 3 characters of the octal number
+        */
+       public function getchmod( $file ) {
+               return '777';
+       }
+

        /**
         * Convert *nix-style file permissions to a octal number.
         *
        /**
         * Convert *nix-style file permissions to a octal number.
         *


@@ -421,9 +381,11 @@ class WP_Filesystem_Base {
                $legal =  array('', 'w', 'r', 'x', '-');
                $attarray = preg_split('//', $mode);
 
                $legal =  array('', 'w', 'r', 'x', '-');
                $attarray = preg_split('//', $mode);
 

-               for ($i=0; $i < count($attarray); $i++)
-                  if ($key = array_search($attarray[$i], $legal))
+               for ( $i = 0, $c = count( $attarray ); $i < $c; $i++ ) {
+                  if ($key = array_search($attarray[$i], $legal)) {

                           $realmode .= $legal[$key];
                           $realmode .= $legal[$key];

+                  }
+               }

 
                $mode = str_pad($realmode, 10, '-', STR_PAD_LEFT);
                $trans = array('-'=>'0', 'r'=>'4', 'w'=>'2', 'x'=>'1');
 
                $mode = str_pad($realmode, 10, '-', STR_PAD_LEFT);
                $trans = array('-'=>'0', 'r'=>'4', 'w'=>'2', 'x'=>'1');


@@ -439,7 +401,6 @@ class WP_Filesystem_Base {
        /**
         * Determine if the string provided contains binary characters.
         *
        /**
         * Determine if the string provided contains binary characters.
         *

-        * @access private

         * @since 2.7.0
         *
         * @param string $text String to test against.
         * @since 2.7.0
         *
         * @param string $text String to test against.


@@ -469,7 +430,7 @@ class WP_Filesystem_Base {
         * Connect filesystem.
         *
         * @since 2.5.0
         * Connect filesystem.
         *
         * @since 2.5.0

-        *
+        * @abstract

         * @return bool True on success or false on failure (always true for WP_Filesystem_Direct).
         */
        public function connect() {
         * @return bool True on success or false on failure (always true for WP_Filesystem_Direct).
         */
        public function connect() {


@@ -480,9 +441,9 @@ class WP_Filesystem_Base {
         * Read entire file into a string.
         *
         * @since 2.5.0
         * Read entire file into a string.
         *
         * @since 2.5.0

-        *
+        * @abstract

         * @param string $file Name of the file to read.
         * @param string $file Name of the file to read.

-        * @return string|bool Returns the read data or false on failure.
+        * @return mixed|bool Returns the read data or false on failure.

         */
        public function get_contents( $file ) {
                return false;
         */
        public function get_contents( $file ) {
                return false;


@@ -492,7 +453,7 @@ class WP_Filesystem_Base {
         * Read entire file into an array.
         *
         * @since 2.5.0
         * Read entire file into an array.
         *
         * @since 2.5.0

-        *
+        * @abstract

         * @param string $file Path to the file.
         * @return array|bool the file contents in an array or false on failure.
         */
         * @param string $file Path to the file.
         * @return array|bool the file contents in an array or false on failure.
         */


@@ -504,7 +465,7 @@ class WP_Filesystem_Base {
         * Write a string to a file.
         *
         * @since 2.5.0
         * Write a string to a file.
         *
         * @since 2.5.0

-        *
+        * @abstract

         * @param string $file     Remote path to the file where to write the data.
         * @param string $contents The data to write.
         * @param int    $mode     Optional. The file permissions as octal number, usually 0644.
         * @param string $file     Remote path to the file where to write the data.
         * @param string $contents The data to write.
         * @param int    $mode     Optional. The file permissions as octal number, usually 0644.


@@ -518,7 +479,7 @@ class WP_Filesystem_Base {
         * Get the current working directory.
         *
         * @since 2.5.0
         * Get the current working directory.
         *
         * @since 2.5.0

-        *
+        * @abstract

         * @return string|bool The current working directory on success, or false on failure.
         */
        public function cwd() {
         * @return string|bool The current working directory on success, or false on failure.
         */
        public function cwd() {


@@ -529,9 +490,9 @@ class WP_Filesystem_Base {
         * Change current directory.
         *
         * @since 2.5.0
         * Change current directory.
         *
         * @since 2.5.0

-        *
+        * @abstract

         * @param string $dir The new current directory.
         * @param string $dir The new current directory.

-        * @return bool Returns true on success or false on failure.
+        * @return bool|string

         */
        public function chdir( $dir ) {
                return false;
         */
        public function chdir( $dir ) {
                return false;


@@ -541,11 +502,11 @@ class WP_Filesystem_Base {
         * Change the file group.
         *
         * @since 2.5.0
         * Change the file group.
         *
         * @since 2.5.0

-        *
+        * @abstract

         * @param string $file      Path to the file.
         * @param mixed  $group     A group name or number.
         * @param bool   $recursive Optional. If set True changes file group recursively. Defaults to False.
         * @param string $file      Path to the file.
         * @param mixed  $group     A group name or number.
         * @param bool   $recursive Optional. If set True changes file group recursively. Defaults to False.

-        * @return bool Returns true on success or false on failure.
+        * @return bool|string

         */
        public function chgrp( $file, $group, $recursive = false ) {
                return false;
         */
        public function chgrp( $file, $group, $recursive = false ) {
                return false;


@@ -555,11 +516,11 @@ class WP_Filesystem_Base {
         * Change filesystem permissions.
         *
         * @since 2.5.0
         * Change filesystem permissions.
         *
         * @since 2.5.0

-        *
+        * @abstract

         * @param string $file      Path to the file.
         * @param int    $mode      Optional. The permissions as octal number, usually 0644 for files, 0755 for dirs.
         * @param bool   $recursive Optional. If set True changes file group recursively. Defaults to False.
         * @param string $file      Path to the file.
         * @param int    $mode      Optional. The permissions as octal number, usually 0644 for files, 0755 for dirs.
         * @param bool   $recursive Optional. If set True changes file group recursively. Defaults to False.

-        * @return bool Returns true on success or false on failure.
+        * @return bool|string

         */
        public function chmod( $file, $mode = false, $recursive = false ) {
                return false;
         */
        public function chmod( $file, $mode = false, $recursive = false ) {
                return false;


@@ -569,7 +530,7 @@ class WP_Filesystem_Base {
         * Get the file owner.
         *
         * @since 2.5.0
         * Get the file owner.
         *
         * @since 2.5.0

-        *
+        * @abstract

         * @param string $file Path to the file.
         * @return string|bool Username of the user or false on error.
         */
         * @param string $file Path to the file.
         * @return string|bool Username of the user or false on error.
         */


@@ -581,7 +542,7 @@ class WP_Filesystem_Base {
         * Get the file's group.
         *
         * @since 2.5.0
         * Get the file's group.
         *
         * @since 2.5.0

-        *
+        * @abstract

         * @param string $file Path to the file.
         * @return string|bool The group or false on error.
         */
         * @param string $file Path to the file.
         * @return string|bool The group or false on error.
         */


@@ -593,7 +554,7 @@ class WP_Filesystem_Base {
         * Copy a file.
         *
         * @since 2.5.0
         * Copy a file.
         *
         * @since 2.5.0

-        *
+        * @abstract

         * @param string $source      Path to the source file.
         * @param string $destination Path to the destination file.
         * @param bool   $overwrite   Optional. Whether to overwrite the destination file if it exists.
         * @param string $source      Path to the source file.
         * @param string $destination Path to the destination file.
         * @param bool   $overwrite   Optional. Whether to overwrite the destination file if it exists.


@@ -610,7 +571,7 @@ class WP_Filesystem_Base {
         * Move a file.
         *
         * @since 2.5.0
         * Move a file.
         *
         * @since 2.5.0

-        *
+        * @abstract

         * @param string $source      Path to the source file.
         * @param string $destination Path to the destination file.
         * @param bool   $overwrite   Optional. Whether to overwrite the destination file if it exists.
         * @param string $source      Path to the source file.
         * @param string $destination Path to the destination file.
         * @param bool   $overwrite   Optional. Whether to overwrite the destination file if it exists.


@@ -625,7 +586,7 @@ class WP_Filesystem_Base {
         * Delete a file or directory.
         *
         * @since 2.5.0
         * Delete a file or directory.
         *
         * @since 2.5.0

-        *
+        * @abstract

         * @param string $file      Path to the file.
         * @param bool   $recursive Optional. If set True changes file group recursively. Defaults to False.
         *                          Default false.
         * @param string $file      Path to the file.
         * @param bool   $recursive Optional. If set True changes file group recursively. Defaults to False.
         *                          Default false.


@@ -641,7 +602,7 @@ class WP_Filesystem_Base {
         * Check if a file or directory exists.
         *
         * @since 2.5.0
         * Check if a file or directory exists.
         *
         * @since 2.5.0

-        *
+        * @abstract

         * @param string $file Path to file/directory.
         * @return bool Whether $file exists or not.
         */
         * @param string $file Path to file/directory.
         * @return bool Whether $file exists or not.
         */


@@ -653,7 +614,7 @@ class WP_Filesystem_Base {
         * Check if resource is a file.
         *
         * @since 2.5.0
         * Check if resource is a file.
         *
         * @since 2.5.0

-        *
+        * @abstract

         * @param string $file File path.
         * @return bool Whether $file is a file.
         */
         * @param string $file File path.
         * @return bool Whether $file is a file.
         */


@@ -665,7 +626,7 @@ class WP_Filesystem_Base {
         * Check if resource is a directory.
         *
         * @since 2.5.0
         * Check if resource is a directory.
         *
         * @since 2.5.0

-        *
+        * @abstract

         * @param string $path Directory path.
         * @return bool Whether $path is a directory.
         */
         * @param string $path Directory path.
         * @return bool Whether $path is a directory.
         */


@@ -677,7 +638,7 @@ class WP_Filesystem_Base {
         * Check if a file is readable.
         *
         * @since 2.5.0
         * Check if a file is readable.
         *
         * @since 2.5.0

-        *
+        * @abstract

         * @param string $file Path to file.
         * @return bool Whether $file is readable.
         */
         * @param string $file Path to file.
         * @return bool Whether $file is readable.
         */


@@ -689,8 +650,7 @@ class WP_Filesystem_Base {
         * Check if a file or directory is writable.
         *
         * @since 2.5.0
         * Check if a file or directory is writable.
         *
         * @since 2.5.0

-        *
-        * @param string $path Path to file/directory.
+        * @abstract

         * @return bool Whether $file is writable.
         */
        public function is_writable( $file ) {
         * @return bool Whether $file is writable.
         */
        public function is_writable( $file ) {


@@ -701,9 +661,9 @@ class WP_Filesystem_Base {
         * Gets the file's last access time.
         *
         * @since 2.5.0
         * Gets the file's last access time.
         *
         * @since 2.5.0

-        *
+        * @abstract

         * @param string $file Path to file.
         * @param string $file Path to file.

-        * @return int Unix timestamp representing last access time.
+        * @return int|bool Unix timestamp representing last access time.

         */
        public function atime( $file ) {
                return false;
         */
        public function atime( $file ) {
                return false;


@@ -713,9 +673,9 @@ class WP_Filesystem_Base {
         * Gets the file modification time.
         *
         * @since 2.5.0
         * Gets the file modification time.
         *
         * @since 2.5.0

-        *
+        * @abstract

         * @param string $file Path to file.
         * @param string $file Path to file.

-        * @return int Unix timestamp representing modification time.
+        * @return int|bool Unix timestamp representing modification time.

         */
        public function mtime( $file ) {
                return false;
         */
        public function mtime( $file ) {
                return false;


@@ -725,9 +685,9 @@ class WP_Filesystem_Base {
         * Gets the file size (in bytes).
         *
         * @since 2.5.0
         * Gets the file size (in bytes).
         *
         * @since 2.5.0

-        *
+        * @abstract

         * @param string $file Path to file.
         * @param string $file Path to file.

-        * @return int Size of the file in bytes.
+        * @return int|bool Size of the file in bytes.

         */
        public function size( $file ) {
                return false;
         */
        public function size( $file ) {
                return false;


@@ -739,7 +699,7 @@ class WP_Filesystem_Base {
         * Note: If $file doesn't exist, it will be created.
         *
         * @since 2.5.0
         * Note: If $file doesn't exist, it will be created.
         *
         * @since 2.5.0

-        *
+        * @abstract

         * @param string $file  Path to file.
         * @param int    $time  Optional. Modified time to set for file.
         *                      Default 0.
         * @param string $file  Path to file.
         * @param int    $time  Optional. Modified time to set for file.
         *                      Default 0.


@@ -755,7 +715,7 @@ class WP_Filesystem_Base {
         * Create a directory.
         *
         * @since 2.5.0
         * Create a directory.
         *
         * @since 2.5.0

-        *
+        * @abstract

         * @param string $path  Path for new directory.
         * @param mixed  $chmod Optional. The permissions as octal number, (or False to skip chmod)
         *                      Default false.
         * @param string $path  Path for new directory.
         * @param mixed  $chmod Optional. The permissions as octal number, (or False to skip chmod)
         *                      Default false.


@@ -773,7 +733,7 @@ class WP_Filesystem_Base {
         * Delete a directory.
         *
         * @since 2.5.0
         * Delete a directory.
         *
         * @since 2.5.0

-        *
+        * @abstract

         * @param string $path      Path to directory.
         * @param bool   $recursive Optional. Whether to recursively remove files/directories.
         *                          Default false.
         * @param string $path      Path to directory.
         * @param bool   $recursive Optional. Whether to recursively remove files/directories.
         *                          Default false.


@@ -787,6 +747,7 @@ class WP_Filesystem_Base {
         * Get details for files in a directory or a specific file.
         *
         * @since 2.5.0
         * Get details for files in a directory or a specific file.
         *
         * @since 2.5.0

+        * @abstract

         *
         * @param string $path           Path to directory or file.
         * @param bool   $include_hidden Optional. Whether to include details of hidden ("." prefixed) files.
         *
         * @param string $path           Path to directory or file.
         * @param bool   $include_hidden Optional. Whether to include details of hidden ("." prefixed) files.


@@ -796,16 +757,16 @@ class WP_Filesystem_Base {
         * @return array|bool {
         *     Array of files. False if unable to list directory contents.
         *
         * @return array|bool {
         *     Array of files. False if unable to list directory contents.
         *

-        *     @type string 'name'        Name of the file/directory.
-        *     @type string 'perms'       *nix representation of permissions.
-        *     @type int    'permsn'      Octal representation of permissions.
-        *     @type string 'owner'       Owner name or ID.
-        *     @type int    'size'        Size of file in bytes.
-        *     @type int    'lastmodunix' Last modified unix timestamp.
-        *     @type mixed  'lastmod'     Last modified month (3 letter) and day (without leading 0).
-        *     @type int    'time'        Last modified time.
-        *     @type string 'type'        Type of resource. 'f' for file, 'd' for directory.
-        *     @type mixed  'files'       If a directory and $recursive is true, contains another array of files.
+        *     @type string $name        Name of the file/directory.
+        *     @type string $perms       *nix representation of permissions.
+        *     @type int    $permsn      Octal representation of permissions.
+        *     @type string $owner       Owner name or ID.
+        *     @type int    $size        Size of file in bytes.
+        *     @type int    $lastmodunix Last modified unix timestamp.
+        *     @type mixed  $lastmod     Last modified month (3 letter) and day (without leading 0).
+        *     @type int    $time        Last modified time.
+        *     @type string $type        Type of resource. 'f' for file, 'd' for directory.
+        *     @type mixed  $files       If a directory and $recursive is true, contains another array of files.

         * }
         */
        public function dirlist( $path, $include_hidden = true, $recursive = false ) {
         * }
         */
        public function dirlist( $path, $include_hidden = true, $recursive = false ) {