mirror of
https://github.com/python/cpython.git
synced 2024-12-04 07:15:09 +08:00
d23f8224e9
svn+ssh://pythondev@svn.python.org/python/trunk ........ r70712 | benjamin.peterson | 2009-03-30 10:15:38 -0500 (Mon, 30 Mar 2009) | 1 line don't rely on the order dict repr #5605 ........ r70714 | brett.cannon | 2009-03-30 10:20:53 -0500 (Mon, 30 Mar 2009) | 1 line Add an entry to developers.txt. ........ r70764 | martin.v.loewis | 2009-03-30 17:06:33 -0500 (Mon, 30 Mar 2009) | 2 lines Add several VM developers. ........ r70765 | georg.brandl | 2009-03-30 17:09:34 -0500 (Mon, 30 Mar 2009) | 1 line #5199: make warning about vars() assignment more visible. ........ r70769 | andrew.kuchling | 2009-03-30 17:29:53 -0500 (Mon, 30 Mar 2009) | 1 line Remove comment ........ r70770 | andrew.kuchling | 2009-03-30 17:30:20 -0500 (Mon, 30 Mar 2009) | 1 line Add several items and placeholders ........ r70771 | andrew.kuchling | 2009-03-30 17:31:11 -0500 (Mon, 30 Mar 2009) | 1 line Many edits ........ r70773 | georg.brandl | 2009-03-30 17:43:00 -0500 (Mon, 30 Mar 2009) | 1 line #5039: make it clear that the impl. note refers to CPython. ........ r70776 | andrew.kuchling | 2009-03-30 18:08:24 -0500 (Mon, 30 Mar 2009) | 1 line typo fix ........ r70777 | andrew.kuchling | 2009-03-30 18:09:46 -0500 (Mon, 30 Mar 2009) | 1 line Add more items ........ r70788 | andrew.kuchling | 2009-03-30 20:21:01 -0500 (Mon, 30 Mar 2009) | 1 line Add various items ........ r70789 | georg.brandl | 2009-03-30 20:25:15 -0500 (Mon, 30 Mar 2009) | 1 line Fix a wrong struct field assignment (docstring as closure). ........ r70824 | georg.brandl | 2009-03-31 10:43:20 -0500 (Tue, 31 Mar 2009) | 1 line #5519: remove reference to Kodos, which seems dead. ........ r70828 | georg.brandl | 2009-03-31 10:50:16 -0500 (Tue, 31 Mar 2009) | 1 line #5581: fget argument of abstractproperty is optional as well. ........ r70832 | georg.brandl | 2009-03-31 11:31:11 -0500 (Tue, 31 Mar 2009) | 1 line #1386675: specify WindowsError as the exception, because it has a winerror attribute that EnvironmentError doesnt have. ........ r70836 | georg.brandl | 2009-03-31 11:50:25 -0500 (Tue, 31 Mar 2009) | 1 line #5417: replace references to undocumented functions by ones to documented functions. ........ r70842 | georg.brandl | 2009-03-31 12:13:06 -0500 (Tue, 31 Mar 2009) | 1 line #970783: document PyObject_Generic[GS]etAttr. ........ r70851 | georg.brandl | 2009-03-31 13:26:55 -0500 (Tue, 31 Mar 2009) | 1 line #837577: note cryptic return value of spawn*e on invalid env dicts. ........ r70855 | georg.brandl | 2009-03-31 13:30:37 -0500 (Tue, 31 Mar 2009) | 1 line #5245: note that PyRun_SimpleString doesnt return on SystemExit. ........ r70857 | georg.brandl | 2009-03-31 13:33:10 -0500 (Tue, 31 Mar 2009) | 1 line #5227: note that Py_Main doesnt return on SystemExit. ........ r70866 | georg.brandl | 2009-03-31 14:06:57 -0500 (Tue, 31 Mar 2009) | 1 line #4882: document named group behavior a bit better. ........ r70867 | georg.brandl | 2009-03-31 14:10:35 -0500 (Tue, 31 Mar 2009) | 1 line #1096310: document usage of sys.__std*__ a bit better. ........ r70868 | georg.brandl | 2009-03-31 14:12:17 -0500 (Tue, 31 Mar 2009) | 1 line #5190: export make_option in __all__. ........ r70869 | georg.brandl | 2009-03-31 14:14:42 -0500 (Tue, 31 Mar 2009) | 1 line Fix-up unwanted change. ........ r70870 | georg.brandl | 2009-03-31 14:26:24 -0500 (Tue, 31 Mar 2009) | 1 line #4411: document mro() and __mro__. (I hope I got it right.) ........ r70871 | georg.brandl | 2009-03-31 14:30:56 -0500 (Tue, 31 Mar 2009) | 1 line #5618: fix typo. ........ r70872 | r.david.murray | 2009-03-31 14:31:17 -0500 (Tue, 31 Mar 2009) | 3 lines Delete out-of-date and little-known README from the test directory by consensus of devs at pycon sprint. ........ r70883 | georg.brandl | 2009-03-31 15:41:08 -0500 (Tue, 31 Mar 2009) | 1 line #1674032: return value of flag from Event.wait(). OKed by Guido. ........ r70885 | tarek.ziade | 2009-03-31 15:48:31 -0500 (Tue, 31 Mar 2009) | 1 line using log.warn for sys.stderr ........ r70893 | georg.brandl | 2009-03-31 15:56:32 -0500 (Tue, 31 Mar 2009) | 1 line #1530012: move TQS section before raw strings. ........ r70894 | benjamin.peterson | 2009-03-31 16:06:30 -0500 (Tue, 31 Mar 2009) | 1 line take the usual lock precautions around _active_limbo_lock ........ r70896 | georg.brandl | 2009-03-31 16:15:33 -0500 (Tue, 31 Mar 2009) | 1 line #5598: document DocFileSuite *args argument. ........ r70897 | benjamin.peterson | 2009-03-31 16:34:42 -0500 (Tue, 31 Mar 2009) | 1 line fix Thread.ident when it is the main thread or a dummy thread #5632 ........ r70903 | georg.brandl | 2009-03-31 16:45:18 -0500 (Tue, 31 Mar 2009) | 1 line #1676135: remove trailing slashes from --prefix argument. ........ r70905 | georg.brandl | 2009-03-31 17:03:40 -0500 (Tue, 31 Mar 2009) | 1 line #5563: more documentation for bdist_msi. ........ r70906 | georg.brandl | 2009-03-31 17:11:53 -0500 (Tue, 31 Mar 2009) | 1 line #1651995: fix _convert_ref for non-ASCII characters. ........ r70907 | georg.brandl | 2009-03-31 17:18:19 -0500 (Tue, 31 Mar 2009) | 1 line #3427: document correct return type for urlopen().info(). ........ r70915 | georg.brandl | 2009-03-31 17:40:16 -0500 (Tue, 31 Mar 2009) | 1 line #5018: remove confusing paragraph. ........ r70927 | georg.brandl | 2009-03-31 18:01:27 -0500 (Tue, 31 Mar 2009) | 1 line Dont shout to users. ........ r70933 | georg.brandl | 2009-03-31 19:04:33 -0500 (Tue, 31 Mar 2009) | 2 lines Issue #5635: Fix running test_sys with tracing enabled. ........ r70951 | georg.brandl | 2009-04-01 09:02:27 -0500 (Wed, 01 Apr 2009) | 1 line Add Maksim, who worked on several issues at the sprint. ........ r70960 | jesse.noller | 2009-04-01 11:42:19 -0500 (Wed, 01 Apr 2009) | 1 line Issue 3270: document Listener address restrictions on windows ........ r70962 | brett.cannon | 2009-04-01 12:07:16 -0500 (Wed, 01 Apr 2009) | 2 lines Ron DuPlain was given commit privileges at PyCon 2009 to work on 3to2. ........ r70963 | georg.brandl | 2009-04-01 12:46:01 -0500 (Wed, 01 Apr 2009) | 1 line #5655: fix docstring oversight. ........ r70964 | brett.cannon | 2009-04-01 12:52:13 -0500 (Wed, 01 Apr 2009) | 2 lines Paul Kippes was given commit privileges to work on 3to2. ........ r70998 | georg.brandl | 2009-04-01 16:54:21 -0500 (Wed, 01 Apr 2009) | 1 line In Pdb, stop assigning values to __builtin__._ which interferes with the one commonly installed by gettext. ........ r71001 | brett.cannon | 2009-04-01 18:01:12 -0500 (Wed, 01 Apr 2009) | 3 lines Add my initials to Misc/developers.txt. Names are now sorted by number of characters in the person's name. ........ r71006 | georg.brandl | 2009-04-01 18:32:17 -0500 (Wed, 01 Apr 2009) | 1 line Cache the f_locals dict of the current frame, since every access to frame.f_locals overrides its contents with the real locals which undoes modifications made by the debugging user. ........ r71008 | andrew.kuchling | 2009-04-01 19:02:14 -0500 (Wed, 01 Apr 2009) | 1 line Typo fix ........ r71010 | benjamin.peterson | 2009-04-01 19:11:52 -0500 (Wed, 01 Apr 2009) | 1 line fix markup ........ r71011 | benjamin.peterson | 2009-04-01 19:12:47 -0500 (Wed, 01 Apr 2009) | 1 line this should be :noindex: ........ r71019 | georg.brandl | 2009-04-01 21:00:01 -0500 (Wed, 01 Apr 2009) | 1 line Fix test_doctest, missed two assignments to curframe. ........ r71037 | r.david.murray | 2009-04-01 23:34:04 -0500 (Wed, 01 Apr 2009) | 6 lines Clarify that datetime strftime does not produce leap seconds and datetime strptime does not accept it in the strftime behavior section of the datetime docs. Closes issue 2568. ........ r71056 | georg.brandl | 2009-04-02 12:43:07 -0500 (Thu, 02 Apr 2009) | 2 lines Actually the displayhook should print the repr. ........ r71094 | vinay.sajip | 2009-04-03 05:23:18 -0500 (Fri, 03 Apr 2009) | 1 line Added warning about logging use from asynchronous signal handlers. ........ r71101 | andrew.kuchling | 2009-04-03 16:43:00 -0500 (Fri, 03 Apr 2009) | 1 line Add some items ........ r71102 | andrew.kuchling | 2009-04-03 16:44:49 -0500 (Fri, 03 Apr 2009) | 1 line Fix 'the the'; grammar fix ........ r71103 | andrew.kuchling | 2009-04-03 16:45:29 -0500 (Fri, 03 Apr 2009) | 1 line Fix 'the the' duplication ........ r71106 | vinay.sajip | 2009-04-03 16:58:16 -0500 (Fri, 03 Apr 2009) | 1 line Clarified warning about logging use from asynchronous signal handlers. ........ r71119 | raymond.hettinger | 2009-04-04 00:37:47 -0500 (Sat, 04 Apr 2009) | 1 line Add helpful link. ........ r71123 | r.david.murray | 2009-04-04 01:39:56 -0500 (Sat, 04 Apr 2009) | 2 lines Fix error in description of 'oct' (issue 5678). ........ r71149 | georg.brandl | 2009-04-04 08:42:39 -0500 (Sat, 04 Apr 2009) | 1 line #5642: clarify map() compatibility to the builtin. ........ r71150 | georg.brandl | 2009-04-04 08:45:49 -0500 (Sat, 04 Apr 2009) | 1 line #5601: clarify that webbrowser is not meant for file names. ........ r71203 | benjamin.peterson | 2009-04-04 18:46:34 -0500 (Sat, 04 Apr 2009) | 1 line note how using iter* are unsafe while mutating and document iter(dict) ........ r71212 | georg.brandl | 2009-04-05 05:24:20 -0500 (Sun, 05 Apr 2009) | 1 line #1742837: expand HTTP server docs, and fix SocketServer ones to document methods as methods, not functions. ........ r71214 | georg.brandl | 2009-04-05 05:29:57 -0500 (Sun, 05 Apr 2009) | 1 line Normalize spelling of Mac OS X. ........ r71215 | georg.brandl | 2009-04-05 05:32:26 -0500 (Sun, 05 Apr 2009) | 1 line Avoid sure signs of a diseased mind. ........ r71216 | georg.brandl | 2009-04-05 05:41:02 -0500 (Sun, 05 Apr 2009) | 1 line #1718017: document the relation of os.path and the posixpath, ntpath etc. modules better. ........ r71217 | georg.brandl | 2009-04-05 05:48:47 -0500 (Sun, 05 Apr 2009) | 1 line #1726172: dont raise an unexpected IndexError if a voidresp() call has an empty response. ........ r71221 | vinay.sajip | 2009-04-05 06:06:24 -0500 (Sun, 05 Apr 2009) | 1 line Issue #5695: Moved logging.captureWarnings() call inside with statement in WarningsTest.test_warnings. ........ r71240 | georg.brandl | 2009-04-05 09:40:06 -0500 (Sun, 05 Apr 2009) | 1 line #5370: doc update about unpickling objects with custom __getattr__ etc. methods. ........
858 lines
28 KiB
Python
858 lines
28 KiB
Python
"""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
|
|
"""
|
|
|
|
#
|
|
# Changes and improvements suggested by Steve Majewski.
|
|
# Modified by Jack to work on the mac.
|
|
# Modified by Siebren to support docstrings and PASV.
|
|
# Modified by Phil Schwartz to add storbinary and storlines callbacks.
|
|
#
|
|
|
|
import os
|
|
import sys
|
|
|
|
# Import SOCKS module if it exists, else standard socket module socket
|
|
try:
|
|
import SOCKS; socket = SOCKS; del SOCKS # import SOCKS as socket
|
|
from socket import getfqdn; socket.getfqdn = getfqdn; del getfqdn
|
|
except ImportError:
|
|
import socket
|
|
from socket import _GLOBAL_DEFAULT_TIMEOUT
|
|
|
|
__all__ = ["FTP","Netrc"]
|
|
|
|
# Magic number from <socket.h>
|
|
MSG_OOB = 0x1 # Process data out of band
|
|
|
|
|
|
# The standard FTP server control port
|
|
FTP_PORT = 21
|
|
|
|
|
|
# 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, IOError, EOFError)
|
|
|
|
|
|
# Line terminators (we always output CRLF, but accept any of CRLF, CR, LF)
|
|
CRLF = '\r\n'
|
|
B_CRLF = b'\r\n'
|
|
|
|
# The class itself
|
|
class FTP:
|
|
|
|
'''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.
|
|
'''
|
|
|
|
debugging = 0
|
|
host = ''
|
|
port = FTP_PORT
|
|
sock = None
|
|
file = None
|
|
welcome = None
|
|
passiveserver = 1
|
|
encoding = "latin1"
|
|
|
|
# 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='',
|
|
timeout=_GLOBAL_DEFAULT_TIMEOUT):
|
|
self.timeout = timeout
|
|
if host:
|
|
self.connect(host)
|
|
if user:
|
|
self.login(user, passwd, acct)
|
|
|
|
def connect(self, host='', port=0, timeout=-999):
|
|
'''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 > 0:
|
|
self.port = port
|
|
if timeout != -999:
|
|
self.timeout = timeout
|
|
self.sock = socket.create_connection((self.host, self.port), self.timeout)
|
|
self.af = self.sock.family
|
|
self.file = self.sock.makefile('r', encoding=self.encoding)
|
|
self.welcome = self.getresp()
|
|
return self.welcome
|
|
|
|
def getwelcome(self):
|
|
'''Get the welcome message from the server.
|
|
(this is read and squirreled away by connect())'''
|
|
if self.debugging:
|
|
print('*welcome*', self.sanitize(self.welcome))
|
|
return 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'''
|
|
self.debugging = level
|
|
debug = set_debuglevel
|
|
|
|
def set_pasv(self, val):
|
|
'''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.'''
|
|
self.passiveserver = val
|
|
|
|
# Internal: "sanitize" a string for printing
|
|
def sanitize(self, s):
|
|
if s[:5] == 'pass ' or s[:5] == 'PASS ':
|
|
i = len(s)
|
|
while i > 5 and s[i-1] in '\r\n':
|
|
i = i-1
|
|
s = s[:5] + '*'*(i-5) + s[i:]
|
|
return repr(s)
|
|
|
|
# Internal: send one line to the server, appending CRLF
|
|
def putline(self, line):
|
|
line = line + CRLF
|
|
if self.debugging > 1: print('*put*', self.sanitize(line))
|
|
self.sock.sendall(line.encode(self.encoding))
|
|
|
|
# Internal: send one command to the server (through putline())
|
|
def putcmd(self, line):
|
|
if self.debugging: print('*cmd*', self.sanitize(line))
|
|
self.putline(line)
|
|
|
|
# Internal: return one line from the server, stripping CRLF.
|
|
# Raise EOFError if the connection is closed
|
|
def getline(self):
|
|
line = self.file.readline()
|
|
if self.debugging > 1:
|
|
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]
|
|
return line
|
|
|
|
# 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
|
|
def getmultiline(self):
|
|
line = self.getline()
|
|
if line[3:4] == '-':
|
|
code = line[:3]
|
|
while 1:
|
|
nextline = self.getline()
|
|
line = line + ('\n' + nextline)
|
|
if nextline[:3] == code and \
|
|
nextline[3:4] != '-':
|
|
break
|
|
return line
|
|
|
|
# Internal: get a response from the server.
|
|
# Raise various errors if the response indicates an error
|
|
def getresp(self):
|
|
resp = self.getmultiline()
|
|
if self.debugging: print('*resp*', self.sanitize(resp))
|
|
self.lastresp = resp[:3]
|
|
c = resp[:1]
|
|
if c in ('1', '2', '3'):
|
|
return resp
|
|
if c == '4':
|
|
raise error_temp(resp)
|
|
if c == '5':
|
|
raise error_perm(resp)
|
|
raise error_proto(resp)
|
|
|
|
def voidresp(self):
|
|
"""Expect a response beginning with '2'."""
|
|
resp = self.getresp()
|
|
if resp[:1] != '2':
|
|
raise error_reply(resp)
|
|
return resp
|
|
|
|
def abort(self):
|
|
'''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.'''
|
|
line = 'ABOR' + CRLF
|
|
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'):
|
|
raise error_proto(resp)
|
|
|
|
def sendcmd(self, cmd):
|
|
'''Send a command and return the response.'''
|
|
self.putcmd(cmd)
|
|
return self.getresp()
|
|
|
|
def voidcmd(self, cmd):
|
|
"""Send a command and expect a response beginning with '2'."""
|
|
self.putcmd(cmd)
|
|
return self.voidresp()
|
|
|
|
def sendport(self, host, port):
|
|
'''Send a PORT command with the current host and the given
|
|
port number.
|
|
'''
|
|
hbytes = host.split('.')
|
|
pbytes = [repr(port//256), repr(port%256)]
|
|
bytes = hbytes + pbytes
|
|
cmd = 'PORT ' + ','.join(bytes)
|
|
return self.voidcmd(cmd)
|
|
|
|
def sendeprt(self, host, port):
|
|
'''Send a EPRT command with the current host and the given port number.'''
|
|
af = 0
|
|
if self.af == socket.AF_INET:
|
|
af = 1
|
|
if self.af == socket.AF_INET6:
|
|
af = 2
|
|
if af == 0:
|
|
raise error_proto('unsupported address family')
|
|
fields = ['', repr(af), host, repr(port), '']
|
|
cmd = 'EPRT ' + '|'.join(fields)
|
|
return self.voidcmd(cmd)
|
|
|
|
def makeport(self):
|
|
'''Create a new socket and send a PORT command for it.'''
|
|
msg = "getaddrinfo returns an empty list"
|
|
sock = None
|
|
for res in socket.getaddrinfo(None, 0, self.af, socket.SOCK_STREAM, 0, socket.AI_PASSIVE):
|
|
af, socktype, proto, canonname, sa = res
|
|
try:
|
|
sock = socket.socket(af, socktype, proto)
|
|
sock.bind(sa)
|
|
except socket.error as msg:
|
|
if sock:
|
|
sock.close()
|
|
sock = None
|
|
continue
|
|
break
|
|
if not sock:
|
|
raise socket.error(msg)
|
|
sock.listen(1)
|
|
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)
|
|
else:
|
|
resp = self.sendeprt(host, port)
|
|
return sock
|
|
|
|
def makepasv(self):
|
|
if self.af == socket.AF_INET:
|
|
host, port = parse227(self.sendcmd('PASV'))
|
|
else:
|
|
host, port = parse229(self.sendcmd('EPSV'), self.sock.getpeername())
|
|
return host, port
|
|
|
|
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 REST command. This is essentially a server
|
|
marker used to tell the server to skip over any data up to the
|
|
given marker.
|
|
"""
|
|
size = None
|
|
if self.passiveserver:
|
|
host, port = self.makepasv()
|
|
conn = socket.create_connection((host, port), self.timeout)
|
|
if rest is not None:
|
|
self.sendcmd("REST %s" % rest)
|
|
resp = self.sendcmd(cmd)
|
|
# Some servers apparently send a 200 reply to
|
|
# a LIST or STOR command, before the 150 reply
|
|
# (and way before the 226 reply). This seems to
|
|
# be in violation of the protocol (which only allows
|
|
# 1xx or error messages for LIST), so we just discard
|
|
# this response.
|
|
if resp[0] == '2':
|
|
resp = self.getresp()
|
|
if resp[0] != '1':
|
|
raise error_reply(resp)
|
|
else:
|
|
sock = self.makeport()
|
|
if rest is not None:
|
|
self.sendcmd("REST %s" % rest)
|
|
resp = self.sendcmd(cmd)
|
|
# See above.
|
|
if resp[0] == '2':
|
|
resp = self.getresp()
|
|
if resp[0] != '1':
|
|
raise error_reply(resp)
|
|
conn, sockaddr = sock.accept()
|
|
if resp[:3] == '150':
|
|
# this is conditional in case we received a 125
|
|
size = parse150(resp)
|
|
return conn, size
|
|
|
|
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 not acct: acct = ''
|
|
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 want to stop SPAM
|
|
# - We don't want to let ftp sites to discriminate by the user,
|
|
# host or country.
|
|
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)
|
|
if resp[0] != '2':
|
|
raise error_reply(resp)
|
|
return resp
|
|
|
|
def retrbinary(self, cmd, callback, blocksize=8192, rest=None):
|
|
"""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.
|
|
"""
|
|
self.voidcmd('TYPE I')
|
|
conn = self.transfercmd(cmd, rest)
|
|
while 1:
|
|
data = conn.recv(blocksize)
|
|
if not data:
|
|
break
|
|
callback(data)
|
|
conn.close()
|
|
return self.voidresp()
|
|
|
|
def retrlines(self, cmd, callback = None):
|
|
"""Retrieve data in line mode. A new port is created for you.
|
|
|
|
Args:
|
|
cmd: A RETR, LIST, NLST, or MLSD 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.
|
|
"""
|
|
if callback is None: callback = print_line
|
|
resp = self.sendcmd('TYPE A')
|
|
conn = self.transfercmd(cmd)
|
|
fp = conn.makefile('r', encoding=self.encoding)
|
|
while 1:
|
|
line = fp.readline()
|
|
if self.debugging > 2: print('*retr*', repr(line))
|
|
if not line:
|
|
break
|
|
if line[-2:] == CRLF:
|
|
line = line[:-2]
|
|
elif line[-1:] == '\n':
|
|
line = line[:-1]
|
|
callback(line)
|
|
fp.close()
|
|
conn.close()
|
|
return self.voidresp()
|
|
|
|
def storbinary(self, cmd, fp, blocksize=8192, callback=None):
|
|
"""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
|
|
on each block of data after it is sent. [default: None]
|
|
|
|
Returns:
|
|
The response code.
|
|
"""
|
|
self.voidcmd('TYPE I')
|
|
conn = self.transfercmd(cmd)
|
|
while 1:
|
|
buf = fp.read(blocksize)
|
|
if not buf: break
|
|
conn.sendall(buf)
|
|
if callback: callback(buf)
|
|
conn.close()
|
|
return self.voidresp()
|
|
|
|
def storlines(self, cmd, fp, callback=None):
|
|
"""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
|
|
on each line after it is sent. [default: None]
|
|
|
|
Returns:
|
|
The response code.
|
|
"""
|
|
self.voidcmd('TYPE A')
|
|
conn = self.transfercmd(cmd)
|
|
while 1:
|
|
buf = fp.readline()
|
|
if not buf: break
|
|
if buf[-2:] != B_CRLF:
|
|
if buf[-1] in B_CRLF: buf = buf[:-1]
|
|
buf = buf + B_CRLF
|
|
conn.sendall(buf)
|
|
if callback: callback(buf)
|
|
conn.close()
|
|
return self.voidresp()
|
|
|
|
def acct(self, password):
|
|
'''Send new account name.'''
|
|
cmd = 'ACCT ' + password
|
|
return self.voidcmd(cmd)
|
|
|
|
def nlst(self, *args):
|
|
'''Return a list of files in a given directory (default the current).'''
|
|
cmd = 'NLST'
|
|
for arg in args:
|
|
cmd = cmd + (' ' + arg)
|
|
files = []
|
|
self.retrlines(cmd, files.append)
|
|
return files
|
|
|
|
def dir(self, *args):
|
|
'''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.)'''
|
|
cmd = 'LIST'
|
|
func = None
|
|
if args[-1:] and type(args[-1]) != type(''):
|
|
args, func = args[:-1], args[-1]
|
|
for arg in args:
|
|
if arg:
|
|
cmd = cmd + (' ' + arg)
|
|
self.retrlines(cmd, func)
|
|
|
|
def rename(self, fromname, toname):
|
|
'''Rename a file.'''
|
|
resp = self.sendcmd('RNFR ' + fromname)
|
|
if resp[0] != '3':
|
|
raise error_reply(resp)
|
|
return self.voidcmd('RNTO ' + toname)
|
|
|
|
def delete(self, filename):
|
|
'''Delete a file.'''
|
|
resp = self.sendcmd('DELE ' + filename)
|
|
if resp[:3] in ('250', '200'):
|
|
return resp
|
|
else:
|
|
raise error_reply(resp)
|
|
|
|
def cwd(self, dirname):
|
|
'''Change to a directory.'''
|
|
if dirname == '..':
|
|
try:
|
|
return self.voidcmd('CDUP')
|
|
except error_perm as msg:
|
|
if msg.args[0][:3] != '500':
|
|
raise
|
|
elif dirname == '':
|
|
dirname = '.' # does nothing, but could return error
|
|
cmd = 'CWD ' + dirname
|
|
return self.voidcmd(cmd)
|
|
|
|
def size(self, filename):
|
|
'''Retrieve the size of a file.'''
|
|
# The SIZE command is defined in RFC-3659
|
|
resp = self.sendcmd('SIZE ' + filename)
|
|
if resp[:3] == '213':
|
|
s = resp[3:].strip()
|
|
try:
|
|
return int(s)
|
|
except (OverflowError, ValueError):
|
|
return int(s)
|
|
|
|
def mkd(self, dirname):
|
|
'''Make a directory, return its full pathname.'''
|
|
resp = self.sendcmd('MKD ' + dirname)
|
|
return parse257(resp)
|
|
|
|
def rmd(self, dirname):
|
|
'''Remove a directory.'''
|
|
return self.voidcmd('RMD ' + dirname)
|
|
|
|
def pwd(self):
|
|
'''Return current working directory.'''
|
|
resp = self.sendcmd('PWD')
|
|
return parse257(resp)
|
|
|
|
def quit(self):
|
|
'''Quit, and close the connection.'''
|
|
resp = self.voidcmd('QUIT')
|
|
self.close()
|
|
return resp
|
|
|
|
def close(self):
|
|
'''Close the connection without assuming anything about it.'''
|
|
if self.file:
|
|
self.file.close()
|
|
self.sock.close()
|
|
self.file = self.sock = None
|
|
|
|
|
|
_150_re = None
|
|
|
|
def parse150(resp):
|
|
'''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.
|
|
'''
|
|
if resp[:3] != '150':
|
|
raise error_reply(resp)
|
|
global _150_re
|
|
if _150_re is None:
|
|
import re
|
|
_150_re = re.compile(
|
|
"150 .* \((\d+) bytes\)", re.IGNORECASE | re.ASCII)
|
|
m = _150_re.match(resp)
|
|
if not m:
|
|
return None
|
|
s = m.group(1)
|
|
try:
|
|
return int(s)
|
|
except (OverflowError, ValueError):
|
|
return int(s)
|
|
|
|
|
|
_227_re = None
|
|
|
|
def parse227(resp):
|
|
'''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.'''
|
|
|
|
if resp[:3] != '227':
|
|
raise error_reply(resp)
|
|
global _227_re
|
|
if _227_re is None:
|
|
import re
|
|
_227_re = re.compile(r'(\d+),(\d+),(\d+),(\d+),(\d+),(\d+)', re.ASCII)
|
|
m = _227_re.search(resp)
|
|
if not m:
|
|
raise error_proto(resp)
|
|
numbers = m.groups()
|
|
host = '.'.join(numbers[:4])
|
|
port = (int(numbers[4]) << 8) + int(numbers[5])
|
|
return host, port
|
|
|
|
|
|
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 resp[:3] != '229':
|
|
raise error_reply(resp)
|
|
left = resp.find('(')
|
|
if left < 0: raise error_proto(resp)
|
|
right = resp.find(')', left + 1)
|
|
if right < 0:
|
|
raise error_proto(resp) # should contain '(|||port|)'
|
|
if resp[left + 1] != resp[right - 1]:
|
|
raise error_proto(resp)
|
|
parts = resp[left + 1:right].split(resp[left+1])
|
|
if len(parts) != 5:
|
|
raise error_proto(resp)
|
|
host = peer[0]
|
|
port = int(parts[3])
|
|
return host, port
|
|
|
|
|
|
def parse257(resp):
|
|
'''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.'''
|
|
|
|
if resp[:3] != '257':
|
|
raise error_reply(resp)
|
|
if resp[3:5] != ' "':
|
|
return '' # Not compliant to RFC 959, but UNIX ftpd does this
|
|
dirname = ''
|
|
i = 5
|
|
n = len(resp)
|
|
while i < n:
|
|
c = resp[i]
|
|
i = i+1
|
|
if c == '"':
|
|
if i >= n or resp[i] != '"':
|
|
break
|
|
i = i+1
|
|
dirname = dirname + c
|
|
return dirname
|
|
|
|
|
|
def print_line(line):
|
|
'''Default retrlines callback to print a line.'''
|
|
print(line)
|
|
|
|
|
|
def ftpcp(source, sourcename, target, targetname = '', type = 'I'):
|
|
'''Copy file from one FTP-instance to another.'''
|
|
if not targetname: targetname = sourcename
|
|
type = 'TYPE ' + type
|
|
source.voidcmd(type)
|
|
target.voidcmd(type)
|
|
sourcehost, sourceport = parse227(source.sendcmd('PASV'))
|
|
target.sendport(sourcehost, sourceport)
|
|
# RFC 959: the user must "listen" [...] BEFORE sending the
|
|
# transfer request.
|
|
# 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
|
|
source.voidresp()
|
|
target.voidresp()
|
|
|
|
|
|
class Netrc:
|
|
"""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.
|
|
|
|
"""
|
|
__defuser = None
|
|
__defpasswd = None
|
|
__defacct = None
|
|
|
|
def __init__(self, filename=None):
|
|
if filename is None:
|
|
if "HOME" in os.environ:
|
|
filename = os.path.join(os.environ["HOME"],
|
|
".netrc")
|
|
else:
|
|
raise IOError("specify file to load or set $HOME")
|
|
self.__hosts = {}
|
|
self.__macros = {}
|
|
fp = open(filename, "r")
|
|
in_macro = 0
|
|
while 1:
|
|
line = fp.readline()
|
|
if not line: break
|
|
if in_macro and line.strip():
|
|
macro_lines.append(line)
|
|
continue
|
|
elif in_macro:
|
|
self.__macros[macro_name] = tuple(macro_lines)
|
|
in_macro = 0
|
|
words = line.split()
|
|
host = user = passwd = acct = None
|
|
default = 0
|
|
i = 0
|
|
while i < len(words):
|
|
w1 = words[i]
|
|
if i+1 < len(words):
|
|
w2 = words[i + 1]
|
|
else:
|
|
w2 = None
|
|
if w1 == 'default':
|
|
default = 1
|
|
elif w1 == 'machine' and w2:
|
|
host = w2.lower()
|
|
i = i + 1
|
|
elif w1 == 'login' and w2:
|
|
user = w2
|
|
i = i + 1
|
|
elif w1 == 'password' and w2:
|
|
passwd = w2
|
|
i = i + 1
|
|
elif w1 == 'account' and w2:
|
|
acct = w2
|
|
i = i + 1
|
|
elif w1 == 'macdef' and w2:
|
|
macro_name = w2
|
|
macro_lines = []
|
|
in_macro = 1
|
|
break
|
|
i = i + 1
|
|
if default:
|
|
self.__defuser = user or self.__defuser
|
|
self.__defpasswd = passwd or self.__defpasswd
|
|
self.__defacct = acct or self.__defacct
|
|
if host:
|
|
if host in self.__hosts:
|
|
ouser, opasswd, oacct = \
|
|
self.__hosts[host]
|
|
user = user or ouser
|
|
passwd = passwd or opasswd
|
|
acct = acct or oacct
|
|
self.__hosts[host] = user, passwd, acct
|
|
fp.close()
|
|
|
|
def get_hosts(self):
|
|
"""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.
|
|
|
|
"""
|
|
host = host.lower()
|
|
user = passwd = acct = None
|
|
if host in self.__hosts:
|
|
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
|
|
|
|
def get_macros(self):
|
|
"""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]
|
|
|
|
|
|
|
|
def test():
|
|
'''Test program.
|
|
Usage: ftp [-d] [-r[file]] host [-l[dir]] [-d[dir]] [-p] [file] ...
|
|
|
|
-d dir
|
|
-l list
|
|
-p password
|
|
'''
|
|
|
|
if len(sys.argv) < 2:
|
|
print(test.__doc__)
|
|
sys.exit(0)
|
|
|
|
debugging = 0
|
|
rcfile = None
|
|
while sys.argv[1] == '-d':
|
|
debugging = debugging+1
|
|
del sys.argv[1]
|
|
if sys.argv[1][:2] == '-r':
|
|
# get name of alternate ~/.netrc file:
|
|
rcfile = sys.argv[1][2:]
|
|
del sys.argv[1]
|
|
host = sys.argv[1]
|
|
ftp = FTP(host)
|
|
ftp.set_debuglevel(debugging)
|
|
userid = passwd = acct = ''
|
|
try:
|
|
netrc = Netrc(rcfile)
|
|
except IOError:
|
|
if rcfile is not None:
|
|
sys.stderr.write("Could not open account file"
|
|
" -- using anonymous login.")
|
|
else:
|
|
try:
|
|
userid, passwd, acct = netrc.get_account(host)
|
|
except KeyError:
|
|
# no account for host
|
|
sys.stderr.write(
|
|
"No account -- using anonymous login.")
|
|
ftp.login(userid, passwd, acct)
|
|
for file in sys.argv[2:]:
|
|
if file[:2] == '-l':
|
|
ftp.dir(file[2:])
|
|
elif file[:2] == '-d':
|
|
cmd = 'CWD'
|
|
if file[2:]: cmd = cmd + ' ' + file[2:]
|
|
resp = ftp.sendcmd(cmd)
|
|
elif file == '-p':
|
|
ftp.set_pasv(not ftp.passiveserver)
|
|
else:
|
|
ftp.retrbinary('RETR ' + file, \
|
|
sys.stdout.write, 1024)
|
|
ftp.quit()
|
|
|
|
|
|
if __name__ == '__main__':
|
|
test()
|