e f @ 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 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$ Gd& d d Z% d' d( Z& e' d) k re& n 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_TIMEOUTFTPNetrc i c @ s e Z d Z d S)ErrorN)__name__
__module__ __qualname__ r r +/opt/alt/python34/lib64/python3.4/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 sH | | _ | | _ | rD | j | | rD | j | | | qD n 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 sc | j d k r_ z- y | j Wn t t f k
r: Yn XWd | j d k r[ | j n Xn d S)N)sockquitOSErrorEOFErrorclose)r argsr r r __exit__~ s z FTP.__exit__i c C s | d k r | | _ n | d k r0 | | _ n | d k rH | | _ n | d k r` | | _ n 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 n | 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 sb | d d d k rX t | j d } | d d d | d | | d } n t | S)N pass PASS z
*> r8 r9 )lenrstriprepr)r sir r r r0 s -z FTP.sanitizec C sy d | k s d | k r' t d n | t } | j d k rY t d | j | n | j j | j | j d S)N
z4an illegal newline character should not be containedr z*put*)
ValueErrorCRLFr. r/ r0 r sendallencoder% )r liner r r putline s
z FTP.putlinec C s3 | j r" t d | j | n | j | d S)Nz*cmd*)r. r/ r0 rG )r rF r r r putcmd s z
FTP.putcmdc C s | j j | j d } t | | j k rD t d | j n | j d k rl t d | j | n | s{ t n | d d t k r | d d } n) | d d t k r | d d } n | S) Nr zgot more than %d bytesz*get* rJ rK )
r+ readlinemaxliner; r r. r/ r0 r rC )r rF r r r getline s z FTP.getlinec C s | j } | d d d k r | d d } xQ | j } | d | } | d d | k r5 | d d d k r5 Pq5 q5 Wn | S)N -rA )rN )r rF codeZnextliner r r getmultiline s zFTP.getmultilinec C s | j } | j r. t d | j | n | d d | _ | d d } | d k ra | S| d k r| t | n | d k r t | n t | d S)
Nz*resp*rO r 12345> rT rV rU )rS r. r/ r0 Zlastrespr r r )r respcr r r r, s z FTP.getrespc C s5 | j } | d d d k r1 t | n | S)z%Expect a response beginning with '2'.Nr rU )r, r
)r rY r r r voidresp s z FTP.voidrespc C sz d t } | j d k r2 t d | j | n | j j | t | j } | d d d k rv t | n | 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*NrO 426225226> r\ r] r^ ) B_CRLFr. r/ r0 r rD MSG_OOBrS r )r rF rY r r r abort s
z FTP.abortc C s | j | | j S)z'Send a command and return the response.)rH 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'.)rH r[ )r rb 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= joinrd )r r r& ZhbytesZpbytesbytesrb r r r sendport s
z FTP.sendportc C s d } | j t j k r! d } n | j t j k r< d } n | d k rW t d n 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 rI zunsupported address familyr zEPRT |)r) r' AF_INETZAF_INET6r r= ri rd )r r r& r) Zfieldsrb r r r sendeprt# s !z FTP.sendeprtc
C s d } d } x t j d d | j t j d t j D] } | \ } } } } } y& t j | | | } | j | WnG t k
r } z' | } | r | j n d } w4 WYd d } ~ Xn XPq4 W| d k r | d k r | q t d n | j d | j d }
| j
j d } | j t j k rK| j | |
} n | j
| |
} | j t k r| j | j n | 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 rm rk rn r r
settimeout)
r errr resr) ZsocktypeprotoZ canonnameZsa_r& r rY 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' rm parse227rc 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 } yq | d k rh | j d | n | j | } | d d k r | j } n | d d k r t | n Wq| j YqXn | j
} | d k r | j d | n | j | } | d d k r.| j } n | d d k rMt | n | j \ } } | j t k r| j
| j n Wd QX| d d d k rt | } n | | 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 rU rT rO 150)r4 rx r' r( r r rc r, r
r! rt Zacceptr ro parse150)
r rb restsizer r& connrY r Zsockaddrr r r ntransfercmdW s<
zFTP.ntransfercmdc C s | j | | d S)z0Like ntransfercmd() but returns only the socket.r )r~ )r rb r{ r r r transfercmd s zFTP.transfercmdc C s | s d } n | s d } n | s- d } n | d k rR | d k rR | d } n | j d | } | d d k r | j d | } n | d d k r | j d | } n | d d
k r t | n | S) zLogin, default anonymous.Z anonymousr rQ z
anonymous@zUSER r rV zPASS zACCT rU > r rQ )rc r
)r r r r rY r r r r s
z FTP.logini c
C s | j d | j | | Y } x' | j | } | s> Pn | | q% Wt d k rt t | t rt | j n Wd QX| 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)rd r Zrecv
_SSLSocket
isinstanceunwrapr[ )r rb callback blocksizer{ r} datar r r
retrbinary s
zFTP.retrbinaryc C sb | d k r t } n | j d } | j | #} | j d d | j } x | j | j d } t | | j k r t d | j n | j d k r t
d t | n | s Pn | d
d t k r | d d } n) | d d d k r| d d
} n | | qT Wt
d k rLt | t
rL| j n Wd QXWd QX| 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 bytesrI z*retr*rA rJ rJ rK rK )
print_linerc r r* r% rL rM r; r r. r/ r= rC r r r r[ )r rb r rY r} fprF r r r retrlines s* z
FTP.retrlinesc
C s | j d | j | | o } x= | j | } | s> Pn | j | | r% | | q% q% Wt d k r t | t r | j n Wd QX| 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)rd r readrD r r r r[ )r rb r r r r{ r} bufr r r
storbinary s
zFTP.storbinaryc
C s | j d | j | } x | j | j d } t | | j k rc t d | j n | sm Pn | d d t k r | d t k r | d d } n | t } n | j | | r" | | q" q" Wt d k r t | t r | j
n Wd QX| 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 bytesrI NrJ rK rK ) rd r rL rM r; r r_ rD r r r r[ )r rb r r r} r r r r storlines s$
z
FTP.storlinesc C s d | } | j | S)zSend new account name.zACCT )rd )r passwordrb 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" rb argfilesr r r nlst* s
zFTP.nlstc G s d } d } | d d rV t | d t d k rV | d d | d } } n x% | D] } | r] | d | } q] q] 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 rK rK rK rK )typer )r r" rb funcr r r r dir3 s ,
zFTP.dirc
c s | r' | j d d j | d n | r: d | } n d } g } | j | | j x | D] } | j t j d \ } } } i } xI | d d j d D]. }
|
j d \ } } } | | | j r r )rc r
)r filenamerY r r r deletee s z
FTP.deletec C s | d k rk y | j d SWq t k
rg } z( | j d d d d k rU n WYd d } ~ Xq Xn | d k r d } n d | } | j | S)
zChange to a directory.z..ZCDUPr NrO 500r re zCWD )rd r r" )r dirnamemsgrb r r r cwdm s
zFTP.cwdc C sM | j d | } | d d d k rI | d d j } t | Sd S)z Retrieve the size of a file.zSIZE NrO Z213)rc stripint)r r rY r> r r r r| z s zFTP.sizec C s0 | j d | } | j d s& d St | S)z+Make a directory, return its full pathname.zMKD 257r )rd
startswithparse257)r r rY r r r mkd s zFTP.mkdc C s | j d | S)zRemove a directory.zRMD )rd )r r r r r rmd s zFTP.rmdc C s, | j d } | j d s" d St | S)z!Return current working directory.ZPWDr r )rd r r )r rY r r r pwd s zFTP.pwdc C s | j d } | j | S)z Quit, and close the connection.ZQUIT)rd r! )r rY r r r r s
zFTP.quitc C sb z/ | j } d | _ | d k r. | j n Wd | j } d | _ | d k r] | j n Xd S)z8Close the connection without assuming anything about it.N)r+ r! r )r r+ r r r r r! s z FTP.closei):r r r
__doc__r. r FTP_PORTr& MAXLINErM r r+ r- r4 r% r r r r# r r1 r3 debugr6 r0 rG rH rN rS r, r[ ra rc rd rk rn rt rx r~ r r r r r r r r r r r r r r| r r r r r! r r r r r K sj
7#
c @ s e Z d Z d Z e j Z d d d d d d d e d d d Z d d d d d d Z d d
Z
d d Z d
d Z d d Z
d d d Z d d Z d S)FTP_TLSa A FTP subclass which adds TLS support to FTP as described
in RFC-4217.
Connect as usual to port 21 implicitly securing the FTP control
connection before authenticating.
Securing the data connection requires user to explicitly ask
for it by calling prot_p() method.
Usage example:
>>> from ftplib import FTP_TLS
>>> ftps = FTP_TLS('ftp.python.org')
>>> ftps.login() # login anonymously previously securing control channel
'230 Guest login ok, access restrictions apply.'
>>> ftps.prot_p() # switch to secure data connection
'200 Protection level set to P'
>>> ftps.retrlines('LIST') # list directory content securely
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.'
>>> ftps.quit()
'221 Goodbye.'
>>>
r Nc
C s | d k r' | d k r' t d n | d k rN | d k rN t d n | | _ | | _ | d k r t j | j d | d | } n | | _ d | _ t j | | | | | | | d S)Nz4context and keyfile arguments are mutually exclusivez5context and certfile arguments are mutually exclusivecertfilekeyfileF)
rB r r sslZ_create_stdlib_context ssl_versioncontext_prot_pr r )
r r r r r r r r r r r r r r s zFTP_TLS.__init__Tc C s? | r) t | j t j r) | j n t j | | | | S)N)r r r SSLSocketauthr r )r r r r Zsecurer r r r s
z
FTP_TLS.loginc C s t | j t j r$ t d n | j t j k rH | j d } n | j d } | j j | j d | j
| _ | j j d d d | j | _
| S)z2Set up secure control connection by using TLS/SSL.zAlready using TLSzAUTH TLSzAUTH SSLserver_hostnamemoder$ r% )r r r r rB r PROTOCOL_SSLv23rd r wrap_socketr r* r% r+ )r rY r r r r s !z FTP_TLS.authc C sI t | j t j s$ t d n | j d } | j j | _ | S)z/Switch back to a clear-text control connection.z
not using TLSZCCC)r r r r rB rd r )r rY r r r ccc s
z FTP_TLS.cccc C s) | j d | j d } d | _ | S)z Set up secure data connection.zPBSZ 0zPROT PT)rd r )r rY r r r prot_p s
zFTP_TLS.prot_pc C s | j d } d | _ | S)z"Set up clear text data connection.zPROT CF)rd r )r rY r r r prot_c s zFTP_TLS.prot_cc C sL t j | | | \ } } | j rB | j j | d | j } n | | f S)Nr )r r~ r r r r )r rb r{ r} r| r r r r~ s
zFTP_TLS.ntransfercmdc C sO d t } | j j | | j } | d d d k rK t | n | S)Ns ABORrO r\ r] r^ > 426225226)r_ r rD rS r )r rF rY r r r ra ! s
z
FTP_TLS.abort)r r r
r r r r r r r r r r r r~ ra r r r r r s
r c C s | d d d k r% t | n t d k r\ d d l } | j d | j | j B a n t j | } | su d St | j d S)zParse the '150' response for a RETR request.
Returns the expected transfer size or None; size is not guaranteed to
be present in the 150 message.
NrO ry r z150 .* \((\d+) bytes\)r ) r
_150_rerecompile
IGNORECASEASCIImatchr group)rY r mr r r rz 0 s rz c C s | d d d k r% t | n t d k rU d d l } | j d | j a n t j | } | sy t | n | j } d j | d d } t | d d >t | d } | | f S)
zParse the '227' response for a PASV request.
Raises error_proto if it does not contain '(h1,h2,h3,h4,p1,p2)'
Return ('host.addr.as.numbers', port#) tuple.NrO Z227r z#(\d+),(\d+),(\d+),(\d+),(\d+),(\d+)re rP r7 )
r
_227_rer r r searchr groupsri r )rY r r Znumbersr r& r r r rv D s "rv c C s | d d d k r% t | n | j d } | d k rO t | n | j d | d } | d k r t | n | | d | | d k r t | n | | d | j | | d } t | d k r t | n | d } t | d } | | f S) zParse the '229' response for an EPSV request.
Raises error_proto if it does not contain '(|||port|)'
Return ('host.addr.as.numbers', port#) tuple.NrO Z229(r )r r7 )r
findr rh r; r )rY Zpeerleftrightpartsr r& r r r rw X s %
rw c C s | d d d k r% t | n | d d d k r? d Sd } d } t | } xg | | k r | | } | d } | d k r | | k s | | d k r Pn | d } n | | } qZ W| S) zParse the '257' response for a MKD or PWD request.
This is a response to a MKD or PWD request: a directory name.
Returns the directoryname in the 257 reply.NrO r r7 z "r r ")r
r; )rY r r? nrZ r r r r n s
r c C s t | d S)z+Default retrlines callback to print a line.N)r/ )rF r r r r s r r Ic C s | s | } n d | } | j | | j | t | j d \ } } | j | | | j d | } | d d d k r t n | j d | } | d d d
k r t n | j | j d S) z+Copy file from one FTP-instance to another.zTYPE ru zSTOR NrO 125ry zRETR > r 150> r r )rd rv rc rk r r[ ) sourceZ
sourcenametargetZ
targetnamer Z
sourcehostZ
sourceportZtreplyZsreplyr r r ftpcp s
r c @ sg e Z d Z d Z d Z d Z d Z d d d Z d d Z d d Z d d
Z
d d Z d S)
r zClass to parse & provide access to 'netrc' format files.
See the netrc(4) man page for information on the file format.
WARNING: This class is obsolete -- use module netrc instead.
Nc C s t j d t d | d k r\ d t j k rM t j j t j d d } q\ t d n i | _ i | _ t
| d } d } xf| j } | s Pn | r | j r | j
| q n" | r t | | j | sP
b
x
m 7