uzf @ s d Z d d l Z d d l Z d d l Z d d l Z d d l m Z d g Z d Z d Z d Z Gd d d e
Z Gd
d d e Z Gd d
d
e Z
Gd d d e Z Gd d d e Z e e e f Z d Z d Z Gd d d Z y d d l Z Wn e k
r'd Z YnB Xe j Z Gd d d e Z e j d e e e e j f Z d a d d Z d a d d Z d d Z! d d Z" d d Z# d! d" d# d$ Z$ d% d& Z% e& d' k re% d S)(aS An FTP client class and some helper functions.
Based on RFC 959: File Transfer Protocol (FTP), by J. Postel and J. Reynolds
Example:
>>> from ftplib import FTP
>>> ftp = FTP('ftp.python.org') # connect to host, default port
>>> ftp.login() # default, i.e.: user anonymous, passwd anonymous@
'230 Guest login ok, access restrictions apply.'
>>> ftp.retrlines('LIST') # list directory contents
total 9
drwxr-xr-x 8 root wheel 1024 Jan 3 1994 .
drwxr-xr-x 8 root wheel 1024 Jan 3 1994 ..
drwxr-xr-x 2 root wheel 1024 Jan 3 1994 bin
drwxr-xr-x 2 root wheel 1024 Jan 3 1994 etc
d-wxrwxr-x 2 ftp wheel 1024 Sep 5 13:43 incoming
drwxr-xr-x 2 root wheel 1024 Nov 17 1993 lib
drwxr-xr-x 6 1094 wheel 1024 Sep 13 19:07 pub
drwxr-xr-x 3 root wheel 1024 Jan 3 1994 usr
-rw-r--r-- 1 root root 312 Aug 1 1994 welcome.msg
'226 Transfer complete.'
>>> ftp.quit()
'221 Goodbye.'
>>>
A nice test that reveals some of the network dialogue would be:
python ftplib.py -d localhost -l -p -l
N)_GLOBAL_DEFAULT_TIMEOUTFTP i c @ s e Z d Z d S)ErrorN)__name__
__module__ __qualname__ r
r
+/opt/alt/python35/lib64/python3.5/ftplib.pyr : s r c @ s e Z d Z d S) error_replyN)r r r r
r
r
r r ; s r c @ s e Z d Z d S)
error_tempN)r r r r
r
r
r r
< s r
c @ s e Z d Z d S)
error_permN)r r r r
r
r
r r = s r c @ s e Z d Z d S) error_protoN)r r r r
r
r
r r > s r z
s
c @ s e Z d Z d Z d Z d Z e Z e Z d Z
d Z d Z d Z
d Z d d d d e d d d Z d d
Z d d Z d d d[ d d d Z d d Z d d Z e Z d d Z d d Z d d Z d d Z d d Z d d Z d d! Z d" d# Z d$ d% Z d& d' Z d( d) Z! d* d+ Z" d, d- Z# d. d/ Z$ d0 d1 Z% d d2 d3 Z& d d4 d5 Z' d d d d6 d7 Z( d8 d d9 d: Z) d d; d< Z* d8 d d d= d> Z+ d d? d@ Z, dA dB Z- dC dD Z. dE dF Z/ d g dG dH Z0 dI dJ Z1 dK dL Z2 dM dN Z3 dO dP Z4 dQ dR Z5 dS dT Z6 dU dV Z7 dW dX Z8 dY dZ Z9 d S)\r ay An FTP client class.
To create a connection, call the class using these arguments:
host, user, passwd, acct, timeout
The first four arguments are all strings, and have default value ''.
timeout must be numeric and defaults to None if not passed,
meaning that no timeout will be set on any ftp socket(s)
If a timeout is passed, then this is now the default timeout for all ftp
socket operations for this instance.
Then use self.connect() with optional host and port argument.
To download a file, use ftp.retrlines('RETR ' + filename),
or ftp.retrbinary() with slightly different arguments.
To upload a file, use ftp.storlines() or ftp.storbinary(),
which have an open file as argument (see their definitions
below for details).
The download/upload functions first issue appropriate TYPE
and PORT or PASV commands.
r Nr zlatin-1c C sB | | _ | | _ | r> | j | | r> | j | | | d S)N)source_addresstimeoutconnectlogin)selfhostuserpasswdacctr r r
r
r __init__q s
z FTP.__init__c C s | S)Nr
)r r
r
r __enter__z s z
FTP.__enter__c G s] | j d k rY z- y | j Wn t t f k
r: Yn XWd | j d k rX | j Xd S)N)sockquitOSErrorEOFErrorclose)r argsr
r
r __exit__~ s z FTP.__exit__i c C s | d k r | | _ | d k r* | | _ | d k r? | | _ | d k rT | | _ t j | j | j f | j d | j | _ | j j | _ | j j d d | j
| _ | j | _
| j
S) aw Connect to host. Arguments are:
- host: hostname to connect to (string, default previous host)
- port: port to connect to (integer, default previous port)
- timeout: the timeout to set against the ftp socket(s)
- source_address: a 2-tuple (host, port) for the socket to bind
to as its source address before connecting.
r r i Nr rencodingi)r portr r socketcreate_connectionr Zfamilyafmakefiler$ filegetrespwelcome)r r r% r r r
r
r r s z FTP.connectc C s) | j r" t d | j | j | j S)z`Get the welcome message from the server.
(this is read and squirreled away by connect())z *welcome*) debuggingprintsanitizer, )r r
r
r
getwelcome s zFTP.getwelcomec C s
| | _ d S)zSet the debugging level.
The required argument level means:
0: no debugging output (default)
1: print commands and responses but not body text etc.
2: also print raw lines read and sent before stripping CR/LFN)r- )r levelr
r
r set_debuglevel s zFTP.set_debuglevelc C s
| | _ d S)zUse passive or active mode for data transfers.
With a false argument, use the normal PORT mode,
With a true argument, use the PASV command.N)
passiveserver)r valr
r
r set_pasv s z FTP.set_pasvc C s_ | d d d k rU t | j d } | d d d | d | | d } t | S)N pass PASS z
*> r7 r8 )lenrstriprepr)r sir
r
r r/ s *z FTP.sanitizec C ss d | k s d | k r$ t d | t } | j d k rS t d | j | | j j | j | j d S)N
z4an illegal newline character should not be containedr z*put*)
ValueErrorCRLFr- r. r/ r sendallencoder$ )r liner
r
r putline s
z FTP.putlinec C s0 | j r t d | j | | j | d S)Nz*cmd*)r- r. r/ rF )r rE r
r
r putcmd s z
FTP.putcmdc C s | j j | j d } t | | j k rA t d | j | j d k rf t d | j | | sr t | d d t k r | d d } n& | d d t k r | d d } | S) Nr zgot more than %d bytesz*get* rI rJ )
r* readlinemaxliner: r r- r. r/ r rB )r rE r
r
r getline s z FTP.getlinec C s | j } | d d d k r | d d } xK | j } | d | } | d d | k r5 | d d d k r5 Pq5 W| S)N -r@ )rM )r rE codeZnextliner
r
r getmultiline s zFTP.getmultilinec C s | j } | j r+ t d | j | | d d | _ | d d } | d k r^ | S| d k rv t | | d k r t | t | d S)
Nz*resp*rN r 12345> rT rS rU )rR r- r. r/ Zlastrespr
r r )r respcr
r
r r+ s z FTP.getrespc C s2 | j } | d d d k r. t | | S)z%Expect a response beginning with '2'.Nr rT )r+ r )r rX r
r
r voidresp s z FTP.voidrespc C st d t } | j d k r/ t d | j | | j j | t | j } | d d d k rp t | | S)
zAbort a file transfer. Uses out-of-band data.
This does not follow the procedure from the RFC to send Telnet
IP and Synch; that doesn't seem to work with the servers I've
tried. Instead, just send the ABOR command as OOB data.s ABORr z *put urgent*NrN 426225226> r] r[ r\ ) B_CRLFr- r. r/ r rC MSG_OOBrR r )r rE rX r
r
r abort s
z FTP.abortc C s | j | | j S)z'Send a command and return the response.)rG r+ )r cmdr
r
r sendcmd s
z FTP.sendcmdc C s | j | | j S)z8Send a command and expect a response beginning with '2'.)rG rZ )r ra r
r
r voidcmd s
z FTP.voidcmdc C sY | j d } t | d t | d g } | | } d d j | } | j | S)zUSend a PORT command with the current host and the given
port number.
. zPORT ,)splitr< joinrc )r r r% ZhbytesZpbytesbytesra r
r
r sendport s
z FTP.sendportc C s d } | j t j k r d } | j t j k r6 d } | d k rN t d d t | | t | d g } d d j | } | j | S)zESend an EPRT command with the current host and the given port number.r r rH zunsupported address familyr zEPRT |)r( r& AF_INETZAF_INET6r r< rh rc )r r r% r( Zfieldsra r
r
r sendeprt# s !z FTP.sendeprtc
C sz d } d } x t j d d | j t j d t j D] } | \ } } } } } y& t j | | | } | j | WnD t k
r } z$ | } | r | j d } w4 WYd d } ~ Xn XPq4 W| d k r | d k r | n t d | j d | j d }
| j
j d } | j t j k rE| j | |
} n | j
| |
} | j t k rv| j | j | S)z3Create a new socket and send a PORT command for it.Nr z!getaddrinfo returns an empty listr )r& Z getaddrinfor( Z SOCK_STREAMZ
AI_PASSIVEZbindr r ZlistenZ getsocknamer rl rj rm r r
settimeout)
r errr resr( ZsocktypeprotoZ canonnameZsa_r% r rX r
r
r makeport0 s6 .
z FTP.makeportc C sa | j t j k r0 t | j d \ } } n' t | j d | j j \ } } | | f S)NPASVZEPSV)r( r& rl parse227rb parse229r Z getpeername)r r r% r
r
r makepasvP s 'z FTP.makepasvc
C s d } | j r | j \ } } t j | | f | j d | j } yh | d k re | j d | | j | } | d d k r | j } | d d k r t | Wqs| j YqsXn | j
} | d k r | j d | | j | } | d d k r | j } | d d k r;t | | j \ } } | j t k rl| j
| j Wd QRX| d d d k rt | } | | f S) a Initiate a transfer over the data connection.
If the transfer is active, send a port command and the
transfer command, and accept the connection. If the server is
passive, send a pasv command, connect to it, and start the
transfer command. Either way, return the socket for the
connection and the expected size of the transfer. The
expected size may be None if it could not be determined.
Optional `rest' argument can be a string that is sent as the
argument to a REST command. This is essentially a server
marker used to tell the server to skip over any data up to the
given marker.
Nr zREST %sr rT rS rN 150)r3 rw r& r' r r rb r+ r r rs Zacceptr rn parse150)
r ra restsizer r% connrX r Zsockaddrr
r
r ntransfercmdW s<
zFTP.ntransfercmdc C s | j | | d S)z0Like ntransfercmd() but returns only the socket.r )r} )r ra rz r
r
r transfercmd s zFTP.transfercmdc C s | s d } | s d } | s$ d } | d k rF | d k rF | d } | j d | } | d d k r| | j d | } | d d k r | j d | } | d d
k r t | | S) zLogin, default anonymous.Z anonymousr rP z
anonymous@zUSER r rU zPASS zACCT rT > r rP )rb r )r r r r rX r
r
r r s
z FTP.logini c
C s | j d | j | | S } x$ | j | } | s; P| | q% Wt d k rn t | t rn | j Wd QRX| j S)a Retrieve data in binary mode. A new port is created for you.
Args:
cmd: A RETR command.
callback: A single parameter callable to be called on each
block of data read.
blocksize: The maximum number of bytes to read from the
socket at one time. [default: 8192]
rest: Passed to transfercmd(). [default: None]
Returns:
The response code.
zTYPE IN)rc r~ Zrecv
_SSLSocket
isinstanceunwraprZ )r ra callback blocksizerz r| datar
r
r
retrbinary s
zFTP.retrbinaryc C sR | d k r t } | j d } | j | } | j d d | j } x | j | j d } t | | j k r t d | j | j d k r t
d t | | s P| d
d t k r | d d } n& | d d d k r| d d
} | | qQ Wt
d k r:t | t
r:| j Wd QRXWd QRX| j S)ah Retrieve data in line mode. A new port is created for you.
Args:
cmd: A RETR, LIST, or NLST command.
callback: An optional single parameter callable that is called
for each line with the trailing CRLF stripped.
[default: print_line()]
Returns:
The response code.
NzTYPE Ar# r$ r zgot more than %d bytesrH z*retr*r@ rI rI rJ rJ )
print_linerb r~ r) r$ rK rL r: r r- r. r< rB r r r rZ )r ra r rX r| fprE r
r
r retrlines s* z
FTP.retrlinesc
C s | j d | j | | f } x7 | j | } | s; P| j | | r% | | q% Wt d k r t | t r | j Wd QRX| j S)a9 Store a file in binary mode. A new port is created for you.
Args:
cmd: A STOR command.
fp: A file-like object with a read(num_bytes) method.
blocksize: The maximum data size to read from fp and send over
the connection at once. [default: 8192]
callback: An optional single parameter callable that is called on
each block of data after it is sent. [default: None]
rest: Passed to transfercmd(). [default: None]
Returns:
The response code.
zTYPE IN)rc r~ readrC r r r rZ )r ra r r r rz r| bufr
r
r
storbinary s
zFTP.storbinaryc
C s | j d | j | } x | j | j d } t | | j k r` t d | j | sg P| d d t k r | d t k r | d d } | t } | j | | r" | | q" Wt d k r t | t r | j
Wd QRX| j S) ah Store a file in line mode. A new port is created for you.
Args:
cmd: A STOR command.
fp: A file-like object with a readline() method.
callback: An optional single parameter callable that is called on
each line after it is sent. [default: None]
Returns:
The response code.
zTYPE Ar zgot more than %d bytesrH NrI rJ rJ ) rc r~ rK rL r: r r^ rC r r r rZ )r ra r r r| r r
r
r storlines s$
z
FTP.storlinesc C s d | } | j | S)zSend new account name.zACCT )rc )r Zpasswordra r
r
r r % s
zFTP.acctc G sB d } x | D] } | d | } q
Wg } | j | | j | S)zBReturn a list of files in a given directory (default the current).ZNLST )r append)r r! ra argfilesr
r
r nlst* s
zFTP.nlstc G s d } d } | d d rS t | d t d k rS | d d | d } } x" | D] } | rZ | d | } qZ W| j | | d S)
a List a directory in long form.
By default list current directory to stdout.
Optional last argument is callback function; all
non-empty arguments before it are concatenated to the
LIST command. (This *should* only be used for a pathname.)ZLISTNr r r rJ rJ rJ rJ )typer )r r! ra funcr r
r
r dir3 s ,
zFTP.dirc
c s | r$ | j d d j | d | r7 d | } n d } g } | j | | j x | D] } | j t j d \ } } } i } xI | d d j d D]. }
|
j d \ } } } | | | j