1
# Copyright (C) 2005-2010 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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 import transport
45
_append_flags = os.O_CREAT | os.O_APPEND | os.O_WRONLY | osutils.O_BINARY | osutils.O_NOINHERIT
46
_put_non_atomic_flags = os.O_CREAT | os.O_TRUNC | os.O_WRONLY | osutils.O_BINARY | osutils.O_NOINHERIT
49
class LocalTransport(transport.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)
67
# Special case : windows has no "root", but does have
68
# multiple lettered drives inside it. #240910
69
if sys.platform == 'win32' and base == 'file:///':
72
super(LocalTransport, self).__init__(base)
75
super(LocalTransport, self).__init__(base)
76
self._local_base = urlutils.local_path_from_url(base)
78
def clone(self, offset=None):
79
"""Return a new LocalTransport with root at self.base + offset
80
Because the local filesystem does not require a connection,
81
we can just return a new object.
84
return LocalTransport(self.base)
86
abspath = self.abspath(offset)
87
if abspath == 'file://':
88
# fix upwalk for UNC path
89
# when clone from //HOST/path updir recursively
90
# we should stop at least at //HOST part
92
return LocalTransport(abspath)
94
def _abspath(self, relative_reference):
95
"""Return a path for use in os calls.
97
Several assumptions are made:
98
- relative_reference does not contain '..'
99
- relative_reference is url escaped.
101
if relative_reference in ('.', ''):
102
# _local_base normally has a trailing slash; strip it so that stat
103
# on a transport pointing to a symlink reads the link not the
104
# referent but be careful of / and c:\
105
return osutils.split(self._local_base)[0]
106
return self._local_base + urlutils.unescape(relative_reference)
108
def abspath(self, relpath):
109
"""Return the full url to the given relative URL."""
110
# TODO: url escape the result. RBC 20060523.
111
# jam 20060426 Using normpath on the real path, because that ensures
112
# proper handling of stuff like
113
path = osutils.normpath(osutils.pathjoin(
114
self._local_base, urlutils.unescape(relpath)))
115
# on windows, our _local_base may or may not have a drive specified
116
# (ie, it may be "/" or "c:/foo").
117
# If 'relpath' is '/' we *always* get back an abspath without
118
# the drive letter - but if our transport already has a drive letter,
119
# we want our abspaths to have a drive letter too - so handle that
121
if (sys.platform == "win32" and self._local_base[1:2] == ":"
123
path = self._local_base[:3]
125
return urlutils.local_path_to_url(path)
127
def local_abspath(self, relpath):
128
"""Transform the given relative path URL into the actual path on disk
130
This function only exists for the LocalTransport, since it is
131
the only one that has direct local access.
132
This is mostly for stuff like WorkingTree which needs to know
133
the local working directory. The returned path will always contain
134
forward slashes as the path separator, regardless of the platform.
136
This function is quite expensive: it calls realpath which resolves
139
absurl = self.abspath(relpath)
140
# mutter(u'relpath %s => base: %s, absurl %s', relpath, self.base, absurl)
141
return urlutils.local_path_from_url(absurl)
143
def relpath(self, abspath):
144
"""Return the local path portion from a given absolute path.
149
return urlutils.file_relpath(
150
urlutils.strip_trailing_slash(self.base),
151
urlutils.strip_trailing_slash(abspath))
153
def has(self, relpath):
154
return os.access(self._abspath(relpath), os.F_OK)
156
def get(self, relpath):
157
"""Get the file at the given relative path.
159
:param relpath: The relative path to the file
161
canonical_url = self.abspath(relpath)
162
if canonical_url in transport._file_streams:
163
transport._file_streams[canonical_url].flush()
165
path = self._abspath(relpath)
166
return osutils.open_file(path, 'rb')
167
except (IOError, OSError),e:
168
if e.errno == errno.EISDIR:
169
return LateReadError(relpath)
170
self._translate_error(e, path)
172
def put_file(self, relpath, f, mode=None):
173
"""Copy the file-like object into the location.
175
:param relpath: Location to put the contents, relative to base.
176
:param f: File-like object.
177
:param mode: The mode for the newly created file,
178
None means just use the default
183
path = self._abspath(relpath)
184
osutils.check_legal_path(path)
185
fp = atomicfile.AtomicFile(path, 'wb', new_mode=mode)
186
except (IOError, OSError),e:
187
self._translate_error(e, path)
189
length = self._pump(f, fp)
195
def put_bytes(self, relpath, bytes, mode=None):
196
"""Copy the string into the location.
198
:param relpath: Location to put the contents, relative to base.
204
path = self._abspath(relpath)
205
osutils.check_legal_path(path)
206
fp = atomicfile.AtomicFile(path, 'wb', new_mode=mode)
207
except (IOError, OSError),e:
208
self._translate_error(e, path)
216
def _put_non_atomic_helper(self, relpath, writer,
218
create_parent_dir=False,
220
"""Common functionality information for the put_*_non_atomic.
222
This tracks all the create_parent_dir stuff.
224
:param relpath: the path we are putting to.
225
:param writer: A function that takes an os level file descriptor
226
and writes whatever data it needs to write there.
227
:param mode: The final file mode.
228
:param create_parent_dir: Should we be creating the parent directory
231
abspath = self._abspath(relpath)
233
# os.open() will automatically use the umask
238
fd = os.open(abspath, _put_non_atomic_flags, local_mode)
239
except (IOError, OSError),e:
240
# We couldn't create the file, maybe we need to create
241
# the parent directory, and try again
242
if (not create_parent_dir
243
or e.errno not in (errno.ENOENT,errno.ENOTDIR)):
244
self._translate_error(e, relpath)
245
parent_dir = os.path.dirname(abspath)
247
self._translate_error(e, relpath)
248
self._mkdir(parent_dir, mode=dir_mode)
249
# We created the parent directory, lets try to open the
252
fd = os.open(abspath, _put_non_atomic_flags, local_mode)
253
except (IOError, OSError), e:
254
self._translate_error(e, relpath)
257
if mode is not None and mode != S_IMODE(st.st_mode):
258
# Because of umask, we may still need to chmod the file.
259
# But in the general case, we won't have to
260
os.chmod(abspath, mode)
265
def put_file_non_atomic(self, relpath, f, mode=None,
266
create_parent_dir=False,
268
"""Copy the file-like object into the target location.
270
This function is not strictly safe to use. It is only meant to
271
be used when you already know that the target does not exist.
272
It is not safe, because it will open and truncate the remote
273
file. So there may be a time when the file has invalid contents.
275
:param relpath: The remote location to put the contents.
276
:param f: File-like object.
277
:param mode: Possible access permissions for new file.
278
None means do not set remote permissions.
279
:param create_parent_dir: If we cannot create the target file because
280
the parent directory does not exist, go ahead and
281
create it, and then try again.
284
self._pump_to_fd(f, fd)
285
self._put_non_atomic_helper(relpath, writer, mode=mode,
286
create_parent_dir=create_parent_dir,
289
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
290
create_parent_dir=False, dir_mode=None):
294
self._put_non_atomic_helper(relpath, writer, mode=mode,
295
create_parent_dir=create_parent_dir,
298
def iter_files_recursive(self):
299
"""Iter the relative paths of files in the transports sub-tree."""
300
queue = list(self.list_dir(u'.'))
302
relpath = queue.pop(0)
303
st = self.stat(relpath)
304
if S_ISDIR(st[ST_MODE]):
305
for i, basename in enumerate(self.list_dir(relpath)):
306
queue.insert(i, relpath+'/'+basename)
310
def _mkdir(self, abspath, mode=None):
311
"""Create a real directory, filtering through mode"""
313
# os.mkdir() will filter through umask
318
os.mkdir(abspath, local_mode)
320
# It is probably faster to just do the chmod, rather than
321
# doing a stat, and then trying to compare
322
os.chmod(abspath, mode)
323
except (IOError, OSError),e:
324
self._translate_error(e, abspath)
326
def mkdir(self, relpath, mode=None):
327
"""Create a directory at the given path."""
328
self._mkdir(self._abspath(relpath), mode=mode)
330
def open_write_stream(self, relpath, mode=None):
331
"""See Transport.open_write_stream."""
332
# initialise the file
333
self.put_bytes_non_atomic(relpath, "", mode=mode)
334
abspath = self._abspath(relpath)
335
handle = osutils.open_file(abspath, 'wb')
337
self._check_mode_and_size(abspath, handle.fileno(), mode)
338
transport._file_streams[self.abspath(relpath)] = handle
339
return transport.FileFileStream(self, relpath, handle)
341
def _get_append_file(self, relpath, mode=None):
342
"""Call os.open() for the given relpath"""
343
file_abspath = self._abspath(relpath)
345
# os.open() will automatically use the umask
350
return file_abspath, os.open(file_abspath, _append_flags, local_mode)
351
except (IOError, OSError),e:
352
self._translate_error(e, relpath)
354
def _check_mode_and_size(self, file_abspath, fd, mode=None):
355
"""Check the mode of the file, and return the current size"""
357
if mode is not None and mode != S_IMODE(st.st_mode):
358
# Because of umask, we may still need to chmod the file.
359
# But in the general case, we won't have to
360
os.chmod(file_abspath, mode)
363
def append_file(self, relpath, f, mode=None):
364
"""Append the text in the file-like object into the final location."""
365
file_abspath, fd = self._get_append_file(relpath, mode=mode)
367
result = self._check_mode_and_size(file_abspath, fd, mode=mode)
368
self._pump_to_fd(f, fd)
373
def append_bytes(self, relpath, bytes, mode=None):
374
"""Append the text in the string into the final location."""
375
file_abspath, fd = self._get_append_file(relpath, mode=mode)
377
result = self._check_mode_and_size(file_abspath, fd, mode=mode)
384
def _pump_to_fd(self, fromfile, to_fd):
385
"""Copy contents of one file to another."""
388
b = fromfile.read(BUFSIZE)
393
def copy(self, rel_from, rel_to):
394
"""Copy the item at rel_from to the location at rel_to"""
395
path_from = self._abspath(rel_from)
396
path_to = self._abspath(rel_to)
398
shutil.copy(path_from, path_to)
399
except (IOError, OSError),e:
400
# TODO: What about path_to?
401
self._translate_error(e, path_from)
403
def rename(self, rel_from, rel_to):
404
path_from = self._abspath(rel_from)
405
path_to = self._abspath(rel_to)
407
# *don't* call bzrlib.osutils.rename, because we want to
408
# detect conflicting names on rename, and osutils.rename tries to
409
# mask cross-platform differences there
410
os.rename(path_from, path_to)
411
except (IOError, OSError),e:
412
# TODO: What about path_to?
413
self._translate_error(e, path_from)
415
def move(self, rel_from, rel_to):
416
"""Move the item at rel_from to the location at rel_to"""
417
path_from = self._abspath(rel_from)
418
path_to = self._abspath(rel_to)
421
# this version will delete the destination if necessary
422
osutils.rename(path_from, path_to)
423
except (IOError, OSError),e:
424
# TODO: What about path_to?
425
self._translate_error(e, path_from)
427
def delete(self, relpath):
428
"""Delete the item at relpath"""
431
path = self._abspath(relpath)
433
except (IOError, OSError),e:
434
self._translate_error(e, path)
436
def external_url(self):
437
"""See bzrlib.transport.Transport.external_url."""
438
# File URL's are externally usable.
441
def copy_to(self, relpaths, other, mode=None, pb=None):
442
"""Copy a set of entries from self into another Transport.
444
:param relpaths: A list/generator of entries to be copied.
446
if isinstance(other, LocalTransport):
447
# Both from & to are on the local filesystem
448
# Unfortunately, I can't think of anything faster than just
449
# copying them across, one by one :(
450
total = self._get_total(relpaths)
452
for path in relpaths:
453
self._update_pb(pb, 'copy-to', count, total)
455
mypath = self._abspath(path)
456
otherpath = other._abspath(path)
457
shutil.copy(mypath, otherpath)
459
os.chmod(otherpath, mode)
460
except (IOError, OSError),e:
461
self._translate_error(e, path)
465
return super(LocalTransport, self).copy_to(relpaths, other, mode=mode, pb=pb)
468
"""See Transport.listable."""
471
def list_dir(self, relpath):
472
"""Return a list of all files at the given location.
473
WARNING: many transports do not support this, so trying avoid using
474
it if at all possible.
476
path = self._abspath(relpath)
478
entries = os.listdir(path)
479
except (IOError, OSError), e:
480
self._translate_error(e, path)
481
return [urlutils.escape(entry) for entry in entries]
483
def stat(self, relpath):
484
"""Return the stat information for a file.
488
path = self._abspath(relpath)
489
return os.lstat(path)
490
except (IOError, OSError),e:
491
self._translate_error(e, path)
493
def lock_read(self, relpath):
494
"""Lock the given file for shared (read) access.
495
:return: A lock object, which should be passed to Transport.unlock()
497
from bzrlib.lock import ReadLock
500
path = self._abspath(relpath)
501
return ReadLock(path)
502
except (IOError, OSError), e:
503
self._translate_error(e, path)
505
def lock_write(self, relpath):
506
"""Lock the given file for exclusive (write) access.
507
WARNING: many transports do not support this, so trying avoid using it
509
:return: A lock object, which should be passed to Transport.unlock()
511
from bzrlib.lock import WriteLock
512
return WriteLock(self._abspath(relpath))
514
def rmdir(self, relpath):
515
"""See Transport.rmdir."""
518
path = self._abspath(relpath)
520
except (IOError, OSError),e:
521
self._translate_error(e, path)
523
if osutils.host_os_dereferences_symlinks():
524
def readlink(self, relpath):
525
"""See Transport.readlink."""
526
return osutils.readlink(self._abspath(relpath))
528
if osutils.hardlinks_good():
529
def hardlink(self, source, link_name):
530
"""See Transport.link."""
532
os.link(self._abspath(source), self._abspath(link_name))
533
except (IOError, OSError), e:
534
self._translate_error(e, source)
536
if osutils.has_symlinks():
537
def symlink(self, source, link_name):
538
"""See Transport.symlink."""
539
abs_link_dirpath = urlutils.dirname(self.abspath(link_name))
540
source_rel = urlutils.file_relpath(
541
urlutils.strip_trailing_slash(abs_link_dirpath),
542
urlutils.strip_trailing_slash(self.abspath(source))
546
os.symlink(source_rel, self._abspath(link_name))
547
except (IOError, OSError), e:
548
self._translate_error(e, source_rel)
550
def _can_roundtrip_unix_modebits(self):
551
if sys.platform == 'win32':
558
class EmulatedWin32LocalTransport(LocalTransport):
559
"""Special transport for testing Win32 [UNC] paths on non-windows"""
561
def __init__(self, base):
564
super(LocalTransport, self).__init__(base)
565
self._local_base = urlutils._win32_local_path_from_url(base)
567
def abspath(self, relpath):
568
path = osutils.normpath(osutils.pathjoin(
569
self._local_base, urlutils.unescape(relpath)))
570
return urlutils._win32_local_path_to_url(path)
572
def clone(self, offset=None):
573
"""Return a new LocalTransport with root at self.base + offset
574
Because the local filesystem does not require a connection,
575
we can just return a new object.
578
return EmulatedWin32LocalTransport(self.base)
580
abspath = self.abspath(offset)
581
if abspath == 'file://':
582
# fix upwalk for UNC path
583
# when clone from //HOST/path updir recursively
584
# we should stop at least at //HOST part
586
return EmulatedWin32LocalTransport(abspath)
589
def get_test_permutations():
590
"""Return the permutations to be used in testing."""
591
from bzrlib.tests import test_server
592
return [(LocalTransport, test_server.LocalURLServer),]
added
removed
bzrlib/transport/local.py
