]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-admin/includes/class-wp-filesystem-ftpext.php
WordPress 4.5
[autoinstalls/wordpress.git] / wp-admin / includes / class-wp-filesystem-ftpext.php
index b8d5c9ae6bd34a7dd8e8881baff8cb829c488a51..e1202aedd29c9143a5998c52e119c11fddea0263 100644 (file)
@@ -9,28 +9,30 @@
 /**
  * WordPress Filesystem Class for implementing FTP.
  *
- * @since 2.5
+ * @since 2.5.0
  * @package WordPress
  * @subpackage Filesystem
  * @uses WP_Filesystem_Base Extends class
  */
 class WP_Filesystem_FTPext extends WP_Filesystem_Base {
-       var $link;
-       var $errors = null;
-       var $options = array();
-
-       function WP_Filesystem_FTPext($opt='') {
+       public $link;
+
+       /**
+        * @access public
+        *
+        * @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.
+               // 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);
@@ -45,9 +47,6 @@ 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']) )
                        $this->errors->add('empty_username', __('FTP username is required'));
@@ -64,23 +63,38 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
                        $this->options['ssl'] = true;
        }
 
-       function connect() {
+       /**
+        * @access public
+        *
+        * @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'], 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']));
+                       $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 ( ! @ftp_login($this->link,$this->options['username'], $this->options['password']) ) {
-                       $this->errors->add('auth', sprintf(__('Username/Password incorrect for %s'), $this->options['username']));
+               if ( ! @ftp_login( $this->link,$this->options['username'], $this->options['password'] ) ) {
+                       $this->errors->add( 'auth',
+                               /* translators: %s: username */
+                               sprintf( __( 'Username/Password incorrect for %s' ),
+                                       $this->options['username']
+                               )
+                       );
                        return false;
                }
 
-               //Set the Connection to use Passive FTP
+               // 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);
@@ -88,61 +102,122 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
                return true;
        }
 
-       function get_contents($file, $type = '', $resumepos = 0 ) {
-               if ( empty($type) )
-                       $type = FTP_BINARY;
-
-               $temp = tmpfile();
-               if ( ! $temp )
+       /**
+        * 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 couldn't be retrieved.
+        */
+       public function get_contents( $file ) {
+               $tempfile = wp_tempnam($file);
+               $temp = fopen($tempfile, 'w+');
+
+               if ( ! $temp ) {
+                       unlink( $tempfile );
                        return false;
-
-               if ( ! @ftp_fget($this->link, $temp, $file, $type, $resumepos) )
+               }
+               
+               if ( ! @ftp_fget( $this->link, $temp, $file, FTP_BINARY ) ) {
+                       fclose( $temp );
+                       unlink( $tempfile );
                        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) )
                        $contents .= fread($temp, 8192);
 
                fclose($temp);
+               unlink($tempfile);
                return $contents;
        }
-       function get_contents_array($file) {
+
+       /**
+        * @access public
+        *
+        * @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) )
-                       $type = $this->is_binary($contents) ? FTP_BINARY : FTP_ASCII;
 
-               $temp = tmpfile();
+       /**
+        * @access public
+        *
+        * @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
+               mbstring_binary_safe_encoding();
+
+               $data_length = strlen( $contents );
+               $bytes_written = fwrite( $temp, $contents );
 
-               $ret = @ftp_fput($this->link, $file, $temp, $type);
+               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() {
+
+       /**
+        * @access public
+        *
+        * @return string
+        */
+       public function cwd() {
                $cwd = @ftp_pwd($this->link);
                if ( $cwd )
                        $cwd = trailingslashit($cwd);
                return $cwd;
        }
-       function chdir($dir) {
+
+       /**
+        * @access public
+        *
+        * @param string $dir
+        * @return bool
+        */
+       public function chdir($dir) {
                return @ftp_chdir($this->link, $dir);
        }
-       function chgrp($file, $group, $recursive = false ) {
-               return false;
-       }
-       function chmod($file, $mode = false, $recursive = false) {
-               if ( ! $this->exists($file) && ! $this->is_dir($file) )
-                       return false;
 
+       /**
+        * @access public
+        *
+        * @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;
@@ -152,49 +227,93 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
                                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);
-               }
-               //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) {
+
+       /**
+        * @access public
+        *
+        * @param string $file
+        * @return string
+        */
+       public function owner($file) {
                $dir = $this->dirlist($file);
                return $dir[$file]['owner'];
        }
-       function getchmod($file) {
+       /**
+        * @access public
+        *
+        * @param string $file
+        * @return string
+        */
+       public function getchmod($file) {
                $dir = $this->dirlist($file);
                return $dir[$file]['permsn'];
        }
-       function group($file) {
+
+       /**
+        * @access public
+        *
+        * @param string $file
+        * @return string
+        */
+       public function group($file) {
                $dir = $this->dirlist($file);
                return $dir[$file]['group'];
        }
-       function copy($source, $destination, $overwrite = false ) {
+
+       /**
+        * @access public
+        *
+        * @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) {
+
+       /**
+        * @access public
+        *
+        * @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 ) {
+       /**
+        * @access public
+        *
+        * @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 ( $this->is_file($file) )
+               if ( 'f' == $type || $this->is_file($file) )
                        return @ftp_delete($this->link, $file);
                if ( !$recursive )
                        return @ftp_rmdir($this->link, $file);
@@ -202,18 +321,43 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
                $filelist = $this->dirlist( trailingslashit($file) );
                if ( !empty($filelist) )
                        foreach ( $filelist as $delete_file )
-                               $this->delete( trailingslashit($file) . $delete_file['name'], $recursive);
+                               $this->delete( trailingslashit($file) . $delete_file['name'], $recursive, $delete_file['type'] );
                return @ftp_rmdir($this->link, $file);
        }
 
-       function exists($file) {
+       /**
+        * @access public
+        *
+        * @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.
+               }
+
                return !empty($list); //empty list = no file, so invert.
        }
-       function is_file($file) {
+
+       /**
+        * @access public
+        *
+        * @param string $file
+        * @return bool
+        */
+       public function is_file($file) {
                return $this->exists($file) && !$this->is_dir($file);
        }
-       function is_dir($path) {
+
+       /**
+        * @access public
+        *
+        * @param string $path
+        * @return bool
+        */
+       public function is_dir($path) {
                $cwd = $this->cwd();
                $result = @ftp_chdir($this->link, trailingslashit($path) );
                if ( $result && $path == $this->cwd() || $this->cwd() != $cwd ) {
@@ -222,51 +366,117 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
                }
                return false;
        }
-       function is_readable($file) {
-               //Get dir list, Check if the file is readable by the current user??
+
+       /**
+        * @access public
+        *
+        * @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??
+
+       /**
+        * @access public
+        *
+        * @param string $file
+        * @return bool
+        */
+       public function is_writable($file) {
                return true;
        }
-       function atime($file) {
+
+       /**
+        * @access public
+        *
+        * @param string $file
+        * @return bool
+        */
+       public function atime($file) {
                return false;
        }
-       function mtime($file) {
+
+       /**
+        * @access public
+        *
+        * @param string $file
+        * @return int
+        */
+       public function mtime($file) {
                return ftp_mdtm($this->link, $file);
        }
-       function size($file) {
+
+       /**
+        * @access public
+        *
+        * @param string $file
+        * @return int
+        */
+       public function size($file) {
                return ftp_size($this->link, $file);
        }
-       function touch($file, $time = 0, $atime = 0) {
+
+       /**
+        * @access public
+        *
+        * @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) )
+
+       /**
+        * @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;
+
+               if ( !@ftp_mkdir($this->link, $path) )
                        return false;
-               if ( ! $chmod )
-                       $chmod = FS_CHMOD_DIR;
                $this->chmod($path, $chmod);
-               if ( $chown )
-                       $this->chown($path, $chown);
-               if ( $chgrp )
-                       $this->chgrp($path, $chgrp);
                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 parselisting($line) {
-               static $is_windows;
+       /**
+        * @access public
+        *
+        * @staticvar bool $is_windows
+        * @param string $line
+        * @return array
+        */
+       public function parselisting($line) {
+               static $is_windows = null;
                if ( is_null($is_windows) )
-                       $is_windows = strpos( strtolower(ftp_systype($this->link)), 'win') !== false;
+                       $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) ) {
+               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
@@ -277,16 +487,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'] )
@@ -294,19 +505,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];
@@ -315,15 +527,28 @@ 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 ( isset( $b['islink'] ) && $b['islink'] ) {
+                       $b['name'] = preg_replace( '/(\s*->\s*.*)$/', '', $b['name'] );
+               }
+
                return $b;
        }
 
-       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) . '/';
@@ -331,9 +556,13 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
                        $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();
@@ -354,9 +583,6 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
                        $dirlist[ $entry['name'] ] = $entry;
                }
 
-               if ( ! $dirlist )
-                       return false;
-
                $ret = array();
                foreach ( (array)$dirlist as $struc ) {
                        if ( 'd' == $struc['type'] ) {
@@ -371,10 +597,11 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
                return $ret;
        }
 
-       function __destruct() {
+       /**
+        * @access public
+        */
+       public function __destruct() {
                if ( $this->link )
                        ftp_close($this->link);
        }
 }
-
-?>