--- a/wp/wp-admin/includes/class-wp-filesystem-ssh2.php Tue Jun 09 11:14:17 2015 +0000
+++ b/wp/wp-admin/includes/class-wp-filesystem-ssh2.php Mon Oct 14 17:39:30 2019 +0200
@@ -35,14 +35,21 @@
*/
class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
+ /**
+ */
public $link = false;
+
/**
* @var resource
*/
public $sftp_link;
public $keys = false;
- public function __construct($opt='') {
+ /**
+ *
+ * @param array $opt
+ */
+ public function __construct( $opt = '' ) {
$this->method = 'ssh2';
$this->errors = new WP_Error();
@@ -52,7 +59,14 @@
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>'));
+ $this->errors->add(
+ 'ssh2_php_requirement',
+ sprintf(
+ /* translators: %s: stream_get_contents() */
+ __( 'The ssh2 PHP extension is available, however, we require the PHP5 function %s' ),
+ '<code>stream_get_contents()</code>'
+ )
+ );
return;
}
@@ -89,9 +103,12 @@
} else {
$this->options['password'] = $opt['password'];
}
-
}
+ /**
+ *
+ * @return bool
+ */
public function connect() {
if ( ! $this->keys ) {
$this->link = @ssh2_connect($this->options['hostname'], $this->options['port']);
@@ -100,39 +117,90 @@
}
if ( ! $this->link ) {
- $this->errors->add('connect', sprintf(__('Failed to connect to SSH2 Server %1$s:%2$s'), $this->options['hostname'], $this->options['port']));
+ $this->errors->add( 'connect',
+ /* translators: %s: hostname:port */
+ sprintf( __( 'Failed to connect to SSH2 Server %s' ),
+ $this->options['hostname'] . ':' . $this->options['port']
+ )
+ );
return false;
}
if ( !$this->keys ) {
if ( ! @ssh2_auth_password($this->link, $this->options['username'], $this->options['password']) ) {
- $this->errors->add('auth', sprintf(__('Username/Password incorrect for %s'), $this->options['username']));
+ $this->errors->add( 'auth',
+ /* translators: %s: username */
+ sprintf( __( 'Username/Password incorrect for %s' ),
+ $this->options['username']
+ )
+ );
return false;
}
} 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 incorrect for %s'), $this->options['username']));
+ $this->errors->add( 'auth',
+ /* translators: %s: username */
+ sprintf( __( 'Public and Private keys incorrect for %s' ),
+ $this->options['username']
+ )
+ );
return false;
}
}
- $this->sftp_link = ssh2_sftp($this->link);
+ $this->sftp_link = ssh2_sftp( $this->link );
+ if ( ! $this->sftp_link ) {
+ $this->errors->add( 'connect',
+ /* translators: %s: hostname:port */
+ sprintf( __( 'Failed to initialize a SFTP subsystem session with the SSH2 Server %s' ),
+ $this->options['hostname'] . ':' . $this->options['port']
+ )
+ );
+ return false;
+ }
return true;
}
/**
+ * Gets the ssh2.sftp PHP stream wrapper path to open for the given file.
+ *
+ * This method also works around a PHP bug where the root directory (/) cannot
+ * be opened by PHP functions, causing a false failure. In order to work around
+ * this, the path is converted to /./ which is semantically the same as /
+ * See https://bugs.php.net/bug.php?id=64169 for more details.
+ *
+ *
+ * @since 4.4.0
+ *
+ * @param string $path The File/Directory path on the remote server to return
+ * @return string The ssh2.sftp:// wrapped path to use.
+ */
+ public function sftp_path( $path ) {
+ if ( '/' === $path ) {
+ $path = '/./';
+ }
+ return 'ssh2.sftp://' . $this->sftp_link . '/' . ltrim( $path, '/' );
+ }
+
+ /**
+ *
* @param string $command
* @param bool $returnbool
- * @return bool|string
+ * @return bool|string True on success, false on failure. String if the command was executed, `$returnbool`
+ * is false (default), and data from the resulting stream was retrieved.
*/
- public function run_command( $command, $returnbool = false) {
-
+ public function run_command( $command, $returnbool = false ) {
if ( ! $this->link )
return false;
if ( ! ($stream = ssh2_exec($this->link, $command)) ) {
- $this->errors->add('command', sprintf(__('Unable to perform command: %s'), $command));
+ $this->errors->add( 'command',
+ /* translators: %s: command */
+ sprintf( __( 'Unable to perform command: %s'),
+ $command
+ )
+ );
} else {
stream_set_blocking( $stream, true );
stream_set_timeout( $stream, FS_TIMEOUT );
@@ -148,31 +216,32 @@
}
/**
+ *
* @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( $this->sftp_path( $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( $this->sftp_path( $file ) );
}
/**
- * @param string $file
- * @param string $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 );
+ $ret = file_put_contents( $this->sftp_path( $file ), $contents );
if ( $ret !== strlen( $contents ) )
return false;
@@ -182,8 +251,12 @@
return true;
}
+ /**
+ *
+ * @return bool
+ */
public function cwd() {
- $cwd = $this->run_command('pwd');
+ $cwd = ssh2_sftp_realpath( $this->sftp_link, '.' );
if ( $cwd ) {
$cwd = trailingslashit( trim( $cwd ) );
}
@@ -191,6 +264,7 @@
}
/**
+ *
* @param string $dir
* @return bool|string
*/
@@ -199,9 +273,12 @@
}
/**
+ *
* @param string $file
* @param string $group
- * @param bool $recursive
+ * @param bool $recursive
+ *
+ * @return bool
*/
public function chgrp($file, $group, $recursive = false ) {
if ( ! $this->exists($file) )
@@ -212,9 +289,10 @@
}
/**
+ *
* @param string $file
- * @param int $mode
- * @param bool $recursive
+ * @param int $mode
+ * @param bool $recursive
* @return bool|string
*/
public function chmod($file, $mode = false, $recursive = false) {
@@ -238,12 +316,11 @@
/**
* 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.
+ * @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. Default False.
+ * @return bool True on success or false on failure.
*/
public function chown( $file, $owner, $recursive = false ) {
if ( ! $this->exists($file) )
@@ -254,11 +331,12 @@
}
/**
+ *
* @param string $file
* @return string|false
*/
public function owner($file) {
- $owneruid = @fileowner('ssh2.sftp://' . $this->sftp_link . '/' . ltrim($file, '/'));
+ $owneruid = @fileowner( $this->sftp_path( $file ) );
if ( ! $owneruid )
return false;
if ( ! function_exists('posix_getpwuid') )
@@ -266,20 +344,23 @@
$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 );
+ return substr( decoct( @fileperms( $this->sftp_path( $file ) ) ), -3 );
}
/**
+ *
* @param string $file
* @return string|false
*/
public function group($file) {
- $gid = @filegroup('ssh2.sftp://' . $this->sftp_link . '/' . ltrim($file, '/'));
+ $gid = @filegroup( $this->sftp_path( $file ) );
if ( ! $gid )
return false;
if ( ! function_exists('posix_getgrgid') )
@@ -289,9 +370,10 @@
}
/**
- * @param string $source
- * @param string $destination
- * @param bool $overwrite
+ *
+ * @param string $source
+ * @param string $destination
+ * @param bool $overwrite
* @param int|bool $mode
* @return bool
*/
@@ -305,9 +387,10 @@
}
/**
+ *
* @param string $source
* @param string $destination
- * @param bool $overwrite
+ * @param bool $overwrite
* @return bool
*/
public function move($source, $destination, $overwrite = false) {
@@ -315,8 +398,9 @@
}
/**
- * @param string $file
- * @param bool $recursive
+ *
+ * @param string $file
+ * @param bool $recursive
* @param string|bool $type
* @return bool
*/
@@ -335,86 +419,94 @@
}
/**
+ *
* @param string $file
* @return bool
*/
public function exists($file) {
- $file = ltrim($file, '/');
- return file_exists('ssh2.sftp://' . $this->sftp_link . '/' . $file);
+ return file_exists( $this->sftp_path( $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( $this->sftp_path( $file ) );
}
+
/**
+ *
* @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( $this->sftp_path( $path ) );
}
+
/**
+ *
* @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( $this->sftp_path( $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);
+ return fileatime( $this->sftp_path( $file ) );
}
/**
+ *
* @param string $file
* @return int
*/
public function mtime($file) {
- $file = ltrim($file, '/');
- return filemtime('ssh2.sftp://' . $this->sftp_link . '/' . $file);
+ return filemtime( $this->sftp_path( $file ) );
}
/**
+ *
* @param string $file
* @return int
*/
public function size($file) {
- $file = ltrim($file, '/');
- return filesize('ssh2.sftp://' . $this->sftp_link . '/' . $file);
+ return filesize( $this->sftp_path( $file ) );
}
/**
+ *
* @param string $file
- * @param int $time
- * @param int $atime
+ * @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
+ * @param mixed $chmod
+ * @param mixed $chown
+ * @param mixed $chgrp
* @return bool
*/
public function mkdir($path, $chmod = false, $chown = false, $chgrp = false) {
@@ -434,8 +526,9 @@
}
/**
+ *
* @param string $path
- * @param bool $recursive
+ * @param bool $recursive
* @return bool
*/
public function rmdir($path, $recursive = false) {
@@ -443,9 +536,10 @@
}
/**
+ *
* @param string $path
- * @param bool $include_hidden
- * @param bool $recursive
+ * @param bool $include_hidden
+ * @param bool $recursive
* @return bool|array
*/
public function dirlist($path, $include_hidden = true, $recursive = false) {
@@ -460,7 +554,7 @@
return false;
$ret = array();
- $dir = @dir('ssh2.sftp://' . $this->sftp_link .'/' . ltrim($path, '/') );
+ $dir = @dir( $this->sftp_path( $path ) );
if ( ! $dir )
return false;