blob: 634bbde7adedec0b5a0dd187dbb79845dbe70843 [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 Rossum52b89762007-07-17 20:45:57 +000097 '''
Guido van Rossumd2560b01996-05-28 23:41:25 +000098
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
Guido van Rossum52b89762007-07-17 20:45:57 +0000106 encoding = "ASCII"
Fred Drake9c98a422001-02-28 21:46:37 +0000107
Tim Peters88869f92001-01-14 23:36:06 +0000108 # Initialization method (called by class instantiation).
109 # Initialize host to localhost, port to standard ftp port
110 # Optional arguments are host (for connect()),
111 # and user, passwd, acct (for login())
Guido van Rossumd8faa362007-04-27 19:54:29 +0000112 def __init__(self, host='', user='', passwd='', acct='', timeout=None):
113 self.timeout = timeout
Tim Peters88869f92001-01-14 23:36:06 +0000114 if host:
Fred Drake9c98a422001-02-28 21:46:37 +0000115 self.connect(host)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000116 if user:
117 self.login(user, passwd, acct)
Guido van Rossum52fc1f61993-06-17 12:38:10 +0000118
Guido van Rossumd8faa362007-04-27 19:54:29 +0000119 def connect(self, host='', port=0, timeout=None):
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000120 '''Connect to host. Arguments are:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000121 - host: hostname to connect to (string, default previous host)
122 - port: port to connect to (integer, default previous port)
123 '''
124 if host != '':
125 self.host = host
126 if port > 0:
127 self.port = port
128 if timeout is not None:
129 self.timeout = timeout
130 self.sock = socket.create_connection((self.host, self.port), self.timeout)
131 self.af = self.sock.family
Guido van Rossum52b89762007-07-17 20:45:57 +0000132 self.file = self.sock.makefile('r', encoding=self.encoding)
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000133 self.welcome = self.getresp()
134 return self.welcome
Guido van Rossum1115ab21992-11-04 15:51:30 +0000135
Tim Peters88869f92001-01-14 23:36:06 +0000136 def getwelcome(self):
137 '''Get the welcome message from the server.
138 (this is read and squirreled away by connect())'''
139 if self.debugging:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000140 print('*welcome*', self.sanitize(self.welcome))
Tim Peters88869f92001-01-14 23:36:06 +0000141 return self.welcome
Guido van Rossum1115ab21992-11-04 15:51:30 +0000142
Tim Peters88869f92001-01-14 23:36:06 +0000143 def set_debuglevel(self, level):
144 '''Set the debugging level.
145 The required argument level means:
146 0: no debugging output (default)
147 1: print commands and responses but not body text etc.
148 2: also print raw lines read and sent before stripping CR/LF'''
149 self.debugging = level
150 debug = set_debuglevel
Guido van Rossum1115ab21992-11-04 15:51:30 +0000151
Tim Peters88869f92001-01-14 23:36:06 +0000152 def set_pasv(self, val):
153 '''Use passive or active mode for data transfers.
154 With a false argument, use the normal PORT mode,
155 With a true argument, use the PASV command.'''
156 self.passiveserver = val
Guido van Rossumd2560b01996-05-28 23:41:25 +0000157
Tim Peters88869f92001-01-14 23:36:06 +0000158 # Internal: "sanitize" a string for printing
159 def sanitize(self, s):
160 if s[:5] == 'pass ' or s[:5] == 'PASS ':
161 i = len(s)
162 while i > 5 and s[i-1] in '\r\n':
163 i = i-1
164 s = s[:5] + '*'*(i-5) + s[i:]
Walter Dörwald70a6b492004-02-12 17:35:32 +0000165 return repr(s)
Guido van Rossumebaf1041995-05-05 15:54:14 +0000166
Tim Peters88869f92001-01-14 23:36:06 +0000167 # Internal: send one line to the server, appending CRLF
168 def putline(self, line):
169 line = line + CRLF
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000170 if self.debugging > 1: print('*put*', self.sanitize(line))
Guido van Rossum52b89762007-07-17 20:45:57 +0000171 self.sock.sendall(line.encode(self.encoding))
Guido van Rossum1115ab21992-11-04 15:51:30 +0000172
Tim Peters88869f92001-01-14 23:36:06 +0000173 # Internal: send one command to the server (through putline())
174 def putcmd(self, line):
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000175 if self.debugging: print('*cmd*', self.sanitize(line))
Tim Peters88869f92001-01-14 23:36:06 +0000176 self.putline(line)
Guido van Rossum1115ab21992-11-04 15:51:30 +0000177
Tim Peters88869f92001-01-14 23:36:06 +0000178 # Internal: return one line from the server, stripping CRLF.
179 # Raise EOFError if the connection is closed
180 def getline(self):
181 line = self.file.readline()
182 if self.debugging > 1:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000183 print('*get*', self.sanitize(line))
Tim Peters88869f92001-01-14 23:36:06 +0000184 if not line: raise EOFError
185 if line[-2:] == CRLF: line = line[:-2]
186 elif line[-1:] in CRLF: line = line[:-1]
187 return line
Guido van Rossum1115ab21992-11-04 15:51:30 +0000188
Tim Peters88869f92001-01-14 23:36:06 +0000189 # Internal: get a response from the server, which may possibly
190 # consist of multiple lines. Return a single string with no
191 # trailing CRLF. If the response consists of multiple lines,
192 # these are separated by '\n' characters in the string
193 def getmultiline(self):
194 line = self.getline()
195 if line[3:4] == '-':
196 code = line[:3]
197 while 1:
198 nextline = self.getline()
199 line = line + ('\n' + nextline)
200 if nextline[:3] == code and \
201 nextline[3:4] != '-':
202 break
203 return line
Guido van Rossum1115ab21992-11-04 15:51:30 +0000204
Tim Peters88869f92001-01-14 23:36:06 +0000205 # Internal: get a response from the server.
206 # Raise various errors if the response indicates an error
207 def getresp(self):
208 resp = self.getmultiline()
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000209 if self.debugging: print('*resp*', self.sanitize(resp))
Tim Peters88869f92001-01-14 23:36:06 +0000210 self.lastresp = resp[:3]
211 c = resp[:1]
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000212 if c in ('1', '2', '3'):
213 return resp
Tim Peters88869f92001-01-14 23:36:06 +0000214 if c == '4':
215 raise error_temp, resp
216 if c == '5':
217 raise error_perm, resp
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000218 raise error_proto, resp
Guido van Rossum1115ab21992-11-04 15:51:30 +0000219
Tim Peters88869f92001-01-14 23:36:06 +0000220 def voidresp(self):
221 """Expect a response beginning with '2'."""
222 resp = self.getresp()
223 if resp[0] != '2':
224 raise error_reply, resp
225 return resp
Guido van Rossumc567c601992-11-05 22:22:37 +0000226
Tim Peters88869f92001-01-14 23:36:06 +0000227 def abort(self):
228 '''Abort a file transfer. Uses out-of-band data.
229 This does not follow the procedure from the RFC to send Telnet
230 IP and Synch; that doesn't seem to work with the servers I've
231 tried. Instead, just send the ABOR command as OOB data.'''
232 line = 'ABOR' + CRLF
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000233 if self.debugging > 1: print('*put urgent*', self.sanitize(line))
Martin v. Löwise12454f2002-02-16 23:06:19 +0000234 self.sock.sendall(line, MSG_OOB)
Tim Peters88869f92001-01-14 23:36:06 +0000235 resp = self.getmultiline()
236 if resp[:3] not in ('426', '226'):
237 raise error_proto, resp
Guido van Rossumd3166071993-05-24 14:16:22 +0000238
Tim Peters88869f92001-01-14 23:36:06 +0000239 def sendcmd(self, cmd):
240 '''Send a command and return the response.'''
241 self.putcmd(cmd)
242 return self.getresp()
Guido van Rossum1115ab21992-11-04 15:51:30 +0000243
Tim Peters88869f92001-01-14 23:36:06 +0000244 def voidcmd(self, cmd):
245 """Send a command and expect a response beginning with '2'."""
246 self.putcmd(cmd)
247 return self.voidresp()
Guido van Rossumc567c601992-11-05 22:22:37 +0000248
Tim Peters88869f92001-01-14 23:36:06 +0000249 def sendport(self, host, port):
250 '''Send a PORT command with the current host and the given
251 port number.
252 '''
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000253 hbytes = host.split('.')
Walter Dörwald70a6b492004-02-12 17:35:32 +0000254 pbytes = [repr(port/256), repr(port%256)]
Tim Peters88869f92001-01-14 23:36:06 +0000255 bytes = hbytes + pbytes
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000256 cmd = 'PORT ' + ','.join(bytes)
Tim Peters88869f92001-01-14 23:36:06 +0000257 return self.voidcmd(cmd)
Guido van Rossum1115ab21992-11-04 15:51:30 +0000258
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000259 def sendeprt(self, host, port):
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000260 '''Send a EPRT command with the current host and the given port number.'''
261 af = 0
262 if self.af == socket.AF_INET:
263 af = 1
264 if self.af == socket.AF_INET6:
265 af = 2
266 if af == 0:
267 raise error_proto, 'unsupported address family'
Walter Dörwald70a6b492004-02-12 17:35:32 +0000268 fields = ['', repr(af), host, repr(port), '']
Neal Norwitz7ce734c2002-05-31 14:13:04 +0000269 cmd = 'EPRT ' + '|'.join(fields)
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000270 return self.voidcmd(cmd)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000271
Tim Peters88869f92001-01-14 23:36:06 +0000272 def makeport(self):
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000273 '''Create a new socket and send a PORT command for it.'''
Martin v. Löwis2ad25692001-07-31 08:40:21 +0000274 msg = "getaddrinfo returns an empty list"
Martin v. Löwis322c0d12001-10-07 08:53:32 +0000275 sock = None
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000276 for res in socket.getaddrinfo(None, 0, self.af, socket.SOCK_STREAM, 0, socket.AI_PASSIVE):
277 af, socktype, proto, canonname, sa = res
278 try:
279 sock = socket.socket(af, socktype, proto)
280 sock.bind(sa)
Guido van Rossumb940e112007-01-10 16:19:56 +0000281 except socket.error as msg:
Martin v. Löwis322c0d12001-10-07 08:53:32 +0000282 if sock:
283 sock.close()
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000284 sock = None
285 continue
286 break
287 if not sock:
288 raise socket.error, msg
289 sock.listen(1)
290 port = sock.getsockname()[1] # Get proper port
291 host = self.sock.getsockname()[0] # Get proper host
292 if self.af == socket.AF_INET:
293 resp = self.sendport(host, port)
294 else:
295 resp = self.sendeprt(host, port)
296 return sock
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000297
298 def makepasv(self):
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000299 if self.af == socket.AF_INET:
300 host, port = parse227(self.sendcmd('PASV'))
301 else:
302 host, port = parse229(self.sendcmd('EPSV'), self.sock.getpeername())
303 return host, port
Guido van Rossum1115ab21992-11-04 15:51:30 +0000304
Tim Peters88869f92001-01-14 23:36:06 +0000305 def ntransfercmd(self, cmd, rest=None):
306 """Initiate a transfer over the data connection.
Barry Warsaw100d81e2000-09-01 06:09:23 +0000307
Tim Peters88869f92001-01-14 23:36:06 +0000308 If the transfer is active, send a port command and the
309 transfer command, and accept the connection. If the server is
310 passive, send a pasv command, connect to it, and start the
311 transfer command. Either way, return the socket for the
312 connection and the expected size of the transfer. The
313 expected size may be None if it could not be determined.
Barry Warsaw100d81e2000-09-01 06:09:23 +0000314
Tim Peters88869f92001-01-14 23:36:06 +0000315 Optional `rest' argument can be a string that is sent as the
316 argument to a RESTART command. This is essentially a server
317 marker used to tell the server to skip over any data up to the
318 given marker.
319 """
320 size = None
321 if self.passiveserver:
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000322 host, port = self.makepasv()
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000323 conn = socket.create_connection((host, port), self.timeout)
Tim Peters88869f92001-01-14 23:36:06 +0000324 if rest is not None:
325 self.sendcmd("REST %s" % rest)
326 resp = self.sendcmd(cmd)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000327 # Some servers apparently send a 200 reply to
328 # a LIST or STOR command, before the 150 reply
329 # (and way before the 226 reply). This seems to
330 # be in violation of the protocol (which only allows
331 # 1xx or error messages for LIST), so we just discard
332 # this response.
333 if resp[0] == '2':
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000334 resp = self.getresp()
Tim Peters88869f92001-01-14 23:36:06 +0000335 if resp[0] != '1':
336 raise error_reply, resp
337 else:
338 sock = self.makeport()
339 if rest is not None:
340 self.sendcmd("REST %s" % rest)
341 resp = self.sendcmd(cmd)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000342 # See above.
343 if resp[0] == '2':
Thomas Wouters9fe394c2007-02-05 01:24:16 +0000344 resp = self.getresp()
Tim Peters88869f92001-01-14 23:36:06 +0000345 if resp[0] != '1':
346 raise error_reply, resp
347 conn, sockaddr = sock.accept()
348 if resp[:3] == '150':
349 # this is conditional in case we received a 125
350 size = parse150(resp)
351 return conn, size
Fred Drake4de02d91997-01-10 18:26:09 +0000352
Tim Peters88869f92001-01-14 23:36:06 +0000353 def transfercmd(self, cmd, rest=None):
Guido van Rossumb6aca6a2001-10-16 19:45:52 +0000354 """Like ntransfercmd() but returns only the socket."""
Tim Peters88869f92001-01-14 23:36:06 +0000355 return self.ntransfercmd(cmd, rest)[0]
Guido van Rossumc567c601992-11-05 22:22:37 +0000356
Tim Peters88869f92001-01-14 23:36:06 +0000357 def login(self, user = '', passwd = '', acct = ''):
358 '''Login, default anonymous.'''
359 if not user: user = 'anonymous'
360 if not passwd: passwd = ''
361 if not acct: acct = ''
362 if user == 'anonymous' and passwd in ('', '-'):
Tim Peterse4418602002-02-16 07:34:19 +0000363 # If there is no anonymous ftp password specified
364 # then we'll just use anonymous@
365 # We don't send any other thing because:
366 # - We want to remain anonymous
367 # - We want to stop SPAM
368 # - We don't want to let ftp sites to discriminate by the user,
369 # host or country.
Guido van Rossumc33e0772001-12-28 20:54:28 +0000370 passwd = passwd + 'anonymous@'
Tim Peters88869f92001-01-14 23:36:06 +0000371 resp = self.sendcmd('USER ' + user)
372 if resp[0] == '3': resp = self.sendcmd('PASS ' + passwd)
373 if resp[0] == '3': resp = self.sendcmd('ACCT ' + acct)
374 if resp[0] != '2':
375 raise error_reply, resp
376 return resp
Guido van Rossumc567c601992-11-05 22:22:37 +0000377
Tim Peters88869f92001-01-14 23:36:06 +0000378 def retrbinary(self, cmd, callback, blocksize=8192, rest=None):
379 """Retrieve data in binary mode.
Barry Warsaw100d81e2000-09-01 06:09:23 +0000380
Tim Peters88869f92001-01-14 23:36:06 +0000381 `cmd' is a RETR command. `callback' is a callback function is
382 called for each block. No more than `blocksize' number of
383 bytes will be read from the socket. Optional `rest' is passed
384 to transfercmd().
Guido van Rossum1115ab21992-11-04 15:51:30 +0000385
Tim Peters88869f92001-01-14 23:36:06 +0000386 A new port is created for you. Return the response code.
387 """
388 self.voidcmd('TYPE I')
389 conn = self.transfercmd(cmd, rest)
390 while 1:
391 data = conn.recv(blocksize)
392 if not data:
393 break
394 callback(data)
395 conn.close()
396 return self.voidresp()
Guido van Rossum1115ab21992-11-04 15:51:30 +0000397
Tim Peters88869f92001-01-14 23:36:06 +0000398 def retrlines(self, cmd, callback = None):
399 '''Retrieve data in line mode.
400 The argument is a RETR or LIST command.
401 The callback function (2nd argument) is called for each line,
402 with trailing CRLF stripped. This creates a new port for you.
403 print_line() is the default callback.'''
Raymond Hettingere874fc32002-05-12 05:53:51 +0000404 if callback is None: callback = print_line
Tim Peters88869f92001-01-14 23:36:06 +0000405 resp = self.sendcmd('TYPE A')
406 conn = self.transfercmd(cmd)
Guido van Rossum52b89762007-07-17 20:45:57 +0000407 fp = conn.makefile('r', encoding=self.encoding)
Tim Peters88869f92001-01-14 23:36:06 +0000408 while 1:
409 line = fp.readline()
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000410 if self.debugging > 2: print('*retr*', repr(line))
Tim Peters88869f92001-01-14 23:36:06 +0000411 if not line:
412 break
413 if line[-2:] == CRLF:
414 line = line[:-2]
415 elif line[-1:] == '\n':
416 line = line[:-1]
417 callback(line)
418 fp.close()
419 conn.close()
420 return self.voidresp()
Guido van Rossumc567c601992-11-05 22:22:37 +0000421
Guido van Rossum4ac83472001-02-15 13:50:36 +0000422 def storbinary(self, cmd, fp, blocksize=8192):
Tim Peters88869f92001-01-14 23:36:06 +0000423 '''Store a file in binary mode.'''
424 self.voidcmd('TYPE I')
425 conn = self.transfercmd(cmd)
426 while 1:
427 buf = fp.read(blocksize)
428 if not buf: break
Martin v. Löwise12454f2002-02-16 23:06:19 +0000429 conn.sendall(buf)
Tim Peters88869f92001-01-14 23:36:06 +0000430 conn.close()
431 return self.voidresp()
Guido van Rossumc567c601992-11-05 22:22:37 +0000432
Tim Peters88869f92001-01-14 23:36:06 +0000433 def storlines(self, cmd, fp):
434 '''Store a file in line mode.'''
435 self.voidcmd('TYPE A')
436 conn = self.transfercmd(cmd)
437 while 1:
438 buf = fp.readline()
439 if not buf: break
440 if buf[-2:] != CRLF:
441 if buf[-1] in CRLF: buf = buf[:-1]
442 buf = buf + CRLF
Martin v. Löwise12454f2002-02-16 23:06:19 +0000443 conn.sendall(buf)
Tim Peters88869f92001-01-14 23:36:06 +0000444 conn.close()
445 return self.voidresp()
Guido van Rossum0eaa74b1996-01-25 18:37:21 +0000446
Tim Peters88869f92001-01-14 23:36:06 +0000447 def acct(self, password):
448 '''Send new account name.'''
449 cmd = 'ACCT ' + password
450 return self.voidcmd(cmd)
Guido van Rossumc567c601992-11-05 22:22:37 +0000451
Tim Peters88869f92001-01-14 23:36:06 +0000452 def nlst(self, *args):
453 '''Return a list of files in a given directory (default the current).'''
454 cmd = 'NLST'
455 for arg in args:
456 cmd = cmd + (' ' + arg)
457 files = []
458 self.retrlines(cmd, files.append)
459 return files
Guido van Rossumae3b3a31993-11-30 13:43:54 +0000460
Tim Peters88869f92001-01-14 23:36:06 +0000461 def dir(self, *args):
462 '''List a directory in long form.
463 By default list current directory to stdout.
464 Optional last argument is callback function; all
465 non-empty arguments before it are concatenated to the
466 LIST command. (This *should* only be used for a pathname.)'''
467 cmd = 'LIST'
468 func = None
469 if args[-1:] and type(args[-1]) != type(''):
470 args, func = args[:-1], args[-1]
471 for arg in args:
472 if arg:
473 cmd = cmd + (' ' + arg)
474 self.retrlines(cmd, func)
Guido van Rossumc567c601992-11-05 22:22:37 +0000475
Tim Peters88869f92001-01-14 23:36:06 +0000476 def rename(self, fromname, toname):
477 '''Rename a file.'''
478 resp = self.sendcmd('RNFR ' + fromname)
479 if resp[0] != '3':
480 raise error_reply, resp
481 return self.voidcmd('RNTO ' + toname)
Guido van Rossuma61bdeb1995-10-11 17:36:31 +0000482
Tim Peters88869f92001-01-14 23:36:06 +0000483 def delete(self, filename):
484 '''Delete a file.'''
485 resp = self.sendcmd('DELE ' + filename)
486 if resp[:3] in ('250', '200'):
487 return resp
488 elif resp[:1] == '5':
489 raise error_perm, resp
490 else:
491 raise error_reply, resp
Guido van Rossum02cf5821993-05-17 08:00:02 +0000492
Tim Peters88869f92001-01-14 23:36:06 +0000493 def cwd(self, dirname):
494 '''Change to a directory.'''
495 if dirname == '..':
496 try:
497 return self.voidcmd('CDUP')
Guido van Rossumb940e112007-01-10 16:19:56 +0000498 except error_perm as msg:
Martin v. Löwisb5255112002-03-10 15:59:58 +0000499 if msg.args[0][:3] != '500':
500 raise
Tim Peters88869f92001-01-14 23:36:06 +0000501 elif dirname == '':
502 dirname = '.' # does nothing, but could return error
503 cmd = 'CWD ' + dirname
504 return self.voidcmd(cmd)
Guido van Rossum17ed1ae1993-06-01 13:21:04 +0000505
Tim Peters88869f92001-01-14 23:36:06 +0000506 def size(self, filename):
507 '''Retrieve the size of a file.'''
508 # Note that the RFC doesn't say anything about 'SIZE'
509 resp = self.sendcmd('SIZE ' + filename)
510 if resp[:3] == '213':
Guido van Rossumb6aca6a2001-10-16 19:45:52 +0000511 s = resp[3:].strip()
512 try:
513 return int(s)
Guido van Rossum1f74cb32001-10-17 17:21:47 +0000514 except (OverflowError, ValueError):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000515 return int(s)
Guido van Rossumc567c601992-11-05 22:22:37 +0000516
Tim Peters88869f92001-01-14 23:36:06 +0000517 def mkd(self, dirname):
518 '''Make a directory, return its full pathname.'''
519 resp = self.sendcmd('MKD ' + dirname)
520 return parse257(resp)
Guido van Rossum98245091998-02-19 21:15:44 +0000521
Tim Peters88869f92001-01-14 23:36:06 +0000522 def rmd(self, dirname):
523 '''Remove a directory.'''
524 return self.voidcmd('RMD ' + dirname)
Guido van Rossum1115ab21992-11-04 15:51:30 +0000525
Tim Peters88869f92001-01-14 23:36:06 +0000526 def pwd(self):
527 '''Return current working directory.'''
528 resp = self.sendcmd('PWD')
529 return parse257(resp)
Guido van Rossum17ed1ae1993-06-01 13:21:04 +0000530
Tim Peters88869f92001-01-14 23:36:06 +0000531 def quit(self):
532 '''Quit, and close the connection.'''
533 resp = self.voidcmd('QUIT')
534 self.close()
535 return resp
536
537 def close(self):
538 '''Close the connection without assuming anything about it.'''
Fred Drake9c98a422001-02-28 21:46:37 +0000539 if self.file:
540 self.file.close()
541 self.sock.close()
542 self.file = self.sock = None
Guido van Rossumc567c601992-11-05 22:22:37 +0000543
544
Guido van Rossumacfb82a1997-10-22 20:49:52 +0000545_150_re = None
Fred Drake4de02d91997-01-10 18:26:09 +0000546
547def parse150(resp):
Tim Peters88869f92001-01-14 23:36:06 +0000548 '''Parse the '150' response for a RETR request.
549 Returns the expected transfer size or None; size is not guaranteed to
550 be present in the 150 message.
551 '''
552 if resp[:3] != '150':
553 raise error_reply, resp
554 global _150_re
555 if _150_re is None:
556 import re
557 _150_re = re.compile("150 .* \((\d+) bytes\)", re.IGNORECASE)
558 m = _150_re.match(resp)
Guido van Rossumb6aca6a2001-10-16 19:45:52 +0000559 if not m:
560 return None
561 s = m.group(1)
562 try:
563 return int(s)
Guido van Rossum1f74cb32001-10-17 17:21:47 +0000564 except (OverflowError, ValueError):
Guido van Rossume2a383d2007-01-15 16:59:06 +0000565 return int(s)
Fred Drake4de02d91997-01-10 18:26:09 +0000566
567
Guido van Rossum70297d32001-08-17 17:24:29 +0000568_227_re = None
569
Guido van Rossumd2560b01996-05-28 23:41:25 +0000570def parse227(resp):
Tim Peters88869f92001-01-14 23:36:06 +0000571 '''Parse the '227' response for a PASV request.
572 Raises error_proto if it does not contain '(h1,h2,h3,h4,p1,p2)'
573 Return ('host.addr.as.numbers', port#) tuple.'''
Guido van Rossumd2560b01996-05-28 23:41:25 +0000574
Tim Peters88869f92001-01-14 23:36:06 +0000575 if resp[:3] != '227':
576 raise error_reply, resp
Guido van Rossum70297d32001-08-17 17:24:29 +0000577 global _227_re
578 if _227_re is None:
579 import re
580 _227_re = re.compile(r'(\d+),(\d+),(\d+),(\d+),(\d+),(\d+)')
581 m = _227_re.search(resp)
582 if not m:
Tim Peters88869f92001-01-14 23:36:06 +0000583 raise error_proto, resp
Guido van Rossum70297d32001-08-17 17:24:29 +0000584 numbers = m.groups()
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000585 host = '.'.join(numbers[:4])
586 port = (int(numbers[4]) << 8) + int(numbers[5])
Tim Peters88869f92001-01-14 23:36:06 +0000587 return host, port
Guido van Rossumd2560b01996-05-28 23:41:25 +0000588
589
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000590def parse229(resp, peer):
591 '''Parse the '229' response for a EPSV request.
592 Raises error_proto if it does not contain '(|||port|)'
593 Return ('host.addr.as.numbers', port#) tuple.'''
594
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000595 if resp[:3] != '229':
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000596 raise error_reply, resp
Neal Norwitz7ce734c2002-05-31 14:13:04 +0000597 left = resp.find('(')
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000598 if left < 0: raise error_proto, resp
Neal Norwitz7ce734c2002-05-31 14:13:04 +0000599 right = resp.find(')', left + 1)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000600 if right < 0:
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000601 raise error_proto, resp # should contain '(|||port|)'
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000602 if resp[left + 1] != resp[right - 1]:
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000603 raise error_proto, resp
Walter Dörwalda401ae42002-06-03 10:41:45 +0000604 parts = resp[left + 1:right].split(resp[left+1])
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000605 if len(parts) != 5:
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000606 raise error_proto, resp
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000607 host = peer[0]
Neal Norwitz7ce734c2002-05-31 14:13:04 +0000608 port = int(parts[3])
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000609 return host, port
610
611
Guido van Rossumc567c601992-11-05 22:22:37 +0000612def parse257(resp):
Tim Peters88869f92001-01-14 23:36:06 +0000613 '''Parse the '257' response for a MKD or PWD request.
614 This is a response to a MKD or PWD request: a directory name.
615 Returns the directoryname in the 257 reply.'''
Guido van Rossumd2560b01996-05-28 23:41:25 +0000616
Tim Peters88869f92001-01-14 23:36:06 +0000617 if resp[:3] != '257':
618 raise error_reply, resp
619 if resp[3:5] != ' "':
620 return '' # Not compliant to RFC 959, but UNIX ftpd does this
621 dirname = ''
622 i = 5
623 n = len(resp)
624 while i < n:
625 c = resp[i]
626 i = i+1
627 if c == '"':
628 if i >= n or resp[i] != '"':
629 break
630 i = i+1
631 dirname = dirname + c
632 return dirname
Guido van Rossum1115ab21992-11-04 15:51:30 +0000633
Guido van Rossum2f3941d1997-10-07 14:49:56 +0000634
Guido van Rossumae3b3a31993-11-30 13:43:54 +0000635def print_line(line):
Tim Peters88869f92001-01-14 23:36:06 +0000636 '''Default retrlines callback to print a line.'''
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000637 print(line)
Guido van Rossumae3b3a31993-11-30 13:43:54 +0000638
Guido van Rossum2f3941d1997-10-07 14:49:56 +0000639
Guido van Rossumd2560b01996-05-28 23:41:25 +0000640def ftpcp(source, sourcename, target, targetname = '', type = 'I'):
Tim Peters88869f92001-01-14 23:36:06 +0000641 '''Copy file from one FTP-instance to another.'''
642 if not targetname: targetname = sourcename
643 type = 'TYPE ' + type
644 source.voidcmd(type)
645 target.voidcmd(type)
646 sourcehost, sourceport = parse227(source.sendcmd('PASV'))
647 target.sendport(sourcehost, sourceport)
648 # RFC 959: the user must "listen" [...] BEFORE sending the
649 # transfer request.
650 # So: STOR before RETR, because here the target is a "user".
651 treply = target.sendcmd('STOR ' + targetname)
652 if treply[:3] not in ('125', '150'): raise error_proto # RFC 959
653 sreply = source.sendcmd('RETR ' + sourcename)
654 if sreply[:3] not in ('125', '150'): raise error_proto # RFC 959
655 source.voidresp()
656 target.voidresp()
Guido van Rossum1115ab21992-11-04 15:51:30 +0000657
Tim Peters88869f92001-01-14 23:36:06 +0000658
Guido van Rossum56d1e3a1997-03-14 04:16:54 +0000659class Netrc:
Tim Peters88869f92001-01-14 23:36:06 +0000660 """Class to parse & provide access to 'netrc' format files.
Fred Drake475d51d1997-06-24 22:02:54 +0000661
Tim Peters88869f92001-01-14 23:36:06 +0000662 See the netrc(4) man page for information on the file format.
Guido van Rossum56d1e3a1997-03-14 04:16:54 +0000663
Tim Peters88869f92001-01-14 23:36:06 +0000664 WARNING: This class is obsolete -- use module netrc instead.
Guido van Rossumc822a451998-12-22 16:49:16 +0000665
Tim Peters88869f92001-01-14 23:36:06 +0000666 """
667 __defuser = None
668 __defpasswd = None
669 __defacct = None
Guido van Rossum56d1e3a1997-03-14 04:16:54 +0000670
Tim Peters88869f92001-01-14 23:36:06 +0000671 def __init__(self, filename=None):
Raymond Hettinger094662a2002-06-01 01:29:16 +0000672 if filename is None:
Raymond Hettinger54f02222002-06-01 14:18:47 +0000673 if "HOME" in os.environ:
Tim Peters88869f92001-01-14 23:36:06 +0000674 filename = os.path.join(os.environ["HOME"],
675 ".netrc")
676 else:
677 raise IOError, \
678 "specify file to load or set $HOME"
679 self.__hosts = {}
680 self.__macros = {}
681 fp = open(filename, "r")
682 in_macro = 0
683 while 1:
684 line = fp.readline()
685 if not line: break
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000686 if in_macro and line.strip():
Tim Peters88869f92001-01-14 23:36:06 +0000687 macro_lines.append(line)
688 continue
689 elif in_macro:
690 self.__macros[macro_name] = tuple(macro_lines)
691 in_macro = 0
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000692 words = line.split()
Tim Peters88869f92001-01-14 23:36:06 +0000693 host = user = passwd = acct = None
694 default = 0
695 i = 0
696 while i < len(words):
697 w1 = words[i]
698 if i+1 < len(words):
699 w2 = words[i + 1]
700 else:
701 w2 = None
702 if w1 == 'default':
703 default = 1
704 elif w1 == 'machine' and w2:
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000705 host = w2.lower()
Tim Peters88869f92001-01-14 23:36:06 +0000706 i = i + 1
707 elif w1 == 'login' and w2:
708 user = w2
709 i = i + 1
710 elif w1 == 'password' and w2:
711 passwd = w2
712 i = i + 1
713 elif w1 == 'account' and w2:
714 acct = w2
715 i = i + 1
716 elif w1 == 'macdef' and w2:
717 macro_name = w2
718 macro_lines = []
719 in_macro = 1
720 break
721 i = i + 1
722 if default:
723 self.__defuser = user or self.__defuser
724 self.__defpasswd = passwd or self.__defpasswd
725 self.__defacct = acct or self.__defacct
726 if host:
Raymond Hettinger54f02222002-06-01 14:18:47 +0000727 if host in self.__hosts:
Tim Peters88869f92001-01-14 23:36:06 +0000728 ouser, opasswd, oacct = \
729 self.__hosts[host]
730 user = user or ouser
731 passwd = passwd or opasswd
732 acct = acct or oacct
733 self.__hosts[host] = user, passwd, acct
734 fp.close()
Guido van Rossum56d1e3a1997-03-14 04:16:54 +0000735
Tim Peters88869f92001-01-14 23:36:06 +0000736 def get_hosts(self):
737 """Return a list of hosts mentioned in the .netrc file."""
738 return self.__hosts.keys()
Guido van Rossum8ca84201998-03-26 20:56:10 +0000739
Tim Peters88869f92001-01-14 23:36:06 +0000740 def get_account(self, host):
741 """Returns login information for the named host.
Guido van Rossum8ca84201998-03-26 20:56:10 +0000742
Tim Peters88869f92001-01-14 23:36:06 +0000743 The return value is a triple containing userid,
744 password, and the accounting field.
Guido van Rossum8ca84201998-03-26 20:56:10 +0000745
Tim Peters88869f92001-01-14 23:36:06 +0000746 """
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000747 host = host.lower()
Tim Peters88869f92001-01-14 23:36:06 +0000748 user = passwd = acct = None
Raymond Hettinger54f02222002-06-01 14:18:47 +0000749 if host in self.__hosts:
Tim Peters88869f92001-01-14 23:36:06 +0000750 user, passwd, acct = self.__hosts[host]
751 user = user or self.__defuser
752 passwd = passwd or self.__defpasswd
753 acct = acct or self.__defacct
754 return user, passwd, acct
Guido van Rossum8ca84201998-03-26 20:56:10 +0000755
Tim Peters88869f92001-01-14 23:36:06 +0000756 def get_macros(self):
757 """Return a list of all defined macro names."""
758 return self.__macros.keys()
Guido van Rossum8ca84201998-03-26 20:56:10 +0000759
Tim Peters88869f92001-01-14 23:36:06 +0000760 def get_macro(self, macro):
761 """Return a sequence of lines which define a named macro."""
762 return self.__macros[macro]
Guido van Rossum56d1e3a1997-03-14 04:16:54 +0000763
Fred Drake475d51d1997-06-24 22:02:54 +0000764
Tim Peters88869f92001-01-14 23:36:06 +0000765
Guido van Rossum1115ab21992-11-04 15:51:30 +0000766def test():
Tim Peters88869f92001-01-14 23:36:06 +0000767 '''Test program.
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000768 Usage: ftp [-d] [-r[file]] host [-l[dir]] [-d[dir]] [-p] [file] ...
769
770 -d dir
771 -l list
772 -p password
773 '''
774
775 if len(sys.argv) < 2:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000776 print(test.__doc__)
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000777 sys.exit(0)
Guido van Rossumd2560b01996-05-28 23:41:25 +0000778
Tim Peters88869f92001-01-14 23:36:06 +0000779 debugging = 0
780 rcfile = None
781 while sys.argv[1] == '-d':
782 debugging = debugging+1
783 del sys.argv[1]
784 if sys.argv[1][:2] == '-r':
785 # get name of alternate ~/.netrc file:
786 rcfile = sys.argv[1][2:]
787 del sys.argv[1]
788 host = sys.argv[1]
789 ftp = FTP(host)
790 ftp.set_debuglevel(debugging)
791 userid = passwd = acct = ''
792 try:
793 netrc = Netrc(rcfile)
794 except IOError:
795 if rcfile is not None:
796 sys.stderr.write("Could not open account file"
797 " -- using anonymous login.")
798 else:
799 try:
800 userid, passwd, acct = netrc.get_account(host)
801 except KeyError:
802 # no account for host
803 sys.stderr.write(
804 "No account -- using anonymous login.")
805 ftp.login(userid, passwd, acct)
806 for file in sys.argv[2:]:
807 if file[:2] == '-l':
808 ftp.dir(file[2:])
809 elif file[:2] == '-d':
810 cmd = 'CWD'
811 if file[2:]: cmd = cmd + ' ' + file[2:]
812 resp = ftp.sendcmd(cmd)
813 elif file == '-p':
814 ftp.set_pasv(not ftp.passiveserver)
815 else:
816 ftp.retrbinary('RETR ' + file, \
817 sys.stdout.write, 1024)
818 ftp.quit()
Guido van Rossum221ec0b1995-08-04 04:39:30 +0000819
820
821if __name__ == '__main__':
Tim Peters88869f92001-01-14 23:36:06 +0000822 test()