/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/transport/ftp.py

  • Committer: Martin Pool
  • Date: 2007-08-20 07:54:29 UTC
  • mto: This revision was merged to the branch mainline in revision 2737.
  • Revision ID: mbp@sourcefrog.net-20070820075429-qf292u06r16ezx8x
Fix up conversion of create_repository to make_repository in test_fetch

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 os.path
 
33
import urllib
 
34
import urlparse
 
35
import select
34
36
import stat
 
37
import threading
35
38
import time
 
39
import random
 
40
from warnings import warn
36
41
 
37
42
from bzrlib import (
38
 
    config,
39
43
    errors,
40
44
    osutils,
41
45
    urlutils,
42
46
    )
43
47
from bzrlib.trace import mutter, warning
44
48
from bzrlib.transport import (
45
 
    AppendBasedFileStream,
 
49
    Server,
46
50
    ConnectedTransport,
47
 
    _file_streams,
48
 
    register_urlparse_netloc_protocol,
49
 
    Server,
50
51
    )
51
 
 
52
 
 
53
 
register_urlparse_netloc_protocol('aftp')
 
52
from bzrlib.transport.local import LocalURLServer
 
53
import bzrlib.ui
 
54
 
 
55
_have_medusa = False
54
56
 
55
57
 
56
58
class FtpPathError(errors.PathError):
58
60
 
59
61
 
60
62
class FtpStatResult(object):
61
 
 
62
 
    def __init__(self, f, abspath):
 
63
    def __init__(self, f, relpath):
63
64
        try:
64
 
            self.st_size = f.size(abspath)
 
65
            self.st_size = f.size(relpath)
65
66
            self.st_mode = stat.S_IFREG
66
67
        except ftplib.error_perm:
67
68
            pwd = f.pwd()
68
69
            try:
69
 
                f.cwd(abspath)
 
70
                f.cwd(relpath)
70
71
                self.st_mode = stat.S_IFDIR
71
72
            finally:
72
73
                f.cwd(pwd)
85
86
 
86
87
    def __init__(self, base, _from_transport=None):
87
88
        """Set the base path where files will be stored."""
88
 
        if not (base.startswith('ftp://') or base.startswith('aftp://')):
89
 
            raise ValueError(base)
 
89
        assert base.startswith('ftp://') or base.startswith('aftp://')
90
90
        super(FtpTransport, self).__init__(base,
91
91
                                           _from_transport=_from_transport)
92
92
        self._unqualified_scheme = 'ftp'
95
95
        else:
96
96
            self.is_active = False
97
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
101
 
 
102
98
    def _get_FTP(self):
103
99
        """Return the ftplib.FTP instance for this object."""
104
100
        # Ensures that a connection is established
109
105
            self._set_connection(connection, credentials)
110
106
        return connection
111
107
 
112
 
    connection_class = ftplib.FTP
113
 
 
114
108
    def _create_connection(self, credentials=None):
115
109
        """Create a new connection with the provided credentials.
116
110
 
118
112
 
119
113
        :return: The created connection and its associated credentials.
120
114
 
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.
 
115
        The credentials are only the password as it may have been entered
 
116
        interactively by the user and may be different from the one provided
 
117
        in base url at transport creation time.
125
118
        """
126
119
        if credentials is None:
127
 
            user, password = self._user, self._password
 
120
            password = self._password
128
121
        else:
129
 
            user, password = credentials
 
122
            password = credentials
130
123
 
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
124
        mutter("Constructing FTP instance against %r" %
136
 
               ((self._host, self._port, user, '********',
 
125
               ((self._host, self._port, self._user, '********',
137
126
                self.is_active),))
138
127
        try:
139
 
            connection = self.connection_class()
 
128
            connection = ftplib.FTP()
140
129
            connection.connect(host=self._host, port=self._port)
141
 
            self._login(connection, auth, user, password)
 
130
            if self._user and self._user != 'anonymous' and \
 
131
                    password is not None: # '' is a valid password
 
132
                get_password = bzrlib.ui.ui_factory.get_password
 
133
                password = get_password(prompt='FTP %(user)s@%(host)s password',
 
134
                                        user=self._user, host=self._host)
 
135
            connection.login(user=self._user, passwd=password)
142
136
            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)
149
137
        except ftplib.error_perm, e:
150
138
            raise errors.TransportError(msg="Error setting up connection:"
151
139
                                        " %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)
 
140
        return connection, password
160
141
 
161
142
    def _reconnect(self):
162
143
        """Create a new connection with the previously used credentials"""
163
 
        credentials = self._get_credentials()
 
144
        credentials = self.get_credentials()
164
145
        connection, credentials = self._create_connection(credentials)
165
146
        self._set_connection(connection, credentials)
166
147
 
167
 
    def _translate_ftp_error(self, err, path, extra=None,
 
148
    def _translate_perm_error(self, err, path, extra=None,
168
149
                              unknown_exc=FtpPathError):
169
 
        """Try to translate an ftplib exception to a bzrlib exception.
 
150
        """Try to translate an ftplib.error_perm exception.
170
151
 
171
152
        :param err: The error to translate into a bzr error
172
153
        :param path: The path which had problems
174
155
        :param unknown_exc: If None, we will just raise the original exception
175
156
                    otherwise we raise unknown_exc(path, extra=extra)
176
157
        """
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
158
        s = str(err).lower()
181
159
        if not extra:
182
160
            extra = str(err)
187
165
            or 'no such dir' in s
188
166
            or 'could not create file' in s # vsftpd
189
167
            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
168
            ):
195
169
            raise errors.NoSuchFile(path, extra=extra)
196
 
        elif ('file exists' in s):
 
170
        if ('file exists' in s):
197
171
            raise errors.FileExists(path, extra=extra)
198
 
        elif ('not a directory' in s):
 
172
        if ('not a directory' in s):
199
173
            raise errors.PathError(path, extra=extra)
200
 
        elif 'directory not empty' in s:
201
 
            raise errors.DirectoryNotEmpty(path, extra=extra)
202
174
 
203
175
        mutter('unable to understand error for path: %s: %s', path, err)
204
176
 
205
177
        if unknown_exc:
206
178
            raise unknown_exc(path, extra=extra)
207
 
        # TODO: jam 20060516 Consider re-raising the error wrapped in
 
179
        # TODO: jam 20060516 Consider re-raising the error wrapped in 
208
180
        #       something like TransportError, but this loses the traceback
209
181
        #       Also, 'sftp' has a generic 'Failure' mode, which we use failure_exc
210
182
        #       to handle. Consider doing something like that here.
211
183
        #raise TransportError(msg='Error for path: %s' % (path,), orig_error=e)
212
184
        raise
213
185
 
 
186
    def _remote_path(self, relpath):
 
187
        # XXX: It seems that ftplib does not handle Unicode paths
 
188
        # at the same time, medusa won't handle utf8 paths So if
 
189
        # we .encode(utf8) here (see ConnectedTransport
 
190
        # implementation), then we get a Server failure.  while
 
191
        # if we use str(), we get a UnicodeError, and the test
 
192
        # suite just skips testing UnicodePaths.
 
193
        relative = str(urlutils.unescape(relpath))
 
194
        remote_path = self._combine_paths(self._path, relative)
 
195
        return remote_path
 
196
 
214
197
    def has(self, relpath):
215
198
        """Does the target location exist?"""
216
199
        # FIXME jam 20060516 We *do* ask about directories in the test suite
286
269
        abspath = self._remote_path(relpath)
287
270
        tmp_abspath = '%s.tmp.%.9f.%d.%d' % (abspath, time.time(),
288
271
                        os.getpid(), random.randint(0,0x7FFFFFFF))
289
 
        bytes = None
290
272
        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)
 
273
            fp = StringIO(fp)
306
274
        try:
307
275
            mutter("FTP put: %s", abspath)
308
276
            f = self._get_FTP()
309
277
            try:
310
278
                f.storbinary('STOR '+tmp_abspath, fp)
311
279
                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
317
280
            except (ftplib.error_temp,EOFError), e:
318
281
                warning("Failure during ftp PUT. Deleting temporary file.")
319
282
                try:
324
287
                    raise e
325
288
                raise
326
289
        except ftplib.error_perm, e:
327
 
            self._translate_ftp_error(e, abspath, extra='could not store',
 
290
            self._translate_perm_error(e, abspath, extra='could not store',
328
291
                                       unknown_exc=errors.NoSuchFile)
329
292
        except ftplib.error_temp, e:
330
293
            if retries > _number_of_retries:
351
314
            mutter("FTP mkd: %s", abspath)
352
315
            f = self._get_FTP()
353
316
            f.mkd(abspath)
354
 
            self._setmode(relpath, mode)
355
317
        except ftplib.error_perm, e:
356
 
            self._translate_ftp_error(e, abspath,
 
318
            self._translate_perm_error(e, abspath,
357
319
                unknown_exc=errors.FileExists)
358
320
 
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
321
    def rmdir(self, rel_path):
375
322
        """Delete the directory at rel_path"""
376
323
        abspath = self._remote_path(rel_path)
379
326
            f = self._get_FTP()
380
327
            f.rmd(abspath)
381
328
        except ftplib.error_perm, e:
382
 
            self._translate_ftp_error(e, abspath, unknown_exc=errors.PathError)
 
329
            self._translate_perm_error(e, abspath, unknown_exc=errors.PathError)
383
330
 
384
331
    def append_file(self, relpath, f, mode=None):
385
332
        """Append the text in the file-like object into the final
386
333
        location.
387
334
        """
388
 
        text = f.read()
389
335
        abspath = self._remote_path(relpath)
390
336
        if self.has(relpath):
391
337
            ftp = self._get_FTP()
393
339
        else:
394
340
            result = 0
395
341
 
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)
 
342
        mutter("FTP appe to %s", abspath)
 
343
        self._try_append(relpath, f.read(), mode)
401
344
 
402
345
        return result
403
346
 
404
347
    def _try_append(self, relpath, text, mode=None, retries=0):
405
348
        """Try repeatedly to append the given text to the file at relpath.
406
 
 
 
349
        
407
350
        This is a recursive function. On errors, it will be called until the
408
351
        number of retries is exceeded.
409
352
        """
411
354
            abspath = self._remote_path(relpath)
412
355
            mutter("FTP appe (try %d) to %s", retries, abspath)
413
356
            ftp = self._get_FTP()
 
357
            ftp.voidcmd("TYPE I")
414
358
            cmd = "APPE %s" % abspath
415
359
            conn = ftp.transfercmd(cmd)
416
360
            conn.sendall(text)
417
361
            conn.close()
418
 
            self._setmode(relpath, mode)
 
362
            if mode:
 
363
                self._setmode(relpath, mode)
419
364
            ftp.getresp()
420
365
        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)
 
366
            self._translate_perm_error(e, abspath, extra='error appending',
 
367
                unknown_exc=errors.NoSuchFile)
430
368
        except ftplib.error_temp, e:
431
369
            if retries > _number_of_retries:
432
 
                raise errors.TransportError(
433
 
                    "FTP temporary error during APPEND %s. Aborting."
434
 
                    % abspath, orig_error=e)
 
370
                raise errors.TransportError("FTP temporary error during APPEND %s." \
 
371
                        "Aborting." % abspath, orig_error=e)
435
372
            else:
436
373
                warning("FTP temporary error: %s. Retrying.", str(e))
437
374
                self._reconnect()
438
375
                self._try_append(relpath, text, mode, retries+1)
439
376
 
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
377
    def _setmode(self, relpath, mode):
448
378
        """Set permissions on a path.
449
379
 
450
380
        Only set permissions if the FTP server supports the 'SITE CHMOD'
451
381
        extension.
452
382
        """
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))
 
383
        try:
 
384
            mutter("FTP site chmod: setting permissions to %s on %s",
 
385
                str(mode), self._remote_path(relpath))
 
386
            ftp = self._get_FTP()
 
387
            cmd = "SITE CHMOD %s %s" % (self._remote_path(relpath), str(mode))
 
388
            ftp.sendcmd(cmd)
 
389
        except ftplib.error_perm, e:
 
390
            # Command probably not available on this server
 
391
            warning("FTP Could not set permissions to %s on %s. %s",
 
392
                    str(mode), self._remote_path(relpath), str(e))
465
393
 
466
394
    # TODO: jam 20060516 I believe ftp allows you to tell an ftp server
467
395
    #       to copy something to another machine. And you may be able
478
406
    def _rename(self, abs_from, abs_to, f):
479
407
        try:
480
408
            f.rename(abs_from, abs_to)
481
 
        except (ftplib.error_temp, ftplib.error_perm), e:
482
 
            self._translate_ftp_error(e, abs_from,
 
409
        except ftplib.error_perm, e:
 
410
            self._translate_perm_error(e, abs_from,
483
411
                ': unable to rename to %r' % (abs_to))
484
412
 
485
413
    def move(self, rel_from, rel_to):
491
419
            f = self._get_FTP()
492
420
            self._rename_and_overwrite(abs_from, abs_to, f)
493
421
        except ftplib.error_perm, e:
494
 
            self._translate_ftp_error(e, abs_from,
495
 
                extra='unable to rename to %r' % (rel_to,),
 
422
            self._translate_perm_error(e, abs_from,
 
423
                extra='unable to rename to %r' % (rel_to,), 
496
424
                unknown_exc=errors.PathError)
497
425
 
498
426
    def _rename_and_overwrite(self, abs_from, abs_to, f):
515
443
            mutter("FTP rm: %s", abspath)
516
444
            f.delete(abspath)
517
445
        except ftplib.error_perm, e:
518
 
            self._translate_ftp_error(e, abspath, 'error deleting',
 
446
            self._translate_perm_error(e, abspath, 'error deleting',
519
447
                unknown_exc=errors.NoSuchFile)
520
448
 
521
449
    def external_url(self):
533
461
        mutter("FTP nlst: %s", basepath)
534
462
        f = self._get_FTP()
535
463
        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
 
 
 
464
            paths = f.nlst(basepath)
 
465
        except ftplib.error_perm, e:
 
466
            self._translate_perm_error(e, relpath, extra='error with list_dir')
556
467
        # If FTP.nlst returns paths prefixed by relpath, strip 'em
557
468
        if paths and paths[0].startswith(basepath):
558
469
            entries = [path[len(basepath)+1:] for path in paths]
585
496
            f = self._get_FTP()
586
497
            return FtpStatResult(f, abspath)
587
498
        except ftplib.error_perm, e:
588
 
            self._translate_ftp_error(e, abspath, extra='error w/ stat')
 
499
            self._translate_perm_error(e, abspath, extra='error w/ stat')
589
500
 
590
501
    def lock_read(self, relpath):
591
502
        """Lock the given file for shared (read) access.
609
520
        return self.lock_read(relpath)
610
521
 
611
522
 
 
523
class FtpServer(Server):
 
524
    """Common code for FTP server facilities."""
 
525
 
 
526
    def __init__(self):
 
527
        self._root = None
 
528
        self._ftp_server = None
 
529
        self._port = None
 
530
        self._async_thread = None
 
531
        # ftp server logs
 
532
        self.logs = []
 
533
 
 
534
    def get_url(self):
 
535
        """Calculate an ftp url to this server."""
 
536
        return 'ftp://foo:bar@localhost:%d/' % (self._port)
 
537
 
 
538
#    def get_bogus_url(self):
 
539
#        """Return a URL which cannot be connected to."""
 
540
#        return 'ftp://127.0.0.1:1'
 
541
 
 
542
    def log(self, message):
 
543
        """This is used by medusa.ftp_server to log connections, etc."""
 
544
        self.logs.append(message)
 
545
 
 
546
    def setUp(self, vfs_server=None):
 
547
        if not _have_medusa:
 
548
            raise RuntimeError('Must have medusa to run the FtpServer')
 
549
 
 
550
        assert vfs_server is None or isinstance(vfs_server, LocalURLServer), \
 
551
            "FtpServer currently assumes local transport, got %s" % vfs_server
 
552
 
 
553
        self._root = os.getcwdu()
 
554
        self._ftp_server = _ftp_server(
 
555
            authorizer=_test_authorizer(root=self._root),
 
556
            ip='localhost',
 
557
            port=0, # bind to a random port
 
558
            resolver=None,
 
559
            logger_object=self # Use FtpServer.log() for messages
 
560
            )
 
561
        self._port = self._ftp_server.getsockname()[1]
 
562
        # Don't let it loop forever, or handle an infinite number of requests.
 
563
        # In this case it will run for 1000s, or 10000 requests
 
564
        self._async_thread = threading.Thread(
 
565
                target=FtpServer._asyncore_loop_ignore_EBADF,
 
566
                kwargs={'timeout':0.1, 'count':10000})
 
567
        self._async_thread.setDaemon(True)
 
568
        self._async_thread.start()
 
569
 
 
570
    def tearDown(self):
 
571
        """See bzrlib.transport.Server.tearDown."""
 
572
        # have asyncore release the channel
 
573
        self._ftp_server.del_channel()
 
574
        asyncore.close_all()
 
575
        self._async_thread.join()
 
576
 
 
577
    @staticmethod
 
578
    def _asyncore_loop_ignore_EBADF(*args, **kwargs):
 
579
        """Ignore EBADF during server shutdown.
 
580
 
 
581
        We close the socket to get the server to shutdown, but this causes
 
582
        select.select() to raise EBADF.
 
583
        """
 
584
        try:
 
585
            asyncore.loop(*args, **kwargs)
 
586
            # FIXME: If we reach that point, we should raise an exception
 
587
            # explaining that the 'count' parameter in setUp is too low or
 
588
            # testers may wonder why their test just sits there waiting for a
 
589
            # server that is already dead. Note that if the tester waits too
 
590
            # long under pdb the server will also die.
 
591
        except select.error, e:
 
592
            if e.args[0] != errno.EBADF:
 
593
                raise
 
594
 
 
595
 
 
596
_ftp_channel = None
 
597
_ftp_server = None
 
598
_test_authorizer = None
 
599
 
 
600
 
 
601
def _setup_medusa():
 
602
    global _have_medusa, _ftp_channel, _ftp_server, _test_authorizer
 
603
    try:
 
604
        import medusa
 
605
        import medusa.filesys
 
606
        import medusa.ftp_server
 
607
    except ImportError:
 
608
        return False
 
609
 
 
610
    _have_medusa = True
 
611
 
 
612
    class test_authorizer(object):
 
613
        """A custom Authorizer object for running the test suite.
 
614
 
 
615
        The reason we cannot use dummy_authorizer, is because it sets the
 
616
        channel to readonly, which we don't always want to do.
 
617
        """
 
618
 
 
619
        def __init__(self, root):
 
620
            self.root = root
 
621
 
 
622
        def authorize(self, channel, username, password):
 
623
            """Return (success, reply_string, filesystem)"""
 
624
            if not _have_medusa:
 
625
                return 0, 'No Medusa.', None
 
626
 
 
627
            channel.persona = -1, -1
 
628
            if username == 'anonymous':
 
629
                channel.read_only = 1
 
630
            else:
 
631
                channel.read_only = 0
 
632
 
 
633
            return 1, 'OK.', medusa.filesys.os_filesystem(self.root)
 
634
 
 
635
 
 
636
    class ftp_channel(medusa.ftp_server.ftp_channel):
 
637
        """Customized ftp channel"""
 
638
 
 
639
        def log(self, message):
 
640
            """Redirect logging requests."""
 
641
            mutter('_ftp_channel: %s', message)
 
642
 
 
643
        def log_info(self, message, type='info'):
 
644
            """Redirect logging requests."""
 
645
            mutter('_ftp_channel %s: %s', type, message)
 
646
 
 
647
        def cmd_rnfr(self, line):
 
648
            """Prepare for renaming a file."""
 
649
            self._renaming = line[1]
 
650
            self.respond('350 Ready for RNTO')
 
651
            # TODO: jam 20060516 in testing, the ftp server seems to
 
652
            #       check that the file already exists, or it sends
 
653
            #       550 RNFR command failed
 
654
 
 
655
        def cmd_rnto(self, line):
 
656
            """Rename a file based on the target given.
 
657
 
 
658
            rnto must be called after calling rnfr.
 
659
            """
 
660
            if not self._renaming:
 
661
                self.respond('503 RNFR required first.')
 
662
            pfrom = self.filesystem.translate(self._renaming)
 
663
            self._renaming = None
 
664
            pto = self.filesystem.translate(line[1])
 
665
            if os.path.exists(pto):
 
666
                self.respond('550 RNTO failed: file exists')
 
667
                return
 
668
            try:
 
669
                os.rename(pfrom, pto)
 
670
            except (IOError, OSError), e:
 
671
                # TODO: jam 20060516 return custom responses based on
 
672
                #       why the command failed
 
673
                # (bialix 20070418) str(e) on Python 2.5 @ Windows
 
674
                # sometimes don't provide expected error message;
 
675
                # so we obtain such message via os.strerror()
 
676
                self.respond('550 RNTO failed: %s' % os.strerror(e.errno))
 
677
            except:
 
678
                self.respond('550 RNTO failed')
 
679
                # For a test server, we will go ahead and just die
 
680
                raise
 
681
            else:
 
682
                self.respond('250 Rename successful.')
 
683
 
 
684
        def cmd_size(self, line):
 
685
            """Return the size of a file
 
686
 
 
687
            This is overloaded to help the test suite determine if the 
 
688
            target is a directory.
 
689
            """
 
690
            filename = line[1]
 
691
            if not self.filesystem.isfile(filename):
 
692
                if self.filesystem.isdir(filename):
 
693
                    self.respond('550 "%s" is a directory' % (filename,))
 
694
                else:
 
695
                    self.respond('550 "%s" is not a file' % (filename,))
 
696
            else:
 
697
                self.respond('213 %d' 
 
698
                    % (self.filesystem.stat(filename)[stat.ST_SIZE]),)
 
699
 
 
700
        def cmd_mkd(self, line):
 
701
            """Create a directory.
 
702
 
 
703
            Overloaded because default implementation does not distinguish
 
704
            *why* it cannot make a directory.
 
705
            """
 
706
            if len (line) != 2:
 
707
                self.command_not_understood(''.join(line))
 
708
            else:
 
709
                path = line[1]
 
710
                try:
 
711
                    self.filesystem.mkdir (path)
 
712
                    self.respond ('257 MKD command successful.')
 
713
                except (IOError, OSError), e:
 
714
                    # (bialix 20070418) str(e) on Python 2.5 @ Windows
 
715
                    # sometimes don't provide expected error message;
 
716
                    # so we obtain such message via os.strerror()
 
717
                    self.respond ('550 error creating directory: %s' %
 
718
                                  os.strerror(e.errno))
 
719
                except:
 
720
                    self.respond ('550 error creating directory.')
 
721
 
 
722
 
 
723
    class ftp_server(medusa.ftp_server.ftp_server):
 
724
        """Customize the behavior of the Medusa ftp_server.
 
725
 
 
726
        There are a few warts on the ftp_server, based on how it expects
 
727
        to be used.
 
728
        """
 
729
        _renaming = None
 
730
        ftp_channel_class = ftp_channel
 
731
 
 
732
        def __init__(self, *args, **kwargs):
 
733
            mutter('Initializing _ftp_server: %r, %r', args, kwargs)
 
734
            medusa.ftp_server.ftp_server.__init__(self, *args, **kwargs)
 
735
 
 
736
        def log(self, message):
 
737
            """Redirect logging requests."""
 
738
            mutter('_ftp_server: %s', message)
 
739
 
 
740
        def log_info(self, message, type='info'):
 
741
            """Override the asyncore.log_info so we don't stipple the screen."""
 
742
            mutter('_ftp_server %s: %s', type, message)
 
743
 
 
744
    _test_authorizer = test_authorizer
 
745
    _ftp_channel = ftp_channel
 
746
    _ftp_server = ftp_server
 
747
 
 
748
    return True
 
749
 
 
750
 
612
751
def get_test_permutations():
613
752
    """Return the permutations to be used in testing."""
614
 
    from bzrlib.tests import ftp_server
615
 
    return [(FtpTransport, ftp_server.FTPTestServer)]
 
753
    if not _setup_medusa():
 
754
        warn("You must install medusa (http://www.amk.ca/python/code/medusa.html) for FTP tests")
 
755
        return []
 
756
    else:
 
757
        return [(FtpTransport, FtpServer)]