*/
class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
- var $link = false;
- var $sftp_link = false;
- var $keys = false;
- var $errors = array();
- var $options = array();
+ /**
+ * @access public
+ */
+ public $link = false;
- function __construct($opt='') {
+ /**
+ * @access public
+ * @var resource
+ */
+ public $sftp_link;
+ public $keys = false;
+
+ /**
+ * @access public
+ *
+ * @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:
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'];
$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() {
+ /**
+ * @access public
+ *
+ * @return bool
+ */
+ public function connect() {
if ( ! $this->keys ) {
$this->link = @ssh2_connect($this->options['hostname'], $this->options['port']);
} else {
}
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;
}
- function run_command( $command, $returnbool = false) {
+ /**
+ * 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.
+ *
+ * @access public
+ *
+ * @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, '/' );
+ }
+ /**
+ * @access public
+ *
+ * @param string $command
+ * @param bool $returnbool
+ * @return bool|string
+ */
+ 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 );
return false;
}
- function get_contents( $file ) {
- $file = ltrim($file, '/');
- return file_get_contents('ssh2.sftp://' . $this->sftp_link . '/' . $file);
+ /**
+ * @access public
+ *
+ * @param string $file
+ * @return string|false
+ */
+ public function get_contents( $file ) {
+ return file_get_contents( $this->sftp_path( $file ) );
}
- function get_contents_array($file) {
- $file = ltrim($file, '/');
- return file('ssh2.sftp://' . $this->sftp_link . '/' . $file);
+ /**
+ * @access public
+ *
+ * @param string $file
+ * @return array
+ */
+ public function get_contents_array($file) {
+ return file( $this->sftp_path( $file ) );
}
- function put_contents($file, $contents, $mode = false ) {
- $ret = file_put_contents( 'ssh2.sftp://' . $this->sftp_link . '/' . ltrim( $file, '/' ), $contents );
+ /**
+ * @access public
+ *
+ * @param string $file
+ * @param string $contents
+ * @param bool|int $mode
+ * @return bool
+ */
+ public function put_contents($file, $contents, $mode = false ) {
+ $ret = file_put_contents( $this->sftp_path( $file ), $contents );
if ( $ret !== strlen( $contents ) )
return false;
return true;
}
- function cwd() {
- $cwd = $this->run_command('pwd');
- if ( $cwd )
- $cwd = trailingslashit($cwd);
+ /**
+ * @access public
+ *
+ * @return bool
+ */
+ public function cwd() {
+ $cwd = ssh2_sftp_realpath( $this->sftp_link, '.' );
+ if ( $cwd ) {
+ $cwd = trailingslashit( trim( $cwd ) );
+ }
return $cwd;
}
- function chdir($dir) {
+ /**
+ * @access public
+ *
+ * @param string $dir
+ * @return bool|string
+ */
+ public function chdir($dir) {
return $this->run_command('cd ' . $dir, true);
}
- function chgrp($file, $group, $recursive = false ) {
+ /**
+ * @access public
+ *
+ * @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 -R %s %s', escapeshellarg($group), escapeshellarg($file)), true);
}
- function chmod($file, $mode = false, $recursive = false) {
+ /**
+ * @access public
+ *
+ * @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;
/**
* Change the ownership of a file / folder.
*
- * @since Unknown
+ * @access public
*
- * @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.
*/
- function chown( $file, $owner, $recursive = false ) {
+ 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 -R %s %s', escapeshellarg($owner), escapeshellarg($file)), true);
}
- function owner($file) {
- $owneruid = @fileowner('ssh2.sftp://' . $this->sftp_link . '/' . ltrim($file, '/'));
+ /**
+ * @access public
+ *
+ * @param string $file
+ * @return string|false
+ */
+ public function owner($file) {
+ $owneruid = @fileowner( $this->sftp_path( $file ) );
if ( ! $owneruid )
return false;
if ( ! function_exists('posix_getpwuid') )
return $ownerarray['name'];
}
- function getchmod($file) {
- return substr(decoct(@fileperms( 'ssh2.sftp://' . $this->sftp_link . '/' . ltrim($file, '/') )),3);
+ /**
+ * @access public
+ *
+ * @param string $file
+ * @return string
+ */
+ public function getchmod($file) {
+ return substr( decoct( @fileperms( $this->sftp_path( $file ) ) ), -3 );
}
- function group($file) {
- $gid = @filegroup('ssh2.sftp://' . $this->sftp_link . '/' . ltrim($file, '/'));
+ /**
+ * @access public
+ *
+ * @param string $file
+ * @return string|false
+ */
+ public function group($file) {
+ $gid = @filegroup( $this->sftp_path( $file ) );
if ( ! $gid )
return false;
if ( ! function_exists('posix_getgrgid') )
return $grouparray['name'];
}
- function copy($source, $destination, $overwrite = false, $mode = false) {
+ /**
+ * @access public
+ *
+ * @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);
return $this->put_contents($destination, $content, $mode);
}
- function move($source, $destination, $overwrite = false) {
- return @ssh2_sftp_rename($this->link, $source, $destination);
+ /**
+ * @access public
+ *
+ * @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, $type = false) {
+ /**
+ * @access public
+ *
+ * @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);
}
- function exists($file) {
- $file = ltrim($file, '/');
- return file_exists('ssh2.sftp://' . $this->sftp_link . '/' . $file);
+ /**
+ * @access public
+ *
+ * @param string $file
+ * @return bool
+ */
+ public function exists($file) {
+ return file_exists( $this->sftp_path( $file ) );
}
- function is_file($file) {
- $file = ltrim($file, '/');
- return is_file('ssh2.sftp://' . $this->sftp_link . '/' . $file);
+ /**
+ * @access public
+ *
+ * @param string $file
+ * @return bool
+ */
+ public function is_file($file) {
+ return is_file( $this->sftp_path( $file ) );
}
- function is_dir($path) {
- $path = ltrim($path, '/');
- return is_dir('ssh2.sftp://' . $this->sftp_link . '/' . $path);
+ /**
+ * @access public
+ *
+ * @param string $path
+ * @return bool
+ */
+ public function is_dir($path) {
+ return is_dir( $this->sftp_path( $path ) );
}
- function is_readable($file) {
- $file = ltrim($file, '/');
- return is_readable('ssh2.sftp://' . $this->sftp_link . '/' . $file);
+ /**
+ * @access public
+ *
+ * @param string $file
+ * @return bool
+ */
+ public function is_readable($file) {
+ return is_readable( $this->sftp_path( $file ) );
}
- function is_writable($file) {
- $file = ltrim($file, '/');
- return is_writable('ssh2.sftp://' . $this->sftp_link . '/' . $file);
+ /**
+ * @access public
+ *
+ * @param string $file
+ * @return bool
+ */
+ public function is_writable($file) {
+ // PHP will base it's writable checks on system_user === file_owner, not ssh_user === file_owner
+ return true;
}
- function atime($file) {
- $file = ltrim($file, '/');
- return fileatime('ssh2.sftp://' . $this->sftp_link . '/' . $file);
+ /**
+ * @access public
+ *
+ * @param string $file
+ * @return int
+ */
+ public function atime($file) {
+ return fileatime( $this->sftp_path( $file ) );
}
- function mtime($file) {
- $file = ltrim($file, '/');
- return filemtime('ssh2.sftp://' . $this->sftp_link . '/' . $file);
+ /**
+ * @access public
+ *
+ * @param string $file
+ * @return int
+ */
+ public function mtime($file) {
+ return filemtime( $this->sftp_path( $file ) );
}
- function size($file) {
- $file = ltrim($file, '/');
- return filesize('ssh2.sftp://' . $this->sftp_link . '/' . $file);
+ /**
+ * @access public
+ *
+ * @param string $file
+ * @return int
+ */
+ public function size($file) {
+ return filesize( $this->sftp_path( $file ) );
}
- function touch($file, $time = 0, $atime = 0) {
+ /**
+ * @access public
+ *
+ * @param string $file
+ * @param int $time
+ * @param int $atime
+ */
+ public function touch($file, $time = 0, $atime = 0) {
//Not implemented.
}
- function mkdir($path, $chmod = false, $chown = false, $chgrp = false) {
+ /**
+ * @access public
+ *
+ * @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) )
return false;
return true;
}
- function rmdir($path, $recursive = false) {
+ /**
+ * @access public
+ *
+ * @param string $path
+ * @param bool $recursive
+ * @return bool
+ */
+ public function rmdir($path, $recursive = false) {
return $this->delete($path, $recursive);
}
- function dirlist($path, $include_hidden = true, $recursive = false) {
+ /**
+ * @access public
+ *
+ * @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);
$path = dirname($path);
return false;
$ret = array();
- $dir = @dir('ssh2.sftp://' . $this->sftp_link .'/' . ltrim($path, '/') );
+ $dir = @dir( $this->sftp_path( $path ) );
if ( ! $dir )
return false;
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff