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 {
21 var $options = array();
23 var $permission = null;
25 function WP_Filesystem_FTPext($opt='') {
26 $this->method = 'ftpext';
27 $this->errors = new WP_Error();
29 //Check if possible to use ftp functions.
30 if ( ! extension_loaded('ftp') ) {
31 $this->errors->add('no_ftp_ext', __('The ftp PHP extension is not available'));
36 if ( empty($opt['port']) )
37 $this->options['port'] = 21;
39 $this->options['port'] = $opt['port'];
41 if ( empty($opt['hostname']) )
42 $this->errors->add('empty_hostname', __('FTP hostname is required'));
44 $this->options['hostname'] = $opt['hostname'];
46 if ( isset($opt['base']) && ! empty($opt['base']) )
47 $this->wp_base = $opt['base'];
49 // Check if the options provided are OK.
50 if ( empty($opt['username']) )
51 $this->errors->add('empty_username', __('FTP username is required'));
53 $this->options['username'] = $opt['username'];
55 if ( empty($opt['password']) )
56 $this->errors->add('empty_password', __('FTP password is required'));
58 $this->options['password'] = $opt['password'];
60 $this->options['ssl'] = false;
61 if ( isset($opt['connection_type']) && 'ftps' == $opt['connection_type'] )
62 $this->options['ssl'] = true;
66 if ( isset($this->options['ssl']) && $this->options['ssl'] && function_exists('ftp_ssl_connect') )
67 $this->link = @ftp_ssl_connect($this->options['hostname'], $this->options['port'], $this->timeout);
69 $this->link = @ftp_connect($this->options['hostname'], $this->options['port'], $this->timeout);
71 if ( ! $this->link ) {
72 $this->errors->add('connect', sprintf(__('Failed to connect to FTP Server %1$s:%2$s'), $this->options['hostname'], $this->options['port']));
76 if ( ! @ftp_login($this->link,$this->options['username'], $this->options['password']) ) {
77 $this->errors->add('auth', sprintf(__('Username/Password incorrect for %s'), $this->options['username']));
81 //Set the Connection to use Passive FTP
82 @ftp_pasv( $this->link, true );
87 function setDefaultPermissions($perm) {
88 $this->permission = $perm;
91 function get_contents($file, $type = '', $resumepos = 0 ){
99 if( ! @ftp_fget($this->link, $temp, $file, $type, $resumepos) )
102 fseek($temp, 0); //Skip back to the start of the file being written to
105 while ( ! feof($temp) )
106 $contents .= fread($temp, 8192);
111 function get_contents_array($file) {
112 return explode("\n", $this->get_contents($file));
114 function put_contents($file, $contents, $type = '' ) {
116 $type = $this->is_binary($contents) ? FTP_BINARY : FTP_ASCII;
122 fwrite($temp, $contents);
123 fseek($temp, 0); //Skip back to the start of the file being written to
125 $ret = @ftp_fput($this->link, $file, $temp, $type);
131 $cwd = @ftp_pwd($this->link);
133 $cwd = trailingslashit($cwd);
136 function chdir($dir) {
137 return @ftp_chdir($dir);
139 function chgrp($file, $group, $recursive = false ) {
142 function chmod($file, $mode = false, $recursive = false) {
144 $mode = $this->permission;
147 if ( ! $this->exists($file) && ! $this->is_dir($file) )
149 if ( ! $recursive || ! $this->is_dir($file) ) {
150 if ( ! function_exists('ftp_chmod') )
151 return @ftp_site($this->link, sprintf('CHMOD %o %s', $mode, $file));
152 return @ftp_chmod($this->link, $mode, $file);
154 //Is a directory, and we want recursive
155 $filelist = $this->dirlist($file);
156 foreach($filelist as $filename){
157 $this->chmod($file . '/' . $filename, $mode, $recursive);
161 function chown($file, $owner, $recursive = false ) {
164 function owner($file) {
165 $dir = $this->dirlist($file);
166 return $dir[$file]['owner'];
168 function getchmod($file) {
169 $dir = $this->dirlist($file);
170 return $dir[$file]['permsn'];
172 function group($file) {
173 $dir = $this->dirlist($file);
174 return $dir[$file]['group'];
176 function copy($source, $destination, $overwrite = false ) {
177 if( ! $overwrite && $this->exists($destination) )
179 $content = $this->get_contents($source);
180 if( false === $content)
182 return $this->put_contents($destination, $content);
184 function move($source, $destination, $overwrite = false) {
185 return ftp_rename($this->link, $source, $destination);
188 function delete($file, $recursive = false ) {
191 if ( $this->is_file($file) )
192 return @ftp_delete($this->link, $file);
194 return @ftp_rmdir($this->link, $file);
196 $filelist = $this->dirlist( trailingslashit($file) );
197 if ( !empty($filelist) )
198 foreach ( $filelist as $delete_file )
199 $this->delete( trailingslashit($file) . $delete_file['name'], $recursive);
200 return @ftp_rmdir($this->link, $file);
203 function exists($file) {
204 $list = @ftp_rawlist($this->link, $file, false);
205 return !empty($list); //empty list = no file, so invert.
207 function is_file($file) {
208 return $this->exists($file) && !$this->is_dir($file);
210 function is_dir($path) {
212 $result = @ftp_chdir($this->link, trailingslashit($path) );
213 if( $result && $path == $this->cwd() || $this->cwd() != $cwd ) {
214 @ftp_chdir($this->link, $cwd);
219 function is_readable($file) {
220 //Get dir list, Check if the file is readable by the current user??
223 function is_writable($file) {
224 //Get dir list, Check if the file is writable by the current user??
227 function atime($file) {
230 function mtime($file) {
231 return ftp_mdtm($this->link, $file);
233 function size($file) {
234 return ftp_size($this->link, $file);
236 function touch($file, $time = 0, $atime = 0) {
239 function mkdir($path, $chmod = false, $chown = false, $chgrp = false) {
240 if( !ftp_mkdir($this->link, $path) )
243 $this->chmod($path, $chmod);
245 $this->chown($path, $chown);
247 $this->chgrp($path, $chgrp);
250 function rmdir($path, $recursive = false) {
251 return $this->delete($path, $recursive);
254 function parselisting($line) {
256 if ( is_null($is_windows) )
257 $is_windows = strpos( strtolower(ftp_systype($this->link)), 'win') !== false;
259 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)) {
261 if ($lucifer[3]<70) { $lucifer[3] +=2000; } else { $lucifer[3]+=1900; } // 4digit year fix
262 $b['isdir'] = ($lucifer[7]=="<DIR>");
267 $b['size'] = $lucifer[7];
268 $b['month'] = $lucifer[1];
269 $b['day'] = $lucifer[2];
270 $b['year'] = $lucifer[3];
271 $b['hour'] = $lucifer[4];
272 $b['minute'] = $lucifer[5];
273 $b['time'] = @mktime($lucifer[4]+(strcasecmp($lucifer[6],"PM")==0?12:0),$lucifer[5],0,$lucifer[1],$lucifer[2],$lucifer[3]);
274 $b['am/pm'] = $lucifer[6];
275 $b['name'] = $lucifer[8];
276 } else if (!$is_windows && $lucifer=preg_split("/[ ]/",$line,9,PREG_SPLIT_NO_EMPTY)) {
278 $lcount=count($lucifer);
279 if ($lcount<8) return '';
281 $b['isdir'] = $lucifer[0]{0} === "d";
282 $b['islink'] = $lucifer[0]{0} === "l";
285 elseif ( $b['islink'] )
289 $b['perms'] = $lucifer[0];
290 $b['number'] = $lucifer[1];
291 $b['owner'] = $lucifer[2];
292 $b['group'] = $lucifer[3];
293 $b['size'] = $lucifer[4];
295 sscanf($lucifer[5],"%d-%d-%d",$b['year'],$b['month'],$b['day']);
296 sscanf($lucifer[6],"%d:%d",$b['hour'],$b['minute']);
297 $b['time'] = @mktime($b['hour'],$b['minute'],0,$b['month'],$b['day'],$b['year']);
298 $b['name'] = $lucifer[7];
300 $b['month'] = $lucifer[5];
301 $b['day'] = $lucifer[6];
302 if (preg_match("/([0-9]{2}):([0-9]{2})/",$lucifer[7],$l2)) {
303 $b['year'] = date("Y");
305 $b['minute'] = $l2[2];
307 $b['year'] = $lucifer[7];
311 $b['time'] = strtotime(sprintf("%d %s %d %02d:%02d",$b['day'],$b['month'],$b['year'],$b['hour'],$b['minute']));
312 $b['name'] = $lucifer[8];
319 function dirlist($path = '.', $incdot = false, $recursive = false) {
320 if( $this->is_file($path) ) {
321 $limitFile = basename($path);
322 $path = dirname($path) . '/';
327 $list = @ftp_rawlist($this->link, '-a ' . $path, false);
329 if ( $list === false )
333 foreach ( $list as $k => $v ) {
334 $entry = $this->parselisting($v);
338 if ( '.' == $entry["name"] || '..' == $entry["name"] )
341 $dirlist[ $entry['name'] ] = $entry;
346 if ( empty($dirlist) )
350 foreach ( $dirlist as $struc ) {
352 if ( 'd' == $struc['type'] ) {
353 $struc['files'] = array();
356 //We're including the doted starts
357 if( '.' != $struc['name'] && '..' != $struc['name'] ){ //Ok, It isnt a special folder
359 $struc['files'] = $this->dirlist($path . '/' . $struc['name'], $incdot, $recursive);
363 $struc['files'] = $this->dirlist($path . '/' . $struc['name'], $incdot, $recursive);
367 $ret[$struc['name']] = $struc;
372 function __destruct(){
374 ftp_close($this->link);