phpseclib\Net\SFTP Class Reference

Inheritance diagram for phpseclib\Net\SFTP:

Collaboration diagram for phpseclib\Net\SFTP:

Public Member Functions
	__construct ($host, $port=22, $timeout=10)
	Default Constructor. More...
	login ($username)
	Login. More...
	disableStatCache ()
	Disable the stat cache. More...
	enableStatCache ()
	Enable the stat cache. More...
	clearStatCache ()
	Clear the stat cache. More...
	pwd ()
	Returns the current directory name. More...
	_logError ($response, $status=-1)
	Logs errors. More...
	_realpath ($path)
	Canonicalize the Server-Side Path Name. More...
	chdir ($dir)
	Changes the current directory. More...
	nlist ($dir='.', $recursive=false)
	Returns a list of files in the given directory. More...
	_nlist_helper ($dir, $recursive, $relativeDir)
	Helper method for nlist. More...
	rawlist ($dir='.', $recursive=false)
	Returns a detailed list of files in the given directory. More...
	_list ($dir, $raw=true)
	Reads a list, be it detailed or not, of files in the given directory. More...
	_comparator ($a, $b)
	Compares two rawlist entries using parameters set by setListOrder() More...
	setListOrder ()
	Defines how nlist() and rawlist() will be sorted - if at all. More...
	size ($filename)
	Returns the file size, in bytes, or false, on failure. More...
	_update_stat_cache ($path, $value)
	Save files / directories to cache. More...
	_remove_from_stat_cache ($path)
	Remove files / directories from cache. More...
	_query_stat_cache ($path)
	Checks cache for path. More...
	stat ($filename)
	Returns general information about a file. More...
	lstat ($filename)
	Returns general information about a file or symbolic link. More...
	_stat ($filename, $type)
	Returns general information about a file or symbolic link. More...
	truncate ($filename, $new_size)
	Truncates a file to a given length. More...
	touch ($filename, $time=null, $atime=null)
	Sets access and modification time of file. More...
	chown ($filename, $uid, $recursive=false)
	Changes file or directory owner. More...
	chgrp ($filename, $gid, $recursive=false)
	Changes file or directory group. More...
	chmod ($mode, $filename, $recursive=false)
	Set permissions on a file. More...
	_setstat ($filename, $attr, $recursive)
	Sets information about a file. More...
	_setstat_recursive ($path, $attr, &$i)
	Recursively sets information on directories on the SFTP server. More...
	readlink ($link)
	Return the target of a symbolic link. More...
	symlink ($target, $link)
	Create a symlink. More...
	mkdir ($dir, $mode=-1, $recursive=false)
	Creates a directory. More...
	_mkdir_helper ($dir, $attr)
	Helper function for directory creation. More...
	rmdir ($dir)
	Removes a directory. More...
	put ($remote_file, $data, $mode=self::SOURCE_STRING, $start=-1, $local_start=-1, $progressCallback=null)
	Uploads a file to the SFTP server. More...
	_read_put_responses ($i)
	Reads multiple successive SSH_FXP_WRITE responses. More...
	_close_handle ($handle)
	Close handle. More...
	get ($remote_file, $local_file=false, $offset=0, $length=-1)
	Downloads a file from the SFTP server. More...
	delete ($path, $recursive=true)
	Deletes a file on the SFTP server. More...
	_delete_recursive ($path, &$i)
	Recursively deletes directories on the SFTP server. More...
	file_exists ($path)
	Checks whether a file or directory exists. More...
	is_dir ($path)
	Tells whether the filename is a directory. More...
	is_file ($path)
	Tells whether the filename is a regular file. More...
	is_link ($path)
	Tells whether the filename is a symbolic link. More...
	fileatime ($path)
	Gets last access time of file. More...
	filemtime ($path)
	Gets file modification time. More...
	fileperms ($path)
	Gets file permissions. More...
	fileowner ($path)
	Gets file owner. More...
	filegroup ($path)
	Gets file group. More...
	filesize ($path)
	Gets file size. More...
	filetype ($path)
	Gets file type. More...
	_get_stat_cache_prop ($path, $prop)
	Return a stat properity. More...
	_get_lstat_cache_prop ($path, $prop)
	Return an lstat properity. More...
	_get_xstat_cache_prop ($path, $prop, $type)
	Return a stat or lstat properity. More...
	rename ($oldname, $newname)
	Renames a file or a directory on the SFTP server. More...
	_parseAttributes (&$response)
	Parse Attributes. More...
	_parseMode ($mode)
	Attempt to identify the file type. More...
	_parseLongname ($longname)
	Parse Longname. More...
	_send_sftp_packet ($type, $data)
	Sends SFTP Packets. More...
	_get_sftp_packet ()
	Receives SFTP Packets. More...
	getSFTPLog ()
	Returns a log of the packets that have been sent and received. More...
	getSFTPErrors ()
	Returns all errors. More...
	getLastSFTPError ()
	Returns the last error. More...
	getSupportedVersions ()
	Get supported SFTP versions. More...
	_disconnect ($reason)
	Disconnect. More...
Public Member Functions inherited from phpseclib\Net\SSH2
	__construct ($host, $port=22, $timeout=10)
	Default Constructor. More...
	setCryptoEngine ($engine)
	Set Crypto Engine Mode. More...
	_connect ()
	Connect to an SSHv2 server. More...
	_generate_identifier ()
	Generates the SSH identifier. More...
	_key_exchange ($kexinit_payload_server)
	Key Exchange. More...
	_encryption_algorithm_to_key_size ($algorithm)
	Maps an encryption algorithm name to the number of key bytes. More...
	_encryption_algorithm_to_crypt_instance ($algorithm)
	Maps an encryption algorithm name to an instance of a subclass of . More...
	login ($username)
	Login. More...
	_login ($username)
	Login Helper. More...
	_login_helper ($username, $password=null)
	Login Helper. More...
	_keyboard_interactive_login ($username, $password)
	Login via keyboard-interactive authentication. More...
	_keyboard_interactive_process ()
	Handle the keyboard-interactive requests / responses. More...
	_ssh_agent_login ($username, $agent)
	Login with an ssh-agent provided key. More...
	_privatekey_login ($username, $privatekey)
	Login with an RSA private key. More...
	setTimeout ($timeout)
	Set Timeout. More...
	getStdError ()
	Get the output from stdError. More...
	exec ($command, $callback=null)
	Execute Command. More...
	_initShell ()
	Creates an interactive shell. More...
	_get_interactive_channel ()
	Return the channel to be used with read() / write() More...
	_get_open_channel ()
	Return an available open channel. More...
	read ($expect='', $mode=self::READ_SIMPLE)
	Returns the output of an interactive shell. More...
	write ($cmd)
	Inputs a command into an interactive shell. More...
	startSubsystem ($subsystem)
	Start a subsystem. More...
	stopSubsystem ()
	Stops a subsystem. More...
	reset ()
	Closes a channel. More...
	isTimeout ()
	Is timeout? More...
	disconnect ()
	Disconnect. More...
	__destruct ()
	Destructor. More...
	isConnected ()
	Is the connection still active? More...
	isAuthenticated ()
	Have you successfully been logged in? More...
	_get_binary_packet ()
	Gets Binary Packets. More...
	_filter ($payload)
	Filter Binary Packets. More...
	enableQuietMode ()
	Enable Quiet Mode. More...
	disableQuietMode ()
	Disable Quiet Mode. More...
	isQuietModeEnabled ()
	Returns whether Quiet Mode is enabled or not. More...
	enablePTY ()
	Enable request-pty when using exec() More...
	disablePTY ()
	Disable request-pty when using exec() More...
	isPTYEnabled ()
	Returns whether request-pty is enabled or not. More...
	_get_channel_packet ($client_channel, $skip_extended=false)
	Gets channel data. More...
	_send_binary_packet ($data, $logged=null)
	Sends Binary Packets. More...
	_append_log ($message_number, $message)
	Logs data packets. More...
	_send_channel_packet ($client_channel, $data)
	Sends channel data. More...
	_close_channel ($client_channel, $want_reply=false)
	Closes and flushes a channel. More...
	_disconnect ($reason)
	Disconnect. More...
	_string_shift (&$string, $index=1)
	String Shift. More...
	_define_array ()
	Define Array. More...
	getLog ()
	Returns a log of the packets that have been sent and received. More...
	_format_log ($message_log, $message_number_log)
	Formats a log for printing. More...
	_format_log_helper ($matches)
	Helper function for _format_log. More...
	_on_channel_open ()
	Helper function for agent->_on_channel_open() More...
	_array_intersect_first ($array1, $array2)
	Returns the first value of the intersection of two arrays or false if the intersection is empty. More...
	getErrors ()
	Returns all errors. More...
	getLastError ()
	Returns the last error. More...
	getServerIdentification ()
	Return the server identification. More...
	getKexAlgorithms ()
	Return a list of the key exchange algorithms the server supports. More...
	getServerHostKeyAlgorithms ()
	Return a list of the host key (public key) algorithms the server supports. More...
	getEncryptionAlgorithmsClient2Server ()
	Return a list of the (symmetric key) encryption algorithms the server supports, when receiving stuff from the client. More...
	getEncryptionAlgorithmsServer2Client ()
	Return a list of the (symmetric key) encryption algorithms the server supports, when sending stuff to the client. More...
	getMACAlgorithmsClient2Server ()
	Return a list of the MAC algorithms the server supports, when receiving stuff from the client. More...
	getMACAlgorithmsServer2Client ()
	Return a list of the MAC algorithms the server supports, when sending stuff to the client. More...
	getCompressionAlgorithmsClient2Server ()
	Return a list of the compression algorithms the server supports, when receiving stuff from the client. More...
	getCompressionAlgorithmsServer2Client ()
	Return a list of the compression algorithms the server supports, when sending stuff to the client. More...
	getLanguagesServer2Client ()
	Return a list of the languages the server supports, when sending stuff to the client. More...
	getLanguagesClient2Server ()
	Return a list of the languages the server supports, when receiving stuff from the client. More...
	getBannerMessage ()
	Returns the banner message. More...
	getServerPublicHostKey ()
	Returns the server public host key. More...
	getExitStatus ()
	Returns the exit status of an SSH command or false. More...
	getWindowColumns ()
	Returns the number of columns for the terminal window size. More...
	getWindowRows ()
	Returns the number of rows for the terminal window size. More...
	setWindowColumns ($value)
	Sets the number of columns for the terminal window size. More...
	setWindowRows ($value)
	Sets the number of rows for the terminal window size. More...
	setWindowSize ($columns=80, $rows=24)
	Sets the number of columns and rows for the terminal window size. More...

Data Fields
const	CHANNEL = 0x100
	SFTP channel constant. More...
const	SOURCE_LOCAL_FILE = 1
	#+ public More...
const	SOURCE_STRING = 2
	Reads data from a string. More...
const	SOURCE_CALLBACK = 16
	Reads data from callback: function callback($length) returns string to proceed, null for EOF. More...
const	RESUME = 4
	Resumes an upload. More...
const	RESUME_START = 8
	Append a local file to an already existing remote file. More...
	$packet_types = array()
	$status_codes = array()
	$request_id = false
	$packet_type = -1
	$packet_buffer = ''
	$extensions = array()
	$version
	$pwd = false
	$packet_type_log = array()
	$packet_log = array()
	$sftp_errors = array()
	$stat_cache = array()
	$max_sftp_packet
	$use_stat_cache = true
	$sortOptions = array()
Data Fields inherited from phpseclib\Net\SSH2
const	MASK_CONSTRUCTOR = 0x00000001
	#+ Execution Bitmap Masks More...
const	MASK_CONNECTED = 0x00000002
const	MASK_LOGIN_REQ = 0x00000004
const	MASK_LOGIN = 0x00000008
const	MASK_SHELL = 0x00000010
const	MASK_WINDOW_ADJUST = 0x00000020
const	CHANNEL_EXEC = 0
	#- More...
const	CHANNEL_SHELL = 1
const	CHANNEL_SUBSYSTEM = 2
const	CHANNEL_AGENT_FORWARD = 3
const	LOG_SIMPLE = 1
	#- More...
const	LOG_COMPLEX = 2
	Returns the message content. More...
const	LOG_REALTIME = 3
	Outputs the content real-time. More...
const	LOG_REALTIME_FILE = 4
	Dumps the content real-time to a file. More...
const	READ_SIMPLE = 1
	#- More...
const	READ_REGEX = 2
	Returns when a string matching the regular expression $expect is found. More...
const	LOG_MAX_SIZE = 1048576
	Make sure that the log never gets larger than this. More...
	$identifier
	$fsock
	$bitmap = 0
	$errors = array()
	$server_identifier = false
	$kex_algorithms = false
	$kex_dh_group_size_min = 1536
	$kex_dh_group_size_preferred = 2048
	$kex_dh_group_size_max = 4096
	$server_host_key_algorithms = false
	$encryption_algorithms_client_to_server = false
	$encryption_algorithms_server_to_client = false
	$mac_algorithms_client_to_server = false
	$mac_algorithms_server_to_client = false
	$compression_algorithms_client_to_server = false
	$compression_algorithms_server_to_client = false
	$languages_server_to_client = false
	$languages_client_to_server = false
	$encrypt_block_size = 8
	$decrypt_block_size = 8
	$decrypt = false
	$encrypt = false
	$hmac_create = false
	$hmac_check = false
	$hmac_size = false
	$server_public_host_key
	$session_id = false
	$exchange_hash = false
	$message_numbers = array()
	$disconnect_reasons = array()
	$channel_open_failure_reasons = array()
	$terminal_modes = array()
	$channel_extended_data_type_codes = array()
	$send_seq_no = 0
	$get_seq_no = 0
	$server_channels = array()
	$channel_buffers = array()
	$channel_status = array()
	$packet_size_client_to_server = array()
	$message_number_log = array()
	$message_log = array()
	$window_size = 0x7FFFFFFF
	$window_size_server_to_client = array()
	$window_size_client_to_server = array()
	$signature = ''
	$signature_format = ''
	$interactiveBuffer = ''
	$log_size
	$timeout
	Timeout. More...
	$curTimeout
	Current Timeout. More...
	$realtime_log_file
	$realtime_log_size
	$signature_validated = false
	$realtime_log_wrap
	Real-time log file wrap boolean. More...
	$quiet_mode = false
	Flag to suppress stderr from output. More...
	$last_packet
	$exit_status
	$request_pty = false
	$in_request_pty_exec = false
	$in_subsystem
	$stdErrorLog
	$last_interactive_response = ''
	$keyboard_requests_responses = array()
	$banner_message = ''
	$is_timeout = false
	$log_boundary = ':'
	$log_long_width = 65
	$log_short_width = 16
	$host
	$port
	$windowColumns = 80
	$windowRows = 24
	$crypto_engine = false
	$agent

Detailed Description

Definition at line 49 of file SFTP.php.

Constructor & Destructor Documentation

__construct()

phpseclib\Net\SFTP::__construct	(		$host,
			$port = 22,
			$timeout = 10
	)

Default Constructor.

Connects to an SFTP server

Parameters

string	$host
int	$port
int	$timeout

Returns

public

Definition at line 252 of file SFTP.php.

References phpseclib\Net\SSH2\$host, phpseclib\Net\SSH2\$port, phpseclib\Net\SSH2\$timeout, and phpseclib\Net\SSH2\_define_array().

    {
        parent::__construct($host, $port, $timeout);

        $this->max_sftp_packet = 1 << 15;

        $this->packet_types = array(
            1  => 'NET_SFTP_INIT',
            2  => 'NET_SFTP_VERSION',
            /* the format of SSH_FXP_OPEN changed between SFTPv4 and SFTPv5+:
                   SFTPv5+: http://tools.ietf.org/html/draft-ietf-secsh-filexfer-13#section-8.1.1
               pre-SFTPv5 : http://tools.ietf.org/html/draft-ietf-secsh-filexfer-04#section-6.3 */
            3  => 'NET_SFTP_OPEN',
            4  => 'NET_SFTP_CLOSE',
            5  => 'NET_SFTP_READ',
            6  => 'NET_SFTP_WRITE',
            7  => 'NET_SFTP_LSTAT',
            9  => 'NET_SFTP_SETSTAT',
            11 => 'NET_SFTP_OPENDIR',
            12 => 'NET_SFTP_READDIR',
            13 => 'NET_SFTP_REMOVE',
            14 => 'NET_SFTP_MKDIR',
            15 => 'NET_SFTP_RMDIR',
            16 => 'NET_SFTP_REALPATH',
            17 => 'NET_SFTP_STAT',
            /* the format of SSH_FXP_RENAME changed between SFTPv4 and SFTPv5+:
                   SFTPv5+: http://tools.ietf.org/html/draft-ietf-secsh-filexfer-13#section-8.3
               pre-SFTPv5 : http://tools.ietf.org/html/draft-ietf-secsh-filexfer-04#section-6.5 */
            18 => 'NET_SFTP_RENAME',
            19 => 'NET_SFTP_READLINK',
            20 => 'NET_SFTP_SYMLINK',

            101=> 'NET_SFTP_STATUS',
            102=> 'NET_SFTP_HANDLE',
            /* the format of SSH_FXP_NAME changed between SFTPv3 and SFTPv4+:
                   SFTPv4+: http://tools.ietf.org/html/draft-ietf-secsh-filexfer-13#section-9.4
               pre-SFTPv4 : http://tools.ietf.org/html/draft-ietf-secsh-filexfer-02#section-7 */
            103=> 'NET_SFTP_DATA',
            104=> 'NET_SFTP_NAME',
            105=> 'NET_SFTP_ATTRS',

            200=> 'NET_SFTP_EXTENDED'
        );
        $this->status_codes = array(
            0 => 'NET_SFTP_STATUS_OK',
            1 => 'NET_SFTP_STATUS_EOF',
            2 => 'NET_SFTP_STATUS_NO_SUCH_FILE',
            3 => 'NET_SFTP_STATUS_PERMISSION_DENIED',
            4 => 'NET_SFTP_STATUS_FAILURE',
            5 => 'NET_SFTP_STATUS_BAD_MESSAGE',
            6 => 'NET_SFTP_STATUS_NO_CONNECTION',
            7 => 'NET_SFTP_STATUS_CONNECTION_LOST',
            8 => 'NET_SFTP_STATUS_OP_UNSUPPORTED',
            9 => 'NET_SFTP_STATUS_INVALID_HANDLE',
            10 => 'NET_SFTP_STATUS_NO_SUCH_PATH',
            11 => 'NET_SFTP_STATUS_FILE_ALREADY_EXISTS',
            12 => 'NET_SFTP_STATUS_WRITE_PROTECT',
            13 => 'NET_SFTP_STATUS_NO_MEDIA',
            14 => 'NET_SFTP_STATUS_NO_SPACE_ON_FILESYSTEM',
            15 => 'NET_SFTP_STATUS_QUOTA_EXCEEDED',
            16 => 'NET_SFTP_STATUS_UNKNOWN_PRINCIPAL',
            17 => 'NET_SFTP_STATUS_LOCK_CONFLICT',
            18 => 'NET_SFTP_STATUS_DIR_NOT_EMPTY',
            19 => 'NET_SFTP_STATUS_NOT_A_DIRECTORY',
            20 => 'NET_SFTP_STATUS_INVALID_FILENAME',
            21 => 'NET_SFTP_STATUS_LINK_LOOP',
            22 => 'NET_SFTP_STATUS_CANNOT_DELETE',
            23 => 'NET_SFTP_STATUS_INVALID_PARAMETER',
            24 => 'NET_SFTP_STATUS_FILE_IS_A_DIRECTORY',
            25 => 'NET_SFTP_STATUS_BYTE_RANGE_LOCK_CONFLICT',
            26 => 'NET_SFTP_STATUS_BYTE_RANGE_LOCK_REFUSED',
            27 => 'NET_SFTP_STATUS_DELETE_PENDING',
            28 => 'NET_SFTP_STATUS_FILE_CORRUPT',
            29 => 'NET_SFTP_STATUS_OWNER_INVALID',
            30 => 'NET_SFTP_STATUS_GROUP_INVALID',
            31 => 'NET_SFTP_STATUS_NO_MATCHING_BYTE_RANGE_LOCK'
        );
        // http://tools.ietf.org/html/draft-ietf-secsh-filexfer-13#section-7.1
        // the order, in this case, matters quite a lot - see \phpseclib\Net\SFTP::_parseAttributes() to understand why
        $this->attributes = array(
            0x00000001 => 'NET_SFTP_ATTR_SIZE',
            0x00000002 => 'NET_SFTP_ATTR_UIDGID', // defined in SFTPv3, removed in SFTPv4+
            0x00000004 => 'NET_SFTP_ATTR_PERMISSIONS',
            0x00000008 => 'NET_SFTP_ATTR_ACCESSTIME',
            // 0x80000000 will yield a floating point on 32-bit systems and converting floating points to integers
            // yields inconsistent behavior depending on how php is compiled.  so we left shift -1 (which, in
            // two's compliment, consists of all 1 bits) by 31.  on 64-bit systems this'll yield 0xFFFFFFFF80000000.
            // that's not a problem, however, and 'anded' and a 32-bit number, as all the leading 1 bits are ignored.
              -1 << 31 => 'NET_SFTP_ATTR_EXTENDED'
        );
        // http://tools.ietf.org/html/draft-ietf-secsh-filexfer-04#section-6.3
        // the flag definitions change somewhat in SFTPv5+.  if SFTPv5+ support is added to this library, maybe name
        // the array for that $this->open5_flags and similarily alter the constant names.
        $this->open_flags = array(
            0x00000001 => 'NET_SFTP_OPEN_READ',
            0x00000002 => 'NET_SFTP_OPEN_WRITE',
            0x00000004 => 'NET_SFTP_OPEN_APPEND',
            0x00000008 => 'NET_SFTP_OPEN_CREATE',
            0x00000010 => 'NET_SFTP_OPEN_TRUNCATE',
            0x00000020 => 'NET_SFTP_OPEN_EXCL'
        );
        // http://tools.ietf.org/html/draft-ietf-secsh-filexfer-04#section-5.2
        // see \phpseclib\Net\SFTP::_parseLongname() for an explanation
        $this->file_types = array(
            1 => 'NET_SFTP_TYPE_REGULAR',
            2 => 'NET_SFTP_TYPE_DIRECTORY',
            3 => 'NET_SFTP_TYPE_SYMLINK',
            4 => 'NET_SFTP_TYPE_SPECIAL',
            5 => 'NET_SFTP_TYPE_UNKNOWN',
            // the followin types were first defined for use in SFTPv5+
            // http://tools.ietf.org/html/draft-ietf-secsh-filexfer-05#section-5.2
            6 => 'NET_SFTP_TYPE_SOCKET',
            7 => 'NET_SFTP_TYPE_CHAR_DEVICE',
            8 => 'NET_SFTP_TYPE_BLOCK_DEVICE',
            9 => 'NET_SFTP_TYPE_FIFO'
        );
        $this->_define_array(
            $this->packet_types,
            $this->status_codes,
            $this->attributes,
            $this->open_flags,
            $this->file_types
        );

        if (!defined('NET_SFTP_QUEUE_SIZE')) {
            define('NET_SFTP_QUEUE_SIZE', 50);
        }
    }

Here is the call graph for this function:

Member Function Documentation

_close_handle()

phpseclib\Net\SFTP::_close_handle

(

$handle

)

Close handle.

Parameters

string

$handle

Returns

bool private

Definition at line 1979 of file SFTP.php.

References $response, phpseclib\Net\SFTP\_get_sftp_packet(), phpseclib\Net\SFTP\_logError(), phpseclib\Net\SFTP\_send_sftp_packet(), and phpseclib\Net\SSH2\_string_shift().

Referenced by phpseclib\Net\SFTP\_list(), phpseclib\Net\SFTP\chdir(), phpseclib\Net\SFTP\get(), phpseclib\Net\SFTP\put(), and phpseclib\Net\SFTP\touch().

    {
        if (!$this->_send_sftp_packet(NET_SFTP_CLOSE, pack('Na*', strlen($handle), $handle))) {
            return false;
        }

        // "The client MUST release all resources associated with the handle regardless of the status."
        //  -- http://tools.ietf.org/html/draft-ietf-secsh-filexfer-13#section-8.1.3
        $response = $this->_get_sftp_packet();
        if ($this->packet_type != NET_SFTP_STATUS) {
            user_error('Expected SSH_FXP_STATUS');
            return false;
        }

        extract(unpack('Nstatus', $this->_string_shift($response, 4)));
        if ($status != NET_SFTP_STATUS_OK) {
            $this->_logError($response, $status);
            return false;
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_comparator()

phpseclib\Net\SFTP::_comparator	(		$a,
			$b
	)

Compares two rawlist entries using parameters set by setListOrder()

Intended for use with uasort()

Parameters

array	$a
array	$b

Returns

int private

Definition at line 928 of file SFTP.php.

References $result.

    {
        switch (true) {
            case $a['filename'] === '.' || $b['filename'] === '.':
                if ($a['filename'] === $b['filename']) {
                    return 0;
                }
                return $a['filename'] === '.' ? -1 : 1;
            case $a['filename'] === '..' || $b['filename'] === '..':
                if ($a['filename'] === $b['filename']) {
                    return 0;
                }
                return $a['filename'] === '..' ? -1 : 1;
            case isset($a['type']) && $a['type'] === NET_SFTP_TYPE_DIRECTORY:
                if (!isset($b['type'])) {
                    return 1;
                }
                if ($b['type'] !== $a['type']) {
                    return -1;
                }
                break;
            case isset($b['type']) && $b['type'] === NET_SFTP_TYPE_DIRECTORY:
                return 1;
        }
        foreach ($this->sortOptions as $sort => $order) {
            if (!isset($a[$sort]) || !isset($b[$sort])) {
                if (isset($a[$sort])) {
                    return -1;
                }
                if (isset($b[$sort])) {
                    return 1;
                }
                return 0;
            }
            switch ($sort) {
                case 'filename':
                    $result = strcasecmp($a['filename'], $b['filename']);
                    if ($result) {
                        return $order === SORT_DESC ? -$result : $result;
                    }
                    break;
                case 'permissions':
                case 'mode':
                    $a[$sort]&= 07777;
                    $b[$sort]&= 07777;
                default:
                    if ($a[$sort] === $b[$sort]) {
                        break;
                    }
                    return $order === SORT_ASC ? $a[$sort] - $b[$sort] : $b[$sort] - $a[$sort];
            }
        }
    }

_delete_recursive()

phpseclib\Net\SFTP::_delete_recursive	(		$path,
		&	$i
	)

Recursively deletes directories on the SFTP server.

Minimizes directory lookups and SSH_FXP_STATUS requests for speed.

Parameters

string	$path
int	$i

Returns

bool private

Definition at line 2182 of file SFTP.php.

References $filename, $i, $path, phpseclib\Net\SFTP\_list(), phpseclib\Net\SFTP\_read_put_responses(), phpseclib\Net\SFTP\_remove_from_stat_cache(), and phpseclib\Net\SFTP\_send_sftp_packet().

Referenced by phpseclib\Net\SFTP\delete().

    {
        if (!$this->_read_put_responses($i)) {
            return false;
        }
        $i = 0;
        $entries = $this->_list($path, true);

        // normally $entries would have at least . and .. but it might not if the directories
        // permissions didn't allow reading
        if (empty($entries)) {
            return false;
        }

        unset($entries['.'], $entries['..']);
        foreach ($entries as $filename => $props) {
            if (!isset($props['type'])) {
                return false;
            }

            $temp = $path . '/' . $filename;
            if ($props['type'] == NET_SFTP_TYPE_DIRECTORY) {
                if (!$this->_delete_recursive($temp, $i)) {
                    return false;
                }
            } else {
                if (!$this->_send_sftp_packet(NET_SFTP_REMOVE, pack('Na*', strlen($temp), $temp))) {
                    return false;
                }
                $this->_remove_from_stat_cache($temp);

                $i++;

                if ($i >= NET_SFTP_QUEUE_SIZE) {
                    if (!$this->_read_put_responses($i)) {
                        return false;
                    }
                    $i = 0;
                }
            }
        }

        if (!$this->_send_sftp_packet(NET_SFTP_RMDIR, pack('Na*', strlen($path), $path))) {
            return false;
        }
        $this->_remove_from_stat_cache($path);

        $i++;

        if ($i >= NET_SFTP_QUEUE_SIZE) {
            if (!$this->_read_put_responses($i)) {
                return false;
            }
            $i = 0;
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_disconnect()

phpseclib\Net\SFTP::_disconnect

(

$reason

)

Disconnect.

Parameters

int

$reason

Returns

bool private

Definition at line 2839 of file SFTP.php.

References phpseclib\Net\SFTP\pwd().

    {
        $this->pwd = false;
        parent::_disconnect($reason);
    }

Here is the call graph for this function:

_get_lstat_cache_prop()

phpseclib\Net\SFTP::_get_lstat_cache_prop	(		$path,
			$prop
	)

Return an lstat properity.

Uses cache if appropriate.

Parameters

string	$path
string	$prop

Returns

mixed private

Definition at line 2441 of file SFTP.php.

References $path, and phpseclib\Net\SFTP\_get_xstat_cache_prop().

Referenced by phpseclib\Net\SFTP\is_link().

    {
        return $this->_get_xstat_cache_prop($path, $prop, 'lstat');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_get_sftp_packet()

phpseclib\Net\SFTP::_get_sftp_packet

(

)

Receives SFTP Packets.

See '6. General Packet Format' of draft-ietf-secsh-filexfer-13 for more info.

Incidentally, the number of SSH_MSG_CHANNEL_DATA messages has no bearing on the number of SFTP packets present. There can be one SSH_MSG_CHANNEL_DATA messages containing two SFTP packets or there can be two SSH_MSG_CHANNEL_DATA messages containing one SFTP packet.

See also

self::_send_sftp_packet()

Returns

string private

Definition at line 2708 of file SFTP.php.

References phpseclib\Net\SFTP\$packet_type, $start, phpseclib\Net\SSH2\_format_log(), phpseclib\Net\SSH2\_get_channel_packet(), and phpseclib\Net\SSH2\_string_shift().

Referenced by phpseclib\Net\SFTP\_close_handle(), phpseclib\Net\SFTP\_list(), phpseclib\Net\SFTP\_mkdir_helper(), phpseclib\Net\SFTP\_read_put_responses(), phpseclib\Net\SFTP\_realpath(), phpseclib\Net\SFTP\_setstat(), phpseclib\Net\SFTP\_stat(), phpseclib\Net\SFTP\chdir(), phpseclib\Net\SFTP\chmod(), phpseclib\Net\SFTP\delete(), phpseclib\Net\SFTP\get(), phpseclib\Net\SFTP\login(), phpseclib\Net\SFTP\put(), phpseclib\Net\SFTP\readlink(), phpseclib\Net\SFTP\rename(), phpseclib\Net\SFTP\rmdir(), phpseclib\Net\SFTP\symlink(), and phpseclib\Net\SFTP\touch().

    {
        $this->curTimeout = false;

        $start = strtok(microtime(), ' ') + strtok(''); // http://php.net/microtime#61838

        // SFTP packet length
        while (strlen($this->packet_buffer) < 4) {
            $temp = $this->_get_channel_packet(self::CHANNEL);
            if (is_bool($temp)) {
                $this->packet_type = false;
                $this->packet_buffer = '';
                return false;
            }
            $this->packet_buffer.= $temp;
        }
        extract(unpack('Nlength', $this->_string_shift($this->packet_buffer, 4)));
        $tempLength = $length;
        $tempLength-= strlen($this->packet_buffer);

        // SFTP packet type and data payload
        while ($tempLength > 0) {
            $temp = $this->_get_channel_packet(self::CHANNEL);
            if (is_bool($temp)) {
                $this->packet_type = false;
                $this->packet_buffer = '';
                return false;
            }
            $this->packet_buffer.= $temp;
            $tempLength-= strlen($temp);
        }

        $stop = strtok(microtime(), ' ') + strtok('');

        $this->packet_type = ord($this->_string_shift($this->packet_buffer));

        if ($this->request_id !== false) {
            $this->_string_shift($this->packet_buffer, 4); // remove the request id
            $length-= 5; // account for the request id and the packet type
        } else {
            $length-= 1; // account for the packet type
        }

        $packet = $this->_string_shift($this->packet_buffer, $length);

        if (defined('NET_SFTP_LOGGING')) {
            $packet_type = '<- ' . $this->packet_types[$this->packet_type] .
                           ' (' . round($stop - $start, 4) . 's)';
            if (NET_SFTP_LOGGING == NET_SFTP_LOG_REALTIME) {
                echo "<pre>\r\n" . $this->_format_log(array($packet), array($packet_type)) . "\r\n</pre>\r\n";
                flush();
                ob_flush();
            } else {
                $this->packet_type_log[] = $packet_type;
                if (NET_SFTP_LOGGING == NET_SFTP_LOG_COMPLEX) {
                    $this->packet_log[] = $packet;
                }
            }
        }

        return $packet;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_get_stat_cache_prop()

phpseclib\Net\SFTP::_get_stat_cache_prop	(		$path,
			$prop
	)

Return a stat properity.

Uses cache if appropriate.

Parameters

string	$path
string	$prop

Returns

mixed private

Definition at line 2426 of file SFTP.php.

References $path, and phpseclib\Net\SFTP\_get_xstat_cache_prop().

Referenced by phpseclib\Net\SFTP\fileatime(), phpseclib\Net\SFTP\filegroup(), phpseclib\Net\SFTP\filemtime(), phpseclib\Net\SFTP\fileowner(), phpseclib\Net\SFTP\fileperms(), phpseclib\Net\SFTP\filesize(), phpseclib\Net\SFTP\filetype(), phpseclib\Net\SFTP\is_dir(), and phpseclib\Net\SFTP\is_file().

    {
        return $this->_get_xstat_cache_prop($path, $prop, 'stat');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_get_xstat_cache_prop()

phpseclib\Net\SFTP::_get_xstat_cache_prop	(		$path,
			$prop,
			$type
	)

Return a stat or lstat properity.

Uses cache if appropriate.

Parameters

string	$path
string	$prop

Returns

mixed private

Definition at line 2456 of file SFTP.php.

References $path, $result, $type, phpseclib\Net\SFTP\_query_stat_cache(), and phpseclib\Net\SFTP\_realpath().

Referenced by phpseclib\Net\SFTP\_get_lstat_cache_prop(), and phpseclib\Net\SFTP\_get_stat_cache_prop().

    {
        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}[$prop];
            }
        }

        $result = $this->$type($path);

        if ($result === false || !isset($result[$prop])) {
            return false;
        }

        return $result[$prop];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_list()

phpseclib\Net\SFTP::_list	(		$dir,
			$raw = true
	)

Reads a list, be it detailed or not, of files in the given directory.

Parameters

string	$dir
bool	$raw

Returns

mixed private

Definition at line 818 of file SFTP.php.

References $attributes, $i, $response, phpseclib\Net\SFTP\_close_handle(), phpseclib\Net\SFTP\_get_sftp_packet(), phpseclib\Net\SFTP\_logError(), phpseclib\Net\SFTP\_parseAttributes(), phpseclib\Net\SFTP\_parseLongname(), phpseclib\Net\SFTP\_realpath(), phpseclib\Net\SFTP\_send_sftp_packet(), phpseclib\Net\SSH2\_string_shift(), phpseclib\Net\SFTP\_update_stat_cache(), and phpseclib\Net\SSH2\MASK_LOGIN.

Referenced by phpseclib\Net\SFTP\_delete_recursive(), phpseclib\Net\SFTP\_nlist_helper(), phpseclib\Net\SFTP\_setstat_recursive(), and phpseclib\Net\SFTP\rawlist().

    {
        if (!($this->bitmap & SSH2::MASK_LOGIN)) {
            return false;
        }

        $dir = $this->_realpath($dir . '/');
        if ($dir === false) {
            return false;
        }

        // http://tools.ietf.org/html/draft-ietf-secsh-filexfer-13#section-8.1.2
        if (!$this->_send_sftp_packet(NET_SFTP_OPENDIR, pack('Na*', strlen($dir), $dir))) {
            return false;
        }

        $response = $this->_get_sftp_packet();
        switch ($this->packet_type) {
            case NET_SFTP_HANDLE:
                // http://tools.ietf.org/html/draft-ietf-secsh-filexfer-13#section-9.2
                // since 'handle' is the last field in the SSH_FXP_HANDLE packet, we'll just remove the first four bytes that
                // represent the length of the string and leave it at that
                $handle = substr($response, 4);
                break;
            case NET_SFTP_STATUS:
                // presumably SSH_FX_NO_SUCH_FILE or SSH_FX_PERMISSION_DENIED
                $this->_logError($response);
                return false;
            default:
                user_error('Expected SSH_FXP_HANDLE or SSH_FXP_STATUS');
                return false;
        }

        $this->_update_stat_cache($dir, array());

        $contents = array();
        while (true) {
            // http://tools.ietf.org/html/draft-ietf-secsh-filexfer-13#section-8.2.2
            // why multiple SSH_FXP_READDIR packets would be sent when the response to a single one can span arbitrarily many
            // SSH_MSG_CHANNEL_DATA messages is not known to me.
            if (!$this->_send_sftp_packet(NET_SFTP_READDIR, pack('Na*', strlen($handle), $handle))) {
                return false;
            }

            $response = $this->_get_sftp_packet();
            switch ($this->packet_type) {
                case NET_SFTP_NAME:
                    extract(unpack('Ncount', $this->_string_shift($response, 4)));
                    for ($i = 0; $i < $count; $i++) {
                        extract(unpack('Nlength', $this->_string_shift($response, 4)));
                        $shortname = $this->_string_shift($response, $length);
                        extract(unpack('Nlength', $this->_string_shift($response, 4)));
                        $longname = $this->_string_shift($response, $length);
                        $attributes = $this->_parseAttributes($response);
                        if (!isset($attributes['type'])) {
                            $fileType = $this->_parseLongname($longname);
                            if ($fileType) {
                                $attributes['type'] = $fileType;
                            }
                        }
                        $contents[$shortname] = $attributes + array('filename' => $shortname);

                        if (isset($attributes['type']) && $attributes['type'] == NET_SFTP_TYPE_DIRECTORY && ($shortname != '.' && $shortname != '..')) {
                            $this->_update_stat_cache($dir . '/' . $shortname, array());
                        } else {
                            if ($shortname == '..') {
                                $temp = $this->_realpath($dir . '/..') . '/.';
                            } else {
                                $temp = $dir . '/' . $shortname;
                            }
                            $this->_update_stat_cache($temp, (object) array('lstat' => $attributes));
                        }
                        // 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.
                    }
                    break;
                case NET_SFTP_STATUS:
                    extract(unpack('Nstatus', $this->_string_shift($response, 4)));
                    if ($status != NET_SFTP_STATUS_EOF) {
                        $this->_logError($response, $status);
                        return false;
                    }
                    break 2;
                default:
                    user_error('Expected SSH_FXP_NAME or SSH_FXP_STATUS');
                    return false;
            }
        }

        if (!$this->_close_handle($handle)) {
            return false;
        }

        if (count($this->sortOptions)) {
            uasort($contents, array(&$this, '_comparator'));
        }

        return $raw ? $contents : array_keys($contents);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_logError()

phpseclib\Net\SFTP::_logError	(		$response,
			$status = -1
	)

Logs errors.

Parameters

string	$response
int	$status	public

Definition at line 589 of file SFTP.php.

References $response, and phpseclib\Net\SSH2\_string_shift().

Referenced by phpseclib\Net\SFTP\_close_handle(), phpseclib\Net\SFTP\_list(), phpseclib\Net\SFTP\_mkdir_helper(), phpseclib\Net\SFTP\_read_put_responses(), phpseclib\Net\SFTP\_realpath(), phpseclib\Net\SFTP\_setstat(), phpseclib\Net\SFTP\_stat(), phpseclib\Net\SFTP\chdir(), phpseclib\Net\SFTP\chmod(), phpseclib\Net\SFTP\delete(), phpseclib\Net\SFTP\get(), phpseclib\Net\SFTP\put(), phpseclib\Net\SFTP\readlink(), phpseclib\Net\SFTP\rename(), phpseclib\Net\SFTP\rmdir(), phpseclib\Net\SFTP\symlink(), and phpseclib\Net\SFTP\touch().

    {
        if ($status == -1) {
            extract(unpack('Nstatus', $this->_string_shift($response, 4)));
        }

        $error = $this->status_codes[$status];

        if ($this->version > 2) {
            extract(unpack('Nlength', $this->_string_shift($response, 4)));
            $this->sftp_errors[] = $error . ': ' . $this->_string_shift($response, $length);
        } else {
            $this->sftp_errors[] = $error;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_mkdir_helper()

phpseclib\Net\SFTP::_mkdir_helper	(		$dir,
			$attr
	)

Helper function for directory creation.

Parameters

string

$dir

Returns

bool private

Definition at line 1692 of file SFTP.php.

References $response, phpseclib\Net\SFTP\_get_sftp_packet(), phpseclib\Net\SFTP\_logError(), phpseclib\Net\SFTP\_send_sftp_packet(), and phpseclib\Net\SSH2\_string_shift().

Referenced by phpseclib\Net\SFTP\mkdir().

    {
        if (!$this->_send_sftp_packet(NET_SFTP_MKDIR, pack('Na*a*', strlen($dir), $dir, $attr))) {
            return false;
        }

        $response = $this->_get_sftp_packet();
        if ($this->packet_type != NET_SFTP_STATUS) {
            user_error('Expected SSH_FXP_STATUS');
            return false;
        }

        extract(unpack('Nstatus', $this->_string_shift($response, 4)));
        if ($status != NET_SFTP_STATUS_OK) {
            $this->_logError($response, $status);
            return false;
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_nlist_helper()

phpseclib\Net\SFTP::_nlist_helper	(		$dir,
			$recursive,
			$relativeDir
	)

Helper method for nlist.

Parameters

string	$dir
bool	$recursive
string	$relativeDir

Returns

mixed private

Definition at line 749 of file SFTP.php.

References $files, $result, phpseclib\Net\SFTP\_list(), phpseclib\Net\SFTP\_query_stat_cache(), and phpseclib\Net\SFTP\_realpath().

Referenced by phpseclib\Net\SFTP\nlist().

    {
        $files = $this->_list($dir, false);

        if (!$recursive) {
            return $files;
        }

        $result = array();
        foreach ($files as $value) {
            if ($value == '.' || $value == '..') {
                if ($relativeDir == '') {
                    $result[] = $value;
                }
                continue;
            }
            if (is_array($this->_query_stat_cache($this->_realpath($dir . '/' . $value)))) {
                $temp = $this->_nlist_helper($dir . '/' . $value, true, $relativeDir . $value . '/');
                $result = array_merge($result, $temp);
            } else {
                $result[] = $relativeDir . $value;
            }
        }

        return $result;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_parseAttributes()

phpseclib\Net\SFTP::_parseAttributes

(

&

$response

)

Parse Attributes.

See '7. File Attributes' of draft-ietf-secsh-filexfer-13 for more info.

Parameters

string

$response

Returns

array private

Definition at line 2534 of file SFTP.php.

References $i, $key, $response, phpseclib\Net\SFTP\_parseMode(), and phpseclib\Net\SSH2\_string_shift().

Referenced by phpseclib\Net\SFTP\_list(), phpseclib\Net\SFTP\_stat(), and phpseclib\Net\SFTP\chmod().

    {
        $attr = array();
        extract(unpack('Nflags', $this->_string_shift($response, 4)));
        // SFTPv4+ have a type field (a byte) that follows the above flag field
        foreach ($this->attributes as $key => $value) {
            switch ($flags & $key) {
                case NET_SFTP_ATTR_SIZE: // 0x00000001
                    // The size attribute is defined as an unsigned 64-bit integer.
                    // The following will use floats on 32-bit platforms, if necessary.
                    // As can be seen in the BigInteger class, floats are generally
                    // IEEE 754 binary64 "double precision" on such platforms and
                    // as such can represent integers of at least 2^50 without loss
                    // of precision. Interpreted in filesize, 2^50 bytes = 1024 TiB.
                    $attr['size'] = hexdec(bin2hex($this->_string_shift($response, 8)));
                    break;
                case NET_SFTP_ATTR_UIDGID: // 0x00000002 (SFTPv3 only)
                    $attr+= unpack('Nuid/Ngid', $this->_string_shift($response, 8));
                    break;
                case NET_SFTP_ATTR_PERMISSIONS: // 0x00000004
                    $attr+= unpack('Npermissions', $this->_string_shift($response, 4));
                    // mode == permissions; permissions was the original array key and is retained for bc purposes.
                    // mode was added because that's the more industry standard terminology
                    $attr+= array('mode' => $attr['permissions']);
                    $fileType = $this->_parseMode($attr['permissions']);
                    if ($fileType !== false) {
                        $attr+= array('type' => $fileType);
                    }
                    break;
                case NET_SFTP_ATTR_ACCESSTIME: // 0x00000008
                    $attr+= unpack('Natime/Nmtime', $this->_string_shift($response, 8));
                    break;
                case NET_SFTP_ATTR_EXTENDED: // 0x80000000
                    extract(unpack('Ncount', $this->_string_shift($response, 4)));
                    for ($i = 0; $i < $count; $i++) {
                        extract(unpack('Nlength', $this->_string_shift($response, 4)));
                        $key = $this->_string_shift($response, $length);
                        extract(unpack('Nlength', $this->_string_shift($response, 4)));
                        $attr[$key] = $this->_string_shift($response, $length);
                    }
            }
        }
        return $attr;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_parseLongname()

phpseclib\Net\SFTP::_parseLongname

(

$longname

)

Parse Longname.

SFTPv3 doesn't provide any easy way of identifying a file type. You could try to open a file as a directory and see if an error is returned or you could try to parse the SFTPv3-specific longname field of the SSH_FXP_NAME packet. That's what this function does. The result is returned using the SFTPv4 type constants.

If the longname is in an unrecognized format bool(false) is returned.

Parameters

string

$longname

Returns

mixed private

Definition at line 2635 of file SFTP.php.

Referenced by phpseclib\Net\SFTP\_list().

    {
        // http://en.wikipedia.org/wiki/Unix_file_types
        // http://en.wikipedia.org/wiki/Filesystem_permissions#Notation_of_traditional_Unix_permissions
        if (preg_match('#^[^/]([r-][w-][xstST-]){3}#', $longname)) {
            switch ($longname[0]) {
                case '-':
                    return NET_SFTP_TYPE_REGULAR;
                case 'd':
                    return NET_SFTP_TYPE_DIRECTORY;
                case 'l':
                    return NET_SFTP_TYPE_SYMLINK;
                default:
                    return NET_SFTP_TYPE_SPECIAL;
            }
        }

        return false;
    }

Here is the caller graph for this function:

_parseMode()

phpseclib\Net\SFTP::_parseMode

(

$mode

)

Attempt to identify the file type.

Quoting the SFTP RFC, "Implementations MUST NOT send bits that are not defined" but they seem to anyway

Parameters

int

$mode

Returns

int private

Definition at line 2588 of file SFTP.php.

Referenced by phpseclib\Net\SFTP\_parseAttributes().

    {
        // values come from http://lxr.free-electrons.com/source/include/uapi/linux/stat.h#L12
        // see, also, http://linux.die.net/man/2/stat
        switch ($mode & 0170000) {// ie. 1111 0000 0000 0000
            case 0000000: // no file type specified - figure out the file type using alternative means
                return false;
            case 0040000:
                return NET_SFTP_TYPE_DIRECTORY;
            case 0100000:
                return NET_SFTP_TYPE_REGULAR;
            case 0120000:
                return NET_SFTP_TYPE_SYMLINK;
            // new types introduced in SFTPv5+
            // http://tools.ietf.org/html/draft-ietf-secsh-filexfer-05#section-5.2
            case 0010000: // named pipe (fifo)
                return NET_SFTP_TYPE_FIFO;
            case 0020000: // character special
                return NET_SFTP_TYPE_CHAR_DEVICE;
            case 0060000: // block special
                return NET_SFTP_TYPE_BLOCK_DEVICE;
            case 0140000: // socket
                return NET_SFTP_TYPE_SOCKET;
            case 0160000: // whiteout
                // "SPECIAL should be used for files that are of
                //  a known type which cannot be expressed in the protocol"
                return NET_SFTP_TYPE_SPECIAL;
            default:
                return NET_SFTP_TYPE_UNKNOWN;
        }
    }

Here is the caller graph for this function:

_query_stat_cache()

phpseclib\Net\SFTP::_query_stat_cache

(

$path

)

Checks cache for path.

Mainly used by file_exists

Parameters

string

$dir

Returns

mixed private

Definition at line 1118 of file SFTP.php.

References $path, and phpseclib\Net\SFTP\$stat_cache.

Referenced by phpseclib\Net\SFTP\_get_xstat_cache_prop(), phpseclib\Net\SFTP\_nlist_helper(), phpseclib\Net\SFTP\chdir(), phpseclib\Net\SFTP\file_exists(), phpseclib\Net\SFTP\lstat(), phpseclib\Net\SFTP\rawlist(), and phpseclib\Net\SFTP\stat().

    {
        $dirs = explode('/', preg_replace('#^/|/(?=/)|/$#', '', $path));

        $temp = &$this->stat_cache;
        foreach ($dirs as $dir) {
            if (!isset($temp[$dir])) {
                return null;
            }
            $temp = &$temp[$dir];
        }
        return $temp;
    }

Here is the caller graph for this function:

_read_put_responses()

phpseclib\Net\SFTP::_read_put_responses

(

$i

)

Reads multiple successive SSH_FXP_WRITE responses.

Sending an SSH_FXP_WRITE packet and immediately reading its response isn't as efficient as blindly sending out $i SSH_FXP_WRITEs, in succession, and then reading $i responses.

Parameters

int

$i

Returns

bool private

Definition at line 1953 of file SFTP.php.

References $i, $response, phpseclib\Net\SFTP\_get_sftp_packet(), phpseclib\Net\SFTP\_logError(), and phpseclib\Net\SSH2\_string_shift().

Referenced by phpseclib\Net\SFTP\_delete_recursive(), phpseclib\Net\SFTP\_setstat(), phpseclib\Net\SFTP\_setstat_recursive(), phpseclib\Net\SFTP\delete(), and phpseclib\Net\SFTP\put().

    {
        while ($i--) {
            $response = $this->_get_sftp_packet();
            if ($this->packet_type != NET_SFTP_STATUS) {
                user_error('Expected SSH_FXP_STATUS');
                return false;
            }

            extract(unpack('Nstatus', $this->_string_shift($response, 4)));
            if ($status != NET_SFTP_STATUS_OK) {
                $this->_logError($response, $status);
                break;
            }
        }

        return $i < 0;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_realpath()

phpseclib\Net\SFTP::_realpath

(

$path

)

Canonicalize the Server-Side Path Name.

SFTP doesn't provide a mechanism by which the current working directory can be changed, so we'll emulate it. Returns the absolute (canonicalized) path.

See also

self::chdir()

Parameters

string

$path

Returns

mixed private

Definition at line 616 of file SFTP.php.

References $path, $response, phpseclib\Net\SFTP\_get_sftp_packet(), phpseclib\Net\SFTP\_logError(), phpseclib\Net\SFTP\_send_sftp_packet(), phpseclib\Net\SSH2\_string_shift(), and phpseclib\Net\SFTP\pwd().

Referenced by phpseclib\Net\SFTP\_get_xstat_cache_prop(), phpseclib\Net\SFTP\_list(), phpseclib\Net\SFTP\_nlist_helper(), phpseclib\Net\SFTP\_setstat(), phpseclib\Net\SFTP\chdir(), phpseclib\Net\SFTP\delete(), phpseclib\Net\SFTP\file_exists(), phpseclib\Net\SFTP\get(), phpseclib\Net\SFTP\login(), phpseclib\Net\SFTP\lstat(), phpseclib\Net\SFTP\mkdir(), phpseclib\Net\SFTP\put(), phpseclib\Net\SFTP\rawlist(), phpseclib\Net\SFTP\readlink(), phpseclib\Net\SFTP\rename(), phpseclib\Net\SFTP\rmdir(), phpseclib\Net\SFTP\stat(), phpseclib\Net\SFTP\symlink(), and phpseclib\Net\SFTP\touch().

    {
        if ($this->pwd === false) {
            // http://tools.ietf.org/html/draft-ietf-secsh-filexfer-13#section-8.9
            if (!$this->_send_sftp_packet(NET_SFTP_REALPATH, pack('Na*', strlen($path), $path))) {
                return false;
            }

            $response = $this->_get_sftp_packet();
            switch ($this->packet_type) {
                case NET_SFTP_NAME:
                    // although SSH_FXP_NAME is implemented differently in SFTPv3 than it is in SFTPv4+, the following
                    // should work on all SFTP versions since the only part of the SSH_FXP_NAME packet the following looks
                    // at is the first part and that part is defined the same in SFTP versions 3 through 6.
                    $this->_string_shift($response, 4); // skip over the count - it should be 1, anyway
                    extract(unpack('Nlength', $this->_string_shift($response, 4)));
                    return $this->_string_shift($response, $length);
                case NET_SFTP_STATUS:
                    $this->_logError($response);
                    return false;
                default:
                    user_error('Expected SSH_FXP_NAME or SSH_FXP_STATUS');
                    return false;
            }
        }

        if ($path[0] != '/') {
            $path = $this->pwd . '/' . $path;
        }

        $path = explode('/', $path);
        $new = array();
        foreach ($path as $dir) {
            if (!strlen($dir)) {
                continue;
            }
            switch ($dir) {
                case '..':
                    array_pop($new);
                case '.':
                    break;
                default:
                    $new[] = $dir;
            }
        }

        return '/' . implode('/', $new);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_remove_from_stat_cache()

phpseclib\Net\SFTP::_remove_from_stat_cache

(

$path

)

Remove files / directories from cache.

Parameters

string

$path

Returns

bool private

Definition at line 1091 of file SFTP.php.

References $i, $path, and phpseclib\Net\SFTP\$stat_cache.

Referenced by phpseclib\Net\SFTP\_delete_recursive(), phpseclib\Net\SFTP\_setstat(), phpseclib\Net\SFTP\delete(), phpseclib\Net\SFTP\lstat(), phpseclib\Net\SFTP\put(), phpseclib\Net\SFTP\rename(), phpseclib\Net\SFTP\rmdir(), and phpseclib\Net\SFTP\stat().

    {
        $dirs = explode('/', preg_replace('#^/|/(?=/)|/$#', '', $path));

        $temp = &$this->stat_cache;
        $max = count($dirs) - 1;
        foreach ($dirs as $i => $dir) {
            if ($i === $max) {
                unset($temp[$dir]);
                return true;
            }
            if (!isset($temp[$dir])) {
                return false;
            }
            $temp = &$temp[$dir];
        }
    }

Here is the caller graph for this function:

_send_sftp_packet()

phpseclib\Net\SFTP::_send_sftp_packet	(		$type,
			$data
	)

Sends SFTP Packets.

See '6. General Packet Format' of draft-ietf-secsh-filexfer-13 for more info.

Parameters

int	$type
string	$data

See also

self::_get_sftp_packet()

self::_send_channel_packet()

Returns

bool private

Definition at line 2667 of file SFTP.php.

References $data, phpseclib\Net\SFTP\$packet_type, $result, $start, $type, phpseclib\Net\SSH2\_format_log(), and phpseclib\Net\SSH2\_send_channel_packet().

Referenced by phpseclib\Net\SFTP\_close_handle(), phpseclib\Net\SFTP\_delete_recursive(), phpseclib\Net\SFTP\_list(), phpseclib\Net\SFTP\_mkdir_helper(), phpseclib\Net\SFTP\_realpath(), phpseclib\Net\SFTP\_setstat(), phpseclib\Net\SFTP\_setstat_recursive(), phpseclib\Net\SFTP\_stat(), phpseclib\Net\SFTP\chdir(), phpseclib\Net\SFTP\chmod(), phpseclib\Net\SFTP\delete(), phpseclib\Net\SFTP\get(), phpseclib\Net\SFTP\login(), phpseclib\Net\SFTP\put(), phpseclib\Net\SFTP\readlink(), phpseclib\Net\SFTP\rename(), phpseclib\Net\SFTP\rmdir(), phpseclib\Net\SFTP\symlink(), and phpseclib\Net\SFTP\touch().

    {
        $packet = $this->request_id !== false ?
            pack('NCNa*', strlen($data) + 5, $type, $this->request_id, $data) :
            pack('NCa*',  strlen($data) + 1, $type, $data);

        $start = strtok(microtime(), ' ') + strtok(''); // http://php.net/microtime#61838
        $result = $this->_send_channel_packet(self::CHANNEL, $packet);
        $stop = strtok(microtime(), ' ') + strtok('');

        if (defined('NET_SFTP_LOGGING')) {
            $packet_type = '-> ' . $this->packet_types[$type] .
                           ' (' . round($stop - $start, 4) . 's)';
            if (NET_SFTP_LOGGING == NET_SFTP_LOG_REALTIME) {
                echo "<pre>\r\n" . $this->_format_log(array($data), array($packet_type)) . "\r\n</pre>\r\n";
                flush();
                ob_flush();
            } else {
                $this->packet_type_log[] = $packet_type;
                if (NET_SFTP_LOGGING == NET_SFTP_LOG_COMPLEX) {
                    $this->packet_log[] = $data;
                }
            }
        }

        return $result;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_setstat()

phpseclib\Net\SFTP::_setstat	(		$filename,
			$attr,
			$recursive
	)

Sets information about a file.

Parameters

string	$filename
string	$attr
bool	$recursive

Returns

bool private

Definition at line 1450 of file SFTP.php.

References $filename, $i, $response, $result, phpseclib\Net\SFTP\_get_sftp_packet(), phpseclib\Net\SFTP\_logError(), phpseclib\Net\SFTP\_read_put_responses(), phpseclib\Net\SFTP\_realpath(), phpseclib\Net\SFTP\_remove_from_stat_cache(), phpseclib\Net\SFTP\_send_sftp_packet(), phpseclib\Net\SFTP\_setstat_recursive(), phpseclib\Net\SSH2\_string_shift(), and phpseclib\Net\SSH2\MASK_LOGIN.

Referenced by phpseclib\Net\SFTP\_setstat_recursive(), phpseclib\Net\SFTP\chgrp(), phpseclib\Net\SFTP\chmod(), phpseclib\Net\SFTP\chown(), phpseclib\Net\SFTP\touch(), and phpseclib\Net\SFTP\truncate().

    {
        if (!($this->bitmap & SSH2::MASK_LOGIN)) {
            return false;
        }

        $filename = $this->_realpath($filename);
        if ($filename === false) {
            return false;
        }

        $this->_remove_from_stat_cache($filename);

        if ($recursive) {
            $i = 0;
            $result = $this->_setstat_recursive($filename, $attr, $i);
            $this->_read_put_responses($i);
            return $result;
        }

        // SFTPv4+ has an additional byte field - type - that would need to be sent, as well. setting it to
        // SSH_FILEXFER_TYPE_UNKNOWN might work. if not, we'd have to do an SSH_FXP_STAT before doing an SSH_FXP_SETSTAT.
        if (!$this->_send_sftp_packet(NET_SFTP_SETSTAT, pack('Na*a*', strlen($filename), $filename, $attr))) {
            return false;
        }

        /*
         "Because some systems must use separate system calls to set various attributes, it is possible that a failure
          response will be returned, but yet some of the attributes may be have been successfully modified.  If possible,
          servers SHOULD avoid this situation; however, clients MUST be aware that this is possible."

          -- http://tools.ietf.org/html/draft-ietf-secsh-filexfer-13#section-8.6
        */
        $response = $this->_get_sftp_packet();
        if ($this->packet_type != NET_SFTP_STATUS) {
            user_error('Expected SSH_FXP_STATUS');
            return false;
        }

        extract(unpack('Nstatus', $this->_string_shift($response, 4)));
        if ($status != NET_SFTP_STATUS_OK) {
            $this->_logError($response, $status);
            return false;
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_setstat_recursive()

phpseclib\Net\SFTP::_setstat_recursive	(		$path,
			$attr,
		&	$i
	)

Recursively sets information on directories on the SFTP server.

Minimizes directory lookups and SSH_FXP_STATUS requests for speed.

Parameters

string	$path
string	$attr
int	$i

Returns

bool private

Definition at line 1509 of file SFTP.php.

References $filename, $i, $path, phpseclib\Net\SFTP\_list(), phpseclib\Net\SFTP\_read_put_responses(), phpseclib\Net\SFTP\_send_sftp_packet(), and phpseclib\Net\SFTP\_setstat().

Referenced by phpseclib\Net\SFTP\_setstat().

    {
        if (!$this->_read_put_responses($i)) {
            return false;
        }
        $i = 0;
        $entries = $this->_list($path, true);

        if ($entries === false) {
            return $this->_setstat($path, $attr, false);
        }

        // normally $entries would have at least . and .. but it might not if the directories
        // permissions didn't allow reading
        if (empty($entries)) {
            return false;
        }

        unset($entries['.'], $entries['..']);
        foreach ($entries as $filename => $props) {
            if (!isset($props['type'])) {
                return false;
            }

            $temp = $path . '/' . $filename;
            if ($props['type'] == NET_SFTP_TYPE_DIRECTORY) {
                if (!$this->_setstat_recursive($temp, $attr, $i)) {
                    return false;
                }
            } else {
                if (!$this->_send_sftp_packet(NET_SFTP_SETSTAT, pack('Na*a*', strlen($temp), $temp, $attr))) {
                    return false;
                }

                $i++;

                if ($i >= NET_SFTP_QUEUE_SIZE) {
                    if (!$this->_read_put_responses($i)) {
                        return false;
                    }
                    $i = 0;
                }
            }
        }

        if (!$this->_send_sftp_packet(NET_SFTP_SETSTAT, pack('Na*a*', strlen($path), $path, $attr))) {
            return false;
        }

        $i++;

        if ($i >= NET_SFTP_QUEUE_SIZE) {
            if (!$this->_read_put_responses($i)) {
                return false;
            }
            $i = 0;
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_stat()

phpseclib\Net\SFTP::_stat	(		$filename,
			$type
	)

Returns general information about a file or symbolic link.

Determines information without calling ::_realpath(). The second parameter can be either NET_SFTP_STAT or NET_SFTP_LSTAT.

Parameters

string	$filename
int	$type

Returns

mixed private

Definition at line 1265 of file SFTP.php.

References $filename, $response, $type, phpseclib\Net\SFTP\_get_sftp_packet(), phpseclib\Net\SFTP\_logError(), phpseclib\Net\SFTP\_parseAttributes(), and phpseclib\Net\SFTP\_send_sftp_packet().

Referenced by phpseclib\Net\SFTP\lstat(), and phpseclib\Net\SFTP\stat().

    {
        // SFTPv4+ adds an additional 32-bit integer field - flags - to the following:
        $packet = pack('Na*', strlen($filename), $filename);
        if (!$this->_send_sftp_packet($type, $packet)) {
            return false;
        }

        $response = $this->_get_sftp_packet();
        switch ($this->packet_type) {
            case NET_SFTP_ATTRS:
                return $this->_parseAttributes($response);
            case NET_SFTP_STATUS:
                $this->_logError($response);
                return false;
        }

        user_error('Expected SSH_FXP_ATTRS or SSH_FXP_STATUS');
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_update_stat_cache()

phpseclib\Net\SFTP::_update_stat_cache	(		$path,
			$value
	)

Save files / directories to cache.

Parameters

string	$path
mixed	$value	private

Definition at line 1047 of file SFTP.php.

References $i, $path, phpseclib\Net\SFTP\$stat_cache, phpseclib\Net\SFTP\lstat(), and phpseclib\Net\SFTP\stat().

Referenced by phpseclib\Net\SFTP\_list(), phpseclib\Net\SFTP\chdir(), phpseclib\Net\SFTP\login(), phpseclib\Net\SFTP\lstat(), and phpseclib\Net\SFTP\stat().

    {
        if ($this->use_stat_cache === false) {
            return;
        }

        // preg_replace('#^/|/(?=/)|/$#', '', $dir) == str_replace('//', '/', trim($path, '/'))
        $dirs = explode('/', preg_replace('#^/|/(?=/)|/$#', '', $path));

        $temp = &$this->stat_cache;
        $max = count($dirs) - 1;
        foreach ($dirs as $i => $dir) {
            // if $temp is an object that means one of two things.
            //  1. a file was deleted and changed to a directory behind phpseclib's back
            //  2. it's a symlink. when lstat is done it's unclear what it's a symlink to
            if (is_object($temp)) {
                $temp = array();
            }
            if (!isset($temp[$dir])) {
                $temp[$dir] = array();
            }
            if ($i === $max) {
                if (is_object($temp[$dir])) {
                    if (!isset($value->stat) && isset($temp[$dir]->stat)) {
                        $value->stat = $temp[$dir]->stat;
                    }
                    if (!isset($value->lstat) && isset($temp[$dir]->lstat)) {
                        $value->lstat = $temp[$dir]->lstat;
                    }
                }
                $temp[$dir] = $value;
                break;
            }
            $temp = &$temp[$dir];
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

chdir()

phpseclib\Net\SFTP::chdir

(

$dir

)

Changes the current directory.

Parameters

string

$dir

Returns

bool public

Definition at line 672 of file SFTP.php.

References $response, phpseclib\Net\SFTP\_close_handle(), phpseclib\Net\SFTP\_get_sftp_packet(), phpseclib\Net\SFTP\_logError(), phpseclib\Net\SFTP\_query_stat_cache(), phpseclib\Net\SFTP\_realpath(), phpseclib\Net\SFTP\_send_sftp_packet(), phpseclib\Net\SFTP\_update_stat_cache(), phpseclib\Net\SSH2\MASK_LOGIN, and phpseclib\Net\SFTP\pwd().

Referenced by phpseclib\Net\SFTP\lstat(), and phpseclib\Net\SFTP\stat().

    {
        if (!($this->bitmap & SSH2::MASK_LOGIN)) {
            return false;
        }

        // assume current dir if $dir is empty
        if ($dir === '') {
            $dir = './';
        // suffix a slash if needed
        } elseif ($dir[strlen($dir) - 1] != '/') {
            $dir.= '/';
        }

        $dir = $this->_realpath($dir);

        // confirm that $dir is, in fact, a valid directory
        if ($this->use_stat_cache && is_array($this->_query_stat_cache($dir))) {
            $this->pwd = $dir;
            return true;
        }

        // we could do a stat on the alleged $dir to see if it's a directory but that doesn't tell us
        // the currently logged in user has the appropriate permissions or not. maybe you could see if
        // the file's uid / gid match the currently logged in user's uid / gid but how there's no easy
        // way to get those with SFTP

        if (!$this->_send_sftp_packet(NET_SFTP_OPENDIR, pack('Na*', strlen($dir), $dir))) {
            return false;
        }

        // see \phpseclib\Net\SFTP::nlist() for a more thorough explanation of the following
        $response = $this->_get_sftp_packet();
        switch ($this->packet_type) {
            case NET_SFTP_HANDLE:
                $handle = substr($response, 4);
                break;
            case NET_SFTP_STATUS:
                $this->_logError($response);
                return false;
            default:
                user_error('Expected SSH_FXP_HANDLE or SSH_FXP_STATUS');
                return false;
        }

        if (!$this->_close_handle($handle)) {
            return false;
        }

        $this->_update_stat_cache($dir, array());

        $this->pwd = $dir;
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

chgrp()

phpseclib\Net\SFTP::chgrp	(		$filename,
			$gid,
			$recursive = false
	)

Changes file or directory group.

Returns true on success or false on error.

Parameters

string	$filename
int	$gid
bool	$recursive

Returns

bool public

Definition at line 1383 of file SFTP.php.

References $filename, and phpseclib\Net\SFTP\_setstat().

    {
        $attr = pack('N3', NET_SFTP_ATTR_UIDGID, -1, $gid);

        return $this->_setstat($filename, $attr, $recursive);
    }

Here is the call graph for this function:

chmod()

phpseclib\Net\SFTP::chmod	(		$mode,
			$filename,
			$recursive = false
	)

Set permissions on a file.

Returns the new file permissions on success or false on error. If $recursive is true than this just returns true or false.

Parameters

int	$mode
string	$filename
bool	$recursive

Returns

mixed public

Definition at line 1402 of file SFTP.php.

References $filename, $response, phpseclib\Net\SFTP\_get_sftp_packet(), phpseclib\Net\SFTP\_logError(), phpseclib\Net\SFTP\_parseAttributes(), phpseclib\Net\SFTP\_send_sftp_packet(), and phpseclib\Net\SFTP\_setstat().

    {
        if (is_string($mode) && is_int($filename)) {
            $temp = $mode;
            $mode = $filename;
            $filename = $temp;
        }

        $attr = pack('N2', NET_SFTP_ATTR_PERMISSIONS, $mode & 07777);
        if (!$this->_setstat($filename, $attr, $recursive)) {
            return false;
        }
        if ($recursive) {
            return true;
        }

        $filename = $this->_realPath($filename);
        // rather than return what the permissions *should* be, we'll return what they actually are.  this will also
        // tell us if the file actually exists.
        // incidentally, SFTPv4+ adds an additional 32-bit integer field - flags - to the following:
        $packet = pack('Na*', strlen($filename), $filename);
        if (!$this->_send_sftp_packet(NET_SFTP_STAT, $packet)) {
            return false;
        }

        $response = $this->_get_sftp_packet();
        switch ($this->packet_type) {
            case NET_SFTP_ATTRS:
                $attrs = $this->_parseAttributes($response);
                return $attrs['permissions'];
            case NET_SFTP_STATUS:
                $this->_logError($response);
                return false;
        }

        user_error('Expected SSH_FXP_ATTRS or SSH_FXP_STATUS');
        return false;
    }

Here is the call graph for this function:

chown()

phpseclib\Net\SFTP::chown	(		$filename,
			$uid,
			$recursive = false
	)

Changes file or directory owner.

Returns true on success or false on error.

Parameters

string	$filename
int	$uid
bool	$recursive

Returns

bool public

Definition at line 1363 of file SFTP.php.

References $filename, and phpseclib\Net\SFTP\_setstat().

    {
        // quoting from <http://www.kernel.org/doc/man-pages/online/pages/man2/chown.2.html>,
        // "if the owner or group is specified as -1, then that ID is not changed"
        $attr = pack('N3', NET_SFTP_ATTR_UIDGID, $uid, -1);

        return $this->_setstat($filename, $attr, $recursive);
    }

Here is the call graph for this function:

clearStatCache()

phpseclib\Net\SFTP::clearStatCache

(

)

Clear the stat cache.

public

Definition at line 566 of file SFTP.php.

    {
        $this->stat_cache = array();
    }

delete()

phpseclib\Net\SFTP::delete	(		$path,
			$recursive = true
	)

Deletes a file on the SFTP server.

Parameters

string	$path
bool	$recursive

Returns

bool public

Definition at line 2132 of file SFTP.php.

References $i, $path, $response, $result, phpseclib\Net\SFTP\_delete_recursive(), phpseclib\Net\SFTP\_get_sftp_packet(), phpseclib\Net\SFTP\_logError(), phpseclib\Net\SFTP\_read_put_responses(), phpseclib\Net\SFTP\_realpath(), phpseclib\Net\SFTP\_remove_from_stat_cache(), phpseclib\Net\SFTP\_send_sftp_packet(), phpseclib\Net\SSH2\_string_shift(), and phpseclib\Net\SSH2\MASK_LOGIN.

    {
        if (!($this->bitmap & SSH2::MASK_LOGIN)) {
            return false;
        }

        $path = $this->_realpath($path);
        if ($path === false) {
            return false;
        }

        // http://tools.ietf.org/html/draft-ietf-secsh-filexfer-13#section-8.3
        if (!$this->_send_sftp_packet(NET_SFTP_REMOVE, pack('Na*', strlen($path), $path))) {
            return false;
        }

        $response = $this->_get_sftp_packet();
        if ($this->packet_type != NET_SFTP_STATUS) {
            user_error('Expected SSH_FXP_STATUS');
            return false;
        }

        // if $status isn't SSH_FX_OK it's probably SSH_FX_NO_SUCH_FILE or SSH_FX_PERMISSION_DENIED
        extract(unpack('Nstatus', $this->_string_shift($response, 4)));
        if ($status != NET_SFTP_STATUS_OK) {
            $this->_logError($response, $status);
            if (!$recursive) {
                return false;
            }
            $i = 0;
            $result = $this->_delete_recursive($path, $i);
            $this->_read_put_responses($i);
            return $result;
        }

        $this->_remove_from_stat_cache($path);

        return true;
    }

Here is the call graph for this function:

disableStatCache()

phpseclib\Net\SFTP::disableStatCache

(

)

Disable the stat cache.

public

Definition at line 546 of file SFTP.php.

    {
        $this->use_stat_cache = false;
    }

enableStatCache()

phpseclib\Net\SFTP::enableStatCache

(

)

Enable the stat cache.

public

Definition at line 556 of file SFTP.php.

    {
        $this->use_stat_cache = true;
    }

file_exists()

phpseclib\Net\SFTP::file_exists

(

$path

)

Checks whether a file or directory exists.

Parameters

string

$path

Returns

bool public

Definition at line 2248 of file SFTP.php.

References $path, $result, phpseclib\Net\SFTP\_query_stat_cache(), phpseclib\Net\SFTP\_realpath(), and phpseclib\Net\SFTP\stat().

    {
        if ($this->use_stat_cache) {
            $path = $this->_realpath($path);

            $result = $this->_query_stat_cache($path);

            if (isset($result)) {
                // return true if $result is an array or if it's an stdClass object
                return $result !== false;
            }
        }

        return $this->stat($path) !== false;
    }

Here is the call graph for this function:

fileatime()

phpseclib\Net\SFTP::fileatime

(

$path

)

Gets last access time of file.

Parameters

string

$path

Returns

mixed public

Definition at line 2319 of file SFTP.php.

References $path, and phpseclib\Net\SFTP\_get_stat_cache_prop().

    {
        return $this->_get_stat_cache_prop($path, 'atime');
    }

Here is the call graph for this function:

filegroup()

phpseclib\Net\SFTP::filegroup

(

$path

)

Gets file group.

Parameters

string

$path

Returns

mixed public

Definition at line 2367 of file SFTP.php.

References $path, and phpseclib\Net\SFTP\_get_stat_cache_prop().

    {
        return $this->_get_stat_cache_prop($path, 'gid');
    }

Here is the call graph for this function:

filemtime()

phpseclib\Net\SFTP::filemtime

(

$path

)

Gets file modification time.

Parameters

string

$path

Returns

mixed public

Definition at line 2331 of file SFTP.php.

References $path, and phpseclib\Net\SFTP\_get_stat_cache_prop().

    {
        return $this->_get_stat_cache_prop($path, 'mtime');
    }

Here is the call graph for this function:

fileowner()

phpseclib\Net\SFTP::fileowner

(

$path

)

Gets file owner.

Parameters

string

$path

Returns

mixed public

Definition at line 2355 of file SFTP.php.

References $path, and phpseclib\Net\SFTP\_get_stat_cache_prop().

    {
        return $this->_get_stat_cache_prop($path, 'uid');
    }

Here is the call graph for this function:

fileperms()

phpseclib\Net\SFTP::fileperms

(

$path

)

Gets file permissions.

Parameters

string

$path

Returns

mixed public

Definition at line 2343 of file SFTP.php.

References $path, and phpseclib\Net\SFTP\_get_stat_cache_prop().

    {
        return $this->_get_stat_cache_prop($path, 'permissions');
    }

Here is the call graph for this function:

filesize()

phpseclib\Net\SFTP::filesize

(

$path

)

Gets file size.

Parameters

string

$path

Returns

mixed public

Definition at line 2379 of file SFTP.php.

References $path, and phpseclib\Net\SFTP\_get_stat_cache_prop().

    {
        return $this->_get_stat_cache_prop($path, 'size');
    }

Here is the call graph for this function:

filetype()

phpseclib\Net\SFTP::filetype

(

$path

)

Gets file type.

Parameters

string

$path

Returns

mixed public

Definition at line 2391 of file SFTP.php.

References $path, $type, and phpseclib\Net\SFTP\_get_stat_cache_prop().

    {
        $type = $this->_get_stat_cache_prop($path, 'type');
        if ($type === false) {
            return false;
        }

        switch ($type) {
            case NET_SFTP_TYPE_BLOCK_DEVICE:
                return 'block';
            case NET_SFTP_TYPE_CHAR_DEVICE:
                return 'char';
            case NET_SFTP_TYPE_DIRECTORY:
                return 'dir';
            case NET_SFTP_TYPE_FIFO:
                return 'fifo';
            case NET_SFTP_TYPE_REGULAR:
                return 'file';
            case NET_SFTP_TYPE_SYMLINK:
                return 'link';
            default:
                return false;
        }
    }

Here is the call graph for this function:

get()

phpseclib\Net\SFTP::get	(		$remote_file,
			$local_file = false,
			$offset = 0,
			$length = -1
	)

Downloads a file from the SFTP server.

Returns a string containing the contents of $remote_file if $local_file is left undefined or a boolean false if the operation was unsuccessful. If $local_file is defined, returns true or false depending on the success of the operation.

$offset and $length can be used to download files in chunks.

Parameters

string	$remote_file
string	$local_file
int	$offset
int	$length

Returns

mixed public

Definition at line 2018 of file SFTP.php.

References $response, $size, $start, phpseclib\Net\SFTP\_close_handle(), phpseclib\Net\SFTP\_get_sftp_packet(), phpseclib\Net\SFTP\_logError(), phpseclib\Net\SFTP\_realpath(), phpseclib\Net\SFTP\_send_sftp_packet(), and phpseclib\Net\SSH2\MASK_LOGIN.

    {
        if (!($this->bitmap & SSH2::MASK_LOGIN)) {
            return false;
        }

        $remote_file = $this->_realpath($remote_file);
        if ($remote_file === false) {
            return false;
        }

        $packet = pack('Na*N2', strlen($remote_file), $remote_file, NET_SFTP_OPEN_READ, 0);
        if (!$this->_send_sftp_packet(NET_SFTP_OPEN, $packet)) {
            return false;
        }

        $response = $this->_get_sftp_packet();
        switch ($this->packet_type) {
            case NET_SFTP_HANDLE:
                $handle = substr($response, 4);
                break;
            case NET_SFTP_STATUS: // presumably SSH_FX_NO_SUCH_FILE or SSH_FX_PERMISSION_DENIED
                $this->_logError($response);
                return false;
            default:
                user_error('Expected SSH_FXP_HANDLE or SSH_FXP_STATUS');
                return false;
        }

        if (is_resource($local_file)) {
            $fp = $local_file;
            $stat = fstat($fp);
            $res_offset = $stat['size'];
        } else {
            $res_offset = 0;
            if ($local_file !== false) {
                $fp = fopen($local_file, 'wb');
                if (!$fp) {
                    return false;
                }
            } else {
                $content = '';
            }
        }

        $fclose_check = $local_file !== false && !is_resource($local_file);

        $start = $offset;
        $size = $this->max_sftp_packet < $length || $length < 0 ? $this->max_sftp_packet : $length;
        while (true) {
            $packet = pack('Na*N3', strlen($handle), $handle, $offset / 4294967296, $offset, $size);
            if (!$this->_send_sftp_packet(NET_SFTP_READ, $packet)) {
                if ($fclose_check) {
                    fclose($fp);
                }
                return false;
            }

            $response = $this->_get_sftp_packet();
            switch ($this->packet_type) {
                case NET_SFTP_DATA:
                    $temp = substr($response, 4);
                    $offset+= strlen($temp);
                    if ($local_file === false) {
                        $content.= $temp;
                    } else {
                        fputs($fp, $temp);
                    }
                    break;
                case NET_SFTP_STATUS:
                    // could, in theory, return false if !strlen($content) but we'll hold off for the time being
                    $this->_logError($response);
                    break 2;
                default:
                    user_error('Expected SSH_FXP_DATA or SSH_FXP_STATUS');
                    if ($fclose_check) {
                        fclose($fp);
                    }
                    return false;
            }

            if ($length > 0 && $length <= $offset - $start) {
                break;
            }
        }

        if ($length > 0 && $length <= $offset - $start) {
            if ($local_file === false) {
                $content = substr($content, 0, $length);
            } else {
                ftruncate($fp, $length + $res_offset);
            }
        }

        if ($fclose_check) {
            fclose($fp);
        }

        if (!$this->_close_handle($handle)) {
            return false;
        }

        // if $content isn't set that means a file was written to
        return isset($content) ? $content : true;
    }

Here is the call graph for this function:

getLastSFTPError()

phpseclib\Net\SFTP::getLastSFTPError

(

)

Returns the last error.

Returns

string public

Definition at line 2812 of file SFTP.php.

    {
        return count($this->sftp_errors) ? $this->sftp_errors[count($this->sftp_errors) - 1] : '';
    }

getSFTPErrors()

phpseclib\Net\SFTP::getSFTPErrors

(

)

Returns all errors.

Returns

string public

Definition at line 2801 of file SFTP.php.

References phpseclib\Net\SFTP\$sftp_errors.

    {
        return $this->sftp_errors;
    }

getSFTPLog()

phpseclib\Net\SFTP::getSFTPLog

(

)

Returns a log of the packets that have been sent and received.

Returns a string if NET_SFTP_LOGGING == NET_SFTP_LOG_COMPLEX, an array if NET_SFTP_LOGGING == NET_SFTP_LOG_SIMPLE and false if !defined('NET_SFTP_LOGGING')

public

Returns

string or Array

Definition at line 2779 of file SFTP.php.

References phpseclib\Net\SFTP\$packet_type_log, and phpseclib\Net\SSH2\_format_log().

    {
        if (!defined('NET_SFTP_LOGGING')) {
            return false;
        }

        switch (NET_SFTP_LOGGING) {
            case NET_SFTP_LOG_COMPLEX:
                return $this->_format_log($this->packet_log, $this->packet_type_log);
                break;
            //case NET_SFTP_LOG_SIMPLE:
            default:
                return $this->packet_type_log;
        }
    }

Here is the call graph for this function:

getSupportedVersions()

phpseclib\Net\SFTP::getSupportedVersions

(

)

Get supported SFTP versions.

Returns

array public

Definition at line 2823 of file SFTP.php.

    {
        $temp = array('version' => $this->version);
        if (isset($this->extensions['versions'])) {
            $temp['extensions'] = $this->extensions['versions'];
        }
        return $temp;
    }

is_dir()

phpseclib\Net\SFTP::is_dir

(

$path

)

Tells whether the filename is a directory.

Parameters

string

$path

Returns

bool public

Definition at line 2271 of file SFTP.php.

References $path, $result, and phpseclib\Net\SFTP\_get_stat_cache_prop().

    {
        $result = $this->_get_stat_cache_prop($path, 'type');
        if ($result === false) {
            return false;
        }
        return $result === NET_SFTP_TYPE_DIRECTORY;
    }

Here is the call graph for this function:

is_file()

phpseclib\Net\SFTP::is_file

(

$path

)

Tells whether the filename is a regular file.

Parameters

string

$path

Returns

bool public

Definition at line 2287 of file SFTP.php.

References $path, $result, and phpseclib\Net\SFTP\_get_stat_cache_prop().

Referenced by phpseclib\Net\SFTP\put().

    {
        $result = $this->_get_stat_cache_prop($path, 'type');
        if ($result === false) {
            return false;
        }
        return $result === NET_SFTP_TYPE_REGULAR;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

is_link()

phpseclib\Net\SFTP::is_link

(

$path

)

Tells whether the filename is a symbolic link.

Parameters

string

$path

Returns

bool public

Definition at line 2303 of file SFTP.php.

References $path, $result, and phpseclib\Net\SFTP\_get_lstat_cache_prop().

    {
        $result = $this->_get_lstat_cache_prop($path, 'type');
        if ($result === false) {
            return false;
        }
        return $result === NET_SFTP_TYPE_SYMLINK;
    }

Here is the call graph for this function:

login()

phpseclib\Net\SFTP::login

(

$username

)

Login.

Parameters

string	$username
string	$password

Returns

bool public

Definition at line 389 of file SFTP.php.

References $key, $response, phpseclib\Net\SFTP\$version, phpseclib\Net\SSH2\$window_size, phpseclib\Net\SSH2\_get_channel_packet(), phpseclib\Net\SFTP\_get_sftp_packet(), phpseclib\Net\SFTP\_realpath(), phpseclib\Net\SSH2\_send_binary_packet(), phpseclib\Net\SFTP\_send_sftp_packet(), phpseclib\Net\SSH2\_string_shift(), phpseclib\Net\SFTP\_update_stat_cache(), and phpseclib\Net\SFTP\pwd().

    {
        $args = func_get_args();
        if (!call_user_func_array(array(&$this, '_login'), $args)) {
            return false;
        }

        $this->window_size_server_to_client[self::CHANNEL] = $this->window_size;

        $packet = pack(
            'CNa*N3',
            NET_SSH2_MSG_CHANNEL_OPEN,
            strlen('session'),
            'session',
            self::CHANNEL,
            $this->window_size,
            0x4000
        );

        if (!$this->_send_binary_packet($packet)) {
            return false;
        }

        $this->channel_status[self::CHANNEL] = NET_SSH2_MSG_CHANNEL_OPEN;

        $response = $this->_get_channel_packet(self::CHANNEL);
        if ($response === false) {
            return false;
        }

        $packet = pack(
            'CNNa*CNa*',
            NET_SSH2_MSG_CHANNEL_REQUEST,
            $this->server_channels[self::CHANNEL],
            strlen('subsystem'),
            'subsystem',
            1,
            strlen('sftp'),
            'sftp'
        );
        if (!$this->_send_binary_packet($packet)) {
            return false;
        }

        $this->channel_status[self::CHANNEL] = NET_SSH2_MSG_CHANNEL_REQUEST;

        $response = $this->_get_channel_packet(self::CHANNEL);
        if ($response === false) {
            // from PuTTY's psftp.exe
            $command = "test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server\n" .
                       "test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server\n" .
                       "exec sftp-server";
            // we don't do $this->exec($command, false) because exec() operates on a different channel and plus the SSH_MSG_CHANNEL_OPEN that exec() does
            // is redundant
            $packet = pack(
                'CNNa*CNa*',
                NET_SSH2_MSG_CHANNEL_REQUEST,
                $this->server_channels[self::CHANNEL],
                strlen('exec'),
                'exec',
                1,
                strlen($command),
                $command
            );
            if (!$this->_send_binary_packet($packet)) {
                return false;
            }

            $this->channel_status[self::CHANNEL] = NET_SSH2_MSG_CHANNEL_REQUEST;

            $response = $this->_get_channel_packet(self::CHANNEL);
            if ($response === false) {
                return false;
            }
        }

        $this->channel_status[self::CHANNEL] = NET_SSH2_MSG_CHANNEL_DATA;

        if (!$this->_send_sftp_packet(NET_SFTP_INIT, "\0\0\0\3")) {
            return false;
        }

        $response = $this->_get_sftp_packet();
        if ($this->packet_type != NET_SFTP_VERSION) {
            user_error('Expected SSH_FXP_VERSION');
            return false;
        }

        extract(unpack('Nversion', $this->_string_shift($response, 4)));
        $this->version = $version;
        while (!empty($response)) {
            extract(unpack('Nlength', $this->_string_shift($response, 4)));
            $key = $this->_string_shift($response, $length);
            extract(unpack('Nlength', $this->_string_shift($response, 4)));
            $value = $this->_string_shift($response, $length);
            $this->extensions[$key] = $value;
        }

        /*
         SFTPv4+ defines a 'newline' extension.  SFTPv3 seems to have unofficial support for it via 'newline@vandyke.com',
         however, I'm not sure what 'newline@vandyke.com' is supposed to do (the fact that it's unofficial means that it's
         not in the official SFTPv3 specs) and 'newline@vandyke.com' / 'newline' are likely not drop-in substitutes for
         one another due to the fact that 'newline' comes with a SSH_FXF_TEXT bitmask whereas it seems unlikely that
         'newline@vandyke.com' would.
        */
        /*
        if (isset($this->extensions['newline@vandyke.com'])) {
            $this->extensions['newline'] = $this->extensions['newline@vandyke.com'];
            unset($this->extensions['newline@vandyke.com']);
        }
        */

        $this->request_id = 1;

        /*
         A Note on SFTPv4/5/6 support:
         <http://tools.ietf.org/html/draft-ietf-secsh-filexfer-13#section-5.1> states the following:

         "If the client wishes to interoperate with servers that support noncontiguous version
          numbers it SHOULD send '3'"

         Given that the server only sends its version number after the client has already done so, the above
         seems to be suggesting that v3 should be the default version.  This makes sense given that v3 is the
         most popular.

         <http://tools.ietf.org/html/draft-ietf-secsh-filexfer-13#section-5.5> states the following;

         "If the server did not send the "versions" extension, or the version-from-list was not included, the
          server MAY send a status response describing the failure, but MUST then close the channel without
          processing any further requests."

         So what do you do if you have a client whose initial SSH_FXP_INIT packet says it implements v3 and
         a server whose initial SSH_FXP_VERSION reply says it implements v4 and only v4?  If it only implements
         v4, the "versions" extension is likely not going to have been sent so version re-negotiation as discussed
         in draft-ietf-secsh-filexfer-13 would be quite impossible.  As such, what \phpseclib\Net\SFTP would do is close the
         channel and reopen it with a new and updated SSH_FXP_INIT packet.
        */
        switch ($this->version) {
            case 2:
            case 3:
                break;
            default:
                return false;
        }

        $this->pwd = $this->_realpath('.');

        $this->_update_stat_cache($this->pwd, array());

        return true;
    }

Here is the call graph for this function:

lstat()

phpseclib\Net\SFTP::lstat

(

$filename

)

Returns general information about a file or symbolic link.

Returns an array on success and false otherwise.

Parameters

string

$filename

Returns

mixed public

Definition at line 1198 of file SFTP.php.

References $filename, phpseclib\Net\SFTP\$pwd, $result, phpseclib\Net\SFTP\_query_stat_cache(), phpseclib\Net\SFTP\_realpath(), phpseclib\Net\SFTP\_remove_from_stat_cache(), phpseclib\Net\SFTP\_stat(), phpseclib\Net\SFTP\_update_stat_cache(), phpseclib\Net\SFTP\chdir(), phpseclib\Net\SSH2\MASK_LOGIN, and phpseclib\Net\SFTP\pwd().

Referenced by phpseclib\Net\SFTP\_update_stat_cache().

    {
        if (!($this->bitmap & SSH2::MASK_LOGIN)) {
            return false;
        }

        $filename = $this->_realpath($filename);
        if ($filename === false) {
            return false;
        }

        if ($this->use_stat_cache) {
            $result = $this->_query_stat_cache($filename);
            if (is_array($result) && isset($result['.']) && isset($result['.']->lstat)) {
                return $result['.']->lstat;
            }
            if (is_object($result) && isset($result->lstat)) {
                return $result->lstat;
            }
        }

        $lstat = $this->_stat($filename, NET_SFTP_LSTAT);
        if ($lstat === false) {
            $this->_remove_from_stat_cache($filename);
            return false;
        }
        if (isset($lstat['type'])) {
            if ($lstat['type'] == NET_SFTP_TYPE_DIRECTORY) {
                $filename.= '/.';
            }
            $this->_update_stat_cache($filename, (object) array('lstat' => $lstat));
            return $lstat;
        }

        $stat = $this->_stat($filename, NET_SFTP_STAT);

        if ($lstat != $stat) {
            $lstat = array_merge($lstat, array('type' => NET_SFTP_TYPE_SYMLINK));
            $this->_update_stat_cache($filename, (object) array('lstat' => $lstat));
            return $stat;
        }

        $pwd = $this->pwd;
        $lstat['type'] = $this->chdir($filename) ?
            NET_SFTP_TYPE_DIRECTORY :
            NET_SFTP_TYPE_REGULAR;
        $this->pwd = $pwd;

        if ($lstat['type'] == NET_SFTP_TYPE_DIRECTORY) {
            $filename.= '/.';
        }
        $this->_update_stat_cache($filename, (object) array('lstat' => $lstat));

        return $lstat;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

mkdir()

phpseclib\Net\SFTP::mkdir	(		$dir,
			$mode = -1,
			$recursive = false
	)

Creates a directory.

Parameters

string

$dir

Returns

bool public

Definition at line 1657 of file SFTP.php.

References $i, $result, phpseclib\Net\SFTP\_mkdir_helper(), phpseclib\Net\SFTP\_realpath(), and phpseclib\Net\SSH2\MASK_LOGIN.

    {
        if (!($this->bitmap & SSH2::MASK_LOGIN)) {
            return false;
        }

        $dir = $this->_realpath($dir);
        // by not providing any permissions, hopefully the server will use the logged in users umask - their
        // default permissions.
        $attr = $mode == -1 ? "\0\0\0\0" : pack('N2', NET_SFTP_ATTR_PERMISSIONS, $mode & 07777);

        if ($recursive) {
            $dirs = explode('/', preg_replace('#/(?=/)|/$#', '', $dir));
            if (empty($dirs[0])) {
                array_shift($dirs);
                $dirs[0] = '/' . $dirs[0];
            }
            for ($i = 0; $i < count($dirs); $i++) {
                $temp = array_slice($dirs, 0, $i + 1);
                $temp = implode('/', $temp);
                $result = $this->_mkdir_helper($temp, $attr);
            }
            return $result;
        }

        return $this->_mkdir_helper($dir, $attr);
    }

Here is the call graph for this function:

nlist()

phpseclib\Net\SFTP::nlist	(		$dir = '.',
			$recursive = false
	)

Returns a list of files in the given directory.

Parameters

string	$dir
bool	$recursive

Returns

mixed public

Definition at line 735 of file SFTP.php.

References phpseclib\Net\SFTP\_nlist_helper().

    {
        return $this->_nlist_helper($dir, $recursive, '');
    }

Here is the call graph for this function:

put()

phpseclib\Net\SFTP::put	(		$remote_file,
			$data,
			$mode = self::SOURCE_STRING,
			$start = -1,
			$local_start = -1,
			$progressCallback = null
	)

Uploads a file to the SFTP server.

By default, ::put() does not read from the local filesystem. $data is dumped directly into $remote_file. So, for example, if you set $data to 'filename.ext' and then do get(), you will get a file, twelve bytes long, containing 'filename.ext' as its contents.

Setting $mode to self::SOURCE_LOCAL_FILE will change the above behavior. With self::SOURCE_LOCAL_FILE, $remote_file will contain as many bytes as filename.ext does on your local filesystem. If your filename.ext is 1MB then that is how large $remote_file will be, as well.

Setting $mode to self::SOURCE_CALLBACK will use $data as callback function, which gets only one parameter – number of bytes to return, and returns a string if there is some data or null if there is no more data

If $data is a resource then it'll be used as a resource instead.

Currently, only binary mode is supported. As such, if the line endings need to be adjusted, you will need to take care of that, yourself.

$mode can take an additional two parameters - self::RESUME and self::RESUME_START. These are bitwise AND'd with $mode. So if you want to resume upload of a 300mb file on the local file system you'd set $mode to the following:

self::SOURCE_LOCAL_FILE | self::RESUME

If you wanted to simply append the full contents of a local file to the full contents of a remote file you'd replace self::RESUME with self::RESUME_START.

If $mode & (self::RESUME | self::RESUME_START) then self::RESUME_START will be assumed.

$start and $local_start give you more fine grained control over this process and take precident over self::RESUME when they're non-negative. ie. $start could let you write at the end of a file (like self::RESUME) or in the middle of one. $local_start could let you start your reading from the end of a file (like self::RESUME_START) or in the middle of one.

Setting $local_start to > 0 or $mode | self::RESUME_START doesn't do anything unless $mode | self::SOURCE_LOCAL_FILE.

Parameters

string	$remote_file
string | resource	$data
int	$mode
int	$start
int	$local_start
callable | null	$progressCallback

Returns

bool public

Definition at line 1802 of file SFTP.php.

References $data, $i, $response, $size, $start, phpseclib\Net\SFTP\_close_handle(), phpseclib\Net\SFTP\_get_sftp_packet(), phpseclib\Net\SFTP\_logError(), phpseclib\Net\SFTP\_read_put_responses(), phpseclib\Net\SFTP\_realpath(), phpseclib\Net\SFTP\_remove_from_stat_cache(), phpseclib\Net\SFTP\_send_sftp_packet(), phpseclib\Net\SFTP\is_file(), phpseclib\Net\SSH2\MASK_LOGIN, phpseclib\Net\SFTP\size(), and phpseclib\Net\SFTP\SOURCE_LOCAL_FILE.

    {
        if (!($this->bitmap & SSH2::MASK_LOGIN)) {
            return false;
        }

        $remote_file = $this->_realpath($remote_file);
        if ($remote_file === false) {
            return false;
        }

        $this->_remove_from_stat_cache($remote_file);

        $flags = NET_SFTP_OPEN_WRITE | NET_SFTP_OPEN_CREATE;
        // according to the SFTP specs, NET_SFTP_OPEN_APPEND should "force all writes to append data at the end of the file."
        // in practice, it doesn't seem to do that.
        //$flags|= ($mode & self::RESUME) ? NET_SFTP_OPEN_APPEND : NET_SFTP_OPEN_TRUNCATE;

        if ($start >= 0) {
            $offset = $start;
        } elseif ($mode & self::RESUME) {
            // if NET_SFTP_OPEN_APPEND worked as it should _size() wouldn't need to be called
            $size = $this->size($remote_file);
            $offset = $size !== false ? $size : 0;
        } else {
            $offset = 0;
            $flags|= NET_SFTP_OPEN_TRUNCATE;
        }

        $packet = pack('Na*N2', strlen($remote_file), $remote_file, $flags, 0);
        if (!$this->_send_sftp_packet(NET_SFTP_OPEN, $packet)) {
            return false;
        }

        $response = $this->_get_sftp_packet();
        switch ($this->packet_type) {
            case NET_SFTP_HANDLE:
                $handle = substr($response, 4);
                break;
            case NET_SFTP_STATUS:
                $this->_logError($response);
                return false;
            default:
                user_error('Expected SSH_FXP_HANDLE or SSH_FXP_STATUS');
                return false;
        }

        // http://tools.ietf.org/html/draft-ietf-secsh-filexfer-13#section-8.2.3
        $dataCallback = false;
        switch (true) {
            case $mode & self::SOURCE_CALLBACK:
                if (!is_callable($data)) {
                    user_error("\$data should be is_callable() if you specify SOURCE_CALLBACK flag");
                }
                $dataCallback = $data;
                // do nothing
                break;
            case is_resource($data):
                $mode = $mode & ~self::SOURCE_LOCAL_FILE;
                $fp = $data;
                break;
            case $mode & self::SOURCE_LOCAL_FILE:
                if (!is_file($data)) {
                    user_error("$data is not a valid file");
                    return false;
                }
                $fp = @fopen($data, 'rb');
                if (!$fp) {
                    return false;
                }
        }

        if (isset($fp)) {
            $stat = fstat($fp);
            $size = $stat['size'];

            if ($local_start >= 0) {
                fseek($fp, $local_start);
                $size-= $local_start;
            }
        } elseif ($dataCallback) {
            $size = 0;
        } else {
            $size = strlen($data);
        }

        $sent = 0;
        $size = $size < 0 ? ($size & 0x7FFFFFFF) + 0x80000000 : $size;

        $sftp_packet_size = 4096; // PuTTY uses 4096
        // make the SFTP packet be exactly 4096 bytes by including the bytes in the NET_SFTP_WRITE packets "header"
        $sftp_packet_size-= strlen($handle) + 25;
        $i = 0;
        while ($dataCallback || $sent < $size) {
            if ($dataCallback) {
                $temp = call_user_func($dataCallback, $sftp_packet_size);
                if (is_null($temp)) {
                    break;
                }
            } else {
                $temp = isset($fp) ? fread($fp, $sftp_packet_size) : substr($data, $sent, $sftp_packet_size);
            }
            $subtemp = $offset + $sent;
            $packet = pack('Na*N3a*', strlen($handle), $handle, $subtemp / 4294967296, $subtemp, strlen($temp), $temp);
            if (!$this->_send_sftp_packet(NET_SFTP_WRITE, $packet)) {
                if ($mode & self::SOURCE_LOCAL_FILE) {
                    fclose($fp);
                }
                return false;
            }
            $sent+= strlen($temp);
            if (is_callable($progressCallback)) {
                call_user_func($progressCallback, $sent);
            }

            $i++;

            if ($i == NET_SFTP_QUEUE_SIZE) {
                if (!$this->_read_put_responses($i)) {
                    $i = 0;
                    break;
                }
                $i = 0;
            }
        }

        if (!$this->_read_put_responses($i)) {
            if ($mode & self::SOURCE_LOCAL_FILE) {
                fclose($fp);
            }
            $this->_close_handle($handle);
            return false;
        }

        if ($mode & self::SOURCE_LOCAL_FILE) {
            fclose($fp);
        }

        return $this->_close_handle($handle);
    }

Here is the call graph for this function:

pwd()

phpseclib\Net\SFTP::pwd

(

)

Returns the current directory name.

Returns

mixed public

Definition at line 577 of file SFTP.php.

References phpseclib\Net\SFTP\$pwd.

Referenced by phpseclib\Net\SFTP\_disconnect(), phpseclib\Net\SFTP\_realpath(), phpseclib\Net\SFTP\chdir(), phpseclib\Net\SFTP\login(), phpseclib\Net\SFTP\lstat(), and phpseclib\Net\SFTP\stat().

    {
        return $this->pwd;
    }

Here is the caller graph for this function:

rawlist()

phpseclib\Net\SFTP::rawlist	(		$dir = '.',
			$recursive = false
	)

Returns a detailed list of files in the given directory.

Parameters

string	$dir
bool	$recursive

Returns

mixed public

Definition at line 784 of file SFTP.php.

References $files, $key, phpseclib\Net\SFTP\_list(), phpseclib\Net\SFTP\_query_stat_cache(), and phpseclib\Net\SFTP\_realpath().

    {
        $files = $this->_list($dir, true);
        if (!$recursive || $files === false) {
            return $files;
        }

        static $depth = 0;

        foreach ($files as $key => $value) {
            if ($depth != 0 && $key == '..') {
                unset($files[$key]);
                continue;
            }
            if ($key != '.' && $key != '..' && is_array($this->_query_stat_cache($this->_realpath($dir . '/' . $key)))) {
                $depth++;
                $files[$key] = $this->rawlist($dir . '/' . $key, true);
                $depth--;
            } else {
                $files[$key] = (object) $value;
            }
        }

        return $files;
    }

Here is the call graph for this function:

readlink()

phpseclib\Net\SFTP::readlink

(

$link

)

Return the target of a symbolic link.

Parameters

string

$link

Returns

mixed public

Definition at line 1577 of file SFTP.php.

References $response, phpseclib\Net\SFTP\_get_sftp_packet(), phpseclib\Net\SFTP\_logError(), phpseclib\Net\SFTP\_realpath(), phpseclib\Net\SFTP\_send_sftp_packet(), phpseclib\Net\SSH2\_string_shift(), and phpseclib\Net\SSH2\MASK_LOGIN.

    {
        if (!($this->bitmap & SSH2::MASK_LOGIN)) {
            return false;
        }

        $link = $this->_realpath($link);

        if (!$this->_send_sftp_packet(NET_SFTP_READLINK, pack('Na*', strlen($link), $link))) {
            return false;
        }

        $response = $this->_get_sftp_packet();
        switch ($this->packet_type) {
            case NET_SFTP_NAME:
                break;
            case NET_SFTP_STATUS:
                $this->_logError($response);
                return false;
            default:
                user_error('Expected SSH_FXP_NAME or SSH_FXP_STATUS');
                return false;
        }

        extract(unpack('Ncount', $this->_string_shift($response, 4)));
        // the file isn't a symlink
        if (!$count) {
            return false;
        }

        extract(unpack('Nlength', $this->_string_shift($response, 4)));
        return $this->_string_shift($response, $length);
    }

Here is the call graph for this function:

rename()

phpseclib\Net\SFTP::rename	(		$oldname,
			$newname
	)

Renames a file or a directory on the SFTP server.

Parameters

string	$oldname
string	$newname

Returns

bool public

Definition at line 2485 of file SFTP.php.

References $response, phpseclib\Net\SFTP\_get_sftp_packet(), phpseclib\Net\SFTP\_logError(), phpseclib\Net\SFTP\_realpath(), phpseclib\Net\SFTP\_remove_from_stat_cache(), phpseclib\Net\SFTP\_send_sftp_packet(), phpseclib\Net\SSH2\_string_shift(), and phpseclib\Net\SSH2\MASK_LOGIN.

    {
        if (!($this->bitmap & SSH2::MASK_LOGIN)) {
            return false;
        }

        $oldname = $this->_realpath($oldname);
        $newname = $this->_realpath($newname);
        if ($oldname === false || $newname === false) {
            return false;
        }

        // http://tools.ietf.org/html/draft-ietf-secsh-filexfer-13#section-8.3
        $packet = pack('Na*Na*', strlen($oldname), $oldname, strlen($newname), $newname);
        if (!$this->_send_sftp_packet(NET_SFTP_RENAME, $packet)) {
            return false;
        }

        $response = $this->_get_sftp_packet();
        if ($this->packet_type != NET_SFTP_STATUS) {
            user_error('Expected SSH_FXP_STATUS');
            return false;
        }

        // if $status isn't SSH_FX_OK it's probably SSH_FX_NO_SUCH_FILE or SSH_FX_PERMISSION_DENIED
        extract(unpack('Nstatus', $this->_string_shift($response, 4)));
        if ($status != NET_SFTP_STATUS_OK) {
            $this->_logError($response, $status);
            return false;
        }

        // don't move the stat cache entry over since this operation could very well change the
        // atime and mtime attributes
        //$this->_update_stat_cache($newname, $this->_query_stat_cache($oldname));
        $this->_remove_from_stat_cache($oldname);
        $this->_remove_from_stat_cache($newname);

        return true;
    }

Here is the call graph for this function:

rmdir()

phpseclib\Net\SFTP::rmdir

(

$dir

)

Removes a directory.

Parameters

string

$dir

Returns

bool public

Definition at line 1720 of file SFTP.php.

References $response, phpseclib\Net\SFTP\_get_sftp_packet(), phpseclib\Net\SFTP\_logError(), phpseclib\Net\SFTP\_realpath(), phpseclib\Net\SFTP\_remove_from_stat_cache(), phpseclib\Net\SFTP\_send_sftp_packet(), phpseclib\Net\SSH2\_string_shift(), and phpseclib\Net\SSH2\MASK_LOGIN.

    {
        if (!($this->bitmap & SSH2::MASK_LOGIN)) {
            return false;
        }

        $dir = $this->_realpath($dir);
        if ($dir === false) {
            return false;
        }

        if (!$this->_send_sftp_packet(NET_SFTP_RMDIR, pack('Na*', strlen($dir), $dir))) {
            return false;
        }

        $response = $this->_get_sftp_packet();
        if ($this->packet_type != NET_SFTP_STATUS) {
            user_error('Expected SSH_FXP_STATUS');
            return false;
        }

        extract(unpack('Nstatus', $this->_string_shift($response, 4)));
        if ($status != NET_SFTP_STATUS_OK) {
            // presumably SSH_FX_NO_SUCH_FILE or SSH_FX_PERMISSION_DENIED?
            $this->_logError($response, $status);
            return false;
        }

        $this->_remove_from_stat_cache($dir);
        // 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, false);

        return true;
    }

Here is the call graph for this function:

setListOrder()

phpseclib\Net\SFTP::setListOrder

(

)

Defines how nlist() and rawlist() will be sorted - if at all.

If sorting is enabled directories and files will be sorted independently with directories appearing before files in the resultant array that is returned.

Any parameter returned by stat is a valid sort parameter for this function. Filename comparisons are case insensitive.

Examples:

$sftp->setListOrder('filename', SORT_ASC); $sftp->setListOrder('size', SORT_DESC, 'filename', SORT_ASC); $sftp->setListOrder(true); Separates directories from files but doesn't do any sorting beyond that $sftp->setListOrder(); Don't do any sort of sorting

public

Definition at line 1002 of file SFTP.php.

References $i.

    {
        $this->sortOptions = array();
        $args = func_get_args();
        if (empty($args)) {
            return;
        }
        $len = count($args) & 0x7FFFFFFE;
        for ($i = 0; $i < $len; $i+=2) {
            $this->sortOptions[$args[$i]] = $args[$i + 1];
        }
        if (!count($this->sortOptions)) {
            $this->sortOptions = array('bogus' => true);
        }
    }

size()

phpseclib\Net\SFTP::size

(

$filename

)

Returns the file size, in bytes, or false, on failure.

Files larger than 4GB will show up as being exactly 4GB.

Parameters

string

$filename

Returns

mixed public

Definition at line 1027 of file SFTP.php.

References $filename, $result, phpseclib\Net\SSH2\MASK_LOGIN, and phpseclib\Net\SFTP\stat().

Referenced by phpseclib\Net\SFTP\Stream\_stream_open(), phpseclib\Net\SFTP\Stream\_stream_read(), phpseclib\Net\SFTP\Stream\_stream_seek(), phpseclib\Net\SFTP\Stream\_stream_truncate(), phpseclib\Net\SFTP\Stream\_stream_write(), and phpseclib\Net\SFTP\put().

    {
        if (!($this->bitmap & SSH2::MASK_LOGIN)) {
            return false;
        }

        $result = $this->stat($filename);
        if ($result === false) {
            return false;
        }
        return isset($result['size']) ? $result['size'] : -1;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

stat()

phpseclib\Net\SFTP::stat

(

$filename

)

Returns general information about a file.

Returns an array on success and false otherwise.

Parameters

string

$filename

Returns

mixed public

Definition at line 1141 of file SFTP.php.

References $filename, phpseclib\Net\SFTP\$pwd, $result, phpseclib\Net\SFTP\_query_stat_cache(), phpseclib\Net\SFTP\_realpath(), phpseclib\Net\SFTP\_remove_from_stat_cache(), phpseclib\Net\SFTP\_stat(), phpseclib\Net\SFTP\_update_stat_cache(), phpseclib\Net\SFTP\chdir(), phpseclib\Net\SSH2\MASK_LOGIN, and phpseclib\Net\SFTP\pwd().

Referenced by phpseclib\Net\SFTP\_update_stat_cache(), phpseclib\Net\SFTP\file_exists(), and phpseclib\Net\SFTP\size().

    {
        if (!($this->bitmap & SSH2::MASK_LOGIN)) {
            return false;
        }

        $filename = $this->_realpath($filename);
        if ($filename === false) {
            return false;
        }

        if ($this->use_stat_cache) {
            $result = $this->_query_stat_cache($filename);
            if (is_array($result) && isset($result['.']) && isset($result['.']->stat)) {
                return $result['.']->stat;
            }
            if (is_object($result) && isset($result->stat)) {
                return $result->stat;
            }
        }

        $stat = $this->_stat($filename, NET_SFTP_STAT);
        if ($stat === false) {
            $this->_remove_from_stat_cache($filename);
            return false;
        }
        if (isset($stat['type'])) {
            if ($stat['type'] == NET_SFTP_TYPE_DIRECTORY) {
                $filename.= '/.';
            }
            $this->_update_stat_cache($filename, (object) array('stat' => $stat));
            return $stat;
        }

        $pwd = $this->pwd;
        $stat['type'] = $this->chdir($filename) ?
            NET_SFTP_TYPE_DIRECTORY :
            NET_SFTP_TYPE_REGULAR;
        $this->pwd = $pwd;

        if ($stat['type'] == NET_SFTP_TYPE_DIRECTORY) {
            $filename.= '/.';
        }
        $this->_update_stat_cache($filename, (object) array('stat' => $stat));

        return $stat;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

symlink()

phpseclib\Net\SFTP::symlink	(		$target,
			$link
	)

Create a symlink.

symlink() creates a symbolic link to the existing target with the specified name link.

Parameters

string	$target
string	$link

Returns

bool public

Definition at line 1621 of file SFTP.php.

References $response, $target, phpseclib\Net\SFTP\_get_sftp_packet(), phpseclib\Net\SFTP\_logError(), phpseclib\Net\SFTP\_realpath(), phpseclib\Net\SFTP\_send_sftp_packet(), phpseclib\Net\SSH2\_string_shift(), and phpseclib\Net\SSH2\MASK_LOGIN.

    {
        if (!($this->bitmap & SSH2::MASK_LOGIN)) {
            return false;
        }

        $target = $this->_realpath($target);
        $link = $this->_realpath($link);

        $packet = pack('Na*Na*', strlen($target), $target, strlen($link), $link);
        if (!$this->_send_sftp_packet(NET_SFTP_SYMLINK, $packet)) {
            return false;
        }

        $response = $this->_get_sftp_packet();
        if ($this->packet_type != NET_SFTP_STATUS) {
            user_error('Expected SSH_FXP_STATUS');
            return false;
        }

        extract(unpack('Nstatus', $this->_string_shift($response, 4)));
        if ($status != NET_SFTP_STATUS_OK) {
            $this->_logError($response, $status);
            return false;
        }

        return true;
    }

Here is the call graph for this function:

touch()

phpseclib\Net\SFTP::touch	(		$filename,
			$time = null,
			$atime = null
	)

Sets access and modification time of file.

If the file does not exist, it will be created.

Parameters

string	$filename
int	$time
int	$atime

Returns

bool public

Definition at line 1312 of file SFTP.php.

References $filename, $response, $time, phpseclib\Net\SFTP\_close_handle(), phpseclib\Net\SFTP\_get_sftp_packet(), phpseclib\Net\SFTP\_logError(), phpseclib\Net\SFTP\_realpath(), phpseclib\Net\SFTP\_send_sftp_packet(), phpseclib\Net\SFTP\_setstat(), and phpseclib\Net\SSH2\MASK_LOGIN.

    {
        if (!($this->bitmap & SSH2::MASK_LOGIN)) {
            return false;
        }

        $filename = $this->_realpath($filename);
        if ($filename === false) {
            return false;
        }

        if (!isset($time)) {
            $time = time();
        }
        if (!isset($atime)) {
            $atime = $time;
        }

        $flags = NET_SFTP_OPEN_WRITE | NET_SFTP_OPEN_CREATE | NET_SFTP_OPEN_EXCL;
        $attr = pack('N3', NET_SFTP_ATTR_ACCESSTIME, $time, $atime);
        $packet = pack('Na*Na*', strlen($filename), $filename, $flags, $attr);
        if (!$this->_send_sftp_packet(NET_SFTP_OPEN, $packet)) {
            return false;
        }

        $response = $this->_get_sftp_packet();
        switch ($this->packet_type) {
            case NET_SFTP_HANDLE:
                return $this->_close_handle(substr($response, 4));
            case NET_SFTP_STATUS:
                $this->_logError($response);
                break;
            default:
                user_error('Expected SSH_FXP_HANDLE or SSH_FXP_STATUS');
                return false;
        }

        return $this->_setstat($filename, $attr, false);
    }

Here is the call graph for this function:

truncate()

phpseclib\Net\SFTP::truncate	(		$filename,
			$new_size
	)

Truncates a file to a given length.

Parameters

string	$filename
int	$new_size

Returns

bool public

Definition at line 1294 of file SFTP.php.

References $filename, and phpseclib\Net\SFTP\_setstat().

    {
        $attr = pack('N3', NET_SFTP_ATTR_SIZE, $new_size / 4294967296, $new_size); // 4294967296 == 0x100000000 == 1<<32

        return $this->_setstat($filename, $attr, false);
    }

Here is the call graph for this function:

Field Documentation

$extensions

phpseclib\Net\SFTP::$extensions = array()

Definition at line 148 of file SFTP.php.

$max_sftp_packet

phpseclib\Net\SFTP::$max_sftp_packet

Definition at line 219 of file SFTP.php.

$packet_buffer

phpseclib\Net\SFTP::$packet_buffer = ''

Definition at line 139 of file SFTP.php.

$packet_log

phpseclib\Net\SFTP::$packet_log = array()

Definition at line 185 of file SFTP.php.

$packet_type

phpseclib\Net\SFTP::$packet_type = -1

Definition at line 130 of file SFTP.php.

Referenced by phpseclib\Net\SFTP\_get_sftp_packet(), and phpseclib\Net\SFTP\_send_sftp_packet().

$packet_type_log

phpseclib\Net\SFTP::$packet_type_log = array()

Definition at line 176 of file SFTP.php.

Referenced by phpseclib\Net\SFTP\getSFTPLog().

$packet_types

phpseclib\Net\SFTP::$packet_types = array()

Definition at line 97 of file SFTP.php.

$pwd

phpseclib\Net\SFTP::$pwd = false

Definition at line 167 of file SFTP.php.

Referenced by phpseclib\Net\SFTP\lstat(), phpseclib\Net\SFTP\pwd(), and phpseclib\Net\SFTP\stat().

$request_id

phpseclib\Net\SFTP::$request_id = false

Definition at line 118 of file SFTP.php.

$sftp_errors

phpseclib\Net\SFTP::$sftp_errors = array()

Definition at line 195 of file SFTP.php.

Referenced by phpseclib\Net\SFTP\getSFTPErrors().

$sortOptions

phpseclib\Net\SFTP::$sortOptions = array()

Definition at line 239 of file SFTP.php.

$stat_cache

phpseclib\Net\SFTP::$stat_cache = array()

Definition at line 209 of file SFTP.php.

Referenced by phpseclib\Net\SFTP\_query_stat_cache(), phpseclib\Net\SFTP\_remove_from_stat_cache(), and phpseclib\Net\SFTP\_update_stat_cache().

$status_codes

phpseclib\Net\SFTP::$status_codes = array()

Definition at line 106 of file SFTP.php.

$use_stat_cache

phpseclib\Net\SFTP::$use_stat_cache = true

Definition at line 229 of file SFTP.php.

$version

phpseclib\Net\SFTP::$version

Definition at line 157 of file SFTP.php.

Referenced by phpseclib\Net\SFTP\login().

CHANNEL

const phpseclib\Net\SFTP::CHANNEL = 0x100

SFTP channel constant.

::exec() uses 0 and ::read() / write() use 1.

See also

::_send_channel_packet()

::_get_channel_packet() private

Definition at line 60 of file SFTP.php.

RESUME

const phpseclib\Net\SFTP::RESUME = 4

Resumes an upload.

Definition at line 83 of file SFTP.php.

RESUME_START

const phpseclib\Net\SFTP::RESUME_START = 8

Append a local file to an already existing remote file.

Definition at line 87 of file SFTP.php.

SOURCE_CALLBACK

const phpseclib\Net\SFTP::SOURCE_CALLBACK = 16

Reads data from callback: function callback($length) returns string to proceed, null for EOF.

Definition at line 79 of file SFTP.php.

SOURCE_LOCAL_FILE

const phpseclib\Net\SFTP::SOURCE_LOCAL_FILE = 1

#+ public

See also

::put() Reads data from a local file.

Definition at line 69 of file SFTP.php.

Referenced by phpseclib\Net\SFTP\put().

SOURCE_STRING

const phpseclib\Net\SFTP::SOURCE_STRING = 2

Reads data from a string.

Definition at line 74 of file SFTP.php.

Referenced by phpseclib\Net\SFTP\Stream\_stream_write().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/phpseclib/phpseclib/phpseclib/Net/SFTP.php