ftplib.py 27.9 KB
Newer Older
1 2
"""An FTP client class and some helper functions.

3
Based on RFC 959: File Transfer Protocol (FTP), by J. Postel and J. Reynolds
4 5 6 7 8

Example:

>>> from ftplib import FTP
>>> ftp = FTP('ftp.python.org') # connect to host, default port
9
>>> ftp.login() # default, i.e.: user anonymous, passwd anonymous@
10
'230 Guest login ok, access restrictions apply.'
11 12 13 14 15 16 17 18 19 20 21
>>> ftp.retrlines('LIST') # list directory contents
total 9
drwxr-xr-x   8 root     wheel        1024 Jan  3  1994 .
drwxr-xr-x   8 root     wheel        1024 Jan  3  1994 ..
drwxr-xr-x   2 root     wheel        1024 Jan  3  1994 bin
drwxr-xr-x   2 root     wheel        1024 Jan  3  1994 etc
d-wxrwxr-x   2 ftp      wheel        1024 Sep  5 13:43 incoming
drwxr-xr-x   2 root     wheel        1024 Nov 17  1993 lib
drwxr-xr-x   6 1094     wheel        1024 Sep 13 19:07 pub
drwxr-xr-x   3 root     wheel        1024 Jan  3  1994 usr
-rw-r--r--   1 root     root          312 Aug  1  1994 welcome.msg
22
'226 Transfer complete.'
23
>>> ftp.quit()
24
'221 Goodbye.'
Tim Peters's avatar
Tim Peters committed
25
>>>
26 27 28

A nice test that reveals some of the network dialogue would be:
python ftplib.py -d localhost -l -p -l
29
"""
30

Tim Peters's avatar
Tim Peters committed
31
#
32 33 34
# Changes and improvements suggested by Steve Majewski.
# Modified by Jack to work on the mac.
# Modified by Siebren to support docstrings and PASV.
35
# Modified by Phil Schwartz to add storbinary and storlines callbacks.
36
#
37

Guido van Rossum's avatar
Guido van Rossum committed
38 39 40
import os
import sys

41 42
# Import SOCKS module if it exists, else standard socket module socket
try:
Tim Peters's avatar
Tim Peters committed
43 44
    import SOCKS; socket = SOCKS; del SOCKS # import SOCKS as socket
    from socket import getfqdn; socket.getfqdn = getfqdn; del getfqdn
45
except ImportError:
Tim Peters's avatar
Tim Peters committed
46
    import socket
47
from socket import _GLOBAL_DEFAULT_TIMEOUT
48

Skip Montanaro's avatar
Skip Montanaro committed
49
__all__ = ["FTP","Netrc"]
Guido van Rossum's avatar
Guido van Rossum committed
50

51
# Magic number from <socket.h>
Tim Peters's avatar
Tim Peters committed
52
MSG_OOB = 0x1                           # Process data out of band
53 54


55
# The standard FTP server control port
Guido van Rossum's avatar
Guido van Rossum committed
56 57 58
FTP_PORT = 21


59
# Exception raised when an error or invalid response is received
60
class Error(Exception): pass
Tim Peters's avatar
Tim Peters committed
61 62 63 64
class error_reply(Error): pass          # unexpected [123]xx reply
class error_temp(Error): pass           # 4xx errors
class error_perm(Error): pass           # 5xx errors
class error_proto(Error): pass          # response does not begin with [1-5]
Guido van Rossum's avatar
Guido van Rossum committed
65 66


67 68
# All exceptions (hopefully) that may be raised here and that aren't
# (always) programming errors on our side
69
all_errors = (Error, IOError, EOFError)
70 71


Guido van Rossum's avatar
Guido van Rossum committed
72 73 74 75 76 77
# Line terminators (we always output CRLF, but accept any of CRLF, CR, LF)
CRLF = '\r\n'

# The class itself
class FTP:

Tim Peters's avatar
Tim Peters committed
78
    '''An FTP client class.
79

80 81 82 83 84 85 86 87
    To create a connection, call the class using these arguments:
            host, user, passwd, acct, timeout

    The first four arguments are all strings, and have default value ''.
    timeout must be numeric and defaults to None if not passed,
    meaning that no timeout will be set on any ftp socket(s)
    If a timeout is passed, then this is now the default timeout for all ftp
    socket operations for this instance.
88

Tim Peters's avatar
Tim Peters committed
89
    Then use self.connect() with optional host and port argument.
90

Tim Peters's avatar
Tim Peters committed
91 92 93 94 95 96 97
    To download a file, use ftp.retrlines('RETR ' + filename),
    or ftp.retrbinary() with slightly different arguments.
    To upload a file, use ftp.storlines() or ftp.storbinary(),
    which have an open file as argument (see their definitions
    below for details).
    The download/upload functions first issue appropriate TYPE
    and PORT or PASV commands.
98 99
'''

100 101 102 103 104 105 106 107
    debugging = 0
    host = ''
    port = FTP_PORT
    sock = None
    file = None
    welcome = None
    passiveserver = 1

Tim Peters's avatar
Tim Peters committed
108 109 110 111
    # Initialization method (called by class instantiation).
    # Initialize host to localhost, port to standard ftp port
    # Optional arguments are host (for connect()),
    # and user, passwd, acct (for login())
112 113
    def __init__(self, host='', user='', passwd='', acct='',
                 timeout=_GLOBAL_DEFAULT_TIMEOUT):
114
        self.timeout = timeout
Tim Peters's avatar
Tim Peters committed
115
        if host:
116
            self.connect(host)
117
            if user:
118
                self.login(user, passwd, acct)
Tim Peters's avatar
Tim Peters committed
119

120
    def connect(self, host='', port=0, timeout=-999):
121
        '''Connect to host.  Arguments are:
122 123 124 125 126 127 128
         - host: hostname to connect to (string, default previous host)
         - port: port to connect to (integer, default previous port)
        '''
        if host != '':
            self.host = host
        if port > 0:
            self.port = port
129
        if timeout != -999:
130
            self.timeout = timeout
131 132
        self.sock = socket.create_connection((self.host, self.port), self.timeout)
        self.af = self.sock.family
133 134 135
        self.file = self.sock.makefile('rb')
        self.welcome = self.getresp()
        return self.welcome
Tim Peters's avatar
Tim Peters committed
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165

    def getwelcome(self):
        '''Get the welcome message from the server.
        (this is read and squirreled away by connect())'''
        if self.debugging:
            print '*welcome*', self.sanitize(self.welcome)
        return self.welcome

    def set_debuglevel(self, level):
        '''Set the debugging level.
        The required argument level means:
        0: no debugging output (default)
        1: print commands and responses but not body text etc.
        2: also print raw lines read and sent before stripping CR/LF'''
        self.debugging = level
    debug = set_debuglevel

    def set_pasv(self, val):
        '''Use passive or active mode for data transfers.
        With a false argument, use the normal PORT mode,
        With a true argument, use the PASV command.'''
        self.passiveserver = val

    # Internal: "sanitize" a string for printing
    def sanitize(self, s):
        if s[:5] == 'pass ' or s[:5] == 'PASS ':
            i = len(s)
            while i > 5 and s[i-1] in '\r\n':
                i = i-1
            s = s[:5] + '*'*(i-5) + s[i:]
166
        return repr(s)
Tim Peters's avatar
Tim Peters committed
167 168 169 170 171

    # Internal: send one line to the server, appending CRLF
    def putline(self, line):
        line = line + CRLF
        if self.debugging > 1: print '*put*', self.sanitize(line)
172
        self.sock.sendall(line)
Tim Peters's avatar
Tim Peters committed
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212

    # Internal: send one command to the server (through putline())
    def putcmd(self, line):
        if self.debugging: print '*cmd*', self.sanitize(line)
        self.putline(line)

    # Internal: return one line from the server, stripping CRLF.
    # Raise EOFError if the connection is closed
    def getline(self):
        line = self.file.readline()
        if self.debugging > 1:
            print '*get*', self.sanitize(line)
        if not line: raise EOFError
        if line[-2:] == CRLF: line = line[:-2]
        elif line[-1:] in CRLF: line = line[:-1]
        return line

    # Internal: get a response from the server, which may possibly
    # consist of multiple lines.  Return a single string with no
    # trailing CRLF.  If the response consists of multiple lines,
    # these are separated by '\n' characters in the string
    def getmultiline(self):
        line = self.getline()
        if line[3:4] == '-':
            code = line[:3]
            while 1:
                nextline = self.getline()
                line = line + ('\n' + nextline)
                if nextline[:3] == code and \
                        nextline[3:4] != '-':
                    break
        return line

    # Internal: get a response from the server.
    # Raise various errors if the response indicates an error
    def getresp(self):
        resp = self.getmultiline()
        if self.debugging: print '*resp*', self.sanitize(resp)
        self.lastresp = resp[:3]
        c = resp[:1]
213 214
        if c in ('1', '2', '3'):
            return resp
Tim Peters's avatar
Tim Peters committed
215 216 217 218
        if c == '4':
            raise error_temp, resp
        if c == '5':
            raise error_perm, resp
219
        raise error_proto, resp
Tim Peters's avatar
Tim Peters committed
220 221 222 223

    def voidresp(self):
        """Expect a response beginning with '2'."""
        resp = self.getresp()
224
        if resp[:1] != '2':
Tim Peters's avatar
Tim Peters committed
225 226 227 228 229 230 231 232 233 234
            raise error_reply, resp
        return resp

    def abort(self):
        '''Abort a file transfer.  Uses out-of-band data.
        This does not follow the procedure from the RFC to send Telnet
        IP and Synch; that doesn't seem to work with the servers I've
        tried.  Instead, just send the ABOR command as OOB data.'''
        line = 'ABOR' + CRLF
        if self.debugging > 1: print '*put urgent*', self.sanitize(line)
235
        self.sock.sendall(line, MSG_OOB)
Tim Peters's avatar
Tim Peters committed
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
        resp = self.getmultiline()
        if resp[:3] not in ('426', '226'):
            raise error_proto, resp

    def sendcmd(self, cmd):
        '''Send a command and return the response.'''
        self.putcmd(cmd)
        return self.getresp()

    def voidcmd(self, cmd):
        """Send a command and expect a response beginning with '2'."""
        self.putcmd(cmd)
        return self.voidresp()

    def sendport(self, host, port):
        '''Send a PORT command with the current host and the given
        port number.
        '''
254
        hbytes = host.split('.')
255
        pbytes = [repr(port//256), repr(port%256)]
Tim Peters's avatar
Tim Peters committed
256
        bytes = hbytes + pbytes
257
        cmd = 'PORT ' + ','.join(bytes)
Tim Peters's avatar
Tim Peters committed
258 259
        return self.voidcmd(cmd)

260
    def sendeprt(self, host, port):
261 262 263 264 265 266 267 268
        '''Send a EPRT command with the current host and the given port number.'''
        af = 0
        if self.af == socket.AF_INET:
            af = 1
        if self.af == socket.AF_INET6:
            af = 2
        if af == 0:
            raise error_proto, 'unsupported address family'
269
        fields = ['', repr(af), host, repr(port), '']
270
        cmd = 'EPRT ' + '|'.join(fields)
271
        return self.voidcmd(cmd)
272

Tim Peters's avatar
Tim Peters committed
273
    def makeport(self):
274
        '''Create a new socket and send a PORT command for it.'''
275
        msg = "getaddrinfo returns an empty list"
276
        sock = None
277 278 279 280 281 282
        for res in socket.getaddrinfo(None, 0, self.af, socket.SOCK_STREAM, 0, socket.AI_PASSIVE):
            af, socktype, proto, canonname, sa = res
            try:
                sock = socket.socket(af, socktype, proto)
                sock.bind(sa)
            except socket.error, msg:
283 284
                if sock:
                    sock.close()
285 286 287 288 289 290 291 292 293 294 295 296 297
                sock = None
                continue
            break
        if not sock:
            raise socket.error, msg
        sock.listen(1)
        port = sock.getsockname()[1] # Get proper port
        host = self.sock.getsockname()[0] # Get proper host
        if self.af == socket.AF_INET:
            resp = self.sendport(host, port)
        else:
            resp = self.sendeprt(host, port)
        return sock
298 299

    def makepasv(self):
300 301 302 303 304
        if self.af == socket.AF_INET:
            host, port = parse227(self.sendcmd('PASV'))
        else:
            host, port = parse229(self.sendcmd('EPSV'), self.sock.getpeername())
        return host, port
Tim Peters's avatar
Tim Peters committed
305 306 307 308 309 310 311 312 313 314 315 316

    def ntransfercmd(self, cmd, rest=None):
        """Initiate a transfer over the data connection.

        If the transfer is active, send a port command and the
        transfer command, and accept the connection.  If the server is
        passive, send a pasv command, connect to it, and start the
        transfer command.  Either way, return the socket for the
        connection and the expected size of the transfer.  The
        expected size may be None if it could not be determined.

        Optional `rest' argument can be a string that is sent as the
317
        argument to a REST command.  This is essentially a server
Tim Peters's avatar
Tim Peters committed
318 319 320 321 322
        marker used to tell the server to skip over any data up to the
        given marker.
        """
        size = None
        if self.passiveserver:
323
            host, port = self.makepasv()
324
            conn = socket.create_connection((host, port), self.timeout)
Tim Peters's avatar
Tim Peters committed
325 326 327
            if rest is not None:
                self.sendcmd("REST %s" % rest)
            resp = self.sendcmd(cmd)
328 329 330 331 332 333 334
            # Some servers apparently send a 200 reply to
            # a LIST or STOR command, before the 150 reply
            # (and way before the 226 reply). This seems to
            # be in violation of the protocol (which only allows
            # 1xx or error messages for LIST), so we just discard
            # this response.
            if resp[0] == '2':
Tim Peters's avatar
Tim Peters committed
335
                resp = self.getresp()
Tim Peters's avatar
Tim Peters committed
336 337 338 339 340 341 342
            if resp[0] != '1':
                raise error_reply, resp
        else:
            sock = self.makeport()
            if rest is not None:
                self.sendcmd("REST %s" % rest)
            resp = self.sendcmd(cmd)
343 344
            # See above.
            if resp[0] == '2':
Tim Peters's avatar
Tim Peters committed
345
                resp = self.getresp()
Tim Peters's avatar
Tim Peters committed
346 347 348 349 350 351 352 353 354
            if resp[0] != '1':
                raise error_reply, resp
            conn, sockaddr = sock.accept()
        if resp[:3] == '150':
            # this is conditional in case we received a 125
            size = parse150(resp)
        return conn, size

    def transfercmd(self, cmd, rest=None):
355
        """Like ntransfercmd() but returns only the socket."""
Tim Peters's avatar
Tim Peters committed
356 357 358 359 360 361 362 363
        return self.ntransfercmd(cmd, rest)[0]

    def login(self, user = '', passwd = '', acct = ''):
        '''Login, default anonymous.'''
        if not user: user = 'anonymous'
        if not passwd: passwd = ''
        if not acct: acct = ''
        if user == 'anonymous' and passwd in ('', '-'):
Tim Peters's avatar
Tim Peters committed
364 365 366 367 368 369 370
            # If there is no anonymous ftp password specified
            # then we'll just use anonymous@
            # We don't send any other thing because:
            # - We want to remain anonymous
            # - We want to stop SPAM
            # - We don't want to let ftp sites to discriminate by the user,
            #   host or country.
371
            passwd = passwd + 'anonymous@'
Tim Peters's avatar
Tim Peters committed
372 373 374 375 376 377 378 379
        resp = self.sendcmd('USER ' + user)
        if resp[0] == '3': resp = self.sendcmd('PASS ' + passwd)
        if resp[0] == '3': resp = self.sendcmd('ACCT ' + acct)
        if resp[0] != '2':
            raise error_reply, resp
        return resp

    def retrbinary(self, cmd, callback, blocksize=8192, rest=None):
380 381 382 383 384 385 386 387 388 389 390 391
        """Retrieve data in binary mode.  A new port is created for you.

        Args:
          cmd: A RETR command.
          callback: A single parameter callable to be called on each
                    block of data read.
          blocksize: The maximum number of bytes to read from the
                     socket at one time.  [default: 8192]
          rest: Passed to transfercmd().  [default: None]

        Returns:
          The response code.
Tim Peters's avatar
Tim Peters committed
392 393 394 395 396 397 398 399 400 401 402 403
        """
        self.voidcmd('TYPE I')
        conn = self.transfercmd(cmd, rest)
        while 1:
            data = conn.recv(blocksize)
            if not data:
                break
            callback(data)
        conn.close()
        return self.voidresp()

    def retrlines(self, cmd, callback = None):
404 405 406
        """Retrieve data in line mode.  A new port is created for you.

        Args:
407
          cmd: A RETR, LIST, NLST, or MLSD command.
408 409 410 411 412 413 414
          callback: An optional single parameter callable that is called
                    for each line with the trailing CRLF stripped.
                    [default: print_line()]

        Returns:
          The response code.
        """
415
        if callback is None: callback = print_line
Tim Peters's avatar
Tim Peters committed
416 417 418 419 420
        resp = self.sendcmd('TYPE A')
        conn = self.transfercmd(cmd)
        fp = conn.makefile('rb')
        while 1:
            line = fp.readline()
421
            if self.debugging > 2: print '*retr*', repr(line)
Tim Peters's avatar
Tim Peters committed
422 423 424 425 426 427 428 429 430 431 432
            if not line:
                break
            if line[-2:] == CRLF:
                line = line[:-2]
            elif line[-1:] == '\n':
                line = line[:-1]
            callback(line)
        fp.close()
        conn.close()
        return self.voidresp()

433 434 435 436 437 438 439 440 441 442 443 444 445 446
    def storbinary(self, cmd, fp, blocksize=8192, callback=None):
        """Store a file in binary mode.  A new port is created for you.

        Args:
          cmd: A STOR command.
          fp: A file-like object with a read(num_bytes) method.
          blocksize: The maximum data size to read from fp and send over
                     the connection at once.  [default: 8192]
          callback: An optional single parameter callable that is called on
                    on each block of data after it is sent.  [default: None]

        Returns:
          The response code.
        """
Tim Peters's avatar
Tim Peters committed
447 448 449 450 451
        self.voidcmd('TYPE I')
        conn = self.transfercmd(cmd)
        while 1:
            buf = fp.read(blocksize)
            if not buf: break
452
            conn.sendall(buf)
453
            if callback: callback(buf)
Tim Peters's avatar
Tim Peters committed
454 455 456
        conn.close()
        return self.voidresp()

457 458 459 460 461 462 463 464 465 466 467 468
    def storlines(self, cmd, fp, callback=None):
        """Store a file in line mode.  A new port is created for you.

        Args:
          cmd: A STOR command.
          fp: A file-like object with a readline() method.
          callback: An optional single parameter callable that is called on
                    on each line after it is sent.  [default: None]

        Returns:
          The response code.
        """
Tim Peters's avatar
Tim Peters committed
469 470 471 472 473 474 475 476
        self.voidcmd('TYPE A')
        conn = self.transfercmd(cmd)
        while 1:
            buf = fp.readline()
            if not buf: break
            if buf[-2:] != CRLF:
                if buf[-1] in CRLF: buf = buf[:-1]
                buf = buf + CRLF
477
            conn.sendall(buf)
478
            if callback: callback(buf)
Tim Peters's avatar
Tim Peters committed
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
        conn.close()
        return self.voidresp()

    def acct(self, password):
        '''Send new account name.'''
        cmd = 'ACCT ' + password
        return self.voidcmd(cmd)

    def nlst(self, *args):
        '''Return a list of files in a given directory (default the current).'''
        cmd = 'NLST'
        for arg in args:
            cmd = cmd + (' ' + arg)
        files = []
        self.retrlines(cmd, files.append)
        return files

    def dir(self, *args):
        '''List a directory in long form.
        By default list current directory to stdout.
        Optional last argument is callback function; all
        non-empty arguments before it are concatenated to the
        LIST command.  (This *should* only be used for a pathname.)'''
        cmd = 'LIST'
        func = None
        if args[-1:] and type(args[-1]) != type(''):
            args, func = args[:-1], args[-1]
        for arg in args:
            if arg:
                cmd = cmd + (' ' + arg)
        self.retrlines(cmd, func)

    def rename(self, fromname, toname):
        '''Rename a file.'''
        resp = self.sendcmd('RNFR ' + fromname)
        if resp[0] != '3':
            raise error_reply, resp
        return self.voidcmd('RNTO ' + toname)

    def delete(self, filename):
        '''Delete a file.'''
        resp = self.sendcmd('DELE ' + filename)
        if resp[:3] in ('250', '200'):
            return resp
        else:
            raise error_reply, resp

    def cwd(self, dirname):
        '''Change to a directory.'''
        if dirname == '..':
            try:
                return self.voidcmd('CDUP')
            except error_perm, msg:
532 533
                if msg.args[0][:3] != '500':
                    raise
Tim Peters's avatar
Tim Peters committed
534 535 536 537 538 539 540
        elif dirname == '':
            dirname = '.'  # does nothing, but could return error
        cmd = 'CWD ' + dirname
        return self.voidcmd(cmd)

    def size(self, filename):
        '''Retrieve the size of a file.'''
541
        # The SIZE command is defined in RFC-3659
Tim Peters's avatar
Tim Peters committed
542 543
        resp = self.sendcmd('SIZE ' + filename)
        if resp[:3] == '213':
544 545 546
            s = resp[3:].strip()
            try:
                return int(s)
547
            except (OverflowError, ValueError):
548
                return long(s)
Tim Peters's avatar
Tim Peters committed
549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571

    def mkd(self, dirname):
        '''Make a directory, return its full pathname.'''
        resp = self.sendcmd('MKD ' + dirname)
        return parse257(resp)

    def rmd(self, dirname):
        '''Remove a directory.'''
        return self.voidcmd('RMD ' + dirname)

    def pwd(self):
        '''Return current working directory.'''
        resp = self.sendcmd('PWD')
        return parse257(resp)

    def quit(self):
        '''Quit, and close the connection.'''
        resp = self.voidcmd('QUIT')
        self.close()
        return resp

    def close(self):
        '''Close the connection without assuming anything about it.'''
572 573 574 575
        if self.file:
            self.file.close()
            self.sock.close()
            self.file = self.sock = None
576 577


578
_150_re = None
579 580

def parse150(resp):
Tim Peters's avatar
Tim Peters committed
581 582 583 584 585 586 587 588 589 590 591
    '''Parse the '150' response for a RETR request.
    Returns the expected transfer size or None; size is not guaranteed to
    be present in the 150 message.
    '''
    if resp[:3] != '150':
        raise error_reply, resp
    global _150_re
    if _150_re is None:
        import re
        _150_re = re.compile("150 .* \((\d+) bytes\)", re.IGNORECASE)
    m = _150_re.match(resp)
592 593 594 595 596
    if not m:
        return None
    s = m.group(1)
    try:
        return int(s)
597
    except (OverflowError, ValueError):
598
        return long(s)
599 600


601 602
_227_re = None

603
def parse227(resp):
Tim Peters's avatar
Tim Peters committed
604 605 606 607 608 609
    '''Parse the '227' response for a PASV request.
    Raises error_proto if it does not contain '(h1,h2,h3,h4,p1,p2)'
    Return ('host.addr.as.numbers', port#) tuple.'''

    if resp[:3] != '227':
        raise error_reply, resp
610 611 612 613 614 615
    global _227_re
    if _227_re is None:
        import re
        _227_re = re.compile(r'(\d+),(\d+),(\d+),(\d+),(\d+),(\d+)')
    m = _227_re.search(resp)
    if not m:
Tim Peters's avatar
Tim Peters committed
616
        raise error_proto, resp
617
    numbers = m.groups()
618 619
    host = '.'.join(numbers[:4])
    port = (int(numbers[4]) << 8) + int(numbers[5])
Tim Peters's avatar
Tim Peters committed
620
    return host, port
621 622


623 624 625 626 627
def parse229(resp, peer):
    '''Parse the '229' response for a EPSV request.
    Raises error_proto if it does not contain '(|||port|)'
    Return ('host.addr.as.numbers', port#) tuple.'''

628
    if resp[:3] != '229':
629
        raise error_reply, resp
630
    left = resp.find('(')
631
    if left < 0: raise error_proto, resp
632
    right = resp.find(')', left + 1)
633
    if right < 0:
634
        raise error_proto, resp # should contain '(|||port|)'
635
    if resp[left + 1] != resp[right - 1]:
636
        raise error_proto, resp
637
    parts = resp[left + 1:right].split(resp[left+1])
638
    if len(parts) != 5:
639
        raise error_proto, resp
640
    host = peer[0]
641
    port = int(parts[3])
642 643 644
    return host, port


645
def parse257(resp):
Tim Peters's avatar
Tim Peters committed
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
    '''Parse the '257' response for a MKD or PWD request.
    This is a response to a MKD or PWD request: a directory name.
    Returns the directoryname in the 257 reply.'''

    if resp[:3] != '257':
        raise error_reply, resp
    if resp[3:5] != ' "':
        return '' # Not compliant to RFC 959, but UNIX ftpd does this
    dirname = ''
    i = 5
    n = len(resp)
    while i < n:
        c = resp[i]
        i = i+1
        if c == '"':
            if i >= n or resp[i] != '"':
                break
            i = i+1
        dirname = dirname + c
    return dirname
Guido van Rossum's avatar
Guido van Rossum committed
666

667

668
def print_line(line):
Tim Peters's avatar
Tim Peters committed
669 670
    '''Default retrlines callback to print a line.'''
    print line
671

672

673
def ftpcp(source, sourcename, target, targetname = '', type = 'I'):
Tim Peters's avatar
Tim Peters committed
674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691
    '''Copy file from one FTP-instance to another.'''
    if not targetname: targetname = sourcename
    type = 'TYPE ' + type
    source.voidcmd(type)
    target.voidcmd(type)
    sourcehost, sourceport = parse227(source.sendcmd('PASV'))
    target.sendport(sourcehost, sourceport)
    # RFC 959: the user must "listen" [...] BEFORE sending the
    # transfer request.
    # So: STOR before RETR, because here the target is a "user".
    treply = target.sendcmd('STOR ' + targetname)
    if treply[:3] not in ('125', '150'): raise error_proto  # RFC 959
    sreply = source.sendcmd('RETR ' + sourcename)
    if sreply[:3] not in ('125', '150'): raise error_proto  # RFC 959
    source.voidresp()
    target.voidresp()


692
class Netrc:
Tim Peters's avatar
Tim Peters committed
693 694 695 696 697 698 699 700 701 702 703 704
    """Class to parse & provide access to 'netrc' format files.

    See the netrc(4) man page for information on the file format.

    WARNING: This class is obsolete -- use module netrc instead.

    """
    __defuser = None
    __defpasswd = None
    __defacct = None

    def __init__(self, filename=None):
705
        if filename is None:
706
            if "HOME" in os.environ:
Tim Peters's avatar
Tim Peters committed
707 708 709 710 711 712 713 714 715 716 717 718
                filename = os.path.join(os.environ["HOME"],
                                        ".netrc")
            else:
                raise IOError, \
                      "specify file to load or set $HOME"
        self.__hosts = {}
        self.__macros = {}
        fp = open(filename, "r")
        in_macro = 0
        while 1:
            line = fp.readline()
            if not line: break
719
            if in_macro and line.strip():
Tim Peters's avatar
Tim Peters committed
720 721 722 723 724
                macro_lines.append(line)
                continue
            elif in_macro:
                self.__macros[macro_name] = tuple(macro_lines)
                in_macro = 0
725
            words = line.split()
Tim Peters's avatar
Tim Peters committed
726 727 728 729 730 731 732 733 734 735 736 737
            host = user = passwd = acct = None
            default = 0
            i = 0
            while i < len(words):
                w1 = words[i]
                if i+1 < len(words):
                    w2 = words[i + 1]
                else:
                    w2 = None
                if w1 == 'default':
                    default = 1
                elif w1 == 'machine' and w2:
738
                    host = w2.lower()
Tim Peters's avatar
Tim Peters committed
739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
                    i = i + 1
                elif w1 == 'login' and w2:
                    user = w2
                    i = i + 1
                elif w1 == 'password' and w2:
                    passwd = w2
                    i = i + 1
                elif w1 == 'account' and w2:
                    acct = w2
                    i = i + 1
                elif w1 == 'macdef' and w2:
                    macro_name = w2
                    macro_lines = []
                    in_macro = 1
                    break
                i = i + 1
            if default:
                self.__defuser = user or self.__defuser
                self.__defpasswd = passwd or self.__defpasswd
                self.__defacct = acct or self.__defacct
            if host:
760
                if host in self.__hosts:
Tim Peters's avatar
Tim Peters committed
761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779
                    ouser, opasswd, oacct = \
                           self.__hosts[host]
                    user = user or ouser
                    passwd = passwd or opasswd
                    acct = acct or oacct
                self.__hosts[host] = user, passwd, acct
        fp.close()

    def get_hosts(self):
        """Return a list of hosts mentioned in the .netrc file."""
        return self.__hosts.keys()

    def get_account(self, host):
        """Returns login information for the named host.

        The return value is a triple containing userid,
        password, and the accounting field.

        """
780
        host = host.lower()
Tim Peters's avatar
Tim Peters committed
781
        user = passwd = acct = None
782
        if host in self.__hosts:
Tim Peters's avatar
Tim Peters committed
783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798
            user, passwd, acct = self.__hosts[host]
        user = user or self.__defuser
        passwd = passwd or self.__defpasswd
        acct = acct or self.__defacct
        return user, passwd, acct

    def get_macros(self):
        """Return a list of all defined macro names."""
        return self.__macros.keys()

    def get_macro(self, macro):
        """Return a sequence of lines which define a named macro."""
        return self.__macros[macro]



Guido van Rossum's avatar
Guido van Rossum committed
799
def test():
Tim Peters's avatar
Tim Peters committed
800
    '''Test program.
801 802 803 804 805 806 807 808 809 810
    Usage: ftp [-d] [-r[file]] host [-l[dir]] [-d[dir]] [-p] [file] ...

    -d dir
    -l list
    -p password
    '''

    if len(sys.argv) < 2:
        print test.__doc__
        sys.exit(0)
Tim Peters's avatar
Tim Peters committed
811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851

    debugging = 0
    rcfile = None
    while sys.argv[1] == '-d':
        debugging = debugging+1
        del sys.argv[1]
    if sys.argv[1][:2] == '-r':
        # get name of alternate ~/.netrc file:
        rcfile = sys.argv[1][2:]
        del sys.argv[1]
    host = sys.argv[1]
    ftp = FTP(host)
    ftp.set_debuglevel(debugging)
    userid = passwd = acct = ''
    try:
        netrc = Netrc(rcfile)
    except IOError:
        if rcfile is not None:
            sys.stderr.write("Could not open account file"
                             " -- using anonymous login.")
    else:
        try:
            userid, passwd, acct = netrc.get_account(host)
        except KeyError:
            # no account for host
            sys.stderr.write(
                    "No account -- using anonymous login.")
    ftp.login(userid, passwd, acct)
    for file in sys.argv[2:]:
        if file[:2] == '-l':
            ftp.dir(file[2:])
        elif file[:2] == '-d':
            cmd = 'CWD'
            if file[2:]: cmd = cmd + ' ' + file[2:]
            resp = ftp.sendcmd(cmd)
        elif file == '-p':
            ftp.set_pasv(not ftp.passiveserver)
        else:
            ftp.retrbinary('RETR ' + file, \
                           sys.stdout.write, 1024)
    ftp.quit()
852 853 854


if __name__ == '__main__':
Tim Peters's avatar
Tim Peters committed
855
    test()