o
0i @ sN d Z ddlZddlZddlmZ g dZdZdZdZG dd d eZ G d
d d e Z
G d d
d
e Z G dd de Z G dd de Z
e eefZdZdZG dd dZzddlZW n eyc dZY nw ejZG dd deZed e eeejfZdadd Z da dd Z d d Z d d Z d d! Z!d)d$d%Z"d&d' Z#e$d(kre# dS dS )*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_TIMEOUT)FTP error_reply
error_temp
error_perm error_proto
all_errors c @ e Zd ZdS )ErrorN__name__
__module__ __qualname__ r r -/opt/alt/python310/lib64/python3.10/ftplib.pyr
9 r
c @ r )r Nr r r r r r : r r c @ r )r Nr r r r r r ; r r c @ r )r Nr r r r r r < r r c @ r )r Nr r r r r r = r r
s
c @ s e Zd ZdZdZdZeZeZ dZ
dZ dZ dZ
dZddddedfddd d
Zd d Zd
d Zd]ddZdd Zdd ZeZdd Zdd Zdd Zd d Zd d Zd d! Z d"d# Z d$d% Z d&d' Z d(d) Z d*d+ Z!d,d- Z"d.d/ Z#d0d1 Z$d2d3 Z%d^d4d5Z&d^d6d7Z'd_d8d9Z(d`d;d<Z)d^d=d>Z*dad?d@Z+d^dAdBZ,dCdD Z-dEdF Z.dGdH Z/dg fdIdJZ0dKdL Z1dMdN Z2dOdP Z3dQdR Z4dSdT Z5dUdV Z6dWdX Z7dYdZ Z8d[d\ Z9dS )br u An FTP client class.
To create a connection, call the class using these arguments:
host, user, passwd, acct, timeout, source_address, encoding
The first four arguments are all strings, and have default value ''.
The parameter ´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.
The last parameter is the encoding of filenames, which defaults to utf-8.
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 NTFutf-8encodingc C s> || _ || _|| _|r| | |r | ||| dS dS dS )zInitialization method (called by class instantiation).
Initialize host to localhost, port to standard ftp port.
Optional arguments are host (for connect()),
and user, passwd, acct (for login()).
N)r source_addresstimeoutconnectlogin)selfhostuserpasswdacctr r r r r r __init__m s
z FTP.__init__c C s | S Nr r r r r __enter__} s z
FTP.__enter__c G sf | j d ur1z z| W n ttfy Y nw W | j d ur$| d S d S | j d ur0| w w d S r$ )sockquitOSErrorEOFErrorclose)r argsr r r __exit__ s
z FTP.__exit__c C s |dkr|| _ |dkr|| _|dkr|| _| jdur!| js!td|dur(|| _td| | j | j tj| j | jf| j| jd| _ | j j
| _ | j j d| j
d | _| | _| jS )
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 r. Nz0Non-blocking socket (timeout=0) is not supportedzftplib.connectr rr )r portr
ValueErrorr sysauditsocketcreate_connectionr' familyafmakefiler filegetrespwelcome)r r r1 r r r r r r s$
z FTP.connectc C s | j r td| | j | jS )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
|| _ dS )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 rA )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 sJ |d d dv r!t |d}|d d d|d ||d }t|S )N > zpass PASS r *)lenrstriprepr)r sir r r r? s $z FTP.sanitizec C s` d|v sd|v r t dtd| | |t }| jdkr$td| | | j| | j
d S )N
z4an illegal newline character should not be containedzftplib.sendcmdr z*put*) r2 r3 r4 CRLFr= r> r? r' sendallencoder r liner r r putline s
z FTP.putlinec C s$ | j r td| | | | d S )Nz*cmd*)r= r> r? rV rT r r r putcmd s z
FTP.putcmdc C s | j | jd }t|| jkrtd| j | jdkr$td| | |s(t|dd t kr8|d d }|S |dd t v rF|d d }|S )Nr got more than %d bytesz*get*)
r: readlinemaxlinerJ r
r= r> r? r* rQ rT r r r getline s
z FTP.getlinec C sf | }|dd dkr1|d d } | }|d| }|d d |kr0|dd dkr0 |S q|S )N -r rP )r] )r rU codeZnextliner r r getmultiline s zFTP.getmultilinec C sl | }| jrtd| | |d d | _|d d }|dv r"|S |dkr*t||dkr2t|t|)Nz*resp*r^ r > 21345)rb r= r> r? Zlastrespr r r )r respcr r r r; s z FTP.getrespc C s$ | }|dd dkrt||S )z%Expect a response beginning with '2'.Nr rc )r; r r rh r r r voidresp s z FTP.voidrespc C sT dt }| jdkrtd| | | j|t | }|dd dvr(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. ABORr z *put urgent*Nr^ Z225Z226Z426) B_CRLFr= r> r? r' rR MSG_OOBrb r r rU rh r r r abort s
z FTP.abortc C | | | S )z'Send a command and return the response.)rW r; r cmdr r r sendcmd
z FTP.sendcmdc C rr )z8Send a command and expect a response beginning with '2'.)rW rk rs r r r voidcmd rv z FTP.voidcmdc C sB | d}t|d t|d g}|| }dd| }| |S )zUSend a PORT command with the current host and the given
port number.
. zPORT ,)splitrL joinrw )r r r1 ZhbytesZpbytesbytesrt r r r sendport s
z FTP.sendportc C sb d}| j tjkr
d}| j tjkrd}|dkrtddt||t|dg}dd| }| |S )zESend an EPRT command with the current host and the given port number.r r zunsupported address familyr zEPRT |)r8 r5 AF_INETZAF_INET6r rL r| rw )r r r1 r8 Zfieldsrt r r r sendeprt* s
z FTP.sendeprtc C sl t jd| jdd}| d }| j d }| jt jkr#| ||}n| ||}| jt ur4|
| j |S )z3Create a new socket and send a PORT command for it.)r r r )r7 Zbacklogr ) r5 Z
create_serverr8 Z getsocknamer' r r~ r r r
settimeout)r r' r1 r rh r r r makeport7 s
z FTP.makeportc C sh | j tjkr#t| d\}}| jr|}||fS | j d }||fS t| d| j \}}||fS )z (address, port)PASVr ZEPSV) r8 r5 r parse227ru trust_server_pasv_ipv4_addressr' Z getpeernameparse229)r Zuntrusted_hostr1 r r r r makepasvD s z FTP.makepasvc
C s> d}| j rF| \}}tj||f| j| jd}z&|dur#| d| | |}|d dkr2| }|d dkr r r` z
anonymous@zUSER r re rH ACCT rc ru r )r r r! r" rh r r r r s z FTP.loginr c C s | d | ||:} ||}|sn|| q
tdur1t|tr;| W d | S W d | S W d | S 1 sHw Y | 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.
TYPE Ir N)rw r Zrecv
_SSLSocket
isinstanceunwraprk )r rt callback blocksizer r datar r r
retrbinary s(
zFTP.retrbinaryc C s< |du rt }| d}| |}|jd| jd]} || jd }t|| jkr1td| j | j dkr=t
dt | |s@n"|d d t krO|dd }n|d
d d kr]|dd
}|| qt
durot|t
ro| W d n1 syw Y W d | S W d | S 1 sw Y | 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.
NTYPE Ar0 r r rX r z*retr*rY rZ rP )
print_lineru r r9 r r[ r\ rJ r
r= r> rL rQ r r r rk )r rt r rh r fprU r r r retrlines s<
( z
FTP.retrlinesc C s | d | ||A} ||}|sn || |r || q
tdur8t|trB| W d | S W d | S W d | S 1 sOw Y | 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.
r r N)rw r readrR r r r rk )r rt r r r r r bufr r r
storbinary s,
zFTP.storbinaryc C s | d | |j} || jd }t|| jkr"td| j |s%n$|dd tkr=|d tv r9|dd }|t }|| |rH|| q tdur`t |trj|
W d | S W d | S W d | S 1 sww Y | 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.
r r rX rY NrZ ) rw r r[ r\ rJ r
rn rR r r r rk )r rt r r r r r r r storlines s6
z
FTP.storlinesc C s d| }| |S )zSend new account name.r rw )r Zpasswordrt r r r r" s
zFTP.acctc G s0 d}|D ]}|d| }qg }| ||j |S )zBReturn a list of files in a given directory (default the current).ZNLST )r append)r r, rt argfilesr r r nlst# s zFTP.nlstc G sh d}d}|dd r t |d t dkr |dd |d }}|D ]
}|r+|d| }q!| || dS )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.)ZLISTNrZ r r )typer )r r, rt funcr r r r dir, s zFTP.dirc
c s |r| dd| d |rd| }nd}g }| ||j |D ].}|td\}}}i } |dd dD ]}
|
d\} }} | | | < q;|| fV q#dS ) a< List a directory in a standardized format by using MLSD
command (RFC-3659). If path is omitted the current directory
is assumed. "facts" is a list of strings representing the type
of information desired (e.g. ["type", "size", "perm"]).
Return a generator object yielding a tuple of two elements
for every file found in path.
First element is the file name, the second one is a dictionary
including a variable number of "facts" depending on the server
and whether "facts" argument has been provided.
z
OPTS MLST ;zMLSD %sZMLSDr NrZ =) ru r| r r rK rQ partitionr{ lower)
r pathZfactsrt linesrU Z facts_found_nameentryZfactkeyvaluer r r mlsd; s
zFTP.mlsdc C s0 | d| }|d dkrt|| d| S )zRename a file.zRNFR r re zRNTO )ru r rw )r ZfromnameZtonamerh r r r renameW s z
FTP.renamec C s* | d| }|dd dv r|S t|)zDelete a file.zDELE Nr^ > Z200Z250r )r filenamerh r r r delete^ s z
FTP.deletec
C sp |dkr)z| dW S ty( } z|jd dd dkr W Y d}~n d}~ww |dkr/d}d | }| |S )
zChange to a directory.z..ZCDUPr Nr^ 500r rx zCWD )rw r r, )r dirnamemsgrt r r r cwdf s
zFTP.cwdc C s: | d| }|dd dkr|dd }t|S dS )z Retrieve the size of a file.zSIZE Nr^ Z213)ru stripint)r r rh rM r r r r s s
zFTP.sizec C s$ | d| }|dsdS t|S )z+Make a directory, return its full pathname.zMKD 257r rw
startswithparse257)r r rh r r r mkd{ s
zFTP.mkdc C s | d| S )zRemove a directory.zRMD r )r r r r r rmd s zFTP.rmdc C s | d}|ds dS t|S )z!Return current working directory.ZPWDr r r rj r r r pwd s
zFTP.pwdc C s | d}| |S )z Quit, and close the connection.ZQUIT)rw r+ rj r r r r( s
zFTP.quitc C sd z!| j }d| _ |dur| W | j}d| _|dur | dS dS | j}d| _|dur1| w w )z8Close the connection without assuming anything about it.N)r: r+ r' )r r: r' r r r r+ s
z FTP.close)r r r. Nr$ )r r r )r N)r NN):r r r __doc__r= r FTP_PORTr1 MAXLINEr\ r' r: r< rD r r r# r& r- r r@ rC debugrF r? rV rW r] rb r; rk rq ru rw 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 r r r r J sr
7
#
r c s e Zd ZdZejZdddddddedf dd fdd Zd fd d
Z d d Z
d
d Z dd Z dd Z
d fdd Zdd Z ZS )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 Nr r c
s |d ur |d ur t d|d ur|d urt d|d us |d ur+dd l} | dtd || _|| _|d u r>tj| j||d}|| _ d| _
t j |||||| |
d d S ) Nz4context and keyfile arguments are mutually exclusivez5context and certfile arguments are mutually exclusiver zAkeyfile and certfile are deprecated, use a custom context insteadr )certfilekeyfileFr )
r2 warningswarnDeprecationWarningr r sslZ_create_stdlib_context ssl_versioncontext_prot_psuperr# ) r r r r! r" r r r r r r r __class__r r r# s*
zFTP_TLS.__init__Tc s* |r
t | jtjs
| t |||S r$ )r r' r SSLSocketauthr r )r r r! r" Zsecurer r r r s z
FTP_TLS.loginc C sf t | jtjr td| jtjkr| d}n| d}| jj | j| j
d| _| jj d| j d| _
|S )z2Set up secure control connection by using TLS/SSL.zAlready using TLSzAUTH TLSzAUTH SSLZserver_hostnamer0 )moder )r r' r r r2 r Z PROTOCOL_TLSrw r wrap_socketr r9 r r: rj r r r r s
z FTP_TLS.authc C s0 t | jtjs td| d}| j | _|S )z/Switch back to a clear-text control connection.z
not using TLSZCCC)r r' r r r2 rw r rj r r r ccc s
z FTP_TLS.cccc C s | d | d}d| _|S )z Set up secure data connection.zPBSZ 0zPROT PTrw r rj r r r prot_p s
zFTP_TLS.prot_pc C s | d}d| _|S )z"Set up clear text data connection.zPROT CFr rj r r r prot_c s
zFTP_TLS.prot_cc s2 t ||\}}| jr| jj|| jd}||fS )Nr )r r r r r r )r rt r r r r r r r s zFTP_TLS.ntransfercmdc C s8 dt }| j| | }|d d dvrt||S )Nrl r^ rm )rn r' rR rb r rp r r r rq s z
FTP_TLS.abort)r r r Tr$ )r r r r r ZPROTOCOL_TLS_CLIENTr r r# r r r r r r rq
__classcell__r r r r r s r c C s\ | dd dkr t | tdu r ddl}|d|j|jB at| }|s'dS t|dS )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.
Nr^ r r z150 .* \((\d+) bytes\)r ) r _150_rerecompile
IGNORECASEASCIImatchr group)rh r mr r r r . s
r c C s | dd dkr t | tdu rddl}|d|jat| }|s&t| | }d|dd }t |d d> t |d }||fS )
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.Nr^ Z227r z#(\d+),(\d+),(\d+),(\d+),(\d+),(\d+)rx r_ rG )
r _227_rer r r searchr groupsr| r )rh r r Znumbersr r1 r r r r B s
r c C s | dd dkr t | | d}|dk rt| | d|d }|dk r)t| | |d | |d kr9t| | |d | | |d }t|dkrRt| |d }t|d }||fS ) zParse the '229' response for an EPSV request.
Raises error_proto if it does not contain '(|||port|)'
Return ('host.addr.as.numbers', port#) tuple.Nr^ Z229(r )r rG )r findr r{ rJ r )rh Zpeerleftrightpartsr r1 r r r r U s
r c C s | dd dkr t | | dd dkrdS d}d}t| }||k rG| | }|d }|dkr?||ks8| | dkr; |S |d }|| }||k s"|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.Nr^ r rG z "r r ")r rJ )rh r rN nri r r r r j s$ r c C s t | dS )z+Default retrlines callback to print a line.N)r> )rU r r r r s r r Ic C s |s|}d| }| | | | t| d\}}||| |d| }|dd dvr2t| d| }|dd dvrCt| | dS )z+Copy file from one FTP-instance to another.zTYPE r zSTOR Nr^ > Z125r RETR )rw r ru r~ r rk ) sourceZ
sourcenametargetZ
targetnamer Z
sourcehostZ
sourceportZtreplyZsreplyr r r ftpcp s
r c C s t tjdk rttj td ddl} d}d}tjd dkr/|d }tjd= tjd dks tjd dd dkrGtjd dd }tjd= tjd }t|}| | d } }}z| |}W n t
yu |durstj d Y nw z
|
|\}}}W n ty tj d Y nw |||| tjdd D ]K} | dd d
kr|| dd q| dd dkrd }
| dd r|
d | dd }
||
} q| d
kr||j q|d| tjj d q| dS )zTest program.
Usage: ftp [-d] [-r[file]] host [-l[dir]] [-d[dir]] [-p] [file] ...
-d dir
-l list
-p password
r r Nr z-dz-rr z5Could not open account file -- using anonymous login.z$No account -- using anonymous login.z-lZCWDr z-pr i )rJ r3 argvr> testr exitnetrcr rC r) stderrwriteZauthenticatorsKeyErrorr r ru rF rD r stdoutr( ) r r= Zrcfiler ZftpZuseridr! r" Znetrcobjr: rt rh r r r r sZ
r __main__)r r )%r r3 r5 r __all__ro r r Exceptionr
r r r r r) r* r rQ rn r r ImportErrorr r r r ZSSLErrorr r r r r r r r r r r r r r sT &
^
}
9