Mercurial > cpython-lru_cache-weakref

annotate Lib/ftplib.py @ 58925:eecf1bef052d 2.6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Merged revisions 78207 via svnmerge from svn+ssh://pythondev@svn.python.org/python/trunk ........ r78207 | ezio.melotti | 2010-02-17 01:26:09 +0200 (Wed, 17 Feb 2010) | 1 line #7930: fix stripid ........
author Ezio Melotti <ezio.melotti@gmail.com>
date Tue, 16 Feb 2010 23:29:44 +0000
parents 587a2aed39f2
children a7e69a5f2337 836642240464
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11708
4a23cc49e2b0 Actually, the previous batch's comment should have been different;
Guido van Rossum <guido@python.org>
parents: 11205
diff changeset
1 """An FTP client class and some helper functions.
4a23cc49e2b0 Actually, the previous batch's comment should have been different;
Guido van Rossum <guido@python.org>
parents: 11205
diff changeset
2
14338
057c7ceb92f0 Added support for RFC 959's REST command (restart), closing SF patch
Barry Warsaw <barry@python.org>
parents: 14022
diff changeset
3 Based on RFC 959: File Transfer Protocol (FTP), by J. Postel and J. Reynolds
1085
965aa3b53a9d Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
4
3649
63cdfbb4a2bb Docstringified and PASV support by Siebren (including new ftpcp() function).
Guido van Rossum <guido@python.org>
parents: 3398
diff changeset
5 Example:
63cdfbb4a2bb Docstringified and PASV support by Siebren (including new ftpcp() function).
Guido van Rossum <guido@python.org>
parents: 3398
diff changeset
6
63cdfbb4a2bb Docstringified and PASV support by Siebren (including new ftpcp() function).
Guido van Rossum <guido@python.org>
parents: 3398
diff changeset
7 >>> from ftplib import FTP
63cdfbb4a2bb Docstringified and PASV support by Siebren (including new ftpcp() function).
Guido van Rossum <guido@python.org>
parents: 3398
diff changeset
8 >>> ftp = FTP('ftp.python.org') # connect to host, default port
21583
ec623047073a Update the docstring too. :-)
Guido van Rossum <guido@python.org>
parents: 21582
diff changeset
9 >>> ftp.login() # default, i.e.: user anonymous, passwd anonymous@
6426
068254fe5617 Return the error code from most commands, rather than swallowing it.
Guido van Rossum <guido@python.org>
parents: 5753
diff changeset
10 '230 Guest login ok, access restrictions apply.'
3649
63cdfbb4a2bb Docstringified and PASV support by Siebren (including new ftpcp() function).
Guido van Rossum <guido@python.org>
parents: 3398
diff changeset
11 >>> ftp.retrlines('LIST') # list directory contents
63cdfbb4a2bb Docstringified and PASV support by Siebren (including new ftpcp() function).
Guido van Rossum <guido@python.org>
parents: 3398
diff changeset
12 total 9
63cdfbb4a2bb Docstringified and PASV support by Siebren (including new ftpcp() function).
Guido van Rossum <guido@python.org>
parents: 3398
diff changeset
13 drwxr-xr-x 8 root wheel 1024 Jan 3 1994 .
63cdfbb4a2bb Docstringified and PASV support by Siebren (including new ftpcp() function).
Guido van Rossum <guido@python.org>
parents: 3398
diff changeset
14 drwxr-xr-x 8 root wheel 1024 Jan 3 1994 ..
63cdfbb4a2bb Docstringified and PASV support by Siebren (including new ftpcp() function).
Guido van Rossum <guido@python.org>
parents: 3398
diff changeset
15 drwxr-xr-x 2 root wheel 1024 Jan 3 1994 bin
63cdfbb4a2bb Docstringified and PASV support by Siebren (including new ftpcp() function).
Guido van Rossum <guido@python.org>
parents: 3398
diff changeset
16 drwxr-xr-x 2 root wheel 1024 Jan 3 1994 etc
63cdfbb4a2bb Docstringified and PASV support by Siebren (including new ftpcp() function).
Guido van Rossum <guido@python.org>
parents: 3398
diff changeset
17 d-wxrwxr-x 2 ftp wheel 1024 Sep 5 13:43 incoming
63cdfbb4a2bb Docstringified and PASV support by Siebren (including new ftpcp() function).
Guido van Rossum <guido@python.org>
parents: 3398
diff changeset
18 drwxr-xr-x 2 root wheel 1024 Nov 17 1993 lib
63cdfbb4a2bb Docstringified and PASV support by Siebren (including new ftpcp() function).
Guido van Rossum <guido@python.org>
parents: 3398
diff changeset
19 drwxr-xr-x 6 1094 wheel 1024 Sep 13 19:07 pub
63cdfbb4a2bb Docstringified and PASV support by Siebren (including new ftpcp() function).
Guido van Rossum <guido@python.org>
parents: 3398
diff changeset
20 drwxr-xr-x 3 root wheel 1024 Jan 3 1994 usr
63cdfbb4a2bb Docstringified and PASV support by Siebren (including new ftpcp() function).
Guido van Rossum <guido@python.org>
parents: 3398
diff changeset
21 -rw-r--r-- 1 root root 312 Aug 1 1994 welcome.msg
6426
068254fe5617 Return the error code from most commands, rather than swallowing it.
Guido van Rossum <guido@python.org>
parents: 5753
diff changeset
22 '226 Transfer complete.'
3649
63cdfbb4a2bb Docstringified and PASV support by Siebren (including new ftpcp() function).
Guido van Rossum <guido@python.org>
parents: 3398
diff changeset
23 >>> ftp.quit()
6426
068254fe5617 Return the error code from most commands, rather than swallowing it.
Guido van Rossum <guido@python.org>
parents: 5753
diff changeset
24 '221 Goodbye.'
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
25 >>>
3649
63cdfbb4a2bb Docstringified and PASV support by Siebren (including new ftpcp() function).
Guido van Rossum <guido@python.org>
parents: 3398
diff changeset
26
63cdfbb4a2bb Docstringified and PASV support by Siebren (including new ftpcp() function).
Guido van Rossum <guido@python.org>
parents: 3398
diff changeset
27 A nice test that reveals some of the network dialogue would be:
63cdfbb4a2bb Docstringified and PASV support by Siebren (including new ftpcp() function).
Guido van Rossum <guido@python.org>
parents: 3398
diff changeset
28 python ftplib.py -d localhost -l -p -l
11708
4a23cc49e2b0 Actually, the previous batch's comment should have been different;
Guido van Rossum <guido@python.org>
parents: 11205
diff changeset
29 """
1087
b9e4f7321e28 Added much functionality, changed some names (errors, login).
Guido van Rossum <guido@python.org>
parents: 1085
diff changeset
30
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
31 #
11870
d7eca5b0960a Simple changes by Gerrit Holl - move author acknowledgements out of
Guido van Rossum <guido@python.org>
parents: 11708
diff changeset
32 # Changes and improvements suggested by Steve Majewski.
d7eca5b0960a Simple changes by Gerrit Holl - move author acknowledgements out of
Guido van Rossum <guido@python.org>
parents: 11708
diff changeset
33 # Modified by Jack to work on the mac.
d7eca5b0960a Simple changes by Gerrit Holl - move author acknowledgements out of
Guido van Rossum <guido@python.org>
parents: 11708
diff changeset
34 # Modified by Siebren to support docstrings and PASV.
44868
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
35 # Modified by Phil Schwartz to add storbinary and storlines callbacks.
11870
d7eca5b0960a Simple changes by Gerrit Holl - move author acknowledgements out of
Guido van Rossum <guido@python.org>
parents: 11708
diff changeset
36 #
1087
b9e4f7321e28 Added much functionality, changed some names (errors, login).
Guido van Rossum <guido@python.org>
parents: 1085
diff changeset
37
1085
965aa3b53a9d Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
38 import os
965aa3b53a9d Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
39 import sys
965aa3b53a9d Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
40
1746
1940892d2fe3 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1435
diff changeset
41 # Import SOCKS module if it exists, else standard socket module socket
1940892d2fe3 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1435
diff changeset
42 try:
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
43 import SOCKS; socket = SOCKS; del SOCKS # import SOCKS as socket
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
44 from socket import getfqdn; socket.getfqdn = getfqdn; del getfqdn
1746
1940892d2fe3 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1435
diff changeset
45 except ImportError:
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
46 import socket
47372
e2c5ae30cffe Fixed the semantic of timeout for socket.create_connection and
Facundo Batista <facundobatista@gmail.com>
parents: 46413
diff changeset
47 from socket import _GLOBAL_DEFAULT_TIMEOUT
1746
1940892d2fe3 Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1435
diff changeset
48
16072
bae889f44cd1 more __all__ updates
Skip Montanaro <skip@pobox.com>
parents: 15881
diff changeset
49 __all__ = ["FTP","Netrc"]
1085
965aa3b53a9d Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
50
1291
517d29ebc840 * ftplib.py: added abort() command (sends oob data).
Guido van Rossum <guido@python.org>
parents: 1286
diff changeset
51 # Magic number from <socket.h>
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
52 MSG_OOB = 0x1 # Process data out of band
1291
517d29ebc840 * ftplib.py: added abort() command (sends oob data).
Guido van Rossum <guido@python.org>
parents: 1286
diff changeset
53
517d29ebc840 * ftplib.py: added abort() command (sends oob data).
Guido van Rossum <guido@python.org>
parents: 1286
diff changeset
54
1087
b9e4f7321e28 Added much functionality, changed some names (errors, login).
Guido van Rossum <guido@python.org>
parents: 1085
diff changeset
55 # The standard FTP server control port
1085
965aa3b53a9d Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
56 FTP_PORT = 21
965aa3b53a9d Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
57
965aa3b53a9d Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
58
1089
8d62c9056fe1 Added all_errors, list of all possible exceptions.
Guido van Rossum <guido@python.org>
parents: 1088
diff changeset
59 # Exception raised when an error or invalid response is received
14022
d44603f2b928 Convert some old-style string exceptions to class exceptions.
Fred Drake <fdrake@acm.org>
parents: 14014
diff changeset
60 class Error(Exception): pass
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
61 class error_reply(Error): pass # unexpected [123]xx reply
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
62 class error_temp(Error): pass # 4xx errors
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
63 class error_perm(Error): pass # 5xx errors
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
64 class error_proto(Error): pass # response does not begin with [1-5]
1085
965aa3b53a9d Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
65
965aa3b53a9d Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
66
1089
8d62c9056fe1 Added all_errors, list of all possible exceptions.
Guido van Rossum <guido@python.org>
parents: 1088
diff changeset
67 # All exceptions (hopefully) that may be raised here and that aren't
8d62c9056fe1 Added all_errors, list of all possible exceptions.
Guido van Rossum <guido@python.org>
parents: 1088
diff changeset
68 # (always) programming errors on our side
46413
2a9858255de1 socket.error inherits from IOError, it no longer needs listing in
Gregory P. Smith <greg@mad-scientist.com>
parents: 44880
diff changeset
69 all_errors = (Error, IOError, EOFError)
1089
8d62c9056fe1 Added all_errors, list of all possible exceptions.
Guido van Rossum <guido@python.org>
parents: 1088
diff changeset
70
8d62c9056fe1 Added all_errors, list of all possible exceptions.
Guido van Rossum <guido@python.org>
parents: 1088
diff changeset
71
1085
965aa3b53a9d Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
72 # Line terminators (we always output CRLF, but accept any of CRLF, CR, LF)
965aa3b53a9d Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
73 CRLF = '\r\n'
965aa3b53a9d Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
74
965aa3b53a9d Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
75 # The class itself
965aa3b53a9d Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
76 class FTP:
965aa3b53a9d Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
77
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
78 '''An FTP client class.
3649
63cdfbb4a2bb Docstringified and PASV support by Siebren (including new ftpcp() function).
Guido van Rossum <guido@python.org>
parents: 3398
diff changeset
79
41306
03d5db8325f4 Forgot to add the file before the previous commit, here go
Facundo Batista <facundobatista@gmail.com>
parents: 40732
diff changeset
80 To create a connection, call the class using these arguments:
03d5db8325f4 Forgot to add the file before the previous commit, here go
Facundo Batista <facundobatista@gmail.com>
parents: 40732
diff changeset
81 host, user, passwd, acct, timeout
03d5db8325f4 Forgot to add the file before the previous commit, here go
Facundo Batista <facundobatista@gmail.com>
parents: 40732
diff changeset
82
03d5db8325f4 Forgot to add the file before the previous commit, here go
Facundo Batista <facundobatista@gmail.com>
parents: 40732
diff changeset
83 The first four arguments are all strings, and have default value ''.
03d5db8325f4 Forgot to add the file before the previous commit, here go
Facundo Batista <facundobatista@gmail.com>
parents: 40732
diff changeset
84 timeout must be numeric and defaults to None if not passed,
03d5db8325f4 Forgot to add the file before the previous commit, here go
Facundo Batista <facundobatista@gmail.com>
parents: 40732
diff changeset
85 meaning that no timeout will be set on any ftp socket(s)
03d5db8325f4 Forgot to add the file before the previous commit, here go
Facundo Batista <facundobatista@gmail.com>
parents: 40732
diff changeset
86 If a timeout is passed, then this is now the default timeout for all ftp
03d5db8325f4 Forgot to add the file before the previous commit, here go
Facundo Batista <facundobatista@gmail.com>
parents: 40732
diff changeset
87 socket operations for this instance.
41532
4b9fa8092e82 Whitespace normalization. Ugh, we really need to do this more often.
Neal Norwitz <nnorwitz@gmail.com>
parents: 41326
diff changeset
88
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
89 Then use self.connect() with optional host and port argument.
3649
63cdfbb4a2bb Docstringified and PASV support by Siebren (including new ftpcp() function).
Guido van Rossum <guido@python.org>
parents: 3398
diff changeset
90
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
91 To download a file, use ftp.retrlines('RETR ' + filename),
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
92 or ftp.retrbinary() with slightly different arguments.
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
93 To upload a file, use ftp.storlines() or ftp.storbinary(),
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
94 which have an open file as argument (see their definitions
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
95 below for details).
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
96 The download/upload functions first issue appropriate TYPE
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
97 and PORT or PASV commands.
3649
63cdfbb4a2bb Docstringified and PASV support by Siebren (including new ftpcp() function).
Guido van Rossum <guido@python.org>
parents: 3398
diff changeset
98 '''
63cdfbb4a2bb Docstringified and PASV support by Siebren (including new ftpcp() function).
Guido van Rossum <guido@python.org>
parents: 3398
diff changeset
99
16851
e5f2ab811ec3 Move some constant initialization from FTP.__init__() and FTP.connect()
Fred Drake <fdrake@acm.org>
parents: 16609
diff changeset
100 debugging = 0
e5f2ab811ec3 Move some constant initialization from FTP.__init__() and FTP.connect()
Fred Drake <fdrake@acm.org>
parents: 16609
diff changeset
101 host = ''
e5f2ab811ec3 Move some constant initialization from FTP.__init__() and FTP.connect()
Fred Drake <fdrake@acm.org>
parents: 16609
diff changeset
102 port = FTP_PORT
e5f2ab811ec3 Move some constant initialization from FTP.__init__() and FTP.connect()
Fred Drake <fdrake@acm.org>
parents: 16609
diff changeset
103 sock = None
e5f2ab811ec3 Move some constant initialization from FTP.__init__() and FTP.connect()
Fred Drake <fdrake@acm.org>
parents: 16609
diff changeset
104 file = None
e5f2ab811ec3 Move some constant initialization from FTP.__init__() and FTP.connect()
Fred Drake <fdrake@acm.org>
parents: 16609
diff changeset
105 welcome = None
e5f2ab811ec3 Move some constant initialization from FTP.__init__() and FTP.connect()
Fred Drake <fdrake@acm.org>
parents: 16609
diff changeset
106 passiveserver = 1
e5f2ab811ec3 Move some constant initialization from FTP.__init__() and FTP.connect()
Fred Drake <fdrake@acm.org>
parents: 16609
diff changeset
107
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
108 # Initialization method (called by class instantiation).
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
109 # Initialize host to localhost, port to standard ftp port
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
110 # Optional arguments are host (for connect()),
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
111 # and user, passwd, acct (for login())
47372
e2c5ae30cffe Fixed the semantic of timeout for socket.create_connection and
Facundo Batista <facundobatista@gmail.com>
parents: 46413
diff changeset
112 def __init__(self, host='', user='', passwd='', acct='',
e2c5ae30cffe Fixed the semantic of timeout for socket.create_connection and
Facundo Batista <facundobatista@gmail.com>
parents: 46413
diff changeset
113 timeout=_GLOBAL_DEFAULT_TIMEOUT):
41306
03d5db8325f4 Forgot to add the file before the previous commit, here go
Facundo Batista <facundobatista@gmail.com>
parents: 40732
diff changeset
114 self.timeout = timeout
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
115 if host:
16851
e5f2ab811ec3 Move some constant initialization from FTP.__init__() and FTP.connect()
Fred Drake <fdrake@acm.org>
parents: 16609
diff changeset
116 self.connect(host)
41532
4b9fa8092e82 Whitespace normalization. Ugh, we really need to do this more often.
Neal Norwitz <nnorwitz@gmail.com>
parents: 41326
diff changeset
117 if user:
41306
03d5db8325f4 Forgot to add the file before the previous commit, here go
Facundo Batista <facundobatista@gmail.com>
parents: 40732
diff changeset
118 self.login(user, passwd, acct)
1314
918bee90f73e * calendar.py: minor cleanups
Guido van Rossum <guido@python.org>
parents: 1297
diff changeset
119
47372
e2c5ae30cffe Fixed the semantic of timeout for socket.create_connection and
Facundo Batista <facundobatista@gmail.com>
parents: 46413
diff changeset
120 def connect(self, host='', port=0, timeout=-999):
18834
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
121 '''Connect to host. Arguments are:
41306
03d5db8325f4 Forgot to add the file before the previous commit, here go
Facundo Batista <facundobatista@gmail.com>
parents: 40732
diff changeset
122 - host: hostname to connect to (string, default previous host)
03d5db8325f4 Forgot to add the file before the previous commit, here go
Facundo Batista <facundobatista@gmail.com>
parents: 40732
diff changeset
123 - port: port to connect to (integer, default previous port)
03d5db8325f4 Forgot to add the file before the previous commit, here go
Facundo Batista <facundobatista@gmail.com>
parents: 40732
diff changeset
124 '''
03d5db8325f4 Forgot to add the file before the previous commit, here go
Facundo Batista <facundobatista@gmail.com>
parents: 40732
diff changeset
125 if host != '':
03d5db8325f4 Forgot to add the file before the previous commit, here go
Facundo Batista <facundobatista@gmail.com>
parents: 40732
diff changeset
126 self.host = host
03d5db8325f4 Forgot to add the file before the previous commit, here go
Facundo Batista <facundobatista@gmail.com>
parents: 40732
diff changeset
127 if port > 0:
03d5db8325f4 Forgot to add the file before the previous commit, here go
Facundo Batista <facundobatista@gmail.com>
parents: 40732
diff changeset
128 self.port = port
47372
e2c5ae30cffe Fixed the semantic of timeout for socket.create_connection and
Facundo Batista <facundobatista@gmail.com>
parents: 46413
diff changeset
129 if timeout != -999:
41326
ccdc5b3b9b11 Added the posibility to pass the timeout to FTP.connect, not only when
Facundo Batista <facundobatista@gmail.com>
parents: 41306
diff changeset
130 self.timeout = timeout
41306
03d5db8325f4 Forgot to add the file before the previous commit, here go
Facundo Batista <facundobatista@gmail.com>
parents: 40732
diff changeset
131 self.sock = socket.create_connection((self.host, self.port), self.timeout)
03d5db8325f4 Forgot to add the file before the previous commit, here go
Facundo Batista <facundobatista@gmail.com>
parents: 40732
diff changeset
132 self.af = self.sock.family
18834
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
133 self.file = self.sock.makefile('rb')
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
134 self.welcome = self.getresp()
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
135 return self.welcome
1085
965aa3b53a9d Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
136
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
137 def getwelcome(self):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
138 '''Get the welcome message from the server.
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
139 (this is read and squirreled away by connect())'''
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
140 if self.debugging:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
141 print '*welcome*', self.sanitize(self.welcome)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
142 return self.welcome
1085
965aa3b53a9d Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
143
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
144 def set_debuglevel(self, level):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
145 '''Set the debugging level.
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
146 The required argument level means:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
147 0: no debugging output (default)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
148 1: print commands and responses but not body text etc.
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
149 2: also print raw lines read and sent before stripping CR/LF'''
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
150 self.debugging = level
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
151 debug = set_debuglevel
1085
965aa3b53a9d Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
152
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
153 def set_pasv(self, val):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
154 '''Use passive or active mode for data transfers.
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
155 With a false argument, use the normal PORT mode,
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
156 With a true argument, use the PASV command.'''
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
157 self.passiveserver = val
3649
63cdfbb4a2bb Docstringified and PASV support by Siebren (including new ftpcp() function).
Guido van Rossum <guido@python.org>
parents: 3398
diff changeset
158
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
159 # Internal: "sanitize" a string for printing
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
160 def sanitize(self, s):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
161 if s[:5] == 'pass ' or s[:5] == 'PASS ':
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
162 i = len(s)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
163 while i > 5 and s[i-1] in '\r\n':
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
164 i = i-1
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
165 s = s[:5] + '*'*(i-5) + s[i:]
31515
71a294bd7950 Replace backticks with repr() or "%r"
Walter Dörwald <walter@livinglogic.de>
parents: 23644
diff changeset
166 return repr(s)
2710
b689e6f92f17 don't show print passwords in debug output
Guido van Rossum <guido@python.org>
parents: 2708
diff changeset
167
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
168 # Internal: send one line to the server, appending CRLF
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
169 def putline(self, line):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
170 line = line + CRLF
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
171 if self.debugging > 1: print '*put*', self.sanitize(line)
21962
d3b1f2c0ebcf The Grande 'sendall()' patch, copied from release21-maint. Fixes #516715.
Martin v. Löwis <martin@v.loewis.de>
parents: 21958
diff changeset
172 self.sock.sendall(line)
1085
965aa3b53a9d Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
173
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
174 # Internal: send one command to the server (through putline())
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
175 def putcmd(self, line):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
176 if self.debugging: print '*cmd*', self.sanitize(line)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
177 self.putline(line)
1085
965aa3b53a9d Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
178
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
179 # Internal: return one line from the server, stripping CRLF.
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
180 # Raise EOFError if the connection is closed
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
181 def getline(self):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
182 line = self.file.readline()
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
183 if self.debugging > 1:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
184 print '*get*', self.sanitize(line)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
185 if not line: raise EOFError
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
186 if line[-2:] == CRLF: line = line[:-2]
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
187 elif line[-1:] in CRLF: line = line[:-1]
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
188 return line
1085
965aa3b53a9d Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
189
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
190 # Internal: get a response from the server, which may possibly
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
191 # consist of multiple lines. Return a single string with no
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
192 # trailing CRLF. If the response consists of multiple lines,
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
193 # these are separated by '\n' characters in the string
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
194 def getmultiline(self):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
195 line = self.getline()
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
196 if line[3:4] == '-':
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
197 code = line[:3]
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
198 while 1:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
199 nextline = self.getline()
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
200 line = line + ('\n' + nextline)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
201 if nextline[:3] == code and \
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
202 nextline[3:4] != '-':
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
203 break
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
204 return line
1085
965aa3b53a9d Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
205
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
206 # Internal: get a response from the server.
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
207 # Raise various errors if the response indicates an error
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
208 def getresp(self):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
209 resp = self.getmultiline()
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
210 if self.debugging: print '*resp*', self.sanitize(resp)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
211 self.lastresp = resp[:3]
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
212 c = resp[:1]
35400
9e05ea3b1bf3 Backport 1.74
Raymond Hettinger <python@rcn.com>
parents: 31515
diff changeset
213 if c in ('1', '2', '3'):
9e05ea3b1bf3 Backport 1.74
Raymond Hettinger <python@rcn.com>
parents: 31515
diff changeset
214 return resp
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
215 if c == '4':
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
216 raise error_temp, resp
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
217 if c == '5':
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
218 raise error_perm, resp
35400
9e05ea3b1bf3 Backport 1.74
Raymond Hettinger <python@rcn.com>
parents: 31515
diff changeset
219 raise error_proto, resp
1085
965aa3b53a9d Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
220
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
221 def voidresp(self):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
222 """Expect a response beginning with '2'."""
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
223 resp = self.getresp()
52866
587a2aed39f2 Merged revisions 71217 via svnmerge from
Georg Brandl <georg@python.org>
parents: 49318
diff changeset
224 if resp[:1] != '2':
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
225 raise error_reply, resp
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
226 return resp
1087
b9e4f7321e28 Added much functionality, changed some names (errors, login).
Guido van Rossum <guido@python.org>
parents: 1085
diff changeset
227
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
228 def abort(self):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
229 '''Abort a file transfer. Uses out-of-band data.
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
230 This does not follow the procedure from the RFC to send Telnet
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
231 IP and Synch; that doesn't seem to work with the servers I've
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
232 tried. Instead, just send the ABOR command as OOB data.'''
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
233 line = 'ABOR' + CRLF
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
234 if self.debugging > 1: print '*put urgent*', self.sanitize(line)
21962
d3b1f2c0ebcf The Grande 'sendall()' patch, copied from release21-maint. Fixes #516715.
Martin v. Löwis <martin@v.loewis.de>
parents: 21958
diff changeset
235 self.sock.sendall(line, MSG_OOB)
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
236 resp = self.getmultiline()
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
237 if resp[:3] not in ('426', '226'):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
238 raise error_proto, resp
1291
517d29ebc840 * ftplib.py: added abort() command (sends oob data).
Guido van Rossum <guido@python.org>
parents: 1286
diff changeset
239
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
240 def sendcmd(self, cmd):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
241 '''Send a command and return the response.'''
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
242 self.putcmd(cmd)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
243 return self.getresp()
1085
965aa3b53a9d Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
244
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
245 def voidcmd(self, cmd):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
246 """Send a command and expect a response beginning with '2'."""
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
247 self.putcmd(cmd)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
248 return self.voidresp()
1087
b9e4f7321e28 Added much functionality, changed some names (errors, login).
Guido van Rossum <guido@python.org>
parents: 1085
diff changeset
249
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
250 def sendport(self, host, port):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
251 '''Send a PORT command with the current host and the given
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
252 port number.
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
253 '''
16504
6ffce8be3e0b String method conversion.
Eric S. Raymond <esr@thyrsus.com>
parents: 16072
diff changeset
254 hbytes = host.split('.')
49318
0699a712a3db backport r66656 so people using -Qnew aren't affected
Benjamin Peterson <benjamin@python.org>
parents: 47372
diff changeset
255 pbytes = [repr(port//256), repr(port%256)]
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
256 bytes = hbytes + pbytes
16504
6ffce8be3e0b String method conversion.
Eric S. Raymond <esr@thyrsus.com>
parents: 16072
diff changeset
257 cmd = 'PORT ' + ','.join(bytes)
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
258 return self.voidcmd(cmd)
1085
965aa3b53a9d Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
259
18825
40900620293e Patch #401196: Use getaddrinfo and AF_INET6 in TCP servers and clients.
Martin v. Löwis <martin@v.loewis.de>
parents: 17347
diff changeset
260 def sendeprt(self, host, port):
18834
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
261 '''Send a EPRT command with the current host and the given port number.'''
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
262 af = 0
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
263 if self.af == socket.AF_INET:
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
264 af = 1
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
265 if self.af == socket.AF_INET6:
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
266 af = 2
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
267 if af == 0:
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
268 raise error_proto, 'unsupported address family'
31515
71a294bd7950 Replace backticks with repr() or "%r"
Walter Dörwald <walter@livinglogic.de>
parents: 23644
diff changeset
269 fields = ['', repr(af), host, repr(port), '']
23590
a4bb18212b48 Use string methods where possible, and remove import string
Neal Norwitz <nnorwitz@gmail.com>
parents: 23419
diff changeset
270 cmd = 'EPRT ' + '|'.join(fields)
18834
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
271 return self.voidcmd(cmd)
18825
40900620293e Patch #401196: Use getaddrinfo and AF_INET6 in TCP servers and clients.
Martin v. Löwis <martin@v.loewis.de>
parents: 17347
diff changeset
272
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
273 def makeport(self):
18834
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
274 '''Create a new socket and send a PORT command for it.'''
18902
edf058b16ddf Initialize msg to avoid unbound locals.
Martin v. Löwis <martin@v.loewis.de>
parents: 18834
diff changeset
275 msg = "getaddrinfo returns an empty list"
20303
faec69c11640 Only close sockets if they have been created. Reported by Blake Winton.
Martin v. Löwis <martin@v.loewis.de>
parents: 19341
diff changeset
276 sock = None
18834
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
277 for res in socket.getaddrinfo(None, 0, self.af, socket.SOCK_STREAM, 0, socket.AI_PASSIVE):
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
278 af, socktype, proto, canonname, sa = res
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
279 try:
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
280 sock = socket.socket(af, socktype, proto)
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
281 sock.bind(sa)
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
282 except socket.error, msg:
20303
faec69c11640 Only close sockets if they have been created. Reported by Blake Winton.
Martin v. Löwis <martin@v.loewis.de>
parents: 19341
diff changeset
283 if sock:
faec69c11640 Only close sockets if they have been created. Reported by Blake Winton.
Martin v. Löwis <martin@v.loewis.de>
parents: 19341
diff changeset
284 sock.close()
18834
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
285 sock = None
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
286 continue
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
287 break
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
288 if not sock:
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
289 raise socket.error, msg
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
290 sock.listen(1)
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
291 port = sock.getsockname()[1] # Get proper port
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
292 host = self.sock.getsockname()[0] # Get proper host
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
293 if self.af == socket.AF_INET:
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
294 resp = self.sendport(host, port)
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
295 else:
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
296 resp = self.sendeprt(host, port)
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
297 return sock
18825
40900620293e Patch #401196: Use getaddrinfo and AF_INET6 in TCP servers and clients.
Martin v. Löwis <martin@v.loewis.de>
parents: 17347
diff changeset
298
40900620293e Patch #401196: Use getaddrinfo and AF_INET6 in TCP servers and clients.
Martin v. Löwis <martin@v.loewis.de>
parents: 17347
diff changeset
299 def makepasv(self):
18834
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
300 if self.af == socket.AF_INET:
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
301 host, port = parse227(self.sendcmd('PASV'))
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
302 else:
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
303 host, port = parse229(self.sendcmd('EPSV'), self.sock.getpeername())
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
304 return host, port
1085
965aa3b53a9d Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
305
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
306 def ntransfercmd(self, cmd, rest=None):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
307 """Initiate a transfer over the data connection.
14338
057c7ceb92f0 Added support for RFC 959's REST command (restart), closing SF patch
Barry Warsaw <barry@python.org>
parents: 14022
diff changeset
308
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
309 If the transfer is active, send a port command and the
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
310 transfer command, and accept the connection. If the server is
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
311 passive, send a pasv command, connect to it, and start the
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
312 transfer command. Either way, return the socket for the
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
313 connection and the expected size of the transfer. The
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
314 expected size may be None if it could not be determined.
14338
057c7ceb92f0 Added support for RFC 959's REST command (restart), closing SF patch
Barry Warsaw <barry@python.org>
parents: 14022
diff changeset
315
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
316 Optional `rest' argument can be a string that is sent as the
44880
c3ed6da7a146 docstring and comment updates suggested by Giampaolo Rodola'
Gregory P. Smith <greg@mad-scientist.com>
parents: 44868
diff changeset
317 argument to a REST command. This is essentially a server
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
318 marker used to tell the server to skip over any data up to the
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
319 given marker.
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
320 """
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
321 size = None
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
322 if self.passiveserver:
18825
40900620293e Patch #401196: Use getaddrinfo and AF_INET6 in TCP servers and clients.
Martin v. Löwis <martin@v.loewis.de>
parents: 17347
diff changeset
323 host, port = self.makepasv()
41961
6fd8d524d56b FTP.ntransfercmd method now uses create_connection when passive,
Facundo Batista <facundobatista@gmail.com>
parents: 41532
diff changeset
324 conn = socket.create_connection((host, port), self.timeout)
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
325 if rest is not None:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
326 self.sendcmd("REST %s" % rest)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
327 resp = self.sendcmd(cmd)
40336
ecbe91b5e46a Patch #1359217: Ignore 2xx response before 150 response.
Martin v. Löwis <martin@v.loewis.de>
parents: 35400
diff changeset
328 # Some servers apparently send a 200 reply to
ecbe91b5e46a Patch #1359217: Ignore 2xx response before 150 response.
Martin v. Löwis <martin@v.loewis.de>
parents: 35400
diff changeset
329 # a LIST or STOR command, before the 150 reply
ecbe91b5e46a Patch #1359217: Ignore 2xx response before 150 response.
Martin v. Löwis <martin@v.loewis.de>
parents: 35400
diff changeset
330 # (and way before the 226 reply). This seems to
ecbe91b5e46a Patch #1359217: Ignore 2xx response before 150 response.
Martin v. Löwis <martin@v.loewis.de>
parents: 35400
diff changeset
331 # be in violation of the protocol (which only allows
ecbe91b5e46a Patch #1359217: Ignore 2xx response before 150 response.
Martin v. Löwis <martin@v.loewis.de>
parents: 35400
diff changeset
332 # 1xx or error messages for LIST), so we just discard
ecbe91b5e46a Patch #1359217: Ignore 2xx response before 150 response.
Martin v. Löwis <martin@v.loewis.de>
parents: 35400
diff changeset
333 # this response.
ecbe91b5e46a Patch #1359217: Ignore 2xx response before 150 response.
Martin v. Löwis <martin@v.loewis.de>
parents: 35400
diff changeset
334 if resp[0] == '2':
40732
5dae0d7f683a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 40336
diff changeset
335 resp = self.getresp()
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
336 if resp[0] != '1':
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
337 raise error_reply, resp
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
338 else:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
339 sock = self.makeport()
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
340 if rest is not None:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
341 self.sendcmd("REST %s" % rest)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
342 resp = self.sendcmd(cmd)
40336
ecbe91b5e46a Patch #1359217: Ignore 2xx response before 150 response.
Martin v. Löwis <martin@v.loewis.de>
parents: 35400
diff changeset
343 # See above.
ecbe91b5e46a Patch #1359217: Ignore 2xx response before 150 response.
Martin v. Löwis <martin@v.loewis.de>
parents: 35400
diff changeset
344 if resp[0] == '2':
40732
5dae0d7f683a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 40336
diff changeset
345 resp = self.getresp()
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
346 if resp[0] != '1':
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
347 raise error_reply, resp
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
348 conn, sockaddr = sock.accept()
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
349 if resp[:3] == '150':
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
350 # this is conditional in case we received a 125
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
351 size = parse150(resp)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
352 return conn, size
4927
040493de848d (ftplib.py): Added parse150() function and FTP.ntransfercmd(). This allows
Fred Drake <fdrake@acm.org>
parents: 4345
diff changeset
353
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
354 def transfercmd(self, cmd, rest=None):
20461
7e71eebab4ea Fix SF bug #459767: ftplib fails with files > 2GB
Guido van Rossum <guido@python.org>
parents: 20303
diff changeset
355 """Like ntransfercmd() but returns only the socket."""
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
356 return self.ntransfercmd(cmd, rest)[0]
1087
b9e4f7321e28 Added much functionality, changed some names (errors, login).
Guido van Rossum <guido@python.org>
parents: 1085
diff changeset
357
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
358 def login(self, user = '', passwd = '', acct = ''):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
359 '''Login, default anonymous.'''
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
360 if not user: user = 'anonymous'
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
361 if not passwd: passwd = ''
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
362 if not acct: acct = ''
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
363 if user == 'anonymous' and passwd in ('', '-'):
21958
5ed782bdbb2a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 21583
diff changeset
364 # If there is no anonymous ftp password specified
5ed782bdbb2a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 21583
diff changeset
365 # then we'll just use anonymous@
5ed782bdbb2a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 21583
diff changeset
366 # We don't send any other thing because:
5ed782bdbb2a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 21583
diff changeset
367 # - We want to remain anonymous
5ed782bdbb2a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 21583
diff changeset
368 # - We want to stop SPAM
5ed782bdbb2a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 21583
diff changeset
369 # - We don't want to let ftp sites to discriminate by the user,
5ed782bdbb2a Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 21583
diff changeset
370 # host or country.
21582
a2eab4de5505 SF patch #497420 (Eduardo Pérez): ftplib: ftp anonymous password
Guido van Rossum <guido@python.org>
parents: 21536
diff changeset
371 passwd = passwd + 'anonymous@'
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
372 resp = self.sendcmd('USER ' + user)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
373 if resp[0] == '3': resp = self.sendcmd('PASS ' + passwd)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
374 if resp[0] == '3': resp = self.sendcmd('ACCT ' + acct)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
375 if resp[0] != '2':
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
376 raise error_reply, resp
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
377 return resp
1087
b9e4f7321e28 Added much functionality, changed some names (errors, login).
Guido van Rossum <guido@python.org>
parents: 1085
diff changeset
378
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
379 def retrbinary(self, cmd, callback, blocksize=8192, rest=None):
44868
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
380 """Retrieve data in binary mode. A new port is created for you.
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
381
44868
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
382 Args:
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
383 cmd: A RETR command.
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
384 callback: A single parameter callable to be called on each
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
385 block of data read.
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
386 blocksize: The maximum number of bytes to read from the
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
387 socket at one time. [default: 8192]
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
388 rest: Passed to transfercmd(). [default: None]
14338
057c7ceb92f0 Added support for RFC 959's REST command (restart), closing SF patch
Barry Warsaw <barry@python.org>
parents: 14022
diff changeset
389
44868
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
390 Returns:
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
391 The response code.
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
392 """
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
393 self.voidcmd('TYPE I')
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
394 conn = self.transfercmd(cmd, rest)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
395 while 1:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
396 data = conn.recv(blocksize)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
397 if not data:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
398 break
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
399 callback(data)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
400 conn.close()
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
401 return self.voidresp()
1085
965aa3b53a9d Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
402
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
403 def retrlines(self, cmd, callback = None):
44868
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
404 """Retrieve data in line mode. A new port is created for you.
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
405
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
406 Args:
44880
c3ed6da7a146 docstring and comment updates suggested by Giampaolo Rodola'
Gregory P. Smith <greg@mad-scientist.com>
parents: 44868
diff changeset
407 cmd: A RETR, LIST, NLST, or MLSD command.
44868
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
408 callback: An optional single parameter callable that is called
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
409 for each line with the trailing CRLF stripped.
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
410 [default: print_line()]
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
411
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
412 Returns:
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
413 The response code.
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
414 """
23419
4f67e56686e5 Closes SF patch 553277. Per GvR, reverting to original patch -- the way to
Raymond Hettinger <python@rcn.com>
parents: 23400
diff changeset
415 if callback is None: callback = print_line
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
416 resp = self.sendcmd('TYPE A')
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
417 conn = self.transfercmd(cmd)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
418 fp = conn.makefile('rb')
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
419 while 1:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
420 line = fp.readline()
31515
71a294bd7950 Replace backticks with repr() or "%r"
Walter Dörwald <walter@livinglogic.de>
parents: 23644
diff changeset
421 if self.debugging > 2: print '*retr*', repr(line)
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
422 if not line:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
423 break
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
424 if line[-2:] == CRLF:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
425 line = line[:-2]
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
426 elif line[-1:] == '\n':
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
427 line = line[:-1]
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
428 callback(line)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
429 fp.close()
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
430 conn.close()
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
431 return self.voidresp()
1087
b9e4f7321e28 Added much functionality, changed some names (errors, login).
Guido van Rossum <guido@python.org>
parents: 1085
diff changeset
432
44868
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
433 def storbinary(self, cmd, fp, blocksize=8192, callback=None):
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
434 """Store a file in binary mode. A new port is created for you.
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
435
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
436 Args:
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
437 cmd: A STOR command.
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
438 fp: A file-like object with a read(num_bytes) method.
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
439 blocksize: The maximum data size to read from fp and send over
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
440 the connection at once. [default: 8192]
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
441 callback: An optional single parameter callable that is called on
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
442 on each block of data after it is sent. [default: None]
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
443
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
444 Returns:
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
445 The response code.
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
446 """
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
447 self.voidcmd('TYPE I')
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
448 conn = self.transfercmd(cmd)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
449 while 1:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
450 buf = fp.read(blocksize)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
451 if not buf: break
21962
d3b1f2c0ebcf The Grande 'sendall()' patch, copied from release21-maint. Fixes #516715.
Martin v. Löwis <martin@v.loewis.de>
parents: 21958
diff changeset
452 conn.sendall(buf)
44868
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
453 if callback: callback(buf)
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
454 conn.close()
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
455 return self.voidresp()
1085
965aa3b53a9d Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
456
44868
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
457 def storlines(self, cmd, fp, callback=None):
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
458 """Store a file in line mode. A new port is created for you.
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
459
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
460 Args:
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
461 cmd: A STOR command.
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
462 fp: A file-like object with a readline() method.
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
463 callback: An optional single parameter callable that is called on
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
464 on each line after it is sent. [default: None]
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
465
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
466 Returns:
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
467 The response code.
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
468 """
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
469 self.voidcmd('TYPE A')
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
470 conn = self.transfercmd(cmd)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
471 while 1:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
472 buf = fp.readline()
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
473 if not buf: break
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
474 if buf[-2:] != CRLF:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
475 if buf[-1] in CRLF: buf = buf[:-1]
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
476 buf = buf + CRLF
21962
d3b1f2c0ebcf The Grande 'sendall()' patch, copied from release21-maint. Fixes #516715.
Martin v. Löwis <martin@v.loewis.de>
parents: 21958
diff changeset
477 conn.sendall(buf)
44868
7f2b525f9df4 accepts and closes issue #1221598: adds an optional callback to ftplib.FTP
Gregory P. Smith <greg@mad-scientist.com>
parents: 41961
diff changeset
478 if callback: callback(buf)
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
479 conn.close()
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
480 return self.voidresp()
1087
b9e4f7321e28 Added much functionality, changed some names (errors, login).
Guido van Rossum <guido@python.org>
parents: 1085
diff changeset
481
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
482 def acct(self, password):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
483 '''Send new account name.'''
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
484 cmd = 'ACCT ' + password
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
485 return self.voidcmd(cmd)
3359
08985431500b add acct() method to send new account name
Guido van Rossum <guido@python.org>
parents: 3201
diff changeset
486
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
487 def nlst(self, *args):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
488 '''Return a list of files in a given directory (default the current).'''
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
489 cmd = 'NLST'
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
490 for arg in args:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
491 cmd = cmd + (' ' + arg)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
492 files = []
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
493 self.retrlines(cmd, files.append)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
494 return files
1087
b9e4f7321e28 Added much functionality, changed some names (errors, login).
Guido van Rossum <guido@python.org>
parents: 1085
diff changeset
495
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
496 def dir(self, *args):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
497 '''List a directory in long form.
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
498 By default list current directory to stdout.
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
499 Optional last argument is callback function; all
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
500 non-empty arguments before it are concatenated to the
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
501 LIST command. (This *should* only be used for a pathname.)'''
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
502 cmd = 'LIST'
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
503 func = None
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
504 if args[-1:] and type(args[-1]) != type(''):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
505 args, func = args[:-1], args[-1]
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
506 for arg in args:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
507 if arg:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
508 cmd = cmd + (' ' + arg)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
509 self.retrlines(cmd, func)
1416
d6f6a1cb7d79 * test_*.py: new lambda syntax (also affects tests for filter, map,
Guido van Rossum <guido@python.org>
parents: 1403
diff changeset
510
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
511 def rename(self, fromname, toname):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
512 '''Rename a file.'''
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
513 resp = self.sendcmd('RNFR ' + fromname)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
514 if resp[0] != '3':
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
515 raise error_reply, resp
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
516 return self.voidcmd('RNTO ' + toname)
1087
b9e4f7321e28 Added much functionality, changed some names (errors, login).
Guido van Rossum <guido@python.org>
parents: 1085
diff changeset
517
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
518 def delete(self, filename):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
519 '''Delete a file.'''
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
520 resp = self.sendcmd('DELE ' + filename)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
521 if resp[:3] in ('250', '200'):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
522 return resp
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
523 else:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
524 raise error_reply, resp
3201
19b58ce794c9 add delete() method to ftp object
Guido van Rossum <guido@python.org>
parents: 3132
diff changeset
525
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
526 def cwd(self, dirname):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
527 '''Change to a directory.'''
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
528 if dirname == '..':
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
529 try:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
530 return self.voidcmd('CDUP')
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
531 except error_perm, msg:
22209
0b08eefb6fc0 Access the exception argument to see whether it starts with '500'.
Martin v. Löwis <martin@v.loewis.de>
parents: 21962
diff changeset
532 if msg.args[0][:3] != '500':
0b08eefb6fc0 Access the exception argument to see whether it starts with '500'.
Martin v. Löwis <martin@v.loewis.de>
parents: 21962
diff changeset
533 raise
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
534 elif dirname == '':
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
535 dirname = '.' # does nothing, but could return error
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
536 cmd = 'CWD ' + dirname
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
537 return self.voidcmd(cmd)
1286
33f3d7ebfcc1 Added cwd()
Guido van Rossum <guido@python.org>
parents: 1089
diff changeset
538
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
539 def size(self, filename):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
540 '''Retrieve the size of a file.'''
44880
c3ed6da7a146 docstring and comment updates suggested by Giampaolo Rodola'
Gregory P. Smith <greg@mad-scientist.com>
parents: 44868
diff changeset
541 # The SIZE command is defined in RFC-3659
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
542 resp = self.sendcmd('SIZE ' + filename)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
543 if resp[:3] == '213':
20461
7e71eebab4ea Fix SF bug #459767: ftplib fails with files > 2GB
Guido van Rossum <guido@python.org>
parents: 20303
diff changeset
544 s = resp[3:].strip()
7e71eebab4ea Fix SF bug #459767: ftplib fails with files > 2GB
Guido van Rossum <guido@python.org>
parents: 20303
diff changeset
545 try:
7e71eebab4ea Fix SF bug #459767: ftplib fails with files > 2GB
Guido van Rossum <guido@python.org>
parents: 20303
diff changeset
546 return int(s)
20500
fddacefeeb36 Oops. Catching OverflowError from int() doesn't help, since it raises
Guido van Rossum <guido@python.org>
parents: 20461
diff changeset
547 except (OverflowError, ValueError):
20461
7e71eebab4ea Fix SF bug #459767: ftplib fails with files > 2GB
Guido van Rossum <guido@python.org>
parents: 20303
diff changeset
548 return long(s)
1297
9234c961ec43 * toaiff.py: import whatsound instead of sndhdr
Guido van Rossum <guido@python.org>
parents: 1291
diff changeset
549
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
550 def mkd(self, dirname):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
551 '''Make a directory, return its full pathname.'''
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
552 resp = self.sendcmd('MKD ' + dirname)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
553 return parse257(resp)
1087
b9e4f7321e28 Added much functionality, changed some names (errors, login).
Guido van Rossum <guido@python.org>
parents: 1085
diff changeset
554
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
555 def rmd(self, dirname):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
556 '''Remove a directory.'''
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
557 return self.voidcmd('RMD ' + dirname)
7411
ad891f6a19ee Add rmd() (remove directory command); fix comment in parse257.
Guido van Rossum <guido@python.org>
parents: 6733
diff changeset
558
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
559 def pwd(self):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
560 '''Return current working directory.'''
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
561 resp = self.sendcmd('PWD')
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
562 return parse257(resp)
1085
965aa3b53a9d Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
563
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
564 def quit(self):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
565 '''Quit, and close the connection.'''
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
566 resp = self.voidcmd('QUIT')
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
567 self.close()
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
568 return resp
1297
9234c961ec43 * toaiff.py: import whatsound instead of sndhdr
Guido van Rossum <guido@python.org>
parents: 1291
diff changeset
569
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
570 def close(self):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
571 '''Close the connection without assuming anything about it.'''
16851
e5f2ab811ec3 Move some constant initialization from FTP.__init__() and FTP.connect()
Fred Drake <fdrake@acm.org>
parents: 16609
diff changeset
572 if self.file:
e5f2ab811ec3 Move some constant initialization from FTP.__init__() and FTP.connect()
Fred Drake <fdrake@acm.org>
parents: 16609
diff changeset
573 self.file.close()
e5f2ab811ec3 Move some constant initialization from FTP.__init__() and FTP.connect()
Fred Drake <fdrake@acm.org>
parents: 16609
diff changeset
574 self.sock.close()
e5f2ab811ec3 Move some constant initialization from FTP.__init__() and FTP.connect()
Fred Drake <fdrake@acm.org>
parents: 16609
diff changeset
575 self.file = self.sock = None
1087
b9e4f7321e28 Added much functionality, changed some names (errors, login).
Guido van Rossum <guido@python.org>
parents: 1085
diff changeset
576
b9e4f7321e28 Added much functionality, changed some names (errors, login).
Guido van Rossum <guido@python.org>
parents: 1085
diff changeset
577
6514
6d9cfb53c7ed Use re instead of regex. Also remove bogus return statement from __init__().
Guido van Rossum <guido@python.org>
parents: 6426
diff changeset
578 _150_re = None
4927
040493de848d (ftplib.py): Added parse150() function and FTP.ntransfercmd(). This allows
Fred Drake <fdrake@acm.org>
parents: 4345
diff changeset
579
040493de848d (ftplib.py): Added parse150() function and FTP.ntransfercmd(). This allows
Fred Drake <fdrake@acm.org>
parents: 4345
diff changeset
580 def parse150(resp):
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
581 '''Parse the '150' response for a RETR request.
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
582 Returns the expected transfer size or None; size is not guaranteed to
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
583 be present in the 150 message.
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
584 '''
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
585 if resp[:3] != '150':
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
586 raise error_reply, resp
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
587 global _150_re
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
588 if _150_re is None:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
589 import re
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
590 _150_re = re.compile("150 .* \((\d+) bytes\)", re.IGNORECASE)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
591 m = _150_re.match(resp)
20461
7e71eebab4ea Fix SF bug #459767: ftplib fails with files > 2GB
Guido van Rossum <guido@python.org>
parents: 20303
diff changeset
592 if not m:
7e71eebab4ea Fix SF bug #459767: ftplib fails with files > 2GB
Guido van Rossum <guido@python.org>
parents: 20303
diff changeset
593 return None
7e71eebab4ea Fix SF bug #459767: ftplib fails with files > 2GB
Guido van Rossum <guido@python.org>
parents: 20303
diff changeset
594 s = m.group(1)
7e71eebab4ea Fix SF bug #459767: ftplib fails with files > 2GB
Guido van Rossum <guido@python.org>
parents: 20303
diff changeset
595 try:
7e71eebab4ea Fix SF bug #459767: ftplib fails with files > 2GB
Guido van Rossum <guido@python.org>
parents: 20303
diff changeset
596 return int(s)
20500
fddacefeeb36 Oops. Catching OverflowError from int() doesn't help, since it raises
Guido van Rossum <guido@python.org>
parents: 20461
diff changeset
597 except (OverflowError, ValueError):
20461
7e71eebab4ea Fix SF bug #459767: ftplib fails with files > 2GB
Guido van Rossum <guido@python.org>
parents: 20303
diff changeset
598 return long(s)
4927
040493de848d (ftplib.py): Added parse150() function and FTP.ntransfercmd(). This allows
Fred Drake <fdrake@acm.org>
parents: 4345
diff changeset
599
040493de848d (ftplib.py): Added parse150() function and FTP.ntransfercmd(). This allows
Fred Drake <fdrake@acm.org>
parents: 4345
diff changeset
600
19341
d46682bda82f Change the 227 response parser to use a more liberal regular
Guido van Rossum <guido@python.org>
parents: 18902
diff changeset
601 _227_re = None
d46682bda82f Change the 227 response parser to use a more liberal regular
Guido van Rossum <guido@python.org>
parents: 18902
diff changeset
602
3649
63cdfbb4a2bb Docstringified and PASV support by Siebren (including new ftpcp() function).
Guido van Rossum <guido@python.org>
parents: 3398
diff changeset
603 def parse227(resp):
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
604 '''Parse the '227' response for a PASV request.
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
605 Raises error_proto if it does not contain '(h1,h2,h3,h4,p1,p2)'
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
606 Return ('host.addr.as.numbers', port#) tuple.'''
3649
63cdfbb4a2bb Docstringified and PASV support by Siebren (including new ftpcp() function).
Guido van Rossum <guido@python.org>
parents: 3398
diff changeset
607
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
608 if resp[:3] != '227':
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
609 raise error_reply, resp
19341
d46682bda82f Change the 227 response parser to use a more liberal regular
Guido van Rossum <guido@python.org>
parents: 18902
diff changeset
610 global _227_re
d46682bda82f Change the 227 response parser to use a more liberal regular
Guido van Rossum <guido@python.org>
parents: 18902
diff changeset
611 if _227_re is None:
d46682bda82f Change the 227 response parser to use a more liberal regular
Guido van Rossum <guido@python.org>
parents: 18902
diff changeset
612 import re
d46682bda82f Change the 227 response parser to use a more liberal regular
Guido van Rossum <guido@python.org>
parents: 18902
diff changeset
613 _227_re = re.compile(r'(\d+),(\d+),(\d+),(\d+),(\d+),(\d+)')
d46682bda82f Change the 227 response parser to use a more liberal regular
Guido van Rossum <guido@python.org>
parents: 18902
diff changeset
614 m = _227_re.search(resp)
d46682bda82f Change the 227 response parser to use a more liberal regular
Guido van Rossum <guido@python.org>
parents: 18902
diff changeset
615 if not m:
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
616 raise error_proto, resp
19341
d46682bda82f Change the 227 response parser to use a more liberal regular
Guido van Rossum <guido@python.org>
parents: 18902
diff changeset
617 numbers = m.groups()
16504
6ffce8be3e0b String method conversion.
Eric S. Raymond <esr@thyrsus.com>
parents: 16072
diff changeset
618 host = '.'.join(numbers[:4])
6ffce8be3e0b String method conversion.
Eric S. Raymond <esr@thyrsus.com>
parents: 16072
diff changeset
619 port = (int(numbers[4]) << 8) + int(numbers[5])
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
620 return host, port
3649
63cdfbb4a2bb Docstringified and PASV support by Siebren (including new ftpcp() function).
Guido van Rossum <guido@python.org>
parents: 3398
diff changeset
621
63cdfbb4a2bb Docstringified and PASV support by Siebren (including new ftpcp() function).
Guido van Rossum <guido@python.org>
parents: 3398
diff changeset
622
18825
40900620293e Patch #401196: Use getaddrinfo and AF_INET6 in TCP servers and clients.
Martin v. Löwis <martin@v.loewis.de>
parents: 17347
diff changeset
623 def parse229(resp, peer):
40900620293e Patch #401196: Use getaddrinfo and AF_INET6 in TCP servers and clients.
Martin v. Löwis <martin@v.loewis.de>
parents: 17347
diff changeset
624 '''Parse the '229' response for a EPSV request.
40900620293e Patch #401196: Use getaddrinfo and AF_INET6 in TCP servers and clients.
Martin v. Löwis <martin@v.loewis.de>
parents: 17347
diff changeset
625 Raises error_proto if it does not contain '(|||port|)'
40900620293e Patch #401196: Use getaddrinfo and AF_INET6 in TCP servers and clients.
Martin v. Löwis <martin@v.loewis.de>
parents: 17347
diff changeset
626 Return ('host.addr.as.numbers', port#) tuple.'''
40900620293e Patch #401196: Use getaddrinfo and AF_INET6 in TCP servers and clients.
Martin v. Löwis <martin@v.loewis.de>
parents: 17347
diff changeset
627
35400
9e05ea3b1bf3 Backport 1.74
Raymond Hettinger <python@rcn.com>
parents: 31515
diff changeset
628 if resp[:3] != '229':
18834
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
629 raise error_reply, resp
23590
a4bb18212b48 Use string methods where possible, and remove import string
Neal Norwitz <nnorwitz@gmail.com>
parents: 23419
diff changeset
630 left = resp.find('(')
18825
40900620293e Patch #401196: Use getaddrinfo and AF_INET6 in TCP servers and clients.
Martin v. Löwis <martin@v.loewis.de>
parents: 17347
diff changeset
631 if left < 0: raise error_proto, resp
23590
a4bb18212b48 Use string methods where possible, and remove import string
Neal Norwitz <nnorwitz@gmail.com>
parents: 23419
diff changeset
632 right = resp.find(')', left + 1)
18825
40900620293e Patch #401196: Use getaddrinfo and AF_INET6 in TCP servers and clients.
Martin v. Löwis <martin@v.loewis.de>
parents: 17347
diff changeset
633 if right < 0:
18834
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
634 raise error_proto, resp # should contain '(|||port|)'
35400
9e05ea3b1bf3 Backport 1.74
Raymond Hettinger <python@rcn.com>
parents: 31515
diff changeset
635 if resp[left + 1] != resp[right - 1]:
18834
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
636 raise error_proto, resp
23644
3ebd376aa4cb Fix a regression from the 1.68->1.69 checkin:
Walter Dörwald <walter@livinglogic.de>
parents: 23620
diff changeset
637 parts = resp[left + 1:right].split(resp[left+1])
35400
9e05ea3b1bf3 Backport 1.74
Raymond Hettinger <python@rcn.com>
parents: 31515
diff changeset
638 if len(parts) != 5:
18834
7e52bf52ae33 Untabify IPv6 changes.
Martin v. Löwis <martin@v.loewis.de>
parents: 18825
diff changeset
639 raise error_proto, resp
18825
40900620293e Patch #401196: Use getaddrinfo and AF_INET6 in TCP servers and clients.
Martin v. Löwis <martin@v.loewis.de>
parents: 17347
diff changeset
640 host = peer[0]
23590
a4bb18212b48 Use string methods where possible, and remove import string
Neal Norwitz <nnorwitz@gmail.com>
parents: 23419
diff changeset
641 port = int(parts[3])
18825
40900620293e Patch #401196: Use getaddrinfo and AF_INET6 in TCP servers and clients.
Martin v. Löwis <martin@v.loewis.de>
parents: 17347
diff changeset
642 return host, port
40900620293e Patch #401196: Use getaddrinfo and AF_INET6 in TCP servers and clients.
Martin v. Löwis <martin@v.loewis.de>
parents: 17347
diff changeset
643
40900620293e Patch #401196: Use getaddrinfo and AF_INET6 in TCP servers and clients.
Martin v. Löwis <martin@v.loewis.de>
parents: 17347
diff changeset
644
1087
b9e4f7321e28 Added much functionality, changed some names (errors, login).
Guido van Rossum <guido@python.org>
parents: 1085
diff changeset
645 def parse257(resp):
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
646 '''Parse the '257' response for a MKD or PWD request.
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
647 This is a response to a MKD or PWD request: a directory name.
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
648 Returns the directoryname in the 257 reply.'''
3649
63cdfbb4a2bb Docstringified and PASV support by Siebren (including new ftpcp() function).
Guido van Rossum <guido@python.org>
parents: 3398
diff changeset
649
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
650 if resp[:3] != '257':
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
651 raise error_reply, resp
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
652 if resp[3:5] != ' "':
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
653 return '' # Not compliant to RFC 959, but UNIX ftpd does this
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
654 dirname = ''
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
655 i = 5
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
656 n = len(resp)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
657 while i < n:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
658 c = resp[i]
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
659 i = i+1
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
660 if c == '"':
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
661 if i >= n or resp[i] != '"':
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
662 break
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
663 i = i+1
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
664 dirname = dirname + c
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
665 return dirname
1085
965aa3b53a9d Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
666
6426
068254fe5617 Return the error code from most commands, rather than swallowing it.
Guido van Rossum <guido@python.org>
parents: 5753
diff changeset
667
1416
d6f6a1cb7d79 * test_*.py: new lambda syntax (also affects tests for filter, map,
Guido van Rossum <guido@python.org>
parents: 1403
diff changeset
668 def print_line(line):
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
669 '''Default retrlines callback to print a line.'''
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
670 print line
1416
d6f6a1cb7d79 * test_*.py: new lambda syntax (also affects tests for filter, map,
Guido van Rossum <guido@python.org>
parents: 1403
diff changeset
671
6426
068254fe5617 Return the error code from most commands, rather than swallowing it.
Guido van Rossum <guido@python.org>
parents: 5753
diff changeset
672
3649
63cdfbb4a2bb Docstringified and PASV support by Siebren (including new ftpcp() function).
Guido van Rossum <guido@python.org>
parents: 3398
diff changeset
673 def ftpcp(source, sourcename, target, targetname = '', type = 'I'):
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
674 '''Copy file from one FTP-instance to another.'''
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
675 if not targetname: targetname = sourcename
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
676 type = 'TYPE ' + type
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
677 source.voidcmd(type)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
678 target.voidcmd(type)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
679 sourcehost, sourceport = parse227(source.sendcmd('PASV'))
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
680 target.sendport(sourcehost, sourceport)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
681 # RFC 959: the user must "listen" [...] BEFORE sending the
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
682 # transfer request.
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
683 # So: STOR before RETR, because here the target is a "user".
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
684 treply = target.sendcmd('STOR ' + targetname)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
685 if treply[:3] not in ('125', '150'): raise error_proto # RFC 959
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
686 sreply = source.sendcmd('RETR ' + sourcename)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
687 if sreply[:3] not in ('125', '150'): raise error_proto # RFC 959
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
688 source.voidresp()
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
689 target.voidresp()
5190
a79ecd5af7e5 Added Fred Drake's netrc parser class.
Guido van Rossum <guido@python.org>
parents: 4927
diff changeset
690
5753
64bc782a42ec Wrapped up the ~/.netrc support. This is basically just the changes Guido &
Fred Drake <fdrake@acm.org>
parents: 5190
diff changeset
691
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
692 class Netrc:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
693 """Class to parse & provide access to 'netrc' format files.
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
694
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
695 See the netrc(4) man page for information on the file format.
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
696
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
697 WARNING: This class is obsolete -- use module netrc instead.
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
698
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
699 """
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
700 __defuser = None
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
701 __defpasswd = None
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
702 __defacct = None
3649
63cdfbb4a2bb Docstringified and PASV support by Siebren (including new ftpcp() function).
Guido van Rossum <guido@python.org>
parents: 3398
diff changeset
703
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
704 def __init__(self, filename=None):
23612
3caee2958387 Replace boolean test with is None
Raymond Hettinger <python@rcn.com>
parents: 23590
diff changeset
705 if filename is None:
23620
a1de0bab5475 SF 563203. Replaced 'has_key()' with 'in'.
Raymond Hettinger <python@rcn.com>
parents: 23612
diff changeset
706 if "HOME" in os.environ:
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
707 filename = os.path.join(os.environ["HOME"],
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
708 ".netrc")
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
709 else:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
710 raise IOError, \
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
711 "specify file to load or set $HOME"
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
712 self.__hosts = {}
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
713 self.__macros = {}
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
714 fp = open(filename, "r")
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
715 in_macro = 0
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
716 while 1:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
717 line = fp.readline()
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
718 if not line: break
16504
6ffce8be3e0b String method conversion.
Eric S. Raymond <esr@thyrsus.com>
parents: 16072
diff changeset
719 if in_macro and line.strip():
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
720 macro_lines.append(line)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
721 continue
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
722 elif in_macro:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
723 self.__macros[macro_name] = tuple(macro_lines)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
724 in_macro = 0
16504
6ffce8be3e0b String method conversion.
Eric S. Raymond <esr@thyrsus.com>
parents: 16072
diff changeset
725 words = line.split()
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
726 host = user = passwd = acct = None
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
727 default = 0
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
728 i = 0
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
729 while i < len(words):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
730 w1 = words[i]
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
731 if i+1 < len(words):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
732 w2 = words[i + 1]
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
733 else:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
734 w2 = None
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
735 if w1 == 'default':
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
736 default = 1
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
737 elif w1 == 'machine' and w2:
16504
6ffce8be3e0b String method conversion.
Eric S. Raymond <esr@thyrsus.com>
parents: 16072
diff changeset
738 host = w2.lower()
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
739 i = i + 1
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
740 elif w1 == 'login' and w2:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
741 user = w2
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
742 i = i + 1
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
743 elif w1 == 'password' and w2:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
744 passwd = w2
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
745 i = i + 1
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
746 elif w1 == 'account' and w2:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
747 acct = w2
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
748 i = i + 1
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
749 elif w1 == 'macdef' and w2:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
750 macro_name = w2
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
751 macro_lines = []
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
752 in_macro = 1
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
753 break
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
754 i = i + 1
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
755 if default:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
756 self.__defuser = user or self.__defuser
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
757 self.__defpasswd = passwd or self.__defpasswd
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
758 self.__defacct = acct or self.__defacct
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
759 if host:
23620
a1de0bab5475 SF 563203. Replaced 'has_key()' with 'in'.
Raymond Hettinger <python@rcn.com>
parents: 23612
diff changeset
760 if host in self.__hosts:
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
761 ouser, opasswd, oacct = \
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
762 self.__hosts[host]
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
763 user = user or ouser
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
764 passwd = passwd or opasswd
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
765 acct = acct or oacct
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
766 self.__hosts[host] = user, passwd, acct
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
767 fp.close()
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
768
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
769 def get_hosts(self):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
770 """Return a list of hosts mentioned in the .netrc file."""
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
771 return self.__hosts.keys()
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
772
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
773 def get_account(self, host):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
774 """Returns login information for the named host.
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
775
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
776 The return value is a triple containing userid,
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
777 password, and the accounting field.
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
778
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
779 """
16504
6ffce8be3e0b String method conversion.
Eric S. Raymond <esr@thyrsus.com>
parents: 16072
diff changeset
780 host = host.lower()
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
781 user = passwd = acct = None
23620
a1de0bab5475 SF 563203. Replaced 'has_key()' with 'in'.
Raymond Hettinger <python@rcn.com>
parents: 23612
diff changeset
782 if host in self.__hosts:
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
783 user, passwd, acct = self.__hosts[host]
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
784 user = user or self.__defuser
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
785 passwd = passwd or self.__defpasswd
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
786 acct = acct or self.__defacct
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
787 return user, passwd, acct
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
788
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
789 def get_macros(self):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
790 """Return a list of all defined macro names."""
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
791 return self.__macros.keys()
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
792
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
793 def get_macro(self, macro):
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
794 """Return a sequence of lines which define a named macro."""
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
795 return self.__macros[macro]
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
796
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
797
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
798
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
799 def test():
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
800 '''Test program.
35400
9e05ea3b1bf3 Backport 1.74
Raymond Hettinger <python@rcn.com>
parents: 31515
diff changeset
801 Usage: ftp [-d] [-r[file]] host [-l[dir]] [-d[dir]] [-p] [file] ...
9e05ea3b1bf3 Backport 1.74
Raymond Hettinger <python@rcn.com>
parents: 31515
diff changeset
802
9e05ea3b1bf3 Backport 1.74
Raymond Hettinger <python@rcn.com>
parents: 31515
diff changeset
803 -d dir
9e05ea3b1bf3 Backport 1.74
Raymond Hettinger <python@rcn.com>
parents: 31515
diff changeset
804 -l list
9e05ea3b1bf3 Backport 1.74
Raymond Hettinger <python@rcn.com>
parents: 31515
diff changeset
805 -p password
9e05ea3b1bf3 Backport 1.74
Raymond Hettinger <python@rcn.com>
parents: 31515
diff changeset
806 '''
9e05ea3b1bf3 Backport 1.74
Raymond Hettinger <python@rcn.com>
parents: 31515
diff changeset
807
9e05ea3b1bf3 Backport 1.74
Raymond Hettinger <python@rcn.com>
parents: 31515
diff changeset
808 if len(sys.argv) < 2:
9e05ea3b1bf3 Backport 1.74
Raymond Hettinger <python@rcn.com>
parents: 31515
diff changeset
809 print test.__doc__
9e05ea3b1bf3 Backport 1.74
Raymond Hettinger <python@rcn.com>
parents: 31515
diff changeset
810 sys.exit(0)
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
811
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
812 debugging = 0
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
813 rcfile = None
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
814 while sys.argv[1] == '-d':
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
815 debugging = debugging+1
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
816 del sys.argv[1]
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
817 if sys.argv[1][:2] == '-r':
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
818 # get name of alternate ~/.netrc file:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
819 rcfile = sys.argv[1][2:]
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
820 del sys.argv[1]
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
821 host = sys.argv[1]
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
822 ftp = FTP(host)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
823 ftp.set_debuglevel(debugging)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
824 userid = passwd = acct = ''
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
825 try:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
826 netrc = Netrc(rcfile)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
827 except IOError:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
828 if rcfile is not None:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
829 sys.stderr.write("Could not open account file"
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
830 " -- using anonymous login.")
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
831 else:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
832 try:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
833 userid, passwd, acct = netrc.get_account(host)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
834 except KeyError:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
835 # no account for host
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
836 sys.stderr.write(
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
837 "No account -- using anonymous login.")
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
838 ftp.login(userid, passwd, acct)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
839 for file in sys.argv[2:]:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
840 if file[:2] == '-l':
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
841 ftp.dir(file[2:])
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
842 elif file[:2] == '-d':
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
843 cmd = 'CWD'
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
844 if file[2:]: cmd = cmd + ' ' + file[2:]
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
845 resp = ftp.sendcmd(cmd)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
846 elif file == '-p':
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
847 ftp.set_pasv(not ftp.passiveserver)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
848 else:
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
849 ftp.retrbinary('RETR ' + file, \
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
850 sys.stdout.write, 1024)
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
851 ftp.quit()
2902
13581b417837 new sendport() interface; add test() program call
Guido van Rossum <guido@python.org>
parents: 2758
diff changeset
852
13581b417837 new sendport() interface; add test() program call
Guido van Rossum <guido@python.org>
parents: 2758
diff changeset
853
13581b417837 new sendport() interface; add test() program call
Guido van Rossum <guido@python.org>
parents: 2758
diff changeset
854 if __name__ == '__main__':
15867
f5a3d98a35bc Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 15543
diff changeset
855 test()