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, S_IMODE
32
from bzrlib.osutils import (abspath, realpath, normpath, pathjoin, rename,
33
check_legal_path, rmtree)
34
from bzrlib.symbol_versioning import warn
35
from bzrlib.trace import mutter
36
from bzrlib.transport import Transport, Server
39
_append_flags = os.O_CREAT | os.O_APPEND | os.O_WRONLY | osutils.O_BINARY
42
class LocalTransport(Transport):
43
"""This is the transport agent for local filesystem access."""
45
def __init__(self, base):
46
"""Set the base path where files will be stored."""
47
if not base.startswith('file://'):
48
warn("Instantiating LocalTransport with a filesystem path"
49
" is deprecated as of bzr 0.8."
50
" Please use bzrlib.transport.get_transport()"
51
" or pass in a file:// url.",
55
base = urlutils.local_path_to_url(base)
58
super(LocalTransport, self).__init__(base)
59
self._local_base = urlutils.local_path_from_url(base)
61
def should_cache(self):
64
def clone(self, offset=None):
65
"""Return a new LocalTransport with root at self.base + offset
66
Because the local filesystem does not require a connection,
67
we can just return a new object.
70
return LocalTransport(self.base)
72
return LocalTransport(self.abspath(offset))
74
def _abspath(self, relative_reference):
75
"""Return a path for use in os calls.
77
Several assumptions are made:
78
- relative_reference does not contain '..'
79
- relative_reference is url escaped.
81
if relative_reference in ('.', ''):
82
return self._local_base
83
return self._local_base + urlutils.unescape(relative_reference)
85
def abspath(self, relpath):
86
"""Return the full url to the given relative URL."""
87
# TODO: url escape the result. RBC 20060523.
88
assert isinstance(relpath, basestring), (type(relpath), relpath)
89
# jam 20060426 Using normpath on the real path, because that ensures
90
# proper handling of stuff like
91
path = normpath(pathjoin(self._local_base, urlutils.unescape(relpath)))
92
return urlutils.local_path_to_url(path)
94
def local_abspath(self, relpath):
95
"""Transform the given relative path URL into the actual path on disk
97
This function only exists for the LocalTransport, since it is
98
the only one that has direct local access.
99
This is mostly for stuff like WorkingTree which needs to know
100
the local working directory.
102
This function is quite expensive: it calls realpath which resolves
105
absurl = self.abspath(relpath)
106
# mutter(u'relpath %s => base: %s, absurl %s', relpath, self.base, absurl)
107
return urlutils.local_path_from_url(absurl)
109
def relpath(self, abspath):
110
"""Return the local path portion from a given absolute path.
115
return urlutils.file_relpath(
116
urlutils.strip_trailing_slash(self.base),
117
urlutils.strip_trailing_slash(abspath))
119
def has(self, relpath):
120
return os.access(self._abspath(relpath), os.F_OK)
122
def get(self, relpath):
123
"""Get the file at the given relative path.
125
:param relpath: The relative path to the file
128
path = self._abspath(relpath)
129
return open(path, 'rb')
130
except (IOError, OSError),e:
131
self._translate_error(e, path)
133
def put(self, relpath, f, mode=None):
134
"""Copy the file-like or string object into the location.
136
:param relpath: Location to put the contents, relative to base.
137
:param f: File-like or string object.
139
from bzrlib.atomicfile import AtomicFile
143
path = self._abspath(relpath)
144
check_legal_path(path)
145
fp = AtomicFile(path, 'wb', new_mode=mode)
146
except (IOError, OSError),e:
147
self._translate_error(e, path)
154
def iter_files_recursive(self):
155
"""Iter the relative paths of files in the transports sub-tree."""
156
queue = list(self.list_dir(u'.'))
158
relpath = queue.pop(0)
159
st = self.stat(relpath)
160
if S_ISDIR(st[ST_MODE]):
161
for i, basename in enumerate(self.list_dir(relpath)):
162
queue.insert(i, relpath+'/'+basename)
166
def mkdir(self, relpath, mode=None):
167
"""Create a directory at the given path."""
171
# os.mkdir() will filter through umask
175
path = self._abspath(relpath)
176
os.mkdir(path, local_mode)
178
# It is probably faster to just do the chmod, rather than
179
# doing a stat, and then trying to compare
181
except (IOError, OSError),e:
182
self._translate_error(e, path)
184
def append(self, relpath, f, mode=None):
185
"""Append the text in the file-like object into the final location."""
186
abspath = self._abspath(relpath)
188
# os.open() will automatically use the umask
193
fd = os.open(abspath, _append_flags, local_mode)
194
except (IOError, OSError),e:
195
self._translate_error(e, relpath)
199
if mode is not None and mode != S_IMODE(st.st_mode):
200
# Because of umask, we may still need to chmod the file.
201
# But in the general case, we won't have to
202
os.chmod(abspath, mode)
203
self._pump_to_fd(f, fd)
208
def _pump_to_fd(self, fromfile, to_fd):
209
"""Copy contents of one file to another."""
212
b = fromfile.read(BUFSIZE)
217
def copy(self, rel_from, rel_to):
218
"""Copy the item at rel_from to the location at rel_to"""
219
path_from = self._abspath(rel_from)
220
path_to = self._abspath(rel_to)
222
shutil.copy(path_from, path_to)
223
except (IOError, OSError),e:
224
# TODO: What about path_to?
225
self._translate_error(e, path_from)
227
def rename(self, rel_from, rel_to):
228
path_from = self._abspath(rel_from)
230
# *don't* call bzrlib.osutils.rename, because we want to
231
# detect errors on rename
232
os.rename(path_from, self._abspath(rel_to))
233
except (IOError, OSError),e:
234
# TODO: What about path_to?
235
self._translate_error(e, path_from)
237
def move(self, rel_from, rel_to):
238
"""Move the item at rel_from to the location at rel_to"""
239
path_from = self._abspath(rel_from)
240
path_to = self._abspath(rel_to)
243
# this version will delete the destination if necessary
244
rename(path_from, path_to)
245
except (IOError, OSError),e:
246
# TODO: What about path_to?
247
self._translate_error(e, path_from)
249
def delete(self, relpath):
250
"""Delete the item at relpath"""
253
path = self._abspath(relpath)
255
except (IOError, OSError),e:
256
self._translate_error(e, path)
258
def copy_to(self, relpaths, other, mode=None, pb=None):
259
"""Copy a set of entries from self into another Transport.
261
:param relpaths: A list/generator of entries to be copied.
263
if isinstance(other, LocalTransport):
264
# Both from & to are on the local filesystem
265
# Unfortunately, I can't think of anything faster than just
266
# copying them across, one by one :(
267
total = self._get_total(relpaths)
269
for path in relpaths:
270
self._update_pb(pb, 'copy-to', count, total)
272
mypath = self._abspath(path)
273
otherpath = other._abspath(path)
274
shutil.copy(mypath, otherpath)
276
os.chmod(otherpath, mode)
277
except (IOError, OSError),e:
278
self._translate_error(e, path)
282
return super(LocalTransport, self).copy_to(relpaths, other, mode=mode, pb=pb)
285
"""See Transport.listable."""
288
def list_dir(self, relpath):
289
"""Return a list of all files at the given location.
290
WARNING: many transports do not support this, so trying avoid using
291
it if at all possible.
293
path = self._abspath(relpath)
295
return [urlutils.escape(entry) for entry in os.listdir(path)]
296
except (IOError, OSError), e:
297
self._translate_error(e, path)
299
def stat(self, relpath):
300
"""Return the stat information for a file.
304
path = self._abspath(relpath)
306
except (IOError, OSError),e:
307
self._translate_error(e, path)
309
def lock_read(self, relpath):
310
"""Lock the given file for shared (read) access.
311
:return: A lock object, which should be passed to Transport.unlock()
313
from bzrlib.lock import ReadLock
316
path = self._abspath(relpath)
317
return ReadLock(path)
318
except (IOError, OSError), e:
319
self._translate_error(e, path)
321
def lock_write(self, relpath):
322
"""Lock the given file for exclusive (write) access.
323
WARNING: many transports do not support this, so trying avoid using it
325
:return: A lock object, which should be passed to Transport.unlock()
327
from bzrlib.lock import WriteLock
328
return WriteLock(self._abspath(relpath))
330
def rmdir(self, relpath):
331
"""See Transport.rmdir."""
334
path = self._abspath(relpath)
336
except (IOError, OSError),e:
337
self._translate_error(e, path)
339
def _can_roundtrip_unix_modebits(self):
340
if sys.platform == 'win32':
347
class LocalRelpathServer(Server):
348
"""A pretend server for local transports, using relpaths."""
351
"""See Transport.Server.get_url."""
355
class LocalAbspathServer(Server):
356
"""A pretend server for local transports, using absolute paths."""
359
"""See Transport.Server.get_url."""
360
return os.path.abspath("")
363
class LocalURLServer(Server):
364
"""A pretend server for local transports, using file:// urls."""
367
"""See Transport.Server.get_url."""
368
return urlutils.local_path_to_url('')
371
def get_test_permutations():
372
"""Return the permutations to be used in testing."""
373
return [(LocalTransport, LocalRelpathServer),
374
(LocalTransport, LocalAbspathServer),
375
(LocalTransport, LocalURLServer),
added
removed
bzrlib/transport/local.py
