blob: ad00e310bd6dded4bebb19ca5f3fd66d42877995 [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.
Antoine Pitrouccd5e022009-11-15 17:22:09 +000036# Modified by Giampaolo Rodola' to add TLS support.
Guido van Rossum98d9fd32000-02-28 15:12:25 +000037#
Guido van Rossumc567c601992-11-05 22:22:37 +000038
Guido van Rossum1115ab21992-11-04 15:51:30 +000039import os
40import sys
Guido van Rossum1115ab21992-11-04 15:51:30 +000041
Guido van Rossumb6775db1994-08-01 11:34:53 +000042# Import SOCKS module if it exists, else standard socket module socket
43try:
Tim Peters88869f92001-01-14 23:36:06 +000044 import SOCKS; socket = SOCKS; del SOCKS # import SOCKS as socket
45 from socket import getfqdn; socket.getfqdn = getfqdn; del getfqdn
Guido van Rossumb6775db1994-08-01 11:34:53 +000046except ImportError:
Tim Peters88869f92001-01-14 23:36:06 +000047 import socket
Facundo Batista4f1b1ed2008-05-29 16:39:26 +000048from socket import _GLOBAL_DEFAULT_TIMEOUT
Guido van Rossumb6775db1994-08-01 11:34:53 +000049
Skip Montanaroeccd02a2001-01-20 23:34:12 +000050__all__ = ["FTP","Netrc"]
Guido van Rossum1115ab21992-11-04 15:51:30 +000051
Guido van Rossumd3166071993-05-24 14:16:22 +000052# Magic number from <socket.h>
Tim Peters88869f92001-01-14 23:36:06 +000053MSG_OOB = 0x1 # Process data out of band
Guido van Rossumd3166071993-05-24 14:16:22 +000054
55
Guido van Rossumc567c601992-11-05 22:22:37 +000056# The standard FTP server control port
Guido van Rossum1115ab21992-11-04 15:51:30 +000057FTP_PORT = 21
Guido van Rossum1115ab21992-11-04 15:51:30 +000058
59
Guido van Rossum21974791992-11-06 13:34:17 +000060# Exception raised when an error or invalid response is received
Fred Drake227b1202000-08-17 05:06:49 +000061class Error(Exception): pass
Tim Peters88869f92001-01-14 23:36:06 +000062class error_reply(Error): pass # unexpected [123]xx reply
63class error_temp(Error): pass # 4xx errors
64class error_perm(Error): pass # 5xx errors
65class error_proto(Error): pass # response does not begin with [1-5]
Guido van Rossum1115ab21992-11-04 15:51:30 +000066
67
Guido van Rossum21974791992-11-06 13:34:17 +000068# All exceptions (hopefully) that may be raised here and that aren't
69# (always) programming errors on our side
Gregory P. Smithe6c03032008-04-12 22:24:04 +000070all_errors = (Error, IOError, EOFError)
Guido van Rossum21974791992-11-06 13:34:17 +000071
72
Guido van Rossum1115ab21992-11-04 15:51:30 +000073# Line terminators (we always output CRLF, but accept any of CRLF, CR, LF)
74CRLF = '\r\n'
75
Guido van Rossum1115ab21992-11-04 15:51:30 +000076# The class itself
77class FTP:
78
Tim Peters88869f92001-01-14 23:36:06 +000079 '''An FTP client class.
Guido van Rossumd2560b01996-05-28 23:41:25 +000080
Facundo Batista3f100992007-03-26 20:56:09 +000081 To create a connection, call the class using these arguments:
82 host, user, passwd, acct, timeout
83
84 The first four arguments are all strings, and have default value ''.
85 timeout must be numeric and defaults to None if not passed,
86 meaning that no timeout will be set on any ftp socket(s)
87 If a timeout is passed, then this is now the default timeout for all ftp
88 socket operations for this instance.
Neal Norwitz0d4c06e2007-04-25 06:30:05 +000089
Tim Peters88869f92001-01-14 23:36:06 +000090 Then use self.connect() with optional host and port argument.
Guido van Rossumd2560b01996-05-28 23:41:25 +000091
Tim Peters88869f92001-01-14 23:36:06 +000092 To download a file, use ftp.retrlines('RETR ' + filename),
93 or ftp.retrbinary() with slightly different arguments.
94 To upload a file, use ftp.storlines() or ftp.storbinary(),
95 which have an open file as argument (see their definitions
96 below for details).
97 The download/upload functions first issue appropriate TYPE
98 and PORT or PASV commands.
Guido van Rossumd2560b01996-05-28 23:41:25 +000099'''
100
Fred Drake9c98a422001-02-28 21:46:37 +0000101 debugging = 0
102 host = ''
103 port = FTP_PORT
104 sock = None
105 file = None
106 welcome = None
107 passiveserver = 1
108
Tim Peters88869f92001-01-14 23:36:06 +0000109 # Initialization method (called by class instantiation).
110 # Initialize host to localhost, port to standard ftp port
111 # Optional arguments are host (for connect()),
112 # and user, passwd, acct (for login())
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000113 def __init__(self, host='', user='', passwd='', acct='',
114 timeout=_GLOBAL_DEFAULT_TIMEOUT):
Facundo Batista3f100992007-03-26 20:56:09 +0000115 self.timeout = timeout
Tim Peters88869f92001-01-14 23:36:06 +0000116 if host:
Fred Drake9c98a422001-02-28 21:46:37 +0000117 self.connect(host)
Neal Norwitz0d4c06e2007-04-25 06:30:05 +0000118 if user:
Facundo Batista3f100992007-03-26 20:56:09 +0000119 self.login(user, passwd, acct)
Guido van Rossum52fc1f61993-06-17 12:38:10 +0000120
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000121 def connect(self, host='', port=0, timeout=-999):
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000122 '''Connect to host. Arguments are:
Facundo Batista3f100992007-03-26 20:56:09 +0000123 - host: hostname to connect to (string, default previous host)
124 - port: port to connect to (integer, default previous port)
125 '''
126 if host != '':
127 self.host = host
128 if port > 0:
129 self.port = port
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000130 if timeout != -999:
Facundo Batista93c33682007-03-30 13:00:35 +0000131 self.timeout = timeout
Facundo Batista3f100992007-03-26 20:56:09 +0000132 self.sock = socket.create_connection((self.host, self.port), self.timeout)
133 self.af = self.sock.family
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000134 self.file = self.sock.makefile('rb')
135 self.welcome = self.getresp()
136 return self.welcome
Guido van Rossum1115ab21992-11-04 15:51:30 +0000137
Tim Peters88869f92001-01-14 23:36:06 +0000138 def getwelcome(self):
139 '''Get the welcome message from the server.
140 (this is read and squirreled away by connect())'''
141 if self.debugging:
142 print '*welcome*', self.sanitize(self.welcome)
143 return self.welcome
Guido van Rossum1115ab21992-11-04 15:51:30 +0000144
Tim Peters88869f92001-01-14 23:36:06 +0000145 def set_debuglevel(self, level):
146 '''Set the debugging level.
147 The required argument level means:
148 0: no debugging output (default)
149 1: print commands and responses but not body text etc.
150 2: also print raw lines read and sent before stripping CR/LF'''
151 self.debugging = level
152 debug = set_debuglevel
Guido van Rossum1115ab21992-11-04 15:51:30 +0000153
Tim Peters88869f92001-01-14 23:36:06 +0000154 def set_pasv(self, val):
155 '''Use passive or active mode for data transfers.
156 With a false argument, use the normal PORT mode,
157 With a true argument, use the PASV command.'''
158 self.passiveserver = val
Guido van Rossumd2560b01996-05-28 23:41:25 +0000159
Tim Peters88869f92001-01-14 23:36:06 +0000160 # Internal: "sanitize" a string for printing
161 def sanitize(self, s):
162 if s[:5] == 'pass ' or s[:5] == 'PASS ':
163 i = len(s)
164 while i > 5 and s[i-1] in '\r\n':
165 i = i-1
166 s = s[:5] + '*'*(i-5) + s[i:]
Walter Dörwald70a6b492004-02-12 17:35:32 +0000167 return repr(s)
Guido van Rossumebaf1041995-05-05 15:54:14 +0000168
Tim Peters88869f92001-01-14 23:36:06 +0000169 # Internal: send one line to the server, appending CRLF
170 def putline(self, line):
171 line = line + CRLF
172 if self.debugging > 1: print '*put*', self.sanitize(line)
Martin v. Löwise12454f2002-02-16 23:06:19 +0000173 self.sock.sendall(line)
Guido van Rossum1115ab21992-11-04 15:51:30 +0000174
Tim Peters88869f92001-01-14 23:36:06 +0000175 # Internal: send one command to the server (through putline())
176 def putcmd(self, line):
177 if self.debugging: print '*cmd*', self.sanitize(line)
178 self.putline(line)
Guido van Rossum1115ab21992-11-04 15:51:30 +0000179
Tim Peters88869f92001-01-14 23:36:06 +0000180 # Internal: return one line from the server, stripping CRLF.
181 # Raise EOFError if the connection is closed
182 def getline(self):
183 line = self.file.readline()
184 if self.debugging > 1:
185 print '*get*', self.sanitize(line)
186 if not line: raise EOFError
187 if line[-2:] == CRLF: line = line[:-2]
188 elif line[-1:] in CRLF: line = line[:-1]
189 return line
Guido van Rossum1115ab21992-11-04 15:51:30 +0000190
Tim Peters88869f92001-01-14 23:36:06 +0000191 # Internal: get a response from the server, which may possibly
192 # consist of multiple lines. Return a single string with no
193 # trailing CRLF. If the response consists of multiple lines,
194 # these are separated by '\n' characters in the string
195 def getmultiline(self):
196 line = self.getline()
197 if line[3:4] == '-':
198 code = line[:3]
199 while 1:
200 nextline = self.getline()
201 line = line + ('\n' + nextline)
202 if nextline[:3] == code and \
203 nextline[3:4] != '-':
204 break
205 return line
Guido van Rossum1115ab21992-11-04 15:51:30 +0000206
Tim Peters88869f92001-01-14 23:36:06 +0000207 # Internal: get a response from the server.
208 # Raise various errors if the response indicates an error
209 def getresp(self):
210 resp = self.getmultiline()
211 if self.debugging: print '*resp*', self.sanitize(resp)
212 self.lastresp = resp[:3]
213 c = resp[:1]
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000214 if c in ('1', '2', '3'):
215 return resp
Tim Peters88869f92001-01-14 23:36:06 +0000216 if c == '4':
217 raise error_temp, resp
218 if c == '5':
219 raise error_perm, resp
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000220 raise error_proto, resp
Guido van Rossum1115ab21992-11-04 15:51:30 +0000221
Tim Peters88869f92001-01-14 23:36:06 +0000222 def voidresp(self):
223 """Expect a response beginning with '2'."""
224 resp = self.getresp()
Georg Brandl50ba6e12009-04-05 10:48:47 +0000225 if resp[:1] != '2':
Tim Peters88869f92001-01-14 23:36:06 +0000226 raise error_reply, resp
227 return resp
Guido van Rossumc567c601992-11-05 22:22:37 +0000228
Tim Peters88869f92001-01-14 23:36:06 +0000229 def abort(self):
230 '''Abort a file transfer. Uses out-of-band data.
231 This does not follow the procedure from the RFC to send Telnet
232 IP and Synch; that doesn't seem to work with the servers I've
233 tried. Instead, just send the ABOR command as OOB data.'''
234 line = 'ABOR' + CRLF
235 if self.debugging > 1: print '*put urgent*', self.sanitize(line)
Martin v. Löwise12454f2002-02-16 23:06:19 +0000236 self.sock.sendall(line, MSG_OOB)
Tim Peters88869f92001-01-14 23:36:06 +0000237 resp = self.getmultiline()
238 if resp[:3] not in ('426', '226'):
239 raise error_proto, resp
Guido van Rossumd3166071993-05-24 14:16:22 +0000240
Tim Peters88869f92001-01-14 23:36:06 +0000241 def sendcmd(self, cmd):
242 '''Send a command and return the response.'''
243 self.putcmd(cmd)
244 return self.getresp()
Guido van Rossum1115ab21992-11-04 15:51:30 +0000245
Tim Peters88869f92001-01-14 23:36:06 +0000246 def voidcmd(self, cmd):
247 """Send a command and expect a response beginning with '2'."""
248 self.putcmd(cmd)
249 return self.voidresp()
Guido van Rossumc567c601992-11-05 22:22:37 +0000250
Tim Peters88869f92001-01-14 23:36:06 +0000251 def sendport(self, host, port):
252 '''Send a PORT command with the current host and the given
253 port number.
254 '''
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000255 hbytes = host.split('.')
Benjamin Petersondee0b172008-09-27 22:08:12 +0000256 pbytes = [repr(port//256), repr(port%256)]
Tim Peters88869f92001-01-14 23:36:06 +0000257 bytes = hbytes + pbytes
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000258 cmd = 'PORT ' + ','.join(bytes)
Tim Peters88869f92001-01-14 23:36:06 +0000259 return self.voidcmd(cmd)
Guido van Rossum1115ab21992-11-04 15:51:30 +0000260
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000261 def sendeprt(self, host, port):
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000262 '''Send a EPRT command with the current host and the given port number.'''
263 af = 0
264 if self.af == socket.AF_INET:
265 af = 1
266 if self.af == socket.AF_INET6:
267 af = 2
268 if af == 0:
269 raise error_proto, 'unsupported address family'
Walter Dörwald70a6b492004-02-12 17:35:32 +0000270 fields = ['', repr(af), host, repr(port), '']
Neal Norwitz7ce734c2002-05-31 14:13:04 +0000271 cmd = 'EPRT ' + '|'.join(fields)
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000272 return self.voidcmd(cmd)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000273
Tim Peters88869f92001-01-14 23:36:06 +0000274 def makeport(self):
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000275 '''Create a new socket and send a PORT command for it.'''
Martin v. Löwis2ad25692001-07-31 08:40:21 +0000276 msg = "getaddrinfo returns an empty list"
Martin v. Löwis322c0d12001-10-07 08:53:32 +0000277 sock = None
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000278 for res in socket.getaddrinfo(None, 0, self.af, socket.SOCK_STREAM, 0, socket.AI_PASSIVE):
279 af, socktype, proto, canonname, sa = res
280 try:
281 sock = socket.socket(af, socktype, proto)
282 sock.bind(sa)
283 except socket.error, msg:
Martin v. Löwis322c0d12001-10-07 08:53:32 +0000284 if sock:
285 sock.close()
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000286 sock = None
287 continue
288 break
289 if not sock:
290 raise socket.error, msg
291 sock.listen(1)
292 port = sock.getsockname()[1] # Get proper port
293 host = self.sock.getsockname()[0] # Get proper host
294 if self.af == socket.AF_INET:
295 resp = self.sendport(host, port)
296 else:
297 resp = self.sendeprt(host, port)
298 return sock
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000299
300 def makepasv(self):
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000301 if self.af == socket.AF_INET:
302 host, port = parse227(self.sendcmd('PASV'))
303 else:
304 host, port = parse229(self.sendcmd('EPSV'), self.sock.getpeername())
305 return host, port
Guido van Rossum1115ab21992-11-04 15:51:30 +0000306
Tim Peters88869f92001-01-14 23:36:06 +0000307 def ntransfercmd(self, cmd, rest=None):
308 """Initiate a transfer over the data connection.
Barry Warsaw100d81e2000-09-01 06:09:23 +0000309
Tim Peters88869f92001-01-14 23:36:06 +0000310 If the transfer is active, send a port command and the
311 transfer command, and accept the connection. If the server is
312 passive, send a pasv command, connect to it, and start the
313 transfer command. Either way, return the socket for the
314 connection and the expected size of the transfer. The
315 expected size may be None if it could not be determined.
Barry Warsaw100d81e2000-09-01 06:09:23 +0000316
Tim Peters88869f92001-01-14 23:36:06 +0000317 Optional `rest' argument can be a string that is sent as the
Gregory P. Smith2230bcf2008-01-22 23:15:34 +0000318 argument to a REST command. This is essentially a server
Tim Peters88869f92001-01-14 23:36:06 +0000319 marker used to tell the server to skip over any data up to the
320 given marker.
321 """
322 size = None
323 if self.passiveserver:
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000324 host, port = self.makepasv()
Facundo Batista92493122007-06-06 15:13:37 +0000325 conn = socket.create_connection((host, port), self.timeout)
Tim Peters88869f92001-01-14 23:36:06 +0000326 if rest is not None:
327 self.sendcmd("REST %s" % rest)
328 resp = self.sendcmd(cmd)
Martin v. Löwis36cbc082006-11-12 18:48:13 +0000329 # Some servers apparently send a 200 reply to
330 # a LIST or STOR command, before the 150 reply
331 # (and way before the 226 reply). This seems to
332 # be in violation of the protocol (which only allows
333 # 1xx or error messages for LIST), so we just discard
334 # this response.
335 if resp[0] == '2':
Tim Petersf733abb2007-01-30 03:03:46 +0000336 resp = self.getresp()
Tim Peters88869f92001-01-14 23:36:06 +0000337 if resp[0] != '1':
338 raise error_reply, resp
339 else:
340 sock = self.makeport()
341 if rest is not None:
342 self.sendcmd("REST %s" % rest)
343 resp = self.sendcmd(cmd)
Martin v. Löwis36cbc082006-11-12 18:48:13 +0000344 # See above.
345 if resp[0] == '2':
Tim Petersf733abb2007-01-30 03:03:46 +0000346 resp = self.getresp()
Tim Peters88869f92001-01-14 23:36:06 +0000347 if resp[0] != '1':
348 raise error_reply, resp
349 conn, sockaddr = sock.accept()
350 if resp[:3] == '150':
351 # this is conditional in case we received a 125
352 size = parse150(resp)
353 return conn, size
Fred Drake4de02d91997-01-10 18:26:09 +0000354
Tim Peters88869f92001-01-14 23:36:06 +0000355 def transfercmd(self, cmd, rest=None):
Guido van Rossumb6aca6a2001-10-16 19:45:52 +0000356 """Like ntransfercmd() but returns only the socket."""
Tim Peters88869f92001-01-14 23:36:06 +0000357 return self.ntransfercmd(cmd, rest)[0]
Guido van Rossumc567c601992-11-05 22:22:37 +0000358
Tim Peters88869f92001-01-14 23:36:06 +0000359 def login(self, user = '', passwd = '', acct = ''):
360 '''Login, default anonymous.'''
361 if not user: user = 'anonymous'
362 if not passwd: passwd = ''
363 if not acct: acct = ''
364 if user == 'anonymous' and passwd in ('', '-'):
Tim Peterse4418602002-02-16 07:34:19 +0000365 # If there is no anonymous ftp password specified
366 # then we'll just use anonymous@
367 # We don't send any other thing because:
368 # - We want to remain anonymous
369 # - We want to stop SPAM
370 # - We don't want to let ftp sites to discriminate by the user,
371 # host or country.
Guido van Rossumc33e0772001-12-28 20:54:28 +0000372 passwd = passwd + 'anonymous@'
Tim Peters88869f92001-01-14 23:36:06 +0000373 resp = self.sendcmd('USER ' + user)
374 if resp[0] == '3': resp = self.sendcmd('PASS ' + passwd)
375 if resp[0] == '3': resp = self.sendcmd('ACCT ' + acct)
376 if resp[0] != '2':
377 raise error_reply, resp
378 return resp
Guido van Rossumc567c601992-11-05 22:22:37 +0000379
Tim Peters88869f92001-01-14 23:36:06 +0000380 def retrbinary(self, cmd, callback, blocksize=8192, rest=None):
Gregory P. Smithc64386b2008-01-22 00:19:41 +0000381 """Retrieve data in binary mode. A new port is created for you.
Barry Warsaw100d81e2000-09-01 06:09:23 +0000382
Gregory P. Smithc64386b2008-01-22 00:19:41 +0000383 Args:
384 cmd: A RETR command.
385 callback: A single parameter callable to be called on each
386 block of data read.
387 blocksize: The maximum number of bytes to read from the
388 socket at one time. [default: 8192]
389 rest: Passed to transfercmd(). [default: None]
Guido van Rossum1115ab21992-11-04 15:51:30 +0000390
Gregory P. Smithc64386b2008-01-22 00:19:41 +0000391 Returns:
392 The response code.
Tim Peters88869f92001-01-14 23:36:06 +0000393 """
394 self.voidcmd('TYPE I')
395 conn = self.transfercmd(cmd, rest)
396 while 1:
397 data = conn.recv(blocksize)
398 if not data:
399 break
400 callback(data)
401 conn.close()
402 return self.voidresp()
Guido van Rossum1115ab21992-11-04 15:51:30 +0000403
Tim Peters88869f92001-01-14 23:36:06 +0000404 def retrlines(self, cmd, callback = None):
Gregory P. Smithc64386b2008-01-22 00:19:41 +0000405 """Retrieve data in line mode. A new port is created for you.
406
407 Args:
Gregory P. Smith2230bcf2008-01-22 23:15:34 +0000408 cmd: A RETR, LIST, NLST, or MLSD command.
Gregory P. Smithc64386b2008-01-22 00:19:41 +0000409 callback: An optional single parameter callable that is called
410 for each line with the trailing CRLF stripped.
411 [default: print_line()]
412
413 Returns:
414 The response code.
415 """
Raymond Hettingere874fc32002-05-12 05:53:51 +0000416 if callback is None: callback = print_line
Tim Peters88869f92001-01-14 23:36:06 +0000417 resp = self.sendcmd('TYPE A')
418 conn = self.transfercmd(cmd)
419 fp = conn.makefile('rb')
420 while 1:
421 line = fp.readline()
Walter Dörwald70a6b492004-02-12 17:35:32 +0000422 if self.debugging > 2: print '*retr*', repr(line)
Tim Peters88869f92001-01-14 23:36:06 +0000423 if not line:
424 break
425 if line[-2:] == CRLF:
426 line = line[:-2]
427 elif line[-1:] == '\n':
428 line = line[:-1]
429 callback(line)
430 fp.close()
431 conn.close()
432 return self.voidresp()
Guido van Rossumc567c601992-11-05 22:22:37 +0000433
Antoine Pitrouacbe3bd2009-11-27 13:18:34 +0000434 def storbinary(self, cmd, fp, blocksize=8192, callback=None, rest=None):
Gregory P. Smithc64386b2008-01-22 00:19:41 +0000435 """Store a file in binary mode. A new port is created for you.
436
437 Args:
438 cmd: A STOR command.
439 fp: A file-like object with a read(num_bytes) method.
440 blocksize: The maximum data size to read from fp and send over
441 the connection at once. [default: 8192]
442 callback: An optional single parameter callable that is called on
443 on each block of data after it is sent. [default: None]
Antoine Pitrouacbe3bd2009-11-27 13:18:34 +0000444 rest: Passed to transfercmd(). [default: None]
Gregory P. Smithc64386b2008-01-22 00:19:41 +0000445
446 Returns:
447 The response code.
448 """
Tim Peters88869f92001-01-14 23:36:06 +0000449 self.voidcmd('TYPE I')
Antoine Pitrouacbe3bd2009-11-27 13:18:34 +0000450 conn = self.transfercmd(cmd, rest)
Tim Peters88869f92001-01-14 23:36:06 +0000451 while 1:
452 buf = fp.read(blocksize)
453 if not buf: break
Martin v. Löwise12454f2002-02-16 23:06:19 +0000454 conn.sendall(buf)
Gregory P. Smithc64386b2008-01-22 00:19:41 +0000455 if callback: callback(buf)
Tim Peters88869f92001-01-14 23:36:06 +0000456 conn.close()
457 return self.voidresp()
Guido van Rossumc567c601992-11-05 22:22:37 +0000458
Gregory P. Smithc64386b2008-01-22 00:19:41 +0000459 def storlines(self, cmd, fp, callback=None):
460 """Store a file in line mode. A new port is created for you.
461
462 Args:
463 cmd: A STOR command.
464 fp: A file-like object with a readline() method.
465 callback: An optional single parameter callable that is called on
466 on each line after it is sent. [default: None]
467
468 Returns:
469 The response code.
470 """
Tim Peters88869f92001-01-14 23:36:06 +0000471 self.voidcmd('TYPE A')
472 conn = self.transfercmd(cmd)
473 while 1:
474 buf = fp.readline()
475 if not buf: break
476 if buf[-2:] != CRLF:
477 if buf[-1] in CRLF: buf = buf[:-1]
478 buf = buf + CRLF
Martin v. Löwise12454f2002-02-16 23:06:19 +0000479 conn.sendall(buf)
Gregory P. Smithc64386b2008-01-22 00:19:41 +0000480 if callback: callback(buf)
Tim Peters88869f92001-01-14 23:36:06 +0000481 conn.close()
482 return self.voidresp()
Guido van Rossum0eaa74b1996-01-25 18:37:21 +0000483
Tim Peters88869f92001-01-14 23:36:06 +0000484 def acct(self, password):
485 '''Send new account name.'''
486 cmd = 'ACCT ' + password
487 return self.voidcmd(cmd)
Guido van Rossumc567c601992-11-05 22:22:37 +0000488
Tim Peters88869f92001-01-14 23:36:06 +0000489 def nlst(self, *args):
490 '''Return a list of files in a given directory (default the current).'''
491 cmd = 'NLST'
492 for arg in args:
493 cmd = cmd + (' ' + arg)
494 files = []
495 self.retrlines(cmd, files.append)
496 return files
Guido van Rossumae3b3a31993-11-30 13:43:54 +0000497
Tim Peters88869f92001-01-14 23:36:06 +0000498 def dir(self, *args):
499 '''List a directory in long form.
500 By default list current directory to stdout.
501 Optional last argument is callback function; all
502 non-empty arguments before it are concatenated to the
503 LIST command. (This *should* only be used for a pathname.)'''
504 cmd = 'LIST'
505 func = None
506 if args[-1:] and type(args[-1]) != type(''):
507 args, func = args[:-1], args[-1]
508 for arg in args:
509 if arg:
510 cmd = cmd + (' ' + arg)
511 self.retrlines(cmd, func)
Guido van Rossumc567c601992-11-05 22:22:37 +0000512
Tim Peters88869f92001-01-14 23:36:06 +0000513 def rename(self, fromname, toname):
514 '''Rename a file.'''
515 resp = self.sendcmd('RNFR ' + fromname)
516 if resp[0] != '3':
517 raise error_reply, resp
518 return self.voidcmd('RNTO ' + toname)
Guido van Rossuma61bdeb1995-10-11 17:36:31 +0000519
Tim Peters88869f92001-01-14 23:36:06 +0000520 def delete(self, filename):
521 '''Delete a file.'''
522 resp = self.sendcmd('DELE ' + filename)
523 if resp[:3] in ('250', '200'):
524 return resp
Tim Peters88869f92001-01-14 23:36:06 +0000525 else:
526 raise error_reply, resp
Guido van Rossum02cf5821993-05-17 08:00:02 +0000527
Tim Peters88869f92001-01-14 23:36:06 +0000528 def cwd(self, dirname):
529 '''Change to a directory.'''
530 if dirname == '..':
531 try:
532 return self.voidcmd('CDUP')
533 except error_perm, msg:
Martin v. Löwisb5255112002-03-10 15:59:58 +0000534 if msg.args[0][:3] != '500':
535 raise
Tim Peters88869f92001-01-14 23:36:06 +0000536 elif dirname == '':
537 dirname = '.' # does nothing, but could return error
538 cmd = 'CWD ' + dirname
539 return self.voidcmd(cmd)
Guido van Rossum17ed1ae1993-06-01 13:21:04 +0000540
Tim Peters88869f92001-01-14 23:36:06 +0000541 def size(self, filename):
542 '''Retrieve the size of a file.'''
Gregory P. Smith2230bcf2008-01-22 23:15:34 +0000543 # The SIZE command is defined in RFC-3659
Tim Peters88869f92001-01-14 23:36:06 +0000544 resp = self.sendcmd('SIZE ' + filename)
545 if resp[:3] == '213':
Guido van Rossumb6aca6a2001-10-16 19:45:52 +0000546 s = resp[3:].strip()
547 try:
548 return int(s)
Guido van Rossum1f74cb32001-10-17 17:21:47 +0000549 except (OverflowError, ValueError):
Guido van Rossumb6aca6a2001-10-16 19:45:52 +0000550 return long(s)
Guido van Rossumc567c601992-11-05 22:22:37 +0000551
Tim Peters88869f92001-01-14 23:36:06 +0000552 def mkd(self, dirname):
553 '''Make a directory, return its full pathname.'''
554 resp = self.sendcmd('MKD ' + dirname)
555 return parse257(resp)
Guido van Rossum98245091998-02-19 21:15:44 +0000556
Tim Peters88869f92001-01-14 23:36:06 +0000557 def rmd(self, dirname):
558 '''Remove a directory.'''
559 return self.voidcmd('RMD ' + dirname)
Guido van Rossum1115ab21992-11-04 15:51:30 +0000560
Tim Peters88869f92001-01-14 23:36:06 +0000561 def pwd(self):
562 '''Return current working directory.'''
563 resp = self.sendcmd('PWD')
564 return parse257(resp)
Guido van Rossum17ed1ae1993-06-01 13:21:04 +0000565
Tim Peters88869f92001-01-14 23:36:06 +0000566 def quit(self):
567 '''Quit, and close the connection.'''
568 resp = self.voidcmd('QUIT')
569 self.close()
570 return resp
571
572 def close(self):
573 '''Close the connection without assuming anything about it.'''
Fred Drake9c98a422001-02-28 21:46:37 +0000574 if self.file:
575 self.file.close()
576 self.sock.close()
577 self.file = self.sock = None
Guido van Rossumc567c601992-11-05 22:22:37 +0000578
579
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000580try:
581 import ssl
582except ImportError:
583 pass
584else:
585 class FTP_TLS(FTP):
586 '''A FTP subclass which adds TLS support to FTP as described
587 in RFC-4217.
588
589 Connect as usual to port 21 implicitly securing the FTP control
590 connection before authenticating.
591
592 Securing the data connection requires user to explicitly ask
593 for it by calling prot_p() method.
594
595 Usage example:
596 >>> from ftplib import FTP_TLS
597 >>> ftps = FTP_TLS('ftp.python.org')
598 >>> ftps.login() # login anonimously previously securing control channel
599 '230 Guest login ok, access restrictions apply.'
600 >>> ftps.prot_p() # switch to secure data connection
601 '200 Protection level set to P'
602 >>> ftps.retrlines('LIST') # list directory content securely
603 total 9
604 drwxr-xr-x 8 root wheel 1024 Jan 3 1994 .
605 drwxr-xr-x 8 root wheel 1024 Jan 3 1994 ..
606 drwxr-xr-x 2 root wheel 1024 Jan 3 1994 bin
607 drwxr-xr-x 2 root wheel 1024 Jan 3 1994 etc
608 d-wxrwxr-x 2 ftp wheel 1024 Sep 5 13:43 incoming
609 drwxr-xr-x 2 root wheel 1024 Nov 17 1993 lib
610 drwxr-xr-x 6 1094 wheel 1024 Sep 13 19:07 pub
611 drwxr-xr-x 3 root wheel 1024 Jan 3 1994 usr
612 -rw-r--r-- 1 root root 312 Aug 1 1994 welcome.msg
613 '226 Transfer complete.'
614 >>> ftps.quit()
615 '221 Goodbye.'
616 >>>
617 '''
618 ssl_version = ssl.PROTOCOL_TLSv1
619
620 def __init__(self, host='', user='', passwd='', acct='', keyfile=None,
621 certfile=None, timeout=_GLOBAL_DEFAULT_TIMEOUT):
622 self.keyfile = keyfile
623 self.certfile = certfile
624 self._prot_p = False
625 FTP.__init__(self, host, user, passwd, acct, timeout)
626
627 def login(self, user='', passwd='', acct='', secure=True):
628 if secure and not isinstance(self.sock, ssl.SSLSocket):
629 self.auth()
630 return FTP.login(self, user, passwd, acct)
631
632 def auth(self):
633 '''Set up secure control connection by using TLS/SSL.'''
634 if isinstance(self.sock, ssl.SSLSocket):
635 raise ValueError("Already using TLS")
636 if self.ssl_version == ssl.PROTOCOL_TLSv1:
637 resp = self.voidcmd('AUTH TLS')
638 else:
639 resp = self.voidcmd('AUTH SSL')
640 self.sock = ssl.wrap_socket(self.sock, self.keyfile, self.certfile,
641 ssl_version=self.ssl_version)
642 self.file = self.sock.makefile(mode='rb')
643 return resp
644
645 def prot_p(self):
646 '''Set up secure data connection.'''
647 # PROT defines whether or not the data channel is to be protected.
648 # Though RFC-2228 defines four possible protection levels,
649 # RFC-4217 only recommends two, Clear and Private.
650 # Clear (PROT C) means that no security is to be used on the
651 # data-channel, Private (PROT P) means that the data-channel
652 # should be protected by TLS.
653 # PBSZ command MUST still be issued, but must have a parameter of
654 # '0' to indicate that no buffering is taking place and the data
655 # connection should not be encapsulated.
656 self.voidcmd('PBSZ 0')
657 resp = self.voidcmd('PROT P')
658 self._prot_p = True
659 return resp
660
661 def prot_c(self):
662 '''Set up clear text data connection.'''
663 resp = self.voidcmd('PROT C')
664 self._prot_p = False
665 return resp
666
667 # --- Overridden FTP methods
668
669 def ntransfercmd(self, cmd, rest=None):
670 conn, size = FTP.ntransfercmd(self, cmd, rest)
671 if self._prot_p:
672 conn = ssl.wrap_socket(conn, self.keyfile, self.certfile,
673 ssl_version=self.ssl_version)
674 return conn, size
675
676 def retrbinary(self, cmd, callback, blocksize=8192, rest=None):
677 self.voidcmd('TYPE I')
678 conn = self.transfercmd(cmd, rest)
679 try:
680 while 1:
681 data = conn.recv(blocksize)
682 if not data:
683 break
684 callback(data)
685 # shutdown ssl layer
686 if isinstance(conn, ssl.SSLSocket):
687 conn.unwrap()
688 finally:
689 conn.close()
690 return self.voidresp()
691
692 def retrlines(self, cmd, callback = None):
693 if callback is None: callback = print_line
694 resp = self.sendcmd('TYPE A')
695 conn = self.transfercmd(cmd)
696 fp = conn.makefile('rb')
697 try:
698 while 1:
699 line = fp.readline()
700 if self.debugging > 2: print '*retr*', repr(line)
701 if not line:
702 break
703 if line[-2:] == CRLF:
704 line = line[:-2]
705 elif line[-1:] == '\n':
706 line = line[:-1]
707 callback(line)
708 # shutdown ssl layer
709 if isinstance(conn, ssl.SSLSocket):
710 conn.unwrap()
711 finally:
712 fp.close()
713 conn.close()
714 return self.voidresp()
715
Antoine Pitrouacbe3bd2009-11-27 13:18:34 +0000716 def storbinary(self, cmd, fp, blocksize=8192, callback=None, rest=None):
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000717 self.voidcmd('TYPE I')
Antoine Pitrouacbe3bd2009-11-27 13:18:34 +0000718 conn = self.transfercmd(cmd, rest)
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000719 try:
720 while 1:
721 buf = fp.read(blocksize)
722 if not buf: break
723 conn.sendall(buf)
724 if callback: callback(buf)
725 # shutdown ssl layer
726 if isinstance(conn, ssl.SSLSocket):
727 conn.unwrap()
728 finally:
729 conn.close()
730 return self.voidresp()
731
732 def storlines(self, cmd, fp, callback=None):
733 self.voidcmd('TYPE A')
734 conn = self.transfercmd(cmd)
735 try:
736 while 1:
737 buf = fp.readline()
738 if not buf: break
739 if buf[-2:] != CRLF:
740 if buf[-1] in CRLF: buf = buf[:-1]
741 buf = buf + CRLF
742 conn.sendall(buf)
743 if callback: callback(buf)
744 # shutdown ssl layer
745 if isinstance(conn, ssl.SSLSocket):
746 conn.unwrap()
747 finally:
748 conn.close()
749 return self.voidresp()
750
751 __all__.append('FTP_TLS')
752 all_errors = (Error, IOError, EOFError, ssl.SSLError)
753
754
Guido van Rossumacfb82a1997-10-22 20:49:52 +0000755_150_re = None
Fred Drake4de02d91997-01-10 18:26:09 +0000756
757def parse150(resp):
Tim Peters88869f92001-01-14 23:36:06 +0000758 '''Parse the '150' response for a RETR request.
759 Returns the expected transfer size or None; size is not guaranteed to
760 be present in the 150 message.
761 '''
762 if resp[:3] != '150':
763 raise error_reply, resp
764 global _150_re
765 if _150_re is None:
766 import re
767 _150_re = re.compile("150 .* \((\d+) bytes\)", re.IGNORECASE)
768 m = _150_re.match(resp)
Guido van Rossumb6aca6a2001-10-16 19:45:52 +0000769 if not m:
770 return None
771 s = m.group(1)
772 try:
773 return int(s)
Guido van Rossum1f74cb32001-10-17 17:21:47 +0000774 except (OverflowError, ValueError):
Guido van Rossumb6aca6a2001-10-16 19:45:52 +0000775 return long(s)
Fred Drake4de02d91997-01-10 18:26:09 +0000776
777
Guido van Rossum70297d32001-08-17 17:24:29 +0000778_227_re = None
779
Guido van Rossumd2560b01996-05-28 23:41:25 +0000780def parse227(resp):
Tim Peters88869f92001-01-14 23:36:06 +0000781 '''Parse the '227' response for a PASV request.
782 Raises error_proto if it does not contain '(h1,h2,h3,h4,p1,p2)'
783 Return ('host.addr.as.numbers', port#) tuple.'''
Guido van Rossumd2560b01996-05-28 23:41:25 +0000784
Tim Peters88869f92001-01-14 23:36:06 +0000785 if resp[:3] != '227':
786 raise error_reply, resp
Guido van Rossum70297d32001-08-17 17:24:29 +0000787 global _227_re
788 if _227_re is None:
789 import re
790 _227_re = re.compile(r'(\d+),(\d+),(\d+),(\d+),(\d+),(\d+)')
791 m = _227_re.search(resp)
792 if not m:
Tim Peters88869f92001-01-14 23:36:06 +0000793 raise error_proto, resp
Guido van Rossum70297d32001-08-17 17:24:29 +0000794 numbers = m.groups()
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000795 host = '.'.join(numbers[:4])
796 port = (int(numbers[4]) << 8) + int(numbers[5])
Tim Peters88869f92001-01-14 23:36:06 +0000797 return host, port
Guido van Rossumd2560b01996-05-28 23:41:25 +0000798
799
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000800def parse229(resp, peer):
801 '''Parse the '229' response for a EPSV request.
802 Raises error_proto if it does not contain '(|||port|)'
803 Return ('host.addr.as.numbers', port#) tuple.'''
804
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000805 if resp[:3] != '229':
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000806 raise error_reply, resp
Neal Norwitz7ce734c2002-05-31 14:13:04 +0000807 left = resp.find('(')
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000808 if left < 0: raise error_proto, resp
Neal Norwitz7ce734c2002-05-31 14:13:04 +0000809 right = resp.find(')', left + 1)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000810 if right < 0:
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000811 raise error_proto, resp # should contain '(|||port|)'
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000812 if resp[left + 1] != resp[right - 1]:
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000813 raise error_proto, resp
Walter Dörwalda401ae42002-06-03 10:41:45 +0000814 parts = resp[left + 1:right].split(resp[left+1])
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000815 if len(parts) != 5:
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000816 raise error_proto, resp
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000817 host = peer[0]
Neal Norwitz7ce734c2002-05-31 14:13:04 +0000818 port = int(parts[3])
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000819 return host, port
820
821
Guido van Rossumc567c601992-11-05 22:22:37 +0000822def parse257(resp):
Tim Peters88869f92001-01-14 23:36:06 +0000823 '''Parse the '257' response for a MKD or PWD request.
824 This is a response to a MKD or PWD request: a directory name.
825 Returns the directoryname in the 257 reply.'''
Guido van Rossumd2560b01996-05-28 23:41:25 +0000826
Tim Peters88869f92001-01-14 23:36:06 +0000827 if resp[:3] != '257':
828 raise error_reply, resp
829 if resp[3:5] != ' "':
830 return '' # Not compliant to RFC 959, but UNIX ftpd does this
831 dirname = ''
832 i = 5
833 n = len(resp)
834 while i < n:
835 c = resp[i]
836 i = i+1
837 if c == '"':
838 if i >= n or resp[i] != '"':
839 break
840 i = i+1
841 dirname = dirname + c
842 return dirname
Guido van Rossum1115ab21992-11-04 15:51:30 +0000843
Guido van Rossum2f3941d1997-10-07 14:49:56 +0000844
Guido van Rossumae3b3a31993-11-30 13:43:54 +0000845def print_line(line):
Tim Peters88869f92001-01-14 23:36:06 +0000846 '''Default retrlines callback to print a line.'''
847 print line
Guido van Rossumae3b3a31993-11-30 13:43:54 +0000848
Guido van Rossum2f3941d1997-10-07 14:49:56 +0000849
Guido van Rossumd2560b01996-05-28 23:41:25 +0000850def ftpcp(source, sourcename, target, targetname = '', type = 'I'):
Tim Peters88869f92001-01-14 23:36:06 +0000851 '''Copy file from one FTP-instance to another.'''
852 if not targetname: targetname = sourcename
853 type = 'TYPE ' + type
854 source.voidcmd(type)
855 target.voidcmd(type)
856 sourcehost, sourceport = parse227(source.sendcmd('PASV'))
857 target.sendport(sourcehost, sourceport)
858 # RFC 959: the user must "listen" [...] BEFORE sending the
859 # transfer request.
860 # So: STOR before RETR, because here the target is a "user".
861 treply = target.sendcmd('STOR ' + targetname)
862 if treply[:3] not in ('125', '150'): raise error_proto # RFC 959
863 sreply = source.sendcmd('RETR ' + sourcename)
864 if sreply[:3] not in ('125', '150'): raise error_proto # RFC 959
865 source.voidresp()
866 target.voidresp()
Guido van Rossum1115ab21992-11-04 15:51:30 +0000867
Tim Peters88869f92001-01-14 23:36:06 +0000868
Guido van Rossum56d1e3a1997-03-14 04:16:54 +0000869class Netrc:
Tim Peters88869f92001-01-14 23:36:06 +0000870 """Class to parse & provide access to 'netrc' format files.
Fred Drake475d51d1997-06-24 22:02:54 +0000871
Tim Peters88869f92001-01-14 23:36:06 +0000872 See the netrc(4) man page for information on the file format.
Guido van Rossum56d1e3a1997-03-14 04:16:54 +0000873
Tim Peters88869f92001-01-14 23:36:06 +0000874 WARNING: This class is obsolete -- use module netrc instead.
Guido van Rossumc822a451998-12-22 16:49:16 +0000875
Tim Peters88869f92001-01-14 23:36:06 +0000876 """
877 __defuser = None
878 __defpasswd = None
879 __defacct = None
Guido van Rossum56d1e3a1997-03-14 04:16:54 +0000880
Tim Peters88869f92001-01-14 23:36:06 +0000881 def __init__(self, filename=None):
Raymond Hettinger094662a2002-06-01 01:29:16 +0000882 if filename is None:
Raymond Hettinger54f02222002-06-01 14:18:47 +0000883 if "HOME" in os.environ:
Tim Peters88869f92001-01-14 23:36:06 +0000884 filename = os.path.join(os.environ["HOME"],
885 ".netrc")
886 else:
887 raise IOError, \
888 "specify file to load or set $HOME"
889 self.__hosts = {}
890 self.__macros = {}
891 fp = open(filename, "r")
892 in_macro = 0
893 while 1:
894 line = fp.readline()
895 if not line: break
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000896 if in_macro and line.strip():
Tim Peters88869f92001-01-14 23:36:06 +0000897 macro_lines.append(line)
898 continue
899 elif in_macro:
900 self.__macros[macro_name] = tuple(macro_lines)
901 in_macro = 0
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000902 words = line.split()
Tim Peters88869f92001-01-14 23:36:06 +0000903 host = user = passwd = acct = None
904 default = 0
905 i = 0
906 while i < len(words):
907 w1 = words[i]
908 if i+1 < len(words):
909 w2 = words[i + 1]
910 else:
911 w2 = None
912 if w1 == 'default':
913 default = 1
914 elif w1 == 'machine' and w2:
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000915 host = w2.lower()
Tim Peters88869f92001-01-14 23:36:06 +0000916 i = i + 1
917 elif w1 == 'login' and w2:
918 user = w2
919 i = i + 1
920 elif w1 == 'password' and w2:
921 passwd = w2
922 i = i + 1
923 elif w1 == 'account' and w2:
924 acct = w2
925 i = i + 1
926 elif w1 == 'macdef' and w2:
927 macro_name = w2
928 macro_lines = []
929 in_macro = 1
930 break
931 i = i + 1
932 if default:
933 self.__defuser = user or self.__defuser
934 self.__defpasswd = passwd or self.__defpasswd
935 self.__defacct = acct or self.__defacct
936 if host:
Raymond Hettinger54f02222002-06-01 14:18:47 +0000937 if host in self.__hosts:
Tim Peters88869f92001-01-14 23:36:06 +0000938 ouser, opasswd, oacct = \
939 self.__hosts[host]
940 user = user or ouser
941 passwd = passwd or opasswd
942 acct = acct or oacct
943 self.__hosts[host] = user, passwd, acct
944 fp.close()
Guido van Rossum56d1e3a1997-03-14 04:16:54 +0000945
Tim Peters88869f92001-01-14 23:36:06 +0000946 def get_hosts(self):
947 """Return a list of hosts mentioned in the .netrc file."""
948 return self.__hosts.keys()
Guido van Rossum8ca84201998-03-26 20:56:10 +0000949
Tim Peters88869f92001-01-14 23:36:06 +0000950 def get_account(self, host):
951 """Returns login information for the named host.
Guido van Rossum8ca84201998-03-26 20:56:10 +0000952
Tim Peters88869f92001-01-14 23:36:06 +0000953 The return value is a triple containing userid,
954 password, and the accounting field.
Guido van Rossum8ca84201998-03-26 20:56:10 +0000955
Tim Peters88869f92001-01-14 23:36:06 +0000956 """
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000957 host = host.lower()
Tim Peters88869f92001-01-14 23:36:06 +0000958 user = passwd = acct = None
Raymond Hettinger54f02222002-06-01 14:18:47 +0000959 if host in self.__hosts:
Tim Peters88869f92001-01-14 23:36:06 +0000960 user, passwd, acct = self.__hosts[host]
961 user = user or self.__defuser
962 passwd = passwd or self.__defpasswd
963 acct = acct or self.__defacct
964 return user, passwd, acct
Guido van Rossum8ca84201998-03-26 20:56:10 +0000965
Tim Peters88869f92001-01-14 23:36:06 +0000966 def get_macros(self):
967 """Return a list of all defined macro names."""
968 return self.__macros.keys()
Guido van Rossum8ca84201998-03-26 20:56:10 +0000969
Tim Peters88869f92001-01-14 23:36:06 +0000970 def get_macro(self, macro):
971 """Return a sequence of lines which define a named macro."""
972 return self.__macros[macro]
Guido van Rossum56d1e3a1997-03-14 04:16:54 +0000973
Fred Drake475d51d1997-06-24 22:02:54 +0000974
Tim Peters88869f92001-01-14 23:36:06 +0000975
Guido van Rossum1115ab21992-11-04 15:51:30 +0000976def test():
Tim Peters88869f92001-01-14 23:36:06 +0000977 '''Test program.
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000978 Usage: ftp [-d] [-r[file]] host [-l[dir]] [-d[dir]] [-p] [file] ...
979
980 -d dir
981 -l list
982 -p password
983 '''
984
985 if len(sys.argv) < 2:
986 print test.__doc__
987 sys.exit(0)
Guido van Rossumd2560b01996-05-28 23:41:25 +0000988
Tim Peters88869f92001-01-14 23:36:06 +0000989 debugging = 0
990 rcfile = None
991 while sys.argv[1] == '-d':
992 debugging = debugging+1
993 del sys.argv[1]
994 if sys.argv[1][:2] == '-r':
995 # get name of alternate ~/.netrc file:
996 rcfile = sys.argv[1][2:]
997 del sys.argv[1]
998 host = sys.argv[1]
999 ftp = FTP(host)
1000 ftp.set_debuglevel(debugging)
1001 userid = passwd = acct = ''
1002 try:
1003 netrc = Netrc(rcfile)
1004 except IOError:
1005 if rcfile is not None:
1006 sys.stderr.write("Could not open account file"
1007 " -- using anonymous login.")
1008 else:
1009 try:
1010 userid, passwd, acct = netrc.get_account(host)
1011 except KeyError:
1012 # no account for host
1013 sys.stderr.write(
1014 "No account -- using anonymous login.")
1015 ftp.login(userid, passwd, acct)
1016 for file in sys.argv[2:]:
1017 if file[:2] == '-l':
1018 ftp.dir(file[2:])
1019 elif file[:2] == '-d':
1020 cmd = 'CWD'
1021 if file[2:]: cmd = cmd + ' ' + file[2:]
1022 resp = ftp.sendcmd(cmd)
1023 elif file == '-p':
1024 ftp.set_pasv(not ftp.passiveserver)
1025 else:
1026 ftp.retrbinary('RETR ' + file, \
1027 sys.stdout.write, 1024)
1028 ftp.quit()
Guido van Rossum221ec0b1995-08-04 04:39:30 +00001029
1030
1031if __name__ == '__main__':
Tim Peters88869f92001-01-14 23:36:06 +00001032 test()