← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transport/ftp.py

  • Committer: Vincent Ladeuil
  • Date: 2007-11-24 14:20:59 UTC
  • mto: (3928.1.1 bzr.integration)
  • mto: This revision was merged to the branch mainline in revision 3929.
  • Revision ID: v.ladeuil+lp@free.fr-20071124142059-2114qtsgfdv8g9p1
Ssl files needed for the test https server.

* bzrlib/tests/ssl_certs/create_ssls.py: 
Script to create the ssl keys and certificates.

* bzrlib/tests/ssl_certs/server.crt: 
Server certificate signed by the certificate authority.

* bzrlib/tests/ssl_certs/server.csr: 
Server certificate signing request.

* bzrlib/tests/ssl_certs/server_without_pass.key: 
Server key usable without password.

* bzrlib/tests/ssl_certs/server_with_pass.key: 
Server key.

* bzrlib/tests/ssl_certs/ca.key: 
Certificate authority private key.

* bzrlib/tests/ssl_certs/ca.crt: 
Certificate authority certificate.

* bzrlib/tests/ssl_certs/__init__.py: 
Provide access to ssl files (keys and certificates). 

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
 
import getpass
31
30
import os
32
 
import random
33
 
import socket
 
31
import os.path
 
32
import urlparse
34
33
import stat
35
34
import time
 
35
import random
 
36
from warnings import warn
36
37
 
37
38
from bzrlib import (
38
39
    config,
48
49
    register_urlparse_netloc_protocol,
49
50
    Server,
50
51
    )
 
52
from bzrlib.transport.local import LocalURLServer
 
53
import bzrlib.ui
51
54
 
52
55
 
53
56
register_urlparse_netloc_protocol('aftp')
58
61
 
59
62
 
60
63
class FtpStatResult(object):
61
 
 
62
 
    def __init__(self, f, abspath):
 
64
    def __init__(self, f, relpath):
63
65
        try:
64
 
            self.st_size = f.size(abspath)
 
66
            self.st_size = f.size(relpath)
65
67
            self.st_mode = stat.S_IFREG
66
68
        except ftplib.error_perm:
67
69
            pwd = f.pwd()
68
70
            try:
69
 
                f.cwd(abspath)
 
71
                f.cwd(relpath)
70
72
                self.st_mode = stat.S_IFDIR
71
73
            finally:
72
74
                f.cwd(pwd)
85
87
 
86
88
    def __init__(self, base, _from_transport=None):
87
89
        """Set the base path where files will be stored."""
88
 
        if not (base.startswith('ftp://') or base.startswith('aftp://')):
89
 
            raise ValueError(base)
 
90
        assert base.startswith('ftp://') or base.startswith('aftp://')
90
91
        super(FtpTransport, self).__init__(base,
91
92
                                           _from_transport=_from_transport)
92
93
        self._unqualified_scheme = 'ftp'
95
96
        else:
96
97
            self.is_active = False
97
98
 
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
99
    def _get_FTP(self):
103
100
        """Return the ftplib.FTP instance for this object."""
104
101
        # Ensures that a connection is established
109
106
            self._set_connection(connection, credentials)
110
107
        return connection
111
108
 
112
 
    connection_class = ftplib.FTP
113
 
 
114
109
    def _create_connection(self, credentials=None):
115
110
        """Create a new connection with the provided credentials.
116
111
 
118
113
 
119
114
        :return: The created connection and its associated credentials.
120
115
 
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.
 
116
        The credentials are only the password as it may have been entered
 
117
        interactively by the user and may be different from the one provided
 
118
        in base url at transport creation time.
125
119
        """
126
120
        if credentials is None:
127
121
            user, password = self._user, self._password
130
124
 
131
125
        auth = config.AuthenticationConfig()
132
126
        if user is None:
133
 
            user = auth.get_user('ftp', self._host, port=self._port,
134
 
                                 default=getpass.getuser())
 
127
            user = auth.get_user('ftp', self._host, port=self._port)
 
128
            if user is None:
 
129
                # Default to local user
 
130
                user = getpass.getuser()
 
131
 
135
132
        mutter("Constructing FTP instance against %r" %
136
133
               ((self._host, self._port, user, '********',
137
134
                self.is_active),))
138
135
        try:
139
 
            connection = self.connection_class()
 
136
            connection = ftplib.FTP()
140
137
            connection.connect(host=self._host, port=self._port)
141
 
            self._login(connection, auth, user, password)
 
138
            if user and user != 'anonymous' and \
 
139
                    password is None: # '' is a valid password
 
140
                password = auth.get_password('ftp', self._host, user,
 
141
                                             port=self._port)
 
142
            connection.login(user=user, passwd=password)
142
143
            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
144
        except ftplib.error_perm, e:
150
145
            raise errors.TransportError(msg="Error setting up connection:"
151
146
                                        " %s" % str(e), orig_error=e)
152
147
        return connection, (user, password)
153
148
 
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
149
    def _reconnect(self):
162
150
        """Create a new connection with the previously used credentials"""
163
151
        credentials = self._get_credentials()
164
152
        connection, credentials = self._create_connection(credentials)
165
153
        self._set_connection(connection, credentials)
166
154
 
167
 
    def _translate_ftp_error(self, err, path, extra=None,
 
155
    def _translate_perm_error(self, err, path, extra=None,
168
156
                              unknown_exc=FtpPathError):
169
 
        """Try to translate an ftplib exception to a bzrlib exception.
 
157
        """Try to translate an ftplib.error_perm exception.
170
158
 
171
159
        :param err: The error to translate into a bzr error
172
160
        :param path: The path which had problems
174
162
        :param unknown_exc: If None, we will just raise the original exception
175
163
                    otherwise we raise unknown_exc(path, extra=extra)
176
164
        """
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
165
        s = str(err).lower()
181
166
        if not extra:
182
167
            extra = str(err)
187
172
            or 'no such dir' in s
188
173
            or 'could not create file' in s # vsftpd
189
174
            or 'file doesn\'t exist' in s
190
 
            or 'rnfr command failed.' in s # vsftpd RNFR reply if file not found
191
175
            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
176
            ):
195
177
            raise errors.NoSuchFile(path, extra=extra)
196
 
        elif ('file exists' in s):
 
178
        if ('file exists' in s):
197
179
            raise errors.FileExists(path, extra=extra)
198
 
        elif ('not a directory' in s):
 
180
        if ('not a directory' in s):
199
181
            raise errors.PathError(path, extra=extra)
200
 
        elif 'directory not empty' in s:
201
 
            raise errors.DirectoryNotEmpty(path, extra=extra)
202
182
 
203
183
        mutter('unable to understand error for path: %s: %s', path, err)
204
184
 
205
185
        if unknown_exc:
206
186
            raise unknown_exc(path, extra=extra)
207
 
        # TODO: jam 20060516 Consider re-raising the error wrapped in
 
187
        # TODO: jam 20060516 Consider re-raising the error wrapped in 
208
188
        #       something like TransportError, but this loses the traceback
209
189
        #       Also, 'sftp' has a generic 'Failure' mode, which we use failure_exc
210
190
        #       to handle. Consider doing something like that here.
211
191
        #raise TransportError(msg='Error for path: %s' % (path,), orig_error=e)
212
192
        raise
213
193
 
 
194
    def _remote_path(self, relpath):
 
195
        # XXX: It seems that ftplib does not handle Unicode paths
 
196
        # at the same time, medusa won't handle utf8 paths So if
 
197
        # we .encode(utf8) here (see ConnectedTransport
 
198
        # implementation), then we get a Server failure.  while
 
199
        # if we use str(), we get a UnicodeError, and the test
 
200
        # suite just skips testing UnicodePaths.
 
201
        relative = str(urlutils.unescape(relpath))
 
202
        remote_path = self._combine_paths(self._path, relative)
 
203
        return remote_path
 
204
 
214
205
    def has(self, relpath):
215
206
        """Does the target location exist?"""
216
207
        # FIXME jam 20060516 We *do* ask about directories in the test suite
309
300
            try:
310
301
                f.storbinary('STOR '+tmp_abspath, fp)
311
302
                self._rename_and_overwrite(tmp_abspath, abspath, f)
312
 
                self._setmode(relpath, mode)
313
303
                if bytes is not None:
314
304
                    return len(bytes)
315
305
                else:
324
314
                    raise e
325
315
                raise
326
316
        except ftplib.error_perm, e:
327
 
            self._translate_ftp_error(e, abspath, extra='could not store',
 
317
            self._translate_perm_error(e, abspath, extra='could not store',
328
318
                                       unknown_exc=errors.NoSuchFile)
329
319
        except ftplib.error_temp, e:
330
320
            if retries > _number_of_retries:
351
341
            mutter("FTP mkd: %s", abspath)
352
342
            f = self._get_FTP()
353
343
            f.mkd(abspath)
354
 
            self._setmode(relpath, mode)
355
344
        except ftplib.error_perm, e:
356
 
            self._translate_ftp_error(e, abspath,
 
345
            self._translate_perm_error(e, abspath,
357
346
                unknown_exc=errors.FileExists)
358
347
 
359
348
    def open_write_stream(self, relpath, mode=None):
379
368
            f = self._get_FTP()
380
369
            f.rmd(abspath)
381
370
        except ftplib.error_perm, e:
382
 
            self._translate_ftp_error(e, abspath, unknown_exc=errors.PathError)
 
371
            self._translate_perm_error(e, abspath, unknown_exc=errors.PathError)
383
372
 
384
373
    def append_file(self, relpath, f, mode=None):
385
374
        """Append the text in the file-like object into the final
386
375
        location.
387
376
        """
388
 
        text = f.read()
389
377
        abspath = self._remote_path(relpath)
390
378
        if self.has(relpath):
391
379
            ftp = self._get_FTP()
393
381
        else:
394
382
            result = 0
395
383
 
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)
 
384
        mutter("FTP appe to %s", abspath)
 
385
        self._try_append(relpath, f.read(), mode)
401
386
 
402
387
        return result
403
388
 
404
389
    def _try_append(self, relpath, text, mode=None, retries=0):
405
390
        """Try repeatedly to append the given text to the file at relpath.
406
 
 
 
391
        
407
392
        This is a recursive function. On errors, it will be called until the
408
393
        number of retries is exceeded.
409
394
        """
411
396
            abspath = self._remote_path(relpath)
412
397
            mutter("FTP appe (try %d) to %s", retries, abspath)
413
398
            ftp = self._get_FTP()
 
399
            ftp.voidcmd("TYPE I")
414
400
            cmd = "APPE %s" % abspath
415
401
            conn = ftp.transfercmd(cmd)
416
402
            conn.sendall(text)
417
403
            conn.close()
418
 
            self._setmode(relpath, mode)
 
404
            if mode:
 
405
                self._setmode(relpath, mode)
419
406
            ftp.getresp()
420
407
        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)
 
408
            self._translate_perm_error(e, abspath, extra='error appending',
 
409
                unknown_exc=errors.NoSuchFile)
430
410
        except ftplib.error_temp, e:
431
411
            if retries > _number_of_retries:
432
 
                raise errors.TransportError(
433
 
                    "FTP temporary error during APPEND %s. Aborting."
434
 
                    % abspath, orig_error=e)
 
412
                raise errors.TransportError("FTP temporary error during APPEND %s." \
 
413
                        "Aborting." % abspath, orig_error=e)
435
414
            else:
436
415
                warning("FTP temporary error: %s. Retrying.", str(e))
437
416
                self._reconnect()
438
417
                self._try_append(relpath, text, mode, retries+1)
439
418
 
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
419
    def _setmode(self, relpath, mode):
448
420
        """Set permissions on a path.
449
421
 
450
422
        Only set permissions if the FTP server supports the 'SITE CHMOD'
451
423
        extension.
452
424
        """
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))
 
425
        try:
 
426
            mutter("FTP site chmod: setting permissions to %s on %s",
 
427
                str(mode), self._remote_path(relpath))
 
428
            ftp = self._get_FTP()
 
429
            cmd = "SITE CHMOD %s %s" % (self._remote_path(relpath), str(mode))
 
430
            ftp.sendcmd(cmd)
 
431
        except ftplib.error_perm, e:
 
432
            # Command probably not available on this server
 
433
            warning("FTP Could not set permissions to %s on %s. %s",
 
434
                    str(mode), self._remote_path(relpath), str(e))
465
435
 
466
436
    # TODO: jam 20060516 I believe ftp allows you to tell an ftp server
467
437
    #       to copy something to another machine. And you may be able
478
448
    def _rename(self, abs_from, abs_to, f):
479
449
        try:
480
450
            f.rename(abs_from, abs_to)
481
 
        except (ftplib.error_temp, ftplib.error_perm), e:
482
 
            self._translate_ftp_error(e, abs_from,
 
451
        except ftplib.error_perm, e:
 
452
            self._translate_perm_error(e, abs_from,
483
453
                ': unable to rename to %r' % (abs_to))
484
454
 
485
455
    def move(self, rel_from, rel_to):
491
461
            f = self._get_FTP()
492
462
            self._rename_and_overwrite(abs_from, abs_to, f)
493
463
        except ftplib.error_perm, e:
494
 
            self._translate_ftp_error(e, abs_from,
495
 
                extra='unable to rename to %r' % (rel_to,),
 
464
            self._translate_perm_error(e, abs_from,
 
465
                extra='unable to rename to %r' % (rel_to,), 
496
466
                unknown_exc=errors.PathError)
497
467
 
498
468
    def _rename_and_overwrite(self, abs_from, abs_to, f):
515
485
            mutter("FTP rm: %s", abspath)
516
486
            f.delete(abspath)
517
487
        except ftplib.error_perm, e:
518
 
            self._translate_ftp_error(e, abspath, 'error deleting',
 
488
            self._translate_perm_error(e, abspath, 'error deleting',
519
489
                unknown_exc=errors.NoSuchFile)
520
490
 
521
491
    def external_url(self):
533
503
        mutter("FTP nlst: %s", basepath)
534
504
        f = self._get_FTP()
535
505
        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
 
 
 
506
            paths = f.nlst(basepath)
 
507
        except ftplib.error_perm, e:
 
508
            self._translate_perm_error(e, relpath, extra='error with list_dir')
556
509
        # If FTP.nlst returns paths prefixed by relpath, strip 'em
557
510
        if paths and paths[0].startswith(basepath):
558
511
            entries = [path[len(basepath)+1:] for path in paths]
585
538
            f = self._get_FTP()
586
539
            return FtpStatResult(f, abspath)
587
540
        except ftplib.error_perm, e:
588
 
            self._translate_ftp_error(e, abspath, extra='error w/ stat')
 
541
            self._translate_perm_error(e, abspath, extra='error w/ stat')
589
542
 
590
543
    def lock_read(self, relpath):
591
544
        """Lock the given file for shared (read) access.
611
564
 
612
565
def get_test_permutations():
613
566
    """Return the permutations to be used in testing."""
614
 
    from bzrlib.tests import ftp_server
615
 
    return [(FtpTransport, ftp_server.FTPTestServer)]
 
567
    from bzrlib import tests
 
568
    if tests.FTPServerFeature.available():
 
569
        from bzrlib.tests import ftp_server
 
570
        return [(FtpTransport, ftp_server.FTPServer)]
 
571
    else:
 
572
        # Dummy server to have the test suite report the number of tests
 
573
        # needing that feature.
 
574
        class UnavailableFTPServer(object):
 
575
            def setUp(self):
 
576
                raise tests.UnavailableFeature(tests.FTPServerFeature)
 
577
 
 
578
        return [(FtpTransport, UnavailableFTPServer)]