ó =OXc@€súdZddlmZddlmZddlmZddlZddlZddl Z ddl m Z ddl m Z ddlmZdd lmZmZmZmZmZmZmZmZmZmZdd lmZd e fd „ƒYZdS( s SFTP file object iÿÿÿÿ(twith_statement(thexlify(tdequeN(tDEBUG(t BufferedFile(tlong( t CMD_CLOSEtCMD_READtCMD_DATAt SFTPErrort CMD_WRITEt CMD_STATUSt CMD_FSTATt CMD_ATTRSt CMD_FSETSTATt CMD_EXTENDED(tSFTPAttributestSFTPFilecB€s+eZdZdZddd„Zd„Zd„Zed„Zd„Z d „Z d „Z d „Z d „Z d „Zd„Zd„Zd„Zdd„Zd„Zd„Zd„Zd„Zd„Zdddd„Zed„Zd!d„Zd„Zd„Zd„Zd„Z d„Z!d „Z"RS("sÄ Proxy object for a file on the remote server, in client mode SFTP. Instances of this class may be used as context managers in the same way that built-in Python file objects are. i€triÿÿÿÿcC€s‡tj|ƒ||_||_tj|||ƒt|_t|_t|_i|_ i|_ t j ƒ|_ d|_tƒ|_dS(N(Rt__init__tsftpthandlet _set_modetFalset pipelinedt _prefetchingt_prefetch_donet_prefetch_datat_prefetch_extentst threadingtLockt_prefetch_locktNonet_saved_exceptionRt_reqs(tselfRRtmodetbufsize((s6/usr/lib/python2.7/site-packages/paramiko/sftp_file.pyR3s         cC€s|jdtƒdS(Ntasync(t_closetTrue(R#((s6/usr/lib/python2.7/site-packages/paramiko/sftp_file.pyt__del__AscC€s|jdtƒdS(s! Close the file. R&N(R'R(R#((s6/usr/lib/python2.7/site-packages/paramiko/sftp_file.pytcloseDscC€sÉ|jr dS|jjtdt|jƒƒ|jrI|jj|ƒntj |ƒyB|r|jj t dƒt |jƒn|jjt |jƒWn*tk r«nttjfk rÄnXdS(Ns close(%s)(t_closedRt_logRRRRt_finish_responsesRR*t_async_requestttypeR Rt_requesttEOFErrortIOErrortsocketterror(R#R&((s6/usr/lib/python2.7/site-packages/paramiko/sftp_file.pyR'Js    " cC€s½gt|jjƒƒD]}|d|kr|^q}t|ƒdkrNtS|jdd„ƒ|d\}}|||kr…tS||||krtS|j||||||ƒS(NitkeycS€s|dS(Ni((tx((s6/usr/lib/python2.7/site-packages/paramiko/sftp_file.pytisiÿÿÿÿ(tlistRtvaluestlenRtsortR(t_data_in_prefetch_requests(R#toffsettsizeR6tkt buf_offsettbuf_size((s6/usr/lib/python2.7/site-packages/paramiko/sftp_file.pyR<es8cC€s{g|jjƒD]}||kr|^q}t|ƒdkrDdSt|ƒ}||}|t|j|ƒkrwdS|S(s if a block of data is present in the prefetch buffers, at the given offset, return the offset of the relevant prefetch buffer. otherwise, return None. this guarantees nothing about the number of bytes collected in the prefetch buffer so far. iN(RtkeysR:R tmax(R#R=tiR?tindexR@((s6/usr/lib/python2.7/site-packages/paramiko/sftp_file.pyt_data_in_prefetch_buffersts.  cC€sþxYtr[|j|jƒ}|dk r+Pn|js=|jrAPn|jjƒ|jƒqW|dkrut |_ dS|j |}|j |=|j|}|dkrÃ|| |j |<||}n|t |ƒkrú|||j |j|<|| }n|S(s£ read data out of the prefetch buffer, if possible. if the data isn't in the buffer, return None. otherwise, behaves like a normal read. iN( R(RFt_realposR RR+Rt_read_responset_check_exceptionRRRR:(R#R>R=tprefetchR@((s6/usr/lib/python2.7/site-packages/paramiko/sftp_file.pyt_read_prefetch…s*           cC€s•t||jƒ}|jr=|j|ƒ}|dk r=|Sn|jjt|jt |j ƒt |ƒƒ\}}|t kr‹t dƒ‚n|jƒS(Ns Expected data(tmintMAX_REQUEST_SIZERRKR RR0RRRRGtintRR t get_string(R#R>tdatatttmsg((s6/usr/lib/python2.7/site-packages/paramiko/sftp_file.pyt_read¢s  3 cC€sætt|ƒ|jƒ}|jj|jjtdƒt |j t |j ƒ|| ƒƒ|j s‡t|jƒdkrâ|jjjƒrâxXt|jƒrÞ|jjƒ}|jj|ƒ\}}|tkrŠtdƒ‚qŠqŠWn|S(NidsExpected status(RLR:RMR"tappendRR.R/R R RRRGRtsockt recv_readytpopleftRHR R (R#RPtchunktreqRQRR((s6/usr/lib/python2.7/site-packages/paramiko/sftp_file.pyt_write­s>1 cC€s|jjj|ƒdS(s@ Set a timeout on read/write operations on the underlying socket or ssh `.Channel`. :param float timeout: seconds to wait for a pending read/write operation before raising ``socket.timeout``, or ``None`` for no timeout .. seealso:: `.Channel.settimeout` N(RRUt settimeout(R#ttimeout((s6/usr/lib/python2.7/site-packages/paramiko/sftp_file.pyR[ºs cC€s|jjjƒS(s´ Returns the timeout in seconds (as a `float`) associated with the socket or ssh `.Channel` used for this file. .. seealso:: `.Channel.gettimeout` (RRUt gettimeout(R#((s6/usr/lib/python2.7/site-packages/paramiko/sftp_file.pyR]ÇscC€s|jjj|ƒdS(sö Set blocking or non-blocking mode on the underiying socket or ssh `.Channel`. :param int blocking: 0 to set non-blocking mode; non-0 to set blocking mode. .. seealso:: `.Channel.setblocking` N(RRUt setblocking(R#tblocking((s6/usr/lib/python2.7/site-packages/paramiko/sftp_file.pyR^Ðs cC€stS(sÁ Check if the file supports random access. :return: `True` if the file supports random access. If `False`, :meth:`seek` will raise an exception (R((R#((s6/usr/lib/python2.7/site-packages/paramiko/sftp_file.pytseekableÜsicC€sƒ|jƒ||jkr,||_|_nG||jkrY|j|7_|j|_n|jƒ||_|_tƒ|_dS(N(tflushtSEEK_SETRGt_postSEEK_CURt _get_sizetbytest_rbuffer(R#R=twhence((s6/usr/lib/python2.7/site-packages/paramiko/sftp_file.pytseekæs cC€sF|jjt|jƒ\}}|tkr9tdƒ‚ntj|ƒS(s Retrieve information about this file from the remote system. This is exactly like `.SFTPClient.stat`, except that it operates on an already-open file. :return: an `.SFTPAttributes` object containing attributes about this file. sExpected attributes(RR0R RR R Rt _from_msg(R#RQRR((s6/usr/lib/python2.7/site-packages/paramiko/sftp_file.pytstatñs cC€sU|jjtdt|jƒ|fƒtƒ}||_|jjt|j|ƒdS(sÔ Change the mode (permissions) of this file. The permissions are unix-style and identical to those used by Python's `os.chmod` function. :param int mode: new permissions s chmod(%s, %r)N( RR,RRRRtst_modeR0R(R#R$tattr((s6/usr/lib/python2.7/site-packages/paramiko/sftp_file.pytchmodþs&  cC€sb|jjtdt|jƒ||fƒtƒ}|||_|_|jjt |j|ƒdS(sV Change the owner (``uid``) and group (``gid``) of this file. As with Python's `os.chown` function, you must pass both arguments, so if you only want to change one, use `stat` first to retrieve the current owner and group. :param int uid: new owner's uid :param int gid: new group id schown(%s, %r, %r)N( RR,RRRRtst_uidtst_gidR0R(R#tuidtgidRm((s6/usr/lib/python2.7/site-packages/paramiko/sftp_file.pytchown s ) cC€s…|dkr'tjƒtjƒf}n|jjtdt|jƒ|fƒtƒ}|\|_|_ |jj t |j|ƒdS(sd Set the access and modified times of this file. If ``times`` is ``None``, then the file's access and modified times are set to the current time. Otherwise, ``times`` must be a 2-tuple of numbers, of the form ``(atime, mtime)``, which is used to set the access and modified times, respectively. This bizarre API is mimicked from Python for the sake of consistency -- I apologize. :param tuple times: ``None`` or a tuple of (access time, modified time) in standard internet epoch time (seconds since 01 January 1970 GMT) s utime(%s, %r)N( R ttimeRR,RRRRtst_atimetst_mtimeR0R(R#ttimesRm((s6/usr/lib/python2.7/site-packages/paramiko/sftp_file.pytutimes & cC€sU|jjtdt|jƒ|fƒtƒ}||_|jjt|j|ƒdS(s Change the size of this file. This usually extends or shrinks the size of the file, just like the ``truncate()`` method on Python file objects. :param size: the new size of the file :type size: int or long struncate(%s, %r)N( RR,RRRRtst_sizeR0R(R#R>Rm((s6/usr/lib/python2.7/site-packages/paramiko/sftp_file.pyttruncate.s &  c C€sa|jjtd|j|t|ƒt|ƒ|ƒ\}}|jƒ}|jƒ}|jƒ} | S(s` Ask the server for a hash of a section of this file. This can be used to verify a successful upload or download, or for various rsync-like operations. The file is hashed from ``offset``, for ``length`` bytes. If ``length`` is 0, the remainder of the file is hashed. Thus, if both ``offset`` and ``length`` are zero, the entire file is hashed. Normally, ``block_size`` will be 0 (the default), and this method will return a byte string representing the requested hash (for example, a string of length 16 for MD5, or 20 for SHA-1). If a non-zero ``block_size`` is given, each chunk of the file (from ``offset`` to ``offset + length``) of ``block_size`` bytes is computed as a separate hash. The hash results are all concatenated and returned as a single string. For example, ``check('sha1', 0, 1024, 512)`` will return a string of length 40. The first 20 bytes will be the SHA-1 of the first 512 bytes of the file, and the last 20 bytes will be the SHA-1 of the next 512 bytes. :param str hash_algorithm: the name of the hash algorithm to use (normally ``"sha1"`` or ``"md5"``) :param offset: offset into the file to begin hashing (0 means to start from the beginning) :type offset: int or long :param length: number of bytes to hash (0 means continue to the end of the file) :type length: int or long :param int block_size: number of bytes to hash per result (must not be less than 256; 0 means to compute only one hash of the entire segment) :type block_size: int :return: `str` of bytes representing the hash of each block, concatenated together :raises IOError: if the server doesn't support the "check-file" extension, or possibly doesn't support the hash algorithm requested .. note:: Many (most?) servers don't support this extension yet. .. versionadded:: 1.4 s check-file(RR0RRRtget_textt get_remainder( R#thash_algorithmR=tlengtht block_sizeRQRRtexttalgRP((s6/usr/lib/python2.7/site-packages/paramiko/sftp_file.pytcheck<s 1$   cC€s ||_dS(sÐ Turn on/off the pipelining of write operations to this file. When pipelining is on, paramiko won't wait for the server response after each write operation. Instead, they're collected as they come in. At the first non-write operation (including `.close`), all remaining server responses are collected. This means that if there was an error with one of your later writes, an exception might be thrown from within `.close` instead of `.write`. By default, files are not pipelined. :param bool pipelined: ``True`` if pipelining should be turned on for this file; ``False`` otherwise .. versionadded:: 1.5 N(R(R#R((s6/usr/lib/python2.7/site-packages/paramiko/sftp_file.pyt set_pipelinedtscC€s™|dkr|jƒj}ng}|j}xC||krrt|j||ƒ}|j||fƒ||7}q0Wt|ƒdkr•|j|ƒndS(s Pre-fetch the remaining contents of this file in anticipation of future `.read` calls. If reading the entire file, pre-fetching can dramatically improve the download speed by avoiding roundtrip latency. The file's contents are incrementally buffered in a background thread. The prefetched data is stored in a buffer until read via the `.read` method. Once data has been read, it's removed from the buffer. The data may be read in a random order (using `.seek`); chunks of the buffer that haven't been read will continue to be buffered. :param int file_size: When this is ``None`` (the default), this method calls `stat` to determine the remote file size. In some situations, doing so can cause exceptions or hangs (see `#562 `_); as a workaround, one may call `stat` explicitly and pass its value in via this parameter. .. versionadded:: 1.5.1 .. versionchanged:: 1.16.0 The ``file_size`` parameter was added (with no default value). .. versionchanged:: 1.16.1 The ``file_size`` parameter was made optional for backwards compatibility. iN( R RkRyRGRLRMRTR:t_start_prefetch(R#t file_sizetchunkstnRX((s6/usr/lib/python2.7/site-packages/paramiko/sftp_file.pyRJˆs  cc€sû|jjtdt|jƒ|fƒg}x‡|D]\}}|j|ƒs3|j||ƒrfq3nxI|dkr±t||jƒ}|j ||fƒ||7}||8}qiWq3W|j |ƒx1|D])}|j |dƒ|j |dƒVqÊWdS(s Read a set of blocks from the file by (offset, length). This is more efficient than doing a series of `.seek` and `.read` calls, since the prefetch machinery is used to retrieve all the requested blocks at once. :param chunks: a list of (offset, length) tuples indicating which sections of the file to read :type chunks: list(tuple(long, int)) :return: a list of blocks read, in the same order as in ``chunks`` .. versionadded:: 1.5.4 s readv(%s, %r)iiN( RR,RRRRFR<RLRMRTR„Ritread(R#R†t read_chunksR=R>t chunk_sizeR6((s6/usr/lib/python2.7/site-packages/paramiko/sftp_file.pytreadv°s&!   cC€s y|jƒjSWndSXdS(Ni(RkRy(R#((s6/usr/lib/python2.7/site-packages/paramiko/sftp_file.pyReÖscC€sKt|_t|_tjd|jd|fƒ}|jtƒ|jƒdS(Nttargettargs( R(RRRRtThreadt_prefetch_threadt setDaemontstart(R#R†RQ((s6/usr/lib/python2.7/site-packages/paramiko/sftp_file.pyR„Üs    cC€skxd|D]\\}}|jj|t|jt|ƒt|ƒƒ}|j||f|j|}||_nXdS|tkr^tdƒ‚n|jƒ}xxträ|j c||j krÛ|j |\}}||j |<|j |=t |j ƒdkr×t|_ nPnWdQXqmWdS(Ns Expected datai(R Rt_convert_statust ExceptionR!RR ROR(RRRR:R(R#RQRRR’teRPR=R~((s6/usr/lib/python2.7/site-packages/paramiko/sftp_file.pyt_async_responseìs$         cC€s.|jdk r*|j}d|_|‚ndS(s.if there's a saved exception, raise & clear itN(R!R (R#R6((s6/usr/lib/python2.7/site-packages/paramiko/sftp_file.pyRIs  N(#t__name__t __module__t__doc__RMRR)R*RR'R<RFRKRSRZR[R]R^R`RiRkRnRsRxRzR‚R(RƒR RJR‹ReR„RR–RI(((s6/usr/lib/python2.7/site-packages/paramiko/sftp_file.pyR's<         8  ( &    (R™t __future__RtbinasciiRt collectionsRR3RRttparamiko.commonRt paramiko.fileRtparamiko.py3compatRt paramiko.sftpRRRR R R R R RRtparamiko.sftp_attrRR(((s6/usr/lib/python2.7/site-packages/paramiko/sftp_file.pyts   F