/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: 2008-06-18 05:35:02 UTC
  • mto: This revision was merged to the branch mainline in revision 3510.
  • Revision ID: mbp@sourcefrog.net-20080618053502-9ogi5d5tx7w5ybf6
Change stray pdb calls to exceptions

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 errno
29
29
import ftplib
30
30
import getpass
31
31
import os
32
 
import random
 
32
import os.path
 
33
import urlparse
33
34
import socket
34
35
import stat
35
36
import time
 
37
import random
 
38
from warnings import warn
36
39
 
37
40
from bzrlib import (
38
41
    config,
48
51
    register_urlparse_netloc_protocol,
49
52
    Server,
50
53
    )
 
54
from bzrlib.transport.local import LocalURLServer
 
55
import bzrlib.ui
51
56
 
52
57
 
53
58
register_urlparse_netloc_protocol('aftp')
58
63
 
59
64
 
60
65
class FtpStatResult(object):
61
 
 
62
 
    def __init__(self, f, abspath):
 
66
    def __init__(self, f, relpath):
63
67
        try:
64
 
            self.st_size = f.size(abspath)
 
68
            self.st_size = f.size(relpath)
65
69
            self.st_mode = stat.S_IFREG
66
70
        except ftplib.error_perm:
67
71
            pwd = f.pwd()
68
72
            try:
69
 
                f.cwd(abspath)
 
73
                f.cwd(relpath)
70
74
                self.st_mode = stat.S_IFDIR
71
75
            finally:
72
76
                f.cwd(pwd)
95
99
        else:
96
100
            self.is_active = False
97
101
 
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
102
    def _get_FTP(self):
103
103
        """Return the ftplib.FTP instance for this object."""
104
104
        # Ensures that a connection is established
109
109
            self._set_connection(connection, credentials)
110
110
        return connection
111
111
 
112
 
    connection_class = ftplib.FTP
113
 
 
114
112
    def _create_connection(self, credentials=None):
115
113
        """Create a new connection with the provided credentials.
116
114
 
118
116
 
119
117
        :return: The created connection and its associated credentials.
120
118
 
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.
 
119
        The credentials are only the password as it may have been entered
 
120
        interactively by the user and may be different from the one provided
 
121
        in base url at transport creation time.
125
122
        """
126
123
        if credentials is None:
127
124
            user, password = self._user, self._password
130
127
 
131
128
        auth = config.AuthenticationConfig()
132
129
        if user is None:
133
 
            user = auth.get_user('ftp', self._host, port=self._port,
134
 
                                 default=getpass.getuser())
 
130
            user = auth.get_user('ftp', self._host, port=self._port)
 
131
            if user is None:
 
132
                # Default to local user
 
133
                user = getpass.getuser()
 
134
 
135
135
        mutter("Constructing FTP instance against %r" %
136
136
               ((self._host, self._port, user, '********',
137
137
                self.is_active),))
138
138
        try:
139
 
            connection = self.connection_class()
 
139
            connection = ftplib.FTP()
140
140
            connection.connect(host=self._host, port=self._port)
141
 
            self._login(connection, auth, user, password)
 
141
            if user and user != 'anonymous' and \
 
142
                    password is None: # '' is a valid password
 
143
                password = auth.get_password('ftp', self._host, user,
 
144
                                             port=self._port)
 
145
            connection.login(user=user, passwd=password)
142
146
            connection.set_pasv(not self.is_active)
143
 
            # binary mode is the default
144
 
            connection.voidcmd('TYPE I')
145
147
        except socket.error, e:
146
148
            raise errors.SocketConnectionError(self._host, self._port,
147
149
                                               msg='Unable to connect to',
151
153
                                        " %s" % str(e), orig_error=e)
152
154
        return connection, (user, password)
153
155
 
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
156
    def _reconnect(self):
162
157
        """Create a new connection with the previously used credentials"""
163
158
        credentials = self._get_credentials()
164
159
        connection, credentials = self._create_connection(credentials)
165
160
        self._set_connection(connection, credentials)
166
161
 
167
 
    def _translate_ftp_error(self, err, path, extra=None,
 
162
    def _translate_perm_error(self, err, path, extra=None,
168
163
                              unknown_exc=FtpPathError):
169
 
        """Try to translate an ftplib exception to a bzrlib exception.
 
164
        """Try to translate an ftplib.error_perm exception.
170
165
 
171
166
        :param err: The error to translate into a bzr error
172
167
        :param path: The path which had problems
174
169
        :param unknown_exc: If None, we will just raise the original exception
175
170
                    otherwise we raise unknown_exc(path, extra=extra)
176
171
        """
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
172
        s = str(err).lower()
181
173
        if not extra:
182
174
            extra = str(err)
193
185
            or (s.startswith('550 ') and 'unable to rename to' in extra)
194
186
            ):
195
187
            raise errors.NoSuchFile(path, extra=extra)
196
 
        elif ('file exists' in s):
 
188
        if ('file exists' in s):
197
189
            raise errors.FileExists(path, extra=extra)
198
 
        elif ('not a directory' in s):
 
190
        if ('not a directory' in s):
199
191
            raise errors.PathError(path, extra=extra)
200
 
        elif 'directory not empty' in s:
201
 
            raise errors.DirectoryNotEmpty(path, extra=extra)
202
192
 
203
193
        mutter('unable to understand error for path: %s: %s', path, err)
204
194
 
205
195
        if unknown_exc:
206
196
            raise unknown_exc(path, extra=extra)
207
 
        # TODO: jam 20060516 Consider re-raising the error wrapped in
 
197
        # TODO: jam 20060516 Consider re-raising the error wrapped in 
208
198
        #       something like TransportError, but this loses the traceback
209
199
        #       Also, 'sftp' has a generic 'Failure' mode, which we use failure_exc
210
200
        #       to handle. Consider doing something like that here.
211
201
        #raise TransportError(msg='Error for path: %s' % (path,), orig_error=e)
212
202
        raise
213
203
 
 
204
    def _remote_path(self, relpath):
 
205
        # XXX: It seems that ftplib does not handle Unicode paths
 
206
        # at the same time, medusa won't handle utf8 paths So if
 
207
        # we .encode(utf8) here (see ConnectedTransport
 
208
        # implementation), then we get a Server failure.  while
 
209
        # if we use str(), we get a UnicodeError, and the test
 
210
        # suite just skips testing UnicodePaths.
 
211
        relative = str(urlutils.unescape(relpath))
 
212
        remote_path = self._combine_paths(self._path, relative)
 
213
        return remote_path
 
214
 
214
215
    def has(self, relpath):
215
216
        """Does the target location exist?"""
216
217
        # FIXME jam 20060516 We *do* ask about directories in the test suite
309
310
            try:
310
311
                f.storbinary('STOR '+tmp_abspath, fp)
311
312
                self._rename_and_overwrite(tmp_abspath, abspath, f)
312
 
                self._setmode(relpath, mode)
313
313
                if bytes is not None:
314
314
                    return len(bytes)
315
315
                else:
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',
 
327
            self._translate_perm_error(e, abspath, extra='could not store',
328
328
                                       unknown_exc=errors.NoSuchFile)
329
329
        except ftplib.error_temp, e:
330
330
            if retries > _number_of_retries:
351
351
            mutter("FTP mkd: %s", abspath)
352
352
            f = self._get_FTP()
353
353
            f.mkd(abspath)
354
 
            self._setmode(relpath, mode)
355
354
        except ftplib.error_perm, e:
356
 
            self._translate_ftp_error(e, abspath,
 
355
            self._translate_perm_error(e, abspath,
357
356
                unknown_exc=errors.FileExists)
358
357
 
359
358
    def open_write_stream(self, relpath, mode=None):
379
378
            f = self._get_FTP()
380
379
            f.rmd(abspath)
381
380
        except ftplib.error_perm, e:
382
 
            self._translate_ftp_error(e, abspath, unknown_exc=errors.PathError)
 
381
            self._translate_perm_error(e, abspath, unknown_exc=errors.PathError)
383
382
 
384
383
    def append_file(self, relpath, f, mode=None):
385
384
        """Append the text in the file-like object into the final
386
385
        location.
387
386
        """
388
 
        text = f.read()
389
387
        abspath = self._remote_path(relpath)
390
388
        if self.has(relpath):
391
389
            ftp = self._get_FTP()
393
391
        else:
394
392
            result = 0
395
393
 
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)
 
394
        mutter("FTP appe to %s", abspath)
 
395
        self._try_append(relpath, f.read(), mode)
401
396
 
402
397
        return result
403
398
 
404
399
    def _try_append(self, relpath, text, mode=None, retries=0):
405
400
        """Try repeatedly to append the given text to the file at relpath.
406
 
 
 
401
        
407
402
        This is a recursive function. On errors, it will be called until the
408
403
        number of retries is exceeded.
409
404
        """
411
406
            abspath = self._remote_path(relpath)
412
407
            mutter("FTP appe (try %d) to %s", retries, abspath)
413
408
            ftp = self._get_FTP()
 
409
            ftp.voidcmd("TYPE I")
414
410
            cmd = "APPE %s" % abspath
415
411
            conn = ftp.transfercmd(cmd)
416
412
            conn.sendall(text)
417
413
            conn.close()
418
 
            self._setmode(relpath, mode)
 
414
            if mode:
 
415
                self._setmode(relpath, mode)
419
416
            ftp.getresp()
420
417
        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)
 
418
            self._translate_perm_error(e, abspath, extra='error appending',
 
419
                unknown_exc=errors.NoSuchFile)
430
420
        except ftplib.error_temp, e:
431
421
            if retries > _number_of_retries:
432
 
                raise errors.TransportError(
433
 
                    "FTP temporary error during APPEND %s. Aborting."
434
 
                    % abspath, orig_error=e)
 
422
                raise errors.TransportError("FTP temporary error during APPEND %s." \
 
423
                        "Aborting." % abspath, orig_error=e)
435
424
            else:
436
425
                warning("FTP temporary error: %s. Retrying.", str(e))
437
426
                self._reconnect()
438
427
                self._try_append(relpath, text, mode, retries+1)
439
428
 
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
429
    def _setmode(self, relpath, mode):
448
430
        """Set permissions on a path.
449
431
 
450
432
        Only set permissions if the FTP server supports the 'SITE CHMOD'
451
433
        extension.
452
434
        """
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))
 
435
        try:
 
436
            mutter("FTP site chmod: setting permissions to %s on %s",
 
437
                str(mode), self._remote_path(relpath))
 
438
            ftp = self._get_FTP()
 
439
            cmd = "SITE CHMOD %s %s" % (self._remote_path(relpath), str(mode))
 
440
            ftp.sendcmd(cmd)
 
441
        except ftplib.error_perm, e:
 
442
            # Command probably not available on this server
 
443
            warning("FTP Could not set permissions to %s on %s. %s",
 
444
                    str(mode), self._remote_path(relpath), str(e))
465
445
 
466
446
    # TODO: jam 20060516 I believe ftp allows you to tell an ftp server
467
447
    #       to copy something to another machine. And you may be able
478
458
    def _rename(self, abs_from, abs_to, f):
479
459
        try:
480
460
            f.rename(abs_from, abs_to)
481
 
        except (ftplib.error_temp, ftplib.error_perm), e:
482
 
            self._translate_ftp_error(e, abs_from,
 
461
        except ftplib.error_perm, e:
 
462
            self._translate_perm_error(e, abs_from,
483
463
                ': unable to rename to %r' % (abs_to))
484
464
 
485
465
    def move(self, rel_from, rel_to):
491
471
            f = self._get_FTP()
492
472
            self._rename_and_overwrite(abs_from, abs_to, f)
493
473
        except ftplib.error_perm, e:
494
 
            self._translate_ftp_error(e, abs_from,
495
 
                extra='unable to rename to %r' % (rel_to,),
 
474
            self._translate_perm_error(e, abs_from,
 
475
                extra='unable to rename to %r' % (rel_to,), 
496
476
                unknown_exc=errors.PathError)
497
477
 
498
478
    def _rename_and_overwrite(self, abs_from, abs_to, f):
515
495
            mutter("FTP rm: %s", abspath)
516
496
            f.delete(abspath)
517
497
        except ftplib.error_perm, e:
518
 
            self._translate_ftp_error(e, abspath, 'error deleting',
 
498
            self._translate_perm_error(e, abspath, 'error deleting',
519
499
                unknown_exc=errors.NoSuchFile)
520
500
 
521
501
    def external_url(self):
533
513
        mutter("FTP nlst: %s", basepath)
534
514
        f = self._get_FTP()
535
515
        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
 
 
 
516
            paths = f.nlst(basepath)
 
517
        except ftplib.error_perm, e:
 
518
            self._translate_perm_error(e, relpath, extra='error with list_dir')
 
519
        except ftplib.error_temp, e:
 
520
            # xs4all's ftp server raises a 450 temp error when listing an empty
 
521
            # directory. Check for that and just return an empty list in that
 
522
            # case. See bug #215522
 
523
            if str(e).lower().startswith('450 no files found'):
 
524
                mutter('FTP Server returned "%s" for nlst.'
 
525
                       ' Assuming it means empty directory',
 
526
                       str(e))
 
527
                return []
 
528
            raise
556
529
        # If FTP.nlst returns paths prefixed by relpath, strip 'em
557
530
        if paths and paths[0].startswith(basepath):
558
531
            entries = [path[len(basepath)+1:] for path in paths]
585
558
            f = self._get_FTP()
586
559
            return FtpStatResult(f, abspath)
587
560
        except ftplib.error_perm, e:
588
 
            self._translate_ftp_error(e, abspath, extra='error w/ stat')
 
561
            self._translate_perm_error(e, abspath, extra='error w/ stat')
589
562
 
590
563
    def lock_read(self, relpath):
591
564
        """Lock the given file for shared (read) access.
611
584
 
612
585
def get_test_permutations():
613
586
    """Return the permutations to be used in testing."""
614
 
    from bzrlib.tests import ftp_server
615
 
    return [(FtpTransport, ftp_server.FTPTestServer)]
 
587
    from bzrlib import tests
 
588
    if tests.FTPServerFeature.available():
 
589
        from bzrlib.tests import ftp_server
 
590
        return [(FtpTransport, ftp_server.FTPServer)]
 
591
    else:
 
592
        # Dummy server to have the test suite report the number of tests
 
593
        # needing that feature. We raise UnavailableFeature from methods before
 
594
        # the test server is being used. Doing so in the setUp method has bad
 
595
        # side-effects (tearDown is never called).
 
596
        class UnavailableFTPServer(object):
 
597
 
 
598
            def setUp(self):
 
599
                pass
 
600
 
 
601
            def tearDown(self):
 
602
                pass
 
603
 
 
604
            def get_url(self):
 
605
                raise tests.UnavailableFeature(tests.FTPServerFeature)
 
606
 
 
607
            def get_bogus_url(self):
 
608
                raise tests.UnavailableFeature(tests.FTPServerFeature)
 
609
 
 
610
        return [(FtpTransport, UnavailableFTPServer)]