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.
23
from stat import ST_MODE, S_ISDIR, ST_SIZE, S_IMODE
26
from bzrlib.lazy_import import lazy_import
27
lazy_import(globals(), """
38
from bzrlib.trace import mutter
39
from bzrlib.transport import LateReadError
42
from bzrlib.transport import Transport, Server
45
_append_flags = os.O_CREAT | os.O_APPEND | os.O_WRONLY | osutils.O_BINARY
46
_put_non_atomic_flags = os.O_CREAT | os.O_TRUNC | os.O_WRONLY | osutils.O_BINARY
49
class LocalTransport(Transport):
50
"""This is the transport agent for local filesystem access."""
52
def __init__(self, base):
53
"""Set the base path where files will be stored."""
54
if not base.startswith('file://'):
55
symbol_versioning.warn(
56
"Instantiating LocalTransport with a filesystem path"
57
" is deprecated as of bzr 0.8."
58
" Please use bzrlib.transport.get_transport()"
59
" or pass in a file:// url.",
63
base = urlutils.local_path_to_url(base)
66
super(LocalTransport, self).__init__(base)
67
self._local_base = urlutils.local_path_from_url(base)
69
def clone(self, offset=None):
70
"""Return a new LocalTransport with root at self.base + offset
71
Because the local filesystem does not require a connection,
72
we can just return a new object.
75
return LocalTransport(self.base)
77
abspath = self.abspath(offset)
78
if abspath == 'file://':
79
# fix upwalk for UNC path
80
# when clone from //HOST/path updir recursively
81
# we should stop at least at //HOST part
83
return LocalTransport(abspath)
85
def _abspath(self, relative_reference):
86
"""Return a path for use in os calls.
88
Several assumptions are made:
89
- relative_reference does not contain '..'
90
- relative_reference is url escaped.
92
if relative_reference in ('.', ''):
93
return self._local_base
94
return self._local_base + urlutils.unescape(relative_reference)
96
def abspath(self, relpath):
97
"""Return the full url to the given relative URL."""
98
# TODO: url escape the result. RBC 20060523.
99
assert isinstance(relpath, basestring), (type(relpath), relpath)
100
# jam 20060426 Using normpath on the real path, because that ensures
101
# proper handling of stuff like
102
path = osutils.normpath(osutils.pathjoin(
103
self._local_base, urlutils.unescape(relpath)))
104
return urlutils.local_path_to_url(path)
106
def local_abspath(self, relpath):
107
"""Transform the given relative path URL into the actual path on disk
109
This function only exists for the LocalTransport, since it is
110
the only one that has direct local access.
111
This is mostly for stuff like WorkingTree which needs to know
112
the local working directory.
114
This function is quite expensive: it calls realpath which resolves
117
absurl = self.abspath(relpath)
118
# mutter(u'relpath %s => base: %s, absurl %s', relpath, self.base, absurl)
119
return urlutils.local_path_from_url(absurl)
121
def relpath(self, abspath):
122
"""Return the local path portion from a given absolute path.
127
return urlutils.file_relpath(
128
urlutils.strip_trailing_slash(self.base),
129
urlutils.strip_trailing_slash(abspath))
131
def has(self, relpath):
132
return os.access(self._abspath(relpath), os.F_OK)
134
def get(self, relpath):
135
"""Get the file at the given relative path.
137
:param relpath: The relative path to the file
139
canonical_url = self.abspath(relpath)
140
if canonical_url in transport._file_streams:
141
transport._file_streams[canonical_url].flush()
143
path = self._abspath(relpath)
144
return open(path, 'rb')
145
except (IOError, OSError),e:
146
if e.errno == errno.EISDIR:
147
return LateReadError(relpath)
148
self._translate_error(e, path)
150
def put_file(self, relpath, f, mode=None):
151
"""Copy the file-like object into the location.
153
:param relpath: Location to put the contents, relative to base.
154
:param f: File-like object.
155
:param mode: The mode for the newly created file,
156
None means just use the default
161
path = self._abspath(relpath)
162
osutils.check_legal_path(path)
163
fp = atomicfile.AtomicFile(path, 'wb', new_mode=mode)
164
except (IOError, OSError),e:
165
self._translate_error(e, path)
172
def put_bytes(self, relpath, bytes, mode=None):
173
"""Copy the string into the location.
175
:param relpath: Location to put the contents, relative to base.
181
path = self._abspath(relpath)
182
osutils.check_legal_path(path)
183
fp = atomicfile.AtomicFile(path, 'wb', new_mode=mode)
184
except (IOError, OSError),e:
185
self._translate_error(e, path)
192
def _put_non_atomic_helper(self, relpath, writer,
194
create_parent_dir=False,
196
"""Common functionality information for the put_*_non_atomic.
198
This tracks all the create_parent_dir stuff.
200
:param relpath: the path we are putting to.
201
:param writer: A function that takes an os level file descriptor
202
and writes whatever data it needs to write there.
203
:param mode: The final file mode.
204
:param create_parent_dir: Should we be creating the parent directory
207
abspath = self._abspath(relpath)
209
# os.open() will automatically use the umask
214
fd = os.open(abspath, _put_non_atomic_flags, local_mode)
215
except (IOError, OSError),e:
216
# We couldn't create the file, maybe we need to create
217
# the parent directory, and try again
218
if (not create_parent_dir
219
or e.errno not in (errno.ENOENT,errno.ENOTDIR)):
220
self._translate_error(e, relpath)
221
parent_dir = os.path.dirname(abspath)
223
self._translate_error(e, relpath)
224
self._mkdir(parent_dir, mode=dir_mode)
225
# We created the parent directory, lets try to open the
228
fd = os.open(abspath, _put_non_atomic_flags, local_mode)
229
except (IOError, OSError), e:
230
self._translate_error(e, relpath)
233
if mode is not None and mode != S_IMODE(st.st_mode):
234
# Because of umask, we may still need to chmod the file.
235
# But in the general case, we won't have to
236
os.chmod(abspath, mode)
241
def put_file_non_atomic(self, relpath, f, mode=None,
242
create_parent_dir=False,
244
"""Copy the file-like object into the target location.
246
This function is not strictly safe to use. It is only meant to
247
be used when you already know that the target does not exist.
248
It is not safe, because it will open and truncate the remote
249
file. So there may be a time when the file has invalid contents.
251
:param relpath: The remote location to put the contents.
252
:param f: File-like object.
253
:param mode: Possible access permissions for new file.
254
None means do not set remote permissions.
255
:param create_parent_dir: If we cannot create the target file because
256
the parent directory does not exist, go ahead and
257
create it, and then try again.
260
self._pump_to_fd(f, fd)
261
self._put_non_atomic_helper(relpath, writer, mode=mode,
262
create_parent_dir=create_parent_dir,
265
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
266
create_parent_dir=False, dir_mode=None):
269
self._put_non_atomic_helper(relpath, writer, mode=mode,
270
create_parent_dir=create_parent_dir,
273
def iter_files_recursive(self):
274
"""Iter the relative paths of files in the transports sub-tree."""
275
queue = list(self.list_dir(u'.'))
277
relpath = queue.pop(0)
278
st = self.stat(relpath)
279
if S_ISDIR(st[ST_MODE]):
280
for i, basename in enumerate(self.list_dir(relpath)):
281
queue.insert(i, relpath+'/'+basename)
285
def _mkdir(self, abspath, mode=None):
286
"""Create a real directory, filtering through mode"""
288
# os.mkdir() will filter through umask
293
os.mkdir(abspath, local_mode)
295
# It is probably faster to just do the chmod, rather than
296
# doing a stat, and then trying to compare
297
os.chmod(abspath, mode)
298
except (IOError, OSError),e:
299
self._translate_error(e, abspath)
301
def mkdir(self, relpath, mode=None):
302
"""Create a directory at the given path."""
303
self._mkdir(self._abspath(relpath), mode=mode)
305
def open_write_stream(self, relpath, mode=None):
306
"""See Transport.open_write_stream."""
307
# initialise the file
308
self.put_bytes_non_atomic(relpath, "", mode=mode)
309
handle = open(self._abspath(relpath), 'wb')
310
transport._file_streams[self.abspath(relpath)] = handle
311
return transport.FileFileStream(self, relpath, handle)
313
def _get_append_file(self, relpath, mode=None):
314
"""Call os.open() for the given relpath"""
315
file_abspath = self._abspath(relpath)
317
# os.open() will automatically use the umask
322
return file_abspath, os.open(file_abspath, _append_flags, local_mode)
323
except (IOError, OSError),e:
324
self._translate_error(e, relpath)
326
def _check_mode_and_size(self, file_abspath, fd, mode=None):
327
"""Check the mode of the file, and return the current size"""
329
if mode is not None and mode != S_IMODE(st.st_mode):
330
# Because of umask, we may still need to chmod the file.
331
# But in the general case, we won't have to
332
os.chmod(file_abspath, mode)
335
def append_file(self, relpath, f, mode=None):
336
"""Append the text in the file-like object into the final location."""
337
file_abspath, fd = self._get_append_file(relpath, mode=mode)
339
result = self._check_mode_and_size(file_abspath, fd, mode=mode)
340
self._pump_to_fd(f, fd)
345
def append_bytes(self, relpath, bytes, mode=None):
346
"""Append the text in the string into the final location."""
347
file_abspath, fd = self._get_append_file(relpath, mode=mode)
349
result = self._check_mode_and_size(file_abspath, fd, mode=mode)
355
def _pump_to_fd(self, fromfile, to_fd):
356
"""Copy contents of one file to another."""
359
b = fromfile.read(BUFSIZE)
364
def copy(self, rel_from, rel_to):
365
"""Copy the item at rel_from to the location at rel_to"""
366
path_from = self._abspath(rel_from)
367
path_to = self._abspath(rel_to)
369
shutil.copy(path_from, path_to)
370
except (IOError, OSError),e:
371
# TODO: What about path_to?
372
self._translate_error(e, path_from)
374
def rename(self, rel_from, rel_to):
375
path_from = self._abspath(rel_from)
377
# *don't* call bzrlib.osutils.rename, because we want to
378
# detect errors on rename
379
os.rename(path_from, self._abspath(rel_to))
380
except (IOError, OSError),e:
381
# TODO: What about path_to?
382
self._translate_error(e, path_from)
384
def move(self, rel_from, rel_to):
385
"""Move the item at rel_from to the location at rel_to"""
386
path_from = self._abspath(rel_from)
387
path_to = self._abspath(rel_to)
390
# this version will delete the destination if necessary
391
osutils.rename(path_from, path_to)
392
except (IOError, OSError),e:
393
# TODO: What about path_to?
394
self._translate_error(e, path_from)
396
def delete(self, relpath):
397
"""Delete the item at relpath"""
400
path = self._abspath(relpath)
402
except (IOError, OSError),e:
403
self._translate_error(e, path)
405
def external_url(self):
406
"""See bzrlib.transport.Transport.external_url."""
407
# File URL's are externally usable.
410
def copy_to(self, relpaths, other, mode=None, pb=None):
411
"""Copy a set of entries from self into another Transport.
413
:param relpaths: A list/generator of entries to be copied.
415
if isinstance(other, LocalTransport):
416
# Both from & to are on the local filesystem
417
# Unfortunately, I can't think of anything faster than just
418
# copying them across, one by one :(
419
total = self._get_total(relpaths)
421
for path in relpaths:
422
self._update_pb(pb, 'copy-to', count, total)
424
mypath = self._abspath(path)
425
otherpath = other._abspath(path)
426
shutil.copy(mypath, otherpath)
428
os.chmod(otherpath, mode)
429
except (IOError, OSError),e:
430
self._translate_error(e, path)
434
return super(LocalTransport, self).copy_to(relpaths, other, mode=mode, pb=pb)
437
"""See Transport.listable."""
440
def list_dir(self, relpath):
441
"""Return a list of all files at the given location.
442
WARNING: many transports do not support this, so trying avoid using
443
it if at all possible.
445
path = self._abspath(relpath)
447
entries = os.listdir(path)
448
except (IOError, OSError), e:
449
self._translate_error(e, path)
450
return [urlutils.escape(entry) for entry in entries]
452
def stat(self, relpath):
453
"""Return the stat information for a file.
457
path = self._abspath(relpath)
459
except (IOError, OSError),e:
460
self._translate_error(e, path)
462
def lock_read(self, relpath):
463
"""Lock the given file for shared (read) access.
464
:return: A lock object, which should be passed to Transport.unlock()
466
from bzrlib.lock import ReadLock
469
path = self._abspath(relpath)
470
return ReadLock(path)
471
except (IOError, OSError), e:
472
self._translate_error(e, path)
474
def lock_write(self, relpath):
475
"""Lock the given file for exclusive (write) access.
476
WARNING: many transports do not support this, so trying avoid using it
478
:return: A lock object, which should be passed to Transport.unlock()
480
from bzrlib.lock import WriteLock
481
return WriteLock(self._abspath(relpath))
483
def rmdir(self, relpath):
484
"""See Transport.rmdir."""
487
path = self._abspath(relpath)
489
except (IOError, OSError),e:
490
self._translate_error(e, path)
492
def _can_roundtrip_unix_modebits(self):
493
if sys.platform == 'win32':
500
class EmulatedWin32LocalTransport(LocalTransport):
501
"""Special transport for testing Win32 [UNC] paths on non-windows"""
503
def __init__(self, base):
506
super(LocalTransport, self).__init__(base)
507
self._local_base = urlutils._win32_local_path_from_url(base)
509
def abspath(self, relpath):
510
assert isinstance(relpath, basestring), (type(relpath), relpath)
511
path = osutils.normpath(osutils.pathjoin(
512
self._local_base, urlutils.unescape(relpath)))
513
return urlutils._win32_local_path_to_url(path)
515
def clone(self, offset=None):
516
"""Return a new LocalTransport with root at self.base + offset
517
Because the local filesystem does not require a connection,
518
we can just return a new object.
521
return EmulatedWin32LocalTransport(self.base)
523
abspath = self.abspath(offset)
524
if abspath == 'file://':
525
# fix upwalk for UNC path
526
# when clone from //HOST/path updir recursively
527
# we should stop at least at //HOST part
529
return EmulatedWin32LocalTransport(abspath)
532
class LocalURLServer(Server):
533
"""A pretend server for local transports, using file:// urls.
535
Of course no actual server is required to access the local filesystem, so
536
this just exists to tell the test code how to get to it.
540
"""Setup the server to service requests.
542
:param decorated_transport: ignored by this implementation.
546
"""See Transport.Server.get_url."""
547
return urlutils.local_path_to_url('')
550
def get_test_permutations():
551
"""Return the permutations to be used in testing."""
553
(LocalTransport, LocalURLServer),
added
removed
bzrlib/transport/local.py
