WordPress 4.7.1-scripts
[autoinstalls/wordpress.git] / wp-admin / includes / class-wp-filesystem-ftpsockets.php
index bb7e0c2e6293ad1fcc22a8f06be46cd7962c17a1..ff0b882414be3c22453a6eed50adb7fb1711039e 100644 (file)
  * @uses WP_Filesystem_Base Extends class
  */
 class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
-       public $ftp = false;
-       public $errors = null;
-       public $options = array();
+       /**
+        * @access public
+        * @var ftp
+        */
+       public $ftp;
 
-       public function __construct($opt = '') {
+       /**
+        * @access public
+        *
+        * @param array $opt
+        */
+       public function __construct( $opt  = '' ) {
                $this->method = 'ftpsockets';
                $this->errors = new WP_Error();
 
                // Check if possible to use ftp functions.
                if ( ! @include_once( ABSPATH . 'wp-admin/includes/class-ftp.php' ) ) {
-                       return false;
+                       return;
                }
                $this->ftp = new ftp();
 
                if ( empty($opt['port']) )
                        $this->options['port'] = 21;
                else
-                       $this->options['port'] = $opt['port'];
+                       $this->options['port'] = (int) $opt['port'];
 
                if ( empty($opt['hostname']) )
                        $this->errors->add('empty_hostname', __('FTP hostname is required'));
                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['username']) )
                        $this->errors->add('empty_username', __('FTP username is required'));
@@ -54,24 +58,44 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
                        $this->options['password'] = $opt['password'];
        }
 
+       /**
+        * @access public
+        *
+        * @return bool
+        */
        public function connect() {
                if ( ! $this->ftp )
                        return false;
 
                $this->ftp->setTimeout(FS_CONNECT_TIMEOUT);
 
-               if ( ! $this->ftp->SetServer($this->options['hostname'], $this->options['port']) ) {
-                       $this->errors->add('connect', sprintf(__('Failed to connect to FTP Server %1$s:%2$s'), $this->options['hostname'], $this->options['port']));
+               if ( ! $this->ftp->SetServer( $this->options['hostname'], $this->options['port'] ) ) {
+                       $this->errors->add( 'connect',
+                               /* translators: %s: hostname:port */
+                               sprintf( __( 'Failed to connect to FTP Server %s' ),
+                                       $this->options['hostname'] . ':' . $this->options['port']
+                               )
+                       );
                        return false;
                }
 
                if ( ! $this->ftp->connect() ) {
-                       $this->errors->add('connect', sprintf(__('Failed to connect to FTP Server %1$s:%2$s'), $this->options['hostname'], $this->options['port']));
+                       $this->errors->add( 'connect',
+                               /* translators: %s: hostname:port */
+                               sprintf( __( 'Failed to connect to FTP Server %s' ),
+                                       $this->options['hostname'] . ':' . $this->options['port']
+                               )
+                       );
                        return false;
                }
 
-               if ( ! $this->ftp->login($this->options['username'], $this->options['password']) ) {
-                       $this->errors->add('auth', sprintf(__('Username/Password incorrect for %s'), $this->options['username']));
+               if ( ! $this->ftp->login( $this->options['username'], $this->options['password'] ) ) {
+                       $this->errors->add( 'auth',
+                               /* translators: %s: username */
+                               sprintf( __( 'Username/Password incorrect for %s' ),
+                                       $this->options['username']
+                               )
+                       );
                        return false;
                }
 
@@ -82,8 +106,14 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
        }
 
        /**
-        * @param string $file
-        * @return bool|string
+        * Retrieves the file contents.
+        *
+        * @since 2.5.0
+        * @access public
+        *
+        * @param string $file Filename.
+        * @return string|false File contents on success, false if no temp file could be opened,
+        *                      or if the file doesn't exist.
         */
        public function get_contents( $file ) {
                if ( ! $this->exists($file) )
@@ -91,8 +121,10 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
 
                $temp = wp_tempnam( $file );
 
-               if ( ! $temphandle = fopen($temp, 'w+') )
+               if ( ! $temphandle = fopen( $temp, 'w+' ) ) {
+                       unlink( $temp );
                        return false;
+               }
 
                mbstring_binary_safe_encoding();
 
@@ -117,7 +149,10 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
                unlink($temp);
                return $contents;
        }
+
        /**
+        * @access public
+        *
         * @param string $file
         * @return array
         */
@@ -126,6 +161,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
        }
 
        /**
+        * @access public
+        *
         * @param string $file
         * @param string $contents
         * @param int|bool $mode
@@ -165,6 +202,11 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
                return $ret;
        }
 
+       /**
+        * @access public
+        *
+        * @return string
+        */
        public function cwd() {
                $cwd = $this->ftp->pwd();
                if ( $cwd )
@@ -172,20 +214,19 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
                return $cwd;
        }
 
-       public function chdir($file) {
-               return $this->ftp->chdir($file);
-       }
-
        /**
+        * @access public
+        *
         * @param string $file
-        * @param bool $group
-        * @param bool $recursive
+        * @return bool
         */
-       public function chgrp($file, $group, $recursive = false ) {
-               return false;
+       public function chdir($file) {
+               return $this->ftp->chdir($file);
        }
 
        /**
+        * @access public
+        *
         * @param string $file
         * @param int|bool $mode
         * @param bool $recursive
@@ -213,6 +254,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
        }
 
        /**
+        * @access public
+        *
         * @param string $file
         * @return string
         */
@@ -220,7 +263,10 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
                $dir = $this->dirlist($file);
                return $dir[$file]['owner'];
        }
+
        /**
+        * @access public
+        *
         * @param string $file
         * @return string
         */
@@ -228,7 +274,10 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
                $dir = $this->dirlist($file);
                return $dir[$file]['permsn'];
        }
+
        /**
+        * @access public
+        *
         * @param string $file
         * @return string
         */
@@ -236,10 +285,13 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
                $dir = $this->dirlist($file);
                return $dir[$file]['group'];
        }
+
        /**
-        * @param string $source
-        * @param string $destination
-        * @param bool $overwrite
+        * @access public
+        *
+        * @param string   $source
+        * @param string   $destination
+        * @param bool     $overwrite
         * @param int|bool $mode
         * @return bool
         */
@@ -253,18 +305,24 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
 
                return $this->put_contents($destination, $content, $mode);
        }
+
        /**
+        * @access public
+        *
         * @param string $source
         * @param string $destination
-        * @param bool $overwrite
+        * @param bool   $overwrite
         * @return bool
         */
        public function move($source, $destination, $overwrite = false ) {
                return $this->ftp->rename($source, $destination);
        }
+
        /**
+        * @access public
+        *
         * @param string $file
-        * @param bool $recursive
+        * @param bool   $recursive
         * @param string $type
         * @return bool
         */
@@ -280,16 +338,25 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
        }
 
        /**
+        * @access public
+        *
         * @param string $file
         * @return bool
         */
        public function exists( $file ) {
                $list = $this->ftp->nlist( $file );
+
+               if ( empty( $list ) && $this->is_dir( $file ) ) {
+                       return true; // File is an empty directory.
+               }
+
                return !empty( $list ); //empty list = no file, so invert.
                // Return $this->ftp->is_exists($file); has issues with ABOR+426 responses on the ncFTPd server.
        }
 
        /**
+        * @access public
+        *
         * @param string $file
         * @return bool
         */
@@ -302,6 +369,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
        }
 
        /**
+        * @access public
+        *
         * @param string $path
         * @return bool
         */
@@ -315,6 +384,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
        }
 
        /**
+        * @access public
+        *
         * @param string $file
         * @return bool
         */
@@ -323,6 +394,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
        }
 
        /**
+        * @access public
+        *
         * @param string $file
         * @return bool
         */
@@ -331,6 +404,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
        }
 
        /**
+        * @access public
+        *
         * @param string $file
         * @return bool
         */
@@ -339,6 +414,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
        }
 
        /**
+        * @access public
+        *
         * @param string $file
         * @return int
         */
@@ -353,7 +430,10 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
        public function size($file) {
                return $this->ftp->filesize($file);
        }
+
        /**
+        * @access public
+        *
         * @param string $file
         * @param int $time
         * @param int $atime
@@ -364,10 +444,12 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
        }
 
        /**
+        * @access public
+        *
         * @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 ) {
@@ -380,15 +462,13 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
                if ( ! $chmod )
                        $chmod = FS_CHMOD_DIR;
                $this->chmod($path, $chmod);
-               if ( $chown )
-                       $this->chown($path, $chown);
-               if ( $chgrp )
-                       $this->chgrp($path, $chgrp);
                return true;
        }
 
        /**
-        * @param sting $path
+        * @access public
+        *
+        * @param string $path
         * @param bool $recursive
         */
        public function rmdir($path, $recursive = false ) {
@@ -396,9 +476,11 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
        }
 
        /**
+        * @access public
+        *
         * @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 ) {
@@ -442,6 +524,9 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
                        if ( $struc['islink'] )
                                $struc['name'] = preg_replace( '/(\s*->\s*.*)$/', '', $struc['name'] );
 
+                       // Add the Octal representation of the file permissions
+                       $struc['permsn'] = $this->getnumchmodfromh( $struc['perms'] );
+
                        $ret[ $struc['name'] ] = $struc;
                }
 
@@ -450,6 +535,9 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
                return $ret;
        }
 
+       /**
+        * @access public
+        */
        public function __destruct() {
                $this->ftp->quit();
        }