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