<?php
/**
- * WordPress SSH2 Filesystem.
- *
- * @package WordPress
- * @subpackage Filesystem
- */
-
-/**
- * WordPress Filesystem Class for implementing SSH2.
+ * WordPress Filesystem Class for implementing SSH2
*
* To use this class you must follow these steps for PHP 5.2.6+
*
* @contrib http://kevin.vanzonneveld.net/techblog/article/make_ssh_connections_with_php/ - Installation Notes
*
- * Complie libssh2 (Note: Only 0.14 is officaly working with PHP 5.2.6+ right now.)
+ * Complie libssh2 (Note: Only 0.14 is officaly working with PHP 5.2.6+ right now, But many users have found the latest versions work)
*
* cd /usr/src
* wget http://surfnet.dl.sourceforge.net/sourceforge/libssh2/libssh2-0.14.tar.gz
* ./configure
* make all install
*
- * Note: No not leave the directory yet!
+ * Note: Do not leave the directory yet!
*
* Enter: pecl install -f ssh2
*
* Restart Apache!
* Check phpinfo() streams to confirm that: ssh2.shell, ssh2.exec, ssh2.tunnel, ssh2.scp, ssh2.sftp exist.
*
+ * Note: as of WordPress 2.8, This utilises the PHP5+ function 'stream_get_contents'
+ *
+ * @since 2.7.0
*
- * @since 2.7
* @package WordPress
* @subpackage Filesystem
- * @uses WP_Filesystem_Base Extends class
*/
class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
var $link = false;
var $sftp_link = false;
var $keys = false;
- /*
- * This is the timeout value for ssh results to comeback.
- * Slower servers might need this incressed, but this number otherwise should not change.
- *
- * @parm $timeout int
- *
- */
- var $timeout = 15;
var $errors = array();
var $options = array();
- var $permission = 0644;
-
- function WP_Filesystem_SSH2($opt='') {
+ function __construct($opt='') {
$this->method = 'ssh2';
$this->errors = new WP_Error();
$this->errors->add('no_ssh2_ext', __('The ssh2 PHP extension is not available'));
return false;
}
- if ( ! version_compare(phpversion(), '5', '>=') ) {
- $this->errors->add('ssh2_php_requirement', __('The ssh2 PHP extension is available, however requires PHP 5+'));
+ if ( !function_exists('stream_get_contents') ) {
+ $this->errors->add('ssh2_php_requirement', __('The ssh2 PHP extension is available, however, we require the PHP5 function <code>stream_get_contents()</code>'));
return false;
}
else
$this->options['hostname'] = $opt['hostname'];
- if ( isset($opt['base']) && ! empty($opt['base']) )
+ if ( ! empty($opt['base']) )
$this->wp_base = $opt['base'];
// Check if the options provided are OK.
$this->options['username'] = $opt['username'];
if ( empty ($opt['password']) ) {
- if ( !$this->keys ) // password can be blank if we are using keys
+ if ( !$this->keys ) //password can be blank if we are using keys
$this->errors->add('empty_password', __('SSH2 password is required'));
} else {
$this->options['password'] = $opt['password'];
}
} else {
if ( ! @ssh2_auth_pubkey_file($this->link, $this->options['username'], $this->options['public_key'], $this->options['private_key'], $this->options['password'] ) ) {
- $this->errors->add('auth', sprintf(__('Public and Private keys incorrent for %s'), $this->options['username']));
+ $this->errors->add('auth', sprintf(__('Public and Private keys incorrect for %s'), $this->options['username']));
return false;
}
}
$this->errors->add('command', sprintf(__('Unable to perform command: %s'), $command));
} else {
stream_set_blocking( $stream, true );
- stream_set_timeout( $stream, $this->timeout );
- $data = stream_get_contents($stream);
+ stream_set_timeout( $stream, FS_TIMEOUT );
+ $data = stream_get_contents( $stream );
+ fclose( $stream );
if ( $returnbool )
- return '' != trim($data);
+ return ( $data === false ) ? false : '' != trim($data);
else
return $data;
}
return false;
}
- function setDefaultPermissions($perm) {
- $this->debug("setDefaultPermissions();");
- if ( $perm )
- $this->permission = $perm;
- }
-
- function get_contents($file, $type = '', $resumepos = 0 ) {
+ function get_contents( $file ) {
$file = ltrim($file, '/');
- return file_get_contents('ssh2.sftp://' . $this->sftp_link .'/' . $file);
+ return file_get_contents('ssh2.sftp://' . $this->sftp_link . '/' . $file);
}
function get_contents_array($file) {
$file = ltrim($file, '/');
- return file('ssh2.sftp://' . $this->sftp_link .'/' . $file);
+ return file('ssh2.sftp://' . $this->sftp_link . '/' . $file);
}
- function put_contents($file, $contents, $type = '' ) {
- $file = ltrim($file, '/');
- return file_put_contents('ssh2.sftp://' . $this->sftp_link .'/' . $file, $contents);
+ function put_contents($file, $contents, $mode = false ) {
+ $ret = file_put_contents( 'ssh2.sftp://' . $this->sftp_link . '/' . ltrim( $file, '/' ), $contents );
+
+ if ( $ret !== strlen( $contents ) )
+ return false;
+
+ $this->chmod($file, $mode);
+
+ return true;
}
function cwd() {
$cwd = $this->run_command('pwd');
- if( $cwd )
+ if ( $cwd )
$cwd = trailingslashit($cwd);
return $cwd;
}
if ( ! $this->exists($file) )
return false;
if ( ! $recursive || ! $this->is_dir($file) )
- return $this->run_command(sprintf('chgrp %o %s', $mode, escapeshellarg($file)), true);
- return $this->run_command(sprintf('chgrp -R %o %s', $mode, escapeshellarg($file)), true);
+ return $this->run_command(sprintf('chgrp %s %s', escapeshellarg($group), escapeshellarg($file)), true);
+ return $this->run_command(sprintf('chgrp -R %s %s', escapeshellarg($group), escapeshellarg($file)), true);
}
function chmod($file, $mode = false, $recursive = false) {
- if( ! $mode )
- $mode = $this->permission;
- if( ! $mode )
- return false;
if ( ! $this->exists($file) )
return false;
+
+ if ( ! $mode ) {
+ if ( $this->is_file($file) )
+ $mode = FS_CHMOD_FILE;
+ elseif ( $this->is_dir($file) )
+ $mode = FS_CHMOD_DIR;
+ else
+ return false;
+ }
+
if ( ! $recursive || ! $this->is_dir($file) )
return $this->run_command(sprintf('chmod %o %s', $mode, escapeshellarg($file)), true);
return $this->run_command(sprintf('chmod -R %o %s', $mode, escapeshellarg($file)), true);
}
- function chown($file, $owner, $recursive = false ) {
+ /**
+ * Change the ownership of a file / folder.
+ *
+ * @since Unknown
+ *
+ * @param string $file Path to the file.
+ * @param mixed $owner A user name or number.
+ * @param bool $recursive Optional. If set True changes file owner recursivly. Defaults to False.
+ * @return bool Returns true on success or false on failure.
+ */
+ function chown( $file, $owner, $recursive = false ) {
if ( ! $this->exists($file) )
return false;
if ( ! $recursive || ! $this->is_dir($file) )
- return $this->run_command(sprintf('chown %o %s', $mode, escapeshellarg($file)), true);
- return $this->run_command(sprintf('chown -R %o %s', $mode, escapeshellarg($file)), true);
+ return $this->run_command(sprintf('chown %s %s', escapeshellarg($owner), escapeshellarg($file)), true);
+ return $this->run_command(sprintf('chown -R %s %s', escapeshellarg($owner), escapeshellarg($file)), true);
}
function owner($file) {
return $grouparray['name'];
}
- function copy($source, $destination, $overwrite = false ) {
- if( ! $overwrite && $this->exists($destination) )
+ 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) {
return @ssh2_sftp_rename($this->link, $source, $destination);
}
- function delete($file, $recursive = false) {
- if ( $this->is_file($file) )
+ function delete($file, $recursive = false, $type = false) {
+ if ( 'f' == $type || $this->is_file($file) )
return ssh2_sftp_unlink($this->sftp_link, $file);
if ( ! $recursive )
return ssh2_sftp_rmdir($this->sftp_link, $file);
$filelist = $this->dirlist($file);
if ( is_array($filelist) ) {
foreach ( $filelist as $filename => $fileinfo) {
- $this->delete($file . '/' . $filename, $recursive);
+ $this->delete($file . '/' . $filename, $recursive, $fileinfo['type']);
}
}
return ssh2_sftp_rmdir($this->sftp_link, $file);
}
function exists($file) {
- //return $this->run_command(sprintf('ls -lad %s', escapeshellarg($file)), true);
$file = ltrim($file, '/');
- return file_exists('ssh2.sftp://' . $this->sftp_link .'/' . $file);
+ return file_exists('ssh2.sftp://' . $this->sftp_link . '/' . $file);
}
function is_file($file) {
$file = ltrim($file, '/');
- return is_file('ssh2.sftp://' . $this->sftp_link .'/' . $file);
+ return is_file('ssh2.sftp://' . $this->sftp_link . '/' . $file);
}
function is_dir($path) {
$path = ltrim($path, '/');
- return is_dir('ssh2.sftp://' . $this->sftp_link .'/' . $path);
+ return is_dir('ssh2.sftp://' . $this->sftp_link . '/' . $path);
}
function is_readable($file) {
$file = ltrim($file, '/');
- return is_readable('ssh2.sftp://' . $this->sftp_link .'/' . $file);
+ return is_readable('ssh2.sftp://' . $this->sftp_link . '/' . $file);
}
function is_writable($file) {
$file = ltrim($file, '/');
- return is_writable('ssh2.sftp://' . $this->sftp_link .'/' . $file);
+ return is_writable('ssh2.sftp://' . $this->sftp_link . '/' . $file);
}
function atime($file) {
$file = ltrim($file, '/');
- return fileatime('ssh2.sftp://' . $this->sftp_link .'/' . $file);
+ return fileatime('ssh2.sftp://' . $this->sftp_link . '/' . $file);
}
function mtime($file) {
$file = ltrim($file, '/');
- return filemtime('ssh2.sftp://' . $this->sftp_link .'/' . $file);
+ return filemtime('ssh2.sftp://' . $this->sftp_link . '/' . $file);
}
function size($file) {
$file = ltrim($file, '/');
- return filesize('ssh2.sftp://' . $this->sftp_link .'/' . $file);
+ return filesize('ssh2.sftp://' . $this->sftp_link . '/' . $file);
}
function touch($file, $time = 0, $atime = 0) {
- //Not implmented.
+ //Not implemented.
}
- function mkdir($path, $chmod = null, $chown = false, $chgrp = false) {
+ function mkdir($path, $chmod = false, $chown = false, $chgrp = false) {
$path = untrailingslashit($path);
- $chmod = !empty($chmod) ? $chmod : $this->permission;
+ if ( empty($path) )
+ return false;
+
+ if ( ! $chmod )
+ $chmod = FS_CHMOD_DIR;
if ( ! ssh2_sftp_mkdir($this->sftp_link, $path, $chmod, true) )
return false;
if ( $chown )
return $this->delete($path, $recursive);
}
- function dirlist($path, $incdot = false, $recursive = false) {
+ function dirlist($path, $include_hidden = true, $recursive = false) {
if ( $this->is_file($path) ) {
- $limitFile = basename($path);
+ $limit_file = basename($path);
$path = dirname($path);
} else {
- $limitFile = false;
+ $limit_file = false;
}
+
if ( ! $this->is_dir($path) )
return false;
$ret = array();
$dir = @dir('ssh2.sftp://' . $this->sftp_link .'/' . ltrim($path, '/') );
+
if ( ! $dir )
return false;
+
while (false !== ($entry = $dir->read()) ) {
$struc = array();
$struc['name'] = $entry;
if ( '.' == $struc['name'] || '..' == $struc['name'] )
continue; //Do not care about these folders.
- if ( '.' == $struc['name'][0] && !$incdot)
+
+ if ( ! $include_hidden && '.' == $struc['name'][0] )
continue;
- if ( $limitFile && $struc['name'] != $limitFile)
+
+ if ( $limit_file && $struc['name'] != $limit_file )
continue;
$struc['perms'] = $this->gethchmod($path.'/'.$entry);
if ( 'd' == $struc['type'] ) {
if ( $recursive )
- $struc['files'] = $this->dirlist($path . '/' . $struc['name'], $incdot, $recursive);
+ $struc['files'] = $this->dirlist($path . '/' . $struc['name'], $include_hidden, $recursive);
else
$struc['files'] = array();
}
unset($dir);
return $ret;
}
-}
\ No newline at end of file
+}
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff