/**
* WordPress Filesystem Class for implementing FTP Sockets.
*
- * @since 2.5
+ * @since 2.5.0
* @package WordPress
* @subpackage Filesystem
* @uses WP_Filesystem_Base Extends class
*/
class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
- var $ftp = false;
- var $timeout = 5;
- var $errors;
- var $options = array();
-
- var $permission = null;
-
- function WP_Filesystem_ftpsockets($opt = '') {
+ /**
+ * @access public
+ * @var ftp
+ */
+ public $ftp;
+
+ /**
+ * @access public
+ *
+ * @param array $opt
+ */
+ public function __construct( $opt = '' ) {
$this->method = 'ftpsockets';
$this->errors = new WP_Error();
- //Check if possible to use ftp functions.
- if( ! @include_once ABSPATH . 'wp-admin/includes/class-ftp.php' )
- return false;
+ // Check if possible to use ftp functions.
+ if ( ! @include_once( ABSPATH . 'wp-admin/includes/class-ftp.php' ) ) {
+ return;
+ }
$this->ftp = new ftp();
- //Set defaults:
if ( empty($opt['port']) )
$this->options['port'] = 21;
else
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'));
$this->options['password'] = $opt['password'];
}
- function connect() {
+ /**
+ * @access public
+ *
+ * @return bool
+ */
+ public function connect() {
if ( ! $this->ftp )
return false;
- //$this->ftp->Verbose = true;
+ $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;
}
- $this->ftp->SetType(FTP_AUTOASCII);
- $this->ftp->Passive(true);
+ $this->ftp->SetType( FTP_BINARY );
+ $this->ftp->Passive( true );
+ $this->ftp->setTimeout( FS_TIMEOUT );
return true;
}
- function setDefaultPermissions($perm) {
- $this->permission = $perm;
- }
-
- function get_contents($file, $type = '', $resumepos = 0) {
- if( ! $this->exists($file) )
+ /**
+ * 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) )
return false;
- if( empty($type) )
- $type = FTP_AUTOASCII;
- $this->ftp->SetType($type);
-
$temp = wp_tempnam( $file );
if ( ! $temphandle = fopen($temp, 'w+') )
return false;
+ mbstring_binary_safe_encoding();
+
if ( ! $this->ftp->fget($temphandle, $file) ) {
fclose($temphandle);
unlink($temp);
- return ''; //Blank document, File does exist, Its just blank.
+
+ reset_mbstring_encoding();
+
+ return ''; // Blank document, File does exist, It's just blank.
}
- fseek($temphandle, 0); //Skip back to the start of the file being written to
+ reset_mbstring_encoding();
+
+ fseek( $temphandle, 0 ); // Skip back to the start of the file being written to
$contents = '';
while ( ! feof($temphandle) )
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;
-
- $this->ftp->SetType($type);
-
+ /**
+ * @access public
+ *
+ * @param string $file
+ * @param string $contents
+ * @param int|bool $mode
+ * @return bool
+ */
+ public function put_contents($file, $contents, $mode = false ) {
$temp = wp_tempnam( $file );
- if ( ! $temphandle = fopen($temp, 'w+') ){
+ if ( ! $temphandle = @fopen($temp, 'w+') ) {
unlink($temp);
return false;
}
- fwrite($temphandle, $contents);
- fseek($temphandle, 0); //Skip back to the start of the file being written to
+ // The FTP class uses string functions internally during file download/upload
+ mbstring_binary_safe_encoding();
+
+ $bytes_written = fwrite( $temphandle, $contents );
+ if ( false === $bytes_written || $bytes_written != strlen( $contents ) ) {
+ fclose( $temphandle );
+ unlink( $temp );
+
+ reset_mbstring_encoding();
+
+ return false;
+ }
+
+ fseek( $temphandle, 0 ); // Skip back to the start of the file being written to
$ret = $this->ftp->fput($file, $temphandle);
+ reset_mbstring_encoding();
+
fclose($temphandle);
unlink($temp);
+
+ $this->chmod($file, $mode);
+
return $ret;
}
- function cwd() {
+ /**
+ * @access public
+ *
+ * @return string
+ */
+ public function cwd() {
$cwd = $this->ftp->pwd();
- if( $cwd )
+ if ( $cwd )
$cwd = trailingslashit($cwd);
return $cwd;
}
- function chdir($file) {
+ /**
+ * @access public
+ *
+ * @param string $file
+ * @return bool
+ */
+ public function chdir($file) {
return $this->ftp->chdir($file);
}
- function chgrp($file, $group, $recursive = false ) {
- return false;
- }
-
- 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) ) {
- return $this->ftp->chmod($file,$mode);
+ /**
+ * @access public
+ *
+ * @param string $file
+ * @param int|bool $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
+ return $this->ftp->chmod($file, $mode);
}
- 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 ) {
- if( ! $overwrite && $this->exists($destination) )
+ /**
+ * @access public
+ *
+ * @param string $source
+ * @param string $destination
+ * @param bool $overwrite
+ * @param int|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 )
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 $this->ftp->rename($source, $destination);
}
- function delete($file, $recursive = false ) {
- if ( $this->is_file($file) )
+ /**
+ * @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 ( 'f' == $type || $this->is_file($file) )
return $this->ftp->delete($file);
if ( !$recursive )
return $this->ftp->rmdir($file);
return $this->ftp->mdel($file);
}
- function exists($file) {
- return $this->ftp->is_exists($file);
+ /**
+ * @access public
+ *
+ * @param string $file
+ * @return bool
+ */
+ public function exists( $file ) {
+ $list = $this->ftp->nlist( $file );
+
+ if ( empty( $list ) && $this->is_dir( $file ) ) {
+ return true; // File is an empty directory.
+ }
+
+ return !empty( $list ); //empty list = no file, so invert.
+ // Return $this->ftp->is_exists($file); has issues with ABOR+426 responses on the ncFTPd server.
}
- function is_file($file) {
- return $this->is_dir($file) ? false : true;
+ /**
+ * @access public
+ *
+ * @param string $file
+ * @return bool
+ */
+ public function is_file($file) {
+ if ( $this->is_dir($file) )
+ return false;
+ if ( $this->exists($file) )
+ return true;
+ return false;
}
- function is_dir($path) {
+ /**
+ * @access public
+ *
+ * @param string $path
+ * @return bool
+ */
+ public function is_dir($path) {
$cwd = $this->cwd();
if ( $this->chdir($path) ) {
$this->chdir($cwd);
return false;
}
- function is_readable($file) {
- //Get dir list, Check if the file is writable 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 $this->ftp->mdtm($file);
}
- function size($file) {
+ /**
+ * @param string $file
+ * @return int
+ */
+ public function size($file) {
return $this->ftp->filesize($file);
}
- function touch($file, $time = 0, $atime = 0 ) {
+ /**
+ * @access public
+ *
+ * @param string $file
+ * @param int $time
+ * @param int $atime
+ * @return bool
+ */
+ public function touch($file, $time = 0, $atime = 0 ) {
return false;
}
- function mkdir($path, $chmod = false, $chown = false, $chgrp = false ) {
- if( ! $this->ftp->mkdir($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( $chmod )
- $this->chmod($path, $chmod);
- if( $chown )
- $this->chown($path, $chown);
- if( $chgrp )
- $this->chgrp($path, $chgrp);
+
+ if ( ! $this->ftp->mkdir($path) )
+ return false;
+ if ( ! $chmod )
+ $chmod = FS_CHMOD_DIR;
+ $this->chmod($path, $chmod);
return true;
}
- function rmdir($path, $recursive = false ) {
- if( ! $recursive )
- return $this->ftp->rmdir($path);
-
- return $this->ftp->mdel($path);
+ /**
+ * @access public
+ *
+ * @param string $path
+ * @param bool $recursive
+ */
+ public function rmdir($path, $recursive = false ) {
+ $this->delete($path, $recursive);
}
- function dirlist($path = '.', $incdot = false, $recursive = false ) {
- if( $this->is_file($path) ) {
- $limitFile = basename($path);
+ /**
+ * @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) . '/';
} else {
- $limitFile = false;
+ $limit_file = false;
}
+ mbstring_binary_safe_encoding();
+
$list = $this->ftp->dirlist($path);
- if( ! $list )
+ if ( empty( $list ) && ! $this->exists( $path ) ) {
+
+ reset_mbstring_encoding();
+
return false;
- if( empty($list) )
- return array();
+ }
$ret = array();
foreach ( $list as $struc ) {
+ if ( '.' == $struc['name'] || '..' == $struc['name'] )
+ continue;
+
+ if ( ! $include_hidden && '.' == $struc['name'][0] )
+ continue;
+
+ if ( $limit_file && $struc['name'] != $limit_file )
+ continue;
+
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;
+
+ // Replace symlinks formatted as "source -> target" with just the source name
+ if ( $struc['islink'] )
+ $struc['name'] = preg_replace( '/(\s*->\s*.*)$/', '', $struc['name'] );
+
+ // Add the Octal representation of the file permissions
+ $struc['permsn'] = $this->getnumchmodfromh( $struc['perms'] );
+
+ $ret[ $struc['name'] ] = $struc;
}
+
+ reset_mbstring_encoding();
+
return $ret;
}
- function __destruct() {
+ /**
+ * @access public
+ */
+ public function __destruct() {
$this->ftp->quit();
}
}
-
-?>
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff