X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/9e77185fafaf4e60e2b73821e0e4b9b1a11fb85f..dc1231b7312fbdca99e9e887cc2bb35a28f85cdc:/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 4618f288..2b167965 100644
--- a/wp-admin/includes/class-wp-filesystem-ssh2.php
+++ b/wp-admin/includes/class-wp-filesystem-ssh2.php
@@ -36,23 +36,28 @@
 class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
 
 	public $link = false;
-	public $sftp_link = false;
+	/**
+	 * @var resource
+	 */
+	public $sftp_link;
 	public $keys = false;
-	public $errors = array();
-	public $options = array();
 
-	public function __construct($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 ( !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 false;
+			return;
 		}
 
 		// Set defaults:
@@ -66,9 +71,6 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
 		else
 			$this->options['hostname'] = $opt['hostname'];
 
-		if ( ! 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'];
@@ -91,9 +93,12 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
 		} else {
 			$this->options['password'] = $opt['password'];
 		}
-
 	}
 
+	/**
+	 *
+	 * @return bool
+	 */
 	public function connect() {
 		if ( ! $this->keys ) {
 			$this->link = @ssh2_connect($this->options['hostname'], $this->options['port']);
@@ -123,8 +128,12 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
 		return true;
 	}
 
-	public 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;
 
@@ -144,16 +153,30 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
 		return false;
 	}
 
+	/**
+	 * @param string $file
+	 * @return string|false
+	 */
 	public function get_contents( $file ) {
 		$file = ltrim($file, '/');
 		return file_get_contents('ssh2.sftp://' . $this->sftp_link . '/' . $file);
 	}
 
+	/**
+	 * @param string $file
+	 * @return array
+	 */
 	public function get_contents_array($file) {
 		$file = ltrim($file, '/');
 		return file('ssh2.sftp://' . $this->sftp_link . '/' . $file);
 	}
 
+	/**
+	 * @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 );
 
@@ -165,17 +188,33 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
 		return true;
 	}
 
+	/**
+	 *
+	 * @return bool
+	 */
 	public function cwd() {
-		$cwd = $this->run_command('pwd');
-		if ( $cwd )
-			$cwd = trailingslashit($cwd);
+		$cwd = ssh2_sftp_realpath( $this->sftp_link, '.' );
+		if ( $cwd ) {
+			$cwd = trailingslashit( trim( $cwd ) );
+		}
 		return $cwd;
 	}
 
+	/**
+	 * @param string $dir
+	 * @return bool|string
+	 */
 	public function chdir($dir) {
 		return $this->run_command('cd ' . $dir, true);
 	}
 
+	/**
+	 * @param string $file
+	 * @param string $group
+	 * @param bool   $recursive
+	 *
+	 * @return bool
+	 */
 	public function chgrp($file, $group, $recursive = false ) {
 		if ( ! $this->exists($file) )
 			return false;
@@ -184,6 +223,12 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
 		return $this->run_command(sprintf('chgrp -R %s %s', escapeshellarg($group), escapeshellarg($file)), true);
 	}
 
+	/**
+	 * @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;
@@ -207,10 +252,10 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
 	 *
 	 * @since Unknown
 	 *
-	 * @param string $file    Path to the file.
-	 * @param mixed  $owner   A user name or number.
-	 * @param bool $recursive Optional. If set True changes file owner recursivly. Defaults to False.
-	 * @return bool Returns true on success or false on failure.
+	 * @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) )
@@ -220,6 +265,10 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
 		return $this->run_command(sprintf('chown -R %s %s', escapeshellarg($owner), escapeshellarg($file)), true);
 	}
 
+	/**
+	 * @param string $file
+	 * @return string|false
+	 */
 	public function owner($file) {
 		$owneruid = @fileowner('ssh2.sftp://' . $this->sftp_link . '/' . ltrim($file, '/'));
 		if ( ! $owneruid )
@@ -229,11 +278,18 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
 		$ownerarray = posix_getpwuid($owneruid);
 		return $ownerarray['name'];
 	}
-
+	/**
+	 * @param string $file
+	 * @return string
+	 */
 	public function getchmod($file) {
 		return substr( decoct( @fileperms( 'ssh2.sftp://' . $this->sftp_link . '/' . ltrim( $file, '/' ) ) ), -3 );
 	}
 
+	/**
+	 * @param string $file
+	 * @return string|false
+	 */
 	public function group($file) {
 		$gid = @filegroup('ssh2.sftp://' . $this->sftp_link . '/' . ltrim($file, '/'));
 		if ( ! $gid )
@@ -244,6 +300,13 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
 		return $grouparray['name'];
 	}
 
+	/**
+	 * @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;
@@ -253,10 +316,22 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
 		return $this->put_contents($destination, $content, $mode);
 	}
 
+	/**
+	 * @param string $source
+	 * @param string $destination
+	 * @param bool   $overwrite
+	 * @return bool
+	 */
 	public function move($source, $destination, $overwrite = false) {
-		return @ssh2_sftp_rename($this->link, $source, $destination);
+		return @ssh2_sftp_rename( $this->sftp_link, $source, $destination );
 	}
 
+	/**
+	 * @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);
@@ -271,50 +346,89 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
 		return ssh2_sftp_rmdir($this->sftp_link, $file);
 	}
 
+	/**
+	 * @param string $file
+	 * @return bool
+	 */
 	public function exists($file) {
 		$file = ltrim($file, '/');
 		return file_exists('ssh2.sftp://' . $this->sftp_link . '/' . $file);
 	}
-
+	/**
+	 * @param string $file
+	 * @return bool
+	 */
 	public function is_file($file) {
 		$file = ltrim($file, '/');
 		return is_file('ssh2.sftp://' . $this->sftp_link . '/' . $file);
 	}
-
+	/**
+	 * @param string $path
+	 * @return bool
+	 */
 	public function is_dir($path) {
 		$path = ltrim($path, '/');
 		return is_dir('ssh2.sftp://' . $this->sftp_link . '/' . $path);
 	}
-
+	/**
+	 * @param string $file
+	 * @return bool
+	 */
 	public function is_readable($file) {
 		$file = ltrim($file, '/');
 		return is_readable('ssh2.sftp://' . $this->sftp_link . '/' . $file);
 	}
-
+	/**
+	 * @param string $file
+	 * @return bool
+	 */
 	public function is_writable($file) {
-		$file = ltrim($file, '/');
-		return is_writable('ssh2.sftp://' . $this->sftp_link . '/' . $file);
+		// PHP will base it's writable checks on system_user === file_owner, not ssh_user === file_owner
+		return true;
 	}
-
+	/**
+	 * @param string $file
+	 * @return int
+	 */
 	public function atime($file) {
 		$file = ltrim($file, '/');
 		return fileatime('ssh2.sftp://' . $this->sftp_link . '/' . $file);
 	}
 
+	/**
+	 * @param string $file
+	 * @return int
+	 */
 	public function mtime($file) {
 		$file = ltrim($file, '/');
 		return filemtime('ssh2.sftp://' . $this->sftp_link . '/' . $file);
 	}
 
+	/**
+	 * @param string $file
+	 * @return int
+	 */
 	public function size($file) {
 		$file = ltrim($file, '/');
 		return filesize('ssh2.sftp://' . $this->sftp_link . '/' . $file);
 	}
 
+	/**
+	 * @param string $file
+	 * @param int    $time
+	 * @param int    $atime
+	 */
 	public function touch($file, $time = 0, $atime = 0) {
 		//Not implemented.
 	}
 
+	/**
+	 * @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);
 		if ( empty($path) )
@@ -331,10 +445,21 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
 		return true;
 	}
 
+	/**
+	 * @param string $path
+	 * @param bool   $recursive
+	 * @return bool
+	 */
 	public function rmdir($path, $recursive = false) {
 		return $this->delete($path, $recursive);
 	}
 
+	/**
+	 * @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) ) {
 			$limit_file = basename($path);