X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/d3b1ea255664edd2deef17f900a655613d20820d..refs/tags/wordpress-4.3:/wp-admin/includes/class-wp-filesystem-ssh2.php

diff --git a/wp-admin/includes/class-wp-filesystem-ssh2.php b/wp-admin/includes/class-wp-filesystem-ssh2.php
index 7bcd4b74..e446656e 100644
--- a/wp-admin/includes/class-wp-filesystem-ssh2.php
+++ b/wp-admin/includes/class-wp-filesystem-ssh2.php
@@ -1,19 +1,12 @@
 <?php
 /**
- * WordPress SSH2 Filesystem.
- *
- * @package WordPress
- * @subpackage Filesystem
- */
-
-/**
- * WordPress Filesystem Class for implementing SSH2.
+ * WordPress Filesystem Class for implementing SSH2
  *
  * To use this class you must follow these steps for PHP 5.2.6+
  *
  * @contrib http://kevin.vanzonneveld.net/techblog/article/make_ssh_connections_with_php/ - Installation Notes
  *
- * Complie libssh2 (Note: Only 0.14 is officaly working with PHP 5.2.6+ right now.)
+ * Complie libssh2 (Note: Only 0.14 is officaly working with PHP 5.2.6+ right now, But many users have found the latest versions work)
  *
  * cd /usr/src
  * wget http://surfnet.dl.sourceforge.net/sourceforge/libssh2/libssh2-0.14.tar.gz
@@ -22,7 +15,7 @@
  * ./configure
  * make all install
  *
- * Note: No not leave the directory yet!
+ * Note: Do not leave the directory yet!
  *
  * Enter: pecl install -f ssh2
  *
@@ -33,42 +26,38 @@
  * Restart Apache!
  * Check phpinfo() streams to confirm that: ssh2.shell, ssh2.exec, ssh2.tunnel, ssh2.scp, ssh2.sftp  exist.
  *
+ * Note: as of WordPress 2.8, This utilises the PHP5+ function 'stream_get_contents'
+ *
+ * @since 2.7.0
  *
- * @since 2.7
  * @package WordPress
  * @subpackage Filesystem
- * @uses WP_Filesystem_Base Extends class
  */
 class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
 
-	var $link = false;
-	var $sftp_link = false;
-	var $keys = false;
-	/*
-	 * This is the timeout value for ssh results to comeback.
-	 * Slower servers might need this incressed, but this number otherwise should not change.
-	 *
-	 * @parm $timeout int
-	 *
+	public $link = false;
+	/**
+	 * @var resource
 	 */
-	var $timeout = 15;
-	var $errors = array();
-	var $options = array();
-
-	var $permission = 0644;
+	public $sftp_link;
+	public $keys = false;
 
-	function WP_Filesystem_SSH2($opt='') {
+	/**
+	 *
+	 * @param array $opt
+	 */
+	public function __construct( $opt = '' ) {
 		$this->method = 'ssh2';
 		$this->errors = new WP_Error();
 
 		//Check if possible to use ssh2 functions.
 		if ( ! extension_loaded('ssh2') ) {
 			$this->errors->add('no_ssh2_ext', __('The ssh2 PHP extension is not available'));
-			return false;
+			return;
 		}
-		if ( ! version_compare(phpversion(), '5', '>=') ) {
-			$this->errors->add('ssh2_php_requirement', __('The ssh2 PHP extension is available, however requires PHP 5+'));
-			return false;
+		if ( !function_exists('stream_get_contents') ) {
+			$this->errors->add('ssh2_php_requirement', __('The ssh2 PHP extension is available, however, we require the PHP5 function <code>stream_get_contents()</code>'));
+			return;
 		}
 
 		// Set defaults:
@@ -82,9 +71,6 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
 		else
 			$this->options['hostname'] = $opt['hostname'];
 
-		if ( isset($opt['base']) && ! empty($opt['base']) )
-			$this->wp_base = $opt['base'];
-
 		// Check if the options provided are OK.
 		if ( !empty ($opt['public_key']) && !empty ($opt['private_key']) ) {
 			$this->options['public_key'] = $opt['public_key'];
@@ -101,15 +87,19 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
 			$this->options['username'] = $opt['username'];
 
 		if ( empty ($opt['password']) ) {
-			if ( !$this->keys )	//	 password can be blank if we are using keys
+			// Password can be blank if we are using keys.
+			if ( !$this->keys )
 				$this->errors->add('empty_password', __('SSH2 password is required'));
 		} else {
 			$this->options['password'] = $opt['password'];
 		}
-
 	}
 
-	function connect() {
+	/**
+	 *
+	 * @return bool
+	 */
+	public function connect() {
 		if ( ! $this->keys ) {
 			$this->link = @ssh2_connect($this->options['hostname'], $this->options['port']);
 		} else {
@@ -128,7 +118,7 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
 			}
 		} else {
 			if ( ! @ssh2_auth_pubkey_file($this->link, $this->options['username'], $this->options['public_key'], $this->options['private_key'], $this->options['password'] ) ) {
-				$this->errors->add('auth', sprintf(__('Public and Private keys incorrent for %s'), $this->options['username']));
+				$this->errors->add('auth', sprintf(__('Public and Private keys incorrect for %s'), $this->options['username']));
 				return false;
 			}
 		}
@@ -138,8 +128,12 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
 		return true;
 	}
 
-	function run_command( $command, $returnbool = false) {
-
+	/**
+	 * @param string $command
+	 * @param bool $returnbool
+	 * @return bool|string
+	 */
+	public function run_command( $command, $returnbool = false ) {
 		if ( ! $this->link )
 			return false;
 
@@ -147,78 +141,135 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
 			$this->errors->add('command', sprintf(__('Unable to perform command: %s'), $command));
 		} else {
 			stream_set_blocking( $stream, true );
-			stream_set_timeout( $stream, $this->timeout );
-			$data = stream_get_contents($stream);
+			stream_set_timeout( $stream, FS_TIMEOUT );
+			$data = stream_get_contents( $stream );
+			fclose( $stream );
 
 			if ( $returnbool )
-				return '' != trim($data);
+				return ( $data === false ) ? false : '' != trim($data);
 			else
 				return $data;
 		}
 		return false;
 	}
 
-	function setDefaultPermissions($perm) {
-		$this->debug("setDefaultPermissions();");
-		if ( $perm )
-			$this->permission = $perm;
-	}
-
-	function get_contents($file, $type = '', $resumepos = 0 ) {
+	/**
+	 * @param string $file
+	 * @return string|false
+	 */
+	public function get_contents( $file ) {
 		$file = ltrim($file, '/');
-		return file_get_contents('ssh2.sftp://' . $this->sftp_link .'/' . $file);
+		return file_get_contents('ssh2.sftp://' . $this->sftp_link . '/' . $file);
 	}
 
-	function get_contents_array($file) {
+	/**
+	 * @param string $file
+	 * @return array
+	 */
+	public function get_contents_array($file) {
 		$file = ltrim($file, '/');
-		return file('ssh2.sftp://' . $this->sftp_link .'/' . $file);
+		return file('ssh2.sftp://' . $this->sftp_link . '/' . $file);
 	}
 
-	function put_contents($file, $contents, $type = '' ) {
-		$file = ltrim($file, '/');
-		return file_put_contents('ssh2.sftp://' . $this->sftp_link .'/' . $file, $contents);
+	/**
+	 * @param string   $file
+	 * @param string   $contents
+	 * @param bool|int $mode
+	 * @return bool
+	 */
+	public function put_contents($file, $contents, $mode = false ) {
+		$ret = file_put_contents( 'ssh2.sftp://' . $this->sftp_link . '/' . ltrim( $file, '/' ), $contents );
+
+		if ( $ret !== strlen( $contents ) )
+			return false;
+
+		$this->chmod($file, $mode);
+
+		return true;
 	}
 
-	function cwd() {
-		$cwd = $this->run_command('pwd');
-		if( $cwd )
-			$cwd = trailingslashit($cwd);
+	/**
+	 *
+	 * @return bool
+	 */
+	public function cwd() {
+		$cwd = ssh2_sftp_realpath( $this->sftp_link, '.' );
+		if ( $cwd ) {
+			$cwd = trailingslashit( trim( $cwd ) );
+		}
 		return $cwd;
 	}
 
-	function chdir($dir) {
+	/**
+	 * @param string $dir
+	 * @return bool|string
+	 */
+	public function chdir($dir) {
 		return $this->run_command('cd ' . $dir, true);
 	}
 
-	function chgrp($file, $group, $recursive = false ) {
+	/**
+	 * @param string $file
+	 * @param string $group
+	 * @param bool   $recursive
+	 *
+	 * @return bool
+	 */
+	public function chgrp($file, $group, $recursive = false ) {
 		if ( ! $this->exists($file) )
 			return false;
 		if ( ! $recursive || ! $this->is_dir($file) )
-			return $this->run_command(sprintf('chgrp %o %s', $mode, escapeshellarg($file)), true);
-		return $this->run_command(sprintf('chgrp -R %o %s', $mode, escapeshellarg($file)), true);
+			return $this->run_command(sprintf('chgrp %s %s', escapeshellarg($group), escapeshellarg($file)), true);
+		return $this->run_command(sprintf('chgrp -R %s %s', escapeshellarg($group), escapeshellarg($file)), true);
 	}
 
-	function chmod($file, $mode = false, $recursive = false) {
-		if( ! $mode )
-			$mode = $this->permission;
-		if( ! $mode )
-			return false;
+	/**
+	 * @param string $file
+	 * @param int    $mode
+	 * @param bool   $recursive
+	 * @return bool|string
+	 */
+	public function chmod($file, $mode = false, $recursive = false) {
 		if ( ! $this->exists($file) )
 			return false;
+
+		if ( ! $mode ) {
+			if ( $this->is_file($file) )
+				$mode = FS_CHMOD_FILE;
+			elseif ( $this->is_dir($file) )
+				$mode = FS_CHMOD_DIR;
+			else
+				return false;
+		}
+
 		if ( ! $recursive || ! $this->is_dir($file) )
 			return $this->run_command(sprintf('chmod %o %s', $mode, escapeshellarg($file)), true);
 		return $this->run_command(sprintf('chmod -R %o %s', $mode, escapeshellarg($file)), true);
 	}
 
-	function chown($file, $owner, $recursive = false ) {
+	/**
+	 * Change the ownership of a file / folder.
+	 *
+	 * @since Unknown
+	 *
+	 * @param string     $file    Path to the file.
+	 * @param string|int $owner   A user name or number.
+	 * @param bool       $recursive Optional. If set True changes file owner recursivly. Defaults to False.
+	 * @return bool|string Returns true on success or false on failure.
+	 */
+	public function chown( $file, $owner, $recursive = false ) {
 		if ( ! $this->exists($file) )
 			return false;
 		if ( ! $recursive || ! $this->is_dir($file) )
-			return $this->run_command(sprintf('chown %o %s', $mode, escapeshellarg($file)), true);
-		return $this->run_command(sprintf('chown -R %o %s', $mode, escapeshellarg($file)), true);
+			return $this->run_command(sprintf('chown %s %s', escapeshellarg($owner), escapeshellarg($file)), true);
+		return $this->run_command(sprintf('chown -R %s %s', escapeshellarg($owner), escapeshellarg($file)), true);
 	}
 
-	function owner($file) {
+	/**
+	 * @param string $file
+	 * @return string|false
+	 */
+	public function owner($file) {
 		$owneruid = @fileowner('ssh2.sftp://' . $this->sftp_link . '/' . ltrim($file, '/'));
 		if ( ! $owneruid )
 			return false;
@@ -227,12 +278,19 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
 		$ownerarray = posix_getpwuid($owneruid);
 		return $ownerarray['name'];
 	}
-
-	function getchmod($file) {
-		return substr(decoct(@fileperms( 'ssh2.sftp://' . $this->sftp_link . '/' . ltrim($file, '/') )),3);
+	/**
+	 * @param string $file
+	 * @return string
+	 */
+	public function getchmod($file) {
+		return substr( decoct( @fileperms( 'ssh2.sftp://' . $this->sftp_link . '/' . ltrim( $file, '/' ) ) ), -3 );
 	}
 
-	function group($file) {
+	/**
+	 * @param string $file
+	 * @return string|false
+	 */
+	public function group($file) {
 		$gid = @filegroup('ssh2.sftp://' . $this->sftp_link . '/' . ltrim($file, '/'));
 		if ( ! $gid )
 			return false;
@@ -242,81 +300,142 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
 		return $grouparray['name'];
 	}
 
-	function copy($source, $destination, $overwrite = false ) {
-		if( ! $overwrite && $this->exists($destination) )
+	/**
+	 * @param string   $source
+	 * @param string   $destination
+	 * @param bool     $overwrite
+	 * @param int|bool $mode
+	 * @return bool
+	 */
+	public function copy($source, $destination, $overwrite = false, $mode = false) {
+		if ( ! $overwrite && $this->exists($destination) )
 			return false;
 		$content = $this->get_contents($source);
-		if( false === $content)
+		if ( false === $content)
 			return false;
-		return $this->put_contents($destination, $content);
+		return $this->put_contents($destination, $content, $mode);
 	}
 
-	function move($source, $destination, $overwrite = false) {
-		return @ssh2_sftp_rename($this->link, $source, $destination);
+	/**
+	 * @param string $source
+	 * @param string $destination
+	 * @param bool   $overwrite
+	 * @return bool
+	 */
+	public function move($source, $destination, $overwrite = false) {
+		return @ssh2_sftp_rename( $this->sftp_link, $source, $destination );
 	}
 
-	function delete($file, $recursive = false) {
-		if ( $this->is_file($file) )
+	/**
+	 * @param string      $file
+	 * @param bool        $recursive
+	 * @param string|bool $type
+	 * @return bool
+	 */
+	public function delete($file, $recursive = false, $type = false) {
+		if ( 'f' == $type || $this->is_file($file) )
 			return ssh2_sftp_unlink($this->sftp_link, $file);
 		if ( ! $recursive )
 			 return ssh2_sftp_rmdir($this->sftp_link, $file);
 		$filelist = $this->dirlist($file);
 		if ( is_array($filelist) ) {
 			foreach ( $filelist as $filename => $fileinfo) {
-				$this->delete($file . '/' . $filename, $recursive);
+				$this->delete($file . '/' . $filename, $recursive, $fileinfo['type']);
 			}
 		}
 		return ssh2_sftp_rmdir($this->sftp_link, $file);
 	}
 
-	function exists($file) {
-		//return $this->run_command(sprintf('ls -lad %s', escapeshellarg($file)), true);
+	/**
+	 * @param string $file
+	 * @return bool
+	 */
+	public function exists($file) {
 		$file = ltrim($file, '/');
-		return file_exists('ssh2.sftp://' . $this->sftp_link .'/' . $file);
+		return file_exists('ssh2.sftp://' . $this->sftp_link . '/' . $file);
 	}
-
-	function is_file($file) {
+	/**
+	 * @param string $file
+	 * @return bool
+	 */
+	public function is_file($file) {
 		$file = ltrim($file, '/');
-		return is_file('ssh2.sftp://' . $this->sftp_link .'/' . $file);
+		return is_file('ssh2.sftp://' . $this->sftp_link . '/' . $file);
 	}
-
-	function is_dir($path) {
+	/**
+	 * @param string $path
+	 * @return bool
+	 */
+	public function is_dir($path) {
 		$path = ltrim($path, '/');
-		return is_dir('ssh2.sftp://' . $this->sftp_link .'/' . $path);
+		return is_dir('ssh2.sftp://' . $this->sftp_link . '/' . $path);
 	}
-
-	function is_readable($file) {
+	/**
+	 * @param string $file
+	 * @return bool
+	 */
+	public function is_readable($file) {
 		$file = ltrim($file, '/');
-		return is_readable('ssh2.sftp://' . $this->sftp_link .'/' . $file);
+		return is_readable('ssh2.sftp://' . $this->sftp_link . '/' . $file);
 	}
-
-	function is_writable($file) {
+	/**
+	 * @param string $file
+	 * @return bool
+	 */
+	public function is_writable($file) {
 		$file = ltrim($file, '/');
-		return is_writable('ssh2.sftp://' . $this->sftp_link .'/' . $file);
+		return is_writable('ssh2.sftp://' . $this->sftp_link . '/' . $file);
 	}
-
-	function atime($file) {
+	/**
+	 * @param string $file
+	 * @return int
+	 */
+	public function atime($file) {
 		$file = ltrim($file, '/');
-		return fileatime('ssh2.sftp://' . $this->sftp_link .'/' . $file);
+		return fileatime('ssh2.sftp://' . $this->sftp_link . '/' . $file);
 	}
 
-	function mtime($file) {
+	/**
+	 * @param string $file
+	 * @return int
+	 */
+	public function mtime($file) {
 		$file = ltrim($file, '/');
-		return filemtime('ssh2.sftp://' . $this->sftp_link .'/' . $file);
+		return filemtime('ssh2.sftp://' . $this->sftp_link . '/' . $file);
 	}
 
-	function size($file) {
+	/**
+	 * @param string $file
+	 * @return int
+	 */
+	public function size($file) {
 		$file = ltrim($file, '/');
-		return filesize('ssh2.sftp://' . $this->sftp_link .'/' . $file);
+		return filesize('ssh2.sftp://' . $this->sftp_link . '/' . $file);
 	}
 
-	function touch($file, $time = 0, $atime = 0) {
-		//Not implmented.
+	/**
+	 * @param string $file
+	 * @param int    $time
+	 * @param int    $atime
+	 */
+	public function touch($file, $time = 0, $atime = 0) {
+		//Not implemented.
 	}
 
-	function mkdir($path, $chmod = null, $chown = false, $chgrp = false) {
+	/**
+	 * @param string $path
+	 * @param mixed  $chmod
+	 * @param mixed  $chown
+	 * @param mixed  $chgrp
+	 * @return bool
+	 */
+	public function mkdir($path, $chmod = false, $chown = false, $chgrp = false) {
 		$path = untrailingslashit($path);
-		$chmod = !empty($chmod) ? $chmod : $this->permission;
+		if ( empty($path) )
+			return false;
+
+		if ( ! $chmod )
+			$chmod = FS_CHMOD_DIR;
 		if ( ! ssh2_sftp_mkdir($this->sftp_link, $path, $chmod, true) )
 			return false;
 		if ( $chown )
@@ -326,33 +445,49 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
 		return true;
 	}
 
-	function rmdir($path, $recursive = false) {
+	/**
+	 * @param string $path
+	 * @param bool   $recursive
+	 * @return bool
+	 */
+	public function rmdir($path, $recursive = false) {
 		return $this->delete($path, $recursive);
 	}
 
-	function dirlist($path, $incdot = false, $recursive = false) {
+	/**
+	 * @param string $path
+	 * @param bool   $include_hidden
+	 * @param bool   $recursive
+	 * @return bool|array
+	 */
+	public function dirlist($path, $include_hidden = true, $recursive = false) {
 		if ( $this->is_file($path) ) {
-			$limitFile = basename($path);
+			$limit_file = basename($path);
 			$path = dirname($path);
 		} else {
-			$limitFile = false;
+			$limit_file = false;
 		}
+
 		if ( ! $this->is_dir($path) )
 			return false;
 
 		$ret = array();
 		$dir = @dir('ssh2.sftp://' . $this->sftp_link .'/' . ltrim($path, '/') );
+
 		if ( ! $dir )
 			return false;
+
 		while (false !== ($entry = $dir->read()) ) {
 			$struc = array();
 			$struc['name'] = $entry;
 
 			if ( '.' == $struc['name'] || '..' == $struc['name'] )
 				continue; //Do not care about these folders.
-			if ( '.' == $struc['name'][0] && !$incdot)
+
+			if ( ! $include_hidden && '.' == $struc['name'][0] )
 				continue;
-			if ( $limitFile && $struc['name'] != $limitFile)
+
+			if ( $limit_file && $struc['name'] != $limit_file )
 				continue;
 
 			$struc['perms'] 	= $this->gethchmod($path.'/'.$entry);
@@ -368,7 +503,7 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
 
 			if ( 'd' == $struc['type'] ) {
 				if ( $recursive )
-					$struc['files'] = $this->dirlist($path . '/' . $struc['name'], $incdot, $recursive);
+					$struc['files'] = $this->dirlist($path . '/' . $struc['name'], $include_hidden, $recursive);
 				else
 					$struc['files'] = array();
 			}
@@ -379,4 +514,4 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
 		unset($dir);
 		return $ret;
 	}
-}
\ No newline at end of file
+}