1
# Copyright (C) 2005, 2006 Canonical Ltd
1
# Copyright (C) 2005 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
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.
16
"""Implementation of Transport for the local filesystem.
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
40
from bzrlib.transport import Transport, Server
43
_append_flags = os.O_CREAT | os.O_APPEND | os.O_WRONLY | osutils.O_BINARY
44
_put_non_atomic_flags = os.O_CREAT | os.O_TRUNC | os.O_WRONLY | osutils.O_BINARY
19
from bzrlib.transport import Transport, register_transport, \
20
TransportError, NoSuchFile, FileExists
23
class LocalTransportError(TransportError):
47
26
class LocalTransport(Transport):
48
27
"""This is the transport agent for local filesystem access."""
50
29
def __init__(self, base):
51
30
"""Set the base path where files will be stored."""
52
if not base.startswith('file://'):
53
symbol_versioning.warn(
54
"Instantiating LocalTransport with a filesystem path"
55
" is deprecated as of bzr 0.8."
56
" Please use bzrlib.transport.get_transport()"
57
" or pass in a file:// url.",
61
base = urlutils.local_path_to_url(base)
64
super(LocalTransport, self).__init__(base)
65
self._local_base = urlutils.local_path_from_url(base)
31
if base.startswith('file://'):
33
super(LocalTransport, self).__init__(os.path.realpath(base))
67
35
def should_cache(self):
76
44
return LocalTransport(self.base)
78
abspath = self.abspath(offset)
79
if abspath == 'file://':
80
# fix upwalk for UNC path
81
# when clone from //HOST/path updir recursively
82
# we should stop at least at //HOST part
84
return LocalTransport(abspath)
86
def _abspath(self, relative_reference):
87
"""Return a path for use in os calls.
89
Several assumptions are made:
90
- relative_reference does not contain '..'
91
- relative_reference is url escaped.
93
if relative_reference in ('.', ''):
94
return self._local_base
95
return self._local_base + urlutils.unescape(relative_reference)
46
return LocalTransport(self.abspath(offset))
97
48
def abspath(self, relpath):
98
"""Return the full url to the given relative URL."""
99
# TODO: url escape the result. RBC 20060523.
100
assert isinstance(relpath, basestring), (type(relpath), relpath)
101
# jam 20060426 Using normpath on the real path, because that ensures
102
# proper handling of stuff like
103
path = osutils.normpath(osutils.pathjoin(
104
self._local_base, urlutils.unescape(relpath)))
105
return urlutils.local_path_to_url(path)
107
def local_abspath(self, relpath):
108
"""Transform the given relative path URL into the actual path on disk
110
This function only exists for the LocalTransport, since it is
111
the only one that has direct local access.
112
This is mostly for stuff like WorkingTree which needs to know
113
the local working directory.
115
This function is quite expensive: it calls realpath which resolves
49
"""Return the full url to the given relative path.
50
This can be supplied with a string or a list
118
absurl = self.abspath(relpath)
119
# mutter(u'relpath %s => base: %s, absurl %s', relpath, self.base, absurl)
120
return urlutils.local_path_from_url(absurl)
52
if isinstance(relpath, basestring):
54
return os.path.join(self.base, *relpath)
122
56
def relpath(self, abspath):
123
57
"""Return the local path portion from a given absolute path.
128
return urlutils.file_relpath(
129
urlutils.strip_trailing_slash(self.base),
130
urlutils.strip_trailing_slash(abspath))
59
from bzrlib.branch import _relpath
60
return _relpath(self.base, abspath)
132
62
def has(self, relpath):
133
return os.access(self._abspath(relpath), os.F_OK)
63
return os.access(self.abspath(relpath), os.F_OK)
135
65
def get(self, relpath):
136
66
"""Get the file at the given relative path.
138
68
:param relpath: The relative path to the file
141
path = self._abspath(relpath)
71
path = self.abspath(relpath)
142
72
return open(path, 'rb')
143
except (IOError, OSError),e:
144
self._translate_error(e, path)
146
def put_file(self, relpath, f, mode=None):
147
"""Copy the file-like object into the location.
74
if e.errno == errno.ENOENT:
75
raise NoSuchFile('File %r does not exist' % path, orig_error=e)
76
raise LocalTransportError(orig_error=e)
78
def get_partial(self, relpath, start, length=None):
79
"""Get just part of a file.
81
:param relpath: Path to the file, relative to base
82
:param start: The starting position to read from
83
:param length: The length to read. A length of None indicates
84
read to the end of the file.
85
:return: A file-like object containing at least the specified bytes.
86
Some implementations may return objects which can be read
87
past this length, but this is not guaranteed.
89
# LocalTransport.get_partial() doesn't care about the length
90
# argument, because it is using a local file, and thus just
91
# returns the file seek'ed to the appropriate location.
93
path = self.abspath(relpath)
98
if e.errno == errno.ENOENT:
99
raise NoSuchFile('File %r does not exist' % path, orig_error=e)
100
raise LocalTransportError(orig_error=e)
102
def put(self, relpath, f):
103
"""Copy the file-like or string object into the location.
149
105
: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
106
:param f: File-like or string object.
108
from bzrlib.atomicfile import AtomicFile
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)
111
path = self.abspath(relpath)
112
fp = AtomicFile(path, 'wb')
114
if e.errno == errno.ENOENT:
115
raise NoSuchFile('File %r does not exist' % path, orig_error=e)
116
raise LocalTransportError(orig_error=e)
163
118
self._pump(f, fp)
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):
123
def mkdir(self, relpath):
298
124
"""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)
126
os.mkdir(self.abspath(relpath))
128
if e.errno == errno.EEXIST:
129
raise FileExists(orig_error=e)
130
elif e.errno == errno.ENOENT:
131
raise NoSuchFile(orig_error=e)
132
raise LocalTransportError(orig_error=e)
134
def append(self, relpath, f):
135
"""Append the text in the file-like object into the final
138
fp = open(self.abspath(relpath), 'ab')
352
141
def copy(self, rel_from, rel_to):
353
142
"""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)
144
path_from = self.abspath(rel_from)
145
path_to = self.abspath(rel_to)
357
147
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)
149
raise LocalTransportError(orig_error=e)
372
151
def move(self, rel_from, rel_to):
373
152
"""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)
153
path_from = self.abspath(rel_from)
154
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)
157
os.rename(path_from, path_to)
159
raise LocalTransportError(orig_error=e)
384
161
def delete(self, relpath):
385
162
"""Delete the item at relpath"""
388
path = self._abspath(relpath)
390
except (IOError, OSError),e:
391
self._translate_error(e, path)
164
os.remove(self.abspath(relpath))
166
raise LocalTransportError(orig_error=e)
393
def copy_to(self, relpaths, other, mode=None, pb=None):
168
def copy_to(self, relpaths, other, pb=None):
394
169
"""Copy a set of entries from self into another Transport.
396
171
:param relpaths: A list/generator of entries to be copied.
399
174
# Both from & to are on the local filesystem
400
175
# Unfortunately, I can't think of anything faster than just
401
176
# copying them across, one by one :(
402
179
total = self._get_total(relpaths)
404
181
for path in relpaths:
405
182
self._update_pb(pb, 'copy-to', count, total)
407
mypath = self._abspath(path)
408
otherpath = other._abspath(path)
409
shutil.copy(mypath, otherpath)
411
os.chmod(otherpath, mode)
412
except (IOError, OSError),e:
413
self._translate_error(e, path)
183
shutil.copy(self.abspath(path), other.abspath(path))
417
return super(LocalTransport, self).copy_to(relpaths, other, mode=mode, pb=pb)
187
return super(LocalTransport, self).copy_to(relpaths, other, pb=pb)
420
"""See Transport.listable."""
423
190
def list_dir(self, relpath):
424
191
"""Return a list of all files at the given location.
425
192
WARNING: many transports do not support this, so trying avoid using
426
193
it if at all possible.
428
path = self._abspath(relpath)
430
entries = os.listdir(path)
431
except (IOError, OSError), e:
432
self._translate_error(e, path)
433
return [urlutils.escape(entry) for entry in entries]
196
return os.listdir(self.abspath(relpath))
198
raise LocalTransportError(orig_error=e)
435
200
def stat(self, relpath):
436
201
"""Return the stat information for a file.
440
path = self._abspath(relpath)
442
except (IOError, OSError),e:
443
self._translate_error(e, path)
204
return os.stat(self.abspath(relpath))
206
raise LocalTransportError(orig_error=e)
445
208
def lock_read(self, relpath):
446
209
"""Lock the given file for shared (read) access.
447
210
:return: A lock object, which should be passed to Transport.unlock()
449
212
from bzrlib.lock import ReadLock
452
path = self._abspath(relpath)
453
return ReadLock(path)
454
except (IOError, OSError), e:
455
self._translate_error(e, path)
213
return ReadLock(self.abspath(relpath))
457
215
def lock_write(self, relpath):
458
216
"""Lock the given file for exclusive (write) access.
461
219
:return: A lock object, which should be passed to Transport.unlock()
463
221
from bzrlib.lock import WriteLock
464
return WriteLock(self._abspath(relpath))
466
def rmdir(self, relpath):
467
"""See Transport.rmdir."""
470
path = self._abspath(relpath)
472
except (IOError, OSError),e:
473
self._translate_error(e, path)
475
def _can_roundtrip_unix_modebits(self):
476
if sys.platform == 'win32':
483
class EmulatedWin32LocalTransport(LocalTransport):
484
"""Special transport for testing Win32 [UNC] paths on non-windows"""
486
def __init__(self, base):
489
super(LocalTransport, self).__init__(base)
490
self._local_base = urlutils._win32_local_path_from_url(base)
492
def abspath(self, relpath):
493
assert isinstance(relpath, basestring), (type(relpath), relpath)
494
path = osutils.normpath(osutils.pathjoin(
495
self._local_base, urlutils.unescape(relpath)))
496
return urlutils._win32_local_path_to_url(path)
498
def clone(self, offset=None):
499
"""Return a new LocalTransport with root at self.base + offset
500
Because the local filesystem does not require a connection,
501
we can just return a new object.
504
return EmulatedWin32LocalTransport(self.base)
506
abspath = self.abspath(offset)
507
if abspath == 'file://':
508
# fix upwalk for UNC path
509
# when clone from //HOST/path updir recursively
510
# we should stop at least at //HOST part
512
return EmulatedWin32LocalTransport(abspath)
515
class LocalURLServer(Server):
516
"""A pretend server for local transports, using file:// urls.
518
Of course no actual server is required to access the local filesystem, so
519
this just exists to tell the test code how to get to it.
523
"""See Transport.Server.get_url."""
524
return urlutils.local_path_to_url('')
527
def get_test_permutations():
528
"""Return the permutations to be used in testing."""
530
(LocalTransport, LocalURLServer),
222
return WriteLock(self.abspath(relpath))
224
# If nothing else matches, try the LocalTransport
225
register_transport(None, LocalTransport)
226
register_transport('file://', LocalTransport)
added
removed
bzrlib/transport/local.py
