blob: cdc893b537540588b7c50c02828d8b7263bb5ab8 [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.
35#
Guido van Rossumc567c601992-11-05 22:22:37 +000036
Guido van Rossum1115ab21992-11-04 15:51:30 +000037import os
38import sys
Guido van Rossum1115ab21992-11-04 15:51:30 +000039
Guido van Rossumb6775db1994-08-01 11:34:53 +000040# Import SOCKS module if it exists, else standard socket module socket
41try:
Tim Peters88869f92001-01-14 23:36:06 +000042 import SOCKS; socket = SOCKS; del SOCKS # import SOCKS as socket
43 from socket import getfqdn; socket.getfqdn = getfqdn; del getfqdn
Guido van Rossumb6775db1994-08-01 11:34:53 +000044except ImportError:
Tim Peters88869f92001-01-14 23:36:06 +000045 import socket
Guido van Rossumb6775db1994-08-01 11:34:53 +000046
Skip Montanaroeccd02a2001-01-20 23:34:12 +000047__all__ = ["FTP","Netrc"]
Guido van Rossum1115ab21992-11-04 15:51:30 +000048
Guido van Rossumd3166071993-05-24 14:16:22 +000049# Magic number from <socket.h>
Tim Peters88869f92001-01-14 23:36:06 +000050MSG_OOB = 0x1 # Process data out of band
Guido van Rossumd3166071993-05-24 14:16:22 +000051
52
Guido van Rossumc567c601992-11-05 22:22:37 +000053# The standard FTP server control port
Guido van Rossum1115ab21992-11-04 15:51:30 +000054FTP_PORT = 21
Guido van Rossum1115ab21992-11-04 15:51:30 +000055
56
Guido van Rossum21974791992-11-06 13:34:17 +000057# Exception raised when an error or invalid response is received
Fred Drake227b1202000-08-17 05:06:49 +000058class Error(Exception): pass
Tim Peters88869f92001-01-14 23:36:06 +000059class error_reply(Error): pass # unexpected [123]xx reply
60class error_temp(Error): pass # 4xx errors
61class error_perm(Error): pass # 5xx errors
62class error_proto(Error): pass # response does not begin with [1-5]
Guido van Rossum1115ab21992-11-04 15:51:30 +000063
64
Guido van Rossum21974791992-11-06 13:34:17 +000065# All exceptions (hopefully) that may be raised here and that aren't
66# (always) programming errors on our side
Fred Drake227b1202000-08-17 05:06:49 +000067all_errors = (Error, socket.error, IOError, EOFError)
Guido van Rossum21974791992-11-06 13:34:17 +000068
69
Guido van Rossum1115ab21992-11-04 15:51:30 +000070# Line terminators (we always output CRLF, but accept any of CRLF, CR, LF)
71CRLF = '\r\n'
72
73
Guido van Rossum1115ab21992-11-04 15:51:30 +000074# The class itself
75class FTP:
76
Tim Peters88869f92001-01-14 23:36:06 +000077 '''An FTP client class.
Guido van Rossumd2560b01996-05-28 23:41:25 +000078
Guido van Rossumd8faa362007-04-27 19:54:29 +000079 To create a connection, call the class using these arguments:
80 host, user, passwd, acct, timeout
81
82 The first four arguments are all strings, and have default value ''.
83 timeout must be numeric and defaults to None if not passed,
84 meaning that no timeout will be set on any ftp socket(s)
85 If a timeout is passed, then this is now the default timeout for all ftp
86 socket operations for this instance.
87
Tim Peters88869f92001-01-14 23:36:06 +000088 Then use self.connect() with optional host and port argument.
Guido van Rossumd2560b01996-05-28 23:41:25 +000089
Tim Peters88869f92001-01-14 23:36:06 +000090 To download a file, use ftp.retrlines('RETR ' + filename),
91 or ftp.retrbinary() with slightly different arguments.
92 To upload a file, use ftp.storlines() or ftp.storbinary(),
93 which have an open file as argument (see their definitions
94 below for details).
95 The download/upload functions first issue appropriate TYPE
96 and PORT or PASV commands.
Guido van Rossumd2560b01996-05-28 23:41:25 +000097'''
98
Fred Drake9c98a422001-02-28 21:46:37 +000099 debugging = 0
100 host = ''
101 port = FTP_PORT
102 sock = None
103 file = None
104 welcome = None
105 passiveserver = 1
106
Tim Peters88869f92001-01-14 23:36:06 +0000107 # Initialization method (called by class instantiation).
108 # Initialize host to localhost, port to standard ftp port
109 # Optional arguments are host (for connect()),
110 # and user, passwd, acct (for login())
Guido van Rossumd8faa362007-04-27 19:54:29 +0000111 def __init__(self, host='', user='', passwd='', acct='', timeout=None):
112 self.timeout = timeout
Tim Peters88869f92001-01-14 23:36:06 +0000113 if host:
Fred Drake9c98a422001-02-28 21:46:37 +0000114 self.connect(host)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000115 if user:
116 self.login(user, passwd, acct)
Guido van Rossum52fc1f61993-06-17 12:38:10 +0000117
Guido van Rossumd8faa362007-04-27 19:54:29 +0000118 def connect(self, host='', port=0, timeout=None):
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000119 '''Connect to host. Arguments are:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000120 - host: hostname to connect to (string, default previous host)
121 - port: port to connect to (integer, default previous port)
122 '''
123 if host != '':
124 self.host = host
125 if port > 0:
126 self.port = port
127 if timeout is not None:
128 self.timeout = timeout
129 self.sock = socket.create_connection((self.host, self.port), self.timeout)
130 self.af = self.sock.family
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000131 self.file = self.sock.makefile('rb')
132 self.welcome = self.getresp()
133 return self.welcome
Guido van Rossum1115ab21992-11-04 15:51:30 +0000134
Tim Peters88869f92001-01-14 23:36:06 +0000135 def getwelcome(self):
136 '''Get the welcome message from the server.
137 (this is read and squirreled away by connect())'''
138 if self.debugging:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000139 print('*welcome*', self.sanitize(self.welcome))
Tim Peters88869f92001-01-14 23:36:06 +0000140 return self.welcome
Guido van Rossum1115ab21992-11-04 15:51:30 +0000141
Tim Peters88869f92001-01-14 23:36:06 +0000142 def set_debuglevel(self, level):
143 '''Set the debugging level.
144 The required argument level means:
145 0: no debugging output (default)
146 1: print commands and responses but not body text etc.
147 2: also print raw lines read and sent before stripping CR/LF'''
148 self.debugging = level
149 debug = set_debuglevel
Guido van Rossum1115ab21992-11-04 15:51:30 +0000150
Tim Peters88869f92001-01-14 23:36:06 +0000151 def set_pasv(self, val):
152 '''Use passive or active mode for data transfers.
153 With a false argument, use the normal PORT mode,
154 With a true argument, use the PASV command.'''
155 self.passiveserver = val
Guido van Rossumd2560b01996-05-28 23:41:25 +0000156
Tim Peters88869f92001-01-14 23:36:06 +0000157 # Internal: "sanitize" a string for printing
158 def sanitize(self, s):
159 if s[:5] == 'pass ' or s[:5] == 'PASS ':
160 i = len(s)
161 while i > 5 and s[i-1] in '\r\n':
162 i = i-1
163 s = s[:5] + '*'*(i-5) + s[i:]
Walter Dörwald70a6b492004-02-12 17:35:32 +0000164 return repr(s)
Guido van Rossumebaf1041995-05-05 15:54:14 +0000165
Tim Peters88869f92001-01-14 23:36:06 +0000166 # Internal: send one line to the server, appending CRLF
167 def putline(self, line):
168 line = line + CRLF
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000169 if self.debugging > 1: print('*put*', self.sanitize(line))
Martin v. Löwise12454f2002-02-16 23:06:19 +0000170 self.sock.sendall(line)
Guido van Rossum1115ab21992-11-04 15:51:30 +0000171
Tim Peters88869f92001-01-14 23:36:06 +0000172 # Internal: send one command to the server (through putline())
173 def putcmd(self, line):
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000174 if self.debugging: print('*cmd*', self.sanitize(line))
Tim Peters88869f92001-01-14 23:36:06 +0000175 self.putline(line)
Guido van Rossum1115ab21992-11-04 15:51:30 +0000176
Tim Peters88869f92001-01-14 23:36:06 +0000177 # Internal: return one line from the server, stripping CRLF.
178 # Raise EOFError if the connection is closed
179 def getline(self):
180 line = self.file.readline()
181 if self.debugging > 1:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000182 print('*get*', self.sanitize(line))
Tim Peters88869f92001-01-14 23:36:06 +0000183 if not line: raise EOFError
184 if line[-2:] == CRLF: line = line[:-2]
185 elif line[-1:] in CRLF: line = line[:-1]
186 return line
Guido van Rossum1115ab21992-11-04 15:51:30 +0000187
Tim Peters88869f92001-01-14 23:36:06 +0000188 # Internal: get a response from the server, which may possibly
189 # consist of multiple lines. Return a single string with no
190 # trailing CRLF. If the response consists of multiple lines,
191 # these are separated by '\n' characters in the string
192 def getmultiline(self):
193 line = self.getline()
194 if line[3:4] == '-':
195 code = line[:3]
196 while 1:
197 nextline = self.getline()
198 line = line + ('\n' + nextline)
199 if nextline[:3] == code and \
200 nextline[3:4] != '-':
201 break
202 return line
Guido van Rossum1115ab21992-11-04 15:51:30 +0000203
Tim Peters88869f92001-01-14 23:36:06 +0000204 # Internal: get a response from the server.
205 # Raise various errors if the response indicates an error
206 def getresp(self):
207 resp = self.getmultiline()
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000208 if self.debugging: print('*resp*', self.sanitize(resp))
Tim Peters88869f92001-01-14 23:36:06 +0000209 self.lastresp = resp[:3]
210 c = resp[:1]
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000211 if c in ('1', '2', '3'):
212 return resp
Tim Peters88869f92001-01-14 23:36:06 +0000213 if c == '4':
214 raise error_temp, resp
215 if c == '5':
216 raise error_perm, resp
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000217 raise error_proto, resp
Guido van Rossum1115ab21992-11-04 15:51:30 +0000218
Tim Peters88869f92001-01-14 23:36:06 +0000219 def voidresp(self):
220 """Expect a response beginning with '2'."""
221 resp = self.getresp()
222 if resp[0] != '2':
223 raise error_reply, resp
224 return resp
Guido van Rossumc567c601992-11-05 22:22:37 +0000225
Tim Peters88869f92001-01-14 23:36:06 +0000226 def abort(self):
227 '''Abort a file transfer. Uses out-of-band data.
228 This does not follow the procedure from the RFC to send Telnet
229 IP and Synch; that doesn't seem to work with the servers I've
230 tried. Instead, just send the ABOR command as OOB data.'''
231 line = 'ABOR' + CRLF
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000232 if self.debugging > 1: print('*put urgent*', self.sanitize(line))
Martin v. Löwise12454f2002-02-16 23:06:19 +0000233 self.sock.sendall(line, MSG_OOB)
Tim Peters88869f92001-01-14 23:36:06 +0000234 resp = self.getmultiline()
235 if resp[:3] not in ('426', '226'):
236 raise error_proto, resp
Guido van Rossumd3166071993-05-24 14:16:22 +0000237
Tim Peters88869f92001-01-14 23:36:06 +0000238 def sendcmd(self, cmd):
239 '''Send a command and return the response.'''
240 self.putcmd(cmd)
241 return self.getresp()
Guido van Rossum1115ab21992-11-04 15:51:30 +0000242
Tim Peters88869f92001-01-14 23:36:06 +0000243 def voidcmd(self, cmd):
244 """Send a command and expect a response beginning with '2'."""
245 self.putcmd(cmd)
246 return self.voidresp()
Guido van Rossumc567c601992-11-05 22:22:37 +0000247
Tim Peters88869f92001-01-14 23:36:06 +0000248 def sendport(self, host, port):
249 '''Send a PORT command with the current host and the given
250 port number.
251 '''
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000252 hbytes = host.split('.')
Walter Dörwald70a6b492004-02-12 17:35:32 +0000253 pbytes = [repr(port/256), repr(port%256)]
Tim Peters88869f92001-01-14 23:36:06 +0000254 bytes = hbytes + pbytes
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000255 cmd = 'PORT ' + ','.join(bytes)
Tim Peters88869f92001-01-14 23:36:06 +0000256 return self.voidcmd(cmd)
Guido van Rossum1115ab21992-11-04 15:51:30 +0000257
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000258 def sendeprt(self, host, port):
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000259 '''Send a EPRT command with the current host and the given port number.'''
260 af = 0
261 if self.af == socket.AF_INET:
262 af = 1
263 if self.af == socket.AF_INET6:
264 af = 2
265 if af == 0:
266 raise error_proto, 'unsupported address family'
Walter Dörwald70a6b492004-02-12 17:35:32 +0000267 fields = ['', repr(af), host, repr(port), '']
Neal Norwitz7ce734c2002-05-31 14:13:04 +0000268 cmd = 'EPRT ' + '|'.join(fields)
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000269 return self.voidcmd(cmd)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000270
Tim Peters88869f92001-01-14 23:36:06 +0000271 def makeport(self):
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000272 '''Create a new socket and send a PORT command for it.'''
Martin v. Löwis2ad25692001-07-31 08:40:21 +0000273 msg = "getaddrinfo returns an empty list"
Martin v. Löwis322c0d12001-10-07 08:53:32 +0000274 sock = None
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000275 for res in socket.getaddrinfo(None, 0, self.af, socket.SOCK_STREAM, 0, socket.AI_PASSIVE):
276 af, socktype, proto, canonname, sa = res
277 try:
278 sock = socket.socket(af, socktype, proto)
279 sock.bind(sa)
Guido van Rossumb940e112007-01-10 16:19:56 +0000280 except socket.error as msg:
Martin v. Löwis322c0d12001-10-07 08:53:32 +0000281 if sock:
282 sock.close()
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000283 sock = None
284 continue
285 break
286 if not sock:
287 raise socket.error, msg
288 sock.listen(1)
289 port = sock.getsockname()[1] # Get proper port
290 host = self.sock.getsockname()[0] # Get proper host
291 if self.af == socket.AF_INET:
292 resp = self.sendport(host, port)
293 else:
294 resp = self.sendeprt(host, port)
295 return sock
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000296
297 def makepasv(self):
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000298 if self.af == socket.AF_INET:
299 host, port = parse227(self.sendcmd('PASV'))
300 else:
301 host, port = parse229(self.sendcmd('EPSV'), self.sock.getpeername())
302 return host, port
Guido van Rossum1115ab21992-11-04 15:51:30 +0000303
Tim Peters88869f92001-01-14 23:36:06 +0000304 def ntransfercmd(self, cmd, rest=None):
305 """Initiate a transfer over the data connection.
Barry Warsaw100d81e2000-09-01 06:09:23 +0000306
Tim Peters88869f92001-01-14 23:36:06 +0000307 If the transfer is active, send a port command and the
308 transfer command, and accept the connection. If the server is
309 passive, send a pasv command, connect to it, and start the
310 transfer command. Either way, return the socket for the
311 connection and the expected size of the transfer. The
312 expected size may be None if it could not be determined.
Barry Warsaw100d81e2000-09-01 06:09:23 +0000313
Tim Peters88869f92001-01-14 23:36:06 +0000314 Optional `rest' argument can be a string that is sent as the
315 argument to a RESTART command. This is essentially a server
316 marker used to tell the server to skip over any data up to the
317 given marker.
318 """
319 size = None
320 if self.passiveserver:
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000321 host, port = self.makepasv()
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000322 af, socktype, proto, canon, sa = socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM)[0]
323 conn = socket.socket(af, socktype, proto)
324 conn.connect(sa)
Tim Peters88869f92001-01-14 23:36:06 +0000325 if rest is not None:
326 self.sendcmd("REST %s" % rest)
327 resp = self.sendcmd(cmd)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000328 # Some servers apparently send a 200 reply to
329 # a LIST or STOR command, before the 150 reply
330 # (and way before the 226 reply). This seems to
331 # be in violation of the protocol (which only allows
332 # 1xx or error messages for LIST), so we just discard
333 # this response.
334 if resp[0] == '2':
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000335 resp = self.getresp()
Tim Peters88869f92001-01-14 23:36:06 +0000336 if resp[0] != '1':
337 raise error_reply, resp
338 else:
339 sock = self.makeport()
340 if rest is not None:
341 self.sendcmd("REST %s" % rest)
342 resp = self.sendcmd(cmd)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000343 # See above.
344 if resp[0] == '2':
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000345 resp = self.getresp()
Tim Peters88869f92001-01-14 23:36:06 +0000346 if resp[0] != '1':
347 raise error_reply, resp
348 conn, sockaddr = sock.accept()
349 if resp[:3] == '150':
350 # this is conditional in case we received a 125
351 size = parse150(resp)
352 return conn, size
Fred Drake4de02d91997-01-10 18:26:09 +0000353
Tim Peters88869f92001-01-14 23:36:06 +0000354 def transfercmd(self, cmd, rest=None):
Guido van Rossumb6aca6a2001-10-16 19:45:52 +0000355 """Like ntransfercmd() but returns only the socket."""
Tim Peters88869f92001-01-14 23:36:06 +0000356 return self.ntransfercmd(cmd, rest)[0]
Guido van Rossumc567c601992-11-05 22:22:37 +0000357
Tim Peters88869f92001-01-14 23:36:06 +0000358 def login(self, user = '', passwd = '', acct = ''):
359 '''Login, default anonymous.'''
360 if not user: user = 'anonymous'
361 if not passwd: passwd = ''
362 if not acct: acct = ''
363 if user == 'anonymous' and passwd in ('', '-'):
Tim Peterse4418602002-02-16 07:34:19 +0000364 # If there is no anonymous ftp password specified
365 # then we'll just use anonymous@
366 # We don't send any other thing because:
367 # - We want to remain anonymous
368 # - We want to stop SPAM
369 # - We don't want to let ftp sites to discriminate by the user,
370 # host or country.
Guido van Rossumc33e0772001-12-28 20:54:28 +0000371 passwd = passwd + 'anonymous@'
Tim Peters88869f92001-01-14 23:36:06 +0000372 resp = self.sendcmd('USER ' + user)
373 if resp[0] == '3': resp = self.sendcmd('PASS ' + passwd)
374 if resp[0] == '3': resp = self.sendcmd('ACCT ' + acct)
375 if resp[0] != '2':
376 raise error_reply, resp
377 return resp
Guido van Rossumc567c601992-11-05 22:22:37 +0000378
Tim Peters88869f92001-01-14 23:36:06 +0000379 def retrbinary(self, cmd, callback, blocksize=8192, rest=None):
380 """Retrieve data in binary mode.
Barry Warsaw100d81e2000-09-01 06:09:23 +0000381
Tim Peters88869f92001-01-14 23:36:06 +0000382 `cmd' is a RETR command. `callback' is a callback function is
383 called for each block. No more than `blocksize' number of
384 bytes will be read from the socket. Optional `rest' is passed
385 to transfercmd().
Guido van Rossum1115ab21992-11-04 15:51:30 +0000386
Tim Peters88869f92001-01-14 23:36:06 +0000387 A new port is created for you. Return the response code.
388 """
389 self.voidcmd('TYPE I')
390 conn = self.transfercmd(cmd, rest)
391 while 1:
392 data = conn.recv(blocksize)
393 if not data:
394 break
395 callback(data)
396 conn.close()
397 return self.voidresp()
Guido van Rossum1115ab21992-11-04 15:51:30 +0000398
Tim Peters88869f92001-01-14 23:36:06 +0000399 def retrlines(self, cmd, callback = None):
400 '''Retrieve data in line mode.
401 The argument is a RETR or LIST command.
402 The callback function (2nd argument) is called for each line,
403 with trailing CRLF stripped. This creates a new port for you.
404 print_line() is the default callback.'''
Raymond Hettingere874fc32002-05-12 05:53:51 +0000405 if callback is None: callback = print_line
Tim Peters88869f92001-01-14 23:36:06 +0000406 resp = self.sendcmd('TYPE A')
407 conn = self.transfercmd(cmd)
408 fp = conn.makefile('rb')
409 while 1:
410 line = fp.readline()
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000411 if self.debugging > 2: print('*retr*', repr(line))
Tim Peters88869f92001-01-14 23:36:06 +0000412 if not line:
413 break
414 if line[-2:] == CRLF:
415 line = line[:-2]
416 elif line[-1:] == '\n':
417 line = line[:-1]
418 callback(line)
419 fp.close()
420 conn.close()
421 return self.voidresp()
Guido van Rossumc567c601992-11-05 22:22:37 +0000422
Guido van Rossum4ac83472001-02-15 13:50:36 +0000423 def storbinary(self, cmd, fp, blocksize=8192):
Tim Peters88869f92001-01-14 23:36:06 +0000424 '''Store a file in binary mode.'''
425 self.voidcmd('TYPE I')
426 conn = self.transfercmd(cmd)
427 while 1:
428 buf = fp.read(blocksize)
429 if not buf: break
Martin v. Löwise12454f2002-02-16 23:06:19 +0000430 conn.sendall(buf)
Tim Peters88869f92001-01-14 23:36:06 +0000431 conn.close()
432 return self.voidresp()
Guido van Rossumc567c601992-11-05 22:22:37 +0000433
Tim Peters88869f92001-01-14 23:36:06 +0000434 def storlines(self, cmd, fp):
435 '''Store a file in line mode.'''
436 self.voidcmd('TYPE A')
437 conn = self.transfercmd(cmd)
438 while 1:
439 buf = fp.readline()
440 if not buf: break
441 if buf[-2:] != CRLF:
442 if buf[-1] in CRLF: buf = buf[:-1]
443 buf = buf + CRLF
Martin v. Löwise12454f2002-02-16 23:06:19 +0000444 conn.sendall(buf)
Tim Peters88869f92001-01-14 23:36:06 +0000445 conn.close()
446 return self.voidresp()
Guido van Rossum0eaa74b1996-01-25 18:37:21 +0000447
Tim Peters88869f92001-01-14 23:36:06 +0000448 def acct(self, password):
449 '''Send new account name.'''
450 cmd = 'ACCT ' + password
451 return self.voidcmd(cmd)
Guido van Rossumc567c601992-11-05 22:22:37 +0000452
Tim Peters88869f92001-01-14 23:36:06 +0000453 def nlst(self, *args):
454 '''Return a list of files in a given directory (default the current).'''
455 cmd = 'NLST'
456 for arg in args:
457 cmd = cmd + (' ' + arg)
458 files = []
459 self.retrlines(cmd, files.append)
460 return files
Guido van Rossumae3b3a31993-11-30 13:43:54 +0000461
Tim Peters88869f92001-01-14 23:36:06 +0000462 def dir(self, *args):
463 '''List a directory in long form.
464 By default list current directory to stdout.
465 Optional last argument is callback function; all
466 non-empty arguments before it are concatenated to the
467 LIST command. (This *should* only be used for a pathname.)'''
468 cmd = 'LIST'
469 func = None
470 if args[-1:] and type(args[-1]) != type(''):
471 args, func = args[:-1], args[-1]
472 for arg in args:
473 if arg:
474 cmd = cmd + (' ' + arg)
475 self.retrlines(cmd, func)
Guido van Rossumc567c601992-11-05 22:22:37 +0000476
Tim Peters88869f92001-01-14 23:36:06 +0000477 def rename(self, fromname, toname):
478 '''Rename a file.'''
479 resp = self.sendcmd('RNFR ' + fromname)
480 if resp[0] != '3':
481 raise error_reply, resp
482 return self.voidcmd('RNTO ' + toname)
Guido van Rossuma61bdeb1995-10-11 17:36:31 +0000483
Tim Peters88869f92001-01-14 23:36:06 +0000484 def delete(self, filename):
485 '''Delete a file.'''
486 resp = self.sendcmd('DELE ' + filename)
487 if resp[:3] in ('250', '200'):
488 return resp
489 elif resp[:1] == '5':
490 raise error_perm, resp
491 else:
492 raise error_reply, resp
Guido van Rossum02cf5821993-05-17 08:00:02 +0000493
Tim Peters88869f92001-01-14 23:36:06 +0000494 def cwd(self, dirname):
495 '''Change to a directory.'''
496 if dirname == '..':
497 try:
498 return self.voidcmd('CDUP')
Guido van Rossumb940e112007-01-10 16:19:56 +0000499 except error_perm as msg:
Martin v. Löwisb5255112002-03-10 15:59:58 +0000500 if msg.args[0][:3] != '500':
501 raise
Tim Peters88869f92001-01-14 23:36:06 +0000502 elif dirname == '':
503 dirname = '.' # does nothing, but could return error
504 cmd = 'CWD ' + dirname
505 return self.voidcmd(cmd)
Guido van Rossum17ed1ae1993-06-01 13:21:04 +0000506
Tim Peters88869f92001-01-14 23:36:06 +0000507 def size(self, filename):
508 '''Retrieve the size of a file.'''
509 # Note that the RFC doesn't say anything about 'SIZE'
510 resp = self.sendcmd('SIZE ' + filename)
511 if resp[:3] == '213':
Guido van Rossumb6aca6a2001-10-16 19:45:52 +0000512 s = resp[3:].strip()
513 try:
514 return int(s)
Guido van Rossum1f74cb32001-10-17 17:21:47 +0000515 except (OverflowError, ValueError):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000516 return int(s)
Guido van Rossumc567c601992-11-05 22:22:37 +0000517
Tim Peters88869f92001-01-14 23:36:06 +0000518 def mkd(self, dirname):
519 '''Make a directory, return its full pathname.'''
520 resp = self.sendcmd('MKD ' + dirname)
521 return parse257(resp)
Guido van Rossum98245091998-02-19 21:15:44 +0000522
Tim Peters88869f92001-01-14 23:36:06 +0000523 def rmd(self, dirname):
524 '''Remove a directory.'''
525 return self.voidcmd('RMD ' + dirname)
Guido van Rossum1115ab21992-11-04 15:51:30 +0000526
Tim Peters88869f92001-01-14 23:36:06 +0000527 def pwd(self):
528 '''Return current working directory.'''
529 resp = self.sendcmd('PWD')
530 return parse257(resp)
Guido van Rossum17ed1ae1993-06-01 13:21:04 +0000531
Tim Peters88869f92001-01-14 23:36:06 +0000532 def quit(self):
533 '''Quit, and close the connection.'''
534 resp = self.voidcmd('QUIT')
535 self.close()
536 return resp
537
538 def close(self):
539 '''Close the connection without assuming anything about it.'''
Fred Drake9c98a422001-02-28 21:46:37 +0000540 if self.file:
541 self.file.close()
542 self.sock.close()
543 self.file = self.sock = None
Guido van Rossumc567c601992-11-05 22:22:37 +0000544
545
Guido van Rossumacfb82a1997-10-22 20:49:52 +0000546_150_re = None
Fred Drake4de02d91997-01-10 18:26:09 +0000547
548def parse150(resp):
Tim Peters88869f92001-01-14 23:36:06 +0000549 '''Parse the '150' response for a RETR request.
550 Returns the expected transfer size or None; size is not guaranteed to
551 be present in the 150 message.
552 '''
553 if resp[:3] != '150':
554 raise error_reply, resp
555 global _150_re
556 if _150_re is None:
557 import re
558 _150_re = re.compile("150 .* \((\d+) bytes\)", re.IGNORECASE)
559 m = _150_re.match(resp)
Guido van Rossumb6aca6a2001-10-16 19:45:52 +0000560 if not m:
561 return None
562 s = m.group(1)
563 try:
564 return int(s)
Guido van Rossum1f74cb32001-10-17 17:21:47 +0000565 except (OverflowError, ValueError):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000566 return int(s)
Fred Drake4de02d91997-01-10 18:26:09 +0000567
568
Guido van Rossum70297d32001-08-17 17:24:29 +0000569_227_re = None
570
Guido van Rossumd2560b01996-05-28 23:41:25 +0000571def parse227(resp):
Tim Peters88869f92001-01-14 23:36:06 +0000572 '''Parse the '227' response for a PASV request.
573 Raises error_proto if it does not contain '(h1,h2,h3,h4,p1,p2)'
574 Return ('host.addr.as.numbers', port#) tuple.'''
Guido van Rossumd2560b01996-05-28 23:41:25 +0000575
Tim Peters88869f92001-01-14 23:36:06 +0000576 if resp[:3] != '227':
577 raise error_reply, resp
Guido van Rossum70297d32001-08-17 17:24:29 +0000578 global _227_re
579 if _227_re is None:
580 import re
581 _227_re = re.compile(r'(\d+),(\d+),(\d+),(\d+),(\d+),(\d+)')
582 m = _227_re.search(resp)
583 if not m:
Tim Peters88869f92001-01-14 23:36:06 +0000584 raise error_proto, resp
Guido van Rossum70297d32001-08-17 17:24:29 +0000585 numbers = m.groups()
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000586 host = '.'.join(numbers[:4])
587 port = (int(numbers[4]) << 8) + int(numbers[5])
Tim Peters88869f92001-01-14 23:36:06 +0000588 return host, port
Guido van Rossumd2560b01996-05-28 23:41:25 +0000589
590
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000591def parse229(resp, peer):
592 '''Parse the '229' response for a EPSV request.
593 Raises error_proto if it does not contain '(|||port|)'
594 Return ('host.addr.as.numbers', port#) tuple.'''
595
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000596 if resp[:3] != '229':
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000597 raise error_reply, resp
Neal Norwitz7ce734c2002-05-31 14:13:04 +0000598 left = resp.find('(')
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000599 if left < 0: raise error_proto, resp
Neal Norwitz7ce734c2002-05-31 14:13:04 +0000600 right = resp.find(')', left + 1)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000601 if right < 0:
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000602 raise error_proto, resp # should contain '(|||port|)'
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000603 if resp[left + 1] != resp[right - 1]:
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000604 raise error_proto, resp
Walter Dörwalda401ae42002-06-03 10:41:45 +0000605 parts = resp[left + 1:right].split(resp[left+1])
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000606 if len(parts) != 5:
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000607 raise error_proto, resp
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000608 host = peer[0]
Neal Norwitz7ce734c2002-05-31 14:13:04 +0000609 port = int(parts[3])
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000610 return host, port
611
612
Guido van Rossumc567c601992-11-05 22:22:37 +0000613def parse257(resp):
Tim Peters88869f92001-01-14 23:36:06 +0000614 '''Parse the '257' response for a MKD or PWD request.
615 This is a response to a MKD or PWD request: a directory name.
616 Returns the directoryname in the 257 reply.'''
Guido van Rossumd2560b01996-05-28 23:41:25 +0000617
Tim Peters88869f92001-01-14 23:36:06 +0000618 if resp[:3] != '257':
619 raise error_reply, resp
620 if resp[3:5] != ' "':
621 return '' # Not compliant to RFC 959, but UNIX ftpd does this
622 dirname = ''
623 i = 5
624 n = len(resp)
625 while i < n:
626 c = resp[i]
627 i = i+1
628 if c == '"':
629 if i >= n or resp[i] != '"':
630 break
631 i = i+1
632 dirname = dirname + c
633 return dirname
Guido van Rossum1115ab21992-11-04 15:51:30 +0000634
Guido van Rossum2f3941d1997-10-07 14:49:56 +0000635
Guido van Rossumae3b3a31993-11-30 13:43:54 +0000636def print_line(line):
Tim Peters88869f92001-01-14 23:36:06 +0000637 '''Default retrlines callback to print a line.'''
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000638 print(line)
Guido van Rossumae3b3a31993-11-30 13:43:54 +0000639
Guido van Rossum2f3941d1997-10-07 14:49:56 +0000640
Guido van Rossumd2560b01996-05-28 23:41:25 +0000641def ftpcp(source, sourcename, target, targetname = '', type = 'I'):
Tim Peters88869f92001-01-14 23:36:06 +0000642 '''Copy file from one FTP-instance to another.'''
643 if not targetname: targetname = sourcename
644 type = 'TYPE ' + type
645 source.voidcmd(type)
646 target.voidcmd(type)
647 sourcehost, sourceport = parse227(source.sendcmd('PASV'))
648 target.sendport(sourcehost, sourceport)
649 # RFC 959: the user must "listen" [...] BEFORE sending the
650 # transfer request.
651 # So: STOR before RETR, because here the target is a "user".
652 treply = target.sendcmd('STOR ' + targetname)
653 if treply[:3] not in ('125', '150'): raise error_proto # RFC 959
654 sreply = source.sendcmd('RETR ' + sourcename)
655 if sreply[:3] not in ('125', '150'): raise error_proto # RFC 959
656 source.voidresp()
657 target.voidresp()
Guido van Rossum1115ab21992-11-04 15:51:30 +0000658
Tim Peters88869f92001-01-14 23:36:06 +0000659
Guido van Rossum56d1e3a1997-03-14 04:16:54 +0000660class Netrc:
Tim Peters88869f92001-01-14 23:36:06 +0000661 """Class to parse & provide access to 'netrc' format files.
Fred Drake475d51d1997-06-24 22:02:54 +0000662
Tim Peters88869f92001-01-14 23:36:06 +0000663 See the netrc(4) man page for information on the file format.
Guido van Rossum56d1e3a1997-03-14 04:16:54 +0000664
Tim Peters88869f92001-01-14 23:36:06 +0000665 WARNING: This class is obsolete -- use module netrc instead.
Guido van Rossumc822a451998-12-22 16:49:16 +0000666
Tim Peters88869f92001-01-14 23:36:06 +0000667 """
668 __defuser = None
669 __defpasswd = None
670 __defacct = None
Guido van Rossum56d1e3a1997-03-14 04:16:54 +0000671
Tim Peters88869f92001-01-14 23:36:06 +0000672 def __init__(self, filename=None):
Raymond Hettinger094662a2002-06-01 01:29:16 +0000673 if filename is None:
Raymond Hettinger54f02222002-06-01 14:18:47 +0000674 if "HOME" in os.environ:
Tim Peters88869f92001-01-14 23:36:06 +0000675 filename = os.path.join(os.environ["HOME"],
676 ".netrc")
677 else:
678 raise IOError, \
679 "specify file to load or set $HOME"
680 self.__hosts = {}
681 self.__macros = {}
682 fp = open(filename, "r")
683 in_macro = 0
684 while 1:
685 line = fp.readline()
686 if not line: break
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000687 if in_macro and line.strip():
Tim Peters88869f92001-01-14 23:36:06 +0000688 macro_lines.append(line)
689 continue
690 elif in_macro:
691 self.__macros[macro_name] = tuple(macro_lines)
692 in_macro = 0
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000693 words = line.split()
Tim Peters88869f92001-01-14 23:36:06 +0000694 host = user = passwd = acct = None
695 default = 0
696 i = 0
697 while i < len(words):
698 w1 = words[i]
699 if i+1 < len(words):
700 w2 = words[i + 1]
701 else:
702 w2 = None
703 if w1 == 'default':
704 default = 1
705 elif w1 == 'machine' and w2:
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000706 host = w2.lower()
Tim Peters88869f92001-01-14 23:36:06 +0000707 i = i + 1
708 elif w1 == 'login' and w2:
709 user = w2
710 i = i + 1
711 elif w1 == 'password' and w2:
712 passwd = w2
713 i = i + 1
714 elif w1 == 'account' and w2:
715 acct = w2
716 i = i + 1
717 elif w1 == 'macdef' and w2:
718 macro_name = w2
719 macro_lines = []
720 in_macro = 1
721 break
722 i = i + 1
723 if default:
724 self.__defuser = user or self.__defuser
725 self.__defpasswd = passwd or self.__defpasswd
726 self.__defacct = acct or self.__defacct
727 if host:
Raymond Hettinger54f02222002-06-01 14:18:47 +0000728 if host in self.__hosts:
Tim Peters88869f92001-01-14 23:36:06 +0000729 ouser, opasswd, oacct = \
730 self.__hosts[host]
731 user = user or ouser
732 passwd = passwd or opasswd
733 acct = acct or oacct
734 self.__hosts[host] = user, passwd, acct
735 fp.close()
Guido van Rossum56d1e3a1997-03-14 04:16:54 +0000736
Tim Peters88869f92001-01-14 23:36:06 +0000737 def get_hosts(self):
738 """Return a list of hosts mentioned in the .netrc file."""
739 return self.__hosts.keys()
Guido van Rossum8ca84201998-03-26 20:56:10 +0000740
Tim Peters88869f92001-01-14 23:36:06 +0000741 def get_account(self, host):
742 """Returns login information for the named host.
Guido van Rossum8ca84201998-03-26 20:56:10 +0000743
Tim Peters88869f92001-01-14 23:36:06 +0000744 The return value is a triple containing userid,
745 password, and the accounting field.
Guido van Rossum8ca84201998-03-26 20:56:10 +0000746
Tim Peters88869f92001-01-14 23:36:06 +0000747 """
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000748 host = host.lower()
Tim Peters88869f92001-01-14 23:36:06 +0000749 user = passwd = acct = None
Raymond Hettinger54f02222002-06-01 14:18:47 +0000750 if host in self.__hosts:
Tim Peters88869f92001-01-14 23:36:06 +0000751 user, passwd, acct = self.__hosts[host]
752 user = user or self.__defuser
753 passwd = passwd or self.__defpasswd
754 acct = acct or self.__defacct
755 return user, passwd, acct
Guido van Rossum8ca84201998-03-26 20:56:10 +0000756
Tim Peters88869f92001-01-14 23:36:06 +0000757 def get_macros(self):
758 """Return a list of all defined macro names."""
759 return self.__macros.keys()
Guido van Rossum8ca84201998-03-26 20:56:10 +0000760
Tim Peters88869f92001-01-14 23:36:06 +0000761 def get_macro(self, macro):
762 """Return a sequence of lines which define a named macro."""
763 return self.__macros[macro]
Guido van Rossum56d1e3a1997-03-14 04:16:54 +0000764
Fred Drake475d51d1997-06-24 22:02:54 +0000765
Tim Peters88869f92001-01-14 23:36:06 +0000766
Guido van Rossum1115ab21992-11-04 15:51:30 +0000767def test():
Tim Peters88869f92001-01-14 23:36:06 +0000768 '''Test program.
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000769 Usage: ftp [-d] [-r[file]] host [-l[dir]] [-d[dir]] [-p] [file] ...
770
771 -d dir
772 -l list
773 -p password
774 '''
775
776 if len(sys.argv) < 2:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000777 print(test.__doc__)
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000778 sys.exit(0)
Guido van Rossumd2560b01996-05-28 23:41:25 +0000779
Tim Peters88869f92001-01-14 23:36:06 +0000780 debugging = 0
781 rcfile = None
782 while sys.argv[1] == '-d':
783 debugging = debugging+1
784 del sys.argv[1]
785 if sys.argv[1][:2] == '-r':
786 # get name of alternate ~/.netrc file:
787 rcfile = sys.argv[1][2:]
788 del sys.argv[1]
789 host = sys.argv[1]
790 ftp = FTP(host)
791 ftp.set_debuglevel(debugging)
792 userid = passwd = acct = ''
793 try:
794 netrc = Netrc(rcfile)
795 except IOError:
796 if rcfile is not None:
797 sys.stderr.write("Could not open account file"
798 " -- using anonymous login.")
799 else:
800 try:
801 userid, passwd, acct = netrc.get_account(host)
802 except KeyError:
803 # no account for host
804 sys.stderr.write(
805 "No account -- using anonymous login.")
806 ftp.login(userid, passwd, acct)
807 for file in sys.argv[2:]:
808 if file[:2] == '-l':
809 ftp.dir(file[2:])
810 elif file[:2] == '-d':
811 cmd = 'CWD'
812 if file[2:]: cmd = cmd + ' ' + file[2:]
813 resp = ftp.sendcmd(cmd)
814 elif file == '-p':
815 ftp.set_pasv(not ftp.passiveserver)
816 else:
817 ftp.retrbinary('RETR ' + file, \
818 sys.stdout.write, 1024)
819 ftp.quit()
Guido van Rossum221ec0b1995-08-04 04:39:30 +0000820
821
822if __name__ == '__main__':
Tim Peters88869f92001-01-14 23:36:06 +0000823 test()