WordPress 4.3.1
[autoinstalls/wordpress.git] / wp-admin / includes / class-wp-filesystem-ssh2.php
index 0337658c9dca1ae8aaea252968d32ef522422037..2b167965910eeb56f149e600089d83e7ee3c25c3 100644 (file)
@@ -1,13 +1,6 @@
 <?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+
  *
  *
  * Note: as of WordPress 2.8, This utilises the PHP5+ function 'stream_get_contents'
  *
- * @since 2.7
+ * @since 2.7.0
+ *
  * @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;
-       var $errors = array();
-       var $options = array();
-
-       function WP_Filesystem_SSH2($opt='') {
+       public $link = false;
+       /**
+        * @var resource
+        */
+       public $sftp_link;
+       public $keys = false;
+
+       /**
+        *
+        * @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:
@@ -73,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'];
@@ -92,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 {
@@ -129,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;
 
@@ -150,41 +153,83 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
                return false;
        }
 
-       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);
        }
 
-       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);
        }
 
-       function put_contents($file, $contents, $type = '' ) {
-               $file = ltrim($file, '/');
-               return false !== 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) {
+       /**
+        * @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;
 
@@ -202,15 +247,29 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
                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;
@@ -219,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;
@@ -234,79 +300,140 @@ 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) {
+       /**
+        * @param string $file
+        * @return bool
+        */
+       public function exists($file) {
                $file = ltrim($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);
        }
-
-       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);
        }
-
-       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);
        }
-
-       function is_writable($file) {
-               $file = ltrim($file, '/');
-               return is_writable('ssh2.sftp://' . $this->sftp_link . '/' . $file);
+       /**
+        * @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) {
+       /**
+        * @param string $file
+        * @return int
+        */
+       public function atime($file) {
                $file = ltrim($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);
        }
 
-       function size($file) {
+       /**
+        * @param string $file
+        * @return int
+        */
+       public function size($file) {
                $file = ltrim($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 = false, $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);
+               if ( empty($path) )
+                       return false;
+
                if ( ! $chmod )
                        $chmod = FS_CHMOD_DIR;
                if ( ! ssh2_sftp_mkdir($this->sftp_link, $path, $chmod, true) )
@@ -318,11 +445,22 @@ 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, $include_hidden = true, $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) ) {
                        $limit_file = basename($path);
                        $path = dirname($path);