enmi-conf.org: comparison wp/wp-admin/includes/class-wp-filesystem-base.php

equal deleted inserted replaced

-:490d5cc509ed
+:cf61fcea0001
 */
 class WP_Filesystem_Base {
 	/**
 	 * Whether to display debug data for the connection.
 	 *
-	 * @access public
 	 * @since 2.5.0
 	 * @var bool
 	 */
 	public $verbose = false;
 	public $cache = array();
 	/**
 	 * The Access method of the current connection, Set automatically.
 	 *
-	 * @access public
 	 * @since 2.5.0
 	 * @var string
 	 */
 	public $method = '';
+	/**
+	 * @var WP_Error
+	 */
 	public $errors = null;
+	/**
+	 */
 	public $options = array();
 	/**
 	 * Return the path on the remote filesystem of ABSPATH.
 	 *
-	 * @access public
 	 * @since 2.7.0
 	 *
 	 * @return string The location of the remote path.
 	 */
 	public function abspath() {
 	}
 	/**
 	 * Return the path on the remote filesystem of WP_CONTENT_DIR.
 	 *
-	 * @access public
 	 * @since 2.7.0
 	 *
 	 * @return string The location of the remote path.
 	 */
 	public function wp_content_dir() {
 	}
 	/**
 	 * Return the path on the remote filesystem of WP_PLUGIN_DIR.
 	 *
-	 * @access public
 	 * @since 2.7.0
 	 *
 	 * @return string The location of the remote path.
 	 */
 	public function wp_plugins_dir() {
 	}
 	/**
 	 * Return the path on the remote filesystem of the Themes Directory.
 	 *
-	 * @access public
 	 * @since 2.7.0
 	 *
 	 * @param string $theme The Theme stylesheet or template for the directory.
 	 * @return string The location of the remote path.
 	 */
 	}
 	/**
 	 * Return the path on the remote filesystem of WP_LANG_DIR.
 	 *
-	 * @access public
 	 * @since 3.2.0
 	 *
 	 * @return string The location of the remote path.
 	 */
 	public function wp_lang_dir() {
 	}
 	/**
 	 * Locate a folder on the remote filesystem.
 	 *
-	 * @access public
 	 * @since 2.5.0
 	 * @deprecated 2.7.0 use WP_Filesystem::abspath() or WP_Filesystem::wp_*_dir() instead.
 	 * @see WP_Filesystem::abspath()
 	 * @see WP_Filesystem::wp_content_dir()
 	 * @see WP_Filesystem::wp_plugins_dir()
 	 * @param bool   $echo True to display debug information.
 	 *                     Default false.
 	 * @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();
 	}
 	/**
 	 * Locate a folder on the remote filesystem.
 	 *
-	 * @access public
 	 * @since 2.5.0
 	 * @deprecated 2.7.0 use WP_Filesystem::abspath() or WP_Filesystem::wp_*_dir() methods instead.
 	 * @see WP_Filesystem::abspath()
 	 * @see WP_Filesystem::wp_content_dir()
 	 * @see WP_Filesystem::wp_plugins_dir()
 	 * @param string $base The folder to start searching from.
 	 * @param bool   $echo True to display debug information.
 	 * @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();
 	}
 	/**
 	 * Locate a folder on the remote filesystem.
 	 *
 	 * Assumes that on Windows systems, Stripping off the Drive
 	 * letter is OK Sanitizes \\ to / in windows filepaths.
 	 *
-	 * @access public
 	 * @since 2.7.0
 	 *
 	 * @param string $folder the folder to locate.
 	 * @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 ];
 		if ( stripos($this->method, 'ftp') !== false ) {
 			$constant_overrides = array(
 		if ( empty( $base ) || '.' == $base )
 			$base = trailingslashit($this->cwd());
 		$folder = untrailingslashit($folder);
-		if ( $this->verbose )
+		if ( $this->verbose ) {
-			printf( "\n" . __('Looking for %1$s in %2$s') . "<br/>\n", $folder, $base );
+			/* translators: 1: folder to locate, 2: folder to start searching from */
+			printf( "\n" . __( 'Looking for %1$s in %2$s' ) . "<br/>\n", $folder, $base );
+		}
 		$folder_parts = explode('/', $folder);
 		$folder_part_keys = array_keys( $folder_parts );
 		$last_index = array_pop( $folder_part_keys );
 		$last_path = $folder_parts[ $last_index ];
 			 */
 			if ( isset($files[ $key ]) ){
 				// Let's try that folder:
 				$newdir = trailingslashit(path_join($base, $key));
-				if ( $this->verbose )
+				if ( $this->verbose ) {
-					printf( "\n" . __('Changing to %s') . "<br/>\n", $newdir );
+					/* translators: %s: directory name */
+					printf( "\n" . __( 'Changing to %s' ) . "<br/>\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 ) );
 				if ( $ret = $this->search_for_folder( $newfolder, $newdir, $loop) )
 					return $ret;
 			}
 		}
-		// 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 )
+			if ( $this->verbose ) {
-				printf( "\n" . __('Found %s') . "<br/>\n",  $base . $last_path );
+				/* translators: %s: directory name */
+				printf( "\n" . __( 'Found %s' ) . "<br/>\n",  $base . $last_path );
+			}
 			return trailingslashit($base . $last_path);
 		}
 		// Prevent this function from looping again.
 		// No need to proceed if we've just searched in /
 	/**
 	 * Return the *nix-style file permissions for a file.
 	 *
 	 * 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
 	 *
 	 * @param string $file String filename.
 	 * @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
 			$info = 'l';
 		elseif (($perms & 0x8000) == 0x8000) // Regular
 					(($perms & 0x0200) ? 'T' : '-'));
 		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.
 	 *
 	 * 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
 	 *
 	 * @param string $mode string The *nix-style file permission.
 	 * @return int octal representation
 	 */
 	/**
 	 * 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 true;
 	}
 	/**
 	 * Read entire file into a string.
 	 *
 	 * @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.
 	 */
 	public function get_contents( $file ) {
 		return false;
 	/**
 	 * 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.
 	 */
 	public function get_contents_array( $file ) {
 		return false;
 	/**
 	 * 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.
 	 * @return bool False on failure.
 	 */
 	/**
 	 * 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 false;
 	}
 	/**
 	 * Change current directory.
 	 *
 	 * @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;
 	}
 	/**
 	 * 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.
-	 * @return bool Returns true on success or false on failure.
+	 * @return bool|string
 	 */
 	public function chgrp( $file, $group, $recursive = false ) {
 		return false;
 	}
 	/**
 	 * 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.
-	 * @return bool Returns true on success or false on failure.
+	 * @return bool|string
 	 */
 	public function chmod( $file, $mode = false, $recursive = false ) {
 		return false;
 	}
 	/**
 	 * 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.
 	 */
 	public function owner( $file ) {
 		return false;
 	/**
 	 * 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.
 	 */
 	public function group( $file ) {
 		return false;
 	/**
 	 * 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.
 	 *                            Default false.
 	 * @param int    $mode        Optional. The permissions as octal number, usually 0644 for files, 0755 for dirs.
 	/**
 	 * 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.
 	 *                            Default false.
 	 * @return bool True if file copied successfully, False otherwise.
 	/**
 	 * 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 bool   $type      Type of resource. 'f' for file, 'd' for directory.
 	 *                          Default false.
 	/**
 	 * 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.
 	 */
 	public function exists( $file ) {
 		return false;
 	/**
 	 * Check if resource is a file.
 	 *
 	 * @since 2.5.0
 	 * @abstract
+	 *
 	 * @param string $file File path.
 	 * @return bool Whether $file is a file.
 	 */
 	public function is_file( $file ) {
 		return false;
 	/**
 	 * Check if resource is a directory.
 	 *
 	 * @since 2.5.0
 	 * @abstract
+	 *
 	 * @param string $path Directory path.
 	 * @return bool Whether $path is a directory.
 	 */
 	public function is_dir( $path ) {
 		return false;
 	/**
 	 * Check if a file is readable.
 	 *
 	 * @since 2.5.0
 	 * @abstract
+	 *
 	 * @param string $file Path to file.
 	 * @return bool Whether $file is readable.
 	 */
 	public function is_readable( $file ) {
 		return false;
 	/**
 	 * Check if a file or directory is writable.
 	 *
 	 * @since 2.5.0
 	 * @abstract
+	 *
+	 * @param string $file Path to file.
 	 * @return bool Whether $file is writable.
 	 */
 	public function is_writable( $file ) {
 		return false;
 	}
 	/**
 	 * Gets the file's last access time.
 	 *
 	 * @since 2.5.0
 	 * @abstract
+	 *
 	 * @param string $file Path to file.
 	 * @return int|bool Unix timestamp representing last access time.
 	 */
 	public function atime( $file ) {
 		return false;
 	/**
 	 * Gets the file modification time.
 	 *
 	 * @since 2.5.0
 	 * @abstract
+	 *
 	 * @param string $file Path to file.
 	 * @return int|bool Unix timestamp representing modification time.
 	 */
 	public function mtime( $file ) {
 		return false;
 	/**
 	 * Gets the file size (in bytes).
 	 *
 	 * @since 2.5.0
 	 * @abstract
+	 *
 	 * @param string $file Path to file.
 	 * @return int|bool Size of the file in bytes.
 	 */
 	public function size( $file ) {
 		return false;
 	 *
 	 * 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 int    $atime Optional. Access time to set for file.
 	 *                      Default 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 mixed  $chown Optional. A user name or number (or False to skip chown)
 	 *                      Default false.
 	/**
 	 * 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.
 	 * @return bool Whether directory is deleted successfully or not.
 	 */

changeset 7	cf61fcea0001
parent 5	5e2f62d02dcd
child 9	177826044cd9