Guido van Rossum | 4b8c6ea | 2000-02-04 15:39:30 +0000 | [diff] [blame] | 1 | """An FTP client class and some helper functions. |
| 2 | |
Barry Warsaw | 100d81e | 2000-09-01 06:09:23 +0000 | [diff] [blame] | 3 | Based on RFC 959: File Transfer Protocol (FTP), by J. Postel and J. Reynolds |
Guido van Rossum | 1115ab2 | 1992-11-04 15:51:30 +0000 | [diff] [blame] | 4 | |
Guido van Rossum | d2560b0 | 1996-05-28 23:41:25 +0000 | [diff] [blame] | 5 | Example: |
| 6 | |
| 7 | >>> from ftplib import FTP |
| 8 | >>> ftp = FTP('ftp.python.org') # connect to host, default port |
Guido van Rossum | 24a6434 | 2001-12-28 20:54:55 +0000 | [diff] [blame] | 9 | >>> ftp.login() # default, i.e.: user anonymous, passwd anonymous@ |
Guido van Rossum | 2f3941d | 1997-10-07 14:49:56 +0000 | [diff] [blame] | 10 | '230 Guest login ok, access restrictions apply.' |
Guido van Rossum | d2560b0 | 1996-05-28 23:41:25 +0000 | [diff] [blame] | 11 | >>> ftp.retrlines('LIST') # list directory contents |
| 12 | total 9 |
| 13 | drwxr-xr-x 8 root wheel 1024 Jan 3 1994 . |
| 14 | drwxr-xr-x 8 root wheel 1024 Jan 3 1994 .. |
| 15 | drwxr-xr-x 2 root wheel 1024 Jan 3 1994 bin |
| 16 | drwxr-xr-x 2 root wheel 1024 Jan 3 1994 etc |
| 17 | d-wxrwxr-x 2 ftp wheel 1024 Sep 5 13:43 incoming |
| 18 | drwxr-xr-x 2 root wheel 1024 Nov 17 1993 lib |
| 19 | drwxr-xr-x 6 1094 wheel 1024 Sep 13 19:07 pub |
| 20 | drwxr-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 Rossum | 2f3941d | 1997-10-07 14:49:56 +0000 | [diff] [blame] | 22 | '226 Transfer complete.' |
Guido van Rossum | d2560b0 | 1996-05-28 23:41:25 +0000 | [diff] [blame] | 23 | >>> ftp.quit() |
Guido van Rossum | 2f3941d | 1997-10-07 14:49:56 +0000 | [diff] [blame] | 24 | '221 Goodbye.' |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 25 | >>> |
Guido van Rossum | d2560b0 | 1996-05-28 23:41:25 +0000 | [diff] [blame] | 26 | |
| 27 | A nice test that reveals some of the network dialogue would be: |
| 28 | python ftplib.py -d localhost -l -p -l |
Guido van Rossum | 4b8c6ea | 2000-02-04 15:39:30 +0000 | [diff] [blame] | 29 | """ |
Guido van Rossum | c567c60 | 1992-11-05 22:22:37 +0000 | [diff] [blame] | 30 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 31 | # |
Guido van Rossum | 98d9fd3 | 2000-02-28 15:12:25 +0000 | [diff] [blame] | 32 | # 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 Heimes | 1af737c | 2008-01-23 08:24:23 +0000 | [diff] [blame] | 35 | # Modified by Phil Schwartz to add storbinary and storlines callbacks. |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 36 | # Modified by Giampaolo Rodola' to add TLS support. |
Guido van Rossum | 98d9fd3 | 2000-02-28 15:12:25 +0000 | [diff] [blame] | 37 | # |
Guido van Rossum | c567c60 | 1992-11-05 22:22:37 +0000 | [diff] [blame] | 38 | |
Guido van Rossum | 1115ab2 | 1992-11-04 15:51:30 +0000 | [diff] [blame] | 39 | import os |
| 40 | import sys |
Giampaolo RodolĂ | 6545ed6 | 2010-08-21 20:34:37 +0000 | [diff] [blame] | 41 | import socket |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 42 | from socket import _GLOBAL_DEFAULT_TIMEOUT |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 43 | |
Skip Montanaro | eccd02a | 2001-01-20 23:34:12 +0000 | [diff] [blame] | 44 | __all__ = ["FTP","Netrc"] |
Guido van Rossum | 1115ab2 | 1992-11-04 15:51:30 +0000 | [diff] [blame] | 45 | |
Guido van Rossum | d316607 | 1993-05-24 14:16:22 +0000 | [diff] [blame] | 46 | # Magic number from <socket.h> |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 47 | MSG_OOB = 0x1 # Process data out of band |
Guido van Rossum | d316607 | 1993-05-24 14:16:22 +0000 | [diff] [blame] | 48 | |
| 49 | |
Guido van Rossum | c567c60 | 1992-11-05 22:22:37 +0000 | [diff] [blame] | 50 | # The standard FTP server control port |
Guido van Rossum | 1115ab2 | 1992-11-04 15:51:30 +0000 | [diff] [blame] | 51 | FTP_PORT = 21 |
Guido van Rossum | 1115ab2 | 1992-11-04 15:51:30 +0000 | [diff] [blame] | 52 | |
| 53 | |
Guido van Rossum | 2197479 | 1992-11-06 13:34:17 +0000 | [diff] [blame] | 54 | # Exception raised when an error or invalid response is received |
Fred Drake | 227b120 | 2000-08-17 05:06:49 +0000 | [diff] [blame] | 55 | class Error(Exception): pass |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 56 | class error_reply(Error): pass # unexpected [123]xx reply |
| 57 | class error_temp(Error): pass # 4xx errors |
| 58 | class error_perm(Error): pass # 5xx errors |
| 59 | class error_proto(Error): pass # response does not begin with [1-5] |
Guido van Rossum | 1115ab2 | 1992-11-04 15:51:30 +0000 | [diff] [blame] | 60 | |
| 61 | |
Guido van Rossum | 2197479 | 1992-11-06 13:34:17 +0000 | [diff] [blame] | 62 | # All exceptions (hopefully) that may be raised here and that aren't |
| 63 | # (always) programming errors on our side |
Christian Heimes | 33fe809 | 2008-04-13 13:53:33 +0000 | [diff] [blame] | 64 | all_errors = (Error, IOError, EOFError) |
Guido van Rossum | 2197479 | 1992-11-06 13:34:17 +0000 | [diff] [blame] | 65 | |
| 66 | |
Guido van Rossum | 1115ab2 | 1992-11-04 15:51:30 +0000 | [diff] [blame] | 67 | # Line terminators (we always output CRLF, but accept any of CRLF, CR, LF) |
| 68 | CRLF = '\r\n' |
Benjamin Peterson | be17a11 | 2008-09-27 21:49:47 +0000 | [diff] [blame] | 69 | B_CRLF = b'\r\n' |
Guido van Rossum | 1115ab2 | 1992-11-04 15:51:30 +0000 | [diff] [blame] | 70 | |
Guido van Rossum | 1115ab2 | 1992-11-04 15:51:30 +0000 | [diff] [blame] | 71 | # The class itself |
| 72 | class FTP: |
| 73 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 74 | '''An FTP client class. |
Guido van Rossum | d2560b0 | 1996-05-28 23:41:25 +0000 | [diff] [blame] | 75 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 76 | To create a connection, call the class using these arguments: |
| 77 | host, user, passwd, acct, timeout |
| 78 | |
| 79 | The first four arguments are all strings, and have default value ''. |
| 80 | timeout must be numeric and defaults to None if not passed, |
| 81 | meaning that no timeout will be set on any ftp socket(s) |
| 82 | If a timeout is passed, then this is now the default timeout for all ftp |
| 83 | socket operations for this instance. |
| 84 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 85 | Then use self.connect() with optional host and port argument. |
Guido van Rossum | d2560b0 | 1996-05-28 23:41:25 +0000 | [diff] [blame] | 86 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 87 | To download a file, use ftp.retrlines('RETR ' + filename), |
| 88 | or ftp.retrbinary() with slightly different arguments. |
| 89 | To upload a file, use ftp.storlines() or ftp.storbinary(), |
| 90 | which have an open file as argument (see their definitions |
| 91 | below for details). |
| 92 | The download/upload functions first issue appropriate TYPE |
| 93 | and PORT or PASV commands. |
Guido van Rossum | 52b8976 | 2007-07-17 20:45:57 +0000 | [diff] [blame] | 94 | ''' |
Guido van Rossum | d2560b0 | 1996-05-28 23:41:25 +0000 | [diff] [blame] | 95 | |
Fred Drake | 9c98a42 | 2001-02-28 21:46:37 +0000 | [diff] [blame] | 96 | debugging = 0 |
| 97 | host = '' |
| 98 | port = FTP_PORT |
| 99 | sock = None |
| 100 | file = None |
| 101 | welcome = None |
| 102 | passiveserver = 1 |
Brett Cannon | 6733d70 | 2007-10-08 19:48:15 +0000 | [diff] [blame] | 103 | encoding = "latin1" |
Fred Drake | 9c98a42 | 2001-02-28 21:46:37 +0000 | [diff] [blame] | 104 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 105 | # Initialization method (called by class instantiation). |
| 106 | # Initialize host to localhost, port to standard ftp port |
| 107 | # Optional arguments are host (for connect()), |
| 108 | # and user, passwd, acct (for login()) |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 109 | def __init__(self, host='', user='', passwd='', acct='', |
| 110 | timeout=_GLOBAL_DEFAULT_TIMEOUT): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 111 | self.timeout = timeout |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 112 | if host: |
Fred Drake | 9c98a42 | 2001-02-28 21:46:37 +0000 | [diff] [blame] | 113 | self.connect(host) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 114 | if user: |
| 115 | self.login(user, passwd, acct) |
Guido van Rossum | 52fc1f6 | 1993-06-17 12:38:10 +0000 | [diff] [blame] | 116 | |
Giampaolo RodolĂ | bd576b7 | 2010-05-10 14:53:29 +0000 | [diff] [blame] | 117 | def __enter__(self): |
| 118 | return self |
| 119 | |
| 120 | # Context management protocol: try to quit() if active |
| 121 | def __exit__(self, *args): |
| 122 | if self.sock is not None: |
| 123 | try: |
| 124 | self.quit() |
| 125 | except (socket.error, EOFError): |
| 126 | pass |
| 127 | finally: |
| 128 | if self.sock is not None: |
| 129 | self.close() |
| 130 | |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 131 | def connect(self, host='', port=0, timeout=-999): |
Martin v. Löwis | 4eb5940 | 2001-07-26 13:37:33 +0000 | [diff] [blame] | 132 | '''Connect to host. Arguments are: |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 133 | - host: hostname to connect to (string, default previous host) |
| 134 | - port: port to connect to (integer, default previous port) |
| 135 | ''' |
| 136 | if host != '': |
| 137 | self.host = host |
| 138 | if port > 0: |
| 139 | self.port = port |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 140 | if timeout != -999: |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 141 | self.timeout = timeout |
| 142 | self.sock = socket.create_connection((self.host, self.port), self.timeout) |
| 143 | self.af = self.sock.family |
Guido van Rossum | 52b8976 | 2007-07-17 20:45:57 +0000 | [diff] [blame] | 144 | self.file = self.sock.makefile('r', encoding=self.encoding) |
Martin v. Löwis | 4eb5940 | 2001-07-26 13:37:33 +0000 | [diff] [blame] | 145 | self.welcome = self.getresp() |
| 146 | return self.welcome |
Guido van Rossum | 1115ab2 | 1992-11-04 15:51:30 +0000 | [diff] [blame] | 147 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 148 | def getwelcome(self): |
| 149 | '''Get the welcome message from the server. |
| 150 | (this is read and squirreled away by connect())''' |
| 151 | if self.debugging: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 152 | print('*welcome*', self.sanitize(self.welcome)) |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 153 | return self.welcome |
Guido van Rossum | 1115ab2 | 1992-11-04 15:51:30 +0000 | [diff] [blame] | 154 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 155 | def set_debuglevel(self, level): |
| 156 | '''Set the debugging level. |
| 157 | The required argument level means: |
| 158 | 0: no debugging output (default) |
| 159 | 1: print commands and responses but not body text etc. |
| 160 | 2: also print raw lines read and sent before stripping CR/LF''' |
| 161 | self.debugging = level |
| 162 | debug = set_debuglevel |
Guido van Rossum | 1115ab2 | 1992-11-04 15:51:30 +0000 | [diff] [blame] | 163 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 164 | def set_pasv(self, val): |
| 165 | '''Use passive or active mode for data transfers. |
| 166 | With a false argument, use the normal PORT mode, |
| 167 | With a true argument, use the PASV command.''' |
| 168 | self.passiveserver = val |
Guido van Rossum | d2560b0 | 1996-05-28 23:41:25 +0000 | [diff] [blame] | 169 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 170 | # Internal: "sanitize" a string for printing |
| 171 | def sanitize(self, s): |
| 172 | if s[:5] == 'pass ' or s[:5] == 'PASS ': |
| 173 | i = len(s) |
Raymond Hettinger | d5825cc | 2010-09-05 23:15:06 +0000 | [diff] [blame] | 174 | while i > 5 and s[i-1] in {'\r', '\n'}: |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 175 | i = i-1 |
| 176 | s = s[:5] + '*'*(i-5) + s[i:] |
Walter Dörwald | 70a6b49 | 2004-02-12 17:35:32 +0000 | [diff] [blame] | 177 | return repr(s) |
Guido van Rossum | ebaf104 | 1995-05-05 15:54:14 +0000 | [diff] [blame] | 178 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 179 | # Internal: send one line to the server, appending CRLF |
| 180 | def putline(self, line): |
| 181 | line = line + CRLF |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 182 | if self.debugging > 1: print('*put*', self.sanitize(line)) |
Guido van Rossum | 52b8976 | 2007-07-17 20:45:57 +0000 | [diff] [blame] | 183 | self.sock.sendall(line.encode(self.encoding)) |
Guido van Rossum | 1115ab2 | 1992-11-04 15:51:30 +0000 | [diff] [blame] | 184 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 185 | # Internal: send one command to the server (through putline()) |
| 186 | def putcmd(self, line): |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 187 | if self.debugging: print('*cmd*', self.sanitize(line)) |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 188 | self.putline(line) |
Guido van Rossum | 1115ab2 | 1992-11-04 15:51:30 +0000 | [diff] [blame] | 189 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 190 | # Internal: return one line from the server, stripping CRLF. |
| 191 | # Raise EOFError if the connection is closed |
| 192 | def getline(self): |
| 193 | line = self.file.readline() |
| 194 | if self.debugging > 1: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 195 | print('*get*', self.sanitize(line)) |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 196 | if not line: raise EOFError |
| 197 | if line[-2:] == CRLF: line = line[:-2] |
| 198 | elif line[-1:] in CRLF: line = line[:-1] |
| 199 | return line |
Guido van Rossum | 1115ab2 | 1992-11-04 15:51:30 +0000 | [diff] [blame] | 200 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 201 | # Internal: get a response from the server, which may possibly |
| 202 | # consist of multiple lines. Return a single string with no |
| 203 | # trailing CRLF. If the response consists of multiple lines, |
| 204 | # these are separated by '\n' characters in the string |
| 205 | def getmultiline(self): |
| 206 | line = self.getline() |
| 207 | if line[3:4] == '-': |
| 208 | code = line[:3] |
| 209 | while 1: |
| 210 | nextline = self.getline() |
| 211 | line = line + ('\n' + nextline) |
| 212 | if nextline[:3] == code and \ |
| 213 | nextline[3:4] != '-': |
| 214 | break |
| 215 | return line |
Guido van Rossum | 1115ab2 | 1992-11-04 15:51:30 +0000 | [diff] [blame] | 216 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 217 | # Internal: get a response from the server. |
| 218 | # Raise various errors if the response indicates an error |
| 219 | def getresp(self): |
| 220 | resp = self.getmultiline() |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 221 | if self.debugging: print('*resp*', self.sanitize(resp)) |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 222 | self.lastresp = resp[:3] |
| 223 | c = resp[:1] |
Raymond Hettinger | d5825cc | 2010-09-05 23:15:06 +0000 | [diff] [blame] | 224 | if c in {'1', '2', '3'}: |
Raymond Hettinger | c88a6c7 | 2005-04-05 04:31:09 +0000 | [diff] [blame] | 225 | return resp |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 226 | if c == '4': |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 227 | raise error_temp(resp) |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 228 | if c == '5': |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 229 | raise error_perm(resp) |
| 230 | raise error_proto(resp) |
Guido van Rossum | 1115ab2 | 1992-11-04 15:51:30 +0000 | [diff] [blame] | 231 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 232 | def voidresp(self): |
| 233 | """Expect a response beginning with '2'.""" |
| 234 | resp = self.getresp() |
Benjamin Peterson | d23f822 | 2009-04-05 19:13:16 +0000 | [diff] [blame] | 235 | if resp[:1] != '2': |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 236 | raise error_reply(resp) |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 237 | return resp |
Guido van Rossum | c567c60 | 1992-11-05 22:22:37 +0000 | [diff] [blame] | 238 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 239 | def abort(self): |
| 240 | '''Abort a file transfer. Uses out-of-band data. |
| 241 | This does not follow the procedure from the RFC to send Telnet |
| 242 | IP and Synch; that doesn't seem to work with the servers I've |
| 243 | tried. Instead, just send the ABOR command as OOB data.''' |
Giampaolo Rodola' | 0b5c21f | 2011-05-07 19:03:47 +0200 | [diff] [blame] | 244 | line = b'ABOR' + B_CRLF |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 245 | if self.debugging > 1: print('*put urgent*', self.sanitize(line)) |
Martin v. Löwis | e12454f | 2002-02-16 23:06:19 +0000 | [diff] [blame] | 246 | self.sock.sendall(line, MSG_OOB) |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 247 | resp = self.getmultiline() |
Raymond Hettinger | d5825cc | 2010-09-05 23:15:06 +0000 | [diff] [blame] | 248 | if resp[:3] not in {'426', '225', '226'}: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 249 | raise error_proto(resp) |
Giampaolo Rodola' | 0b5c21f | 2011-05-07 19:03:47 +0200 | [diff] [blame] | 250 | return resp |
Guido van Rossum | d316607 | 1993-05-24 14:16:22 +0000 | [diff] [blame] | 251 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 252 | def sendcmd(self, cmd): |
| 253 | '''Send a command and return the response.''' |
| 254 | self.putcmd(cmd) |
| 255 | return self.getresp() |
Guido van Rossum | 1115ab2 | 1992-11-04 15:51:30 +0000 | [diff] [blame] | 256 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 257 | def voidcmd(self, cmd): |
| 258 | """Send a command and expect a response beginning with '2'.""" |
| 259 | self.putcmd(cmd) |
| 260 | return self.voidresp() |
Guido van Rossum | c567c60 | 1992-11-05 22:22:37 +0000 | [diff] [blame] | 261 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 262 | def sendport(self, host, port): |
| 263 | '''Send a PORT command with the current host and the given |
| 264 | port number. |
| 265 | ''' |
Eric S. Raymond | c95bf69 | 2001-02-09 10:06:47 +0000 | [diff] [blame] | 266 | hbytes = host.split('.') |
Benjamin Peterson | 3a53fbb | 2008-09-27 22:04:16 +0000 | [diff] [blame] | 267 | pbytes = [repr(port//256), repr(port%256)] |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 268 | bytes = hbytes + pbytes |
Eric S. Raymond | c95bf69 | 2001-02-09 10:06:47 +0000 | [diff] [blame] | 269 | cmd = 'PORT ' + ','.join(bytes) |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 270 | return self.voidcmd(cmd) |
Guido van Rossum | 1115ab2 | 1992-11-04 15:51:30 +0000 | [diff] [blame] | 271 | |
Martin v. Löwis | a43c2f8 | 2001-07-24 20:34:08 +0000 | [diff] [blame] | 272 | def sendeprt(self, host, port): |
Martin v. Löwis | 4eb5940 | 2001-07-26 13:37:33 +0000 | [diff] [blame] | 273 | '''Send a EPRT command with the current host and the given port number.''' |
| 274 | af = 0 |
| 275 | if self.af == socket.AF_INET: |
| 276 | af = 1 |
| 277 | if self.af == socket.AF_INET6: |
| 278 | af = 2 |
| 279 | if af == 0: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 280 | raise error_proto('unsupported address family') |
Walter Dörwald | 70a6b49 | 2004-02-12 17:35:32 +0000 | [diff] [blame] | 281 | fields = ['', repr(af), host, repr(port), ''] |
Neal Norwitz | 7ce734c | 2002-05-31 14:13:04 +0000 | [diff] [blame] | 282 | cmd = 'EPRT ' + '|'.join(fields) |
Martin v. Löwis | 4eb5940 | 2001-07-26 13:37:33 +0000 | [diff] [blame] | 283 | return self.voidcmd(cmd) |
Martin v. Löwis | a43c2f8 | 2001-07-24 20:34:08 +0000 | [diff] [blame] | 284 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 285 | def makeport(self): |
Martin v. Löwis | 4eb5940 | 2001-07-26 13:37:33 +0000 | [diff] [blame] | 286 | '''Create a new socket and send a PORT command for it.''' |
Giampaolo Rodola' | fc32788 | 2012-12-17 14:20:27 +0100 | [diff] [blame] | 287 | err = None |
Martin v. Löwis | 322c0d1 | 2001-10-07 08:53:32 +0000 | [diff] [blame] | 288 | sock = None |
Martin v. Löwis | 4eb5940 | 2001-07-26 13:37:33 +0000 | [diff] [blame] | 289 | for res in socket.getaddrinfo(None, 0, self.af, socket.SOCK_STREAM, 0, socket.AI_PASSIVE): |
| 290 | af, socktype, proto, canonname, sa = res |
| 291 | try: |
| 292 | sock = socket.socket(af, socktype, proto) |
| 293 | sock.bind(sa) |
Giampaolo Rodola' | 57f3487 | 2012-12-17 20:46:16 +0100 | [diff] [blame] | 294 | except socket.error as _: |
| 295 | err = _ |
Martin v. Löwis | 322c0d1 | 2001-10-07 08:53:32 +0000 | [diff] [blame] | 296 | if sock: |
| 297 | sock.close() |
Martin v. Löwis | 4eb5940 | 2001-07-26 13:37:33 +0000 | [diff] [blame] | 298 | sock = None |
| 299 | continue |
| 300 | break |
Giampaolo Rodola' | fc32788 | 2012-12-17 14:20:27 +0100 | [diff] [blame] | 301 | if sock is None: |
| 302 | if err is not None: |
| 303 | raise err |
| 304 | else: |
| 305 | raise socket.error("getaddrinfo returns an empty list") |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 306 | raise socket.error(msg) |
Martin v. Löwis | 4eb5940 | 2001-07-26 13:37:33 +0000 | [diff] [blame] | 307 | sock.listen(1) |
| 308 | port = sock.getsockname()[1] # Get proper port |
| 309 | host = self.sock.getsockname()[0] # Get proper host |
| 310 | if self.af == socket.AF_INET: |
| 311 | resp = self.sendport(host, port) |
| 312 | else: |
| 313 | resp = self.sendeprt(host, port) |
Giampaolo RodolĂ | 5fb313b | 2010-04-19 22:05:54 +0000 | [diff] [blame] | 314 | if self.timeout is not _GLOBAL_DEFAULT_TIMEOUT: |
| 315 | sock.settimeout(self.timeout) |
Martin v. Löwis | 4eb5940 | 2001-07-26 13:37:33 +0000 | [diff] [blame] | 316 | return sock |
Martin v. Löwis | a43c2f8 | 2001-07-24 20:34:08 +0000 | [diff] [blame] | 317 | |
| 318 | def makepasv(self): |
Martin v. Löwis | 4eb5940 | 2001-07-26 13:37:33 +0000 | [diff] [blame] | 319 | if self.af == socket.AF_INET: |
| 320 | host, port = parse227(self.sendcmd('PASV')) |
| 321 | else: |
| 322 | host, port = parse229(self.sendcmd('EPSV'), self.sock.getpeername()) |
| 323 | return host, port |
Guido van Rossum | 1115ab2 | 1992-11-04 15:51:30 +0000 | [diff] [blame] | 324 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 325 | def ntransfercmd(self, cmd, rest=None): |
| 326 | """Initiate a transfer over the data connection. |
Barry Warsaw | 100d81e | 2000-09-01 06:09:23 +0000 | [diff] [blame] | 327 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 328 | If the transfer is active, send a port command and the |
| 329 | transfer command, and accept the connection. If the server is |
| 330 | passive, send a pasv command, connect to it, and start the |
| 331 | transfer command. Either way, return the socket for the |
| 332 | connection and the expected size of the transfer. The |
| 333 | expected size may be None if it could not be determined. |
Barry Warsaw | 100d81e | 2000-09-01 06:09:23 +0000 | [diff] [blame] | 334 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 335 | Optional `rest' argument can be a string that is sent as the |
Christian Heimes | 1af737c | 2008-01-23 08:24:23 +0000 | [diff] [blame] | 336 | argument to a REST command. This is essentially a server |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 337 | marker used to tell the server to skip over any data up to the |
| 338 | given marker. |
| 339 | """ |
| 340 | size = None |
| 341 | if self.passiveserver: |
Martin v. Löwis | a43c2f8 | 2001-07-24 20:34:08 +0000 | [diff] [blame] | 342 | host, port = self.makepasv() |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 343 | conn = socket.create_connection((host, port), self.timeout) |
Nadeem Vawda | 08f5f7a | 2011-07-23 14:03:00 +0200 | [diff] [blame] | 344 | try: |
| 345 | if rest is not None: |
| 346 | self.sendcmd("REST %s" % rest) |
| 347 | resp = self.sendcmd(cmd) |
| 348 | # Some servers apparently send a 200 reply to |
| 349 | # a LIST or STOR command, before the 150 reply |
| 350 | # (and way before the 226 reply). This seems to |
| 351 | # be in violation of the protocol (which only allows |
| 352 | # 1xx or error messages for LIST), so we just discard |
| 353 | # this response. |
| 354 | if resp[0] == '2': |
| 355 | resp = self.getresp() |
| 356 | if resp[0] != '1': |
| 357 | raise error_reply(resp) |
| 358 | except: |
| 359 | conn.close() |
| 360 | raise |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 361 | else: |
| 362 | sock = self.makeport() |
Nadeem Vawda | 08f5f7a | 2011-07-23 14:03:00 +0200 | [diff] [blame] | 363 | try: |
| 364 | if rest is not None: |
| 365 | self.sendcmd("REST %s" % rest) |
| 366 | resp = self.sendcmd(cmd) |
| 367 | # See above. |
| 368 | if resp[0] == '2': |
| 369 | resp = self.getresp() |
| 370 | if resp[0] != '1': |
| 371 | raise error_reply(resp) |
| 372 | conn, sockaddr = sock.accept() |
| 373 | if self.timeout is not _GLOBAL_DEFAULT_TIMEOUT: |
| 374 | conn.settimeout(self.timeout) |
| 375 | finally: |
| 376 | sock.close() |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 377 | if resp[:3] == '150': |
| 378 | # this is conditional in case we received a 125 |
| 379 | size = parse150(resp) |
| 380 | return conn, size |
Fred Drake | 4de02d9 | 1997-01-10 18:26:09 +0000 | [diff] [blame] | 381 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 382 | def transfercmd(self, cmd, rest=None): |
Guido van Rossum | b6aca6a | 2001-10-16 19:45:52 +0000 | [diff] [blame] | 383 | """Like ntransfercmd() but returns only the socket.""" |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 384 | return self.ntransfercmd(cmd, rest)[0] |
Guido van Rossum | c567c60 | 1992-11-05 22:22:37 +0000 | [diff] [blame] | 385 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 386 | def login(self, user = '', passwd = '', acct = ''): |
| 387 | '''Login, default anonymous.''' |
| 388 | if not user: user = 'anonymous' |
| 389 | if not passwd: passwd = '' |
| 390 | if not acct: acct = '' |
Raymond Hettinger | d5825cc | 2010-09-05 23:15:06 +0000 | [diff] [blame] | 391 | if user == 'anonymous' and passwd in {'', '-'}: |
Tim Peters | e441860 | 2002-02-16 07:34:19 +0000 | [diff] [blame] | 392 | # If there is no anonymous ftp password specified |
| 393 | # then we'll just use anonymous@ |
| 394 | # We don't send any other thing because: |
| 395 | # - We want to remain anonymous |
| 396 | # - We want to stop SPAM |
| 397 | # - We don't want to let ftp sites to discriminate by the user, |
| 398 | # host or country. |
Guido van Rossum | c33e077 | 2001-12-28 20:54:28 +0000 | [diff] [blame] | 399 | passwd = passwd + 'anonymous@' |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 400 | resp = self.sendcmd('USER ' + user) |
| 401 | if resp[0] == '3': resp = self.sendcmd('PASS ' + passwd) |
| 402 | if resp[0] == '3': resp = self.sendcmd('ACCT ' + acct) |
| 403 | if resp[0] != '2': |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 404 | raise error_reply(resp) |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 405 | return resp |
Guido van Rossum | c567c60 | 1992-11-05 22:22:37 +0000 | [diff] [blame] | 406 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 407 | def retrbinary(self, cmd, callback, blocksize=8192, rest=None): |
Christian Heimes | 1af737c | 2008-01-23 08:24:23 +0000 | [diff] [blame] | 408 | """Retrieve data in binary mode. A new port is created for you. |
Barry Warsaw | 100d81e | 2000-09-01 06:09:23 +0000 | [diff] [blame] | 409 | |
Christian Heimes | 1af737c | 2008-01-23 08:24:23 +0000 | [diff] [blame] | 410 | Args: |
| 411 | cmd: A RETR command. |
| 412 | callback: A single parameter callable to be called on each |
| 413 | block of data read. |
| 414 | blocksize: The maximum number of bytes to read from the |
| 415 | socket at one time. [default: 8192] |
| 416 | rest: Passed to transfercmd(). [default: None] |
Guido van Rossum | 1115ab2 | 1992-11-04 15:51:30 +0000 | [diff] [blame] | 417 | |
Christian Heimes | 1af737c | 2008-01-23 08:24:23 +0000 | [diff] [blame] | 418 | Returns: |
| 419 | The response code. |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 420 | """ |
| 421 | self.voidcmd('TYPE I') |
Benjamin Peterson | a807137 | 2010-10-31 18:21:16 +0000 | [diff] [blame] | 422 | with self.transfercmd(cmd, rest) as conn: |
| 423 | while 1: |
| 424 | data = conn.recv(blocksize) |
| 425 | if not data: |
| 426 | break |
| 427 | callback(data) |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 428 | return self.voidresp() |
Guido van Rossum | 1115ab2 | 1992-11-04 15:51:30 +0000 | [diff] [blame] | 429 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 430 | def retrlines(self, cmd, callback = None): |
Christian Heimes | 1af737c | 2008-01-23 08:24:23 +0000 | [diff] [blame] | 431 | """Retrieve data in line mode. A new port is created for you. |
| 432 | |
| 433 | Args: |
| 434 | cmd: A RETR, LIST, NLST, or MLSD command. |
| 435 | callback: An optional single parameter callable that is called |
| 436 | for each line with the trailing CRLF stripped. |
| 437 | [default: print_line()] |
| 438 | |
| 439 | Returns: |
| 440 | The response code. |
| 441 | """ |
Raymond Hettinger | e874fc3 | 2002-05-12 05:53:51 +0000 | [diff] [blame] | 442 | if callback is None: callback = print_line |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 443 | resp = self.sendcmd('TYPE A') |
Benjamin Peterson | a807137 | 2010-10-31 18:21:16 +0000 | [diff] [blame] | 444 | with self.transfercmd(cmd) as conn, \ |
| 445 | conn.makefile('r', encoding=self.encoding) as fp: |
| 446 | while 1: |
| 447 | line = fp.readline() |
| 448 | if self.debugging > 2: print('*retr*', repr(line)) |
| 449 | if not line: |
| 450 | break |
| 451 | if line[-2:] == CRLF: |
| 452 | line = line[:-2] |
| 453 | elif line[-1:] == '\n': |
| 454 | line = line[:-1] |
| 455 | callback(line) |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 456 | return self.voidresp() |
Guido van Rossum | c567c60 | 1992-11-05 22:22:37 +0000 | [diff] [blame] | 457 | |
Antoine Pitrou | 648bcd7 | 2009-11-27 13:23:26 +0000 | [diff] [blame] | 458 | def storbinary(self, cmd, fp, blocksize=8192, callback=None, rest=None): |
Christian Heimes | 1af737c | 2008-01-23 08:24:23 +0000 | [diff] [blame] | 459 | """Store a file in binary mode. A new port is created for you. |
| 460 | |
| 461 | Args: |
| 462 | cmd: A STOR command. |
| 463 | fp: A file-like object with a read(num_bytes) method. |
| 464 | blocksize: The maximum data size to read from fp and send over |
| 465 | the connection at once. [default: 8192] |
| 466 | callback: An optional single parameter callable that is called on |
| 467 | on each block of data after it is sent. [default: None] |
Antoine Pitrou | 648bcd7 | 2009-11-27 13:23:26 +0000 | [diff] [blame] | 468 | rest: Passed to transfercmd(). [default: None] |
Christian Heimes | 1af737c | 2008-01-23 08:24:23 +0000 | [diff] [blame] | 469 | |
| 470 | Returns: |
| 471 | The response code. |
| 472 | """ |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 473 | self.voidcmd('TYPE I') |
Benjamin Peterson | a807137 | 2010-10-31 18:21:16 +0000 | [diff] [blame] | 474 | with self.transfercmd(cmd, rest) as conn: |
| 475 | while 1: |
| 476 | buf = fp.read(blocksize) |
| 477 | if not buf: break |
| 478 | conn.sendall(buf) |
| 479 | if callback: callback(buf) |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 480 | return self.voidresp() |
Guido van Rossum | c567c60 | 1992-11-05 22:22:37 +0000 | [diff] [blame] | 481 | |
Christian Heimes | 1af737c | 2008-01-23 08:24:23 +0000 | [diff] [blame] | 482 | def storlines(self, cmd, fp, callback=None): |
| 483 | """Store a file in line mode. A new port is created for you. |
| 484 | |
| 485 | Args: |
| 486 | cmd: A STOR command. |
| 487 | fp: A file-like object with a readline() method. |
| 488 | callback: An optional single parameter callable that is called on |
| 489 | on each line after it is sent. [default: None] |
| 490 | |
| 491 | Returns: |
| 492 | The response code. |
| 493 | """ |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 494 | self.voidcmd('TYPE A') |
Benjamin Peterson | a807137 | 2010-10-31 18:21:16 +0000 | [diff] [blame] | 495 | with self.transfercmd(cmd) as conn: |
| 496 | while 1: |
| 497 | buf = fp.readline() |
| 498 | if not buf: break |
| 499 | if buf[-2:] != B_CRLF: |
| 500 | if buf[-1] in B_CRLF: buf = buf[:-1] |
| 501 | buf = buf + B_CRLF |
| 502 | conn.sendall(buf) |
| 503 | if callback: callback(buf) |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 504 | return self.voidresp() |
Guido van Rossum | 0eaa74b | 1996-01-25 18:37:21 +0000 | [diff] [blame] | 505 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 506 | def acct(self, password): |
| 507 | '''Send new account name.''' |
| 508 | cmd = 'ACCT ' + password |
| 509 | return self.voidcmd(cmd) |
Guido van Rossum | c567c60 | 1992-11-05 22:22:37 +0000 | [diff] [blame] | 510 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 511 | def nlst(self, *args): |
| 512 | '''Return a list of files in a given directory (default the current).''' |
| 513 | cmd = 'NLST' |
| 514 | for arg in args: |
| 515 | cmd = cmd + (' ' + arg) |
| 516 | files = [] |
| 517 | self.retrlines(cmd, files.append) |
| 518 | return files |
Guido van Rossum | ae3b3a3 | 1993-11-30 13:43:54 +0000 | [diff] [blame] | 519 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 520 | def dir(self, *args): |
| 521 | '''List a directory in long form. |
| 522 | By default list current directory to stdout. |
| 523 | Optional last argument is callback function; all |
| 524 | non-empty arguments before it are concatenated to the |
| 525 | LIST command. (This *should* only be used for a pathname.)''' |
| 526 | cmd = 'LIST' |
| 527 | func = None |
| 528 | if args[-1:] and type(args[-1]) != type(''): |
| 529 | args, func = args[:-1], args[-1] |
| 530 | for arg in args: |
| 531 | if arg: |
| 532 | cmd = cmd + (' ' + arg) |
| 533 | self.retrlines(cmd, func) |
Guido van Rossum | c567c60 | 1992-11-05 22:22:37 +0000 | [diff] [blame] | 534 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 535 | def rename(self, fromname, toname): |
| 536 | '''Rename a file.''' |
| 537 | resp = self.sendcmd('RNFR ' + fromname) |
| 538 | if resp[0] != '3': |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 539 | raise error_reply(resp) |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 540 | return self.voidcmd('RNTO ' + toname) |
Guido van Rossum | a61bdeb | 1995-10-11 17:36:31 +0000 | [diff] [blame] | 541 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 542 | def delete(self, filename): |
| 543 | '''Delete a file.''' |
| 544 | resp = self.sendcmd('DELE ' + filename) |
Raymond Hettinger | d5825cc | 2010-09-05 23:15:06 +0000 | [diff] [blame] | 545 | if resp[:3] in {'250', '200'}: |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 546 | return resp |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 547 | else: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 548 | raise error_reply(resp) |
Guido van Rossum | 02cf582 | 1993-05-17 08:00:02 +0000 | [diff] [blame] | 549 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 550 | def cwd(self, dirname): |
| 551 | '''Change to a directory.''' |
| 552 | if dirname == '..': |
| 553 | try: |
| 554 | return self.voidcmd('CDUP') |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 555 | except error_perm as msg: |
Martin v. Löwis | b525511 | 2002-03-10 15:59:58 +0000 | [diff] [blame] | 556 | if msg.args[0][:3] != '500': |
| 557 | raise |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 558 | elif dirname == '': |
| 559 | dirname = '.' # does nothing, but could return error |
| 560 | cmd = 'CWD ' + dirname |
| 561 | return self.voidcmd(cmd) |
Guido van Rossum | 17ed1ae | 1993-06-01 13:21:04 +0000 | [diff] [blame] | 562 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 563 | def size(self, filename): |
| 564 | '''Retrieve the size of a file.''' |
Christian Heimes | 1af737c | 2008-01-23 08:24:23 +0000 | [diff] [blame] | 565 | # The SIZE command is defined in RFC-3659 |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 566 | resp = self.sendcmd('SIZE ' + filename) |
| 567 | if resp[:3] == '213': |
Guido van Rossum | b6aca6a | 2001-10-16 19:45:52 +0000 | [diff] [blame] | 568 | s = resp[3:].strip() |
| 569 | try: |
| 570 | return int(s) |
Guido van Rossum | 1f74cb3 | 2001-10-17 17:21:47 +0000 | [diff] [blame] | 571 | except (OverflowError, ValueError): |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 572 | return int(s) |
Guido van Rossum | c567c60 | 1992-11-05 22:22:37 +0000 | [diff] [blame] | 573 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 574 | def mkd(self, dirname): |
| 575 | '''Make a directory, return its full pathname.''' |
Giampaolo RodolĂ | bbc4782 | 2010-08-23 22:10:32 +0000 | [diff] [blame] | 576 | resp = self.voidcmd('MKD ' + dirname) |
| 577 | # fix around non-compliant implementations such as IIS shipped |
| 578 | # with Windows server 2003 |
| 579 | if not resp.startswith('257'): |
| 580 | return '' |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 581 | return parse257(resp) |
Guido van Rossum | 9824509 | 1998-02-19 21:15:44 +0000 | [diff] [blame] | 582 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 583 | def rmd(self, dirname): |
| 584 | '''Remove a directory.''' |
| 585 | return self.voidcmd('RMD ' + dirname) |
Guido van Rossum | 1115ab2 | 1992-11-04 15:51:30 +0000 | [diff] [blame] | 586 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 587 | def pwd(self): |
| 588 | '''Return current working directory.''' |
Giampaolo RodolĂ | bbc4782 | 2010-08-23 22:10:32 +0000 | [diff] [blame] | 589 | resp = self.voidcmd('PWD') |
| 590 | # fix around non-compliant implementations such as IIS shipped |
| 591 | # with Windows server 2003 |
| 592 | if not resp.startswith('257'): |
| 593 | return '' |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 594 | return parse257(resp) |
Guido van Rossum | 17ed1ae | 1993-06-01 13:21:04 +0000 | [diff] [blame] | 595 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 596 | def quit(self): |
| 597 | '''Quit, and close the connection.''' |
| 598 | resp = self.voidcmd('QUIT') |
| 599 | self.close() |
| 600 | return resp |
| 601 | |
| 602 | def close(self): |
| 603 | '''Close the connection without assuming anything about it.''' |
Fred Drake | 9c98a42 | 2001-02-28 21:46:37 +0000 | [diff] [blame] | 604 | if self.file: |
| 605 | self.file.close() |
| 606 | self.sock.close() |
| 607 | self.file = self.sock = None |
Guido van Rossum | c567c60 | 1992-11-05 22:22:37 +0000 | [diff] [blame] | 608 | |
| 609 | |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 610 | try: |
| 611 | import ssl |
| 612 | except ImportError: |
| 613 | pass |
| 614 | else: |
| 615 | class FTP_TLS(FTP): |
| 616 | '''A FTP subclass which adds TLS support to FTP as described |
| 617 | in RFC-4217. |
| 618 | |
| 619 | Connect as usual to port 21 implicitly securing the FTP control |
| 620 | connection before authenticating. |
| 621 | |
| 622 | Securing the data connection requires user to explicitly ask |
| 623 | for it by calling prot_p() method. |
| 624 | |
| 625 | Usage example: |
| 626 | >>> from ftplib import FTP_TLS |
| 627 | >>> ftps = FTP_TLS('ftp.python.org') |
Ezio Melotti | 4969f70 | 2011-03-15 05:59:46 +0200 | [diff] [blame] | 628 | >>> ftps.login() # login anonymously previously securing control channel |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 629 | '230 Guest login ok, access restrictions apply.' |
| 630 | >>> ftps.prot_p() # switch to secure data connection |
| 631 | '200 Protection level set to P' |
| 632 | >>> ftps.retrlines('LIST') # list directory content securely |
| 633 | total 9 |
| 634 | drwxr-xr-x 8 root wheel 1024 Jan 3 1994 . |
| 635 | drwxr-xr-x 8 root wheel 1024 Jan 3 1994 .. |
| 636 | drwxr-xr-x 2 root wheel 1024 Jan 3 1994 bin |
| 637 | drwxr-xr-x 2 root wheel 1024 Jan 3 1994 etc |
| 638 | d-wxrwxr-x 2 ftp wheel 1024 Sep 5 13:43 incoming |
| 639 | drwxr-xr-x 2 root wheel 1024 Nov 17 1993 lib |
| 640 | drwxr-xr-x 6 1094 wheel 1024 Sep 13 19:07 pub |
| 641 | drwxr-xr-x 3 root wheel 1024 Jan 3 1994 usr |
| 642 | -rw-r--r-- 1 root root 312 Aug 1 1994 welcome.msg |
| 643 | '226 Transfer complete.' |
| 644 | >>> ftps.quit() |
| 645 | '221 Goodbye.' |
| 646 | >>> |
| 647 | ''' |
| 648 | ssl_version = ssl.PROTOCOL_TLSv1 |
| 649 | |
| 650 | def __init__(self, host='', user='', passwd='', acct='', keyfile=None, |
Giampaolo RodolĂ | a67299e | 2010-05-26 18:06:04 +0000 | [diff] [blame] | 651 | certfile=None, context=None, |
| 652 | timeout=_GLOBAL_DEFAULT_TIMEOUT): |
| 653 | if context is not None and keyfile is not None: |
| 654 | raise ValueError("context and keyfile arguments are mutually " |
| 655 | "exclusive") |
| 656 | if context is not None and certfile is not None: |
| 657 | raise ValueError("context and certfile arguments are mutually " |
| 658 | "exclusive") |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 659 | self.keyfile = keyfile |
| 660 | self.certfile = certfile |
Giampaolo RodolĂ | a67299e | 2010-05-26 18:06:04 +0000 | [diff] [blame] | 661 | self.context = context |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 662 | self._prot_p = False |
| 663 | FTP.__init__(self, host, user, passwd, acct, timeout) |
| 664 | |
| 665 | def login(self, user='', passwd='', acct='', secure=True): |
| 666 | if secure and not isinstance(self.sock, ssl.SSLSocket): |
| 667 | self.auth() |
| 668 | return FTP.login(self, user, passwd, acct) |
| 669 | |
| 670 | def auth(self): |
| 671 | '''Set up secure control connection by using TLS/SSL.''' |
| 672 | if isinstance(self.sock, ssl.SSLSocket): |
| 673 | raise ValueError("Already using TLS") |
| 674 | if self.ssl_version == ssl.PROTOCOL_TLSv1: |
| 675 | resp = self.voidcmd('AUTH TLS') |
| 676 | else: |
| 677 | resp = self.voidcmd('AUTH SSL') |
Giampaolo RodolĂ | a67299e | 2010-05-26 18:06:04 +0000 | [diff] [blame] | 678 | if self.context is not None: |
| 679 | self.sock = self.context.wrap_socket(self.sock) |
| 680 | else: |
| 681 | self.sock = ssl.wrap_socket(self.sock, self.keyfile, |
| 682 | self.certfile, |
| 683 | ssl_version=self.ssl_version) |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 684 | self.file = self.sock.makefile(mode='r', encoding=self.encoding) |
| 685 | return resp |
| 686 | |
| 687 | def prot_p(self): |
| 688 | '''Set up secure data connection.''' |
| 689 | # PROT defines whether or not the data channel is to be protected. |
| 690 | # Though RFC-2228 defines four possible protection levels, |
| 691 | # RFC-4217 only recommends two, Clear and Private. |
| 692 | # Clear (PROT C) means that no security is to be used on the |
| 693 | # data-channel, Private (PROT P) means that the data-channel |
| 694 | # should be protected by TLS. |
| 695 | # PBSZ command MUST still be issued, but must have a parameter of |
| 696 | # '0' to indicate that no buffering is taking place and the data |
| 697 | # connection should not be encapsulated. |
| 698 | self.voidcmd('PBSZ 0') |
| 699 | resp = self.voidcmd('PROT P') |
| 700 | self._prot_p = True |
| 701 | return resp |
| 702 | |
| 703 | def prot_c(self): |
| 704 | '''Set up clear text data connection.''' |
| 705 | resp = self.voidcmd('PROT C') |
| 706 | self._prot_p = False |
| 707 | return resp |
| 708 | |
| 709 | # --- Overridden FTP methods |
| 710 | |
| 711 | def ntransfercmd(self, cmd, rest=None): |
| 712 | conn, size = FTP.ntransfercmd(self, cmd, rest) |
| 713 | if self._prot_p: |
Giampaolo RodolĂ | a67299e | 2010-05-26 18:06:04 +0000 | [diff] [blame] | 714 | if self.context is not None: |
| 715 | conn = self.context.wrap_socket(conn) |
| 716 | else: |
| 717 | conn = ssl.wrap_socket(conn, self.keyfile, self.certfile, |
| 718 | ssl_version=self.ssl_version) |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 719 | return conn, size |
| 720 | |
| 721 | def retrbinary(self, cmd, callback, blocksize=8192, rest=None): |
| 722 | self.voidcmd('TYPE I') |
| 723 | conn = self.transfercmd(cmd, rest) |
| 724 | try: |
| 725 | while 1: |
| 726 | data = conn.recv(blocksize) |
| 727 | if not data: |
| 728 | break |
| 729 | callback(data) |
| 730 | # shutdown ssl layer |
| 731 | if isinstance(conn, ssl.SSLSocket): |
| 732 | conn.unwrap() |
| 733 | finally: |
| 734 | conn.close() |
| 735 | return self.voidresp() |
| 736 | |
| 737 | def retrlines(self, cmd, callback = None): |
| 738 | if callback is None: callback = print_line |
| 739 | resp = self.sendcmd('TYPE A') |
| 740 | conn = self.transfercmd(cmd) |
| 741 | fp = conn.makefile('r', encoding=self.encoding) |
| 742 | try: |
| 743 | while 1: |
| 744 | line = fp.readline() |
| 745 | if self.debugging > 2: print('*retr*', repr(line)) |
| 746 | if not line: |
| 747 | break |
| 748 | if line[-2:] == CRLF: |
| 749 | line = line[:-2] |
| 750 | elif line[-1:] == '\n': |
| 751 | line = line[:-1] |
| 752 | callback(line) |
| 753 | # shutdown ssl layer |
| 754 | if isinstance(conn, ssl.SSLSocket): |
| 755 | conn.unwrap() |
| 756 | finally: |
| 757 | fp.close() |
| 758 | conn.close() |
| 759 | return self.voidresp() |
| 760 | |
Antoine Pitrou | 648bcd7 | 2009-11-27 13:23:26 +0000 | [diff] [blame] | 761 | def storbinary(self, cmd, fp, blocksize=8192, callback=None, rest=None): |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 762 | self.voidcmd('TYPE I') |
Antoine Pitrou | 648bcd7 | 2009-11-27 13:23:26 +0000 | [diff] [blame] | 763 | conn = self.transfercmd(cmd, rest) |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 764 | try: |
| 765 | while 1: |
| 766 | buf = fp.read(blocksize) |
| 767 | if not buf: break |
| 768 | conn.sendall(buf) |
| 769 | if callback: callback(buf) |
| 770 | # shutdown ssl layer |
| 771 | if isinstance(conn, ssl.SSLSocket): |
| 772 | conn.unwrap() |
| 773 | finally: |
| 774 | conn.close() |
| 775 | return self.voidresp() |
| 776 | |
| 777 | def storlines(self, cmd, fp, callback=None): |
| 778 | self.voidcmd('TYPE A') |
| 779 | conn = self.transfercmd(cmd) |
| 780 | try: |
| 781 | while 1: |
| 782 | buf = fp.readline() |
| 783 | if not buf: break |
Giampaolo RodolĂ | f96482e | 2010-08-04 10:36:18 +0000 | [diff] [blame] | 784 | if buf[-2:] != B_CRLF: |
| 785 | if buf[-1] in B_CRLF: buf = buf[:-1] |
| 786 | buf = buf + B_CRLF |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 787 | conn.sendall(buf) |
| 788 | if callback: callback(buf) |
| 789 | # shutdown ssl layer |
| 790 | if isinstance(conn, ssl.SSLSocket): |
| 791 | conn.unwrap() |
| 792 | finally: |
| 793 | conn.close() |
| 794 | return self.voidresp() |
| 795 | |
Giampaolo Rodola' | 24befa8 | 2011-05-07 19:09:34 +0200 | [diff] [blame] | 796 | def abort(self): |
| 797 | # overridden as we can't pass MSG_OOB flag to sendall() |
| 798 | line = b'ABOR' + B_CRLF |
| 799 | self.sock.sendall(line) |
| 800 | resp = self.getmultiline() |
| 801 | if resp[:3] not in {'426', '225', '226'}: |
| 802 | raise error_proto(resp) |
| 803 | return resp |
| 804 | |
Antoine Pitrou | f988cd0 | 2009-11-17 20:21:14 +0000 | [diff] [blame] | 805 | __all__.append('FTP_TLS') |
| 806 | all_errors = (Error, IOError, EOFError, ssl.SSLError) |
| 807 | |
| 808 | |
Guido van Rossum | acfb82a | 1997-10-22 20:49:52 +0000 | [diff] [blame] | 809 | _150_re = None |
Fred Drake | 4de02d9 | 1997-01-10 18:26:09 +0000 | [diff] [blame] | 810 | |
| 811 | def parse150(resp): |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 812 | '''Parse the '150' response for a RETR request. |
| 813 | Returns the expected transfer size or None; size is not guaranteed to |
| 814 | be present in the 150 message. |
| 815 | ''' |
| 816 | if resp[:3] != '150': |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 817 | raise error_reply(resp) |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 818 | global _150_re |
| 819 | if _150_re is None: |
| 820 | import re |
Antoine Pitrou | fd03645 | 2008-08-19 17:56:33 +0000 | [diff] [blame] | 821 | _150_re = re.compile( |
| 822 | "150 .* \((\d+) bytes\)", re.IGNORECASE | re.ASCII) |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 823 | m = _150_re.match(resp) |
Guido van Rossum | b6aca6a | 2001-10-16 19:45:52 +0000 | [diff] [blame] | 824 | if not m: |
| 825 | return None |
| 826 | s = m.group(1) |
| 827 | try: |
| 828 | return int(s) |
Guido van Rossum | 1f74cb3 | 2001-10-17 17:21:47 +0000 | [diff] [blame] | 829 | except (OverflowError, ValueError): |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 830 | return int(s) |
Fred Drake | 4de02d9 | 1997-01-10 18:26:09 +0000 | [diff] [blame] | 831 | |
| 832 | |
Guido van Rossum | 70297d3 | 2001-08-17 17:24:29 +0000 | [diff] [blame] | 833 | _227_re = None |
| 834 | |
Guido van Rossum | d2560b0 | 1996-05-28 23:41:25 +0000 | [diff] [blame] | 835 | def parse227(resp): |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 836 | '''Parse the '227' response for a PASV request. |
| 837 | Raises error_proto if it does not contain '(h1,h2,h3,h4,p1,p2)' |
| 838 | Return ('host.addr.as.numbers', port#) tuple.''' |
Guido van Rossum | d2560b0 | 1996-05-28 23:41:25 +0000 | [diff] [blame] | 839 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 840 | if resp[:3] != '227': |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 841 | raise error_reply(resp) |
Guido van Rossum | 70297d3 | 2001-08-17 17:24:29 +0000 | [diff] [blame] | 842 | global _227_re |
| 843 | if _227_re is None: |
| 844 | import re |
Antoine Pitrou | fd03645 | 2008-08-19 17:56:33 +0000 | [diff] [blame] | 845 | _227_re = re.compile(r'(\d+),(\d+),(\d+),(\d+),(\d+),(\d+)', re.ASCII) |
Guido van Rossum | 70297d3 | 2001-08-17 17:24:29 +0000 | [diff] [blame] | 846 | m = _227_re.search(resp) |
| 847 | if not m: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 848 | raise error_proto(resp) |
Guido van Rossum | 70297d3 | 2001-08-17 17:24:29 +0000 | [diff] [blame] | 849 | numbers = m.groups() |
Eric S. Raymond | c95bf69 | 2001-02-09 10:06:47 +0000 | [diff] [blame] | 850 | host = '.'.join(numbers[:4]) |
| 851 | port = (int(numbers[4]) << 8) + int(numbers[5]) |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 852 | return host, port |
Guido van Rossum | d2560b0 | 1996-05-28 23:41:25 +0000 | [diff] [blame] | 853 | |
| 854 | |
Martin v. Löwis | a43c2f8 | 2001-07-24 20:34:08 +0000 | [diff] [blame] | 855 | def parse229(resp, peer): |
| 856 | '''Parse the '229' response for a EPSV request. |
| 857 | Raises error_proto if it does not contain '(|||port|)' |
| 858 | Return ('host.addr.as.numbers', port#) tuple.''' |
| 859 | |
Raymond Hettinger | c88a6c7 | 2005-04-05 04:31:09 +0000 | [diff] [blame] | 860 | if resp[:3] != '229': |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 861 | raise error_reply(resp) |
Neal Norwitz | 7ce734c | 2002-05-31 14:13:04 +0000 | [diff] [blame] | 862 | left = resp.find('(') |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 863 | if left < 0: raise error_proto(resp) |
Neal Norwitz | 7ce734c | 2002-05-31 14:13:04 +0000 | [diff] [blame] | 864 | right = resp.find(')', left + 1) |
Martin v. Löwis | a43c2f8 | 2001-07-24 20:34:08 +0000 | [diff] [blame] | 865 | if right < 0: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 866 | raise error_proto(resp) # should contain '(|||port|)' |
Raymond Hettinger | c88a6c7 | 2005-04-05 04:31:09 +0000 | [diff] [blame] | 867 | if resp[left + 1] != resp[right - 1]: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 868 | raise error_proto(resp) |
Walter Dörwald | a401ae4 | 2002-06-03 10:41:45 +0000 | [diff] [blame] | 869 | parts = resp[left + 1:right].split(resp[left+1]) |
Raymond Hettinger | c88a6c7 | 2005-04-05 04:31:09 +0000 | [diff] [blame] | 870 | if len(parts) != 5: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 871 | raise error_proto(resp) |
Martin v. Löwis | a43c2f8 | 2001-07-24 20:34:08 +0000 | [diff] [blame] | 872 | host = peer[0] |
Neal Norwitz | 7ce734c | 2002-05-31 14:13:04 +0000 | [diff] [blame] | 873 | port = int(parts[3]) |
Martin v. Löwis | a43c2f8 | 2001-07-24 20:34:08 +0000 | [diff] [blame] | 874 | return host, port |
| 875 | |
| 876 | |
Guido van Rossum | c567c60 | 1992-11-05 22:22:37 +0000 | [diff] [blame] | 877 | def parse257(resp): |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 878 | '''Parse the '257' response for a MKD or PWD request. |
| 879 | This is a response to a MKD or PWD request: a directory name. |
| 880 | Returns the directoryname in the 257 reply.''' |
Guido van Rossum | d2560b0 | 1996-05-28 23:41:25 +0000 | [diff] [blame] | 881 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 882 | if resp[:3] != '257': |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 883 | raise error_reply(resp) |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 884 | if resp[3:5] != ' "': |
| 885 | return '' # Not compliant to RFC 959, but UNIX ftpd does this |
| 886 | dirname = '' |
| 887 | i = 5 |
| 888 | n = len(resp) |
| 889 | while i < n: |
| 890 | c = resp[i] |
| 891 | i = i+1 |
| 892 | if c == '"': |
| 893 | if i >= n or resp[i] != '"': |
| 894 | break |
| 895 | i = i+1 |
| 896 | dirname = dirname + c |
| 897 | return dirname |
Guido van Rossum | 1115ab2 | 1992-11-04 15:51:30 +0000 | [diff] [blame] | 898 | |
Guido van Rossum | 2f3941d | 1997-10-07 14:49:56 +0000 | [diff] [blame] | 899 | |
Guido van Rossum | ae3b3a3 | 1993-11-30 13:43:54 +0000 | [diff] [blame] | 900 | def print_line(line): |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 901 | '''Default retrlines callback to print a line.''' |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 902 | print(line) |
Guido van Rossum | ae3b3a3 | 1993-11-30 13:43:54 +0000 | [diff] [blame] | 903 | |
Guido van Rossum | 2f3941d | 1997-10-07 14:49:56 +0000 | [diff] [blame] | 904 | |
Guido van Rossum | d2560b0 | 1996-05-28 23:41:25 +0000 | [diff] [blame] | 905 | def ftpcp(source, sourcename, target, targetname = '', type = 'I'): |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 906 | '''Copy file from one FTP-instance to another.''' |
| 907 | if not targetname: targetname = sourcename |
| 908 | 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) |
Raymond Hettinger | d5825cc | 2010-09-05 23:15:06 +0000 | [diff] [blame] | 917 | if treply[:3] not in {'125', '150'}: raise error_proto # RFC 959 |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 918 | sreply = source.sendcmd('RETR ' + sourcename) |
Raymond Hettinger | d5825cc | 2010-09-05 23:15:06 +0000 | [diff] [blame] | 919 | if sreply[:3] not in {'125', '150'}: raise error_proto # RFC 959 |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 920 | source.voidresp() |
| 921 | target.voidresp() |
Guido van Rossum | 1115ab2 | 1992-11-04 15:51:30 +0000 | [diff] [blame] | 922 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 923 | |
Guido van Rossum | 56d1e3a | 1997-03-14 04:16:54 +0000 | [diff] [blame] | 924 | class Netrc: |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 925 | """Class to parse & provide access to 'netrc' format files. |
Fred Drake | 475d51d | 1997-06-24 22:02:54 +0000 | [diff] [blame] | 926 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 927 | See the netrc(4) man page for information on the file format. |
Guido van Rossum | 56d1e3a | 1997-03-14 04:16:54 +0000 | [diff] [blame] | 928 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 929 | WARNING: This class is obsolete -- use module netrc instead. |
Guido van Rossum | c822a45 | 1998-12-22 16:49:16 +0000 | [diff] [blame] | 930 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 931 | """ |
| 932 | __defuser = None |
| 933 | __defpasswd = None |
| 934 | __defacct = None |
Guido van Rossum | 56d1e3a | 1997-03-14 04:16:54 +0000 | [diff] [blame] | 935 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 936 | def __init__(self, filename=None): |
Raymond Hettinger | 094662a | 2002-06-01 01:29:16 +0000 | [diff] [blame] | 937 | if filename is None: |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 938 | if "HOME" in os.environ: |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 939 | filename = os.path.join(os.environ["HOME"], |
| 940 | ".netrc") |
| 941 | else: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 942 | raise IOError("specify file to load or set $HOME") |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 943 | self.__hosts = {} |
| 944 | self.__macros = {} |
| 945 | fp = open(filename, "r") |
| 946 | in_macro = 0 |
| 947 | while 1: |
| 948 | line = fp.readline() |
| 949 | if not line: break |
Eric S. Raymond | c95bf69 | 2001-02-09 10:06:47 +0000 | [diff] [blame] | 950 | if in_macro and line.strip(): |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 951 | macro_lines.append(line) |
| 952 | continue |
| 953 | elif in_macro: |
| 954 | self.__macros[macro_name] = tuple(macro_lines) |
| 955 | in_macro = 0 |
Eric S. Raymond | c95bf69 | 2001-02-09 10:06:47 +0000 | [diff] [blame] | 956 | words = line.split() |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 957 | host = user = passwd = acct = None |
| 958 | default = 0 |
| 959 | i = 0 |
| 960 | while i < len(words): |
| 961 | w1 = words[i] |
| 962 | if i+1 < len(words): |
| 963 | w2 = words[i + 1] |
| 964 | else: |
| 965 | w2 = None |
| 966 | if w1 == 'default': |
| 967 | default = 1 |
| 968 | elif w1 == 'machine' and w2: |
Eric S. Raymond | c95bf69 | 2001-02-09 10:06:47 +0000 | [diff] [blame] | 969 | host = w2.lower() |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 970 | i = i + 1 |
| 971 | elif w1 == 'login' and w2: |
| 972 | user = w2 |
| 973 | i = i + 1 |
| 974 | elif w1 == 'password' and w2: |
| 975 | passwd = w2 |
| 976 | i = i + 1 |
| 977 | elif w1 == 'account' and w2: |
| 978 | acct = w2 |
| 979 | i = i + 1 |
| 980 | elif w1 == 'macdef' and w2: |
| 981 | macro_name = w2 |
| 982 | macro_lines = [] |
| 983 | in_macro = 1 |
| 984 | break |
| 985 | i = i + 1 |
| 986 | if default: |
| 987 | self.__defuser = user or self.__defuser |
| 988 | self.__defpasswd = passwd or self.__defpasswd |
| 989 | self.__defacct = acct or self.__defacct |
| 990 | if host: |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 991 | if host in self.__hosts: |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 992 | ouser, opasswd, oacct = \ |
| 993 | self.__hosts[host] |
| 994 | user = user or ouser |
| 995 | passwd = passwd or opasswd |
| 996 | acct = acct or oacct |
| 997 | self.__hosts[host] = user, passwd, acct |
| 998 | fp.close() |
Guido van Rossum | 56d1e3a | 1997-03-14 04:16:54 +0000 | [diff] [blame] | 999 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 1000 | def get_hosts(self): |
| 1001 | """Return a list of hosts mentioned in the .netrc file.""" |
| 1002 | return self.__hosts.keys() |
Guido van Rossum | 8ca8420 | 1998-03-26 20:56:10 +0000 | [diff] [blame] | 1003 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 1004 | def get_account(self, host): |
| 1005 | """Returns login information for the named host. |
Guido van Rossum | 8ca8420 | 1998-03-26 20:56:10 +0000 | [diff] [blame] | 1006 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 1007 | The return value is a triple containing userid, |
| 1008 | password, and the accounting field. |
Guido van Rossum | 8ca8420 | 1998-03-26 20:56:10 +0000 | [diff] [blame] | 1009 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 1010 | """ |
Eric S. Raymond | c95bf69 | 2001-02-09 10:06:47 +0000 | [diff] [blame] | 1011 | host = host.lower() |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 1012 | user = passwd = acct = None |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 1013 | if host in self.__hosts: |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 1014 | user, passwd, acct = self.__hosts[host] |
| 1015 | user = user or self.__defuser |
| 1016 | passwd = passwd or self.__defpasswd |
| 1017 | acct = acct or self.__defacct |
| 1018 | return user, passwd, acct |
Guido van Rossum | 8ca8420 | 1998-03-26 20:56:10 +0000 | [diff] [blame] | 1019 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 1020 | def get_macros(self): |
| 1021 | """Return a list of all defined macro names.""" |
| 1022 | return self.__macros.keys() |
Guido van Rossum | 8ca8420 | 1998-03-26 20:56:10 +0000 | [diff] [blame] | 1023 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 1024 | def get_macro(self, macro): |
| 1025 | """Return a sequence of lines which define a named macro.""" |
| 1026 | return self.__macros[macro] |
Guido van Rossum | 56d1e3a | 1997-03-14 04:16:54 +0000 | [diff] [blame] | 1027 | |
Fred Drake | 475d51d | 1997-06-24 22:02:54 +0000 | [diff] [blame] | 1028 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 1029 | |
Guido van Rossum | 1115ab2 | 1992-11-04 15:51:30 +0000 | [diff] [blame] | 1030 | def test(): |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 1031 | '''Test program. |
Raymond Hettinger | c88a6c7 | 2005-04-05 04:31:09 +0000 | [diff] [blame] | 1032 | Usage: ftp [-d] [-r[file]] host [-l[dir]] [-d[dir]] [-p] [file] ... |
| 1033 | |
| 1034 | -d dir |
| 1035 | -l list |
| 1036 | -p password |
| 1037 | ''' |
| 1038 | |
| 1039 | if len(sys.argv) < 2: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 1040 | print(test.__doc__) |
Raymond Hettinger | c88a6c7 | 2005-04-05 04:31:09 +0000 | [diff] [blame] | 1041 | sys.exit(0) |
Guido van Rossum | d2560b0 | 1996-05-28 23:41:25 +0000 | [diff] [blame] | 1042 | |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 1043 | debugging = 0 |
| 1044 | rcfile = None |
| 1045 | while sys.argv[1] == '-d': |
| 1046 | debugging = debugging+1 |
| 1047 | del sys.argv[1] |
| 1048 | if sys.argv[1][:2] == '-r': |
| 1049 | # get name of alternate ~/.netrc file: |
| 1050 | rcfile = sys.argv[1][2:] |
| 1051 | del sys.argv[1] |
| 1052 | host = sys.argv[1] |
| 1053 | ftp = FTP(host) |
| 1054 | ftp.set_debuglevel(debugging) |
| 1055 | userid = passwd = acct = '' |
| 1056 | try: |
| 1057 | netrc = Netrc(rcfile) |
| 1058 | except IOError: |
| 1059 | if rcfile is not None: |
| 1060 | sys.stderr.write("Could not open account file" |
| 1061 | " -- using anonymous login.") |
| 1062 | else: |
| 1063 | try: |
| 1064 | userid, passwd, acct = netrc.get_account(host) |
| 1065 | except KeyError: |
| 1066 | # no account for host |
| 1067 | sys.stderr.write( |
| 1068 | "No account -- using anonymous login.") |
| 1069 | ftp.login(userid, passwd, acct) |
| 1070 | for file in sys.argv[2:]: |
| 1071 | if file[:2] == '-l': |
| 1072 | ftp.dir(file[2:]) |
| 1073 | elif file[:2] == '-d': |
| 1074 | cmd = 'CWD' |
| 1075 | if file[2:]: cmd = cmd + ' ' + file[2:] |
| 1076 | resp = ftp.sendcmd(cmd) |
| 1077 | elif file == '-p': |
| 1078 | ftp.set_pasv(not ftp.passiveserver) |
| 1079 | else: |
| 1080 | ftp.retrbinary('RETR ' + file, \ |
| 1081 | sys.stdout.write, 1024) |
| 1082 | ftp.quit() |
Guido van Rossum | 221ec0b | 1995-08-04 04:39:30 +0000 | [diff] [blame] | 1083 | |
| 1084 | |
| 1085 | if __name__ == '__main__': |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 1086 | test() |