← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transport/ftp.py

  • Committer: John Arbash Meinel
  • Date: 2007-03-14 20:15:52 UTC
  • mto: (2353.4.2 locking)
  • mto: This revision was merged to the branch mainline in revision 2360.
  • Revision ID: john@arbash-meinel.com-20070314201552-bjtfua57456dviep
Update the lock code and test code so that if more than one
lock implementation is available, they will both be tested.

It is quite a bit of overhead, for a case where we are likely to only have 1
real lock implementation per platform, but hey, for now we have 2.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/transport/ftp.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
16
"""Implementation of Transport over ftp.
18
17
 
19
18
Written by Daniel Silverstone <dsilvers@digital-scurf.org> with serious
26
25
"""
27
26
 
28
27
from cStringIO import StringIO
 
28
import asyncore
 
29
import errno
29
30
import ftplib
30
 
import getpass
31
31
import os
32
 
import random
33
 
import socket
 
32
import urllib
 
33
import urlparse
34
34
import stat
 
35
import threading
35
36
import time
 
37
import random
 
38
from warnings import warn
36
39
 
37
40
from bzrlib import (
38
 
    config,
39
41
    errors,
40
 
    osutils,
41
42
    urlutils,
42
43
    )
43
44
from bzrlib.trace import mutter, warning
44
45
from bzrlib.transport import (
45
 
    AppendBasedFileStream,
46
 
    ConnectedTransport,
47
 
    _file_streams,
48
 
    register_urlparse_netloc_protocol,
49
46
    Server,
 
47
    split_url,
 
48
    Transport,
50
49
    )
51
 
 
52
 
 
53
 
register_urlparse_netloc_protocol('aftp')
 
50
import bzrlib.ui
 
51
 
 
52
_have_medusa = False
54
53
 
55
54
 
56
55
class FtpPathError(errors.PathError):
57
56
    """FTP failed for path: %(path)s%(extra)s"""
58
57
 
59
58
 
 
59
_FTP_cache = {}
 
60
def _find_FTP(hostname, port, username, password, is_active):
 
61
    """Find an ftplib.FTP instance attached to this triplet."""
 
62
    key = (hostname, port, username, password, is_active)
 
63
    alt_key = (hostname, port, username, '********', is_active)
 
64
    if key not in _FTP_cache:
 
65
        mutter("Constructing FTP instance against %r" % (alt_key,))
 
66
        conn = ftplib.FTP()
 
67
 
 
68
        conn.connect(host=hostname, port=port)
 
69
        if username and username != 'anonymous' and not password:
 
70
            password = bzrlib.ui.ui_factory.get_password(
 
71
                prompt='FTP %(user)s@%(host)s password',
 
72
                user=username, host=hostname)
 
73
        conn.login(user=username, passwd=password)
 
74
        conn.set_pasv(not is_active)
 
75
 
 
76
        _FTP_cache[key] = conn
 
77
 
 
78
    return _FTP_cache[key]    
 
79
 
 
80
 
60
81
class FtpStatResult(object):
61
 
 
62
 
    def __init__(self, f, abspath):
 
82
    def __init__(self, f, relpath):
63
83
        try:
64
 
            self.st_size = f.size(abspath)
 
84
            self.st_size = f.size(relpath)
65
85
            self.st_mode = stat.S_IFREG
66
86
        except ftplib.error_perm:
67
87
            pwd = f.pwd()
68
88
            try:
69
 
                f.cwd(abspath)
 
89
                f.cwd(relpath)
70
90
                self.st_mode = stat.S_IFDIR
71
91
            finally:
72
92
                f.cwd(pwd)
75
95
_number_of_retries = 2
76
96
_sleep_between_retries = 5
77
97
 
78
 
# FIXME: there are inconsistencies in the way temporary errors are
79
 
# handled. Sometimes we reconnect, sometimes we raise an exception. Care should
80
 
# be taken to analyze the implications for write operations (read operations
81
 
# are safe to retry). Overall even some read operations are never
82
 
# retried. --vila 20070720 (Bug #127164)
83
 
class FtpTransport(ConnectedTransport):
 
98
class FtpTransport(Transport):
84
99
    """This is the transport agent for ftp:// access."""
85
100
 
86
 
    def __init__(self, base, _from_transport=None):
 
101
    def __init__(self, base, _provided_instance=None):
87
102
        """Set the base path where files will be stored."""
88
 
        if not (base.startswith('ftp://') or base.startswith('aftp://')):
89
 
            raise ValueError(base)
90
 
        super(FtpTransport, self).__init__(base,
91
 
                                           _from_transport=_from_transport)
92
 
        self._unqualified_scheme = 'ftp'
93
 
        if self._scheme == 'aftp':
94
 
            self.is_active = True
95
 
        else:
96
 
            self.is_active = False
97
 
 
98
 
        # Most modern FTP servers support the APPE command. If ours doesn't, we
99
 
        # (re)set this flag accordingly later.
100
 
        self._has_append = True
 
103
        assert base.startswith('ftp://') or base.startswith('aftp://')
 
104
 
 
105
        self.is_active = base.startswith('aftp://')
 
106
        if self.is_active:
 
107
            # urlparse won't handle aftp://
 
108
            base = base[1:]
 
109
        if not base.endswith('/'):
 
110
            base += '/'
 
111
        (self._proto, self._username,
 
112
            self._password, self._host,
 
113
            self._port, self._path) = split_url(base)
 
114
        base = self._unparse_url()
 
115
 
 
116
        super(FtpTransport, self).__init__(base)
 
117
        self._FTP_instance = _provided_instance
 
118
 
 
119
    def _unparse_url(self, path=None):
 
120
        if path is None:
 
121
            path = self._path
 
122
        path = urllib.quote(path)
 
123
        netloc = urllib.quote(self._host)
 
124
        if self._username is not None:
 
125
            netloc = '%s@%s' % (urllib.quote(self._username), netloc)
 
126
        if self._port is not None:
 
127
            netloc = '%s:%d' % (netloc, self._port)
 
128
        proto = 'ftp'
 
129
        if self.is_active:
 
130
            proto = 'aftp'
 
131
        return urlparse.urlunparse((proto, netloc, path, '', '', ''))
101
132
 
102
133
    def _get_FTP(self):
103
134
        """Return the ftplib.FTP instance for this object."""
104
 
        # Ensures that a connection is established
105
 
        connection = self._get_connection()
106
 
        if connection is None:
107
 
            # First connection ever
108
 
            connection, credentials = self._create_connection()
109
 
            self._set_connection(connection, credentials)
110
 
        return connection
111
 
 
112
 
    connection_class = ftplib.FTP
113
 
 
114
 
    def _create_connection(self, credentials=None):
115
 
        """Create a new connection with the provided credentials.
116
 
 
117
 
        :param credentials: The credentials needed to establish the connection.
118
 
 
119
 
        :return: The created connection and its associated credentials.
120
 
 
121
 
        The input credentials are only the password as it may have been
122
 
        entered interactively by the user and may be different from the one
123
 
        provided in base url at transport creation time.  The returned
124
 
        credentials are username, password.
125
 
        """
126
 
        if credentials is None:
127
 
            user, password = self._user, self._password
128
 
        else:
129
 
            user, password = credentials
130
 
 
131
 
        auth = config.AuthenticationConfig()
132
 
        if user is None:
133
 
            user = auth.get_user('ftp', self._host, port=self._port,
134
 
                                 default=getpass.getuser())
135
 
        mutter("Constructing FTP instance against %r" %
136
 
               ((self._host, self._port, user, '********',
137
 
                self.is_active),))
 
135
        if self._FTP_instance is not None:
 
136
            return self._FTP_instance
 
137
        
138
138
        try:
139
 
            connection = self.connection_class()
140
 
            connection.connect(host=self._host, port=self._port)
141
 
            self._login(connection, auth, user, password)
142
 
            connection.set_pasv(not self.is_active)
143
 
            # binary mode is the default
144
 
            connection.voidcmd('TYPE I')
145
 
        except socket.error, e:
146
 
            raise errors.SocketConnectionError(self._host, self._port,
147
 
                                               msg='Unable to connect to',
148
 
                                               orig_error= e)
 
139
            self._FTP_instance = _find_FTP(self._host, self._port,
 
140
                                           self._username, self._password,
 
141
                                           self.is_active)
 
142
            return self._FTP_instance
149
143
        except ftplib.error_perm, e:
150
 
            raise errors.TransportError(msg="Error setting up connection:"
151
 
                                        " %s" % str(e), orig_error=e)
152
 
        return connection, (user, password)
153
 
 
154
 
    def _login(self, connection, auth, user, password):
155
 
        # '' is a valid password
156
 
        if user and user != 'anonymous' and password is None:
157
 
            password = auth.get_password('ftp', self._host,
158
 
                                         user, port=self._port)
159
 
        connection.login(user=user, passwd=password)
160
 
 
161
 
    def _reconnect(self):
162
 
        """Create a new connection with the previously used credentials"""
163
 
        credentials = self._get_credentials()
164
 
        connection, credentials = self._create_connection(credentials)
165
 
        self._set_connection(connection, credentials)
166
 
 
167
 
    def _translate_ftp_error(self, err, path, extra=None,
168
 
                              unknown_exc=FtpPathError):
169
 
        """Try to translate an ftplib exception to a bzrlib exception.
 
144
            raise errors.TransportError(msg="Error setting up connection: %s"
 
145
                                    % str(e), orig_error=e)
 
146
 
 
147
    def _translate_perm_error(self, err, path, extra=None, unknown_exc=FtpPathError):
 
148
        """Try to translate an ftplib.error_perm exception.
170
149
 
171
150
        :param err: The error to translate into a bzr error
172
151
        :param path: The path which had problems
174
153
        :param unknown_exc: If None, we will just raise the original exception
175
154
                    otherwise we raise unknown_exc(path, extra=extra)
176
155
        """
177
 
        # ftp error numbers are very generic, like "451: Requested action aborted,
178
 
        # local error in processing" so unfortunately we have to match by
179
 
        # strings.
180
156
        s = str(err).lower()
181
157
        if not extra:
182
158
            extra = str(err)
186
162
            or 'could not open' in s
187
163
            or 'no such dir' in s
188
164
            or 'could not create file' in s # vsftpd
189
 
            or 'file doesn\'t exist' in s
190
 
            or 'rnfr command failed.' in s # vsftpd RNFR reply if file not found
191
 
            or 'file/directory not found' in s # filezilla server
192
 
            # Microsoft FTP-Service RNFR reply if file not found
193
 
            or (s.startswith('550 ') and 'unable to rename to' in extra)
194
165
            ):
195
166
            raise errors.NoSuchFile(path, extra=extra)
196
 
        elif ('file exists' in s):
 
167
        if ('file exists' in s):
197
168
            raise errors.FileExists(path, extra=extra)
198
 
        elif ('not a directory' in s):
 
169
        if ('not a directory' in s):
199
170
            raise errors.PathError(path, extra=extra)
200
 
        elif 'directory not empty' in s:
201
 
            raise errors.DirectoryNotEmpty(path, extra=extra)
202
171
 
203
172
        mutter('unable to understand error for path: %s: %s', path, err)
204
173
 
205
174
        if unknown_exc:
206
175
            raise unknown_exc(path, extra=extra)
207
 
        # TODO: jam 20060516 Consider re-raising the error wrapped in
 
176
        # TODO: jam 20060516 Consider re-raising the error wrapped in 
208
177
        #       something like TransportError, but this loses the traceback
209
178
        #       Also, 'sftp' has a generic 'Failure' mode, which we use failure_exc
210
179
        #       to handle. Consider doing something like that here.
211
180
        #raise TransportError(msg='Error for path: %s' % (path,), orig_error=e)
212
181
        raise
213
182
 
 
183
    def should_cache(self):
 
184
        """Return True if the data pulled across should be cached locally.
 
185
        """
 
186
        return True
 
187
 
 
188
    def clone(self, offset=None):
 
189
        """Return a new FtpTransport with root at self.base + offset.
 
190
        """
 
191
        mutter("FTP clone")
 
192
        if offset is None:
 
193
            return FtpTransport(self.base, self._FTP_instance)
 
194
        else:
 
195
            return FtpTransport(self.abspath(offset), self._FTP_instance)
 
196
 
 
197
    def _abspath(self, relpath):
 
198
        assert isinstance(relpath, basestring)
 
199
        relpath = urlutils.unescape(relpath)
 
200
        if relpath.startswith('/'):
 
201
            basepath = []
 
202
        else:
 
203
            basepath = self._path.split('/')
 
204
        if len(basepath) > 0 and basepath[-1] == '':
 
205
            basepath = basepath[:-1]
 
206
        for p in relpath.split('/'):
 
207
            if p == '..':
 
208
                if len(basepath) == 0:
 
209
                    # In most filesystems, a request for the parent
 
210
                    # of root, just returns root.
 
211
                    continue
 
212
                basepath.pop()
 
213
            elif p == '.' or p == '':
 
214
                continue # No-op
 
215
            else:
 
216
                basepath.append(p)
 
217
        # Possibly, we could use urlparse.urljoin() here, but
 
218
        # I'm concerned about when it chooses to strip the last
 
219
        # portion of the path, and when it doesn't.
 
220
 
 
221
        # XXX: It seems that ftplib does not handle Unicode paths
 
222
        # at the same time, medusa won't handle utf8 paths
 
223
        # So if we .encode(utf8) here, then we get a Server failure.
 
224
        # while if we use str(), we get a UnicodeError, and the test suite
 
225
        # just skips testing UnicodePaths.
 
226
        return str('/'.join(basepath) or '/')
 
227
    
 
228
    def abspath(self, relpath):
 
229
        """Return the full url to the given relative path.
 
230
        This can be supplied with a string or a list
 
231
        """
 
232
        path = self._abspath(relpath)
 
233
        return self._unparse_url(path)
 
234
 
214
235
    def has(self, relpath):
215
236
        """Does the target location exist?"""
216
237
        # FIXME jam 20060516 We *do* ask about directories in the test suite
218
239
        # XXX: I assume we're never asked has(dirname) and thus I use
219
240
        # the FTP size command and assume that if it doesn't raise,
220
241
        # all is good.
221
 
        abspath = self._remote_path(relpath)
 
242
        abspath = self._abspath(relpath)
222
243
        try:
223
244
            f = self._get_FTP()
224
245
            mutter('FTP has check: %s => %s', relpath, abspath)
244
265
        """
245
266
        # TODO: decode should be deprecated
246
267
        try:
247
 
            mutter("FTP get: %s", self._remote_path(relpath))
 
268
            mutter("FTP get: %s", self._abspath(relpath))
248
269
            f = self._get_FTP()
249
270
            ret = StringIO()
250
 
            f.retrbinary('RETR '+self._remote_path(relpath), ret.write, 8192)
 
271
            f.retrbinary('RETR '+self._abspath(relpath), ret.write, 8192)
251
272
            ret.seek(0)
252
273
            return ret
253
274
        except ftplib.error_perm, e:
259
280
                                     orig_error=e)
260
281
            else:
261
282
                warning("FTP temporary error: %s. Retrying.", str(e))
262
 
                self._reconnect()
 
283
                self._FTP_instance = None
263
284
                return self.get(relpath, decode, retries+1)
264
285
        except EOFError, e:
265
286
            if retries > _number_of_retries:
269
290
            else:
270
291
                warning("FTP control connection closed. Trying to reopen.")
271
292
                time.sleep(_sleep_between_retries)
272
 
                self._reconnect()
 
293
                self._FTP_instance = None
273
294
                return self.get(relpath, decode, retries+1)
274
295
 
275
296
    def put_file(self, relpath, fp, mode=None, retries=0):
280
301
        :param retries: Number of retries after temporary failures so far
281
302
                        for this operation.
282
303
 
283
 
        TODO: jam 20051215 ftp as a protocol seems to support chmod, but
284
 
        ftplib does not
 
304
        TODO: jam 20051215 ftp as a protocol seems to support chmod, but ftplib does not
285
305
        """
286
 
        abspath = self._remote_path(relpath)
 
306
        abspath = self._abspath(relpath)
287
307
        tmp_abspath = '%s.tmp.%.9f.%d.%d' % (abspath, time.time(),
288
308
                        os.getpid(), random.randint(0,0x7FFFFFFF))
289
 
        bytes = None
290
309
        if getattr(fp, 'read', None) is None:
291
 
            # hand in a string IO
292
 
            bytes = fp
293
 
            fp = StringIO(bytes)
294
 
        else:
295
 
            # capture the byte count; .read() may be read only so
296
 
            # decorate it.
297
 
            class byte_counter(object):
298
 
                def __init__(self, fp):
299
 
                    self.fp = fp
300
 
                    self.counted_bytes = 0
301
 
                def read(self, count):
302
 
                    result = self.fp.read(count)
303
 
                    self.counted_bytes += len(result)
304
 
                    return result
305
 
            fp = byte_counter(fp)
 
310
            fp = StringIO(fp)
306
311
        try:
307
312
            mutter("FTP put: %s", abspath)
308
313
            f = self._get_FTP()
309
314
            try:
310
315
                f.storbinary('STOR '+tmp_abspath, fp)
311
 
                self._rename_and_overwrite(tmp_abspath, abspath, f)
312
 
                self._setmode(relpath, mode)
313
 
                if bytes is not None:
314
 
                    return len(bytes)
315
 
                else:
316
 
                    return fp.counted_bytes
 
316
                f.rename(tmp_abspath, abspath)
317
317
            except (ftplib.error_temp,EOFError), e:
318
318
                warning("Failure during ftp PUT. Deleting temporary file.")
319
319
                try:
324
324
                    raise e
325
325
                raise
326
326
        except ftplib.error_perm, e:
327
 
            self._translate_ftp_error(e, abspath, extra='could not store',
328
 
                                       unknown_exc=errors.NoSuchFile)
 
327
            self._translate_perm_error(e, abspath, extra='could not store')
329
328
        except ftplib.error_temp, e:
330
329
            if retries > _number_of_retries:
331
330
                raise errors.TransportError("FTP temporary error during PUT %s. Aborting."
332
331
                                     % self.abspath(relpath), orig_error=e)
333
332
            else:
334
333
                warning("FTP temporary error: %s. Retrying.", str(e))
335
 
                self._reconnect()
 
334
                self._FTP_instance = None
336
335
                self.put_file(relpath, fp, mode, retries+1)
337
336
        except EOFError:
338
337
            if retries > _number_of_retries:
341
340
            else:
342
341
                warning("FTP control connection closed. Trying to reopen.")
343
342
                time.sleep(_sleep_between_retries)
344
 
                self._reconnect()
 
343
                self._FTP_instance = None
345
344
                self.put_file(relpath, fp, mode, retries+1)
346
345
 
347
346
    def mkdir(self, relpath, mode=None):
348
347
        """Create a directory at the given path."""
349
 
        abspath = self._remote_path(relpath)
 
348
        abspath = self._abspath(relpath)
350
349
        try:
351
350
            mutter("FTP mkd: %s", abspath)
352
351
            f = self._get_FTP()
353
352
            f.mkd(abspath)
354
 
            self._setmode(relpath, mode)
355
353
        except ftplib.error_perm, e:
356
 
            self._translate_ftp_error(e, abspath,
 
354
            self._translate_perm_error(e, abspath,
357
355
                unknown_exc=errors.FileExists)
358
356
 
359
 
    def open_write_stream(self, relpath, mode=None):
360
 
        """See Transport.open_write_stream."""
361
 
        self.put_bytes(relpath, "", mode)
362
 
        result = AppendBasedFileStream(self, relpath)
363
 
        _file_streams[self.abspath(relpath)] = result
364
 
        return result
365
 
 
366
 
    def recommended_page_size(self):
367
 
        """See Transport.recommended_page_size().
368
 
 
369
 
        For FTP we suggest a large page size to reduce the overhead
370
 
        introduced by latency.
371
 
        """
372
 
        return 64 * 1024
373
 
 
374
357
    def rmdir(self, rel_path):
375
358
        """Delete the directory at rel_path"""
376
 
        abspath = self._remote_path(rel_path)
 
359
        abspath = self._abspath(rel_path)
377
360
        try:
378
361
            mutter("FTP rmd: %s", abspath)
379
362
            f = self._get_FTP()
380
363
            f.rmd(abspath)
381
364
        except ftplib.error_perm, e:
382
 
            self._translate_ftp_error(e, abspath, unknown_exc=errors.PathError)
 
365
            self._translate_perm_error(e, abspath, unknown_exc=errors.PathError)
383
366
 
384
367
    def append_file(self, relpath, f, mode=None):
385
368
        """Append the text in the file-like object into the final
386
369
        location.
387
370
        """
388
 
        text = f.read()
389
 
        abspath = self._remote_path(relpath)
 
371
        abspath = self._abspath(relpath)
390
372
        if self.has(relpath):
391
373
            ftp = self._get_FTP()
392
374
            result = ftp.size(abspath)
393
375
        else:
394
376
            result = 0
395
377
 
396
 
        if self._has_append:
397
 
            mutter("FTP appe to %s", abspath)
398
 
            self._try_append(relpath, text, mode)
399
 
        else:
400
 
            self._fallback_append(relpath, text, mode)
 
378
        mutter("FTP appe to %s", abspath)
 
379
        self._try_append(relpath, f.read(), mode)
401
380
 
402
381
        return result
403
382
 
404
383
    def _try_append(self, relpath, text, mode=None, retries=0):
405
384
        """Try repeatedly to append the given text to the file at relpath.
406
 
 
 
385
        
407
386
        This is a recursive function. On errors, it will be called until the
408
387
        number of retries is exceeded.
409
388
        """
410
389
        try:
411
 
            abspath = self._remote_path(relpath)
 
390
            abspath = self._abspath(relpath)
412
391
            mutter("FTP appe (try %d) to %s", retries, abspath)
413
392
            ftp = self._get_FTP()
 
393
            ftp.voidcmd("TYPE I")
414
394
            cmd = "APPE %s" % abspath
415
395
            conn = ftp.transfercmd(cmd)
416
396
            conn.sendall(text)
417
397
            conn.close()
418
 
            self._setmode(relpath, mode)
 
398
            if mode:
 
399
                self._setmode(relpath, mode)
419
400
            ftp.getresp()
420
401
        except ftplib.error_perm, e:
421
 
            # Check whether the command is not supported (reply code 502)
422
 
            if str(e).startswith('502 '):
423
 
                warning("FTP server does not support file appending natively. "
424
 
                        "Performance may be severely degraded! (%s)", e)
425
 
                self._has_append = False
426
 
                self._fallback_append(relpath, text, mode)
427
 
            else:
428
 
                self._translate_ftp_error(e, abspath, extra='error appending',
429
 
                    unknown_exc=errors.NoSuchFile)
 
402
            self._translate_perm_error(e, abspath, extra='error appending',
 
403
                unknown_exc=errors.NoSuchFile)
430
404
        except ftplib.error_temp, e:
431
405
            if retries > _number_of_retries:
432
 
                raise errors.TransportError(
433
 
                    "FTP temporary error during APPEND %s. Aborting."
434
 
                    % abspath, orig_error=e)
 
406
                raise errors.TransportError("FTP temporary error during APPEND %s." \
 
407
                        "Aborting." % abspath, orig_error=e)
435
408
            else:
436
409
                warning("FTP temporary error: %s. Retrying.", str(e))
437
 
                self._reconnect()
 
410
                self._FTP_instance = None
438
411
                self._try_append(relpath, text, mode, retries+1)
439
412
 
440
 
    def _fallback_append(self, relpath, text, mode = None):
441
 
        remote = self.get(relpath)
442
 
        remote.seek(0, os.SEEK_END)
443
 
        remote.write(text)
444
 
        remote.seek(0)
445
 
        return self.put_file(relpath, remote, mode)
446
 
 
447
413
    def _setmode(self, relpath, mode):
448
414
        """Set permissions on a path.
449
415
 
450
416
        Only set permissions if the FTP server supports the 'SITE CHMOD'
451
417
        extension.
452
418
        """
453
 
        if mode:
454
 
            try:
455
 
                mutter("FTP site chmod: setting permissions to %s on %s",
456
 
                       oct(mode), self._remote_path(relpath))
457
 
                ftp = self._get_FTP()
458
 
                cmd = "SITE CHMOD %s %s" % (oct(mode),
459
 
                                            self._remote_path(relpath))
460
 
                ftp.sendcmd(cmd)
461
 
            except ftplib.error_perm, e:
462
 
                # Command probably not available on this server
463
 
                warning("FTP Could not set permissions to %s on %s. %s",
464
 
                        oct(mode), self._remote_path(relpath), str(e))
 
419
        try:
 
420
            mutter("FTP site chmod: setting permissions to %s on %s",
 
421
                str(mode), self._abspath(relpath))
 
422
            ftp = self._get_FTP()
 
423
            cmd = "SITE CHMOD %s %s" % (self._abspath(relpath), str(mode))
 
424
            ftp.sendcmd(cmd)
 
425
        except ftplib.error_perm, e:
 
426
            # Command probably not available on this server
 
427
            warning("FTP Could not set permissions to %s on %s. %s",
 
428
                    str(mode), self._abspath(relpath), str(e))
465
429
 
466
430
    # TODO: jam 20060516 I believe ftp allows you to tell an ftp server
467
431
    #       to copy something to another machine. And you may be able
468
432
    #       to give it its own address as the 'to' location.
469
433
    #       So implement a fancier 'copy()'
470
434
 
471
 
    def rename(self, rel_from, rel_to):
472
 
        abs_from = self._remote_path(rel_from)
473
 
        abs_to = self._remote_path(rel_to)
474
 
        mutter("FTP rename: %s => %s", abs_from, abs_to)
475
 
        f = self._get_FTP()
476
 
        return self._rename(abs_from, abs_to, f)
477
 
 
478
 
    def _rename(self, abs_from, abs_to, f):
479
 
        try:
480
 
            f.rename(abs_from, abs_to)
481
 
        except (ftplib.error_temp, ftplib.error_perm), e:
482
 
            self._translate_ftp_error(e, abs_from,
483
 
                ': unable to rename to %r' % (abs_to))
484
 
 
485
435
    def move(self, rel_from, rel_to):
486
436
        """Move the item at rel_from to the location at rel_to"""
487
 
        abs_from = self._remote_path(rel_from)
488
 
        abs_to = self._remote_path(rel_to)
 
437
        abs_from = self._abspath(rel_from)
 
438
        abs_to = self._abspath(rel_to)
489
439
        try:
490
440
            mutter("FTP mv: %s => %s", abs_from, abs_to)
491
441
            f = self._get_FTP()
492
 
            self._rename_and_overwrite(abs_from, abs_to, f)
 
442
            f.rename(abs_from, abs_to)
493
443
        except ftplib.error_perm, e:
494
 
            self._translate_ftp_error(e, abs_from,
495
 
                extra='unable to rename to %r' % (rel_to,),
 
444
            self._translate_perm_error(e, abs_from,
 
445
                extra='unable to rename to %r' % (rel_to,), 
496
446
                unknown_exc=errors.PathError)
497
447
 
498
 
    def _rename_and_overwrite(self, abs_from, abs_to, f):
499
 
        """Do a fancy rename on the remote server.
500
 
 
501
 
        Using the implementation provided by osutils.
502
 
        """
503
 
        osutils.fancy_rename(abs_from, abs_to,
504
 
            rename_func=lambda p1, p2: self._rename(p1, p2, f),
505
 
            unlink_func=lambda p: self._delete(p, f))
 
448
    rename = move
506
449
 
507
450
    def delete(self, relpath):
508
451
        """Delete the item at relpath"""
509
 
        abspath = self._remote_path(relpath)
510
 
        f = self._get_FTP()
511
 
        self._delete(abspath, f)
512
 
 
513
 
    def _delete(self, abspath, f):
 
452
        abspath = self._abspath(relpath)
514
453
        try:
515
454
            mutter("FTP rm: %s", abspath)
 
455
            f = self._get_FTP()
516
456
            f.delete(abspath)
517
457
        except ftplib.error_perm, e:
518
 
            self._translate_ftp_error(e, abspath, 'error deleting',
 
458
            self._translate_perm_error(e, abspath, 'error deleting',
519
459
                unknown_exc=errors.NoSuchFile)
520
460
 
521
 
    def external_url(self):
522
 
        """See bzrlib.transport.Transport.external_url."""
523
 
        # FTP URL's are externally usable.
524
 
        return self.base
525
 
 
526
461
    def listable(self):
527
462
        """See Transport.listable."""
528
463
        return True
529
464
 
530
465
    def list_dir(self, relpath):
531
466
        """See Transport.list_dir."""
532
 
        basepath = self._remote_path(relpath)
 
467
        basepath = self._abspath(relpath)
533
468
        mutter("FTP nlst: %s", basepath)
534
469
        f = self._get_FTP()
535
470
        try:
536
 
            try:
537
 
                paths = f.nlst(basepath)
538
 
            except ftplib.error_perm, e:
539
 
                self._translate_ftp_error(e, relpath,
540
 
                                           extra='error with list_dir')
541
 
            except ftplib.error_temp, e:
542
 
                # xs4all's ftp server raises a 450 temp error when listing an
543
 
                # empty directory. Check for that and just return an empty list
544
 
                # in that case. See bug #215522
545
 
                if str(e).lower().startswith('450 no files found'):
546
 
                    mutter('FTP Server returned "%s" for nlst.'
547
 
                           ' Assuming it means empty directory',
548
 
                           str(e))
549
 
                    return []
550
 
                raise
551
 
        finally:
552
 
            # Restore binary mode as nlst switch to ascii mode to retrieve file
553
 
            # list
554
 
            f.voidcmd('TYPE I')
555
 
 
 
471
            paths = f.nlst(basepath)
 
472
        except ftplib.error_perm, e:
 
473
            self._translate_perm_error(e, relpath, extra='error with list_dir')
556
474
        # If FTP.nlst returns paths prefixed by relpath, strip 'em
557
475
        if paths and paths[0].startswith(basepath):
558
476
            entries = [path[len(basepath)+1:] for path in paths]
579
497
 
580
498
    def stat(self, relpath):
581
499
        """Return the stat information for a file."""
582
 
        abspath = self._remote_path(relpath)
 
500
        abspath = self._abspath(relpath)
583
501
        try:
584
502
            mutter("FTP stat: %s", abspath)
585
503
            f = self._get_FTP()
586
504
            return FtpStatResult(f, abspath)
587
505
        except ftplib.error_perm, e:
588
 
            self._translate_ftp_error(e, abspath, extra='error w/ stat')
 
506
            self._translate_perm_error(e, abspath, extra='error w/ stat')
589
507
 
590
508
    def lock_read(self, relpath):
591
509
        """Lock the given file for shared (read) access.
609
527
        return self.lock_read(relpath)
610
528
 
611
529
 
 
530
class FtpServer(Server):
 
531
    """Common code for SFTP server facilities."""
 
532
 
 
533
    def __init__(self):
 
534
        self._root = None
 
535
        self._ftp_server = None
 
536
        self._port = None
 
537
        self._async_thread = None
 
538
        # ftp server logs
 
539
        self.logs = []
 
540
 
 
541
    def get_url(self):
 
542
        """Calculate an ftp url to this server."""
 
543
        return 'ftp://foo:bar@localhost:%d/' % (self._port)
 
544
 
 
545
#    def get_bogus_url(self):
 
546
#        """Return a URL which cannot be connected to."""
 
547
#        return 'ftp://127.0.0.1:1'
 
548
 
 
549
    def log(self, message):
 
550
        """This is used by medusa.ftp_server to log connections, etc."""
 
551
        self.logs.append(message)
 
552
 
 
553
    def setUp(self):
 
554
 
 
555
        if not _have_medusa:
 
556
            raise RuntimeError('Must have medusa to run the FtpServer')
 
557
 
 
558
        self._root = os.getcwdu()
 
559
        self._ftp_server = _ftp_server(
 
560
            authorizer=_test_authorizer(root=self._root),
 
561
            ip='localhost',
 
562
            port=0, # bind to a random port
 
563
            resolver=None,
 
564
            logger_object=self # Use FtpServer.log() for messages
 
565
            )
 
566
        self._port = self._ftp_server.getsockname()[1]
 
567
        # Don't let it loop forever, or handle an infinite number of requests.
 
568
        # In this case it will run for 100s, or 1000 requests
 
569
        self._async_thread = threading.Thread(target=asyncore.loop,
 
570
                kwargs={'timeout':0.1, 'count':1000})
 
571
        self._async_thread.setDaemon(True)
 
572
        self._async_thread.start()
 
573
 
 
574
    def tearDown(self):
 
575
        """See bzrlib.transport.Server.tearDown."""
 
576
        # have asyncore release the channel
 
577
        self._ftp_server.del_channel()
 
578
        asyncore.close_all()
 
579
        self._async_thread.join()
 
580
 
 
581
 
 
582
_ftp_channel = None
 
583
_ftp_server = None
 
584
_test_authorizer = None
 
585
 
 
586
 
 
587
def _setup_medusa():
 
588
    global _have_medusa, _ftp_channel, _ftp_server, _test_authorizer
 
589
    try:
 
590
        import medusa
 
591
        import medusa.filesys
 
592
        import medusa.ftp_server
 
593
    except ImportError:
 
594
        return False
 
595
 
 
596
    _have_medusa = True
 
597
 
 
598
    class test_authorizer(object):
 
599
        """A custom Authorizer object for running the test suite.
 
600
 
 
601
        The reason we cannot use dummy_authorizer, is because it sets the
 
602
        channel to readonly, which we don't always want to do.
 
603
        """
 
604
 
 
605
        def __init__(self, root):
 
606
            self.root = root
 
607
 
 
608
        def authorize(self, channel, username, password):
 
609
            """Return (success, reply_string, filesystem)"""
 
610
            if not _have_medusa:
 
611
                return 0, 'No Medusa.', None
 
612
 
 
613
            channel.persona = -1, -1
 
614
            if username == 'anonymous':
 
615
                channel.read_only = 1
 
616
            else:
 
617
                channel.read_only = 0
 
618
 
 
619
            return 1, 'OK.', medusa.filesys.os_filesystem(self.root)
 
620
 
 
621
 
 
622
    class ftp_channel(medusa.ftp_server.ftp_channel):
 
623
        """Customized ftp channel"""
 
624
 
 
625
        def log(self, message):
 
626
            """Redirect logging requests."""
 
627
            mutter('_ftp_channel: %s', message)
 
628
            
 
629
        def log_info(self, message, type='info'):
 
630
            """Redirect logging requests."""
 
631
            mutter('_ftp_channel %s: %s', type, message)
 
632
            
 
633
        def cmd_rnfr(self, line):
 
634
            """Prepare for renaming a file."""
 
635
            self._renaming = line[1]
 
636
            self.respond('350 Ready for RNTO')
 
637
            # TODO: jam 20060516 in testing, the ftp server seems to
 
638
            #       check that the file already exists, or it sends
 
639
            #       550 RNFR command failed
 
640
 
 
641
        def cmd_rnto(self, line):
 
642
            """Rename a file based on the target given.
 
643
 
 
644
            rnto must be called after calling rnfr.
 
645
            """
 
646
            if not self._renaming:
 
647
                self.respond('503 RNFR required first.')
 
648
            pfrom = self.filesystem.translate(self._renaming)
 
649
            self._renaming = None
 
650
            pto = self.filesystem.translate(line[1])
 
651
            try:
 
652
                os.rename(pfrom, pto)
 
653
            except (IOError, OSError), e:
 
654
                # TODO: jam 20060516 return custom responses based on
 
655
                #       why the command failed
 
656
                self.respond('550 RNTO failed: %s' % (e,))
 
657
            except:
 
658
                self.respond('550 RNTO failed')
 
659
                # For a test server, we will go ahead and just die
 
660
                raise
 
661
            else:
 
662
                self.respond('250 Rename successful.')
 
663
 
 
664
        def cmd_size(self, line):
 
665
            """Return the size of a file
 
666
 
 
667
            This is overloaded to help the test suite determine if the 
 
668
            target is a directory.
 
669
            """
 
670
            filename = line[1]
 
671
            if not self.filesystem.isfile(filename):
 
672
                if self.filesystem.isdir(filename):
 
673
                    self.respond('550 "%s" is a directory' % (filename,))
 
674
                else:
 
675
                    self.respond('550 "%s" is not a file' % (filename,))
 
676
            else:
 
677
                self.respond('213 %d' 
 
678
                    % (self.filesystem.stat(filename)[stat.ST_SIZE]),)
 
679
 
 
680
        def cmd_mkd(self, line):
 
681
            """Create a directory.
 
682
 
 
683
            Overloaded because default implementation does not distinguish
 
684
            *why* it cannot make a directory.
 
685
            """
 
686
            if len (line) != 2:
 
687
                self.command_not_understood(''.join(line))
 
688
            else:
 
689
                path = line[1]
 
690
                try:
 
691
                    self.filesystem.mkdir (path)
 
692
                    self.respond ('257 MKD command successful.')
 
693
                except (IOError, OSError), e:
 
694
                    self.respond ('550 error creating directory: %s' % (e,))
 
695
                except:
 
696
                    self.respond ('550 error creating directory.')
 
697
 
 
698
 
 
699
    class ftp_server(medusa.ftp_server.ftp_server):
 
700
        """Customize the behavior of the Medusa ftp_server.
 
701
 
 
702
        There are a few warts on the ftp_server, based on how it expects
 
703
        to be used.
 
704
        """
 
705
        _renaming = None
 
706
        ftp_channel_class = ftp_channel
 
707
 
 
708
        def __init__(self, *args, **kwargs):
 
709
            mutter('Initializing _ftp_server: %r, %r', args, kwargs)
 
710
            medusa.ftp_server.ftp_server.__init__(self, *args, **kwargs)
 
711
 
 
712
        def log(self, message):
 
713
            """Redirect logging requests."""
 
714
            mutter('_ftp_server: %s', message)
 
715
 
 
716
        def log_info(self, message, type='info'):
 
717
            """Override the asyncore.log_info so we don't stipple the screen."""
 
718
            mutter('_ftp_server %s: %s', type, message)
 
719
 
 
720
    _test_authorizer = test_authorizer
 
721
    _ftp_channel = ftp_channel
 
722
    _ftp_server = ftp_server
 
723
 
 
724
    return True
 
725
 
 
726
 
612
727
def get_test_permutations():
613
728
    """Return the permutations to be used in testing."""
614
 
    from bzrlib.tests import ftp_server
615
 
    return [(FtpTransport, ftp_server.FTPTestServer)]
 
729
    if not _setup_medusa():
 
730
        warn("You must install medusa (http://www.amk.ca/python/code/medusa.html) for FTP tests")
 
731
        return []
 
732
    else:
 
733
        return [(FtpTransport, FtpServer)]