1
# Copyright (C) 2005, 2006 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
17
"""Transport for the local filesystem.
19
This is a fairly thin wrapper on regular file IO.
25
from stat import ST_MODE, S_ISDIR, ST_SIZE
28
from bzrlib.osutils import (abspath, realpath, normpath, pathjoin, rename,
29
check_legal_path, rmtree)
30
from bzrlib.symbol_versioning import warn
31
from bzrlib.trace import mutter
32
from bzrlib.transport import Transport, Server
33
import bzrlib.urlutils as urlutils
36
class LocalTransport(Transport):
37
"""This is the transport agent for local filesystem access."""
39
def __init__(self, base):
40
"""Set the base path where files will be stored."""
41
if not base.startswith('file://'):
42
warn("Instantiating LocalTransport with a filesystem path"
43
" is deprecated as of bzr 0.8."
44
" Please use bzrlib.transport.get_transport()"
45
" or pass in a file:// url.",
49
base = urlutils.local_path_to_url(base)
52
super(LocalTransport, self).__init__(base)
53
self._local_base = urlutils.local_path_from_url(base)
54
## mutter("_local_base: %r => %r", base, self._local_base)
56
def should_cache(self):
59
def clone(self, offset=None):
60
"""Return a new LocalTransport with root at self.base + offset
61
Because the local filesystem does not require a connection,
62
we can just return a new object.
65
return LocalTransport(self.base)
67
return LocalTransport(self.abspath(offset))
69
def _abspath(self, relative_reference):
70
"""Return a path for use in os calls.
72
Several assumptions are made:
73
- relative_reference does not contain '..'
74
- relative_reference is url escaped.
76
if relative_reference in ('.', ''):
77
return self._local_base
78
return self._local_base + urlutils.unescape(relative_reference)
80
def abspath(self, relpath):
81
"""Return the full url to the given relative URL."""
82
# TODO: url escape the result. RBC 20060523.
83
assert isinstance(relpath, basestring), (type(relpath), relpath)
84
# jam 20060426 Using normpath on the real path, because that ensures
85
# proper handling of stuff like
86
path = normpath(pathjoin(self._local_base, urlutils.unescape(relpath)))
87
return urlutils.local_path_to_url(path)
89
def local_abspath(self, relpath):
90
"""Transform the given relative path URL into the actual path on disk
92
This function only exists for the LocalTransport, since it is
93
the only one that has direct local access.
94
This is mostly for stuff like WorkingTree which needs to know
95
the local working directory.
97
This function is quite expensive: it calls realpath which resolves
100
absurl = self.abspath(relpath)
101
# mutter(u'relpath %s => base: %s, absurl %s', relpath, self.base, absurl)
102
return urlutils.local_path_from_url(absurl)
104
def relpath(self, abspath):
105
"""Return the local path portion from a given absolute path.
110
return urlutils.file_relpath(
111
urlutils.strip_trailing_slash(self.base),
112
urlutils.strip_trailing_slash(abspath))
114
def has(self, relpath):
115
return os.access(self._abspath(relpath), os.F_OK)
117
def get(self, relpath):
118
"""Get the file at the given relative path.
120
:param relpath: The relative path to the file
123
path = self._abspath(relpath)
124
return open(path, 'rb')
125
except (IOError, OSError),e:
126
self._translate_error(e, path)
128
def put(self, relpath, f, mode=None):
129
"""Copy the file-like or string object into the location.
131
:param relpath: Location to put the contents, relative to base.
132
:param f: File-like or string object.
134
from bzrlib.atomicfile import AtomicFile
138
path = self._abspath(relpath)
139
check_legal_path(path)
140
fp = AtomicFile(path, 'wb', new_mode=mode)
141
except (IOError, OSError),e:
142
self._translate_error(e, path)
149
def iter_files_recursive(self):
150
"""Iter the relative paths of files in the transports sub-tree."""
151
queue = list(self.list_dir(u'.'))
153
relpath = queue.pop(0)
154
st = self.stat(relpath)
155
if S_ISDIR(st[ST_MODE]):
156
for i, basename in enumerate(self.list_dir(relpath)):
157
queue.insert(i, relpath+'/'+basename)
161
def mkdir(self, relpath, mode=None):
162
"""Create a directory at the given path."""
165
path = self._abspath(relpath)
169
except (IOError, OSError),e:
170
self._translate_error(e, path)
172
def append(self, relpath, f, mode=None):
173
"""Append the text in the file-like object into the final location."""
174
abspath = self._abspath(relpath)
178
fp = open(abspath, 'ab')
179
# FIXME should we really be chmodding every time ? RBC 20060523
181
os.chmod(abspath, mode)
182
except (IOError, OSError),e:
183
self._translate_error(e, relpath)
184
# win32 workaround (tell on an unwritten file returns 0)
193
def copy(self, rel_from, rel_to):
194
"""Copy the item at rel_from to the location at rel_to"""
195
path_from = self._abspath(rel_from)
196
path_to = self._abspath(rel_to)
198
shutil.copy(path_from, path_to)
199
except (IOError, OSError),e:
200
# TODO: What about path_to?
201
self._translate_error(e, path_from)
203
def rename(self, rel_from, rel_to):
204
path_from = self._abspath(rel_from)
206
# *don't* call bzrlib.osutils.rename, because we want to
207
# detect errors on rename
208
os.rename(path_from, self._abspath(rel_to))
209
except (IOError, OSError),e:
210
# TODO: What about path_to?
211
self._translate_error(e, path_from)
213
def move(self, rel_from, rel_to):
214
"""Move the item at rel_from to the location at rel_to"""
215
path_from = self._abspath(rel_from)
216
path_to = self._abspath(rel_to)
219
# this version will delete the destination if necessary
220
rename(path_from, path_to)
221
except (IOError, OSError),e:
222
# TODO: What about path_to?
223
self._translate_error(e, path_from)
225
def delete(self, relpath):
226
"""Delete the item at relpath"""
229
path = self._abspath(relpath)
231
except (IOError, OSError),e:
232
self._translate_error(e, path)
234
def copy_to(self, relpaths, other, mode=None, pb=None):
235
"""Copy a set of entries from self into another Transport.
237
:param relpaths: A list/generator of entries to be copied.
239
if isinstance(other, LocalTransport):
240
# Both from & to are on the local filesystem
241
# Unfortunately, I can't think of anything faster than just
242
# copying them across, one by one :(
243
total = self._get_total(relpaths)
245
for path in relpaths:
246
self._update_pb(pb, 'copy-to', count, total)
248
mypath = self._abspath(path)
249
otherpath = other._abspath(path)
250
shutil.copy(mypath, otherpath)
252
os.chmod(otherpath, mode)
253
except (IOError, OSError),e:
254
self._translate_error(e, path)
258
return super(LocalTransport, self).copy_to(relpaths, other, mode=mode, pb=pb)
261
"""See Transport.listable."""
264
def list_dir(self, relpath):
265
"""Return a list of all files at the given location.
266
WARNING: many transports do not support this, so trying avoid using
267
it if at all possible.
269
path = self._abspath(relpath)
271
return [urlutils.escape(entry) for entry in os.listdir(path)]
272
except (IOError, OSError), e:
273
self._translate_error(e, path)
275
def stat(self, relpath):
276
"""Return the stat information for a file.
280
path = self._abspath(relpath)
282
except (IOError, OSError),e:
283
self._translate_error(e, path)
285
def lock_read(self, relpath):
286
"""Lock the given file for shared (read) access.
287
:return: A lock object, which should be passed to Transport.unlock()
289
from bzrlib.lock import ReadLock
292
path = self._abspath(relpath)
293
return ReadLock(path)
294
except (IOError, OSError), e:
295
self._translate_error(e, path)
297
def lock_write(self, relpath):
298
"""Lock the given file for exclusive (write) access.
299
WARNING: many transports do not support this, so trying avoid using it
301
:return: A lock object, which should be passed to Transport.unlock()
303
from bzrlib.lock import WriteLock
304
return WriteLock(self._abspath(relpath))
306
def rmdir(self, relpath):
307
"""See Transport.rmdir."""
310
path = self._abspath(relpath)
312
except (IOError, OSError),e:
313
self._translate_error(e, path)
315
def _can_roundtrip_unix_modebits(self):
316
if sys.platform == 'win32':
323
class LocalRelpathServer(Server):
324
"""A pretend server for local transports, using relpaths."""
327
"""See Transport.Server.get_url."""
331
class LocalAbspathServer(Server):
332
"""A pretend server for local transports, using absolute paths."""
335
"""See Transport.Server.get_url."""
336
return os.path.abspath("")
339
class LocalURLServer(Server):
340
"""A pretend server for local transports, using file:// urls."""
343
"""See Transport.Server.get_url."""
344
return urlutils.local_path_to_url('')
347
def get_test_permutations():
348
"""Return the permutations to be used in testing."""
349
return [(LocalTransport, LocalRelpathServer),
350
(LocalTransport, LocalAbspathServer),
351
(LocalTransport, LocalURLServer),
added
removed
bzrlib/transport/local.py
