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)
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
return self._local_base
103
return self._local_base + urlutils.unescape(relative_reference)
105
def abspath(self, relpath):
106
"""Return the full url to the given relative URL."""
107
# TODO: url escape the result. RBC 20060523.
108
# jam 20060426 Using normpath on the real path, because that ensures
109
# proper handling of stuff like
110
path = osutils.normpath(osutils.pathjoin(
111
self._local_base, urlutils.unescape(relpath)))
112
# on windows, our _local_base may or may not have a drive specified
113
# (ie, it may be "/" or "c:/foo").
114
# If 'relpath' is '/' we *always* get back an abspath without
115
# the drive letter - but if our transport already has a drive letter,
116
# we want our abspaths to have a drive letter too - so handle that
118
if (sys.platform == "win32" and self._local_base[1:2] == ":"
120
path = self._local_base[:3]
122
return urlutils.local_path_to_url(path)
124
def local_abspath(self, relpath):
125
"""Transform the given relative path URL into the actual path on disk
127
This function only exists for the LocalTransport, since it is
128
the only one that has direct local access.
129
This is mostly for stuff like WorkingTree which needs to know
130
the local working directory. The returned path will always contain
131
forward slashes as the path separator, regardless of the platform.
133
This function is quite expensive: it calls realpath which resolves
136
absurl = self.abspath(relpath)
137
# mutter(u'relpath %s => base: %s, absurl %s', relpath, self.base, absurl)
138
return urlutils.local_path_from_url(absurl)
140
def relpath(self, abspath):
141
"""Return the local path portion from a given absolute path.
146
return urlutils.file_relpath(
147
urlutils.strip_trailing_slash(self.base),
148
urlutils.strip_trailing_slash(abspath))
150
def has(self, relpath):
151
return os.access(self._abspath(relpath), os.F_OK)
153
def get(self, relpath):
154
"""Get the file at the given relative path.
156
:param relpath: The relative path to the file
158
canonical_url = self.abspath(relpath)
159
if canonical_url in transport._file_streams:
160
transport._file_streams[canonical_url].flush()
162
path = self._abspath(relpath)
163
return open(path, 'rb')
164
except (IOError, OSError),e:
165
if e.errno == errno.EISDIR:
166
return LateReadError(relpath)
167
self._translate_error(e, path)
169
def put_file(self, relpath, f, mode=None):
170
"""Copy the file-like object into the location.
172
:param relpath: Location to put the contents, relative to base.
173
:param f: File-like object.
174
:param mode: The mode for the newly created file,
175
None means just use the default
180
path = self._abspath(relpath)
181
osutils.check_legal_path(path)
182
fp = atomicfile.AtomicFile(path, 'wb', new_mode=mode)
183
except (IOError, OSError),e:
184
self._translate_error(e, path)
186
length = self._pump(f, fp)
192
def put_bytes(self, relpath, bytes, mode=None):
193
"""Copy the string into the location.
195
:param relpath: Location to put the contents, relative to base.
201
path = self._abspath(relpath)
202
osutils.check_legal_path(path)
203
fp = atomicfile.AtomicFile(path, 'wb', new_mode=mode)
204
except (IOError, OSError),e:
205
self._translate_error(e, path)
212
def _put_non_atomic_helper(self, relpath, writer,
214
create_parent_dir=False,
216
"""Common functionality information for the put_*_non_atomic.
218
This tracks all the create_parent_dir stuff.
220
:param relpath: the path we are putting to.
221
:param writer: A function that takes an os level file descriptor
222
and writes whatever data it needs to write there.
223
:param mode: The final file mode.
224
:param create_parent_dir: Should we be creating the parent directory
227
abspath = self._abspath(relpath)
229
# os.open() will automatically use the umask
234
fd = os.open(abspath, _put_non_atomic_flags, local_mode)
235
except (IOError, OSError),e:
236
# We couldn't create the file, maybe we need to create
237
# the parent directory, and try again
238
if (not create_parent_dir
239
or e.errno not in (errno.ENOENT,errno.ENOTDIR)):
240
self._translate_error(e, relpath)
241
parent_dir = os.path.dirname(abspath)
243
self._translate_error(e, relpath)
244
self._mkdir(parent_dir, mode=dir_mode)
245
# We created the parent directory, lets try to open the
248
fd = os.open(abspath, _put_non_atomic_flags, local_mode)
249
except (IOError, OSError), e:
250
self._translate_error(e, relpath)
253
if mode is not None and mode != S_IMODE(st.st_mode):
254
# Because of umask, we may still need to chmod the file.
255
# But in the general case, we won't have to
256
os.chmod(abspath, mode)
261
def put_file_non_atomic(self, relpath, f, mode=None,
262
create_parent_dir=False,
264
"""Copy the file-like object into the target location.
266
This function is not strictly safe to use. It is only meant to
267
be used when you already know that the target does not exist.
268
It is not safe, because it will open and truncate the remote
269
file. So there may be a time when the file has invalid contents.
271
:param relpath: The remote location to put the contents.
272
:param f: File-like object.
273
:param mode: Possible access permissions for new file.
274
None means do not set remote permissions.
275
:param create_parent_dir: If we cannot create the target file because
276
the parent directory does not exist, go ahead and
277
create it, and then try again.
280
self._pump_to_fd(f, fd)
281
self._put_non_atomic_helper(relpath, writer, mode=mode,
282
create_parent_dir=create_parent_dir,
285
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
286
create_parent_dir=False, dir_mode=None):
289
self._put_non_atomic_helper(relpath, writer, mode=mode,
290
create_parent_dir=create_parent_dir,
293
def iter_files_recursive(self):
294
"""Iter the relative paths of files in the transports sub-tree."""
295
queue = list(self.list_dir(u'.'))
297
relpath = queue.pop(0)
298
st = self.stat(relpath)
299
if S_ISDIR(st[ST_MODE]):
300
for i, basename in enumerate(self.list_dir(relpath)):
301
queue.insert(i, relpath+'/'+basename)
305
def _mkdir(self, abspath, mode=None):
306
"""Create a real directory, filtering through mode"""
308
# os.mkdir() will filter through umask
313
os.mkdir(abspath, local_mode)
315
# It is probably faster to just do the chmod, rather than
316
# doing a stat, and then trying to compare
317
os.chmod(abspath, mode)
318
except (IOError, OSError),e:
319
self._translate_error(e, abspath)
321
def mkdir(self, relpath, mode=None):
322
"""Create a directory at the given path."""
323
self._mkdir(self._abspath(relpath), mode=mode)
325
def open_write_stream(self, relpath, mode=None):
326
"""See Transport.open_write_stream."""
327
# initialise the file
328
self.put_bytes_non_atomic(relpath, "", mode=mode)
329
abspath = self._abspath(relpath)
330
handle = open(abspath, 'wb')
332
self._check_mode_and_size(abspath, handle.fileno(), mode)
333
transport._file_streams[self.abspath(relpath)] = handle
334
return transport.FileFileStream(self, relpath, handle)
336
def _get_append_file(self, relpath, mode=None):
337
"""Call os.open() for the given relpath"""
338
file_abspath = self._abspath(relpath)
340
# os.open() will automatically use the umask
345
return file_abspath, os.open(file_abspath, _append_flags, local_mode)
346
except (IOError, OSError),e:
347
self._translate_error(e, relpath)
349
def _check_mode_and_size(self, file_abspath, fd, mode=None):
350
"""Check the mode of the file, and return the current size"""
352
if mode is not None and mode != S_IMODE(st.st_mode):
353
# Because of umask, we may still need to chmod the file.
354
# But in the general case, we won't have to
355
os.chmod(file_abspath, mode)
358
def append_file(self, relpath, f, mode=None):
359
"""Append the text in the file-like object into the final location."""
360
file_abspath, fd = self._get_append_file(relpath, mode=mode)
362
result = self._check_mode_and_size(file_abspath, fd, mode=mode)
363
self._pump_to_fd(f, fd)
368
def append_bytes(self, relpath, bytes, mode=None):
369
"""Append the text in the string into the final location."""
370
file_abspath, fd = self._get_append_file(relpath, mode=mode)
372
result = self._check_mode_and_size(file_abspath, fd, mode=mode)
378
def _pump_to_fd(self, fromfile, to_fd):
379
"""Copy contents of one file to another."""
382
b = fromfile.read(BUFSIZE)
387
def copy(self, rel_from, rel_to):
388
"""Copy 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)
392
shutil.copy(path_from, path_to)
393
except (IOError, OSError),e:
394
# TODO: What about path_to?
395
self._translate_error(e, path_from)
397
def rename(self, rel_from, rel_to):
398
path_from = self._abspath(rel_from)
400
# *don't* call bzrlib.osutils.rename, because we want to
401
# detect errors on rename
402
os.rename(path_from, self._abspath(rel_to))
403
except (IOError, OSError),e:
404
# TODO: What about path_to?
405
self._translate_error(e, path_from)
407
def move(self, rel_from, rel_to):
408
"""Move the item at rel_from to the location at rel_to"""
409
path_from = self._abspath(rel_from)
410
path_to = self._abspath(rel_to)
413
# this version will delete the destination if necessary
414
osutils.rename(path_from, path_to)
415
except (IOError, OSError),e:
416
# TODO: What about path_to?
417
self._translate_error(e, path_from)
419
def delete(self, relpath):
420
"""Delete the item at relpath"""
423
path = self._abspath(relpath)
425
except (IOError, OSError),e:
426
self._translate_error(e, path)
428
def external_url(self):
429
"""See bzrlib.transport.Transport.external_url."""
430
# File URL's are externally usable.
433
def copy_to(self, relpaths, other, mode=None, pb=None):
434
"""Copy a set of entries from self into another Transport.
436
:param relpaths: A list/generator of entries to be copied.
438
if isinstance(other, LocalTransport):
439
# Both from & to are on the local filesystem
440
# Unfortunately, I can't think of anything faster than just
441
# copying them across, one by one :(
442
total = self._get_total(relpaths)
444
for path in relpaths:
445
self._update_pb(pb, 'copy-to', count, total)
447
mypath = self._abspath(path)
448
otherpath = other._abspath(path)
449
shutil.copy(mypath, otherpath)
451
os.chmod(otherpath, mode)
452
except (IOError, OSError),e:
453
self._translate_error(e, path)
457
return super(LocalTransport, self).copy_to(relpaths, other, mode=mode, pb=pb)
460
"""See Transport.listable."""
463
def list_dir(self, relpath):
464
"""Return a list of all files at the given location.
465
WARNING: many transports do not support this, so trying avoid using
466
it if at all possible.
468
path = self._abspath(relpath)
470
entries = os.listdir(path)
471
except (IOError, OSError), e:
472
self._translate_error(e, path)
473
return [urlutils.escape(entry) for entry in entries]
475
def stat(self, relpath):
476
"""Return the stat information for a file.
480
path = self._abspath(relpath)
482
except (IOError, OSError),e:
483
self._translate_error(e, path)
485
def lock_read(self, relpath):
486
"""Lock the given file for shared (read) access.
487
:return: A lock object, which should be passed to Transport.unlock()
489
from bzrlib.lock import ReadLock
492
path = self._abspath(relpath)
493
return ReadLock(path)
494
except (IOError, OSError), e:
495
self._translate_error(e, path)
497
def lock_write(self, relpath):
498
"""Lock the given file for exclusive (write) access.
499
WARNING: many transports do not support this, so trying avoid using it
501
:return: A lock object, which should be passed to Transport.unlock()
503
from bzrlib.lock import WriteLock
504
return WriteLock(self._abspath(relpath))
506
def rmdir(self, relpath):
507
"""See Transport.rmdir."""
510
path = self._abspath(relpath)
512
except (IOError, OSError),e:
513
self._translate_error(e, path)
515
def _can_roundtrip_unix_modebits(self):
516
if sys.platform == 'win32':
523
class EmulatedWin32LocalTransport(LocalTransport):
524
"""Special transport for testing Win32 [UNC] paths on non-windows"""
526
def __init__(self, base):
529
super(LocalTransport, self).__init__(base)
530
self._local_base = urlutils._win32_local_path_from_url(base)
532
def abspath(self, relpath):
533
path = osutils.normpath(osutils.pathjoin(
534
self._local_base, urlutils.unescape(relpath)))
535
return urlutils._win32_local_path_to_url(path)
537
def clone(self, offset=None):
538
"""Return a new LocalTransport with root at self.base + offset
539
Because the local filesystem does not require a connection,
540
we can just return a new object.
543
return EmulatedWin32LocalTransport(self.base)
545
abspath = self.abspath(offset)
546
if abspath == 'file://':
547
# fix upwalk for UNC path
548
# when clone from //HOST/path updir recursively
549
# we should stop at least at //HOST part
551
return EmulatedWin32LocalTransport(abspath)
554
class LocalURLServer(Server):
555
"""A pretend server for local transports, using file:// urls.
557
Of course no actual server is required to access the local filesystem, so
558
this just exists to tell the test code how to get to it.
562
"""Setup the server to service requests.
564
:param decorated_transport: ignored by this implementation.
568
"""See Transport.Server.get_url."""
569
return urlutils.local_path_to_url('')
572
def get_test_permutations():
573
"""Return the permutations to be used in testing."""
575
(LocalTransport, LocalURLServer),
added
removed
bzrlib/transport/local.py
