blob: c416d8562b097a502c774fd082fb77287ad30369 [file] [log] [blame]
Guido van Rossum4b8c6ea2000-02-04 15:39:30 +00001"""An FTP client class and some helper functions.
2
Barry Warsaw100d81e2000-09-01 06:09:23 +00003Based on RFC 959: File Transfer Protocol (FTP), by J. Postel and J. Reynolds
Guido van Rossum1115ab21992-11-04 15:51:30 +00004
Guido van Rossumd2560b01996-05-28 23:41:25 +00005Example:
6
7>>> from ftplib import FTP
8>>> ftp = FTP('ftp.python.org') # connect to host, default port
Guido van Rossum24a64342001-12-28 20:54:55 +00009>>> ftp.login() # default, i.e.: user anonymous, passwd anonymous@
Guido van Rossum2f3941d1997-10-07 14:49:56 +000010'230 Guest login ok, access restrictions apply.'
Guido van Rossumd2560b01996-05-28 23:41:25 +000011>>> ftp.retrlines('LIST') # list directory contents
12total 9
13drwxr-xr-x 8 root wheel 1024 Jan 3 1994 .
14drwxr-xr-x 8 root wheel 1024 Jan 3 1994 ..
15drwxr-xr-x 2 root wheel 1024 Jan 3 1994 bin
16drwxr-xr-x 2 root wheel 1024 Jan 3 1994 etc
17d-wxrwxr-x 2 ftp wheel 1024 Sep 5 13:43 incoming
18drwxr-xr-x 2 root wheel 1024 Nov 17 1993 lib
19drwxr-xr-x 6 1094 wheel 1024 Sep 13 19:07 pub
20drwxr-xr-x 3 root wheel 1024 Jan 3 1994 usr
21-rw-r--r-- 1 root root 312 Aug 1 1994 welcome.msg
Guido van Rossum2f3941d1997-10-07 14:49:56 +000022'226 Transfer complete.'
Guido van Rossumd2560b01996-05-28 23:41:25 +000023>>> ftp.quit()
Guido van Rossum2f3941d1997-10-07 14:49:56 +000024'221 Goodbye.'
Tim Peters88869f92001-01-14 23:36:06 +000025>>>
Guido van Rossumd2560b01996-05-28 23:41:25 +000026
27A nice test that reveals some of the network dialogue would be:
28python ftplib.py -d localhost -l -p -l
Guido van Rossum4b8c6ea2000-02-04 15:39:30 +000029"""
Guido van Rossumc567c601992-11-05 22:22:37 +000030
Tim Peters88869f92001-01-14 23:36:06 +000031#
Guido van Rossum98d9fd32000-02-28 15:12:25 +000032# Changes and improvements suggested by Steve Majewski.
33# Modified by Jack to work on the mac.
34# Modified by Siebren to support docstrings and PASV.
Christian Heimes1af737c2008-01-23 08:24:23 +000035# Modified by Phil Schwartz to add storbinary and storlines callbacks.
Antoine Pitrouf988cd02009-11-17 20:21:14 +000036# Modified by Giampaolo Rodola' to add TLS support.
Guido van Rossum98d9fd32000-02-28 15:12:25 +000037#
Guido van Rossumc567c601992-11-05 22:22:37 +000038
Guido van Rossum1115ab21992-11-04 15:51:30 +000039import os
40import sys
Giampaolo Rodolà6545ed62010-08-21 20:34:37 +000041import socket
R David Murray87632f12013-02-19 18:32:28 -050042import warnings
Georg Brandlf78e02b2008-06-10 17:40:04 +000043from socket import _GLOBAL_DEFAULT_TIMEOUT
Guido van Rossumb6775db1994-08-01 11:34:53 +000044
Berker Peksag8f791d32014-11-01 10:45:57 +020045__all__ = ["FTP"]
Guido van Rossum1115ab21992-11-04 15:51:30 +000046
Guido van Rossumd3166071993-05-24 14:16:22 +000047# Magic number from <socket.h>
Tim Peters88869f92001-01-14 23:36:06 +000048MSG_OOB = 0x1 # Process data out of band
Guido van Rossumd3166071993-05-24 14:16:22 +000049
50
Guido van Rossumc567c601992-11-05 22:22:37 +000051# The standard FTP server control port
Guido van Rossum1115ab21992-11-04 15:51:30 +000052FTP_PORT = 21
Serhiy Storchakac30b1782013-10-20 16:58:27 +030053# The sizehint parameter passed to readline() calls
54MAXLINE = 8192
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
Andrew Svetlovf7a17b42012-12-25 16:47:37 +020067all_errors = (Error, OSError, 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'
Benjamin Petersonbe17a112008-09-27 21:49:47 +000072B_CRLF = b'\r\n'
Guido van Rossum1115ab21992-11-04 15:51:30 +000073
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
Serhiy Storchakac30b1782013-10-20 16:58:27 +0300102 maxline = MAXLINE
Fred Drake9c98a422001-02-28 21:46:37 +0000103 sock = None
104 file = None
105 welcome = None
106 passiveserver = 1
Marc-André Lemburg8f36af72011-02-25 15:42:01 +0000107 encoding = "latin-1"
Fred Drake9c98a422001-02-28 21:46:37 +0000108
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())
Georg Brandlf78e02b2008-06-10 17:40:04 +0000113 def __init__(self, host='', user='', passwd='', acct='',
Giampaolo Rodolà396ff062011-02-28 19:19:51 +0000114 timeout=_GLOBAL_DEFAULT_TIMEOUT, source_address=None):
115 self.source_address = source_address
Guido van Rossumd8faa362007-04-27 19:54:29 +0000116 self.timeout = timeout
Tim Peters88869f92001-01-14 23:36:06 +0000117 if host:
Fred Drake9c98a422001-02-28 21:46:37 +0000118 self.connect(host)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000119 if user:
120 self.login(user, passwd, acct)
Guido van Rossum52fc1f61993-06-17 12:38:10 +0000121
Giampaolo Rodolàbd576b72010-05-10 14:53:29 +0000122 def __enter__(self):
123 return self
124
125 # Context management protocol: try to quit() if active
126 def __exit__(self, *args):
127 if self.sock is not None:
128 try:
129 self.quit()
Andrew Svetlov0832af62012-12-18 23:10:48 +0200130 except (OSError, EOFError):
Giampaolo Rodolàbd576b72010-05-10 14:53:29 +0000131 pass
132 finally:
133 if self.sock is not None:
134 self.close()
135
Giampaolo Rodolà396ff062011-02-28 19:19:51 +0000136 def connect(self, host='', port=0, timeout=-999, source_address=None):
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000137 '''Connect to host. Arguments are:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000138 - host: hostname to connect to (string, default previous host)
139 - port: port to connect to (integer, default previous port)
Giampaolo Rodola'11a9bd62013-04-26 15:23:43 +0200140 - timeout: the timeout to set against the ftp socket(s)
Giampaolo Rodolà396ff062011-02-28 19:19:51 +0000141 - source_address: a 2-tuple (host, port) for the socket to bind
142 to as its source address before connecting.
Guido van Rossumd8faa362007-04-27 19:54:29 +0000143 '''
144 if host != '':
145 self.host = host
146 if port > 0:
147 self.port = port
Georg Brandlf78e02b2008-06-10 17:40:04 +0000148 if timeout != -999:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000149 self.timeout = timeout
Giampaolo Rodolà396ff062011-02-28 19:19:51 +0000150 if source_address is not None:
151 self.source_address = source_address
152 self.sock = socket.create_connection((self.host, self.port), self.timeout,
153 source_address=self.source_address)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000154 self.af = self.sock.family
Guido van Rossum52b89762007-07-17 20:45:57 +0000155 self.file = self.sock.makefile('r', encoding=self.encoding)
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000156 self.welcome = self.getresp()
157 return self.welcome
Guido van Rossum1115ab21992-11-04 15:51:30 +0000158
Tim Peters88869f92001-01-14 23:36:06 +0000159 def getwelcome(self):
160 '''Get the welcome message from the server.
161 (this is read and squirreled away by connect())'''
162 if self.debugging:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000163 print('*welcome*', self.sanitize(self.welcome))
Tim Peters88869f92001-01-14 23:36:06 +0000164 return self.welcome
Guido van Rossum1115ab21992-11-04 15:51:30 +0000165
Tim Peters88869f92001-01-14 23:36:06 +0000166 def set_debuglevel(self, level):
167 '''Set the debugging level.
168 The required argument level means:
169 0: no debugging output (default)
170 1: print commands and responses but not body text etc.
171 2: also print raw lines read and sent before stripping CR/LF'''
172 self.debugging = level
173 debug = set_debuglevel
Guido van Rossum1115ab21992-11-04 15:51:30 +0000174
Tim Peters88869f92001-01-14 23:36:06 +0000175 def set_pasv(self, val):
176 '''Use passive or active mode for data transfers.
177 With a false argument, use the normal PORT mode,
178 With a true argument, use the PASV command.'''
179 self.passiveserver = val
Guido van Rossumd2560b01996-05-28 23:41:25 +0000180
Tim Peters88869f92001-01-14 23:36:06 +0000181 # Internal: "sanitize" a string for printing
182 def sanitize(self, s):
Florent Xicluna2bb96f52011-10-23 22:11:00 +0200183 if s[:5] in {'pass ', 'PASS '}:
184 i = len(s.rstrip('\r\n'))
Tim Peters88869f92001-01-14 23:36:06 +0000185 s = s[:5] + '*'*(i-5) + s[i:]
Walter Dörwald70a6b492004-02-12 17:35:32 +0000186 return repr(s)
Guido van Rossumebaf1041995-05-05 15:54:14 +0000187
Tim Peters88869f92001-01-14 23:36:06 +0000188 # Internal: send one line to the server, appending CRLF
189 def putline(self, line):
190 line = line + CRLF
Giampaolo Rodola'94c56a12013-03-07 13:51:20 +0100191 if self.debugging > 1:
192 print('*put*', self.sanitize(line))
Guido van Rossum52b89762007-07-17 20:45:57 +0000193 self.sock.sendall(line.encode(self.encoding))
Guido van Rossum1115ab21992-11-04 15:51:30 +0000194
Tim Peters88869f92001-01-14 23:36:06 +0000195 # Internal: send one command to the server (through putline())
196 def putcmd(self, line):
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000197 if self.debugging: print('*cmd*', self.sanitize(line))
Tim Peters88869f92001-01-14 23:36:06 +0000198 self.putline(line)
Guido van Rossum1115ab21992-11-04 15:51:30 +0000199
Tim Peters88869f92001-01-14 23:36:06 +0000200 # Internal: return one line from the server, stripping CRLF.
201 # Raise EOFError if the connection is closed
202 def getline(self):
Serhiy Storchakac30b1782013-10-20 16:58:27 +0300203 line = self.file.readline(self.maxline + 1)
204 if len(line) > self.maxline:
205 raise Error("got more than %d bytes" % self.maxline)
Tim Peters88869f92001-01-14 23:36:06 +0000206 if self.debugging > 1:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000207 print('*get*', self.sanitize(line))
Giampaolo Rodola'94c56a12013-03-07 13:51:20 +0100208 if not line:
209 raise EOFError
210 if line[-2:] == CRLF:
211 line = line[:-2]
212 elif line[-1:] in CRLF:
213 line = line[:-1]
Tim Peters88869f92001-01-14 23:36:06 +0000214 return line
Guido van Rossum1115ab21992-11-04 15:51:30 +0000215
Tim Peters88869f92001-01-14 23:36:06 +0000216 # Internal: get a response from the server, which may possibly
217 # consist of multiple lines. Return a single string with no
218 # trailing CRLF. If the response consists of multiple lines,
219 # these are separated by '\n' characters in the string
220 def getmultiline(self):
221 line = self.getline()
222 if line[3:4] == '-':
223 code = line[:3]
224 while 1:
225 nextline = self.getline()
226 line = line + ('\n' + nextline)
227 if nextline[:3] == code and \
228 nextline[3:4] != '-':
229 break
230 return line
Guido van Rossum1115ab21992-11-04 15:51:30 +0000231
Tim Peters88869f92001-01-14 23:36:06 +0000232 # Internal: get a response from the server.
233 # Raise various errors if the response indicates an error
234 def getresp(self):
235 resp = self.getmultiline()
Giampaolo Rodola'94c56a12013-03-07 13:51:20 +0100236 if self.debugging:
237 print('*resp*', self.sanitize(resp))
Tim Peters88869f92001-01-14 23:36:06 +0000238 self.lastresp = resp[:3]
239 c = resp[:1]
Raymond Hettingerd5825cc2010-09-05 23:15:06 +0000240 if c in {'1', '2', '3'}:
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000241 return resp
Tim Peters88869f92001-01-14 23:36:06 +0000242 if c == '4':
Collin Winterce36ad82007-08-30 01:19:48 +0000243 raise error_temp(resp)
Tim Peters88869f92001-01-14 23:36:06 +0000244 if c == '5':
Collin Winterce36ad82007-08-30 01:19:48 +0000245 raise error_perm(resp)
246 raise error_proto(resp)
Guido van Rossum1115ab21992-11-04 15:51:30 +0000247
Tim Peters88869f92001-01-14 23:36:06 +0000248 def voidresp(self):
249 """Expect a response beginning with '2'."""
250 resp = self.getresp()
Benjamin Petersond23f8222009-04-05 19:13:16 +0000251 if resp[:1] != '2':
Collin Winterce36ad82007-08-30 01:19:48 +0000252 raise error_reply(resp)
Tim Peters88869f92001-01-14 23:36:06 +0000253 return resp
Guido van Rossumc567c601992-11-05 22:22:37 +0000254
Tim Peters88869f92001-01-14 23:36:06 +0000255 def abort(self):
256 '''Abort a file transfer. Uses out-of-band data.
257 This does not follow the procedure from the RFC to send Telnet
258 IP and Synch; that doesn't seem to work with the servers I've
259 tried. Instead, just send the ABOR command as OOB data.'''
Giampaolo Rodola'0b5c21f2011-05-07 19:03:47 +0200260 line = b'ABOR' + B_CRLF
Giampaolo Rodola'94c56a12013-03-07 13:51:20 +0100261 if self.debugging > 1:
262 print('*put urgent*', self.sanitize(line))
Martin v. Löwise12454f2002-02-16 23:06:19 +0000263 self.sock.sendall(line, MSG_OOB)
Tim Peters88869f92001-01-14 23:36:06 +0000264 resp = self.getmultiline()
Raymond Hettingerd5825cc2010-09-05 23:15:06 +0000265 if resp[:3] not in {'426', '225', '226'}:
Collin Winterce36ad82007-08-30 01:19:48 +0000266 raise error_proto(resp)
Giampaolo Rodola'0b5c21f2011-05-07 19:03:47 +0200267 return resp
Guido van Rossumd3166071993-05-24 14:16:22 +0000268
Tim Peters88869f92001-01-14 23:36:06 +0000269 def sendcmd(self, cmd):
270 '''Send a command and return the response.'''
271 self.putcmd(cmd)
272 return self.getresp()
Guido van Rossum1115ab21992-11-04 15:51:30 +0000273
Tim Peters88869f92001-01-14 23:36:06 +0000274 def voidcmd(self, cmd):
275 """Send a command and expect a response beginning with '2'."""
276 self.putcmd(cmd)
277 return self.voidresp()
Guido van Rossumc567c601992-11-05 22:22:37 +0000278
Tim Peters88869f92001-01-14 23:36:06 +0000279 def sendport(self, host, port):
280 '''Send a PORT command with the current host and the given
281 port number.
282 '''
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000283 hbytes = host.split('.')
Benjamin Peterson3a53fbb2008-09-27 22:04:16 +0000284 pbytes = [repr(port//256), repr(port%256)]
Tim Peters88869f92001-01-14 23:36:06 +0000285 bytes = hbytes + pbytes
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000286 cmd = 'PORT ' + ','.join(bytes)
Tim Peters88869f92001-01-14 23:36:06 +0000287 return self.voidcmd(cmd)
Guido van Rossum1115ab21992-11-04 15:51:30 +0000288
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000289 def sendeprt(self, host, port):
Martin Panter7462b6492015-11-02 03:37:02 +0000290 '''Send an EPRT command with the current host and the given port number.'''
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000291 af = 0
292 if self.af == socket.AF_INET:
293 af = 1
294 if self.af == socket.AF_INET6:
295 af = 2
296 if af == 0:
Collin Winterce36ad82007-08-30 01:19:48 +0000297 raise error_proto('unsupported address family')
Walter Dörwald70a6b492004-02-12 17:35:32 +0000298 fields = ['', repr(af), host, repr(port), '']
Neal Norwitz7ce734c2002-05-31 14:13:04 +0000299 cmd = 'EPRT ' + '|'.join(fields)
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000300 return self.voidcmd(cmd)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000301
Tim Peters88869f92001-01-14 23:36:06 +0000302 def makeport(self):
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000303 '''Create a new socket and send a PORT command for it.'''
Giampaolo Rodola'fc327882012-12-17 14:20:27 +0100304 err = None
Martin v. Löwis322c0d12001-10-07 08:53:32 +0000305 sock = None
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000306 for res in socket.getaddrinfo(None, 0, self.af, socket.SOCK_STREAM, 0, socket.AI_PASSIVE):
307 af, socktype, proto, canonname, sa = res
308 try:
309 sock = socket.socket(af, socktype, proto)
310 sock.bind(sa)
Andrew Svetlov0832af62012-12-18 23:10:48 +0200311 except OSError as _:
Giampaolo Rodola'57f34872012-12-17 20:46:16 +0100312 err = _
Martin v. Löwis322c0d12001-10-07 08:53:32 +0000313 if sock:
314 sock.close()
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000315 sock = None
316 continue
317 break
Giampaolo Rodola'fc327882012-12-17 14:20:27 +0100318 if sock is None:
319 if err is not None:
320 raise err
321 else:
Andrew Svetlov0832af62012-12-18 23:10:48 +0200322 raise OSError("getaddrinfo returns an empty list")
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000323 sock.listen(1)
324 port = sock.getsockname()[1] # Get proper port
325 host = self.sock.getsockname()[0] # Get proper host
326 if self.af == socket.AF_INET:
327 resp = self.sendport(host, port)
328 else:
329 resp = self.sendeprt(host, port)
Giampaolo Rodolà5fb313b2010-04-19 22:05:54 +0000330 if self.timeout is not _GLOBAL_DEFAULT_TIMEOUT:
331 sock.settimeout(self.timeout)
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000332 return sock
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000333
334 def makepasv(self):
Martin v. Löwis4eb59402001-07-26 13:37:33 +0000335 if self.af == socket.AF_INET:
336 host, port = parse227(self.sendcmd('PASV'))
337 else:
338 host, port = parse229(self.sendcmd('EPSV'), self.sock.getpeername())
339 return host, port
Guido van Rossum1115ab21992-11-04 15:51:30 +0000340
Tim Peters88869f92001-01-14 23:36:06 +0000341 def ntransfercmd(self, cmd, rest=None):
342 """Initiate a transfer over the data connection.
Barry Warsaw100d81e2000-09-01 06:09:23 +0000343
Tim Peters88869f92001-01-14 23:36:06 +0000344 If the transfer is active, send a port command and the
345 transfer command, and accept the connection. If the server is
346 passive, send a pasv command, connect to it, and start the
347 transfer command. Either way, return the socket for the
348 connection and the expected size of the transfer. The
349 expected size may be None if it could not be determined.
Barry Warsaw100d81e2000-09-01 06:09:23 +0000350
Tim Peters88869f92001-01-14 23:36:06 +0000351 Optional `rest' argument can be a string that is sent as the
Christian Heimes1af737c2008-01-23 08:24:23 +0000352 argument to a REST command. This is essentially a server
Tim Peters88869f92001-01-14 23:36:06 +0000353 marker used to tell the server to skip over any data up to the
354 given marker.
355 """
356 size = None
357 if self.passiveserver:
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000358 host, port = self.makepasv()
Giampaolo Rodolà396ff062011-02-28 19:19:51 +0000359 conn = socket.create_connection((host, port), self.timeout,
360 source_address=self.source_address)
Nadeem Vawda08f5f7a2011-07-23 14:03:00 +0200361 try:
362 if rest is not None:
363 self.sendcmd("REST %s" % rest)
364 resp = self.sendcmd(cmd)
365 # Some servers apparently send a 200 reply to
366 # a LIST or STOR command, before the 150 reply
367 # (and way before the 226 reply). This seems to
368 # be in violation of the protocol (which only allows
369 # 1xx or error messages for LIST), so we just discard
370 # this response.
371 if resp[0] == '2':
372 resp = self.getresp()
373 if resp[0] != '1':
374 raise error_reply(resp)
375 except:
376 conn.close()
377 raise
Tim Peters88869f92001-01-14 23:36:06 +0000378 else:
Giampaolo Rodola'836e9aa2011-12-10 21:25:04 +0100379 with self.makeport() as sock:
Nadeem Vawda08f5f7a2011-07-23 14:03:00 +0200380 if rest is not None:
381 self.sendcmd("REST %s" % rest)
382 resp = self.sendcmd(cmd)
383 # See above.
384 if resp[0] == '2':
385 resp = self.getresp()
386 if resp[0] != '1':
387 raise error_reply(resp)
388 conn, sockaddr = sock.accept()
389 if self.timeout is not _GLOBAL_DEFAULT_TIMEOUT:
390 conn.settimeout(self.timeout)
Tim Peters88869f92001-01-14 23:36:06 +0000391 if resp[:3] == '150':
392 # this is conditional in case we received a 125
393 size = parse150(resp)
394 return conn, size
Fred Drake4de02d91997-01-10 18:26:09 +0000395
Tim Peters88869f92001-01-14 23:36:06 +0000396 def transfercmd(self, cmd, rest=None):
Guido van Rossumb6aca6a2001-10-16 19:45:52 +0000397 """Like ntransfercmd() but returns only the socket."""
Tim Peters88869f92001-01-14 23:36:06 +0000398 return self.ntransfercmd(cmd, rest)[0]
Guido van Rossumc567c601992-11-05 22:22:37 +0000399
Tim Peters88869f92001-01-14 23:36:06 +0000400 def login(self, user = '', passwd = '', acct = ''):
401 '''Login, default anonymous.'''
Giampaolo Rodola'94c56a12013-03-07 13:51:20 +0100402 if not user:
403 user = 'anonymous'
404 if not passwd:
405 passwd = ''
406 if not acct:
407 acct = ''
Raymond Hettingerd5825cc2010-09-05 23:15:06 +0000408 if user == 'anonymous' and passwd in {'', '-'}:
Tim Peterse4418602002-02-16 07:34:19 +0000409 # If there is no anonymous ftp password specified
410 # then we'll just use anonymous@
411 # We don't send any other thing because:
412 # - We want to remain anonymous
413 # - We want to stop SPAM
414 # - We don't want to let ftp sites to discriminate by the user,
415 # host or country.
Guido van Rossumc33e0772001-12-28 20:54:28 +0000416 passwd = passwd + 'anonymous@'
Tim Peters88869f92001-01-14 23:36:06 +0000417 resp = self.sendcmd('USER ' + user)
Giampaolo Rodola'94c56a12013-03-07 13:51:20 +0100418 if resp[0] == '3':
419 resp = self.sendcmd('PASS ' + passwd)
420 if resp[0] == '3':
421 resp = self.sendcmd('ACCT ' + acct)
Tim Peters88869f92001-01-14 23:36:06 +0000422 if resp[0] != '2':
Collin Winterce36ad82007-08-30 01:19:48 +0000423 raise error_reply(resp)
Tim Peters88869f92001-01-14 23:36:06 +0000424 return resp
Guido van Rossumc567c601992-11-05 22:22:37 +0000425
Tim Peters88869f92001-01-14 23:36:06 +0000426 def retrbinary(self, cmd, callback, blocksize=8192, rest=None):
Christian Heimes1af737c2008-01-23 08:24:23 +0000427 """Retrieve data in binary mode. A new port is created for you.
Barry Warsaw100d81e2000-09-01 06:09:23 +0000428
Christian Heimes1af737c2008-01-23 08:24:23 +0000429 Args:
430 cmd: A RETR command.
431 callback: A single parameter callable to be called on each
432 block of data read.
433 blocksize: The maximum number of bytes to read from the
434 socket at one time. [default: 8192]
435 rest: Passed to transfercmd(). [default: None]
Guido van Rossum1115ab21992-11-04 15:51:30 +0000436
Christian Heimes1af737c2008-01-23 08:24:23 +0000437 Returns:
438 The response code.
Tim Peters88869f92001-01-14 23:36:06 +0000439 """
440 self.voidcmd('TYPE I')
Benjamin Petersona8071372010-10-31 18:21:16 +0000441 with self.transfercmd(cmd, rest) as conn:
442 while 1:
443 data = conn.recv(blocksize)
444 if not data:
445 break
446 callback(data)
Giampaolo Rodola'3ff5e752013-03-07 14:03:27 +0100447 # shutdown ssl layer
Giampaolo Rodola'a77d7a52013-03-18 09:59:15 +0100448 if _SSLSocket is not None and isinstance(conn, _SSLSocket):
Giampaolo Rodola'3ff5e752013-03-07 14:03:27 +0100449 conn.unwrap()
Tim Peters88869f92001-01-14 23:36:06 +0000450 return self.voidresp()
Guido van Rossum1115ab21992-11-04 15:51:30 +0000451
Tim Peters88869f92001-01-14 23:36:06 +0000452 def retrlines(self, cmd, callback = None):
Christian Heimes1af737c2008-01-23 08:24:23 +0000453 """Retrieve data in line mode. A new port is created for you.
454
455 Args:
Giampaolo Rodola'd78def92011-05-06 19:49:08 +0200456 cmd: A RETR, LIST, or NLST command.
Christian Heimes1af737c2008-01-23 08:24:23 +0000457 callback: An optional single parameter callable that is called
458 for each line with the trailing CRLF stripped.
459 [default: print_line()]
460
461 Returns:
462 The response code.
463 """
Giampaolo Rodola'94c56a12013-03-07 13:51:20 +0100464 if callback is None:
465 callback = print_line
Tim Peters88869f92001-01-14 23:36:06 +0000466 resp = self.sendcmd('TYPE A')
Benjamin Petersona8071372010-10-31 18:21:16 +0000467 with self.transfercmd(cmd) as conn, \
468 conn.makefile('r', encoding=self.encoding) as fp:
469 while 1:
Serhiy Storchakac30b1782013-10-20 16:58:27 +0300470 line = fp.readline(self.maxline + 1)
471 if len(line) > self.maxline:
472 raise Error("got more than %d bytes" % self.maxline)
Giampaolo Rodola'94c56a12013-03-07 13:51:20 +0100473 if self.debugging > 2:
474 print('*retr*', repr(line))
Benjamin Petersona8071372010-10-31 18:21:16 +0000475 if not line:
476 break
477 if line[-2:] == CRLF:
478 line = line[:-2]
479 elif line[-1:] == '\n':
480 line = line[:-1]
481 callback(line)
Giampaolo Rodola'3ff5e752013-03-07 14:03:27 +0100482 # shutdown ssl layer
Giampaolo Rodola'a77d7a52013-03-18 09:59:15 +0100483 if _SSLSocket is not None and isinstance(conn, _SSLSocket):
Giampaolo Rodola'3ff5e752013-03-07 14:03:27 +0100484 conn.unwrap()
Tim Peters88869f92001-01-14 23:36:06 +0000485 return self.voidresp()
Guido van Rossumc567c601992-11-05 22:22:37 +0000486
Antoine Pitrou648bcd72009-11-27 13:23:26 +0000487 def storbinary(self, cmd, fp, blocksize=8192, callback=None, rest=None):
Christian Heimes1af737c2008-01-23 08:24:23 +0000488 """Store a file in binary mode. A new port is created for you.
489
490 Args:
491 cmd: A STOR command.
492 fp: A file-like object with a read(num_bytes) method.
493 blocksize: The maximum data size to read from fp and send over
494 the connection at once. [default: 8192]
495 callback: An optional single parameter callable that is called on
Terry Jan Reedyc30b7b12013-03-11 17:57:08 -0400496 each block of data after it is sent. [default: None]
Antoine Pitrou648bcd72009-11-27 13:23:26 +0000497 rest: Passed to transfercmd(). [default: None]
Christian Heimes1af737c2008-01-23 08:24:23 +0000498
499 Returns:
500 The response code.
501 """
Tim Peters88869f92001-01-14 23:36:06 +0000502 self.voidcmd('TYPE I')
Benjamin Petersona8071372010-10-31 18:21:16 +0000503 with self.transfercmd(cmd, rest) as conn:
504 while 1:
505 buf = fp.read(blocksize)
Giampaolo Rodola'94c56a12013-03-07 13:51:20 +0100506 if not buf:
507 break
Benjamin Petersona8071372010-10-31 18:21:16 +0000508 conn.sendall(buf)
Giampaolo Rodola'94c56a12013-03-07 13:51:20 +0100509 if callback:
510 callback(buf)
Giampaolo Rodola'3ff5e752013-03-07 14:03:27 +0100511 # shutdown ssl layer
Giampaolo Rodola'a77d7a52013-03-18 09:59:15 +0100512 if _SSLSocket is not None and isinstance(conn, _SSLSocket):
Giampaolo Rodola'3ff5e752013-03-07 14:03:27 +0100513 conn.unwrap()
Tim Peters88869f92001-01-14 23:36:06 +0000514 return self.voidresp()
Guido van Rossumc567c601992-11-05 22:22:37 +0000515
Christian Heimes1af737c2008-01-23 08:24:23 +0000516 def storlines(self, cmd, fp, callback=None):
517 """Store a file in line mode. A new port is created for you.
518
519 Args:
520 cmd: A STOR command.
521 fp: A file-like object with a readline() method.
522 callback: An optional single parameter callable that is called on
Terry Jan Reedyc30b7b12013-03-11 17:57:08 -0400523 each line after it is sent. [default: None]
Christian Heimes1af737c2008-01-23 08:24:23 +0000524
525 Returns:
526 The response code.
527 """
Tim Peters88869f92001-01-14 23:36:06 +0000528 self.voidcmd('TYPE A')
Benjamin Petersona8071372010-10-31 18:21:16 +0000529 with self.transfercmd(cmd) as conn:
530 while 1:
Serhiy Storchakac30b1782013-10-20 16:58:27 +0300531 buf = fp.readline(self.maxline + 1)
532 if len(buf) > self.maxline:
533 raise Error("got more than %d bytes" % self.maxline)
Giampaolo Rodola'94c56a12013-03-07 13:51:20 +0100534 if not buf:
535 break
Benjamin Petersona8071372010-10-31 18:21:16 +0000536 if buf[-2:] != B_CRLF:
537 if buf[-1] in B_CRLF: buf = buf[:-1]
538 buf = buf + B_CRLF
539 conn.sendall(buf)
Giampaolo Rodola'94c56a12013-03-07 13:51:20 +0100540 if callback:
541 callback(buf)
Giampaolo Rodola'3ff5e752013-03-07 14:03:27 +0100542 # shutdown ssl layer
Giampaolo Rodola'a77d7a52013-03-18 09:59:15 +0100543 if _SSLSocket is not None and isinstance(conn, _SSLSocket):
Giampaolo Rodola'3ff5e752013-03-07 14:03:27 +0100544 conn.unwrap()
Tim Peters88869f92001-01-14 23:36:06 +0000545 return self.voidresp()
Guido van Rossum0eaa74b1996-01-25 18:37:21 +0000546
Tim Peters88869f92001-01-14 23:36:06 +0000547 def acct(self, password):
548 '''Send new account name.'''
549 cmd = 'ACCT ' + password
550 return self.voidcmd(cmd)
Guido van Rossumc567c601992-11-05 22:22:37 +0000551
Tim Peters88869f92001-01-14 23:36:06 +0000552 def nlst(self, *args):
553 '''Return a list of files in a given directory (default the current).'''
554 cmd = 'NLST'
555 for arg in args:
556 cmd = cmd + (' ' + arg)
557 files = []
558 self.retrlines(cmd, files.append)
559 return files
Guido van Rossumae3b3a31993-11-30 13:43:54 +0000560
Tim Peters88869f92001-01-14 23:36:06 +0000561 def dir(self, *args):
562 '''List a directory in long form.
563 By default list current directory to stdout.
564 Optional last argument is callback function; all
565 non-empty arguments before it are concatenated to the
566 LIST command. (This *should* only be used for a pathname.)'''
567 cmd = 'LIST'
568 func = None
569 if args[-1:] and type(args[-1]) != type(''):
570 args, func = args[:-1], args[-1]
571 for arg in args:
572 if arg:
573 cmd = cmd + (' ' + arg)
574 self.retrlines(cmd, func)
Guido van Rossumc567c601992-11-05 22:22:37 +0000575
Giampaolo Rodola'd78def92011-05-06 19:49:08 +0200576 def mlsd(self, path="", facts=[]):
577 '''List a directory in a standardized format by using MLSD
578 command (RFC-3659). If path is omitted the current directory
579 is assumed. "facts" is a list of strings representing the type
580 of information desired (e.g. ["type", "size", "perm"]).
581
582 Return a generator object yielding a tuple of two elements
583 for every file found in path.
584 First element is the file name, the second one is a dictionary
585 including a variable number of "facts" depending on the server
586 and whether "facts" argument has been provided.
587 '''
588 if facts:
589 self.sendcmd("OPTS MLST " + ";".join(facts) + ";")
590 if path:
591 cmd = "MLSD %s" % path
592 else:
593 cmd = "MLSD"
594 lines = []
595 self.retrlines(cmd, lines.append)
596 for line in lines:
597 facts_found, _, name = line.rstrip(CRLF).partition(' ')
598 entry = {}
599 for fact in facts_found[:-1].split(";"):
600 key, _, value = fact.partition("=")
601 entry[key.lower()] = value
602 yield (name, entry)
603
Tim Peters88869f92001-01-14 23:36:06 +0000604 def rename(self, fromname, toname):
605 '''Rename a file.'''
606 resp = self.sendcmd('RNFR ' + fromname)
607 if resp[0] != '3':
Collin Winterce36ad82007-08-30 01:19:48 +0000608 raise error_reply(resp)
Tim Peters88869f92001-01-14 23:36:06 +0000609 return self.voidcmd('RNTO ' + toname)
Guido van Rossuma61bdeb1995-10-11 17:36:31 +0000610
Tim Peters88869f92001-01-14 23:36:06 +0000611 def delete(self, filename):
612 '''Delete a file.'''
613 resp = self.sendcmd('DELE ' + filename)
Raymond Hettingerd5825cc2010-09-05 23:15:06 +0000614 if resp[:3] in {'250', '200'}:
Tim Peters88869f92001-01-14 23:36:06 +0000615 return resp
Tim Peters88869f92001-01-14 23:36:06 +0000616 else:
Collin Winterce36ad82007-08-30 01:19:48 +0000617 raise error_reply(resp)
Guido van Rossum02cf5821993-05-17 08:00:02 +0000618
Tim Peters88869f92001-01-14 23:36:06 +0000619 def cwd(self, dirname):
620 '''Change to a directory.'''
621 if dirname == '..':
622 try:
623 return self.voidcmd('CDUP')
Guido van Rossumb940e112007-01-10 16:19:56 +0000624 except error_perm as msg:
Martin v. Löwisb5255112002-03-10 15:59:58 +0000625 if msg.args[0][:3] != '500':
626 raise
Tim Peters88869f92001-01-14 23:36:06 +0000627 elif dirname == '':
628 dirname = '.' # does nothing, but could return error
629 cmd = 'CWD ' + dirname
630 return self.voidcmd(cmd)
Guido van Rossum17ed1ae1993-06-01 13:21:04 +0000631
Tim Peters88869f92001-01-14 23:36:06 +0000632 def size(self, filename):
633 '''Retrieve the size of a file.'''
Christian Heimes1af737c2008-01-23 08:24:23 +0000634 # The SIZE command is defined in RFC-3659
Tim Peters88869f92001-01-14 23:36:06 +0000635 resp = self.sendcmd('SIZE ' + filename)
636 if resp[:3] == '213':
Guido van Rossumb6aca6a2001-10-16 19:45:52 +0000637 s = resp[3:].strip()
Florent Xicluna2bb96f52011-10-23 22:11:00 +0200638 return int(s)
Guido van Rossumc567c601992-11-05 22:22:37 +0000639
Tim Peters88869f92001-01-14 23:36:06 +0000640 def mkd(self, dirname):
641 '''Make a directory, return its full pathname.'''
Giampaolo Rodolàbbc47822010-08-23 22:10:32 +0000642 resp = self.voidcmd('MKD ' + dirname)
643 # fix around non-compliant implementations such as IIS shipped
644 # with Windows server 2003
645 if not resp.startswith('257'):
646 return ''
Tim Peters88869f92001-01-14 23:36:06 +0000647 return parse257(resp)
Guido van Rossum98245091998-02-19 21:15:44 +0000648
Tim Peters88869f92001-01-14 23:36:06 +0000649 def rmd(self, dirname):
650 '''Remove a directory.'''
651 return self.voidcmd('RMD ' + dirname)
Guido van Rossum1115ab21992-11-04 15:51:30 +0000652
Tim Peters88869f92001-01-14 23:36:06 +0000653 def pwd(self):
654 '''Return current working directory.'''
Giampaolo Rodolàbbc47822010-08-23 22:10:32 +0000655 resp = self.voidcmd('PWD')
656 # fix around non-compliant implementations such as IIS shipped
657 # with Windows server 2003
658 if not resp.startswith('257'):
659 return ''
Tim Peters88869f92001-01-14 23:36:06 +0000660 return parse257(resp)
Guido van Rossum17ed1ae1993-06-01 13:21:04 +0000661
Tim Peters88869f92001-01-14 23:36:06 +0000662 def quit(self):
663 '''Quit, and close the connection.'''
664 resp = self.voidcmd('QUIT')
665 self.close()
666 return resp
667
668 def close(self):
669 '''Close the connection without assuming anything about it.'''
Serhiy Storchaka7e7a3db2015-04-10 13:24:41 +0300670 try:
671 file = self.file
672 self.file = None
673 if file is not None:
674 file.close()
675 finally:
676 sock = self.sock
677 self.sock = None
678 if sock is not None:
679 sock.close()
Guido van Rossumc567c601992-11-05 22:22:37 +0000680
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000681try:
682 import ssl
Brett Cannoncd171c82013-07-04 17:43:24 -0400683except ImportError:
Giampaolo Rodola'3ff5e752013-03-07 14:03:27 +0100684 _SSLSocket = None
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000685else:
Giampaolo Rodola'3ff5e752013-03-07 14:03:27 +0100686 _SSLSocket = ssl.SSLSocket
687
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000688 class FTP_TLS(FTP):
689 '''A FTP subclass which adds TLS support to FTP as described
690 in RFC-4217.
691
692 Connect as usual to port 21 implicitly securing the FTP control
693 connection before authenticating.
694
695 Securing the data connection requires user to explicitly ask
696 for it by calling prot_p() method.
697
698 Usage example:
699 >>> from ftplib import FTP_TLS
700 >>> ftps = FTP_TLS('ftp.python.org')
Ezio Melotti4969f702011-03-15 05:59:46 +0200701 >>> ftps.login() # login anonymously previously securing control channel
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000702 '230 Guest login ok, access restrictions apply.'
703 >>> ftps.prot_p() # switch to secure data connection
704 '200 Protection level set to P'
705 >>> ftps.retrlines('LIST') # list directory content securely
706 total 9
707 drwxr-xr-x 8 root wheel 1024 Jan 3 1994 .
708 drwxr-xr-x 8 root wheel 1024 Jan 3 1994 ..
709 drwxr-xr-x 2 root wheel 1024 Jan 3 1994 bin
710 drwxr-xr-x 2 root wheel 1024 Jan 3 1994 etc
711 d-wxrwxr-x 2 ftp wheel 1024 Sep 5 13:43 incoming
712 drwxr-xr-x 2 root wheel 1024 Nov 17 1993 lib
713 drwxr-xr-x 6 1094 wheel 1024 Sep 13 19:07 pub
714 drwxr-xr-x 3 root wheel 1024 Jan 3 1994 usr
715 -rw-r--r-- 1 root root 312 Aug 1 1994 welcome.msg
716 '226 Transfer complete.'
717 >>> ftps.quit()
718 '221 Goodbye.'
719 >>>
720 '''
Benjamin Peterson36fe7922014-12-30 15:15:43 -0600721 ssl_version = ssl.PROTOCOL_SSLv23
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000722
723 def __init__(self, host='', user='', passwd='', acct='', keyfile=None,
Giampaolo Rodolàa67299e2010-05-26 18:06:04 +0000724 certfile=None, context=None,
Giampaolo Rodolà396ff062011-02-28 19:19:51 +0000725 timeout=_GLOBAL_DEFAULT_TIMEOUT, source_address=None):
Giampaolo Rodolàa67299e2010-05-26 18:06:04 +0000726 if context is not None and keyfile is not None:
727 raise ValueError("context and keyfile arguments are mutually "
728 "exclusive")
729 if context is not None and certfile is not None:
730 raise ValueError("context and certfile arguments are mutually "
731 "exclusive")
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000732 self.keyfile = keyfile
733 self.certfile = certfile
Christian Heimes67986f92013-11-23 22:43:47 +0100734 if context is None:
735 context = ssl._create_stdlib_context(self.ssl_version,
736 certfile=certfile,
737 keyfile=keyfile)
Giampaolo Rodolàa67299e2010-05-26 18:06:04 +0000738 self.context = context
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000739 self._prot_p = False
Giampaolo Rodolà396ff062011-02-28 19:19:51 +0000740 FTP.__init__(self, host, user, passwd, acct, timeout, source_address)
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000741
742 def login(self, user='', passwd='', acct='', secure=True):
743 if secure and not isinstance(self.sock, ssl.SSLSocket):
744 self.auth()
745 return FTP.login(self, user, passwd, acct)
746
747 def auth(self):
748 '''Set up secure control connection by using TLS/SSL.'''
749 if isinstance(self.sock, ssl.SSLSocket):
750 raise ValueError("Already using TLS")
Benjamin Peterson36fe7922014-12-30 15:15:43 -0600751 if self.ssl_version >= ssl.PROTOCOL_SSLv23:
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000752 resp = self.voidcmd('AUTH TLS')
753 else:
754 resp = self.voidcmd('AUTH SSL')
Christian Heimese5b5edf2013-12-02 02:56:02 +0100755 self.sock = self.context.wrap_socket(self.sock,
Benjamin Peterson7243b572014-11-23 17:04:34 -0600756 server_hostname=self.host)
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000757 self.file = self.sock.makefile(mode='r', encoding=self.encoding)
758 return resp
759
Giampaolo Rodola'096dcb12011-06-27 11:17:51 +0200760 def ccc(self):
761 '''Switch back to a clear-text control connection.'''
762 if not isinstance(self.sock, ssl.SSLSocket):
763 raise ValueError("not using TLS")
764 resp = self.voidcmd('CCC')
765 self.sock = self.sock.unwrap()
766 return resp
767
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000768 def prot_p(self):
769 '''Set up secure data connection.'''
770 # PROT defines whether or not the data channel is to be protected.
771 # Though RFC-2228 defines four possible protection levels,
772 # RFC-4217 only recommends two, Clear and Private.
773 # Clear (PROT C) means that no security is to be used on the
774 # data-channel, Private (PROT P) means that the data-channel
775 # should be protected by TLS.
776 # PBSZ command MUST still be issued, but must have a parameter of
777 # '0' to indicate that no buffering is taking place and the data
778 # connection should not be encapsulated.
779 self.voidcmd('PBSZ 0')
780 resp = self.voidcmd('PROT P')
781 self._prot_p = True
782 return resp
783
784 def prot_c(self):
785 '''Set up clear text data connection.'''
786 resp = self.voidcmd('PROT C')
787 self._prot_p = False
788 return resp
789
790 # --- Overridden FTP methods
791
792 def ntransfercmd(self, cmd, rest=None):
793 conn, size = FTP.ntransfercmd(self, cmd, rest)
794 if self._prot_p:
Christian Heimese5b5edf2013-12-02 02:56:02 +0100795 conn = self.context.wrap_socket(conn,
Benjamin Peterson7243b572014-11-23 17:04:34 -0600796 server_hostname=self.host)
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000797 return conn, size
798
Giampaolo Rodola'24befa82011-05-07 19:09:34 +0200799 def abort(self):
800 # overridden as we can't pass MSG_OOB flag to sendall()
801 line = b'ABOR' + B_CRLF
802 self.sock.sendall(line)
803 resp = self.getmultiline()
804 if resp[:3] not in {'426', '225', '226'}:
805 raise error_proto(resp)
806 return resp
807
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000808 __all__.append('FTP_TLS')
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200809 all_errors = (Error, OSError, EOFError, ssl.SSLError)
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000810
811
Guido van Rossumacfb82a1997-10-22 20:49:52 +0000812_150_re = None
Fred Drake4de02d91997-01-10 18:26:09 +0000813
814def parse150(resp):
Tim Peters88869f92001-01-14 23:36:06 +0000815 '''Parse the '150' response for a RETR request.
816 Returns the expected transfer size or None; size is not guaranteed to
817 be present in the 150 message.
818 '''
819 if resp[:3] != '150':
Collin Winterce36ad82007-08-30 01:19:48 +0000820 raise error_reply(resp)
Tim Peters88869f92001-01-14 23:36:06 +0000821 global _150_re
822 if _150_re is None:
823 import re
Antoine Pitroufd036452008-08-19 17:56:33 +0000824 _150_re = re.compile(
825 "150 .* \((\d+) bytes\)", re.IGNORECASE | re.ASCII)
Tim Peters88869f92001-01-14 23:36:06 +0000826 m = _150_re.match(resp)
Guido van Rossumb6aca6a2001-10-16 19:45:52 +0000827 if not m:
828 return None
Florent Xicluna2bb96f52011-10-23 22:11:00 +0200829 return int(m.group(1))
Fred Drake4de02d91997-01-10 18:26:09 +0000830
831
Guido van Rossum70297d32001-08-17 17:24:29 +0000832_227_re = None
833
Guido van Rossumd2560b01996-05-28 23:41:25 +0000834def parse227(resp):
Tim Peters88869f92001-01-14 23:36:06 +0000835 '''Parse the '227' response for a PASV request.
836 Raises error_proto if it does not contain '(h1,h2,h3,h4,p1,p2)'
837 Return ('host.addr.as.numbers', port#) tuple.'''
Guido van Rossumd2560b01996-05-28 23:41:25 +0000838
Tim Peters88869f92001-01-14 23:36:06 +0000839 if resp[:3] != '227':
Collin Winterce36ad82007-08-30 01:19:48 +0000840 raise error_reply(resp)
Guido van Rossum70297d32001-08-17 17:24:29 +0000841 global _227_re
842 if _227_re is None:
843 import re
Antoine Pitroufd036452008-08-19 17:56:33 +0000844 _227_re = re.compile(r'(\d+),(\d+),(\d+),(\d+),(\d+),(\d+)', re.ASCII)
Guido van Rossum70297d32001-08-17 17:24:29 +0000845 m = _227_re.search(resp)
846 if not m:
Collin Winterce36ad82007-08-30 01:19:48 +0000847 raise error_proto(resp)
Guido van Rossum70297d32001-08-17 17:24:29 +0000848 numbers = m.groups()
Eric S. Raymondc95bf692001-02-09 10:06:47 +0000849 host = '.'.join(numbers[:4])
850 port = (int(numbers[4]) << 8) + int(numbers[5])
Tim Peters88869f92001-01-14 23:36:06 +0000851 return host, port
Guido van Rossumd2560b01996-05-28 23:41:25 +0000852
853
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000854def parse229(resp, peer):
Martin Panter7462b6492015-11-02 03:37:02 +0000855 '''Parse the '229' response for an EPSV request.
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000856 Raises error_proto if it does not contain '(|||port|)'
857 Return ('host.addr.as.numbers', port#) tuple.'''
858
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000859 if resp[:3] != '229':
Collin Winterce36ad82007-08-30 01:19:48 +0000860 raise error_reply(resp)
Neal Norwitz7ce734c2002-05-31 14:13:04 +0000861 left = resp.find('(')
Collin Winterce36ad82007-08-30 01:19:48 +0000862 if left < 0: raise error_proto(resp)
Neal Norwitz7ce734c2002-05-31 14:13:04 +0000863 right = resp.find(')', left + 1)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000864 if right < 0:
Collin Winterce36ad82007-08-30 01:19:48 +0000865 raise error_proto(resp) # should contain '(|||port|)'
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000866 if resp[left + 1] != resp[right - 1]:
Collin Winterce36ad82007-08-30 01:19:48 +0000867 raise error_proto(resp)
Walter Dörwalda401ae42002-06-03 10:41:45 +0000868 parts = resp[left + 1:right].split(resp[left+1])
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000869 if len(parts) != 5:
Collin Winterce36ad82007-08-30 01:19:48 +0000870 raise error_proto(resp)
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000871 host = peer[0]
Neal Norwitz7ce734c2002-05-31 14:13:04 +0000872 port = int(parts[3])
Martin v. Löwisa43c2f82001-07-24 20:34:08 +0000873 return host, port
874
875
Guido van Rossumc567c601992-11-05 22:22:37 +0000876def parse257(resp):
Tim Peters88869f92001-01-14 23:36:06 +0000877 '''Parse the '257' response for a MKD or PWD request.
878 This is a response to a MKD or PWD request: a directory name.
879 Returns the directoryname in the 257 reply.'''
Guido van Rossumd2560b01996-05-28 23:41:25 +0000880
Tim Peters88869f92001-01-14 23:36:06 +0000881 if resp[:3] != '257':
Collin Winterce36ad82007-08-30 01:19:48 +0000882 raise error_reply(resp)
Tim Peters88869f92001-01-14 23:36:06 +0000883 if resp[3:5] != ' "':
884 return '' # Not compliant to RFC 959, but UNIX ftpd does this
885 dirname = ''
886 i = 5
887 n = len(resp)
888 while i < n:
889 c = resp[i]
890 i = i+1
891 if c == '"':
892 if i >= n or resp[i] != '"':
893 break
894 i = i+1
895 dirname = dirname + c
896 return dirname
Guido van Rossum1115ab21992-11-04 15:51:30 +0000897
Guido van Rossum2f3941d1997-10-07 14:49:56 +0000898
Guido van Rossumae3b3a31993-11-30 13:43:54 +0000899def print_line(line):
Tim Peters88869f92001-01-14 23:36:06 +0000900 '''Default retrlines callback to print a line.'''
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000901 print(line)
Guido van Rossumae3b3a31993-11-30 13:43:54 +0000902
Guido van Rossum2f3941d1997-10-07 14:49:56 +0000903
Guido van Rossumd2560b01996-05-28 23:41:25 +0000904def ftpcp(source, sourcename, target, targetname = '', type = 'I'):
Tim Peters88869f92001-01-14 23:36:06 +0000905 '''Copy file from one FTP-instance to another.'''
Giampaolo Rodola'94c56a12013-03-07 13:51:20 +0100906 if not targetname:
907 targetname = sourcename
Tim Peters88869f92001-01-14 23:36:06 +0000908 type = 'TYPE ' + type
909 source.voidcmd(type)
910 target.voidcmd(type)
911 sourcehost, sourceport = parse227(source.sendcmd('PASV'))
912 target.sendport(sourcehost, sourceport)
913 # RFC 959: the user must "listen" [...] BEFORE sending the
914 # transfer request.
915 # So: STOR before RETR, because here the target is a "user".
916 treply = target.sendcmd('STOR ' + targetname)
Giampaolo Rodola'94c56a12013-03-07 13:51:20 +0100917 if treply[:3] not in {'125', '150'}:
918 raise error_proto # RFC 959
Tim Peters88869f92001-01-14 23:36:06 +0000919 sreply = source.sendcmd('RETR ' + sourcename)
Giampaolo Rodola'94c56a12013-03-07 13:51:20 +0100920 if sreply[:3] not in {'125', '150'}:
921 raise error_proto # RFC 959
Tim Peters88869f92001-01-14 23:36:06 +0000922 source.voidresp()
923 target.voidresp()
Guido van Rossum1115ab21992-11-04 15:51:30 +0000924
Tim Peters88869f92001-01-14 23:36:06 +0000925
Guido van Rossum1115ab21992-11-04 15:51:30 +0000926def test():
Tim Peters88869f92001-01-14 23:36:06 +0000927 '''Test program.
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000928 Usage: ftp [-d] [-r[file]] host [-l[dir]] [-d[dir]] [-p] [file] ...
929
930 -d dir
931 -l list
932 -p password
933 '''
934
935 if len(sys.argv) < 2:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000936 print(test.__doc__)
Raymond Hettingerc88a6c72005-04-05 04:31:09 +0000937 sys.exit(0)
Guido van Rossumd2560b01996-05-28 23:41:25 +0000938
Berker Peksag8f791d32014-11-01 10:45:57 +0200939 import netrc
940
Tim Peters88869f92001-01-14 23:36:06 +0000941 debugging = 0
942 rcfile = None
943 while sys.argv[1] == '-d':
944 debugging = debugging+1
945 del sys.argv[1]
946 if sys.argv[1][:2] == '-r':
947 # get name of alternate ~/.netrc file:
948 rcfile = sys.argv[1][2:]
949 del sys.argv[1]
950 host = sys.argv[1]
951 ftp = FTP(host)
952 ftp.set_debuglevel(debugging)
953 userid = passwd = acct = ''
954 try:
Berker Peksag8f791d32014-11-01 10:45:57 +0200955 netrcobj = netrc.netrc(rcfile)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200956 except OSError:
Tim Peters88869f92001-01-14 23:36:06 +0000957 if rcfile is not None:
958 sys.stderr.write("Could not open account file"
959 " -- using anonymous login.")
960 else:
961 try:
Berker Peksag8f791d32014-11-01 10:45:57 +0200962 userid, acct, passwd = netrcobj.authenticators(host)
Tim Peters88869f92001-01-14 23:36:06 +0000963 except KeyError:
964 # no account for host
965 sys.stderr.write(
966 "No account -- using anonymous login.")
967 ftp.login(userid, passwd, acct)
968 for file in sys.argv[2:]:
969 if file[:2] == '-l':
970 ftp.dir(file[2:])
971 elif file[:2] == '-d':
972 cmd = 'CWD'
973 if file[2:]: cmd = cmd + ' ' + file[2:]
974 resp = ftp.sendcmd(cmd)
975 elif file == '-p':
976 ftp.set_pasv(not ftp.passiveserver)
977 else:
978 ftp.retrbinary('RETR ' + file, \
979 sys.stdout.write, 1024)
980 ftp.quit()
Guido van Rossum221ec0b1995-08-04 04:39:30 +0000981
982
983if __name__ == '__main__':
Tim Peters88869f92001-01-14 23:36:06 +0000984 test()