3 * WordPress FTP Filesystem.
6 * @subpackage Filesystem
10 * WordPress Filesystem Class for implementing FTP.
14 * @subpackage Filesystem
15 * @uses WP_Filesystem_Base Extends class
17 class WP_Filesystem_FTPext extends WP_Filesystem_Base {
20 var $options = array();
22 function __construct($opt='') {
23 $this->method = 'ftpext';
24 $this->errors = new WP_Error();
26 //Check if possible to use ftp functions.
27 if ( ! extension_loaded('ftp') ) {
28 $this->errors->add('no_ftp_ext', __('The ftp PHP extension is not available'));
33 //This Class uses the timeout on a per-connection basis, Others use it on a per-action basis.
35 if ( ! defined('FS_TIMEOUT') )
36 define('FS_TIMEOUT', 240);
38 if ( empty($opt['port']) )
39 $this->options['port'] = 21;
41 $this->options['port'] = $opt['port'];
43 if ( empty($opt['hostname']) )
44 $this->errors->add('empty_hostname', __('FTP hostname is required'));
46 $this->options['hostname'] = $opt['hostname'];
48 if ( ! empty($opt['base']) )
49 $this->wp_base = $opt['base'];
51 // Check if the options provided are OK.
52 if ( empty($opt['username']) )
53 $this->errors->add('empty_username', __('FTP username is required'));
55 $this->options['username'] = $opt['username'];
57 if ( empty($opt['password']) )
58 $this->errors->add('empty_password', __('FTP password is required'));
60 $this->options['password'] = $opt['password'];
62 $this->options['ssl'] = false;
63 if ( isset($opt['connection_type']) && 'ftps' == $opt['connection_type'] )
64 $this->options['ssl'] = true;
68 if ( isset($this->options['ssl']) && $this->options['ssl'] && function_exists('ftp_ssl_connect') )
69 $this->link = @ftp_ssl_connect($this->options['hostname'], $this->options['port'], FS_CONNECT_TIMEOUT);
71 $this->link = @ftp_connect($this->options['hostname'], $this->options['port'], FS_CONNECT_TIMEOUT);
73 if ( ! $this->link ) {
74 $this->errors->add('connect', sprintf(__('Failed to connect to FTP Server %1$s:%2$s'), $this->options['hostname'], $this->options['port']));
78 if ( ! @ftp_login($this->link,$this->options['username'], $this->options['password']) ) {
79 $this->errors->add('auth', sprintf(__('Username/Password incorrect for %s'), $this->options['username']));
83 //Set the Connection to use Passive FTP
84 @ftp_pasv( $this->link, true );
85 if ( @ftp_get_option($this->link, FTP_TIMEOUT_SEC) < FS_TIMEOUT )
86 @ftp_set_option($this->link, FTP_TIMEOUT_SEC, FS_TIMEOUT);
91 function get_contents($file, $type = '', $resumepos = 0 ) {
95 $tempfile = wp_tempnam($file);
96 $temp = fopen($tempfile, 'w+');
101 if ( ! @ftp_fget($this->link, $temp, $file, $type, $resumepos) )
104 fseek($temp, 0); //Skip back to the start of the file being written to
107 while ( ! feof($temp) )
108 $contents .= fread($temp, 8192);
114 function get_contents_array($file) {
115 return explode("\n", $this->get_contents($file));
118 function put_contents($file, $contents, $mode = false ) {
119 $tempfile = wp_tempnam($file);
120 $temp = fopen($tempfile, 'w+');
124 fwrite($temp, $contents);
125 fseek($temp, 0); //Skip back to the start of the file being written to
127 $type = $this->is_binary($contents) ? FTP_BINARY : FTP_ASCII;
128 $ret = @ftp_fput($this->link, $file, $temp, $type);
133 $this->chmod($file, $mode);
138 $cwd = @ftp_pwd($this->link);
140 $cwd = trailingslashit($cwd);
143 function chdir($dir) {
144 return @ftp_chdir($this->link, $dir);
146 function chgrp($file, $group, $recursive = false ) {
149 function chmod($file, $mode = false, $recursive = false) {
151 if ( $this->is_file($file) )
152 $mode = FS_CHMOD_FILE;
153 elseif ( $this->is_dir($file) )
154 $mode = FS_CHMOD_DIR;
159 // chmod any sub-objects if recursive.
160 if ( $recursive && $this->is_dir($file) ) {
161 $filelist = $this->dirlist($file);
162 foreach ( (array)$filelist as $filename => $filemeta )
163 $this->chmod($file . '/' . $filename, $mode, $recursive);
166 // chmod the file or directory
167 if ( ! function_exists('ftp_chmod') )
168 return (bool)@ftp_site($this->link, sprintf('CHMOD %o %s', $mode, $file));
169 return (bool)@ftp_chmod($this->link, $mode, $file);
171 function chown($file, $owner, $recursive = false ) {
174 function owner($file) {
175 $dir = $this->dirlist($file);
176 return $dir[$file]['owner'];
178 function getchmod($file) {
179 $dir = $this->dirlist($file);
180 return $dir[$file]['permsn'];
182 function group($file) {
183 $dir = $this->dirlist($file);
184 return $dir[$file]['group'];
186 function copy($source, $destination, $overwrite = false, $mode = false) {
187 if ( ! $overwrite && $this->exists($destination) )
189 $content = $this->get_contents($source);
190 if ( false === $content)
192 return $this->put_contents($destination, $content, $mode);
194 function move($source, $destination, $overwrite = false) {
195 return ftp_rename($this->link, $source, $destination);
198 function delete($file, $recursive = false, $type = false) {
201 if ( 'f' == $type || $this->is_file($file) )
202 return @ftp_delete($this->link, $file);
204 return @ftp_rmdir($this->link, $file);
206 $filelist = $this->dirlist( trailingslashit($file) );
207 if ( !empty($filelist) )
208 foreach ( $filelist as $delete_file )
209 $this->delete( trailingslashit($file) . $delete_file['name'], $recursive, $delete_file['type'] );
210 return @ftp_rmdir($this->link, $file);
213 function exists($file) {
214 $list = @ftp_nlist($this->link, $file);
215 return !empty($list); //empty list = no file, so invert.
217 function is_file($file) {
218 return $this->exists($file) && !$this->is_dir($file);
220 function is_dir($path) {
222 $result = @ftp_chdir($this->link, trailingslashit($path) );
223 if ( $result && $path == $this->cwd() || $this->cwd() != $cwd ) {
224 @ftp_chdir($this->link, $cwd);
229 function is_readable($file) {
230 //Get dir list, Check if the file is readable by the current user??
233 function is_writable($file) {
234 //Get dir list, Check if the file is writable by the current user??
237 function atime($file) {
240 function mtime($file) {
241 return ftp_mdtm($this->link, $file);
243 function size($file) {
244 return ftp_size($this->link, $file);
246 function touch($file, $time = 0, $atime = 0) {
249 function mkdir($path, $chmod = false, $chown = false, $chgrp = false) {
250 $path = untrailingslashit($path);
254 if ( !@ftp_mkdir($this->link, $path) )
256 $this->chmod($path, $chmod);
258 $this->chown($path, $chown);
260 $this->chgrp($path, $chgrp);
263 function rmdir($path, $recursive = false) {
264 return $this->delete($path, $recursive);
267 function parselisting($line) {
269 if ( is_null($is_windows) )
270 $is_windows = stripos( ftp_systype($this->link), 'win') !== false;
272 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) ) {
274 if ( $lucifer[3] < 70 )
277 $lucifer[3] += 1900; // 4digit year fix
278 $b['isdir'] = ( $lucifer[7] == '<DIR>');
283 $b['size'] = $lucifer[7];
284 $b['month'] = $lucifer[1];
285 $b['day'] = $lucifer[2];
286 $b['year'] = $lucifer[3];
287 $b['hour'] = $lucifer[4];
288 $b['minute'] = $lucifer[5];
289 $b['time'] = @mktime($lucifer[4] + (strcasecmp($lucifer[6], "PM") == 0 ? 12 : 0), $lucifer[5], 0, $lucifer[1], $lucifer[2], $lucifer[3]);
290 $b['am/pm'] = $lucifer[6];
291 $b['name'] = $lucifer[8];
292 } elseif ( !$is_windows && $lucifer = preg_split('/[ ]/', $line, 9, PREG_SPLIT_NO_EMPTY)) {
294 $lcount = count($lucifer);
298 $b['isdir'] = $lucifer[0]{0} === 'd';
299 $b['islink'] = $lucifer[0]{0} === 'l';
302 elseif ( $b['islink'] )
306 $b['perms'] = $lucifer[0];
307 $b['number'] = $lucifer[1];
308 $b['owner'] = $lucifer[2];
309 $b['group'] = $lucifer[3];
310 $b['size'] = $lucifer[4];
311 if ( $lcount == 8 ) {
312 sscanf($lucifer[5], '%d-%d-%d', $b['year'], $b['month'], $b['day']);
313 sscanf($lucifer[6], '%d:%d', $b['hour'], $b['minute']);
314 $b['time'] = @mktime($b['hour'], $b['minute'], 0, $b['month'], $b['day'], $b['year']);
315 $b['name'] = $lucifer[7];
317 $b['month'] = $lucifer[5];
318 $b['day'] = $lucifer[6];
319 if ( preg_match('/([0-9]{2}):([0-9]{2})/', $lucifer[7], $l2) ) {
320 $b['year'] = date("Y");
322 $b['minute'] = $l2[2];
324 $b['year'] = $lucifer[7];
328 $b['time'] = strtotime( sprintf('%d %s %d %02d:%02d', $b['day'], $b['month'], $b['year'], $b['hour'], $b['minute']) );
329 $b['name'] = $lucifer[8];
336 function dirlist($path = '.', $include_hidden = true, $recursive = false) {
337 if ( $this->is_file($path) ) {
338 $limit_file = basename($path);
339 $path = dirname($path) . '/';
344 $pwd = @ftp_pwd($this->link);
345 if ( ! @ftp_chdir($this->link, $path) ) // Cant change to folder = folder doesn't exist
347 $list = @ftp_rawlist($this->link, '-a', false);
348 @ftp_chdir($this->link, $pwd);
350 if ( empty($list) ) // Empty array = non-existent folder (real folder will show . at least)
354 foreach ( $list as $k => $v ) {
355 $entry = $this->parselisting($v);
359 if ( '.' == $entry['name'] || '..' == $entry['name'] )
362 if ( ! $include_hidden && '.' == $entry['name'][0] )
365 if ( $limit_file && $entry['name'] != $limit_file)
368 $dirlist[ $entry['name'] ] = $entry;
372 foreach ( (array)$dirlist as $struc ) {
373 if ( 'd' == $struc['type'] ) {
375 $struc['files'] = $this->dirlist($path . '/' . $struc['name'], $include_hidden, $recursive);
377 $struc['files'] = array();
380 $ret[ $struc['name'] ] = $struc;
385 function __destruct() {
387 ftp_close($this->link);