WordPress 4.7.1-scripts
[autoinstalls/wordpress.git] / wp-admin / includes / class-wp-filesystem-ftpsockets.php
index 879a2e8ca8542e25d0881a4f98bbda7a26fae916..ff0b882414be3c22453a6eed50adb7fb1711039e 100644 (file)
  */
 class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
        /**
+        * @access public
         * @var ftp
         */
        public $ftp;
 
        /**
+        * @access public
         *
         * @param array $opt
         */
@@ -37,7 +39,7 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
                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'));
@@ -57,6 +59,7 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
        }
 
        /**
+        * @access public
         *
         * @return bool
         */
@@ -66,18 +69,33 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
 
                $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;
                }
 
@@ -88,8 +106,14 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
        }
 
        /**
-        * @param string $file
-        * @return false|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) )
@@ -97,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();
 
@@ -123,7 +149,10 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
                unlink($temp);
                return $contents;
        }
+
        /**
+        * @access public
+        *
         * @param string $file
         * @return array
         */
@@ -132,6 +161,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
        }
 
        /**
+        * @access public
+        *
         * @param string $file
         * @param string $contents
         * @param int|bool $mode
@@ -172,6 +203,7 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
        }
 
        /**
+        * @access public
         *
         * @return string
         */
@@ -183,6 +215,7 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
        }
 
        /**
+        * @access public
         *
         * @param string $file
         * @return bool
@@ -192,6 +225,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
        }
 
        /**
+        * @access public
+        *
         * @param string $file
         * @param int|bool $mode
         * @param bool $recursive
@@ -219,6 +254,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
        }
 
        /**
+        * @access public
+        *
         * @param string $file
         * @return string
         */
@@ -226,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
         */
@@ -234,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
         */
@@ -242,7 +285,10 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
                $dir = $this->dirlist($file);
                return $dir[$file]['group'];
        }
+
        /**
+        * @access public
+        *
         * @param string   $source
         * @param string   $destination
         * @param bool     $overwrite
@@ -259,7 +305,10 @@ 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
@@ -268,7 +317,10 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
        public function move($source, $destination, $overwrite = false ) {
                return $this->ftp->rename($source, $destination);
        }
+
        /**
+        * @access public
+        *
         * @param string $file
         * @param bool   $recursive
         * @param string $type
@@ -286,6 +338,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
        }
 
        /**
+        * @access public
+        *
         * @param string $file
         * @return bool
         */
@@ -301,6 +355,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
        }
 
        /**
+        * @access public
+        *
         * @param string $file
         * @return bool
         */
@@ -313,6 +369,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
        }
 
        /**
+        * @access public
+        *
         * @param string $path
         * @return bool
         */
@@ -326,6 +384,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
        }
 
        /**
+        * @access public
+        *
         * @param string $file
         * @return bool
         */
@@ -334,6 +394,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
        }
 
        /**
+        * @access public
+        *
         * @param string $file
         * @return bool
         */
@@ -342,6 +404,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
        }
 
        /**
+        * @access public
+        *
         * @param string $file
         * @return bool
         */
@@ -350,6 +414,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
        }
 
        /**
+        * @access public
+        *
         * @param string $file
         * @return int
         */
@@ -364,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
@@ -375,6 +444,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
        }
 
        /**
+        * @access public
+        *
         * @param string $path
         * @param mixed  $chmod
         * @param mixed  $chown
@@ -395,7 +466,9 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
        }
 
        /**
-        * @param sting $path
+        * @access public
+        *
+        * @param string $path
         * @param bool $recursive
         */
        public function rmdir($path, $recursive = false ) {
@@ -403,6 +476,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
        }
 
        /**
+        * @access public
+        *
         * @param string $path
         * @param bool   $include_hidden
         * @param bool   $recursive