WordPress 4.3
[autoinstalls/wordpress.git] / wp-admin / includes / class-wp-filesystem-ftpext.php
index 20699351d9d96fb52e1eaa8ecfa49acd1c9d7a96..62ade49136ec5a9c6143529280811ae3a2d1a6c7 100644 (file)
@@ -1,38 +1,41 @@
 <?php
-class WP_Filesystem_FTPext extends WP_Filesystem_Base{
-       var $link;
-       var $timeout = 5;
-       var $errors = array();
-       var $options = array();
-
-       var $permission = null;
-
-       var $filetypes = array(
-                                                       'php'=>FTP_ASCII,
-                                                       'css'=>FTP_ASCII,
-                                                       'txt'=>FTP_ASCII,
-                                                       'js'=>FTP_ASCII,
-                                                       'html'=>FTP_ASCII,
-                                                       'htm'=>FTP_ASCII,
-                                                       'xml'=>FTP_ASCII,
-
-                                                       'jpg'=>FTP_BINARY,
-                                                       'png'=>FTP_BINARY,
-                                                       'gif'=>FTP_BINARY,
-                                                       'bmp'=>FTP_BINARY
-                                                       );
-
-       function WP_Filesystem_FTPext($opt='') {
+/**
+ * WordPress FTP Filesystem.
+ *
+ * @package WordPress
+ * @subpackage Filesystem
+ */
+
+/**
+ * WordPress Filesystem Class for implementing FTP.
+ *
+ * @since 2.5.0
+ * @package WordPress
+ * @subpackage Filesystem
+ * @uses WP_Filesystem_Base Extends class
+ */
+class WP_Filesystem_FTPext extends WP_Filesystem_Base {
+       public $link;
+
+       /**
+        *
+        * @param array $opt
+        */
+       public function __construct( $opt = '' ) {
                $this->method = 'ftpext';
                $this->errors = new WP_Error();
 
-               //Check if possible to use ftp functions.
+               // Check if possible to use ftp functions.
                if ( ! extension_loaded('ftp') ) {
                        $this->errors->add('no_ftp_ext', __('The ftp PHP extension is not available'));
-                       return false;
+                       return;
                }
 
-               // Set defaults:
+               // This Class uses the timeout on a per-connection basis, Others use it on a per-action basis.
+
+               if ( ! defined('FS_TIMEOUT') )
+                       define('FS_TIMEOUT', 240);
+
                if ( empty($opt['port']) )
                        $this->options['port'] = 21;
                else
@@ -43,28 +46,31 @@ class WP_Filesystem_FTPext 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['username']) )
+               if ( empty($opt['username']) )
                        $this->errors->add('empty_username', __('FTP username is required'));
                else
                        $this->options['username'] = $opt['username'];
 
-               if ( empty ($opt['password']) )
+               if ( empty($opt['password']) )
                        $this->errors->add('empty_password', __('FTP password is required'));
                else
                        $this->options['password'] = $opt['password'];
 
-               $this->options['ssl'] = ( !empty($opt['ssl']) );
+               $this->options['ssl'] = false;
+               if ( isset($opt['connection_type']) && 'ftps' == $opt['connection_type'] )
+                       $this->options['ssl'] = true;
        }
 
-       function connect() {
-               if ( $this->options['ssl'] && function_exists('ftp_ssl_connect') )
-                       $this->link = @ftp_ssl_connect($this->options['hostname'], $this->options['port'],$this->timeout);
+       /**
+        *
+        * @return bool
+        */
+       public function connect() {
+               if ( isset($this->options['ssl']) && $this->options['ssl'] && function_exists('ftp_ssl_connect') )
+                       $this->link = @ftp_ssl_connect($this->options['hostname'], $this->options['port'], FS_CONNECT_TIMEOUT);
                else
-                       $this->link = @ftp_connect($this->options['hostname'], $this->options['port'],$this->timeout);
+                       $this->link = @ftp_connect($this->options['hostname'], $this->options['port'], FS_CONNECT_TIMEOUT);
 
                if ( ! $this->link ) {
                        $this->errors->add('connect', sprintf(__('Failed to connect to FTP Server %1$s:%2$s'), $this->options['hostname'], $this->options['port']));
@@ -76,183 +82,322 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base{
                        return false;
                }
 
+               // Set the Connection to use Passive FTP
+               @ftp_pasv( $this->link, true );
+               if ( @ftp_get_option($this->link, FTP_TIMEOUT_SEC) < FS_TIMEOUT )
+                       @ftp_set_option($this->link, FTP_TIMEOUT_SEC, FS_TIMEOUT);
+
                return true;
        }
 
-       function setDefaultPermissions($perm) {
-               $this->permission = $perm;
-       }
-       
-       function get_contents($file, $type = '', $resumepos = 0 ){
-               if( empty($type) ){
-                       $extension = substr(strrchr($file, "."), 1);
-                       $type = isset($this->filetypes[ $extension ]) ? $this->filetypes[ $extension ] : FTP_ASCII;
-               }
-               $temp = tmpfile();
+       /**
+        * @param string $file
+        * @return false|string
+        */
+       public function get_contents( $file ) {
+               $tempfile = wp_tempnam($file);
+               $temp = fopen($tempfile, 'w+');
+
                if ( ! $temp )
                        return false;
-               if( ! @ftp_fget($this->link, $temp, $file, $type, $resumepos) )
+
+               if ( ! @ftp_fget($this->link, $temp, $file, FTP_BINARY ) )
                        return false;
-               fseek($temp, 0); //Skip back to the start of the file being written to
+
+               fseek( $temp, 0 ); // Skip back to the start of the file being written to
                $contents = '';
-               while (!feof($temp)) {
+
+               while ( ! feof($temp) )
                        $contents .= fread($temp, 8192);
-               }
+
                fclose($temp);
+               unlink($tempfile);
                return $contents;
        }
-       function get_contents_array($file) {
+
+       /**
+        * @param string $file
+        * @return array
+        */
+       public function get_contents_array($file) {
                return explode("\n", $this->get_contents($file));
        }
-       function put_contents($file, $contents, $type = '' ) {
-               if( empty($type) ) {
-                       $extension = substr(strrchr($file, "."), 1);
-                       $type = isset($this->filetypes[ $extension ]) ? $this->filetypes[ $extension ] : FTP_ASCII;
-               }
-               $temp = tmpfile();
+
+       /**
+        * @param string $file
+        * @param string $contents
+        * @param bool|int $mode
+        * @return bool
+        */
+       public function put_contents($file, $contents, $mode = false ) {
+               $tempfile = wp_tempnam($file);
+               $temp = fopen( $tempfile, 'wb+' );
                if ( ! $temp )
                        return false;
-               fwrite($temp, $contents);
-               fseek($temp, 0); //Skip back to the start of the file being written to
-               $ret = @ftp_fput($this->link, $file, $temp, $type);
+
+               mbstring_binary_safe_encoding();
+
+               $data_length = strlen( $contents );
+               $bytes_written = fwrite( $temp, $contents );
+
+               reset_mbstring_encoding();
+
+               if ( $data_length !== $bytes_written ) {
+                       fclose( $temp );
+                       unlink( $tempfile );
+                       return false;
+               }
+
+               fseek( $temp, 0 ); // Skip back to the start of the file being written to
+
+               $ret = @ftp_fput( $this->link, $file, $temp, FTP_BINARY );
+
                fclose($temp);
+               unlink($tempfile);
+
+               $this->chmod($file, $mode);
+
                return $ret;
        }
-       function cwd() {
-               $cwd = ftp_pwd($this->link);
-               if( $cwd )
+
+       /**
+        * @return string
+        */
+       public function cwd() {
+               $cwd = @ftp_pwd($this->link);
+               if ( $cwd )
                        $cwd = trailingslashit($cwd);
                return $cwd;
        }
-       function chdir($dir) {
-               return @ftp_chdir($dir);
-       }
-       function chgrp($file, $group, $recursive = false ) {
-               return false;
+
+       /**
+        * @param string $dir
+        * @return bool
+        */
+       public function chdir($dir) {
+               return @ftp_chdir($this->link, $dir);
        }
-       function chmod($file, $mode = false, $recursive = false) {
-               if( ! $mode )
-                       $mode = $this->permission;
-               if( ! $mode )
-                       return false;
-               if ( ! $this->exists($file) )
-                       return false;
-               if ( ! $recursive || ! $this->is_dir($file) ) {
-                       if ( ! function_exists('ftp_chmod') )
-                               return @ftp_site($this->link, sprintf('CHMOD %o %s', $mode, $file));
-                       return @ftp_chmod($this->link, $mode, $file);
+
+       /**
+        * @param string $file
+        * @param int $mode
+        * @param bool $recursive
+        * @return bool
+        */
+       public function chmod($file, $mode = false, $recursive = false) {
+               if ( ! $mode ) {
+                       if ( $this->is_file($file) )
+                               $mode = FS_CHMOD_FILE;
+                       elseif ( $this->is_dir($file) )
+                               $mode = FS_CHMOD_DIR;
+                       else
+                               return false;
                }
-               //Is a directory, and we want recursive
-               $filelist = $this->dirlist($file);
-               foreach($filelist as $filename){
-                       $this->chmod($file . '/' . $filename, $mode, $recursive);
+
+               // chmod any sub-objects if recursive.
+               if ( $recursive && $this->is_dir($file) ) {
+                       $filelist = $this->dirlist($file);
+                       foreach ( (array)$filelist as $filename => $filemeta )
+                               $this->chmod($file . '/' . $filename, $mode, $recursive);
                }
-               return true;
-       }
-       function chown($file, $owner, $recursive = false ) {
-               return false;
+
+               // chmod the file or directory
+               if ( ! function_exists('ftp_chmod') )
+                       return (bool)@ftp_site($this->link, sprintf('CHMOD %o %s', $mode, $file));
+               return (bool)@ftp_chmod($this->link, $mode, $file);
        }
-       function owner($file) {
+
+       /**
+        * @param string $file
+        * @return string
+        */
+       public function owner($file) {
                $dir = $this->dirlist($file);
                return $dir[$file]['owner'];
        }
-       function getchmod($file) {
+       /**
+        * @param string $file
+        * @return string
+        */
+       public function getchmod($file) {
                $dir = $this->dirlist($file);
                return $dir[$file]['permsn'];
        }
-       function group($file) {
+       /**
+        * @param string $file
+        * @return string
+        */
+       public function group($file) {
                $dir = $this->dirlist($file);
                return $dir[$file]['group'];
        }
-       function copy($source, $destination, $overwrite = false ) {
-               if( ! $overwrite && $this->exists($destination) )
+
+       /**
+        *
+        * @param string $source
+        * @param string $destination
+        * @param bool   $overwrite
+        * @param string|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) {
+       /**
+        * @param string $source
+        * @param string $destination
+        * @param bool $overwrite
+        * @return bool
+        */
+       public function move($source, $destination, $overwrite = false) {
                return ftp_rename($this->link, $source, $destination);
        }
-
-       function delete($file,$recursive=false) {
-               if ( $this->is_file($file) )
+       /**
+        * @param string $file
+        * @param bool $recursive
+        * @param string $type
+        * @return bool
+        */
+       public function delete($file, $recursive = false, $type = false) {
+               if ( empty($file) )
+                       return false;
+               if ( 'f' == $type || $this->is_file($file) )
                        return @ftp_delete($this->link, $file);
                if ( !$recursive )
                        return @ftp_rmdir($this->link, $file);
-               $filelist = $this->dirlist($file);
-               foreach ((array) $filelist as $filename => $fileinfo) {
-                       $this->delete($file . '/' . $filename, $recursive);
-               }
+
+               $filelist = $this->dirlist( trailingslashit($file) );
+               if ( !empty($filelist) )
+                       foreach ( $filelist as $delete_file )
+                               $this->delete( trailingslashit($file) . $delete_file['name'], $recursive, $delete_file['type'] );
                return @ftp_rmdir($this->link, $file);
        }
+       /**
+        * @param string $file
+        * @return bool
+        */
+       public function exists($file) {
+               $list = @ftp_nlist($this->link, $file);
+
+               if ( empty( $list ) && $this->is_dir( $file ) ) {
+                       return true; // File is an empty directory.
+               }
 
-       function exists($file) {
-               $list = ftp_rawlist($this->link, $file, false);
-               if( ! $list )
-                       return false;
-               return count($list) == 1 ? true : false;
+               return !empty($list); //empty list = no file, so invert.
        }
-       function is_file($file) {
-               return $this->is_dir($file) ? false : true;
+       /**
+        * @param string $file
+        * @return bool
+        */
+       public function is_file($file) {
+               return $this->exists($file) && !$this->is_dir($file);
        }
-       function is_dir($path) {
+       /**
+        * @param string $path
+        * @return bool
+        */
+       public function is_dir($path) {
                $cwd = $this->cwd();
-               $result = @ftp_chdir($this->link, $path);
-               if( $result && $path == $this->cwd() || $this->cwd() != $cwd ) {
+               $result = @ftp_chdir($this->link, trailingslashit($path) );
+               if ( $result && $path == $this->cwd() || $this->cwd() != $cwd ) {
                        @ftp_chdir($this->link, $cwd);
                        return true;
                }
                return false;
        }
-       function is_readable($file) {
-               //Get dir list, Check if the file is writable by the current user??
+
+       /**
+        * @param string $file
+        * @return bool
+        */
+       public function is_readable($file) {
                return true;
        }
-       function is_writable($file) {
-               //Get dir list, Check if the file is writable by the current user??
+       /**
+        * @param string $file
+        * @return bool
+        */
+       public function is_writable($file) {
                return true;
        }
-       function atime($file) {
+       /**
+        * @param string $file
+        * @return bool
+        */
+       public function atime($file) {
                return false;
        }
-       function mtime($file) {
+       /**
+        * @param string $file
+        * @return int
+        */
+       public function mtime($file) {
                return ftp_mdtm($this->link, $file);
        }
-       function size($file) {
+       /**
+        * @param string $file
+        * @return int
+        */
+       public function size($file) {
                return ftp_size($this->link, $file);
        }
-       function touch($file, $time = 0, $atime = 0) {
+       /**
+        * @param string $file
+        * @return bool
+        */
+       public function touch($file, $time = 0, $atime = 0) {
                return false;
        }
-       function mkdir($path, $chmod = false, $chown = false, $chgrp = false) {
-               if( !@ftp_mkdir($this->link, $path) )
+
+       /**
+        * @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 )
-                       $this->chmod($path, $chmod);
-               if( $chown )
-                       $this->chown($path, $chown);
-               if( $chgrp )
-                       $this->chgrp($path, $chgrp);
+
+               if ( !@ftp_mkdir($this->link, $path) )
+                       return false;
+               $this->chmod($path, $chmod);
                return true;
        }
-       function rmdir($path, $recursive = false) {
-               if( ! $recursive )
-                       return @ftp_rmdir($this->link, $path);
-
-               //TODO: Recursive Directory delete, Have to delete files from the folder first.
-               //$dir = $this->dirlist($path);
-               //foreach($dir as $file)
 
+       /**
+        * @param string $path
+        * @param bool $recursive
+        * @return bool
+        */
+       public function rmdir($path, $recursive = false) {
+               return $this->delete($path, $recursive);
        }
 
-       function parselisting($line) {
-               $is_windows = ($this->OS_remote == FTP_OS_Windows);
-               if ($is_windows && preg_match("/([0-9]{2})-([0-9]{2})-([0-9]{2}) +([0-9]{2}):([0-9]{2})(AM|PM) +([0-9]+|<DIR>) +(.+)/", $line, $lucifer)) {
+       /**
+        * @staticvar bool $is_windows
+        * @param string $line
+        * @return array
+        */
+       public function parselisting($line) {
+               static $is_windows = null;
+               if ( is_null($is_windows) )
+                       $is_windows = stripos( ftp_systype($this->link), 'win') !== false;
+
+               if ( $is_windows && preg_match('/([0-9]{2})-([0-9]{2})-([0-9]{2}) +([0-9]{2}):([0-9]{2})(AM|PM) +([0-9]+|<DIR>) +(.+)/', $line, $lucifer) ) {
                        $b = array();
-                       if ($lucifer[3]<70) { $lucifer[3] +=2000; } else { $lucifer[3]+=1900; } // 4digit year fix
-                       $b['isdir'] = ($lucifer[7]=="<DIR>");
+                       if ( $lucifer[3] < 70 )
+                               $lucifer[3] +=2000;
+                       else
+                               $lucifer[3] += 1900; // 4digit year fix
+                       $b['isdir'] = ( $lucifer[7] == '<DIR>');
                        if ( $b['isdir'] )
                                $b['type'] = 'd';
                        else
@@ -263,16 +408,17 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base{
                        $b['year'] = $lucifer[3];
                        $b['hour'] = $lucifer[4];
                        $b['minute'] = $lucifer[5];
-                       $b['time'] = @mktime($lucifer[4]+(strcasecmp($lucifer[6],"PM")==0?12:0),$lucifer[5],0,$lucifer[1],$lucifer[2],$lucifer[3]);
+                       $b['time'] = @mktime($lucifer[4] + (strcasecmp($lucifer[6], "PM") == 0 ? 12 : 0), $lucifer[5], 0, $lucifer[1], $lucifer[2], $lucifer[3]);
                        $b['am/pm'] = $lucifer[6];
                        $b['name'] = $lucifer[8];
-               } else if (!$is_windows && $lucifer=preg_split("/[ ]/",$line,9,PREG_SPLIT_NO_EMPTY)) {
+               } elseif ( !$is_windows && $lucifer = preg_split('/[ ]/', $line, 9, PREG_SPLIT_NO_EMPTY)) {
                        //echo $line."\n";
-                       $lcount=count($lucifer);
-                       if ($lcount<8) return '';
+                       $lcount = count($lucifer);
+                       if ( $lcount < 8 )
+                               return '';
                        $b = array();
-                       $b['isdir'] = $lucifer[0]{0} === "d";
-                       $b['islink'] = $lucifer[0]{0} === "l";
+                       $b['isdir'] = $lucifer[0]{0} === 'd';
+                       $b['islink'] = $lucifer[0]{0} === 'l';
                        if ( $b['isdir'] )
                                $b['type'] = 'd';
                        elseif ( $b['islink'] )
@@ -280,19 +426,20 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base{
                        else
                                $b['type'] = 'f';
                        $b['perms'] = $lucifer[0];
+                       $b['permsn'] = $this->getnumchmodfromh( $b['perms'] );
                        $b['number'] = $lucifer[1];
                        $b['owner'] = $lucifer[2];
                        $b['group'] = $lucifer[3];
                        $b['size'] = $lucifer[4];
-                       if ($lcount==8) {
-                               sscanf($lucifer[5],"%d-%d-%d",$b['year'],$b['month'],$b['day']);
-                               sscanf($lucifer[6],"%d:%d",$b['hour'],$b['minute']);
-                               $b['time'] = @mktime($b['hour'],$b['minute'],0,$b['month'],$b['day'],$b['year']);
+                       if ( $lcount == 8 ) {
+                               sscanf($lucifer[5], '%d-%d-%d', $b['year'], $b['month'], $b['day']);
+                               sscanf($lucifer[6], '%d:%d', $b['hour'], $b['minute']);
+                               $b['time'] = @mktime($b['hour'], $b['minute'], 0, $b['month'], $b['day'], $b['year']);
                                $b['name'] = $lucifer[7];
                        } else {
                                $b['month'] = $lucifer[5];
                                $b['day'] = $lucifer[6];
-                               if (preg_match("/([0-9]{2}):([0-9]{2})/",$lucifer[7],$l2)) {
+                               if ( preg_match('/([0-9]{2}):([0-9]{2})/', $lucifer[7], $l2) ) {
                                        $b['year'] = date("Y");
                                        $b['hour'] = $l2[1];
                                        $b['minute'] = $l2[2];
@@ -301,25 +448,39 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base{
                                        $b['hour'] = 0;
                                        $b['minute'] = 0;
                                }
-                               $b['time'] = strtotime(sprintf("%d %s %d %02d:%02d",$b['day'],$b['month'],$b['year'],$b['hour'],$b['minute']));
+                               $b['time'] = strtotime( sprintf('%d %s %d %02d:%02d', $b['day'], $b['month'], $b['year'], $b['hour'], $b['minute']) );
                                $b['name'] = $lucifer[8];
                        }
                }
 
+               // Replace symlinks formatted as "source -> target" with just the source name
+               if ( $b['islink'] )
+                       $b['name'] = preg_replace( '/(\s*->\s*.*)$/', '', $b['name'] );
+
                return $b;
        }
 
-       function dirlist($path = '.', $incdot = false, $recursive = false) {
-               if( $this->is_file($path) ) {
-                       $limitFile = basename($path);
+       /**
+        * @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) . '/';
                } else {
-                       $limitFile = false;
+                       $limit_file = false;
                }
 
-               $list = @ftp_rawlist($this->link, '-a ' . $path, false);
+               $pwd = @ftp_pwd($this->link);
+               if ( ! @ftp_chdir($this->link, $path) ) // Cant change to folder = folder doesn't exist
+                       return false;
+               $list = @ftp_rawlist($this->link, '-a', false);
+               @ftp_chdir($this->link, $pwd);
 
-               if ( $list === false )
+               if ( empty($list) ) // Empty array = non-existent folder (real folder will show . at least)
                        return false;
 
                $dirlist = array();
@@ -328,44 +489,37 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base{
                        if ( empty($entry) )
                                continue;
 
-                       if ( '.' == $entry["name"] || '..' == $entry["name"] )
+                       if ( '.' == $entry['name'] || '..' == $entry['name'] )
+                               continue;
+
+                       if ( ! $include_hidden && '.' == $entry['name'][0] )
+                               continue;
+
+                       if ( $limit_file && $entry['name'] != $limit_file)
                                continue;
 
                        $dirlist[ $entry['name'] ] = $entry;
                }
 
-               if ( ! $dirlist )
-                       return false;
-               if ( empty($dirlist) )
-                       return array();
-
                $ret = array();
-               foreach ( $dirlist as $struc ) {
-
+               foreach ( (array)$dirlist as $struc ) {
                        if ( 'd' == $struc['type'] ) {
-                               $struc['files'] = array();
-
-                               if ( $incdot ){
-                                       //We're including the doted starts
-                                       if( '.' != $struc['name'] && '..' != $struc['name'] ){ //Ok, It isnt a special folder
-                                               if ($recursive)
-                                                       $struc['files'] = $this->dirlist($path . '/' . $struc['name'], $incdot, $recursive);
-                                       }
-                               } else { //No dots
-                                       if ($recursive)
-                                               $struc['files'] = $this->dirlist($path . '/' . $struc['name'], $incdot, $recursive);
-                               }
+                               if ( $recursive )
+                                       $struc['files'] = $this->dirlist($path . '/' . $struc['name'], $include_hidden, $recursive);
+                               else
+                                       $struc['files'] = array();
                        }
-                       //File
-                       $ret[$struc['name']] = $struc;
+
+                       $ret[ $struc['name'] ] = $struc;
                }
                return $ret;
        }
 
-       function __destruct(){
-               if( $this->link )
+       /**
+        * @access public
+        */
+       public function __destruct() {
+               if ( $this->link )
                        ftp_close($this->link);
        }
 }
-
-?>