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
# jam 20060426 Using normpath on the real path, because that ensures
100
# proper handling of stuff like
101
path = osutils.normpath(osutils.pathjoin(
102
self._local_base, urlutils.unescape(relpath)))
103
return urlutils.local_path_to_url(path)
105
def local_abspath(self, relpath):
106
"""Transform the given relative path URL into the actual path on disk
108
This function only exists for the LocalTransport, since it is
109
the only one that has direct local access.
110
This is mostly for stuff like WorkingTree which needs to know
111
the local working directory.
113
This function is quite expensive: it calls realpath which resolves
116
absurl = self.abspath(relpath)
117
# mutter(u'relpath %s => base: %s, absurl %s', relpath, self.base, absurl)
118
return urlutils.local_path_from_url(absurl)
120
def relpath(self, abspath):
121
"""Return the local path portion from a given absolute path.
126
return urlutils.file_relpath(
127
urlutils.strip_trailing_slash(self.base),
128
urlutils.strip_trailing_slash(abspath))
130
def has(self, relpath):
131
return os.access(self._abspath(relpath), os.F_OK)
133
def get(self, relpath):
134
"""Get the file at the given relative path.
136
:param relpath: The relative path to the file
138
canonical_url = self.abspath(relpath)
139
if canonical_url in transport._file_streams:
140
transport._file_streams[canonical_url].flush()
142
path = self._abspath(relpath)
143
return open(path, 'rb')
144
except (IOError, OSError),e:
145
if e.errno == errno.EISDIR:
146
return LateReadError(relpath)
147
self._translate_error(e, path)
149
def put_file(self, relpath, f, mode=None):
150
"""Copy the file-like object into the location.
152
:param relpath: Location to put the contents, relative to base.
153
:param f: File-like object.
154
:param mode: The mode for the newly created file,
155
None means just use the default
160
path = self._abspath(relpath)
161
osutils.check_legal_path(path)
162
fp = atomicfile.AtomicFile(path, 'wb', new_mode=mode)
163
except (IOError, OSError),e:
164
self._translate_error(e, path)
166
length = self._pump(f, fp)
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
abspath = self._abspath(relpath)
310
handle = open(abspath, 'wb')
312
self._check_mode_and_size(abspath, handle.fileno(), mode)
313
transport._file_streams[self.abspath(relpath)] = handle
314
return transport.FileFileStream(self, relpath, handle)
316
def _get_append_file(self, relpath, mode=None):
317
"""Call os.open() for the given relpath"""
318
file_abspath = self._abspath(relpath)
320
# os.open() will automatically use the umask
325
return file_abspath, os.open(file_abspath, _append_flags, local_mode)
326
except (IOError, OSError),e:
327
self._translate_error(e, relpath)
329
def _check_mode_and_size(self, file_abspath, fd, mode=None):
330
"""Check the mode of the file, and return the current size"""
332
if mode is not None and mode != S_IMODE(st.st_mode):
333
# Because of umask, we may still need to chmod the file.
334
# But in the general case, we won't have to
335
os.chmod(file_abspath, mode)
338
def append_file(self, relpath, f, mode=None):
339
"""Append the text in the file-like object into the final location."""
340
file_abspath, fd = self._get_append_file(relpath, mode=mode)
342
result = self._check_mode_and_size(file_abspath, fd, mode=mode)
343
self._pump_to_fd(f, fd)
348
def append_bytes(self, relpath, bytes, mode=None):
349
"""Append the text in the string into the final location."""
350
file_abspath, fd = self._get_append_file(relpath, mode=mode)
352
result = self._check_mode_and_size(file_abspath, fd, mode=mode)
358
def _pump_to_fd(self, fromfile, to_fd):
359
"""Copy contents of one file to another."""
362
b = fromfile.read(BUFSIZE)
367
def copy(self, rel_from, rel_to):
368
"""Copy the item at rel_from to the location at rel_to"""
369
path_from = self._abspath(rel_from)
370
path_to = self._abspath(rel_to)
372
shutil.copy(path_from, path_to)
373
except (IOError, OSError),e:
374
# TODO: What about path_to?
375
self._translate_error(e, path_from)
377
def rename(self, rel_from, rel_to):
378
path_from = self._abspath(rel_from)
380
# *don't* call bzrlib.osutils.rename, because we want to
381
# detect errors on rename
382
os.rename(path_from, self._abspath(rel_to))
383
except (IOError, OSError),e:
384
# TODO: What about path_to?
385
self._translate_error(e, path_from)
387
def move(self, rel_from, rel_to):
388
"""Move the item at rel_from to the location at rel_to"""
389
path_from = self._abspath(rel_from)
390
path_to = self._abspath(rel_to)
393
# this version will delete the destination if necessary
394
osutils.rename(path_from, path_to)
395
except (IOError, OSError),e:
396
# TODO: What about path_to?
397
self._translate_error(e, path_from)
399
def delete(self, relpath):
400
"""Delete the item at relpath"""
403
path = self._abspath(relpath)
405
except (IOError, OSError),e:
406
self._translate_error(e, path)
408
def external_url(self):
409
"""See bzrlib.transport.Transport.external_url."""
410
# File URL's are externally usable.
413
def copy_to(self, relpaths, other, mode=None, pb=None):
414
"""Copy a set of entries from self into another Transport.
416
:param relpaths: A list/generator of entries to be copied.
418
if isinstance(other, LocalTransport):
419
# Both from & to are on the local filesystem
420
# Unfortunately, I can't think of anything faster than just
421
# copying them across, one by one :(
422
total = self._get_total(relpaths)
424
for path in relpaths:
425
self._update_pb(pb, 'copy-to', count, total)
427
mypath = self._abspath(path)
428
otherpath = other._abspath(path)
429
shutil.copy(mypath, otherpath)
431
os.chmod(otherpath, mode)
432
except (IOError, OSError),e:
433
self._translate_error(e, path)
437
return super(LocalTransport, self).copy_to(relpaths, other, mode=mode, pb=pb)
440
"""See Transport.listable."""
443
def list_dir(self, relpath):
444
"""Return a list of all files at the given location.
445
WARNING: many transports do not support this, so trying avoid using
446
it if at all possible.
448
path = self._abspath(relpath)
450
entries = os.listdir(path)
451
except (IOError, OSError), e:
452
self._translate_error(e, path)
453
return [urlutils.escape(entry) for entry in entries]
455
def stat(self, relpath):
456
"""Return the stat information for a file.
460
path = self._abspath(relpath)
462
except (IOError, OSError),e:
463
self._translate_error(e, path)
465
def lock_read(self, relpath):
466
"""Lock the given file for shared (read) access.
467
:return: A lock object, which should be passed to Transport.unlock()
469
from bzrlib.lock import ReadLock
472
path = self._abspath(relpath)
473
return ReadLock(path)
474
except (IOError, OSError), e:
475
self._translate_error(e, path)
477
def lock_write(self, relpath):
478
"""Lock the given file for exclusive (write) access.
479
WARNING: many transports do not support this, so trying avoid using it
481
:return: A lock object, which should be passed to Transport.unlock()
483
from bzrlib.lock import WriteLock
484
return WriteLock(self._abspath(relpath))
486
def rmdir(self, relpath):
487
"""See Transport.rmdir."""
490
path = self._abspath(relpath)
492
except (IOError, OSError),e:
493
self._translate_error(e, path)
495
def _can_roundtrip_unix_modebits(self):
496
if sys.platform == 'win32':
503
class EmulatedWin32LocalTransport(LocalTransport):
504
"""Special transport for testing Win32 [UNC] paths on non-windows"""
506
def __init__(self, base):
509
super(LocalTransport, self).__init__(base)
510
self._local_base = urlutils._win32_local_path_from_url(base)
512
def abspath(self, relpath):
513
path = osutils.normpath(osutils.pathjoin(
514
self._local_base, urlutils.unescape(relpath)))
515
return urlutils._win32_local_path_to_url(path)
517
def clone(self, offset=None):
518
"""Return a new LocalTransport with root at self.base + offset
519
Because the local filesystem does not require a connection,
520
we can just return a new object.
523
return EmulatedWin32LocalTransport(self.base)
525
abspath = self.abspath(offset)
526
if abspath == 'file://':
527
# fix upwalk for UNC path
528
# when clone from //HOST/path updir recursively
529
# we should stop at least at //HOST part
531
return EmulatedWin32LocalTransport(abspath)
534
class LocalURLServer(Server):
535
"""A pretend server for local transports, using file:// urls.
537
Of course no actual server is required to access the local filesystem, so
538
this just exists to tell the test code how to get to it.
542
"""Setup the server to service requests.
544
:param decorated_transport: ignored by this implementation.
548
"""See Transport.Server.get_url."""
549
return urlutils.local_path_to_url('')
552
def get_test_permutations():
553
"""Return the permutations to be used in testing."""
555
(LocalTransport, LocalURLServer),
added
removed
bzrlib/transport/local.py
