"""An FTP client class and some helper functions.
Based on RFC 959: File Transfer Protocol (FTP), by J. Postel and J. Reynolds
>>> 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
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
A nice test that reveals some of the network dialogue would be:
python ftplib.py -d localhost -l -p -l
# Changes and improvements suggested by Steve Majewski.
# Modified by Jack to work on the mac.
# Modified by Siebren to support docstrings and PASV.
# Import SOCKS module if it exists, else standard socket module socket
import SOCKS
; socket
= SOCKS
; del SOCKS
# import SOCKS as socket
from socket
import getfqdn
; socket
.getfqdn
= getfqdn
; del getfqdn
__all__
= ["FTP","Netrc"]
# Magic number from <socket.h>
MSG_OOB
= 0x1 # Process data out of band
# The standard FTP server control port
# Exception raised when an error or invalid response is received
class Error(Exception): pass
class error_reply(Error
): pass # unexpected [123]xx reply
class error_temp(Error
): pass # 4xx errors
class error_perm(Error
): pass # 5xx errors
class error_proto(Error
): pass # response does not begin with [1-5]
# All exceptions (hopefully) that may be raised here and that aren't
# (always) programming errors on our side
all_errors
= (Error
, socket
.error
, IOError, EOFError)
# Line terminators (we always output CRLF, but accept any of CRLF, CR, LF)
To create a connection, call the class using these argument:
These are all strings, and have default value ''.
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
The download/upload functions first issue appropriate TYPE
and PORT or PASV commands.
# Initialization 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())
def __init__(self
, host
='', user
='', passwd
='', acct
=''):
if user
: self
.login(user
, passwd
, acct
)
def connect(self
, host
= '', port
= 0):
'''Connect to host. Arguments are:
- host: hostname to connect to (string, default previous host)
- port: port to connect to (integer, default previous port)'''
if host
: self
.host
= host
if port
: self
.port
= port
msg
= "getaddrinfo returns an empty list"
for res
in socket
.getaddrinfo(self
.host
, self
.port
, 0, socket
.SOCK_STREAM
):
af
, socktype
, proto
, canonname
, sa
= res
self
.sock
= socket
.socket(af
, socktype
, proto
)
except socket
.error
, msg
:
self
.file = self
.sock
.makefile('rb')
self
.welcome
= self
.getresp()
'''Get the welcome message from the server.
(this is read and squirreled away by connect())'''
print '*welcome*', self
.sanitize(self
.welcome
)
def set_debuglevel(self
, level
):
'''Set 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/LF'''
'''Use passive or active mode for data transfers.
With a false argument, use the normal PORT mode,
With a true argument, use the PASV command.'''
# Internal: "sanitize" a string for printing
if s
[:5] == 'pass ' or s
[:5] == 'PASS ':
while i
> 5 and s
[i
-1] in '\r\n':
s
= s
[:5] + '*'*(i
-5) + s
[i
:]
# Internal: send one line to the server, appending CRLF
if self
.debugging
> 1: print '*put*', self
.sanitize(line
)
# Internal: send one command to the server (through putline())
if self
.debugging
: print '*cmd*', self
.sanitize(line
)
# Internal: return one line from the server, stripping CRLF.
# Raise EOFError if the connection is closed
line
= self
.file.readline()
print '*get*', self
.sanitize(line
)
if not line
: raise EOFError
if line
[-2:] == CRLF
: line
= line
[:-2]
elif line
[-1:] in CRLF
: line
= line
[:-1]
# Internal: get a response from the server, which may possibly
# consist of multiple lines. Return a single string with no
# trailing CRLF. If the response consists of multiple lines,
# these are separated by '\n' characters in the string
nextline
= self
.getline()
line
= line
+ ('\n' + nextline
)
if nextline
[:3] == code
and \
# Internal: get a response from the server.
# Raise various errors if the response indicates an error
resp
= self
.getmultiline()
if self
.debugging
: print '*resp*', self
.sanitize(resp
)
"""Expect a response beginning with '2'."""
'''Abort 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.'''
if self
.debugging
> 1: print '*put urgent*', self
.sanitize(line
)
self
.sock
.sendall(line
, MSG_OOB
)
resp
= self
.getmultiline()
if resp
[:3] not in ('426', '226'):
'''Send a command and return the response.'''
"""Send a command and expect a response beginning with '2'."""
def sendport(self
, host
, port
):
'''Send a PORT command with the current host and the given
pbytes
= [repr(port
/256), repr(port
%256)]
cmd
= 'PORT ' + ','.join(bytes
)
def sendeprt(self
, host
, port
):
'''Send a EPRT command with the current host and the given port number.'''
if self
.af
== socket
.AF_INET
:
if self
.af
== socket
.AF_INET6
:
raise error_proto
, 'unsupported address family'
fields
= ['', repr(af
), host
, repr(port
), '']
cmd
= 'EPRT ' + '|'.join(fields
)
'''Create a new socket and send a PORT command for it.'''
msg
= "getaddrinfo returns an empty list"
for res
in socket
.getaddrinfo(None, 0, self
.af
, socket
.SOCK_STREAM
, 0, socket
.AI_PASSIVE
):
af
, socktype
, proto
, canonname
, sa
= res
sock
= socket
.socket(af
, socktype
, proto
)
except socket
.error
, msg
:
port
= sock
.getsockname()[1] # Get proper port
host
= self
.sock
.getsockname()[0] # Get proper host
if self
.af
== socket
.AF_INET
:
resp
= self
.sendport(host
, port
)
resp
= self
.sendeprt(host
, port
)
if self
.af
== socket
.AF_INET
:
host
, port
= parse227(self
.sendcmd('PASV'))
host
, port
= parse229(self
.sendcmd('EPSV'), self
.sock
.getpeername())
def ntransfercmd(self
, cmd
, rest
=None):
"""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 RESTART command. This is essentially a server
marker used to tell the server to skip over any data up to the
host
, port
= self
.makepasv()
af
, socktype
, proto
, canon
, sa
= socket
.getaddrinfo(host
, port
, 0, socket
.SOCK_STREAM
)[0]
conn
= socket
.socket(af
, socktype
, proto
)
self
.sendcmd("REST %s" % rest
)
self
.sendcmd("REST %s" % rest
)
conn
, sockaddr
= sock
.accept()
# this is conditional in case we received a 125
def transfercmd(self
, cmd
, rest
=None):
"""Like ntransfercmd() but returns only the socket."""
return self
.ntransfercmd(cmd
, rest
)[0]
def login(self
, user
= '', passwd
= '', acct
= ''):
'''Login, default anonymous.'''
if not user
: user
= 'anonymous'
if not passwd
: passwd
= ''
if user
== 'anonymous' and passwd
in ('', '-'):
# If there is no anonymous ftp password specified
# then we'll just use anonymous@
# We don't send any other thing because:
# - We want to remain anonymous
# - We don't want to let ftp sites to discriminate by the user,
passwd
= passwd
+ 'anonymous@'
resp
= self
.sendcmd('USER ' + user
)
if resp
[0] == '3': resp
= self
.sendcmd('PASS ' + passwd
)
if resp
[0] == '3': resp
= self
.sendcmd('ACCT ' + acct
)
def retrbinary(self
, cmd
, callback
, blocksize
=8192, rest
=None):
"""Retrieve data in binary mode.
`cmd' is a RETR command. `callback' is a callback function is
called for each block. No more than `blocksize' number of
bytes will be read from the socket. Optional `rest' is passed
A new port is created for you. Return the response code.
conn
= self
.transfercmd(cmd
, rest
)
data
= conn
.recv(blocksize
)
def retrlines(self
, cmd
, callback
= None):
'''Retrieve data in line mode.
The argument is a RETR or LIST command.
The callback function (2nd argument) is called for each line,
with trailing CRLF stripped. This creates a new port for you.
print_line() is the default callback.'''
if callback
is None: callback
= print_line
resp
= self
.sendcmd('TYPE A')
conn
= self
.transfercmd(cmd
)
if self
.debugging
> 2: print '*retr*', repr(line
)
def storbinary(self
, cmd
, fp
, blocksize
=8192):
'''Store a file in binary mode.'''
conn
= self
.transfercmd(cmd
)
def storlines(self
, cmd
, fp
):
'''Store a file in line mode.'''
conn
= self
.transfercmd(cmd
)
if buf
[-1] in CRLF
: buf
= buf
[:-1]
def acct(self
, password
):
'''Send new account name.'''
'''Return a list of files in a given directory (default the current).'''
self
.retrlines(cmd
, files
.append
)
'''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.)'''
if args
[-1:] and type(args
[-1]) != type(''):
args
, func
= args
[:-1], args
[-1]
self
.retrlines(cmd
, func
)
def rename(self
, fromname
, toname
):
resp
= self
.sendcmd('RNFR ' + fromname
)
return self
.voidcmd('RNTO ' + toname
)
def delete(self
, filename
):
resp
= self
.sendcmd('DELE ' + filename
)
if resp
[:3] in ('250', '200'):
'''Change to a directory.'''
return self
.voidcmd('CDUP')
if msg
.args
[0][:3] != '500':
dirname
= '.' # does nothing, but could return error
def size(self
, filename
):
'''Retrieve the size of a file.'''
# Note that the RFC doesn't say anything about 'SIZE'
resp
= self
.sendcmd('SIZE ' + filename
)
except (OverflowError, ValueError):
'''Make a directory, return its full pathname.'''
resp
= self
.sendcmd('MKD ' + dirname
)
'''Remove a directory.'''
return self
.voidcmd('RMD ' + dirname
)
'''Return current working directory.'''
resp
= self
.sendcmd('PWD')
'''Quit, and close the connection.'''
resp
= self
.voidcmd('QUIT')
'''Close the connection without assuming anything about it.'''
self
.file = self
.sock
= None
'''Parse 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.
_150_re
= re
.compile("150 .* \((\d+) bytes\)", re
.IGNORECASE
)
except (OverflowError, ValueError):
'''Parse 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.'''
_227_re
= re
.compile(r
'(\d+),(\d+),(\d+),(\d+),(\d+),(\d+)')
host
= '.'.join(numbers
[:4])
port
= (int(numbers
[4]) << 8) + int(numbers
[5])
def parse229(resp
, peer
):
'''Parse the '229' response for a EPSV request.
Raises error_proto if it does not contain '(|||port|)'
Return ('host.addr.as.numbers', port#) tuple.'''
if left
< 0: raise error_proto
, resp
right
= resp
.find(')', left
+ 1)
raise error_proto
, resp
# should contain '(|||port|)'
if resp
[left
+ 1] != resp
[right
- 1]:
parts
= resp
[left
+ 1:right
].split(resp
[left
+1])
'''Parse 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.'''
return '' # Not compliant to RFC 959, but UNIX ftpd does this
if i
>= n
or resp
[i
] != '"':
'''Default retrlines callback to print a line.'''
def ftpcp(source
, sourcename
, target
, targetname
= '', type = 'I'):
'''Copy file from one FTP-instance to another.'''
if not targetname
: targetname
= sourcename
sourcehost
, sourceport
= parse227(source
.sendcmd('PASV'))
target
.sendport(sourcehost
, sourceport
)
# RFC 959: the user must "listen" [...] BEFORE sending the
# So: STOR before RETR, because here the target is a "user".
treply
= target
.sendcmd('STOR ' + targetname
)
if treply
[:3] not in ('125', '150'): raise error_proto
# RFC 959
sreply
= source
.sendcmd('RETR ' + sourcename
)
if sreply
[:3] not in ('125', '150'): raise error_proto
# RFC 959
"""Class 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.
def __init__(self
, filename
=None):
filename
= os
.path
.join(os
.environ
["HOME"],
"specify file to load or set $HOME"
if in_macro
and line
.strip():
self
.__macros
[macro_name
] = tuple(macro_lines
)
host
= user
= passwd
= acct
= None
elif w1
== 'machine' and w2
:
elif w1
== 'login' and w2
:
elif w1
== 'password' and w2
:
elif w1
== 'account' and w2
:
elif w1
== 'macdef' and w2
:
self
.__defuser
= user
or self
.__defuser
self
.__defpasswd
= passwd
or self
.__defpasswd
self
.__defacct
= acct
or self
.__defacct
ouser
, opasswd
, oacct
= \
passwd
= passwd
or opasswd
self
.__hosts
[host
] = user
, passwd
, acct
"""Return a list of hosts mentioned in the .netrc file."""
return self
.__hosts
.keys()
def get_account(self
, host
):
"""Returns login information for the named host.
The return value is a triple containing userid,
password, and the accounting field.
user
= passwd
= acct
= None
user
, passwd
, acct
= self
.__hosts
[host
]
user
= user
or self
.__defuser
passwd
= passwd
or self
.__defpasswd
acct
= acct
or self
.__defacct
return user
, passwd
, acct
"""Return a list of all defined macro names."""
return self
.__macros
.keys()
def get_macro(self
, macro
):
"""Return a sequence of lines which define a named macro."""
return self
.__macros
[macro
]
Usage: ftp [-d] [-r[file]] host [-l[dir]] [-d[dir]] [-p] [file] ...
while sys
.argv
[1] == '-d':
if sys
.argv
[1][:2] == '-r':
# get name of alternate ~/.netrc file:
ftp
.set_debuglevel(debugging
)
userid
= passwd
= acct
= ''
sys
.stderr
.write("Could not open account file"
" -- using anonymous login.")
userid
, passwd
, acct
= netrc
.get_account(host
)
"No account -- using anonymous login.")
ftp
.login(userid
, passwd
, acct
)
for file in sys
.argv
[2:]:
if file[2:]: cmd
= cmd
+ ' ' + file[2:]
ftp
.set_pasv(not ftp
.passiveserver
)
ftp
.retrbinary('RETR ' + file, \
if __name__
== '__main__':