octoleo/phpseclib
1
0
Fork 0
mirror of https://github.com/phpseclib/phpseclib.git synced 2025-01-14 10:53:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

SFTP: switch from using file existence cache to stat cache, like PHP

Browse Source 
also add a few new functions - is_link and filesize
This commit is contained in:
terrafrost 2014-05-18 15:34:10 -05:00
parent 0a0398268a
commit e09a6968da
1 changed files with 140 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

214
phpseclib/Net/SFTP.php
View File

@ -229,18 +229,18 @@ class Net_SFTP extends Net_SSH2
var $sftp_errors = array(); var $sftp_errors = array();
/** /**
* Cache * Stat Cache
* *
* Rather than always having to open a directory and close it immediately there after to see if a file is a directory or * Rather than always having to open a directory and close it immediately there after to see if a file is a directory
* rather than always * we'll cache the results.
* *
* @see Net_SFTP::_update_cache() * @see Net_SFTP::_update_stat_cache()
* @see Net_SFTP::_remove_from_cache() * @see Net_SFTP::_remove_from_stat_cache()
* @see Net_SFTP::_query_cache() * @see Net_SFTP::_query_stat_cache()
* @var Array * @var Array
* @access private * @access private
*/ */
var $cache = array(); var $stat_cache = array();
/** /**
* Max SFTP Packet Size * Max SFTP Packet Size
@ -253,14 +253,14 @@ class Net_SFTP extends Net_SSH2
var $max_sftp_packet; var $max_sftp_packet;
/** /**
* Cache Flag * Stat Cache Flag
* *
* @see Net_SFTP::disableCache() * @see Net_SFTP::disableStatCache()
* @see Net_SFTP::enableCache() * @see Net_SFTP::enableStatCache()
* @var Boolean * @var Boolean
* @access private * @access private
*/ */
var $use_cache = true; var $use_stat_cache = true;
/** /**
* Default Constructor. * Default Constructor.
@ -532,7 +532,7 @@ class Net_SFTP extends Net_SSH2
$this->pwd = $this->_realpath('.'); $this->pwd = $this->_realpath('.');
$this->_update_cache($this->pwd, array()); $this->_update_stat_cache($this->pwd, array());
return true; return true;
} }
@ -542,9 +542,9 @@ class Net_SFTP extends Net_SSH2
* *
* @access public * @access public
*/ */
function disableCache() function disableStatCache()
{ {
$this->use_cache = false; $this->use_stat_cache = false;
} }
/** /**
@ -552,9 +552,9 @@ class Net_SFTP extends Net_SSH2
* *
* @access public * @access public
*/ */
function enableCache() function enableStatCache()
{ {
$this->use_cache = true; $this->use_stat_cache = true;
} }
/** /**
@ -675,7 +675,7 @@ class Net_SFTP extends Net_SSH2
$dir = $this->_realpath($dir); $dir = $this->_realpath($dir);
// confirm that $dir is, in fact, a valid directory // confirm that $dir is, in fact, a valid directory
if ($this->use_cache && is_array($this->_query_cache($dir))) { if ($this->use_cache && is_array($this->_query_stat_cache($dir))) {
$this->pwd = $dir; $this->pwd = $dir;
return true; return true;
} }
@ -707,7 +707,7 @@ class Net_SFTP extends Net_SSH2
return false; return false;
} }
$this->_update_cache($dir, array()); $this->_update_stat_cache($dir, array());
$this->pwd = $dir; $this->pwd = $dir;
return true; return true;
@ -723,24 +723,26 @@ class Net_SFTP extends Net_SSH2
*/ */
function nlist($dir = '.', $recursive = false) function nlist($dir = '.', $recursive = false)
{ {
$dir = $this->_realpath($dir . '/'); return $this->_nlist_helper($dir, $recursive, '');
switch (true) { }
case !$this->use_cache:
case !is_array($result = $this->_query_cache($dir)): /**
case !isset($result['.']): * Helper method for nlist
case $recursive: *
break; * @param String $dir
default: * @param Boolean $recursive
return array_keys($result); * @param String $relativeDir
} * @return Mixed
* @access private
*/
function _nlist_helper($dir, $recursive, $relativeDir)
{
$files = $this->_list($dir, false); $files = $this->_list($dir, false);
if (!$recursive) { if (!$recursive) {
return $files; return $files;
} }
static $relativeDir = '';
$result = array(); $result = array();
foreach ($files as $value) { foreach ($files as $value) {
if ($value == '.' || $value == '..') { if ($value == '.' || $value == '..') {
@ -749,12 +751,9 @@ class Net_SFTP extends Net_SSH2
} }
continue; continue;
} }
if (is_array($this->_query_cache($this->_realpath($dir . '/' . $value)))) { if (is_array($this->_query_stat_cache($this->_realpath($dir . '/' . $value)))) {
$oldDir = $relativeDir; $temp = $this->_nlist_helper($dir . '/' . $value, true, $relativeDir . $value . '/');
$relativeDir.= $value . '/';
$temp = $this->nlist($dir . '/' . $value, true);
$result = array_merge($result, $temp); $result = array_merge($result, $temp);
$relativeDir = $oldDir;
} else { } else {
$result[] = $relativeDir . $value; $result[] = $relativeDir . $value;
} }
@ -785,16 +784,12 @@ class Net_SFTP extends Net_SSH2
unset($files[$key]); unset($files[$key]);
continue; continue;
} }
if ($key != '.' && $key != '..' && is_array($this->_query_cache($this->_realpath($dir . '/' . $key)))) { if ($key != '.' && $key != '..' && is_array($this->_query_stat_cache($this->_realpath($dir . '/' . $key)))) {
$depth++; $depth++;
$files[$key] = $this->rawlist($dir . '/' . $key, true); $files[$key] = $this->rawlist($dir . '/' . $key, true);
$depth--; $depth--;
} else { } else {
$temp = new StdClass(); $files[$key] = (object) $value;
foreach ($value as $subkey=>$subvalue) {
$temp->$subkey = $subvalue;
}
$files[$key] = $temp;
} }
} }
@ -846,7 +841,7 @@ class Net_SFTP extends Net_SSH2
return false; return false;
} }
$this->_update_cache($dir, array()); $this->_update_stat_cache($dir, array());
$contents = array(); $contents = array();
while (true) { while (true) {
@ -880,9 +875,9 @@ class Net_SFTP extends Net_SSH2
} }
if (isset($attributes['type']) && $attributes['type'] == NET_SFTP_TYPE_DIRECTORY && ($shortname != '.' && $shortname != '..')) { if (isset($attributes['type']) && $attributes['type'] == NET_SFTP_TYPE_DIRECTORY && ($shortname != '.' && $shortname != '..')) {
$this->_update_cache($dir . '/' . $shortname, array()); $this->_update_stat_cache($dir . '/' . $shortname, array());
} else { } else {
$this->_update_cache($dir . '/' . $shortname, 1); $this->_update_stat_cache($dir . '/' . $shortname, (object) $attributes);
} }
// SFTPv6 has an optional boolean end-of-list field, but we'll ignore that, since the // SFTPv6 has an optional boolean end-of-list field, but we'll ignore that, since the
// final SSH_FXP_STATUS packet should tell us that, already. // final SSH_FXP_STATUS packet should tell us that, already.
@ -938,7 +933,7 @@ class Net_SFTP extends Net_SSH2
* @param optional Boolean $file * @param optional Boolean $file
* @access private * @access private
*/ */
function _update_cache($path, $value) function _update_stat_cache($path, $value)
{ {
// preg_replace('#^/|/(?=/)|/$#', '', $dir) == str_replace('//', '/', trim($path, '/')) // preg_replace('#^/|/(?=/)|/$#', '', $dir) == str_replace('//', '/', trim($path, '/'))
$dirs = explode('/', preg_replace('#^/|/(?=/)|/$#', '', $path)); $dirs = explode('/', preg_replace('#^/|/(?=/)|/$#', '', $path));
@ -962,7 +957,7 @@ class Net_SFTP extends Net_SSH2
* @param optional Boolean $file * @param optional Boolean $file
* @access private * @access private
*/ */
function _remove_from_cache($path) function _remove_from_stat_cache($path)
{ {
$dirs = explode('/', preg_replace('#^/|/(?=/)|/$#', '', $path)); $dirs = explode('/', preg_replace('#^/|/(?=/)|/$#', '', $path));
@ -988,7 +983,7 @@ class Net_SFTP extends Net_SSH2
* @return Mixed * @return Mixed
* @access private * @access private
*/ */
function _query_cache($path) function _query_stat_cache($path)
{ {
$dirs = explode('/', preg_replace('#^/|/(?=/)|/$#', '', $path)); $dirs = explode('/', preg_replace('#^/|/(?=/)|/$#', '', $path));
@ -1022,13 +1017,23 @@ class Net_SFTP extends Net_SSH2
return false; return false;
} }
if ($this->use_stat_cache) {
$result = $this->_query_stat_cache($filename);
if (is_array($result)) {
return (array) $result['.'];
}
if ($result !== false) {
return (array) $result;
}
}
$stat = $this->_stat($filename, NET_SFTP_STAT); $stat = $this->_stat($filename, NET_SFTP_STAT);
if ($stat === false) { if ($stat === false) {
$this->_update_cache($filename, 0); $this->_update_stat_cache($filename, 0);
return false; return false;
} }
$this->_update_cache($filename, 1);
if (isset($stat['type'])) { if (isset($stat['type'])) {
$this->_update_stat_cache($filename, $stat);
return $stat; return $stat;
} }
@ -1038,6 +1043,8 @@ class Net_SFTP extends Net_SSH2
NET_SFTP_TYPE_REGULAR; NET_SFTP_TYPE_REGULAR;
$this->pwd = $pwd; $this->pwd = $pwd;
$this->_update_stat_cache($filename, $stat);
return $stat; return $stat;
} }
@ -1058,23 +1065,34 @@ class Net_SFTP extends Net_SSH2
$filename = $this->_realpath($filename); $filename = $this->_realpath($filename);
if ($filename === false) { if ($filename === false) {
$this->_update_cache($filename, 0);
return false; return false;
} }
if ($this->use_stat_cache) {
$result = $this->_query_stat_cache($filename);
if (is_array($result)) {
return (array) $result['.'];
}
if ($result !== false) {
return (array) $result;
}
}
$lstat = $this->_stat($filename, NET_SFTP_LSTAT); $lstat = $this->_stat($filename, NET_SFTP_LSTAT);
if ($lstat === false) { if ($lstat === false) {
return false; return false;
} }
$this->_update_cache($filename, 1);
if (isset($lstat['type'])) { if (isset($lstat['type'])) {
$this->_update_stat_cache($filename, $lstat);
return $lstat; return $lstat;
} }
$stat = $this->_stat($filename, NET_SFTP_STAT); $stat = $this->_stat($filename, NET_SFTP_STAT);
if ($lstat != $stat) { if ($lstat != $stat) {
return array_merge($lstat, array('type' => NET_SFTP_TYPE_SYMLINK)); $lstat = array_merge($lstat, array('type' => NET_SFTP_TYPE_SYMLINK));
$this->_update_stat_cache($filename, $lstat);
return $stat;
} }
$pwd = $this->pwd; $pwd = $this->pwd;
@ -1083,6 +1101,8 @@ class Net_SFTP extends Net_SSH2
NET_SFTP_TYPE_REGULAR; NET_SFTP_TYPE_REGULAR;
$this->pwd = $pwd; $this->pwd = $pwd;
$this->_update_stat_cache($filename, $lstat);
return $lstat; return $lstat;
} }
@ -1199,8 +1219,6 @@ class Net_SFTP extends Net_SSH2
return false; return false;
} }
$this->_update_cache($filename, 1);
return $this->_setstat($filename, $attr, false); return $this->_setstat($filename, $attr, false);
} }
@ -1312,6 +1330,8 @@ class Net_SFTP extends Net_SSH2
return false; return false;
} }
$this->_remove_from_stat_cache($filename);
if ($recursive) { if ($recursive) {
$i = 0; $i = 0;
$result = $this->_setstat_recursive($filename, $attr, $i); $result = $this->_setstat_recursive($filename, $attr, $i);
@ -1482,8 +1502,6 @@ class Net_SFTP extends Net_SSH2
return false; return false;
} }
$this->_update_cache($dir, array());
return true; return true;
} }
@ -1522,8 +1540,11 @@ class Net_SFTP extends Net_SSH2
return false; return false;
} }
//$this->_remove_from_cache($dir); $this->_remove_from_stat_cache($dir);
$this->_update_cache($dir, 0); // the following will do a soft delete, which would be useful if you deleted a file
// and then tried to do a stat on the deleted file. the above, in contrast, does
// a hard delete
//$this->_update_stat_cache($dir, 0);
return true; return true;
} }
@ -1676,8 +1697,6 @@ class Net_SFTP extends Net_SSH2
fclose($fp); fclose($fp);
} }
$this->_update_cache($remote_file, 1);
return $this->_close_handle($handle); return $this->_close_handle($handle);
} }
@ -1849,8 +1868,6 @@ class Net_SFTP extends Net_SSH2
return false; return false;
} }
$this->_update_cache($remote_file, 1);
// if $content isn't set that means a file was written to // if $content isn't set that means a file was written to
return isset($content) ? $content : true; return isset($content) ? $content : true;
} }
@ -1898,7 +1915,7 @@ class Net_SFTP extends Net_SSH2
return $result; return $result;
} }
$this->_update_cache($path, 0); $this->_remove_from_stat_cache($path);
return true; return true;
} }
@ -1955,8 +1972,7 @@ class Net_SFTP extends Net_SSH2
$i = 0; $i = 0;
} }
} }
//$this->_remove_from_cache($path); $this->_remove_from_stat_cache($path);
$this->_update_cache($path, 0);
} }
if (!$this->_send_sftp_packet(NET_SFTP_RMDIR, pack('Na*', strlen($path), $path))) { if (!$this->_send_sftp_packet(NET_SFTP_RMDIR, pack('Na*', strlen($path), $path))) {
@ -1984,10 +2000,10 @@ class Net_SFTP extends Net_SSH2
*/ */
function file_exists($path) function file_exists($path)
{ {
if ($this->use_cache) { if ($this->use_stat_cache) {
$path = $this->_realpath($path); $path = $this->_realpath($path);
$result = $this->_query_cache($path); $result = $this->_query_stat_cache($path);
if ($result !== false) { if ($result !== false) {
// return true if $result is an array or if it's int(1) // return true if $result is an array or if it's int(1)
@ -2007,10 +2023,10 @@ class Net_SFTP extends Net_SSH2
*/ */
function is_dir($path) function is_dir($path)
{ {
if ($this->use_cache) { if ($this->use_stat_cache) {
$path = $this->_realpath($path); $path = $this->_realpath($path);
$result = $this->_query_cache($path); $result = $this->_query_stat_cache($path);
if ($result !== false) { if ($result !== false) {
return is_array($result); return is_array($result);
@ -2031,13 +2047,13 @@ class Net_SFTP extends Net_SSH2
*/ */
function is_file($path) function is_file($path)
{ {
if ($this->use_cache) { if ($this->use_stat_cache) {
$path = $this->_realpath($path); $path = $this->_realpath($path);
$result = $this->_query_cache($path); $result = $this->_query_stat_cache($path);
if ($result !== false) { if ($result !== false) {
return $result === 1; return !is_array($result);
} }
} }
@ -2046,6 +2062,54 @@ class Net_SFTP extends Net_SSH2
return $result['type'] === NET_SFTP_TYPE_REGULAR; return $result['type'] === NET_SFTP_TYPE_REGULAR;
} }
/**
* Tells whether the filename is a symbolic link
*
* @param String $path
* @return Boolean
* @access public
*/
function is_link($path)
{
if ($this->use_stat_cache) {
$path = $this->_realpath($path);
$result = $this->_query_stat_cache($path);
if (is_object($result) && isset($result->type)) {
return $result->type === NET_SFTP_TYPE_SYMLINK;
}
}
$result = $this->stat($path);
return $result['type'] === NET_SFTP_TYPE_SYMLINK;
}
/**
* Gets file size
*
* @param String $path
* @return Boolean
* @access public
*/
function filesize($path)
{
if ($this->use_stat_cache) {
$path = $this->_realpath($path);
$result = $this->_query_stat_cache($path);
if (is_object($result) && isset($result->size)) {
return $result->size;
}
}
$result = $this->stat($path);
return $result['size'];
}
/** /**
* Renames a file or a directory on the SFTP server * Renames a file or a directory on the SFTP server
* *
@ -2085,8 +2149,10 @@ class Net_SFTP extends Net_SSH2
return false; return false;
} }
$this->_update_cache($oldname, 0); // don't move the stat cache entry over since this operation could very well change the
$this->_update_cache($newname, 1); // atime and mtime attributes
//$this->_update_stat_cache($newname, $this->_query_stat_cache($oldname));
$this->_remove_from_stat_cache($oldname);
return true; return true;
} }