blob: 9c190baa058f2d00143ef5d3bb3c2ffee9d584fa [file] [log] [blame]
Guido van Rossum4b8c6ea2000-02-04 15:39:30 +00001"""An FTP client class and some helper functions.
2
Barry Warsaw100d81e2000-09-01 06:09:23 +00003Based on RFC 959: File Transfer Protocol (FTP), by J. Postel and J. Reynolds
Guido van Rossum1115ab21992-11-04 15:51:30 +00004
Guido van Rossumd2560b01996-05-28 23:41:25 +00005Example:
6
7>>> from ftplib import FTP
8>>> ftp = FTP('ftp.python.org') # connect to host, default port
Guido van Rossum24a64342001-12-28 20:54:55 +00009>>> ftp.login() # default, i.e.: user anonymous, passwd anonymous@
Guido van Rossum2f3941d1997-10-07 14:49:56 +000010'230 Guest login ok, access restrictions apply.'
Guido van Rossumd2560b01996-05-28 23:41:25 +000011>>> ftp.retrlines('LIST') # list directory contents
12total 9
13drwxr-xr-x 8 root wheel 1024 Jan 3 1994 .
14drwxr-xr-x 8 root wheel 1024 Jan 3 1994 ..
15drwxr-xr-x 2 root wheel 1024 Jan 3 1994 bin
16drwxr-xr-x 2 root wheel 1024 Jan 3 1994 etc
17d-wxrwxr-x 2 ftp wheel 1024 Sep 5 13:43 incoming
18drwxr-xr-x 2 root wheel 1024 Nov 17 1993 lib
19drwxr-xr-x 6 1094 wheel 1024 Sep 13 19:07 pub
20drwxr-xr-x 3 root wheel 1024 Jan 3 1994 usr
21-rw-r--r-- 1 root root 312 Aug 1 1994 welcome.msg
Guido van Rossum2f3941d1997-10-07 14:49:56 +000022'226 Transfer complete.'
Guido van Rossumd2560b01996-05-28 23:41:25 +000023>>> ftp.quit()
Guido van Rossum2f3941d1997-10-07 14:49:56 +000024'221 Goodbye.'
Tim Peters88869f92001-01-14 23:36:06 +000025>>>
Guido van Rossumd2560b01996-05-28 23:41:25 +000026
27A nice test that reveals some of the network dialogue would be:
28python ftplib.py -d localhost -l -p -l
Guido van Rossum4b8c6ea2000-02-04 15:39:30 +000029"""
Guido van Rossumc567c601992-11-05 22:22:37 +000030
Tim Peters88869f92001-01-14 23:36:06 +000031#
Guido van Rossum98d9fd32000-02-28 15:12:25 +000032# Changes and improvements suggested by Steve Majewski.
33# Modified by Jack to work on the mac.
34# Modified by Siebren to support docstrings and PASV.
Christian Heimes1af737c2008-01-23 08:24:23 +000035# Modified by Phil Schwartz to add storbinary and storlines callbacks.
Antoine Pitrouf988cd02009-11-17 20:21:14 +000036# Modified by Giampaolo Rodola' to add TLS support.
Guido van Rossum98d9fd32000-02-28 15:12:25 +000037#
Guido van Rossumc567c601992-11-05 22:22:37 +000038
Guido van Rossum1115ab21992-11-04 15:51:30 +000039import os
40import sys
Giampaolo RodolĂ 6545ed62010-08-21 20:34:37 +000041import socket
Georg Brandlf78e02b2008-06-10 17:40:04 +000042from socket import _GLOBAL_DEFAULT_TIMEOUT
Guido van Rossumb6775db1994-08-01 11:34:53 +000043
Skip Montanaroeccd02a2001-01-20 23:34:12 +000044__all__ = ["FTP","Netrc"]
Guido van Rossum1115ab21992-11-04 15:51:30 +000045
Guido van Rossumd3166071993-05-24 14:16:22 +000046# Magic number from <socket.h>
Tim Peters88869f92001-01-14 23:36:06 +000047MSG_OOB = 0x1 # Process data out of band
Guido van Rossumd3166071993-05-24 14:16:22 +000048
49
Guido van Rossumc567c601992-11-05 22:22:37 +000050# The standard FTP server control port
Guido van Rossum1115ab21992-11-04 15:51:30 +000051FTP_PORT = 21
Guido van Rossum1115ab21992-11-04 15:51:30 +000052
53
Guido van Rossum21974791992-11-06 13:34:17 +000054# Exception raised when an error or invalid response is received
Fred Drake227b1202000-08-17 05:06:49 +000055class Error(Exception): pass
Tim Peters88869f92001-01-14 23:36:06 +000056class error_reply(Error): pass # unexpected [123]xx reply
57class error_temp(Error): pass # 4xx errors
58class error_perm(Error): pass # 5xx errors
59class error_proto(Error): pass # response does not begin with [1-5]
Guido van Rossum1115ab21992-11-04 15:51:30 +000060
61
Guido van Rossum21974791992-11-06 13:34:17 +000062# All exceptions (hopefully) that may be raised here and that aren't
63# (always) programming errors on our side
Christian Heimes33fe8092008-04-13 13:53:33 +000064all_errors = (Error, IOError, EOFError)
Guido van Rossum21974791992-11-06 13:34:17 +000065
66
Guido van Rossum1115ab21992-11-04 15:51:30 +000067# Line terminators (we always output CRLF, but accept any of CRLF, CR, LF)
68CRLF = '\r\n'
Benjamin Petersonbe17a112008-09-27 21:49:47 +000069B_CRLF = b'\r\n'
Guido van Rossum1115ab21992-11-04 15:51:30 +000070
Guido van Rossum1115ab21992-11-04 15:51:30 +000071# The class itself
72class FTP:
73
Tim Peters88869f92001-01-14 23:36:06 +000074 '''An FTP client class.
Guido van Rossumd2560b01996-05-28 23:41:25 +000075
Guido van Rossumd8faa362007-04-27 19:54:29 +000076 To create a connection, call the class using these arguments:
77 host, user, passwd, acct, timeout
78
79 The first four arguments are all strings, and have default value ''.
80 timeout must be numeric and defaults to None if not passed,
81 meaning that no timeout will be set on any ftp socket(s)
82 If a timeout is passed, then this is now the default timeout for all ftp
83 socket operations for this instance.
84
Tim Peters88869f92001-01-14 23:36:06 +000085 Then use self.connect() with optional host and port argument.
Guido van Rossumd2560b01996-05-28 23:41:25 +000086
Tim Peters88869f92001-01-14 23:36:06 +000087 To download a file, use ftp.retrlines('RETR ' + filename),
88 or ftp.retrbinary() with slightly different arguments.
89 To upload a file, use ftp.storlines() or ftp.storbinary(),
90 which have an open file as argument (see their definitions
91 below for details).
92 The download/upload functions first issue appropriate TYPE
93 and PORT or PASV commands.
Guido van Rossum52b89762007-07-17 20:45:57 +000094 '''
Guido van Rossumd2560b01996-05-28 23:41:25 +000095
Fred Drake9c98a422001-02-28 21:46:37 +000096 debugging = 0
97 host = ''
98 port = FTP_PORT
99 sock = None
100 file = None
101 welcome = None
102 passiveserver = 1
Brett Cannon6733d702007-10-08 19:48:15 +0000103 encoding = "latin1"
Fred Drake9c98a422001-02-28 21:46:37 +0000104
Tim Peters88869f92001-01-14 23:36:06 +0000105 # Initialization method (called by class instantiation).
106 # Initialize host to localhost, port to standard ftp port
107 # Optional arguments are host (for connect()),
108 # and user, passwd, acct (for login())
Georg Brandlf78e02b2008-06-10 17:40:04 +0000109 def __init__(self, host='', user='', passwd='', acct='',
110 timeout=_GLOBAL_DEFAULT_TIMEOUT):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000111 self.timeout = timeout
Tim Peters88869f92001-01-14 23:36:06 +0000112 if host:
Fred Drake9c98a422001-02-28 21:46:37 +0000113 self.connect(host)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000114 if user:
115 self.login(user, passwd, acct)
Guido van Rossum52fc1f61993-06-17 12:38:10 +0000116
Giampaolo RodolĂ bd576b72010-05-10 14:53:29 +0000117 def __enter__(self):
118 return self
119
120 # Context management protocol: try to quit() if active
121 def __exit__(self, *args):
122 if self.sock is not None:
123 try:
124 self.quit()
125 except (socket.error, EOFError):
126 pass
127 finally:
128 if self.sock is not None:
129 self.close()
130
Georg Brandlf78e02b2008-06-10 17:40:04 +0000131 def connect(self, host='', port=0, timeout=-999):
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000132 '''Connect to host. Arguments are:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000133 - host: hostname to connect to (string, default previous host)
134 - port: port to connect to (integer, default previous port)
135 '''
136 if host != '':
137 self.host = host
138 if port > 0:
139 self.port = port
Georg Brandlf78e02b2008-06-10 17:40:04 +0000140 if timeout != -999:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000141 self.timeout = timeout
142 self.sock = socket.create_connection((self.host, self.port), self.timeout)
143 self.af = self.sock.family
Guido van Rossum52b89762007-07-17 20:45:57 +0000144 self.file = self.sock.makefile('r', encoding=self.encoding)
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000145 self.welcome = self.getresp()
146 return self.welcome
Guido van Rossum1115ab21992-11-04 15:51:30 +0000147
Tim Peters88869f92001-01-14 23:36:06 +0000148 def getwelcome(self):
149 '''Get the welcome message from the server.
150 (this is read and squirreled away by connect())'''
151 if self.debugging:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000152 print('*welcome*', self.sanitize(self.welcome))
Tim Peters88869f92001-01-14 23:36:06 +0000153 return self.welcome
Guido van Rossum1115ab21992-11-04 15:51:30 +0000154
Tim Peters88869f92001-01-14 23:36:06 +0000155 def set_debuglevel(self, level):
156 '''Set the debugging level.
157 The required argument level means:
158 0: no debugging output (default)
159 1: print commands and responses but not body text etc.
160 2: also print raw lines read and sent before stripping CR/LF'''
161 self.debugging = level
162 debug = set_debuglevel
Guido van Rossum1115ab21992-11-04 15:51:30 +0000163
Tim Peters88869f92001-01-14 23:36:06 +0000164 def set_pasv(self, val):
165 '''Use passive or active mode for data transfers.
166 With a false argument, use the normal PORT mode,
167 With a true argument, use the PASV command.'''
168 self.passiveserver = val
Guido van Rossumd2560b01996-05-28 23:41:25 +0000169
Tim Peters88869f92001-01-14 23:36:06 +0000170 # Internal: "sanitize" a string for printing
171 def sanitize(self, s):
172 if s[:5] == 'pass ' or s[:5] == 'PASS ':
173 i = len(s)
Raymond Hettingerd5825cc2010-09-05 23:15:06 +0000174 while i > 5 and s[i-1] in {'\r', '\n'}:
Tim Peters88869f92001-01-14 23:36:06 +0000175 i = i-1
176 s = s[:5] + '*'*(i-5) + s[i:]
Walter Dörwald70a6b492004-02-12 17:35:32 +0000177 return repr(s)
Guido van Rossumebaf1041995-05-05 15:54:14 +0000178
Tim Peters88869f92001-01-14 23:36:06 +0000179 # Internal: send one line to the server, appending CRLF
180 def putline(self, line):
181 line = line + CRLF
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000182 if self.debugging > 1: print('*put*', self.sanitize(line))
Guido van Rossum52b89762007-07-17 20:45:57 +0000183 self.sock.sendall(line.encode(self.encoding))
Guido van Rossum1115ab21992-11-04 15:51:30 +0000184
Tim Peters88869f92001-01-14 23:36:06 +0000185 # Internal: send one command to the server (through putline())
186 def putcmd(self, line):
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000187 if self.debugging: print('*cmd*', self.sanitize(line))
Tim Peters88869f92001-01-14 23:36:06 +0000188 self.putline(line)
Guido van Rossum1115ab21992-11-04 15:51:30 +0000189
Tim Peters88869f92001-01-14 23:36:06 +0000190 # Internal: return one line from the server, stripping CRLF.
191 # Raise EOFError if the connection is closed
192 def getline(self):
193 line = self.file.readline()
194 if self.debugging > 1:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000195 print('*get*', self.sanitize(line))
Tim Peters88869f92001-01-14 23:36:06 +0000196 if not line: raise EOFError
197 if line[-2:] == CRLF: line = line[:-2]
198 elif line[-1:] in CRLF: line = line[:-1]
199 return line
Guido van Rossum1115ab21992-11-04 15:51:30 +0000200
Tim Peters88869f92001-01-14 23:36:06 +0000201 # Internal: get a response from the server, which may possibly
202 # consist of multiple lines. Return a single string with no
203 # trailing CRLF. If the response consists of multiple lines,
204 # these are separated by '\n' characters in the string
205 def getmultiline(self):
206 line = self.getline()
207 if line[3:4] == '-':
208 code = line[:3]
209 while 1:
210 nextline = self.getline()
211 line = line + ('\n' + nextline)
212 if nextline[:3] == code and \
213 nextline[3:4] != '-':
214 break
215 return line
Guido van Rossum1115ab21992-11-04 15:51:30 +0000216
Tim Peters88869f92001-01-14 23:36:06 +0000217 # Internal: get a response from the server.
218 # Raise various errors if the response indicates an error
219 def getresp(self):
220 resp = self.getmultiline()
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000221 if self.debugging: print('*resp*', self.sanitize(resp))
Tim Peters88869f92001-01-14 23:36:06 +0000222 self.lastresp = resp[:3]
223 c = resp[:1]
Raymond Hettingerd5825cc2010-09-05 23:15:06 +0000224 if c in {'1', '2', '3'}:
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000225 return resp
Tim Peters88869f92001-01-14 23:36:06 +0000226 if c == '4':
Collin Winterce36ad82007-08-30 01:19:48 +0000227 raise error_temp(resp)
Tim Peters88869f92001-01-14 23:36:06 +0000228 if c == '5':
Collin Winterce36ad82007-08-30 01:19:48 +0000229 raise error_perm(resp)
230 raise error_proto(resp)
Guido van Rossum1115ab21992-11-04 15:51:30 +0000231
Tim Peters88869f92001-01-14 23:36:06 +0000232 def voidresp(self):
233 """Expect a response beginning with '2'."""
234 resp = self.getresp()
Benjamin Petersond23f8222009-04-05 19:13:16 +0000235 if resp[:1] != '2':
Collin Winterce36ad82007-08-30 01:19:48 +0000236 raise error_reply(resp)
Tim Peters88869f92001-01-14 23:36:06 +0000237 return resp
Guido van Rossumc567c601992-11-05 22:22:37 +0000238
Tim Peters88869f92001-01-14 23:36:06 +0000239 def abort(self):
240 '''Abort a file transfer. Uses out-of-band data.
241 This does not follow the procedure from the RFC to send Telnet
242 IP and Synch; that doesn't seem to work with the servers I've
243 tried. Instead, just send the ABOR command as OOB data.'''
244 line = 'ABOR' + CRLF
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000245 if self.debugging > 1: print('*put urgent*', self.sanitize(line))
Martin v. Löwise12454f2002-02-16 23:06:19 +0000246 self.sock.sendall(line, MSG_OOB)
Tim Peters88869f92001-01-14 23:36:06 +0000247 resp = self.getmultiline()
Raymond Hettingerd5825cc2010-09-05 23:15:06 +0000248 if resp[:3] not in {'426', '225', '226'}:
Collin Winterce36ad82007-08-30 01:19:48 +0000249 raise error_proto(resp)
Guido van Rossumd3166071993-05-24 14:16:22 +0000250
Tim Peters88869f92001-01-14 23:36:06 +0000251 def sendcmd(self, cmd):
252 '''Send a command and return the response.'''
253 self.putcmd(cmd)
254 return self.getresp()
Guido van Rossum1115ab21992-11-04 15:51:30 +0000255
Tim Peters88869f92001-01-14 23:36:06 +0000256 def voidcmd(self, cmd):
257 """Send a command and expect a response beginning with '2'."""
258 self.putcmd(cmd)
259 return self.voidresp()
Guido van Rossumc567c601992-11-05 22:22:37 +0000260
Tim Peters88869f92001-01-14 23:36:06 +0000261 def sendport(self, host, port):
262 '''Send a PORT command with the current host and the given
263 port number.
264 '''
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000265 hbytes = host.split('.')
Benjamin Peterson3a53fbb2008-09-27 22:04:16 +0000266 pbytes = [repr(port//256), repr(port%256)]
Tim Peters88869f92001-01-14 23:36:06 +0000267 bytes = hbytes + pbytes
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000268 cmd = 'PORT ' + ','.join(bytes)
Tim Peters88869f92001-01-14 23:36:06 +0000269 return self.voidcmd(cmd)
Guido van Rossum1115ab21992-11-04 15:51:30 +0000270
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000271 def sendeprt(self, host, port):
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000272 '''Send a EPRT command with the current host and the given port number.'''
273 af = 0
274 if self.af == socket.AF_INET:
275 af = 1
276 if self.af == socket.AF_INET6:
277 af = 2
278 if af == 0:
Collin Winterce36ad82007-08-30 01:19:48 +0000279 raise error_proto('unsupported address family')
Walter Dörwald70a6b492004-02-12 17:35:32 +0000280 fields = ['', repr(af), host, repr(port), '']
Neal Norwitz7ce734c2002-05-31 14:13:04 +0000281 cmd = 'EPRT ' + '|'.join(fields)
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000282 return self.voidcmd(cmd)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000283
Tim Peters88869f92001-01-14 23:36:06 +0000284 def makeport(self):
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000285 '''Create a new socket and send a PORT command for it.'''
Martin v. Löwis2ad25692001-07-31 08:40:21 +0000286 msg = "getaddrinfo returns an empty list"
Martin v. Löwis322c0d12001-10-07 08:53:32 +0000287 sock = None
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000288 for res in socket.getaddrinfo(None, 0, self.af, socket.SOCK_STREAM, 0, socket.AI_PASSIVE):
289 af, socktype, proto, canonname, sa = res
290 try:
291 sock = socket.socket(af, socktype, proto)
292 sock.bind(sa)
Guido van Rossumb940e112007-01-10 16:19:56 +0000293 except socket.error as msg:
Martin v. Löwis322c0d12001-10-07 08:53:32 +0000294 if sock:
295 sock.close()
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000296 sock = None
297 continue
298 break
299 if not sock:
Collin Winterce36ad82007-08-30 01:19:48 +0000300 raise socket.error(msg)
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000301 sock.listen(1)
302 port = sock.getsockname()[1] # Get proper port
303 host = self.sock.getsockname()[0] # Get proper host
304 if self.af == socket.AF_INET:
305 resp = self.sendport(host, port)
306 else:
307 resp = self.sendeprt(host, port)
Giampaolo RodolĂ 5fb313b2010-04-19 22:05:54 +0000308 if self.timeout is not _GLOBAL_DEFAULT_TIMEOUT:
309 sock.settimeout(self.timeout)
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000310 return sock
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000311
312 def makepasv(self):
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000313 if self.af == socket.AF_INET:
314 host, port = parse227(self.sendcmd('PASV'))
315 else:
316 host, port = parse229(self.sendcmd('EPSV'), self.sock.getpeername())
317 return host, port
Guido van Rossum1115ab21992-11-04 15:51:30 +0000318
Tim Peters88869f92001-01-14 23:36:06 +0000319 def ntransfercmd(self, cmd, rest=None):
320 """Initiate a transfer over the data connection.
Barry Warsaw100d81e2000-09-01 06:09:23 +0000321
Tim Peters88869f92001-01-14 23:36:06 +0000322 If the transfer is active, send a port command and the
323 transfer command, and accept the connection. If the server is
324 passive, send a pasv command, connect to it, and start the
325 transfer command. Either way, return the socket for the
326 connection and the expected size of the transfer. The
327 expected size may be None if it could not be determined.
Barry Warsaw100d81e2000-09-01 06:09:23 +0000328
Tim Peters88869f92001-01-14 23:36:06 +0000329 Optional `rest' argument can be a string that is sent as the
Christian Heimes1af737c2008-01-23 08:24:23 +0000330 argument to a REST command. This is essentially a server
Tim Peters88869f92001-01-14 23:36:06 +0000331 marker used to tell the server to skip over any data up to the
332 given marker.
333 """
334 size = None
335 if self.passiveserver:
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000336 host, port = self.makepasv()
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000337 conn = socket.create_connection((host, port), self.timeout)
Tim Peters88869f92001-01-14 23:36:06 +0000338 if rest is not None:
339 self.sendcmd("REST %s" % rest)
340 resp = self.sendcmd(cmd)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000341 # Some servers apparently send a 200 reply to
342 # a LIST or STOR command, before the 150 reply
343 # (and way before the 226 reply). This seems to
344 # be in violation of the protocol (which only allows
345 # 1xx or error messages for LIST), so we just discard
346 # this response.
347 if resp[0] == '2':
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000348 resp = self.getresp()
Tim Peters88869f92001-01-14 23:36:06 +0000349 if resp[0] != '1':
Collin Winterce36ad82007-08-30 01:19:48 +0000350 raise error_reply(resp)
Tim Peters88869f92001-01-14 23:36:06 +0000351 else:
352 sock = self.makeport()
353 if rest is not None:
354 self.sendcmd("REST %s" % rest)
355 resp = self.sendcmd(cmd)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000356 # See above.
357 if resp[0] == '2':
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000358 resp = self.getresp()
Tim Peters88869f92001-01-14 23:36:06 +0000359 if resp[0] != '1':
Collin Winterce36ad82007-08-30 01:19:48 +0000360 raise error_reply(resp)
Tim Peters88869f92001-01-14 23:36:06 +0000361 conn, sockaddr = sock.accept()
Giampaolo RodolĂ 5fb313b2010-04-19 22:05:54 +0000362 if self.timeout is not _GLOBAL_DEFAULT_TIMEOUT:
363 conn.settimeout(self.timeout)
Tim Peters88869f92001-01-14 23:36:06 +0000364 if resp[:3] == '150':
365 # this is conditional in case we received a 125
366 size = parse150(resp)
367 return conn, size
Fred Drake4de02d91997-01-10 18:26:09 +0000368
Tim Peters88869f92001-01-14 23:36:06 +0000369 def transfercmd(self, cmd, rest=None):
Guido van Rossumb6aca6a2001-10-16 19:45:52 +0000370 """Like ntransfercmd() but returns only the socket."""
Tim Peters88869f92001-01-14 23:36:06 +0000371 return self.ntransfercmd(cmd, rest)[0]
Guido van Rossumc567c601992-11-05 22:22:37 +0000372
Tim Peters88869f92001-01-14 23:36:06 +0000373 def login(self, user = '', passwd = '', acct = ''):
374 '''Login, default anonymous.'''
375 if not user: user = 'anonymous'
376 if not passwd: passwd = ''
377 if not acct: acct = ''
Raymond Hettingerd5825cc2010-09-05 23:15:06 +0000378 if user == 'anonymous' and passwd in {'', '-'}:
Tim Peterse4418602002-02-16 07:34:19 +0000379 # If there is no anonymous ftp password specified
380 # then we'll just use anonymous@
381 # We don't send any other thing because:
382 # - We want to remain anonymous
383 # - We want to stop SPAM
384 # - We don't want to let ftp sites to discriminate by the user,
385 # host or country.
Guido van Rossumc33e0772001-12-28 20:54:28 +0000386 passwd = passwd + 'anonymous@'
Tim Peters88869f92001-01-14 23:36:06 +0000387 resp = self.sendcmd('USER ' + user)
388 if resp[0] == '3': resp = self.sendcmd('PASS ' + passwd)
389 if resp[0] == '3': resp = self.sendcmd('ACCT ' + acct)
390 if resp[0] != '2':
Collin Winterce36ad82007-08-30 01:19:48 +0000391 raise error_reply(resp)
Tim Peters88869f92001-01-14 23:36:06 +0000392 return resp
Guido van Rossumc567c601992-11-05 22:22:37 +0000393
Tim Peters88869f92001-01-14 23:36:06 +0000394 def retrbinary(self, cmd, callback, blocksize=8192, rest=None):
Christian Heimes1af737c2008-01-23 08:24:23 +0000395 """Retrieve data in binary mode. A new port is created for you.
Barry Warsaw100d81e2000-09-01 06:09:23 +0000396
Christian Heimes1af737c2008-01-23 08:24:23 +0000397 Args:
398 cmd: A RETR command.
399 callback: A single parameter callable to be called on each
400 block of data read.
401 blocksize: The maximum number of bytes to read from the
402 socket at one time. [default: 8192]
403 rest: Passed to transfercmd(). [default: None]
Guido van Rossum1115ab21992-11-04 15:51:30 +0000404
Christian Heimes1af737c2008-01-23 08:24:23 +0000405 Returns:
406 The response code.
Tim Peters88869f92001-01-14 23:36:06 +0000407 """
408 self.voidcmd('TYPE I')
409 conn = self.transfercmd(cmd, rest)
410 while 1:
411 data = conn.recv(blocksize)
412 if not data:
413 break
414 callback(data)
415 conn.close()
416 return self.voidresp()
Guido van Rossum1115ab21992-11-04 15:51:30 +0000417
Tim Peters88869f92001-01-14 23:36:06 +0000418 def retrlines(self, cmd, callback = None):
Christian Heimes1af737c2008-01-23 08:24:23 +0000419 """Retrieve data in line mode. A new port is created for you.
420
421 Args:
422 cmd: A RETR, LIST, NLST, or MLSD command.
423 callback: An optional single parameter callable that is called
424 for each line with the trailing CRLF stripped.
425 [default: print_line()]
426
427 Returns:
428 The response code.
429 """
Raymond Hettingere874fc32002-05-12 05:53:51 +0000430 if callback is None: callback = print_line
Tim Peters88869f92001-01-14 23:36:06 +0000431 resp = self.sendcmd('TYPE A')
432 conn = self.transfercmd(cmd)
Guido van Rossum52b89762007-07-17 20:45:57 +0000433 fp = conn.makefile('r', encoding=self.encoding)
Tim Peters88869f92001-01-14 23:36:06 +0000434 while 1:
435 line = fp.readline()
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000436 if self.debugging > 2: print('*retr*', repr(line))
Tim Peters88869f92001-01-14 23:36:06 +0000437 if not line:
438 break
439 if line[-2:] == CRLF:
440 line = line[:-2]
441 elif line[-1:] == '\n':
442 line = line[:-1]
443 callback(line)
444 fp.close()
445 conn.close()
446 return self.voidresp()
Guido van Rossumc567c601992-11-05 22:22:37 +0000447
Antoine Pitrou648bcd72009-11-27 13:23:26 +0000448 def storbinary(self, cmd, fp, blocksize=8192, callback=None, rest=None):
Christian Heimes1af737c2008-01-23 08:24:23 +0000449 """Store a file in binary mode. A new port is created for you.
450
451 Args:
452 cmd: A STOR command.
453 fp: A file-like object with a read(num_bytes) method.
454 blocksize: The maximum data size to read from fp and send over
455 the connection at once. [default: 8192]
456 callback: An optional single parameter callable that is called on
457 on each block of data after it is sent. [default: None]
Antoine Pitrou648bcd72009-11-27 13:23:26 +0000458 rest: Passed to transfercmd(). [default: None]
Christian Heimes1af737c2008-01-23 08:24:23 +0000459
460 Returns:
461 The response code.
462 """
Tim Peters88869f92001-01-14 23:36:06 +0000463 self.voidcmd('TYPE I')
Antoine Pitrou648bcd72009-11-27 13:23:26 +0000464 conn = self.transfercmd(cmd, rest)
Tim Peters88869f92001-01-14 23:36:06 +0000465 while 1:
466 buf = fp.read(blocksize)
467 if not buf: break
Martin v. Löwise12454f2002-02-16 23:06:19 +0000468 conn.sendall(buf)
Christian Heimes1af737c2008-01-23 08:24:23 +0000469 if callback: callback(buf)
Tim Peters88869f92001-01-14 23:36:06 +0000470 conn.close()
471 return self.voidresp()
Guido van Rossumc567c601992-11-05 22:22:37 +0000472
Christian Heimes1af737c2008-01-23 08:24:23 +0000473 def storlines(self, cmd, fp, callback=None):
474 """Store a file in line mode. A new port is created for you.
475
476 Args:
477 cmd: A STOR command.
478 fp: A file-like object with a readline() method.
479 callback: An optional single parameter callable that is called on
480 on each line after it is sent. [default: None]
481
482 Returns:
483 The response code.
484 """
Tim Peters88869f92001-01-14 23:36:06 +0000485 self.voidcmd('TYPE A')
486 conn = self.transfercmd(cmd)
487 while 1:
488 buf = fp.readline()
489 if not buf: break
Giampaolo RodolĂ f96482e2010-08-04 10:36:18 +0000490 if buf[-2:] != B_CRLF:
491 if buf[-1] in B_CRLF: buf = buf[:-1]
492 buf = buf + B_CRLF
Martin v. Löwise12454f2002-02-16 23:06:19 +0000493 conn.sendall(buf)
Christian Heimes1af737c2008-01-23 08:24:23 +0000494 if callback: callback(buf)
Tim Peters88869f92001-01-14 23:36:06 +0000495 conn.close()
496 return self.voidresp()
Guido van Rossum0eaa74b1996-01-25 18:37:21 +0000497
Tim Peters88869f92001-01-14 23:36:06 +0000498 def acct(self, password):
499 '''Send new account name.'''
500 cmd = 'ACCT ' + password
501 return self.voidcmd(cmd)
Guido van Rossumc567c601992-11-05 22:22:37 +0000502
Tim Peters88869f92001-01-14 23:36:06 +0000503 def nlst(self, *args):
504 '''Return a list of files in a given directory (default the current).'''
505 cmd = 'NLST'
506 for arg in args:
507 cmd = cmd + (' ' + arg)
508 files = []
509 self.retrlines(cmd, files.append)
510 return files
Guido van Rossumae3b3a31993-11-30 13:43:54 +0000511
Tim Peters88869f92001-01-14 23:36:06 +0000512 def dir(self, *args):
513 '''List a directory in long form.
514 By default list current directory to stdout.
515 Optional last argument is callback function; all
516 non-empty arguments before it are concatenated to the
517 LIST command. (This *should* only be used for a pathname.)'''
518 cmd = 'LIST'
519 func = None
520 if args[-1:] and type(args[-1]) != type(''):
521 args, func = args[:-1], args[-1]
522 for arg in args:
523 if arg:
524 cmd = cmd + (' ' + arg)
525 self.retrlines(cmd, func)
Guido van Rossumc567c601992-11-05 22:22:37 +0000526
Tim Peters88869f92001-01-14 23:36:06 +0000527 def rename(self, fromname, toname):
528 '''Rename a file.'''
529 resp = self.sendcmd('RNFR ' + fromname)
530 if resp[0] != '3':
Collin Winterce36ad82007-08-30 01:19:48 +0000531 raise error_reply(resp)
Tim Peters88869f92001-01-14 23:36:06 +0000532 return self.voidcmd('RNTO ' + toname)
Guido van Rossuma61bdeb1995-10-11 17:36:31 +0000533
Tim Peters88869f92001-01-14 23:36:06 +0000534 def delete(self, filename):
535 '''Delete a file.'''
536 resp = self.sendcmd('DELE ' + filename)
Raymond Hettingerd5825cc2010-09-05 23:15:06 +0000537 if resp[:3] in {'250', '200'}:
Tim Peters88869f92001-01-14 23:36:06 +0000538 return resp
Tim Peters88869f92001-01-14 23:36:06 +0000539 else:
Collin Winterce36ad82007-08-30 01:19:48 +0000540 raise error_reply(resp)
Guido van Rossum02cf5821993-05-17 08:00:02 +0000541
Tim Peters88869f92001-01-14 23:36:06 +0000542 def cwd(self, dirname):
543 '''Change to a directory.'''
544 if dirname == '..':
545 try:
546 return self.voidcmd('CDUP')
Guido van Rossumb940e112007-01-10 16:19:56 +0000547 except error_perm as msg:
Martin v. Löwisb5255112002-03-10 15:59:58 +0000548 if msg.args[0][:3] != '500':
549 raise
Tim Peters88869f92001-01-14 23:36:06 +0000550 elif dirname == '':
551 dirname = '.' # does nothing, but could return error
552 cmd = 'CWD ' + dirname
553 return self.voidcmd(cmd)
Guido van Rossum17ed1ae1993-06-01 13:21:04 +0000554
Tim Peters88869f92001-01-14 23:36:06 +0000555 def size(self, filename):
556 '''Retrieve the size of a file.'''
Christian Heimes1af737c2008-01-23 08:24:23 +0000557 # The SIZE command is defined in RFC-3659
Tim Peters88869f92001-01-14 23:36:06 +0000558 resp = self.sendcmd('SIZE ' + filename)
559 if resp[:3] == '213':
Guido van Rossumb6aca6a2001-10-16 19:45:52 +0000560 s = resp[3:].strip()
561 try:
562 return int(s)
Guido van Rossum1f74cb32001-10-17 17:21:47 +0000563 except (OverflowError, ValueError):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000564 return int(s)
Guido van Rossumc567c601992-11-05 22:22:37 +0000565
Tim Peters88869f92001-01-14 23:36:06 +0000566 def mkd(self, dirname):
567 '''Make a directory, return its full pathname.'''
Giampaolo RodolĂ bbc47822010-08-23 22:10:32 +0000568 resp = self.voidcmd('MKD ' + dirname)
569 # fix around non-compliant implementations such as IIS shipped
570 # with Windows server 2003
571 if not resp.startswith('257'):
572 return ''
Tim Peters88869f92001-01-14 23:36:06 +0000573 return parse257(resp)
Guido van Rossum98245091998-02-19 21:15:44 +0000574
Tim Peters88869f92001-01-14 23:36:06 +0000575 def rmd(self, dirname):
576 '''Remove a directory.'''
577 return self.voidcmd('RMD ' + dirname)
Guido van Rossum1115ab21992-11-04 15:51:30 +0000578
Tim Peters88869f92001-01-14 23:36:06 +0000579 def pwd(self):
580 '''Return current working directory.'''
Giampaolo RodolĂ bbc47822010-08-23 22:10:32 +0000581 resp = self.voidcmd('PWD')
582 # fix around non-compliant implementations such as IIS shipped
583 # with Windows server 2003
584 if not resp.startswith('257'):
585 return ''
Tim Peters88869f92001-01-14 23:36:06 +0000586 return parse257(resp)
Guido van Rossum17ed1ae1993-06-01 13:21:04 +0000587
Tim Peters88869f92001-01-14 23:36:06 +0000588 def quit(self):
589 '''Quit, and close the connection.'''
590 resp = self.voidcmd('QUIT')
591 self.close()
592 return resp
593
594 def close(self):
595 '''Close the connection without assuming anything about it.'''
Fred Drake9c98a422001-02-28 21:46:37 +0000596 if self.file:
597 self.file.close()
598 self.sock.close()
599 self.file = self.sock = None
Guido van Rossumc567c601992-11-05 22:22:37 +0000600
601
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000602try:
603 import ssl
604except ImportError:
605 pass
606else:
607 class FTP_TLS(FTP):
608 '''A FTP subclass which adds TLS support to FTP as described
609 in RFC-4217.
610
611 Connect as usual to port 21 implicitly securing the FTP control
612 connection before authenticating.
613
614 Securing the data connection requires user to explicitly ask
615 for it by calling prot_p() method.
616
617 Usage example:
618 >>> from ftplib import FTP_TLS
619 >>> ftps = FTP_TLS('ftp.python.org')
620 >>> ftps.login() # login anonimously previously securing control channel
621 '230 Guest login ok, access restrictions apply.'
622 >>> ftps.prot_p() # switch to secure data connection
623 '200 Protection level set to P'
624 >>> ftps.retrlines('LIST') # list directory content securely
625 total 9
626 drwxr-xr-x 8 root wheel 1024 Jan 3 1994 .
627 drwxr-xr-x 8 root wheel 1024 Jan 3 1994 ..
628 drwxr-xr-x 2 root wheel 1024 Jan 3 1994 bin
629 drwxr-xr-x 2 root wheel 1024 Jan 3 1994 etc
630 d-wxrwxr-x 2 ftp wheel 1024 Sep 5 13:43 incoming
631 drwxr-xr-x 2 root wheel 1024 Nov 17 1993 lib
632 drwxr-xr-x 6 1094 wheel 1024 Sep 13 19:07 pub
633 drwxr-xr-x 3 root wheel 1024 Jan 3 1994 usr
634 -rw-r--r-- 1 root root 312 Aug 1 1994 welcome.msg
635 '226 Transfer complete.'
636 >>> ftps.quit()
637 '221 Goodbye.'
638 >>>
639 '''
640 ssl_version = ssl.PROTOCOL_TLSv1
641
642 def __init__(self, host='', user='', passwd='', acct='', keyfile=None,
Giampaolo RodolĂ a67299e2010-05-26 18:06:04 +0000643 certfile=None, context=None,
644 timeout=_GLOBAL_DEFAULT_TIMEOUT):
645 if context is not None and keyfile is not None:
646 raise ValueError("context and keyfile arguments are mutually "
647 "exclusive")
648 if context is not None and certfile is not None:
649 raise ValueError("context and certfile arguments are mutually "
650 "exclusive")
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000651 self.keyfile = keyfile
652 self.certfile = certfile
Giampaolo RodolĂ a67299e2010-05-26 18:06:04 +0000653 self.context = context
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000654 self._prot_p = False
655 FTP.__init__(self, host, user, passwd, acct, timeout)
656
657 def login(self, user='', passwd='', acct='', secure=True):
658 if secure and not isinstance(self.sock, ssl.SSLSocket):
659 self.auth()
660 return FTP.login(self, user, passwd, acct)
661
662 def auth(self):
663 '''Set up secure control connection by using TLS/SSL.'''
664 if isinstance(self.sock, ssl.SSLSocket):
665 raise ValueError("Already using TLS")
666 if self.ssl_version == ssl.PROTOCOL_TLSv1:
667 resp = self.voidcmd('AUTH TLS')
668 else:
669 resp = self.voidcmd('AUTH SSL')
Giampaolo RodolĂ a67299e2010-05-26 18:06:04 +0000670 if self.context is not None:
671 self.sock = self.context.wrap_socket(self.sock)
672 else:
673 self.sock = ssl.wrap_socket(self.sock, self.keyfile,
674 self.certfile,
675 ssl_version=self.ssl_version)
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000676 self.file = self.sock.makefile(mode='r', encoding=self.encoding)
677 return resp
678
679 def prot_p(self):
680 '''Set up secure data connection.'''
681 # PROT defines whether or not the data channel is to be protected.
682 # Though RFC-2228 defines four possible protection levels,
683 # RFC-4217 only recommends two, Clear and Private.
684 # Clear (PROT C) means that no security is to be used on the
685 # data-channel, Private (PROT P) means that the data-channel
686 # should be protected by TLS.
687 # PBSZ command MUST still be issued, but must have a parameter of
688 # '0' to indicate that no buffering is taking place and the data
689 # connection should not be encapsulated.
690 self.voidcmd('PBSZ 0')
691 resp = self.voidcmd('PROT P')
692 self._prot_p = True
693 return resp
694
695 def prot_c(self):
696 '''Set up clear text data connection.'''
697 resp = self.voidcmd('PROT C')
698 self._prot_p = False
699 return resp
700
701 # --- Overridden FTP methods
702
703 def ntransfercmd(self, cmd, rest=None):
704 conn, size = FTP.ntransfercmd(self, cmd, rest)
705 if self._prot_p:
Giampaolo RodolĂ a67299e2010-05-26 18:06:04 +0000706 if self.context is not None:
707 conn = self.context.wrap_socket(conn)
708 else:
709 conn = ssl.wrap_socket(conn, self.keyfile, self.certfile,
710 ssl_version=self.ssl_version)
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000711 return conn, size
712
713 def retrbinary(self, cmd, callback, blocksize=8192, rest=None):
714 self.voidcmd('TYPE I')
715 conn = self.transfercmd(cmd, rest)
716 try:
717 while 1:
718 data = conn.recv(blocksize)
719 if not data:
720 break
721 callback(data)
722 # shutdown ssl layer
723 if isinstance(conn, ssl.SSLSocket):
724 conn.unwrap()
725 finally:
726 conn.close()
727 return self.voidresp()
728
729 def retrlines(self, cmd, callback = None):
730 if callback is None: callback = print_line
731 resp = self.sendcmd('TYPE A')
732 conn = self.transfercmd(cmd)
733 fp = conn.makefile('r', encoding=self.encoding)
734 try:
735 while 1:
736 line = fp.readline()
737 if self.debugging > 2: print('*retr*', repr(line))
738 if not line:
739 break
740 if line[-2:] == CRLF:
741 line = line[:-2]
742 elif line[-1:] == '\n':
743 line = line[:-1]
744 callback(line)
745 # shutdown ssl layer
746 if isinstance(conn, ssl.SSLSocket):
747 conn.unwrap()
748 finally:
749 fp.close()
750 conn.close()
751 return self.voidresp()
752
Antoine Pitrou648bcd72009-11-27 13:23:26 +0000753 def storbinary(self, cmd, fp, blocksize=8192, callback=None, rest=None):
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000754 self.voidcmd('TYPE I')
Antoine Pitrou648bcd72009-11-27 13:23:26 +0000755 conn = self.transfercmd(cmd, rest)
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000756 try:
757 while 1:
758 buf = fp.read(blocksize)
759 if not buf: break
760 conn.sendall(buf)
761 if callback: callback(buf)
762 # shutdown ssl layer
763 if isinstance(conn, ssl.SSLSocket):
764 conn.unwrap()
765 finally:
766 conn.close()
767 return self.voidresp()
768
769 def storlines(self, cmd, fp, callback=None):
770 self.voidcmd('TYPE A')
771 conn = self.transfercmd(cmd)
772 try:
773 while 1:
774 buf = fp.readline()
775 if not buf: break
Giampaolo RodolĂ f96482e2010-08-04 10:36:18 +0000776 if buf[-2:] != B_CRLF:
777 if buf[-1] in B_CRLF: buf = buf[:-1]
778 buf = buf + B_CRLF
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000779 conn.sendall(buf)
780 if callback: callback(buf)
781 # shutdown ssl layer
782 if isinstance(conn, ssl.SSLSocket):
783 conn.unwrap()
784 finally:
785 conn.close()
786 return self.voidresp()
787
788 __all__.append('FTP_TLS')
789 all_errors = (Error, IOError, EOFError, ssl.SSLError)
790
791
Guido van Rossumacfb82a1997-10-22 20:49:52 +0000792_150_re = None
Fred Drake4de02d91997-01-10 18:26:09 +0000793
794def parse150(resp):
Tim Peters88869f92001-01-14 23:36:06 +0000795 '''Parse the '150' response for a RETR request.
796 Returns the expected transfer size or None; size is not guaranteed to
797 be present in the 150 message.
798 '''
799 if resp[:3] != '150':
Collin Winterce36ad82007-08-30 01:19:48 +0000800 raise error_reply(resp)
Tim Peters88869f92001-01-14 23:36:06 +0000801 global _150_re
802 if _150_re is None:
803 import re
Antoine Pitroufd036452008-08-19 17:56:33 +0000804 _150_re = re.compile(
805 "150 .* \((\d+) bytes\)", re.IGNORECASE | re.ASCII)
Tim Peters88869f92001-01-14 23:36:06 +0000806 m = _150_re.match(resp)
Guido van Rossumb6aca6a2001-10-16 19:45:52 +0000807 if not m:
808 return None
809 s = m.group(1)
810 try:
811 return int(s)
Guido van Rossum1f74cb32001-10-17 17:21:47 +0000812 except (OverflowError, ValueError):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000813 return int(s)
Fred Drake4de02d91997-01-10 18:26:09 +0000814
815
Guido van Rossum70297d32001-08-17 17:24:29 +0000816_227_re = None
817
Guido van Rossumd2560b01996-05-28 23:41:25 +0000818def parse227(resp):
Tim Peters88869f92001-01-14 23:36:06 +0000819 '''Parse the '227' response for a PASV request.
820 Raises error_proto if it does not contain '(h1,h2,h3,h4,p1,p2)'
821 Return ('host.addr.as.numbers', port#) tuple.'''
Guido van Rossumd2560b01996-05-28 23:41:25 +0000822
Tim Peters88869f92001-01-14 23:36:06 +0000823 if resp[:3] != '227':
Collin Winterce36ad82007-08-30 01:19:48 +0000824 raise error_reply(resp)
Guido van Rossum70297d32001-08-17 17:24:29 +0000825 global _227_re
826 if _227_re is None:
827 import re
Antoine Pitroufd036452008-08-19 17:56:33 +0000828 _227_re = re.compile(r'(\d+),(\d+),(\d+),(\d+),(\d+),(\d+)', re.ASCII)
Guido van Rossum70297d32001-08-17 17:24:29 +0000829 m = _227_re.search(resp)
830 if not m:
Collin Winterce36ad82007-08-30 01:19:48 +0000831 raise error_proto(resp)
Guido van Rossum70297d32001-08-17 17:24:29 +0000832 numbers = m.groups()
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000833 host = '.'.join(numbers[:4])
834 port = (int(numbers[4]) << 8) + int(numbers[5])
Tim Peters88869f92001-01-14 23:36:06 +0000835 return host, port
Guido van Rossumd2560b01996-05-28 23:41:25 +0000836
837
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000838def parse229(resp, peer):
839 '''Parse the '229' response for a EPSV request.
840 Raises error_proto if it does not contain '(|||port|)'
841 Return ('host.addr.as.numbers', port#) tuple.'''
842
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000843 if resp[:3] != '229':
Collin Winterce36ad82007-08-30 01:19:48 +0000844 raise error_reply(resp)
Neal Norwitz7ce734c2002-05-31 14:13:04 +0000845 left = resp.find('(')
Collin Winterce36ad82007-08-30 01:19:48 +0000846 if left < 0: raise error_proto(resp)
Neal Norwitz7ce734c2002-05-31 14:13:04 +0000847 right = resp.find(')', left + 1)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000848 if right < 0:
Collin Winterce36ad82007-08-30 01:19:48 +0000849 raise error_proto(resp) # should contain '(|||port|)'
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000850 if resp[left + 1] != resp[right - 1]:
Collin Winterce36ad82007-08-30 01:19:48 +0000851 raise error_proto(resp)
Walter Dörwalda401ae42002-06-03 10:41:45 +0000852 parts = resp[left + 1:right].split(resp[left+1])
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000853 if len(parts) != 5:
Collin Winterce36ad82007-08-30 01:19:48 +0000854 raise error_proto(resp)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000855 host = peer[0]
Neal Norwitz7ce734c2002-05-31 14:13:04 +0000856 port = int(parts[3])
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000857 return host, port
858
859
Guido van Rossumc567c601992-11-05 22:22:37 +0000860def parse257(resp):
Tim Peters88869f92001-01-14 23:36:06 +0000861 '''Parse the '257' response for a MKD or PWD request.
862 This is a response to a MKD or PWD request: a directory name.
863 Returns the directoryname in the 257 reply.'''
Guido van Rossumd2560b01996-05-28 23:41:25 +0000864
Tim Peters88869f92001-01-14 23:36:06 +0000865 if resp[:3] != '257':
Collin Winterce36ad82007-08-30 01:19:48 +0000866 raise error_reply(resp)
Tim Peters88869f92001-01-14 23:36:06 +0000867 if resp[3:5] != ' "':
868 return '' # Not compliant to RFC 959, but UNIX ftpd does this
869 dirname = ''
870 i = 5
871 n = len(resp)
872 while i < n:
873 c = resp[i]
874 i = i+1
875 if c == '"':
876 if i >= n or resp[i] != '"':
877 break
878 i = i+1
879 dirname = dirname + c
880 return dirname
Guido van Rossum1115ab21992-11-04 15:51:30 +0000881
Guido van Rossum2f3941d1997-10-07 14:49:56 +0000882
Guido van Rossumae3b3a31993-11-30 13:43:54 +0000883def print_line(line):
Tim Peters88869f92001-01-14 23:36:06 +0000884 '''Default retrlines callback to print a line.'''
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000885 print(line)
Guido van Rossumae3b3a31993-11-30 13:43:54 +0000886
Guido van Rossum2f3941d1997-10-07 14:49:56 +0000887
Guido van Rossumd2560b01996-05-28 23:41:25 +0000888def ftpcp(source, sourcename, target, targetname = '', type = 'I'):
Tim Peters88869f92001-01-14 23:36:06 +0000889 '''Copy file from one FTP-instance to another.'''
890 if not targetname: targetname = sourcename
891 type = 'TYPE ' + type
892 source.voidcmd(type)
893 target.voidcmd(type)
894 sourcehost, sourceport = parse227(source.sendcmd('PASV'))
895 target.sendport(sourcehost, sourceport)
896 # RFC 959: the user must "listen" [...] BEFORE sending the
897 # transfer request.
898 # So: STOR before RETR, because here the target is a "user".
899 treply = target.sendcmd('STOR ' + targetname)
Raymond Hettingerd5825cc2010-09-05 23:15:06 +0000900 if treply[:3] not in {'125', '150'}: raise error_proto # RFC 959
Tim Peters88869f92001-01-14 23:36:06 +0000901 sreply = source.sendcmd('RETR ' + sourcename)
Raymond Hettingerd5825cc2010-09-05 23:15:06 +0000902 if sreply[:3] not in {'125', '150'}: raise error_proto # RFC 959
Tim Peters88869f92001-01-14 23:36:06 +0000903 source.voidresp()
904 target.voidresp()
Guido van Rossum1115ab21992-11-04 15:51:30 +0000905
Tim Peters88869f92001-01-14 23:36:06 +0000906
Guido van Rossum56d1e3a1997-03-14 04:16:54 +0000907class Netrc:
Tim Peters88869f92001-01-14 23:36:06 +0000908 """Class to parse & provide access to 'netrc' format files.
Fred Drake475d51d1997-06-24 22:02:54 +0000909
Tim Peters88869f92001-01-14 23:36:06 +0000910 See the netrc(4) man page for information on the file format.
Guido van Rossum56d1e3a1997-03-14 04:16:54 +0000911
Tim Peters88869f92001-01-14 23:36:06 +0000912 WARNING: This class is obsolete -- use module netrc instead.
Guido van Rossumc822a451998-12-22 16:49:16 +0000913
Tim Peters88869f92001-01-14 23:36:06 +0000914 """
915 __defuser = None
916 __defpasswd = None
917 __defacct = None
Guido van Rossum56d1e3a1997-03-14 04:16:54 +0000918
Tim Peters88869f92001-01-14 23:36:06 +0000919 def __init__(self, filename=None):
Raymond Hettinger094662a2002-06-01 01:29:16 +0000920 if filename is None:
Raymond Hettinger54f02222002-06-01 14:18:47 +0000921 if "HOME" in os.environ:
Tim Peters88869f92001-01-14 23:36:06 +0000922 filename = os.path.join(os.environ["HOME"],
923 ".netrc")
924 else:
Collin Winterce36ad82007-08-30 01:19:48 +0000925 raise IOError("specify file to load or set $HOME")
Tim Peters88869f92001-01-14 23:36:06 +0000926 self.__hosts = {}
927 self.__macros = {}
928 fp = open(filename, "r")
929 in_macro = 0
930 while 1:
931 line = fp.readline()
932 if not line: break
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000933 if in_macro and line.strip():
Tim Peters88869f92001-01-14 23:36:06 +0000934 macro_lines.append(line)
935 continue
936 elif in_macro:
937 self.__macros[macro_name] = tuple(macro_lines)
938 in_macro = 0
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000939 words = line.split()
Tim Peters88869f92001-01-14 23:36:06 +0000940 host = user = passwd = acct = None
941 default = 0
942 i = 0
943 while i < len(words):
944 w1 = words[i]
945 if i+1 < len(words):
946 w2 = words[i + 1]
947 else:
948 w2 = None
949 if w1 == 'default':
950 default = 1
951 elif w1 == 'machine' and w2:
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000952 host = w2.lower()
Tim Peters88869f92001-01-14 23:36:06 +0000953 i = i + 1
954 elif w1 == 'login' and w2:
955 user = w2
956 i = i + 1
957 elif w1 == 'password' and w2:
958 passwd = w2
959 i = i + 1
960 elif w1 == 'account' and w2:
961 acct = w2
962 i = i + 1
963 elif w1 == 'macdef' and w2:
964 macro_name = w2
965 macro_lines = []
966 in_macro = 1
967 break
968 i = i + 1
969 if default:
970 self.__defuser = user or self.__defuser
971 self.__defpasswd = passwd or self.__defpasswd
972 self.__defacct = acct or self.__defacct
973 if host:
Raymond Hettinger54f02222002-06-01 14:18:47 +0000974 if host in self.__hosts:
Tim Peters88869f92001-01-14 23:36:06 +0000975 ouser, opasswd, oacct = \
976 self.__hosts[host]
977 user = user or ouser
978 passwd = passwd or opasswd
979 acct = acct or oacct
980 self.__hosts[host] = user, passwd, acct
981 fp.close()
Guido van Rossum56d1e3a1997-03-14 04:16:54 +0000982
Tim Peters88869f92001-01-14 23:36:06 +0000983 def get_hosts(self):
984 """Return a list of hosts mentioned in the .netrc file."""
985 return self.__hosts.keys()
Guido van Rossum8ca84201998-03-26 20:56:10 +0000986
Tim Peters88869f92001-01-14 23:36:06 +0000987 def get_account(self, host):
988 """Returns login information for the named host.
Guido van Rossum8ca84201998-03-26 20:56:10 +0000989
Tim Peters88869f92001-01-14 23:36:06 +0000990 The return value is a triple containing userid,
991 password, and the accounting field.
Guido van Rossum8ca84201998-03-26 20:56:10 +0000992
Tim Peters88869f92001-01-14 23:36:06 +0000993 """
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000994 host = host.lower()
Tim Peters88869f92001-01-14 23:36:06 +0000995 user = passwd = acct = None
Raymond Hettinger54f02222002-06-01 14:18:47 +0000996 if host in self.__hosts:
Tim Peters88869f92001-01-14 23:36:06 +0000997 user, passwd, acct = self.__hosts[host]
998 user = user or self.__defuser
999 passwd = passwd or self.__defpasswd
1000 acct = acct or self.__defacct
1001 return user, passwd, acct
Guido van Rossum8ca84201998-03-26 20:56:10 +00001002
Tim Peters88869f92001-01-14 23:36:06 +00001003 def get_macros(self):
1004 """Return a list of all defined macro names."""
1005 return self.__macros.keys()
Guido van Rossum8ca84201998-03-26 20:56:10 +00001006
Tim Peters88869f92001-01-14 23:36:06 +00001007 def get_macro(self, macro):
1008 """Return a sequence of lines which define a named macro."""
1009 return self.__macros[macro]
Guido van Rossum56d1e3a1997-03-14 04:16:54 +00001010
Fred Drake475d51d1997-06-24 22:02:54 +00001011
Tim Peters88869f92001-01-14 23:36:06 +00001012
Guido van Rossum1115ab21992-11-04 15:51:30 +00001013def test():
Tim Peters88869f92001-01-14 23:36:06 +00001014 '''Test program.
Raymond Hettingerc88a6c72005-04-05 04:31:09 +00001015 Usage: ftp [-d] [-r[file]] host [-l[dir]] [-d[dir]] [-p] [file] ...
1016
1017 -d dir
1018 -l list
1019 -p password
1020 '''
1021
1022 if len(sys.argv) < 2:
Guido van Rossumbe19ed72007-02-09 05:37:30 +00001023 print(test.__doc__)
Raymond Hettingerc88a6c72005-04-05 04:31:09 +00001024 sys.exit(0)
Guido van Rossumd2560b01996-05-28 23:41:25 +00001025
Tim Peters88869f92001-01-14 23:36:06 +00001026 debugging = 0
1027 rcfile = None
1028 while sys.argv[1] == '-d':
1029 debugging = debugging+1
1030 del sys.argv[1]
1031 if sys.argv[1][:2] == '-r':
1032 # get name of alternate ~/.netrc file:
1033 rcfile = sys.argv[1][2:]
1034 del sys.argv[1]
1035 host = sys.argv[1]
1036 ftp = FTP(host)
1037 ftp.set_debuglevel(debugging)
1038 userid = passwd = acct = ''
1039 try:
1040 netrc = Netrc(rcfile)
1041 except IOError:
1042 if rcfile is not None:
1043 sys.stderr.write("Could not open account file"
1044 " -- using anonymous login.")
1045 else:
1046 try:
1047 userid, passwd, acct = netrc.get_account(host)
1048 except KeyError:
1049 # no account for host
1050 sys.stderr.write(
1051 "No account -- using anonymous login.")
1052 ftp.login(userid, passwd, acct)
1053 for file in sys.argv[2:]:
1054 if file[:2] == '-l':
1055 ftp.dir(file[2:])
1056 elif file[:2] == '-d':
1057 cmd = 'CWD'
1058 if file[2:]: cmd = cmd + ' ' + file[2:]
1059 resp = ftp.sendcmd(cmd)
1060 elif file == '-p':
1061 ftp.set_pasv(not ftp.passiveserver)
1062 else:
1063 ftp.retrbinary('RETR ' + file, \
1064 sys.stdout.write, 1024)
1065 ftp.quit()
Guido van Rossum221ec0b1995-08-04 04:39:30 +00001066
1067
1068if __name__ == '__main__':
Tim Peters88869f92001-01-14 23:36:06 +00001069 test()