1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
|
# Copyright (C) 2005 Canonical Ltd
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""Implementation of Transport over ftp.
Written by Daniel Silverstone <dsilvers@digital-scurf.org> with serious
cargo-culting from the sftp transport and the http transport.
It provides the ftp:// and aftp:// protocols where ftp:// is passive ftp
and aftp:// is active ftp. Most people will want passive ftp for traversing
NAT and other firewalls, so it's best to use it unless you explicitly want
active, in which case aftp:// will be your friend.
"""
from bzrlib.transport import Transport
from bzrlib.errors import (TransportNotPossible, NoSuchFile,
NonRelativePath, TransportError, ConnectionError)
import os, errno
from cStringIO import StringIO
import ftplib
import urlparse
import urllib
import stat
from bzrlib.errors import BzrError, BzrCheckError
from bzrlib.branch import Branch
from bzrlib.trace import mutter
class FtpTransportError(TransportError):
pass
class FtpStatResult(object):
def __init__(self, f, relpath):
try:
self.st_size = f.size(relpath)
self.st_mode = stat.S_IFREG
except ftplib.error_perm:
pwd = f.pwd()
try:
f.cwd(relpath)
self.st_mode = stat.S_IFDIR
finally:
f.cwd(pwd)
class FtpTransport(Transport):
"""This is the transport agent for ftp:// access."""
def __init__(self, base, _provided_instance=None):
"""Set the base path where files will be stored."""
assert base.startswith('ftp://') or base.startswith('aftp://')
super(FtpTransport, self).__init__(base)
self.is_active = base.startswith('aftp://')
if self.is_active:
base = base[1:]
(self._proto, self._host,
self._path, self._parameters,
self._query, self._fragment) = urlparse.urlparse(self.base)
self._FTP_instance = _provided_instance
def _get_FTP(self):
"""Return the ftplib.FTP instance for this object."""
if self._FTP_instance is not None:
return self._FTP_instance
try:
username = ''
password = ''
hostname = self._host
if '@' in hostname:
username, hostname = hostname.split("@", 1)
if ':' in username:
username, password = username.split(":", 1)
mutter("Constructing FTP instance")
self._FTP_instance = ftplib.FTP(hostname, username, password)
self._FTP_instance.set_pasv(not self.is_active)
return self._FTP_instance
except ftplib.error_perm, e:
raise FtpTransportError(msg="Error setting up connection: %s"
% str(e), orig_error=e)
def should_cache(self):
"""Return True if the data pulled across should be cached locally.
"""
return True
def clone(self, offset=None):
"""Return a new FtpTransport with root at self.base + offset.
"""
mutter("FTP clone")
if offset is None:
return FtpTransport(self.base, self._FTP_instance)
else:
return FtpTransport(self.abspath(offset), self._FTP_instance)
def _abspath(self, relpath):
assert isinstance(relpath, basestring)
relpath = urllib.unquote(relpath)
if isinstance(relpath, basestring):
relpath_parts = relpath.split('/')
else:
# TODO: Don't call this with an array - no magic interfaces
relpath_parts = relpath[:]
if len(relpath_parts) > 1:
if relpath_parts[0] == '':
raise ValueError("path %r within branch %r seems to be absolute"
% (relpath, self._path))
basepath = self._path.split('/')
if len(basepath) > 0 and basepath[-1] == '':
basepath = basepath[:-1]
for p in relpath_parts:
if p == '..':
if len(basepath) == 0:
# In most filesystems, a request for the parent
# of root, just returns root.
continue
basepath.pop()
elif p == '.' or p == '':
continue # No-op
else:
basepath.append(p)
# Possibly, we could use urlparse.urljoin() here, but
# I'm concerned about when it chooses to strip the last
# portion of the path, and when it doesn't.
return '/'.join(basepath)
def abspath(self, relpath):
"""Return the full url to the given relative path.
This can be supplied with a string or a list
"""
path = self._abspath(relpath)
return urlparse.urlunparse((self._proto,
self._host, path, '', '', ''))
def has(self, relpath):
"""Does the target location exist?
XXX: I assume we're never asked has(dirname) and thus I use
the FTP size command and assume that if it doesn't raise,
all is good.
"""
try:
f = self._get_FTP()
s = f.size(self._abspath(relpath))
mutter("FTP has: %s" % self._abspath(relpath))
return True
except ftplib.error_perm:
mutter("FTP has not: %s" % self._abspath(relpath))
return False
def get(self, relpath, decode=False):
"""Get the file at the given relative path.
:param relpath: The relative path to the file
We're meant to return a file-like object which bzr will
then read from. For now we do this via the magic of StringIO
"""
try:
mutter("FTP get: %s" % self._abspath(relpath))
f = self._get_FTP()
ret = StringIO()
f.retrbinary('RETR '+self._abspath(relpath), ret.write, 8192)
ret.seek(0)
return ret
except ftplib.error_perm, e:
raise NoSuchFile(msg="Error retrieving %s: %s"
% (self.abspath(relpath), str(e)),
orig_error=e)
def put(self, relpath, fp):
"""Copy the file-like or string object into the location.
:param relpath: Location to put the contents, relative to base.
:param f: File-like or string object.
"""
if not hasattr(fp, 'read'):
fp = StringIO(fp)
try:
mutter("FTP put: %s" % self._abspath(relpath))
f = self._get_FTP()
f.storbinary('STOR '+self._abspath(relpath), fp, 8192)
except ftplib.error_perm, e:
raise FtpTransportError(orig_error=e)
def mkdir(self, relpath):
"""Create a directory at the given path."""
try:
mutter("FTP mkd: %s" % self._abspath(relpath))
f = self._get_FTP()
try:
f.mkd(self._abspath(relpath))
except ftplib.error_perm, e:
s = str(e)
if 'File exists' in s:
# Swallow attempts to mkdir something which is already
# present. Hopefully this will shush some errors.
return
else:
raise
except ftplib.error_perm, e:
raise FtpTransportError(orig_error=e)
def append(self, relpath, f):
"""Append the text in the file-like object into the final
location.
"""
raise TransportNotPossible('ftp does not support append()')
def copy(self, rel_from, rel_to):
"""Copy the item at rel_from to the location at rel_to"""
raise TransportNotPossible('ftp does not (yet) support copy()')
def move(self, rel_from, rel_to):
"""Move the item at rel_from to the location at rel_to"""
try:
mutter("FTP mv: %s => %s" % (self._abspath(rel_from),
self._abspath(rel_to)))
f = self._get_FTP()
f.rename(self._abspath(rel_from), self._abspath(rel_to))
except ftplib.error_perm, e:
raise FtpTransportError(orig_error=e)
def delete(self, relpath):
"""Delete the item at relpath"""
try:
mutter("FTP rm: %s" % self._abspath(relpath))
f = self._get_FTP()
f.delete(self._abspath(relpath))
except ftplib.error_perm, e:
raise FtpTransportError(orig_error=e)
def listable(self):
"""See Transport.listable."""
return True
def list_dir(self, relpath):
"""See Transport.list_dir."""
try:
mutter("FTP nlst: %s" % self._abspath(relpath))
f = self._get_FTP()
basepath = self._abspath(relpath)
# FTP.nlst returns paths prefixed by relpath, strip 'em
the_list = f.nlst(basepath)
stripped = [path[len(basepath)+1:] for path in the_list]
# Remove . and .. if present, and return
return [path for path in stripped if path not in (".", "..")]
except ftplib.error_perm, e:
raise FtpTransportError(orig_error=e)
def iter_files_recursive(self):
"""See Transport.iter_files_recursive.
This is cargo-culted from the SFTP transport"""
mutter("FTP iter_files_recursive")
queue = list(self.list_dir("."))
while queue:
relpath = urllib.quote(queue.pop(0))
st = self.stat(relpath)
if stat.S_ISDIR(st.st_mode):
for i, basename in enumerate(self.list_dir(relpath)):
queue.insert(i, relpath+"/"+basename)
else:
yield relpath
def stat(self, relpath):
"""Return the stat information for a file.
"""
try:
mutter("FTP stat: %s" % self._abspath(relpath))
f = self._get_FTP()
return FtpStatResult(f, self._abspath(relpath))
except ftplib.error_perm, e:
raise FtpTransportError(orig_error=e)
def lock_read(self, relpath):
"""Lock the given file for shared (read) access.
:return: A lock object, which should be passed to Transport.unlock()
"""
# The old RemoteBranch ignore lock for reading, so we will
# continue that tradition and return a bogus lock object.
class BogusLock(object):
def __init__(self, path):
self.path = path
def unlock(self):
pass
return BogusLock(relpath)
def lock_write(self, relpath):
"""Lock the given file for exclusive (write) access.
WARNING: many transports do not support this, so trying avoid using it
:return: A lock object, which should be passed to Transport.unlock()
"""
return self.lock_read(relpath)
|