X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/7f1521bf193b382565eb753043c161f4cb3fcda7..607b7e02d77e7326161e8ec15639052d2040f745:/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 f8aeb86f..87cf3f55 100644
--- a/wp-admin/includes/class-wp-filesystem-base.php
+++ b/wp-admin/includes/class-wp-filesystem-base.php
@@ -24,6 +24,7 @@ class WP_Filesystem_Base {
/**
* Cached list of local filepaths to mapped remote filepaths.
*
+ * @access public
* @since 2.7.0
* @var array
*/
@@ -38,8 +39,15 @@ class WP_Filesystem_Base {
*/
public $method = '';
+ /**
+ * @access public
+ * @var WP_Error
+ */
public $errors = null;
+ /**
+ * @access public
+ */
public $options = array();
/**
@@ -131,7 +139,7 @@ class WP_Filesystem_Base {
* @return string The location of the remote path.
*/
public function find_base_dir( $base = '.', $echo = false ) {
- _deprecated_function(__FUNCTION__, '2.7', 'WP_Filesystem::abspath() or WP_Filesystem::wp_*_dir()' );
+ _deprecated_function(__FUNCTION__, '2.7.0', 'WP_Filesystem::abspath() or WP_Filesystem::wp_*_dir()' );
$this->verbose = $echo;
return $this->abspath();
}
@@ -153,7 +161,7 @@ class WP_Filesystem_Base {
* @return string The location of the remote path.
*/
public function get_base_dir( $base = '.', $echo = false ) {
- _deprecated_function(__FUNCTION__, '2.7', 'WP_Filesystem::abspath() or WP_Filesystem::wp_*_dir()' );
+ _deprecated_function(__FUNCTION__, '2.7.0', 'WP_Filesystem::abspath() or WP_Filesystem::wp_*_dir()' );
$this->verbose = $echo;
return $this->abspath();
}
@@ -171,7 +179,6 @@ class WP_Filesystem_Base {
* @return string|false The location of the remote path, false on failure.
*/
public function find_folder( $folder ) {
-
if ( isset( $this->cache[ $folder ] ) )
return $this->cache[ $folder ];
@@ -231,6 +238,7 @@ class WP_Filesystem_Base {
*
* Expects Windows sanitized path.
*
+ * @access public
* @since 2.7.0
*
* @param string $folder The folder to locate.
@@ -244,8 +252,10 @@ class WP_Filesystem_Base {
$folder = untrailingslashit($folder);
- if ( $this->verbose )
- printf( "\n" . __('Looking for %1$s in %2$s') . "
\n", $folder, $base );
+ if ( $this->verbose ) {
+ /* translators: 1: folder to locate, 2: folder to start searching from */
+ printf( "\n" . __( 'Looking for %1$s in %2$s' ) . "
\n", $folder, $base );
+ }
$folder_parts = explode('/', $folder);
$folder_part_keys = array_keys( $folder_parts );
@@ -269,8 +279,10 @@ class WP_Filesystem_Base {
// Let's try that folder:
$newdir = trailingslashit(path_join($base, $key));
- if ( $this->verbose )
- printf( "\n" . __('Changing to %s') . "
\n", $newdir );
+ if ( $this->verbose ) {
+ /* translators: %s: directory name */
+ printf( "\n" . __( 'Changing to %s' ) . "
\n", $newdir );
+ }
// Only search for the remaining path tokens in the directory, not the full path again.
$newfolder = implode( '/', array_slice( $folder_parts, $index + 1 ) );
@@ -279,10 +291,13 @@ class WP_Filesystem_Base {
}
}
- // Only check this as a last resort, to prevent locating the incorrect install. All above procedures will fail quickly if this is the right branch to take.
+ // Only check this as a last resort, to prevent locating the incorrect install.
+ // All above procedures will fail quickly if this is the right branch to take.
if (isset( $files[ $last_path ] ) ) {
- if ( $this->verbose )
- printf( "\n" . __('Found %s') . "
\n", $base . $last_path );
+ if ( $this->verbose ) {
+ /* translators: %s: directory name */
+ printf( "\n" . __( 'Found %s' ) . "
\n", $base . $last_path );
+ }
return trailingslashit($base . $last_path);
}
@@ -302,7 +317,7 @@ class WP_Filesystem_Base {
*
* From the PHP documentation page for fileperms().
*
- * @link http://docs.php.net/fileperms
+ * @link https://secure.php.net/manual/en/function.fileperms.php
*
* @access public
* @since 2.5.0
@@ -311,7 +326,7 @@ class WP_Filesystem_Base {
* @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
@@ -352,13 +367,25 @@ class WP_Filesystem_Base {
return $info;
}
+ /**
+ * Gets the permissions of the specified file or filepath in their octal format
+ *
+ * @access public
+ * @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.
*
* Converts '-rw-r--r--' to 0644
* From "info at rvgate dot nl"'s comment on the PHP documentation for chmod()
*
- * @link http://docs.php.net/manual/en/function.chmod.php#49614
+ * @link https://secure.php.net/manual/en/function.chmod.php#49614
*
* @access public
* @since 2.5.0
@@ -391,6 +418,7 @@ class WP_Filesystem_Base {
/**
* Determine if the string provided contains binary characters.
*
+ * @access public
* @since 2.7.0
*
* @param string $text String to test against.
@@ -405,6 +433,7 @@ class WP_Filesystem_Base {
*
* Default behavior is to do nothing, override this in your subclass, if desired.
*
+ * @access public
* @since 2.5.0
*
* @param string $file Path to the file.
@@ -419,8 +448,10 @@ class WP_Filesystem_Base {
/**
* Connect filesystem.
*
+ * @access public
* @since 2.5.0
* @abstract
+ *
* @return bool True on success or false on failure (always true for WP_Filesystem_Direct).
*/
public function connect() {
@@ -430,8 +461,10 @@ class WP_Filesystem_Base {
/**
* Read entire file into a string.
*
+ * @access public
* @since 2.5.0
* @abstract
+ *
* @param string $file Name of the file to read.
* @return mixed|bool Returns the read data or false on failure.
*/
@@ -442,8 +475,10 @@ class WP_Filesystem_Base {
/**
* Read entire file into an array.
*
+ * @access public
* @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.
*/
@@ -454,8 +489,10 @@ class WP_Filesystem_Base {
/**
* Write a string to a file.
*
+ * @access public
* @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.
@@ -468,8 +505,10 @@ class WP_Filesystem_Base {
/**
* Get the current working directory.
*
+ * @access public
* @since 2.5.0
* @abstract
+ *
* @return string|bool The current working directory on success, or false on failure.
*/
public function cwd() {
@@ -479,10 +518,12 @@ class WP_Filesystem_Base {
/**
* Change current directory.
*
+ * @access public
* @since 2.5.0
* @abstract
+ *
* @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;
@@ -491,12 +532,14 @@ class WP_Filesystem_Base {
/**
* Change the file group.
*
+ * @access public
* @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.
- * @return bool Returns true on success or false on failure.
+ * @return bool|string
*/
public function chgrp( $file, $group, $recursive = false ) {
return false;
@@ -505,12 +548,14 @@ class WP_Filesystem_Base {
/**
* Change filesystem permissions.
*
+ * @access public
* @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.
- * @return bool Returns true on success or false on failure.
+ * @return bool|string
*/
public function chmod( $file, $mode = false, $recursive = false ) {
return false;
@@ -519,8 +564,10 @@ class WP_Filesystem_Base {
/**
* Get the file owner.
*
+ * @access public
* @since 2.5.0
* @abstract
+ *
* @param string $file Path to the file.
* @return string|bool Username of the user or false on error.
*/
@@ -531,8 +578,10 @@ class WP_Filesystem_Base {
/**
* Get the file's group.
*
+ * @access public
* @since 2.5.0
* @abstract
+ *
* @param string $file Path to the file.
* @return string|bool The group or false on error.
*/
@@ -543,8 +592,10 @@ class WP_Filesystem_Base {
/**
* Copy a file.
*
+ * @access public
* @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.
@@ -560,8 +611,10 @@ class WP_Filesystem_Base {
/**
* Move a file.
*
+ * @access public
* @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.
@@ -575,8 +628,10 @@ class WP_Filesystem_Base {
/**
* Delete a file or directory.
*
+ * @access public
* @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.
@@ -591,8 +646,10 @@ class WP_Filesystem_Base {
/**
* Check if a file or directory exists.
*
+ * @access public
* @since 2.5.0
* @abstract
+ *
* @param string $file Path to file/directory.
* @return bool Whether $file exists or not.
*/
@@ -603,8 +660,10 @@ class WP_Filesystem_Base {
/**
* Check if resource is a file.
*
+ * @access public
* @since 2.5.0
* @abstract
+ *
* @param string $file File path.
* @return bool Whether $file is a file.
*/
@@ -615,8 +674,10 @@ class WP_Filesystem_Base {
/**
* Check if resource is a directory.
*
+ * @access public
* @since 2.5.0
* @abstract
+ *
* @param string $path Directory path.
* @return bool Whether $path is a directory.
*/
@@ -627,8 +688,10 @@ class WP_Filesystem_Base {
/**
* Check if a file is readable.
*
+ * @access public
* @since 2.5.0
* @abstract
+ *
* @param string $file Path to file.
* @return bool Whether $file is readable.
*/
@@ -639,8 +702,11 @@ class WP_Filesystem_Base {
/**
* Check if a file or directory is writable.
*
+ * @access public
* @since 2.5.0
* @abstract
+ *
+ * @param string $file Path to file.
* @return bool Whether $file is writable.
*/
public function is_writable( $file ) {
@@ -650,8 +716,10 @@ class WP_Filesystem_Base {
/**
* Gets the file's last access time.
*
+ * @access public
* @since 2.5.0
* @abstract
+ *
* @param string $file Path to file.
* @return int|bool Unix timestamp representing last access time.
*/
@@ -662,8 +730,10 @@ class WP_Filesystem_Base {
/**
* Gets the file modification time.
*
+ * @access public
* @since 2.5.0
* @abstract
+ *
* @param string $file Path to file.
* @return int|bool Unix timestamp representing modification time.
*/
@@ -674,8 +744,10 @@ class WP_Filesystem_Base {
/**
* Gets the file size (in bytes).
*
+ * @access public
* @since 2.5.0
* @abstract
+ *
* @param string $file Path to file.
* @return int|bool Size of the file in bytes.
*/
@@ -688,8 +760,10 @@ class WP_Filesystem_Base {
*
* Note: If $file doesn't exist, it will be created.
*
+ * @access public
* @since 2.5.0
* @abstract
+ *
* @param string $file Path to file.
* @param int $time Optional. Modified time to set for file.
* Default 0.
@@ -704,8 +778,10 @@ class WP_Filesystem_Base {
/**
* Create a directory.
*
+ * @access public
* @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.
@@ -722,8 +798,10 @@ class WP_Filesystem_Base {
/**
* Delete a directory.
*
+ * @access public
* @since 2.5.0
* @abstract
+ *
* @param string $path Path to directory.
* @param bool $recursive Optional. Whether to recursively remove files/directories.
* Default false.
@@ -736,6 +814,7 @@ class WP_Filesystem_Base {
/**
* Get details for files in a directory or a specific file.
*
+ * @access public
* @since 2.5.0
* @abstract
*