1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
"""Implementation of Transport over ftp.
18
Written by Daniel Silverstone <dsilvers@digital-scurf.org> with serious
19
cargo-culting from the sftp transport and the http transport.
21
It provides the ftp:// and aftp:// protocols where ftp:// is passive ftp
22
and aftp:// is active ftp. Most people will want passive ftp for traversing
23
NAT and other firewalls, so it's best to use it unless you explicitly want
24
active, in which case aftp:// will be your friend.
27
from cStringIO import StringIO
40
from warnings import warn
47
from bzrlib.trace import mutter, warning
48
from bzrlib.transport import (
49
AppendBasedFileStream,
54
from bzrlib.transport.local import LocalURLServer
60
class FtpPathError(errors.PathError):
61
"""FTP failed for path: %(path)s%(extra)s"""
64
class FtpStatResult(object):
65
def __init__(self, f, relpath):
67
self.st_size = f.size(relpath)
68
self.st_mode = stat.S_IFREG
69
except ftplib.error_perm:
73
self.st_mode = stat.S_IFDIR
78
_number_of_retries = 2
79
_sleep_between_retries = 5
81
# FIXME: there are inconsistencies in the way temporary errors are
82
# handled. Sometimes we reconnect, sometimes we raise an exception. Care should
83
# be taken to analyze the implications for write operations (read operations
84
# are safe to retry). Overall even some read operations are never
85
# retried. --vila 20070720 (Bug #127164)
86
class FtpTransport(ConnectedTransport):
87
"""This is the transport agent for ftp:// access."""
89
def __init__(self, base, _from_transport=None):
90
"""Set the base path where files will be stored."""
91
assert base.startswith('ftp://') or base.startswith('aftp://')
92
super(FtpTransport, self).__init__(base,
93
_from_transport=_from_transport)
94
self._unqualified_scheme = 'ftp'
95
if self._scheme == 'aftp':
98
self.is_active = False
101
"""Return the ftplib.FTP instance for this object."""
102
# Ensures that a connection is established
103
connection = self._get_connection()
104
if connection is None:
105
# First connection ever
106
connection, credentials = self._create_connection()
107
self._set_connection(connection, credentials)
110
def _create_connection(self, credentials=None):
111
"""Create a new connection with the provided credentials.
113
:param credentials: The credentials needed to establish the connection.
115
:return: The created connection and its associated credentials.
117
The credentials are only the password as it may have been entered
118
interactively by the user and may be different from the one provided
119
in base url at transport creation time.
121
if credentials is None:
122
password = self._password
124
password = credentials
126
mutter("Constructing FTP instance against %r" %
127
((self._host, self._port, self._user, '********',
130
connection = ftplib.FTP()
131
connection.connect(host=self._host, port=self._port)
132
if self._user and self._user != 'anonymous' and \
133
password is None: # '' is a valid password
134
get_password = bzrlib.ui.ui_factory.get_password
135
password = get_password(prompt='FTP %(user)s@%(host)s password',
136
user=self._user, host=self._host)
137
connection.login(user=self._user, passwd=password)
138
connection.set_pasv(not self.is_active)
139
except ftplib.error_perm, e:
140
raise errors.TransportError(msg="Error setting up connection:"
141
" %s" % str(e), orig_error=e)
142
return connection, password
144
def _reconnect(self):
145
"""Create a new connection with the previously used credentials"""
146
credentials = self._get_credentials()
147
connection, credentials = self._create_connection(credentials)
148
self._set_connection(connection, credentials)
150
def _translate_perm_error(self, err, path, extra=None,
151
unknown_exc=FtpPathError):
152
"""Try to translate an ftplib.error_perm exception.
154
:param err: The error to translate into a bzr error
155
:param path: The path which had problems
156
:param extra: Extra information which can be included
157
:param unknown_exc: If None, we will just raise the original exception
158
otherwise we raise unknown_exc(path, extra=extra)
164
extra += ': ' + str(err)
165
if ('no such file' in s
166
or 'could not open' in s
167
or 'no such dir' in s
168
or 'could not create file' in s # vsftpd
169
or 'file doesn\'t exist' in s
170
or 'file/directory not found' in s # filezilla server
172
raise errors.NoSuchFile(path, extra=extra)
173
if ('file exists' in s):
174
raise errors.FileExists(path, extra=extra)
175
if ('not a directory' in s):
176
raise errors.PathError(path, extra=extra)
178
mutter('unable to understand error for path: %s: %s', path, err)
181
raise unknown_exc(path, extra=extra)
182
# TODO: jam 20060516 Consider re-raising the error wrapped in
183
# something like TransportError, but this loses the traceback
184
# Also, 'sftp' has a generic 'Failure' mode, which we use failure_exc
185
# to handle. Consider doing something like that here.
186
#raise TransportError(msg='Error for path: %s' % (path,), orig_error=e)
189
def _remote_path(self, relpath):
190
# XXX: It seems that ftplib does not handle Unicode paths
191
# at the same time, medusa won't handle utf8 paths So if
192
# we .encode(utf8) here (see ConnectedTransport
193
# implementation), then we get a Server failure. while
194
# if we use str(), we get a UnicodeError, and the test
195
# suite just skips testing UnicodePaths.
196
relative = str(urlutils.unescape(relpath))
197
remote_path = self._combine_paths(self._path, relative)
200
def has(self, relpath):
201
"""Does the target location exist?"""
202
# FIXME jam 20060516 We *do* ask about directories in the test suite
203
# We don't seem to in the actual codebase
204
# XXX: I assume we're never asked has(dirname) and thus I use
205
# the FTP size command and assume that if it doesn't raise,
207
abspath = self._remote_path(relpath)
210
mutter('FTP has check: %s => %s', relpath, abspath)
212
mutter("FTP has: %s", abspath)
214
except ftplib.error_perm, e:
215
if ('is a directory' in str(e).lower()):
216
mutter("FTP has dir: %s: %s", abspath, e)
218
mutter("FTP has not: %s: %s", abspath, e)
221
def get(self, relpath, decode=False, retries=0):
222
"""Get the file at the given relative path.
224
:param relpath: The relative path to the file
225
:param retries: Number of retries after temporary failures so far
228
We're meant to return a file-like object which bzr will
229
then read from. For now we do this via the magic of StringIO
231
# TODO: decode should be deprecated
233
mutter("FTP get: %s", self._remote_path(relpath))
236
f.retrbinary('RETR '+self._remote_path(relpath), ret.write, 8192)
239
except ftplib.error_perm, e:
240
raise errors.NoSuchFile(self.abspath(relpath), extra=str(e))
241
except ftplib.error_temp, e:
242
if retries > _number_of_retries:
243
raise errors.TransportError(msg="FTP temporary error during GET %s. Aborting."
244
% self.abspath(relpath),
247
warning("FTP temporary error: %s. Retrying.", str(e))
249
return self.get(relpath, decode, retries+1)
251
if retries > _number_of_retries:
252
raise errors.TransportError("FTP control connection closed during GET %s."
253
% self.abspath(relpath),
256
warning("FTP control connection closed. Trying to reopen.")
257
time.sleep(_sleep_between_retries)
259
return self.get(relpath, decode, retries+1)
261
def put_file(self, relpath, fp, mode=None, retries=0):
262
"""Copy the file-like or string object into the location.
264
:param relpath: Location to put the contents, relative to base.
265
:param fp: File-like or string object.
266
:param retries: Number of retries after temporary failures so far
269
TODO: jam 20051215 ftp as a protocol seems to support chmod, but
272
abspath = self._remote_path(relpath)
273
tmp_abspath = '%s.tmp.%.9f.%d.%d' % (abspath, time.time(),
274
os.getpid(), random.randint(0,0x7FFFFFFF))
276
if getattr(fp, 'read', None) is None:
277
# hand in a string IO
281
# capture the byte count; .read() may be read only so
283
class byte_counter(object):
284
def __init__(self, fp):
286
self.counted_bytes = 0
287
def read(self, count):
288
result = self.fp.read(count)
289
self.counted_bytes += len(result)
291
fp = byte_counter(fp)
293
mutter("FTP put: %s", abspath)
296
f.storbinary('STOR '+tmp_abspath, fp)
297
self._rename_and_overwrite(tmp_abspath, abspath, f)
298
if bytes is not None:
301
return fp.counted_bytes
302
except (ftplib.error_temp,EOFError), e:
303
warning("Failure during ftp PUT. Deleting temporary file.")
305
f.delete(tmp_abspath)
307
warning("Failed to delete temporary file on the"
308
" server.\nFile: %s", tmp_abspath)
311
except ftplib.error_perm, e:
312
self._translate_perm_error(e, abspath, extra='could not store',
313
unknown_exc=errors.NoSuchFile)
314
except ftplib.error_temp, e:
315
if retries > _number_of_retries:
316
raise errors.TransportError("FTP temporary error during PUT %s. Aborting."
317
% self.abspath(relpath), orig_error=e)
319
warning("FTP temporary error: %s. Retrying.", str(e))
321
self.put_file(relpath, fp, mode, retries+1)
323
if retries > _number_of_retries:
324
raise errors.TransportError("FTP control connection closed during PUT %s."
325
% self.abspath(relpath), orig_error=e)
327
warning("FTP control connection closed. Trying to reopen.")
328
time.sleep(_sleep_between_retries)
330
self.put_file(relpath, fp, mode, retries+1)
332
def mkdir(self, relpath, mode=None):
333
"""Create a directory at the given path."""
334
abspath = self._remote_path(relpath)
336
mutter("FTP mkd: %s", abspath)
339
except ftplib.error_perm, e:
340
self._translate_perm_error(e, abspath,
341
unknown_exc=errors.FileExists)
343
def open_write_stream(self, relpath, mode=None):
344
"""See Transport.open_write_stream."""
345
self.put_bytes(relpath, "", mode)
346
result = AppendBasedFileStream(self, relpath)
347
_file_streams[self.abspath(relpath)] = result
350
def recommended_page_size(self):
351
"""See Transport.recommended_page_size().
353
For FTP we suggest a large page size to reduce the overhead
354
introduced by latency.
358
def rmdir(self, rel_path):
359
"""Delete the directory at rel_path"""
360
abspath = self._remote_path(rel_path)
362
mutter("FTP rmd: %s", abspath)
365
except ftplib.error_perm, e:
366
self._translate_perm_error(e, abspath, unknown_exc=errors.PathError)
368
def append_file(self, relpath, f, mode=None):
369
"""Append the text in the file-like object into the final
372
abspath = self._remote_path(relpath)
373
if self.has(relpath):
374
ftp = self._get_FTP()
375
result = ftp.size(abspath)
379
mutter("FTP appe to %s", abspath)
380
self._try_append(relpath, f.read(), mode)
384
def _try_append(self, relpath, text, mode=None, retries=0):
385
"""Try repeatedly to append the given text to the file at relpath.
387
This is a recursive function. On errors, it will be called until the
388
number of retries is exceeded.
391
abspath = self._remote_path(relpath)
392
mutter("FTP appe (try %d) to %s", retries, abspath)
393
ftp = self._get_FTP()
394
ftp.voidcmd("TYPE I")
395
cmd = "APPE %s" % abspath
396
conn = ftp.transfercmd(cmd)
400
self._setmode(relpath, mode)
402
except ftplib.error_perm, e:
403
self._translate_perm_error(e, abspath, extra='error appending',
404
unknown_exc=errors.NoSuchFile)
405
except ftplib.error_temp, e:
406
if retries > _number_of_retries:
407
raise errors.TransportError("FTP temporary error during APPEND %s." \
408
"Aborting." % abspath, orig_error=e)
410
warning("FTP temporary error: %s. Retrying.", str(e))
412
self._try_append(relpath, text, mode, retries+1)
414
def _setmode(self, relpath, mode):
415
"""Set permissions on a path.
417
Only set permissions if the FTP server supports the 'SITE CHMOD'
421
mutter("FTP site chmod: setting permissions to %s on %s",
422
str(mode), self._remote_path(relpath))
423
ftp = self._get_FTP()
424
cmd = "SITE CHMOD %s %s" % (self._remote_path(relpath), str(mode))
426
except ftplib.error_perm, e:
427
# Command probably not available on this server
428
warning("FTP Could not set permissions to %s on %s. %s",
429
str(mode), self._remote_path(relpath), str(e))
431
# TODO: jam 20060516 I believe ftp allows you to tell an ftp server
432
# to copy something to another machine. And you may be able
433
# to give it its own address as the 'to' location.
434
# So implement a fancier 'copy()'
436
def rename(self, rel_from, rel_to):
437
abs_from = self._remote_path(rel_from)
438
abs_to = self._remote_path(rel_to)
439
mutter("FTP rename: %s => %s", abs_from, abs_to)
441
return self._rename(abs_from, abs_to, f)
443
def _rename(self, abs_from, abs_to, f):
445
f.rename(abs_from, abs_to)
446
except ftplib.error_perm, e:
447
self._translate_perm_error(e, abs_from,
448
': unable to rename to %r' % (abs_to))
450
def move(self, rel_from, rel_to):
451
"""Move the item at rel_from to the location at rel_to"""
452
abs_from = self._remote_path(rel_from)
453
abs_to = self._remote_path(rel_to)
455
mutter("FTP mv: %s => %s", abs_from, abs_to)
457
self._rename_and_overwrite(abs_from, abs_to, f)
458
except ftplib.error_perm, e:
459
self._translate_perm_error(e, abs_from,
460
extra='unable to rename to %r' % (rel_to,),
461
unknown_exc=errors.PathError)
463
def _rename_and_overwrite(self, abs_from, abs_to, f):
464
"""Do a fancy rename on the remote server.
466
Using the implementation provided by osutils.
468
osutils.fancy_rename(abs_from, abs_to,
469
rename_func=lambda p1, p2: self._rename(p1, p2, f),
470
unlink_func=lambda p: self._delete(p, f))
472
def delete(self, relpath):
473
"""Delete the item at relpath"""
474
abspath = self._remote_path(relpath)
476
self._delete(abspath, f)
478
def _delete(self, abspath, f):
480
mutter("FTP rm: %s", abspath)
482
except ftplib.error_perm, e:
483
self._translate_perm_error(e, abspath, 'error deleting',
484
unknown_exc=errors.NoSuchFile)
486
def external_url(self):
487
"""See bzrlib.transport.Transport.external_url."""
488
# FTP URL's are externally usable.
492
"""See Transport.listable."""
495
def list_dir(self, relpath):
496
"""See Transport.list_dir."""
497
basepath = self._remote_path(relpath)
498
mutter("FTP nlst: %s", basepath)
501
paths = f.nlst(basepath)
502
except ftplib.error_perm, e:
503
self._translate_perm_error(e, relpath, extra='error with list_dir')
504
# If FTP.nlst returns paths prefixed by relpath, strip 'em
505
if paths and paths[0].startswith(basepath):
506
entries = [path[len(basepath)+1:] for path in paths]
509
# Remove . and .. if present
510
return [urlutils.escape(entry) for entry in entries
511
if entry not in ('.', '..')]
513
def iter_files_recursive(self):
514
"""See Transport.iter_files_recursive.
516
This is cargo-culted from the SFTP transport"""
517
mutter("FTP iter_files_recursive")
518
queue = list(self.list_dir("."))
520
relpath = queue.pop(0)
521
st = self.stat(relpath)
522
if stat.S_ISDIR(st.st_mode):
523
for i, basename in enumerate(self.list_dir(relpath)):
524
queue.insert(i, relpath+"/"+basename)
528
def stat(self, relpath):
529
"""Return the stat information for a file."""
530
abspath = self._remote_path(relpath)
532
mutter("FTP stat: %s", abspath)
534
return FtpStatResult(f, abspath)
535
except ftplib.error_perm, e:
536
self._translate_perm_error(e, abspath, extra='error w/ stat')
538
def lock_read(self, relpath):
539
"""Lock the given file for shared (read) access.
540
:return: A lock object, which should be passed to Transport.unlock()
542
# The old RemoteBranch ignore lock for reading, so we will
543
# continue that tradition and return a bogus lock object.
544
class BogusLock(object):
545
def __init__(self, path):
549
return BogusLock(relpath)
551
def lock_write(self, relpath):
552
"""Lock the given file for exclusive (write) access.
553
WARNING: many transports do not support this, so trying avoid using it
555
:return: A lock object, which should be passed to Transport.unlock()
557
return self.lock_read(relpath)
560
class FtpServer(Server):
561
"""Common code for FTP server facilities."""
565
self._ftp_server = None
567
self._async_thread = None
572
"""Calculate an ftp url to this server."""
573
return 'ftp://foo:bar@localhost:%d/' % (self._port)
575
# def get_bogus_url(self):
576
# """Return a URL which cannot be connected to."""
577
# return 'ftp://127.0.0.1:1'
579
def log(self, message):
580
"""This is used by medusa.ftp_server to log connections, etc."""
581
self.logs.append(message)
583
def setUp(self, vfs_server=None):
585
raise RuntimeError('Must have medusa to run the FtpServer')
587
assert vfs_server is None or isinstance(vfs_server, LocalURLServer), \
588
"FtpServer currently assumes local transport, got %s" % vfs_server
590
self._root = os.getcwdu()
591
self._ftp_server = _ftp_server(
592
authorizer=_test_authorizer(root=self._root),
594
port=0, # bind to a random port
596
logger_object=self # Use FtpServer.log() for messages
598
self._port = self._ftp_server.getsockname()[1]
599
# Don't let it loop forever, or handle an infinite number of requests.
600
# In this case it will run for 1000s, or 10000 requests
601
self._async_thread = threading.Thread(
602
target=FtpServer._asyncore_loop_ignore_EBADF,
603
kwargs={'timeout':0.1, 'count':10000})
604
self._async_thread.setDaemon(True)
605
self._async_thread.start()
608
"""See bzrlib.transport.Server.tearDown."""
609
self._ftp_server.close()
611
self._async_thread.join()
614
def _asyncore_loop_ignore_EBADF(*args, **kwargs):
615
"""Ignore EBADF during server shutdown.
617
We close the socket to get the server to shutdown, but this causes
618
select.select() to raise EBADF.
621
asyncore.loop(*args, **kwargs)
622
# FIXME: If we reach that point, we should raise an exception
623
# explaining that the 'count' parameter in setUp is too low or
624
# testers may wonder why their test just sits there waiting for a
625
# server that is already dead. Note that if the tester waits too
626
# long under pdb the server will also die.
627
except select.error, e:
628
if e.args[0] != errno.EBADF:
634
_test_authorizer = None
638
global _have_medusa, _ftp_channel, _ftp_server, _test_authorizer
641
import medusa.filesys
642
import medusa.ftp_server
648
class test_authorizer(object):
649
"""A custom Authorizer object for running the test suite.
651
The reason we cannot use dummy_authorizer, is because it sets the
652
channel to readonly, which we don't always want to do.
655
def __init__(self, root):
657
# If secured_user is set secured_password will be checked
658
self.secured_user = None
659
self.secured_password = None
661
def authorize(self, channel, username, password):
662
"""Return (success, reply_string, filesystem)"""
664
return 0, 'No Medusa.', None
666
channel.persona = -1, -1
667
if username == 'anonymous':
668
channel.read_only = 1
670
channel.read_only = 0
672
# Check secured_user if set
673
if (self.secured_user is not None
674
and username == self.secured_user
675
and password != self.secured_password):
676
return 0, 'Password invalid.', None
678
return 1, 'OK.', medusa.filesys.os_filesystem(self.root)
681
class ftp_channel(medusa.ftp_server.ftp_channel):
682
"""Customized ftp channel"""
684
def log(self, message):
685
"""Redirect logging requests."""
686
mutter('_ftp_channel: %s', message)
688
def log_info(self, message, type='info'):
689
"""Redirect logging requests."""
690
mutter('_ftp_channel %s: %s', type, message)
692
def cmd_rnfr(self, line):
693
"""Prepare for renaming a file."""
694
self._renaming = line[1]
695
self.respond('350 Ready for RNTO')
696
# TODO: jam 20060516 in testing, the ftp server seems to
697
# check that the file already exists, or it sends
698
# 550 RNFR command failed
700
def cmd_rnto(self, line):
701
"""Rename a file based on the target given.
703
rnto must be called after calling rnfr.
705
if not self._renaming:
706
self.respond('503 RNFR required first.')
707
pfrom = self.filesystem.translate(self._renaming)
708
self._renaming = None
709
pto = self.filesystem.translate(line[1])
710
if os.path.exists(pto):
711
self.respond('550 RNTO failed: file exists')
714
os.rename(pfrom, pto)
715
except (IOError, OSError), e:
716
# TODO: jam 20060516 return custom responses based on
717
# why the command failed
718
# (bialix 20070418) str(e) on Python 2.5 @ Windows
719
# sometimes don't provide expected error message;
720
# so we obtain such message via os.strerror()
721
self.respond('550 RNTO failed: %s' % os.strerror(e.errno))
723
self.respond('550 RNTO failed')
724
# For a test server, we will go ahead and just die
727
self.respond('250 Rename successful.')
729
def cmd_size(self, line):
730
"""Return the size of a file
732
This is overloaded to help the test suite determine if the
733
target is a directory.
736
if not self.filesystem.isfile(filename):
737
if self.filesystem.isdir(filename):
738
self.respond('550 "%s" is a directory' % (filename,))
740
self.respond('550 "%s" is not a file' % (filename,))
742
self.respond('213 %d'
743
% (self.filesystem.stat(filename)[stat.ST_SIZE]),)
745
def cmd_mkd(self, line):
746
"""Create a directory.
748
Overloaded because default implementation does not distinguish
749
*why* it cannot make a directory.
752
self.command_not_understood(''.join(line))
756
self.filesystem.mkdir (path)
757
self.respond ('257 MKD command successful.')
758
except (IOError, OSError), e:
759
# (bialix 20070418) str(e) on Python 2.5 @ Windows
760
# sometimes don't provide expected error message;
761
# so we obtain such message via os.strerror()
762
self.respond ('550 error creating directory: %s' %
763
os.strerror(e.errno))
765
self.respond ('550 error creating directory.')
768
class ftp_server(medusa.ftp_server.ftp_server):
769
"""Customize the behavior of the Medusa ftp_server.
771
There are a few warts on the ftp_server, based on how it expects
775
ftp_channel_class = ftp_channel
777
def __init__(self, *args, **kwargs):
778
mutter('Initializing _ftp_server: %r, %r', args, kwargs)
779
medusa.ftp_server.ftp_server.__init__(self, *args, **kwargs)
781
def log(self, message):
782
"""Redirect logging requests."""
783
mutter('_ftp_server: %s', message)
785
def log_info(self, message, type='info'):
786
"""Override the asyncore.log_info so we don't stipple the screen."""
787
mutter('_ftp_server %s: %s', type, message)
789
_test_authorizer = test_authorizer
790
_ftp_channel = ftp_channel
791
_ftp_server = ftp_server
796
def get_test_permutations():
797
"""Return the permutations to be used in testing."""
798
if not _setup_medusa():
799
warn("You must install medusa (http://www.amk.ca/python/code/medusa.html) for FTP tests")
802
return [(FtpTransport, FtpServer)]
added
removed
bzrlib/transport/ftp.py
