blob: 22decb2dbb5190a1de0469cd94008aedfbd1f384 [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.
Gregory P. Smithc64386b2008-01-22 00:19:41 +000035# Modified by Phil Schwartz to add storbinary and storlines callbacks.
Guido van Rossum98d9fd32000-02-28 15:12:25 +000036#
Guido van Rossumc567c601992-11-05 22:22:37 +000037
Guido van Rossum1115ab21992-11-04 15:51:30 +000038import os
39import sys
Guido van Rossum1115ab21992-11-04 15:51:30 +000040
Guido van Rossumb6775db1994-08-01 11:34:53 +000041# Import SOCKS module if it exists, else standard socket module socket
42try:
Tim Peters88869f92001-01-14 23:36:06 +000043 import SOCKS; socket = SOCKS; del SOCKS # import SOCKS as socket
44 from socket import getfqdn; socket.getfqdn = getfqdn; del getfqdn
Guido van Rossumb6775db1994-08-01 11:34:53 +000045except ImportError:
Tim Peters88869f92001-01-14 23:36:06 +000046 import socket
Facundo Batista4f1b1ed2008-05-29 16:39:26 +000047from socket import _GLOBAL_DEFAULT_TIMEOUT
Guido van Rossumb6775db1994-08-01 11:34:53 +000048
Skip Montanaroeccd02a2001-01-20 23:34:12 +000049__all__ = ["FTP","Netrc"]
Guido van Rossum1115ab21992-11-04 15:51:30 +000050
Guido van Rossumd3166071993-05-24 14:16:22 +000051# Magic number from <socket.h>
Tim Peters88869f92001-01-14 23:36:06 +000052MSG_OOB = 0x1 # Process data out of band
Guido van Rossumd3166071993-05-24 14:16:22 +000053
54
Guido van Rossumc567c601992-11-05 22:22:37 +000055# The standard FTP server control port
Guido van Rossum1115ab21992-11-04 15:51:30 +000056FTP_PORT = 21
Guido van Rossum1115ab21992-11-04 15:51:30 +000057
58
Guido van Rossum21974791992-11-06 13:34:17 +000059# Exception raised when an error or invalid response is received
Fred Drake227b1202000-08-17 05:06:49 +000060class Error(Exception): pass
Tim Peters88869f92001-01-14 23:36:06 +000061class error_reply(Error): pass # unexpected [123]xx reply
62class error_temp(Error): pass # 4xx errors
63class error_perm(Error): pass # 5xx errors
64class error_proto(Error): pass # response does not begin with [1-5]
Guido van Rossum1115ab21992-11-04 15:51:30 +000065
66
Guido van Rossum21974791992-11-06 13:34:17 +000067# All exceptions (hopefully) that may be raised here and that aren't
68# (always) programming errors on our side
Gregory P. Smithe6c03032008-04-12 22:24:04 +000069all_errors = (Error, IOError, EOFError)
Guido van Rossum21974791992-11-06 13:34:17 +000070
71
Guido van Rossum1115ab21992-11-04 15:51:30 +000072# Line terminators (we always output CRLF, but accept any of CRLF, CR, LF)
73CRLF = '\r\n'
74
Guido van Rossum1115ab21992-11-04 15:51:30 +000075# The class itself
76class FTP:
77
Tim Peters88869f92001-01-14 23:36:06 +000078 '''An FTP client class.
Guido van Rossumd2560b01996-05-28 23:41:25 +000079
Facundo Batista3f100992007-03-26 20:56:09 +000080 To create a connection, call the class using these arguments:
81 host, user, passwd, acct, timeout
82
83 The first four arguments are all strings, and have default value ''.
84 timeout must be numeric and defaults to None if not passed,
85 meaning that no timeout will be set on any ftp socket(s)
86 If a timeout is passed, then this is now the default timeout for all ftp
87 socket operations for this instance.
Neal Norwitz0d4c06e2007-04-25 06:30:05 +000088
Tim Peters88869f92001-01-14 23:36:06 +000089 Then use self.connect() with optional host and port argument.
Guido van Rossumd2560b01996-05-28 23:41:25 +000090
Tim Peters88869f92001-01-14 23:36:06 +000091 To download a file, use ftp.retrlines('RETR ' + filename),
92 or ftp.retrbinary() with slightly different arguments.
93 To upload a file, use ftp.storlines() or ftp.storbinary(),
94 which have an open file as argument (see their definitions
95 below for details).
96 The download/upload functions first issue appropriate TYPE
97 and PORT or PASV commands.
Guido van Rossumd2560b01996-05-28 23:41:25 +000098'''
99
Fred Drake9c98a422001-02-28 21:46:37 +0000100 debugging = 0
101 host = ''
102 port = FTP_PORT
103 sock = None
104 file = None
105 welcome = None
106 passiveserver = 1
107
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())
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000112 def __init__(self, host='', user='', passwd='', acct='',
113 timeout=_GLOBAL_DEFAULT_TIMEOUT):
Facundo Batista3f100992007-03-26 20:56:09 +0000114 self.timeout = timeout
Tim Peters88869f92001-01-14 23:36:06 +0000115 if host:
Fred Drake9c98a422001-02-28 21:46:37 +0000116 self.connect(host)
Neal Norwitz0d4c06e2007-04-25 06:30:05 +0000117 if user:
Facundo Batista3f100992007-03-26 20:56:09 +0000118 self.login(user, passwd, acct)
Guido van Rossum52fc1f61993-06-17 12:38:10 +0000119
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000120 def connect(self, host='', port=0, timeout=-999):
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000121 '''Connect to host. Arguments are:
Facundo Batista3f100992007-03-26 20:56:09 +0000122 - host: hostname to connect to (string, default previous host)
123 - port: port to connect to (integer, default previous port)
124 '''
125 if host != '':
126 self.host = host
127 if port > 0:
128 self.port = port
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000129 if timeout != -999:
Facundo Batista93c33682007-03-30 13:00:35 +0000130 self.timeout = timeout
Facundo Batista3f100992007-03-26 20:56:09 +0000131 self.sock = socket.create_connection((self.host, self.port), self.timeout)
132 self.af = self.sock.family
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000133 self.file = self.sock.makefile('rb')
134 self.welcome = self.getresp()
135 return self.welcome
Guido van Rossum1115ab21992-11-04 15:51:30 +0000136
Tim Peters88869f92001-01-14 23:36:06 +0000137 def getwelcome(self):
138 '''Get the welcome message from the server.
139 (this is read and squirreled away by connect())'''
140 if self.debugging:
141 print '*welcome*', self.sanitize(self.welcome)
142 return self.welcome
Guido van Rossum1115ab21992-11-04 15:51:30 +0000143
Tim Peters88869f92001-01-14 23:36:06 +0000144 def set_debuglevel(self, level):
145 '''Set the debugging level.
146 The required argument level means:
147 0: no debugging output (default)
148 1: print commands and responses but not body text etc.
149 2: also print raw lines read and sent before stripping CR/LF'''
150 self.debugging = level
151 debug = set_debuglevel
Guido van Rossum1115ab21992-11-04 15:51:30 +0000152
Tim Peters88869f92001-01-14 23:36:06 +0000153 def set_pasv(self, val):
154 '''Use passive or active mode for data transfers.
155 With a false argument, use the normal PORT mode,
156 With a true argument, use the PASV command.'''
157 self.passiveserver = val
Guido van Rossumd2560b01996-05-28 23:41:25 +0000158
Tim Peters88869f92001-01-14 23:36:06 +0000159 # Internal: "sanitize" a string for printing
160 def sanitize(self, s):
161 if s[:5] == 'pass ' or s[:5] == 'PASS ':
162 i = len(s)
163 while i > 5 and s[i-1] in '\r\n':
164 i = i-1
165 s = s[:5] + '*'*(i-5) + s[i:]
Walter Dörwald70a6b492004-02-12 17:35:32 +0000166 return repr(s)
Guido van Rossumebaf1041995-05-05 15:54:14 +0000167
Tim Peters88869f92001-01-14 23:36:06 +0000168 # Internal: send one line to the server, appending CRLF
169 def putline(self, line):
170 line = line + CRLF
171 if self.debugging > 1: print '*put*', self.sanitize(line)
Martin v. Löwise12454f2002-02-16 23:06:19 +0000172 self.sock.sendall(line)
Guido van Rossum1115ab21992-11-04 15:51:30 +0000173
Tim Peters88869f92001-01-14 23:36:06 +0000174 # Internal: send one command to the server (through putline())
175 def putcmd(self, line):
176 if self.debugging: print '*cmd*', self.sanitize(line)
177 self.putline(line)
Guido van Rossum1115ab21992-11-04 15:51:30 +0000178
Tim Peters88869f92001-01-14 23:36:06 +0000179 # Internal: return one line from the server, stripping CRLF.
180 # Raise EOFError if the connection is closed
181 def getline(self):
182 line = self.file.readline()
183 if self.debugging > 1:
184 print '*get*', self.sanitize(line)
185 if not line: raise EOFError
186 if line[-2:] == CRLF: line = line[:-2]
187 elif line[-1:] in CRLF: line = line[:-1]
188 return line
Guido van Rossum1115ab21992-11-04 15:51:30 +0000189
Tim Peters88869f92001-01-14 23:36:06 +0000190 # Internal: get a response from the server, which may possibly
191 # consist of multiple lines. Return a single string with no
192 # trailing CRLF. If the response consists of multiple lines,
193 # these are separated by '\n' characters in the string
194 def getmultiline(self):
195 line = self.getline()
196 if line[3:4] == '-':
197 code = line[:3]
198 while 1:
199 nextline = self.getline()
200 line = line + ('\n' + nextline)
201 if nextline[:3] == code and \
202 nextline[3:4] != '-':
203 break
204 return line
Guido van Rossum1115ab21992-11-04 15:51:30 +0000205
Tim Peters88869f92001-01-14 23:36:06 +0000206 # Internal: get a response from the server.
207 # Raise various errors if the response indicates an error
208 def getresp(self):
209 resp = self.getmultiline()
210 if self.debugging: print '*resp*', self.sanitize(resp)
211 self.lastresp = resp[:3]
212 c = resp[:1]
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000213 if c in ('1', '2', '3'):
214 return resp
Tim Peters88869f92001-01-14 23:36:06 +0000215 if c == '4':
216 raise error_temp, resp
217 if c == '5':
218 raise error_perm, resp
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000219 raise error_proto, resp
Guido van Rossum1115ab21992-11-04 15:51:30 +0000220
Tim Peters88869f92001-01-14 23:36:06 +0000221 def voidresp(self):
222 """Expect a response beginning with '2'."""
223 resp = self.getresp()
Georg Brandlf7a1efc2009-04-05 10:51:10 +0000224 if resp[:1] != '2':
Tim Peters88869f92001-01-14 23:36:06 +0000225 raise error_reply, resp
226 return resp
Guido van Rossumc567c601992-11-05 22:22:37 +0000227
Tim Peters88869f92001-01-14 23:36:06 +0000228 def abort(self):
229 '''Abort a file transfer. Uses out-of-band data.
230 This does not follow the procedure from the RFC to send Telnet
231 IP and Synch; that doesn't seem to work with the servers I've
232 tried. Instead, just send the ABOR command as OOB data.'''
233 line = 'ABOR' + CRLF
234 if self.debugging > 1: print '*put urgent*', self.sanitize(line)
Martin v. Löwise12454f2002-02-16 23:06:19 +0000235 self.sock.sendall(line, MSG_OOB)
Tim Peters88869f92001-01-14 23:36:06 +0000236 resp = self.getmultiline()
Giampaolo Rodolàfa1520a2010-04-18 13:13:54 +0000237 if resp[:3] not in ('426', '225', '226'):
Tim Peters88869f92001-01-14 23:36:06 +0000238 raise error_proto, resp
Guido van Rossumd3166071993-05-24 14:16:22 +0000239
Tim Peters88869f92001-01-14 23:36:06 +0000240 def sendcmd(self, cmd):
241 '''Send a command and return the response.'''
242 self.putcmd(cmd)
243 return self.getresp()
Guido van Rossum1115ab21992-11-04 15:51:30 +0000244
Tim Peters88869f92001-01-14 23:36:06 +0000245 def voidcmd(self, cmd):
246 """Send a command and expect a response beginning with '2'."""
247 self.putcmd(cmd)
248 return self.voidresp()
Guido van Rossumc567c601992-11-05 22:22:37 +0000249
Tim Peters88869f92001-01-14 23:36:06 +0000250 def sendport(self, host, port):
251 '''Send a PORT command with the current host and the given
252 port number.
253 '''
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000254 hbytes = host.split('.')
Benjamin Petersondee0b172008-09-27 22:08:12 +0000255 pbytes = [repr(port//256), repr(port%256)]
Tim Peters88869f92001-01-14 23:36:06 +0000256 bytes = hbytes + pbytes
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000257 cmd = 'PORT ' + ','.join(bytes)
Tim Peters88869f92001-01-14 23:36:06 +0000258 return self.voidcmd(cmd)
Guido van Rossum1115ab21992-11-04 15:51:30 +0000259
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000260 def sendeprt(self, host, port):
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000261 '''Send a EPRT command with the current host and the given port number.'''
262 af = 0
263 if self.af == socket.AF_INET:
264 af = 1
265 if self.af == socket.AF_INET6:
266 af = 2
267 if af == 0:
268 raise error_proto, 'unsupported address family'
Walter Dörwald70a6b492004-02-12 17:35:32 +0000269 fields = ['', repr(af), host, repr(port), '']
Neal Norwitz7ce734c2002-05-31 14:13:04 +0000270 cmd = 'EPRT ' + '|'.join(fields)
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000271 return self.voidcmd(cmd)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000272
Tim Peters88869f92001-01-14 23:36:06 +0000273 def makeport(self):
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000274 '''Create a new socket and send a PORT command for it.'''
Martin v. Löwis2ad25692001-07-31 08:40:21 +0000275 msg = "getaddrinfo returns an empty list"
Martin v. Löwis322c0d12001-10-07 08:53:32 +0000276 sock = None
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000277 for res in socket.getaddrinfo(None, 0, self.af, socket.SOCK_STREAM, 0, socket.AI_PASSIVE):
278 af, socktype, proto, canonname, sa = res
279 try:
280 sock = socket.socket(af, socktype, proto)
281 sock.bind(sa)
282 except socket.error, msg:
Martin v. Löwis322c0d12001-10-07 08:53:32 +0000283 if sock:
284 sock.close()
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000285 sock = None
286 continue
287 break
288 if not sock:
289 raise socket.error, msg
290 sock.listen(1)
291 port = sock.getsockname()[1] # Get proper port
292 host = self.sock.getsockname()[0] # Get proper host
293 if self.af == socket.AF_INET:
294 resp = self.sendport(host, port)
295 else:
296 resp = self.sendeprt(host, port)
Giampaolo Rodolàa2eb7f62010-04-19 21:56:45 +0000297 if self.timeout is not _GLOBAL_DEFAULT_TIMEOUT:
298 sock.settimeout(self.timeout)
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000299 return sock
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000300
301 def makepasv(self):
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000302 if self.af == socket.AF_INET:
303 host, port = parse227(self.sendcmd('PASV'))
304 else:
305 host, port = parse229(self.sendcmd('EPSV'), self.sock.getpeername())
306 return host, port
Guido van Rossum1115ab21992-11-04 15:51:30 +0000307
Tim Peters88869f92001-01-14 23:36:06 +0000308 def ntransfercmd(self, cmd, rest=None):
309 """Initiate a transfer over the data connection.
Barry Warsaw100d81e2000-09-01 06:09:23 +0000310
Tim Peters88869f92001-01-14 23:36:06 +0000311 If the transfer is active, send a port command and the
312 transfer command, and accept the connection. If the server is
313 passive, send a pasv command, connect to it, and start the
314 transfer command. Either way, return the socket for the
315 connection and the expected size of the transfer. The
316 expected size may be None if it could not be determined.
Barry Warsaw100d81e2000-09-01 06:09:23 +0000317
Tim Peters88869f92001-01-14 23:36:06 +0000318 Optional `rest' argument can be a string that is sent as the
Gregory P. Smith2230bcf2008-01-22 23:15:34 +0000319 argument to a REST command. This is essentially a server
Tim Peters88869f92001-01-14 23:36:06 +0000320 marker used to tell the server to skip over any data up to the
321 given marker.
322 """
323 size = None
324 if self.passiveserver:
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000325 host, port = self.makepasv()
Facundo Batista92493122007-06-06 15:13:37 +0000326 conn = socket.create_connection((host, port), self.timeout)
Tim Peters88869f92001-01-14 23:36:06 +0000327 if rest is not None:
328 self.sendcmd("REST %s" % rest)
329 resp = self.sendcmd(cmd)
Martin v. Löwis36cbc082006-11-12 18:48:13 +0000330 # Some servers apparently send a 200 reply to
331 # a LIST or STOR command, before the 150 reply
332 # (and way before the 226 reply). This seems to
333 # be in violation of the protocol (which only allows
334 # 1xx or error messages for LIST), so we just discard
335 # this response.
336 if resp[0] == '2':
Tim Petersf733abb2007-01-30 03:03:46 +0000337 resp = self.getresp()
Tim Peters88869f92001-01-14 23:36:06 +0000338 if resp[0] != '1':
339 raise error_reply, resp
340 else:
341 sock = self.makeport()
342 if rest is not None:
343 self.sendcmd("REST %s" % rest)
344 resp = self.sendcmd(cmd)
Martin v. Löwis36cbc082006-11-12 18:48:13 +0000345 # See above.
346 if resp[0] == '2':
Tim Petersf733abb2007-01-30 03:03:46 +0000347 resp = self.getresp()
Tim Peters88869f92001-01-14 23:36:06 +0000348 if resp[0] != '1':
349 raise error_reply, resp
350 conn, sockaddr = sock.accept()
Giampaolo Rodolàa2eb7f62010-04-19 21:56:45 +0000351 if self.timeout is not _GLOBAL_DEFAULT_TIMEOUT:
352 conn.settimeout(self.timeout)
Tim Peters88869f92001-01-14 23:36:06 +0000353 if resp[:3] == '150':
354 # this is conditional in case we received a 125
355 size = parse150(resp)
356 return conn, size
Fred Drake4de02d91997-01-10 18:26:09 +0000357
Tim Peters88869f92001-01-14 23:36:06 +0000358 def transfercmd(self, cmd, rest=None):
Guido van Rossumb6aca6a2001-10-16 19:45:52 +0000359 """Like ntransfercmd() but returns only the socket."""
Tim Peters88869f92001-01-14 23:36:06 +0000360 return self.ntransfercmd(cmd, rest)[0]
Guido van Rossumc567c601992-11-05 22:22:37 +0000361
Tim Peters88869f92001-01-14 23:36:06 +0000362 def login(self, user = '', passwd = '', acct = ''):
363 '''Login, default anonymous.'''
364 if not user: user = 'anonymous'
365 if not passwd: passwd = ''
366 if not acct: acct = ''
367 if user == 'anonymous' and passwd in ('', '-'):
Tim Peterse4418602002-02-16 07:34:19 +0000368 # If there is no anonymous ftp password specified
369 # then we'll just use anonymous@
370 # We don't send any other thing because:
371 # - We want to remain anonymous
372 # - We want to stop SPAM
373 # - We don't want to let ftp sites to discriminate by the user,
374 # host or country.
Guido van Rossumc33e0772001-12-28 20:54:28 +0000375 passwd = passwd + 'anonymous@'
Tim Peters88869f92001-01-14 23:36:06 +0000376 resp = self.sendcmd('USER ' + user)
377 if resp[0] == '3': resp = self.sendcmd('PASS ' + passwd)
378 if resp[0] == '3': resp = self.sendcmd('ACCT ' + acct)
379 if resp[0] != '2':
380 raise error_reply, resp
381 return resp
Guido van Rossumc567c601992-11-05 22:22:37 +0000382
Tim Peters88869f92001-01-14 23:36:06 +0000383 def retrbinary(self, cmd, callback, blocksize=8192, rest=None):
Gregory P. Smithc64386b2008-01-22 00:19:41 +0000384 """Retrieve data in binary mode. A new port is created for you.
Barry Warsaw100d81e2000-09-01 06:09:23 +0000385
Gregory P. Smithc64386b2008-01-22 00:19:41 +0000386 Args:
387 cmd: A RETR command.
388 callback: A single parameter callable to be called on each
389 block of data read.
390 blocksize: The maximum number of bytes to read from the
391 socket at one time. [default: 8192]
392 rest: Passed to transfercmd(). [default: None]
Guido van Rossum1115ab21992-11-04 15:51:30 +0000393
Gregory P. Smithc64386b2008-01-22 00:19:41 +0000394 Returns:
395 The response code.
Tim Peters88869f92001-01-14 23:36:06 +0000396 """
397 self.voidcmd('TYPE I')
398 conn = self.transfercmd(cmd, rest)
399 while 1:
400 data = conn.recv(blocksize)
401 if not data:
402 break
403 callback(data)
404 conn.close()
405 return self.voidresp()
Guido van Rossum1115ab21992-11-04 15:51:30 +0000406
Tim Peters88869f92001-01-14 23:36:06 +0000407 def retrlines(self, cmd, callback = None):
Gregory P. Smithc64386b2008-01-22 00:19:41 +0000408 """Retrieve data in line mode. A new port is created for you.
409
410 Args:
Gregory P. Smith2230bcf2008-01-22 23:15:34 +0000411 cmd: A RETR, LIST, NLST, or MLSD command.
Gregory P. Smithc64386b2008-01-22 00:19:41 +0000412 callback: An optional single parameter callable that is called
413 for each line with the trailing CRLF stripped.
414 [default: print_line()]
415
416 Returns:
417 The response code.
418 """
Raymond Hettingere874fc32002-05-12 05:53:51 +0000419 if callback is None: callback = print_line
Tim Peters88869f92001-01-14 23:36:06 +0000420 resp = self.sendcmd('TYPE A')
421 conn = self.transfercmd(cmd)
422 fp = conn.makefile('rb')
423 while 1:
424 line = fp.readline()
Walter Dörwald70a6b492004-02-12 17:35:32 +0000425 if self.debugging > 2: print '*retr*', repr(line)
Tim Peters88869f92001-01-14 23:36:06 +0000426 if not line:
427 break
428 if line[-2:] == CRLF:
429 line = line[:-2]
430 elif line[-1:] == '\n':
431 line = line[:-1]
432 callback(line)
433 fp.close()
434 conn.close()
435 return self.voidresp()
Guido van Rossumc567c601992-11-05 22:22:37 +0000436
Gregory P. Smithc64386b2008-01-22 00:19:41 +0000437 def storbinary(self, cmd, fp, blocksize=8192, callback=None):
438 """Store a file in binary mode. A new port is created for you.
439
440 Args:
441 cmd: A STOR command.
442 fp: A file-like object with a read(num_bytes) method.
443 blocksize: The maximum data size to read from fp and send over
444 the connection at once. [default: 8192]
445 callback: An optional single parameter callable that is called on
446 on each block of data after it is sent. [default: None]
447
448 Returns:
449 The response code.
450 """
Tim Peters88869f92001-01-14 23:36:06 +0000451 self.voidcmd('TYPE I')
452 conn = self.transfercmd(cmd)
453 while 1:
454 buf = fp.read(blocksize)
455 if not buf: break
Martin v. Löwise12454f2002-02-16 23:06:19 +0000456 conn.sendall(buf)
Gregory P. Smithc64386b2008-01-22 00:19:41 +0000457 if callback: callback(buf)
Tim Peters88869f92001-01-14 23:36:06 +0000458 conn.close()
459 return self.voidresp()
Guido van Rossumc567c601992-11-05 22:22:37 +0000460
Gregory P. Smithc64386b2008-01-22 00:19:41 +0000461 def storlines(self, cmd, fp, callback=None):
462 """Store a file in line mode. A new port is created for you.
463
464 Args:
465 cmd: A STOR command.
466 fp: A file-like object with a readline() method.
467 callback: An optional single parameter callable that is called on
468 on each line after it is sent. [default: None]
469
470 Returns:
471 The response code.
472 """
Tim Peters88869f92001-01-14 23:36:06 +0000473 self.voidcmd('TYPE A')
474 conn = self.transfercmd(cmd)
475 while 1:
476 buf = fp.readline()
477 if not buf: break
478 if buf[-2:] != CRLF:
479 if buf[-1] in CRLF: buf = buf[:-1]
480 buf = buf + CRLF
Martin v. Löwise12454f2002-02-16 23:06:19 +0000481 conn.sendall(buf)
Gregory P. Smithc64386b2008-01-22 00:19:41 +0000482 if callback: callback(buf)
Tim Peters88869f92001-01-14 23:36:06 +0000483 conn.close()
484 return self.voidresp()
Guido van Rossum0eaa74b1996-01-25 18:37:21 +0000485
Tim Peters88869f92001-01-14 23:36:06 +0000486 def acct(self, password):
487 '''Send new account name.'''
488 cmd = 'ACCT ' + password
489 return self.voidcmd(cmd)
Guido van Rossumc567c601992-11-05 22:22:37 +0000490
Tim Peters88869f92001-01-14 23:36:06 +0000491 def nlst(self, *args):
492 '''Return a list of files in a given directory (default the current).'''
493 cmd = 'NLST'
494 for arg in args:
495 cmd = cmd + (' ' + arg)
496 files = []
497 self.retrlines(cmd, files.append)
498 return files
Guido van Rossumae3b3a31993-11-30 13:43:54 +0000499
Tim Peters88869f92001-01-14 23:36:06 +0000500 def dir(self, *args):
501 '''List a directory in long form.
502 By default list current directory to stdout.
503 Optional last argument is callback function; all
504 non-empty arguments before it are concatenated to the
505 LIST command. (This *should* only be used for a pathname.)'''
506 cmd = 'LIST'
507 func = None
508 if args[-1:] and type(args[-1]) != type(''):
509 args, func = args[:-1], args[-1]
510 for arg in args:
511 if arg:
512 cmd = cmd + (' ' + arg)
513 self.retrlines(cmd, func)
Guido van Rossumc567c601992-11-05 22:22:37 +0000514
Tim Peters88869f92001-01-14 23:36:06 +0000515 def rename(self, fromname, toname):
516 '''Rename a file.'''
517 resp = self.sendcmd('RNFR ' + fromname)
518 if resp[0] != '3':
519 raise error_reply, resp
520 return self.voidcmd('RNTO ' + toname)
Guido van Rossuma61bdeb1995-10-11 17:36:31 +0000521
Tim Peters88869f92001-01-14 23:36:06 +0000522 def delete(self, filename):
523 '''Delete a file.'''
524 resp = self.sendcmd('DELE ' + filename)
525 if resp[:3] in ('250', '200'):
526 return resp
Tim Peters88869f92001-01-14 23:36:06 +0000527 else:
528 raise error_reply, resp
Guido van Rossum02cf5821993-05-17 08:00:02 +0000529
Tim Peters88869f92001-01-14 23:36:06 +0000530 def cwd(self, dirname):
531 '''Change to a directory.'''
532 if dirname == '..':
533 try:
534 return self.voidcmd('CDUP')
535 except error_perm, msg:
Martin v. Löwisb5255112002-03-10 15:59:58 +0000536 if msg.args[0][:3] != '500':
537 raise
Tim Peters88869f92001-01-14 23:36:06 +0000538 elif dirname == '':
539 dirname = '.' # does nothing, but could return error
540 cmd = 'CWD ' + dirname
541 return self.voidcmd(cmd)
Guido van Rossum17ed1ae1993-06-01 13:21:04 +0000542
Tim Peters88869f92001-01-14 23:36:06 +0000543 def size(self, filename):
544 '''Retrieve the size of a file.'''
Gregory P. Smith2230bcf2008-01-22 23:15:34 +0000545 # The SIZE command is defined in RFC-3659
Tim Peters88869f92001-01-14 23:36:06 +0000546 resp = self.sendcmd('SIZE ' + filename)
547 if resp[:3] == '213':
Guido van Rossumb6aca6a2001-10-16 19:45:52 +0000548 s = resp[3:].strip()
549 try:
550 return int(s)
Guido van Rossum1f74cb32001-10-17 17:21:47 +0000551 except (OverflowError, ValueError):
Guido van Rossumb6aca6a2001-10-16 19:45:52 +0000552 return long(s)
Guido van Rossumc567c601992-11-05 22:22:37 +0000553
Tim Peters88869f92001-01-14 23:36:06 +0000554 def mkd(self, dirname):
555 '''Make a directory, return its full pathname.'''
556 resp = self.sendcmd('MKD ' + dirname)
557 return parse257(resp)
Guido van Rossum98245091998-02-19 21:15:44 +0000558
Tim Peters88869f92001-01-14 23:36:06 +0000559 def rmd(self, dirname):
560 '''Remove a directory.'''
561 return self.voidcmd('RMD ' + dirname)
Guido van Rossum1115ab21992-11-04 15:51:30 +0000562
Tim Peters88869f92001-01-14 23:36:06 +0000563 def pwd(self):
564 '''Return current working directory.'''
565 resp = self.sendcmd('PWD')
566 return parse257(resp)
Guido van Rossum17ed1ae1993-06-01 13:21:04 +0000567
Tim Peters88869f92001-01-14 23:36:06 +0000568 def quit(self):
569 '''Quit, and close the connection.'''
570 resp = self.voidcmd('QUIT')
571 self.close()
572 return resp
573
574 def close(self):
575 '''Close the connection without assuming anything about it.'''
Fred Drake9c98a422001-02-28 21:46:37 +0000576 if self.file:
577 self.file.close()
578 self.sock.close()
579 self.file = self.sock = None
Guido van Rossumc567c601992-11-05 22:22:37 +0000580
581
Guido van Rossumacfb82a1997-10-22 20:49:52 +0000582_150_re = None
Fred Drake4de02d91997-01-10 18:26:09 +0000583
584def parse150(resp):
Tim Peters88869f92001-01-14 23:36:06 +0000585 '''Parse the '150' response for a RETR request.
586 Returns the expected transfer size or None; size is not guaranteed to
587 be present in the 150 message.
588 '''
589 if resp[:3] != '150':
590 raise error_reply, resp
591 global _150_re
592 if _150_re is None:
593 import re
594 _150_re = re.compile("150 .* \((\d+) bytes\)", re.IGNORECASE)
595 m = _150_re.match(resp)
Guido van Rossumb6aca6a2001-10-16 19:45:52 +0000596 if not m:
597 return None
598 s = m.group(1)
599 try:
600 return int(s)
Guido van Rossum1f74cb32001-10-17 17:21:47 +0000601 except (OverflowError, ValueError):
Guido van Rossumb6aca6a2001-10-16 19:45:52 +0000602 return long(s)
Fred Drake4de02d91997-01-10 18:26:09 +0000603
604
Guido van Rossum70297d32001-08-17 17:24:29 +0000605_227_re = None
606
Guido van Rossumd2560b01996-05-28 23:41:25 +0000607def parse227(resp):
Tim Peters88869f92001-01-14 23:36:06 +0000608 '''Parse the '227' response for a PASV request.
609 Raises error_proto if it does not contain '(h1,h2,h3,h4,p1,p2)'
610 Return ('host.addr.as.numbers', port#) tuple.'''
Guido van Rossumd2560b01996-05-28 23:41:25 +0000611
Tim Peters88869f92001-01-14 23:36:06 +0000612 if resp[:3] != '227':
613 raise error_reply, resp
Guido van Rossum70297d32001-08-17 17:24:29 +0000614 global _227_re
615 if _227_re is None:
616 import re
617 _227_re = re.compile(r'(\d+),(\d+),(\d+),(\d+),(\d+),(\d+)')
618 m = _227_re.search(resp)
619 if not m:
Tim Peters88869f92001-01-14 23:36:06 +0000620 raise error_proto, resp
Guido van Rossum70297d32001-08-17 17:24:29 +0000621 numbers = m.groups()
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000622 host = '.'.join(numbers[:4])
623 port = (int(numbers[4]) << 8) + int(numbers[5])
Tim Peters88869f92001-01-14 23:36:06 +0000624 return host, port
Guido van Rossumd2560b01996-05-28 23:41:25 +0000625
626
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000627def parse229(resp, peer):
628 '''Parse the '229' response for a EPSV request.
629 Raises error_proto if it does not contain '(|||port|)'
630 Return ('host.addr.as.numbers', port#) tuple.'''
631
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000632 if resp[:3] != '229':
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000633 raise error_reply, resp
Neal Norwitz7ce734c2002-05-31 14:13:04 +0000634 left = resp.find('(')
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000635 if left < 0: raise error_proto, resp
Neal Norwitz7ce734c2002-05-31 14:13:04 +0000636 right = resp.find(')', left + 1)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000637 if right < 0:
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000638 raise error_proto, resp # should contain '(|||port|)'
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000639 if resp[left + 1] != resp[right - 1]:
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000640 raise error_proto, resp
Walter Dörwalda401ae42002-06-03 10:41:45 +0000641 parts = resp[left + 1:right].split(resp[left+1])
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000642 if len(parts) != 5:
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000643 raise error_proto, resp
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000644 host = peer[0]
Neal Norwitz7ce734c2002-05-31 14:13:04 +0000645 port = int(parts[3])
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000646 return host, port
647
648
Guido van Rossumc567c601992-11-05 22:22:37 +0000649def parse257(resp):
Tim Peters88869f92001-01-14 23:36:06 +0000650 '''Parse the '257' response for a MKD or PWD request.
651 This is a response to a MKD or PWD request: a directory name.
652 Returns the directoryname in the 257 reply.'''
Guido van Rossumd2560b01996-05-28 23:41:25 +0000653
Tim Peters88869f92001-01-14 23:36:06 +0000654 if resp[:3] != '257':
655 raise error_reply, resp
656 if resp[3:5] != ' "':
657 return '' # Not compliant to RFC 959, but UNIX ftpd does this
658 dirname = ''
659 i = 5
660 n = len(resp)
661 while i < n:
662 c = resp[i]
663 i = i+1
664 if c == '"':
665 if i >= n or resp[i] != '"':
666 break
667 i = i+1
668 dirname = dirname + c
669 return dirname
Guido van Rossum1115ab21992-11-04 15:51:30 +0000670
Guido van Rossum2f3941d1997-10-07 14:49:56 +0000671
Guido van Rossumae3b3a31993-11-30 13:43:54 +0000672def print_line(line):
Tim Peters88869f92001-01-14 23:36:06 +0000673 '''Default retrlines callback to print a line.'''
674 print line
Guido van Rossumae3b3a31993-11-30 13:43:54 +0000675
Guido van Rossum2f3941d1997-10-07 14:49:56 +0000676
Guido van Rossumd2560b01996-05-28 23:41:25 +0000677def ftpcp(source, sourcename, target, targetname = '', type = 'I'):
Tim Peters88869f92001-01-14 23:36:06 +0000678 '''Copy file from one FTP-instance to another.'''
679 if not targetname: targetname = sourcename
680 type = 'TYPE ' + type
681 source.voidcmd(type)
682 target.voidcmd(type)
683 sourcehost, sourceport = parse227(source.sendcmd('PASV'))
684 target.sendport(sourcehost, sourceport)
685 # RFC 959: the user must "listen" [...] BEFORE sending the
686 # transfer request.
687 # So: STOR before RETR, because here the target is a "user".
688 treply = target.sendcmd('STOR ' + targetname)
689 if treply[:3] not in ('125', '150'): raise error_proto # RFC 959
690 sreply = source.sendcmd('RETR ' + sourcename)
691 if sreply[:3] not in ('125', '150'): raise error_proto # RFC 959
692 source.voidresp()
693 target.voidresp()
Guido van Rossum1115ab21992-11-04 15:51:30 +0000694
Tim Peters88869f92001-01-14 23:36:06 +0000695
Guido van Rossum56d1e3a1997-03-14 04:16:54 +0000696class Netrc:
Tim Peters88869f92001-01-14 23:36:06 +0000697 """Class to parse & provide access to 'netrc' format files.
Fred Drake475d51d1997-06-24 22:02:54 +0000698
Tim Peters88869f92001-01-14 23:36:06 +0000699 See the netrc(4) man page for information on the file format.
Guido van Rossum56d1e3a1997-03-14 04:16:54 +0000700
Tim Peters88869f92001-01-14 23:36:06 +0000701 WARNING: This class is obsolete -- use module netrc instead.
Guido van Rossumc822a451998-12-22 16:49:16 +0000702
Tim Peters88869f92001-01-14 23:36:06 +0000703 """
704 __defuser = None
705 __defpasswd = None
706 __defacct = None
Guido van Rossum56d1e3a1997-03-14 04:16:54 +0000707
Tim Peters88869f92001-01-14 23:36:06 +0000708 def __init__(self, filename=None):
Raymond Hettinger094662a2002-06-01 01:29:16 +0000709 if filename is None:
Raymond Hettinger54f02222002-06-01 14:18:47 +0000710 if "HOME" in os.environ:
Tim Peters88869f92001-01-14 23:36:06 +0000711 filename = os.path.join(os.environ["HOME"],
712 ".netrc")
713 else:
714 raise IOError, \
715 "specify file to load or set $HOME"
716 self.__hosts = {}
717 self.__macros = {}
718 fp = open(filename, "r")
719 in_macro = 0
720 while 1:
721 line = fp.readline()
722 if not line: break
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000723 if in_macro and line.strip():
Tim Peters88869f92001-01-14 23:36:06 +0000724 macro_lines.append(line)
725 continue
726 elif in_macro:
727 self.__macros[macro_name] = tuple(macro_lines)
728 in_macro = 0
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000729 words = line.split()
Tim Peters88869f92001-01-14 23:36:06 +0000730 host = user = passwd = acct = None
731 default = 0
732 i = 0
733 while i < len(words):
734 w1 = words[i]
735 if i+1 < len(words):
736 w2 = words[i + 1]
737 else:
738 w2 = None
739 if w1 == 'default':
740 default = 1
741 elif w1 == 'machine' and w2:
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000742 host = w2.lower()
Tim Peters88869f92001-01-14 23:36:06 +0000743 i = i + 1
744 elif w1 == 'login' and w2:
745 user = w2
746 i = i + 1
747 elif w1 == 'password' and w2:
748 passwd = w2
749 i = i + 1
750 elif w1 == 'account' and w2:
751 acct = w2
752 i = i + 1
753 elif w1 == 'macdef' and w2:
754 macro_name = w2
755 macro_lines = []
756 in_macro = 1
757 break
758 i = i + 1
759 if default:
760 self.__defuser = user or self.__defuser
761 self.__defpasswd = passwd or self.__defpasswd
762 self.__defacct = acct or self.__defacct
763 if host:
Raymond Hettinger54f02222002-06-01 14:18:47 +0000764 if host in self.__hosts:
Tim Peters88869f92001-01-14 23:36:06 +0000765 ouser, opasswd, oacct = \
766 self.__hosts[host]
767 user = user or ouser
768 passwd = passwd or opasswd
769 acct = acct or oacct
770 self.__hosts[host] = user, passwd, acct
771 fp.close()
Guido van Rossum56d1e3a1997-03-14 04:16:54 +0000772
Tim Peters88869f92001-01-14 23:36:06 +0000773 def get_hosts(self):
774 """Return a list of hosts mentioned in the .netrc file."""
775 return self.__hosts.keys()
Guido van Rossum8ca84201998-03-26 20:56:10 +0000776
Tim Peters88869f92001-01-14 23:36:06 +0000777 def get_account(self, host):
778 """Returns login information for the named host.
Guido van Rossum8ca84201998-03-26 20:56:10 +0000779
Tim Peters88869f92001-01-14 23:36:06 +0000780 The return value is a triple containing userid,
781 password, and the accounting field.
Guido van Rossum8ca84201998-03-26 20:56:10 +0000782
Tim Peters88869f92001-01-14 23:36:06 +0000783 """
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000784 host = host.lower()
Tim Peters88869f92001-01-14 23:36:06 +0000785 user = passwd = acct = None
Raymond Hettinger54f02222002-06-01 14:18:47 +0000786 if host in self.__hosts:
Tim Peters88869f92001-01-14 23:36:06 +0000787 user, passwd, acct = self.__hosts[host]
788 user = user or self.__defuser
789 passwd = passwd or self.__defpasswd
790 acct = acct or self.__defacct
791 return user, passwd, acct
Guido van Rossum8ca84201998-03-26 20:56:10 +0000792
Tim Peters88869f92001-01-14 23:36:06 +0000793 def get_macros(self):
794 """Return a list of all defined macro names."""
795 return self.__macros.keys()
Guido van Rossum8ca84201998-03-26 20:56:10 +0000796
Tim Peters88869f92001-01-14 23:36:06 +0000797 def get_macro(self, macro):
798 """Return a sequence of lines which define a named macro."""
799 return self.__macros[macro]
Guido van Rossum56d1e3a1997-03-14 04:16:54 +0000800
Fred Drake475d51d1997-06-24 22:02:54 +0000801
Tim Peters88869f92001-01-14 23:36:06 +0000802
Guido van Rossum1115ab21992-11-04 15:51:30 +0000803def test():
Tim Peters88869f92001-01-14 23:36:06 +0000804 '''Test program.
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000805 Usage: ftp [-d] [-r[file]] host [-l[dir]] [-d[dir]] [-p] [file] ...
806
807 -d dir
808 -l list
809 -p password
810 '''
811
812 if len(sys.argv) < 2:
813 print test.__doc__
814 sys.exit(0)
Guido van Rossumd2560b01996-05-28 23:41:25 +0000815
Tim Peters88869f92001-01-14 23:36:06 +0000816 debugging = 0
817 rcfile = None
818 while sys.argv[1] == '-d':
819 debugging = debugging+1
820 del sys.argv[1]
821 if sys.argv[1][:2] == '-r':
822 # get name of alternate ~/.netrc file:
823 rcfile = sys.argv[1][2:]
824 del sys.argv[1]
825 host = sys.argv[1]
826 ftp = FTP(host)
827 ftp.set_debuglevel(debugging)
828 userid = passwd = acct = ''
829 try:
830 netrc = Netrc(rcfile)
831 except IOError:
832 if rcfile is not None:
833 sys.stderr.write("Could not open account file"
834 " -- using anonymous login.")
835 else:
836 try:
837 userid, passwd, acct = netrc.get_account(host)
838 except KeyError:
839 # no account for host
840 sys.stderr.write(
841 "No account -- using anonymous login.")
842 ftp.login(userid, passwd, acct)
843 for file in sys.argv[2:]:
844 if file[:2] == '-l':
845 ftp.dir(file[2:])
846 elif file[:2] == '-d':
847 cmd = 'CWD'
848 if file[2:]: cmd = cmd + ' ' + file[2:]
849 resp = ftp.sendcmd(cmd)
850 elif file == '-p':
851 ftp.set_pasv(not ftp.passiveserver)
852 else:
853 ftp.retrbinary('RETR ' + file, \
854 sys.stdout.write, 1024)
855 ftp.quit()
Guido van Rossum221ec0b1995-08-04 04:39:30 +0000856
857
858if __name__ == '__main__':
Tim Peters88869f92001-01-14 23:36:06 +0000859 test()