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(), """
37
from bzrlib.trace import mutter
38
from bzrlib.transport import LateReadError
41
from bzrlib.transport import Transport, Server
44
_append_flags = os.O_CREAT | os.O_APPEND | os.O_WRONLY | osutils.O_BINARY
45
_put_non_atomic_flags = os.O_CREAT | os.O_TRUNC | os.O_WRONLY | osutils.O_BINARY
48
class LocalTransport(Transport):
49
"""This is the transport agent for local filesystem access."""
51
def __init__(self, base):
52
"""Set the base path where files will be stored."""
53
if not base.startswith('file://'):
54
symbol_versioning.warn(
55
"Instantiating LocalTransport with a filesystem path"
56
" is deprecated as of bzr 0.8."
57
" Please use bzrlib.transport.get_transport()"
58
" or pass in a file:// url.",
62
base = urlutils.local_path_to_url(base)
65
super(LocalTransport, self).__init__(base)
66
self._local_base = urlutils.local_path_from_url(base)
68
def clone(self, offset=None):
69
"""Return a new LocalTransport with root at self.base + offset
70
Because the local filesystem does not require a connection,
71
we can just return a new object.
74
return LocalTransport(self.base)
76
abspath = self.abspath(offset)
77
if abspath == 'file://':
78
# fix upwalk for UNC path
79
# when clone from //HOST/path updir recursively
80
# we should stop at least at //HOST part
82
return LocalTransport(abspath)
84
def _abspath(self, relative_reference):
85
"""Return a path for use in os calls.
87
Several assumptions are made:
88
- relative_reference does not contain '..'
89
- relative_reference is url escaped.
91
if relative_reference in ('.', ''):
92
return self._local_base
93
return self._local_base + urlutils.unescape(relative_reference)
95
def abspath(self, relpath):
96
"""Return the full url to the given relative URL."""
97
# TODO: url escape the result. RBC 20060523.
98
assert isinstance(relpath, basestring), (type(relpath), relpath)
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
139
path = self._abspath(relpath)
140
return open(path, 'rb')
141
except (IOError, OSError),e:
142
if e.errno == errno.EISDIR:
143
return LateReadError(relpath)
144
self._translate_error(e, path)
146
def put_file(self, relpath, f, mode=None):
147
"""Copy the file-like object into the location.
149
:param relpath: Location to put the contents, relative to base.
150
:param f: File-like object.
151
:param mode: The mode for the newly created file,
152
None means just use the default
157
path = self._abspath(relpath)
158
osutils.check_legal_path(path)
159
fp = atomicfile.AtomicFile(path, 'wb', new_mode=mode)
160
except (IOError, OSError),e:
161
self._translate_error(e, path)
168
def put_bytes(self, relpath, bytes, mode=None):
169
"""Copy the string into the location.
171
:param relpath: Location to put the contents, relative to base.
177
path = self._abspath(relpath)
178
osutils.check_legal_path(path)
179
fp = atomicfile.AtomicFile(path, 'wb', new_mode=mode)
180
except (IOError, OSError),e:
181
self._translate_error(e, path)
188
def _put_non_atomic_helper(self, relpath, writer,
190
create_parent_dir=False,
192
"""Common functionality information for the put_*_non_atomic.
194
This tracks all the create_parent_dir stuff.
196
:param relpath: the path we are putting to.
197
:param writer: A function that takes an os level file descriptor
198
and writes whatever data it needs to write there.
199
:param mode: The final file mode.
200
:param create_parent_dir: Should we be creating the parent directory
203
abspath = self._abspath(relpath)
205
# os.open() will automatically use the umask
210
fd = os.open(abspath, _put_non_atomic_flags, local_mode)
211
except (IOError, OSError),e:
212
# We couldn't create the file, maybe we need to create
213
# the parent directory, and try again
214
if (not create_parent_dir
215
or e.errno not in (errno.ENOENT,errno.ENOTDIR)):
216
self._translate_error(e, relpath)
217
parent_dir = os.path.dirname(abspath)
219
self._translate_error(e, relpath)
220
self._mkdir(parent_dir, mode=dir_mode)
221
# We created the parent directory, lets try to open the
224
fd = os.open(abspath, _put_non_atomic_flags, local_mode)
225
except (IOError, OSError), e:
226
self._translate_error(e, relpath)
229
if mode is not None and mode != S_IMODE(st.st_mode):
230
# Because of umask, we may still need to chmod the file.
231
# But in the general case, we won't have to
232
os.chmod(abspath, mode)
237
def put_file_non_atomic(self, relpath, f, mode=None,
238
create_parent_dir=False,
240
"""Copy the file-like object into the target location.
242
This function is not strictly safe to use. It is only meant to
243
be used when you already know that the target does not exist.
244
It is not safe, because it will open and truncate the remote
245
file. So there may be a time when the file has invalid contents.
247
:param relpath: The remote location to put the contents.
248
:param f: File-like object.
249
:param mode: Possible access permissions for new file.
250
None means do not set remote permissions.
251
:param create_parent_dir: If we cannot create the target file because
252
the parent directory does not exist, go ahead and
253
create it, and then try again.
256
self._pump_to_fd(f, fd)
257
self._put_non_atomic_helper(relpath, writer, mode=mode,
258
create_parent_dir=create_parent_dir,
261
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
262
create_parent_dir=False, dir_mode=None):
265
self._put_non_atomic_helper(relpath, writer, mode=mode,
266
create_parent_dir=create_parent_dir,
269
def iter_files_recursive(self):
270
"""Iter the relative paths of files in the transports sub-tree."""
271
queue = list(self.list_dir(u'.'))
273
relpath = queue.pop(0)
274
st = self.stat(relpath)
275
if S_ISDIR(st[ST_MODE]):
276
for i, basename in enumerate(self.list_dir(relpath)):
277
queue.insert(i, relpath+'/'+basename)
281
def _mkdir(self, abspath, mode=None):
282
"""Create a real directory, filtering through mode"""
284
# os.mkdir() will filter through umask
289
os.mkdir(abspath, local_mode)
291
# It is probably faster to just do the chmod, rather than
292
# doing a stat, and then trying to compare
293
os.chmod(abspath, mode)
294
except (IOError, OSError),e:
295
self._translate_error(e, abspath)
297
def mkdir(self, relpath, mode=None):
298
"""Create a directory at the given path."""
299
self._mkdir(self._abspath(relpath), mode=mode)
301
def _get_append_file(self, relpath, mode=None):
302
"""Call os.open() for the given relpath"""
303
file_abspath = self._abspath(relpath)
305
# os.open() will automatically use the umask
310
return file_abspath, os.open(file_abspath, _append_flags, local_mode)
311
except (IOError, OSError),e:
312
self._translate_error(e, relpath)
314
def _check_mode_and_size(self, file_abspath, fd, mode=None):
315
"""Check the mode of the file, and return the current size"""
317
if mode is not None and mode != S_IMODE(st.st_mode):
318
# Because of umask, we may still need to chmod the file.
319
# But in the general case, we won't have to
320
os.chmod(file_abspath, mode)
323
def append_file(self, relpath, f, mode=None):
324
"""Append the text in the file-like object into the final location."""
325
file_abspath, fd = self._get_append_file(relpath, mode=mode)
327
result = self._check_mode_and_size(file_abspath, fd, mode=mode)
328
self._pump_to_fd(f, fd)
333
def append_bytes(self, relpath, bytes, mode=None):
334
"""Append the text in the string into the final location."""
335
file_abspath, fd = self._get_append_file(relpath, mode=mode)
337
result = self._check_mode_and_size(file_abspath, fd, mode=mode)
343
def _pump_to_fd(self, fromfile, to_fd):
344
"""Copy contents of one file to another."""
347
b = fromfile.read(BUFSIZE)
352
def copy(self, rel_from, rel_to):
353
"""Copy the item at rel_from to the location at rel_to"""
354
path_from = self._abspath(rel_from)
355
path_to = self._abspath(rel_to)
357
shutil.copy(path_from, path_to)
358
except (IOError, OSError),e:
359
# TODO: What about path_to?
360
self._translate_error(e, path_from)
362
def rename(self, rel_from, rel_to):
363
path_from = self._abspath(rel_from)
365
# *don't* call bzrlib.osutils.rename, because we want to
366
# detect errors on rename
367
os.rename(path_from, self._abspath(rel_to))
368
except (IOError, OSError),e:
369
# TODO: What about path_to?
370
self._translate_error(e, path_from)
372
def move(self, rel_from, rel_to):
373
"""Move the item at rel_from to the location at rel_to"""
374
path_from = self._abspath(rel_from)
375
path_to = self._abspath(rel_to)
378
# this version will delete the destination if necessary
379
osutils.rename(path_from, path_to)
380
except (IOError, OSError),e:
381
# TODO: What about path_to?
382
self._translate_error(e, path_from)
384
def delete(self, relpath):
385
"""Delete the item at relpath"""
388
path = self._abspath(relpath)
390
except (IOError, OSError),e:
391
self._translate_error(e, path)
393
def external_url(self):
394
"""See bzrlib.transport.Transport.external_url."""
395
# File URL's are externally usable.
398
def copy_to(self, relpaths, other, mode=None, pb=None):
399
"""Copy a set of entries from self into another Transport.
401
:param relpaths: A list/generator of entries to be copied.
403
if isinstance(other, LocalTransport):
404
# Both from & to are on the local filesystem
405
# Unfortunately, I can't think of anything faster than just
406
# copying them across, one by one :(
407
total = self._get_total(relpaths)
409
for path in relpaths:
410
self._update_pb(pb, 'copy-to', count, total)
412
mypath = self._abspath(path)
413
otherpath = other._abspath(path)
414
shutil.copy(mypath, otherpath)
416
os.chmod(otherpath, mode)
417
except (IOError, OSError),e:
418
self._translate_error(e, path)
422
return super(LocalTransport, self).copy_to(relpaths, other, mode=mode, pb=pb)
425
"""See Transport.listable."""
428
def list_dir(self, relpath):
429
"""Return a list of all files at the given location.
430
WARNING: many transports do not support this, so trying avoid using
431
it if at all possible.
433
path = self._abspath(relpath)
435
entries = os.listdir(path)
436
except (IOError, OSError), e:
437
self._translate_error(e, path)
438
return [urlutils.escape(entry) for entry in entries]
440
def stat(self, relpath):
441
"""Return the stat information for a file.
445
path = self._abspath(relpath)
447
except (IOError, OSError),e:
448
self._translate_error(e, path)
450
def lock_read(self, relpath):
451
"""Lock the given file for shared (read) access.
452
:return: A lock object, which should be passed to Transport.unlock()
454
from bzrlib.lock import ReadLock
457
path = self._abspath(relpath)
458
return ReadLock(path)
459
except (IOError, OSError), e:
460
self._translate_error(e, path)
462
def lock_write(self, relpath):
463
"""Lock the given file for exclusive (write) access.
464
WARNING: many transports do not support this, so trying avoid using it
466
:return: A lock object, which should be passed to Transport.unlock()
468
from bzrlib.lock import WriteLock
469
return WriteLock(self._abspath(relpath))
471
def rmdir(self, relpath):
472
"""See Transport.rmdir."""
475
path = self._abspath(relpath)
477
except (IOError, OSError),e:
478
self._translate_error(e, path)
480
def _can_roundtrip_unix_modebits(self):
481
if sys.platform == 'win32':
488
class EmulatedWin32LocalTransport(LocalTransport):
489
"""Special transport for testing Win32 [UNC] paths on non-windows"""
491
def __init__(self, base):
494
super(LocalTransport, self).__init__(base)
495
self._local_base = urlutils._win32_local_path_from_url(base)
497
def abspath(self, relpath):
498
assert isinstance(relpath, basestring), (type(relpath), relpath)
499
path = osutils.normpath(osutils.pathjoin(
500
self._local_base, urlutils.unescape(relpath)))
501
return urlutils._win32_local_path_to_url(path)
503
def clone(self, offset=None):
504
"""Return a new LocalTransport with root at self.base + offset
505
Because the local filesystem does not require a connection,
506
we can just return a new object.
509
return EmulatedWin32LocalTransport(self.base)
511
abspath = self.abspath(offset)
512
if abspath == 'file://':
513
# fix upwalk for UNC path
514
# when clone from //HOST/path updir recursively
515
# we should stop at least at //HOST part
517
return EmulatedWin32LocalTransport(abspath)
520
class LocalURLServer(Server):
521
"""A pretend server for local transports, using file:// urls.
523
Of course no actual server is required to access the local filesystem, so
524
this just exists to tell the test code how to get to it.
528
"""Setup the server to service requests.
530
:param decorated_transport: ignored by this implementation.
534
"""See Transport.Server.get_url."""
535
return urlutils.local_path_to_url('')
538
def get_test_permutations():
539
"""Return the permutations to be used in testing."""
541
(LocalTransport, LocalURLServer),
added
removed
bzrlib/transport/local.py
