1
# Copyright (C) 2005-2011 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
# 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.
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
"""Implementation of Transport for the local filesystem.
23
from stat import ST_MODE, S_ISDIR, S_IMODE
26
from bzrlib.lazy_import import lazy_import
27
lazy_import(globals(), """
37
from bzrlib.transport import LateReadError
40
from bzrlib import transport
43
_append_flags = os.O_CREAT | os.O_APPEND | os.O_WRONLY | osutils.O_BINARY | osutils.O_NOINHERIT
44
_put_non_atomic_flags = os.O_CREAT | os.O_TRUNC | os.O_WRONLY | osutils.O_BINARY | osutils.O_NOINHERIT
47
class LocalTransport(transport.Transport):
22
from stat import ST_MODE, S_ISDIR, ST_SIZE
25
from bzrlib.trace import mutter
26
from bzrlib.transport import Transport, register_transport, \
27
TransportError, NoSuchFile, FileExists
30
class LocalTransportError(TransportError):
34
class LocalTransport(Transport):
48
35
"""This is the transport agent for local filesystem access."""
50
37
def __init__(self, base):
51
38
"""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)
65
# Special case : windows has no "root", but does have
66
# multiple lettered drives inside it. #240910
67
if sys.platform == 'win32' and base == 'file:///':
70
super(LocalTransport, self).__init__(base)
73
super(LocalTransport, self).__init__(base)
74
self._local_base = urlutils.local_path_from_url(base)
75
if self._local_base[-1] != '/':
76
self._local_base = self._local_base + '/'
39
if base.startswith('file://'):
41
# realpath is incompatible with symlinks. When we traverse
42
# up we might be able to normpath stuff. RBC 20051003
43
super(LocalTransport, self).__init__(
44
os.path.normpath(os.path.abspath(base)))
46
def should_cache(self):
78
49
def clone(self, offset=None):
79
50
"""Return a new LocalTransport with root at self.base + offset
80
Because the local filesystem does not require a connection,
51
Because the local filesystem does not require a connection,
81
52
we can just return a new object.
84
55
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)
57
return LocalTransport(self.abspath(offset))
108
59
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
60
"""Return the full url to the given relative path.
61
This can be supplied with a string or a list
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)
63
if isinstance(relpath, basestring):
65
return os.path.join(self.base, *relpath)
143
67
def relpath(self, abspath):
144
68
"""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))
70
from bzrlib.osutils import relpath
71
return relpath(self.base, abspath)
153
73
def has(self, relpath):
154
return os.access(self._abspath(relpath), os.F_OK)
74
return os.access(self.abspath(relpath), os.F_OK)
156
76
def get(self, relpath):
157
77
"""Get the file at the given relative path.
159
79
: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,
82
path = self.abspath(relpath)
83
return open(path, 'rb')
85
if e.errno in (errno.ENOENT, errno.ENOTDIR):
86
raise NoSuchFile('File or directory %r does not exist' % path, orig_error=e)
87
raise LocalTransportError(orig_error=e)
89
def put(self, relpath, f):
90
"""Copy the file-like or string object into the location.
92
:param relpath: Location to put the contents, relative to base.
93
:param f: File-like or string object.
95
from bzrlib.atomicfile import AtomicFile
98
path = self.abspath(relpath)
99
fp = AtomicFile(path, 'wb')
101
if e.errno == errno.ENOENT:
102
raise NoSuchFile('File %r does not exist' % path, orig_error=e)
103
raise LocalTransportError(orig_error=e)
298
110
def iter_files_recursive(self):
299
111
"""Iter the relative paths of files in the transports sub-tree."""
300
queue = list(self.list_dir(u'.'))
112
queue = list(self.list_dir('.'))
302
114
relpath = queue.pop(0)
303
115
st = self.stat(relpath)
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):
122
def mkdir(self, relpath):
327
123
"""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
abspath = self._abspath(relpath)
333
handle = osutils.open_file(abspath, 'wb')
336
self._check_mode_and_size(abspath, handle.fileno(), mode)
337
transport._file_streams[self.abspath(relpath)] = handle
338
return transport.FileFileStream(self, relpath, handle)
340
def _get_append_file(self, relpath, mode=None):
341
"""Call os.open() for the given relpath"""
342
file_abspath = self._abspath(relpath)
344
# os.open() will automatically use the umask
349
return file_abspath, os.open(file_abspath, _append_flags, local_mode)
350
except (IOError, OSError),e:
351
self._translate_error(e, relpath)
353
def _check_mode_and_size(self, file_abspath, fd, mode=None):
354
"""Check the mode of the file, and return the current size"""
356
if mode is not None and mode != S_IMODE(st.st_mode):
357
# Because of umask, we may still need to chmod the file.
358
# But in the general case, we won't have to
359
os.chmod(file_abspath, mode)
362
def append_file(self, relpath, f, mode=None):
363
"""Append the text in the file-like object into the final location."""
364
file_abspath, fd = self._get_append_file(relpath, mode=mode)
366
result = self._check_mode_and_size(file_abspath, fd, mode=mode)
367
self._pump_to_fd(f, fd)
372
def append_bytes(self, relpath, bytes, mode=None):
373
"""Append the text in the string into the final location."""
374
file_abspath, fd = self._get_append_file(relpath, mode=mode)
376
result = self._check_mode_and_size(file_abspath, fd, mode=mode)
383
def _pump_to_fd(self, fromfile, to_fd):
384
"""Copy contents of one file to another."""
387
b = fromfile.read(BUFSIZE)
125
os.mkdir(self.abspath(relpath))
127
if e.errno == errno.EEXIST:
128
raise FileExists(orig_error=e)
129
elif e.errno == errno.ENOENT:
130
raise NoSuchFile(orig_error=e)
131
raise LocalTransportError(orig_error=e)
133
def append(self, relpath, f):
134
"""Append the text in the file-like object into the final
137
fp = open(self.abspath(relpath), 'ab')
392
140
def copy(self, rel_from, rel_to):
393
141
"""Copy the item at rel_from to the location at rel_to"""
394
path_from = self._abspath(rel_from)
395
path_to = self._abspath(rel_to)
143
path_from = self.abspath(rel_from)
144
path_to = self.abspath(rel_to)
397
146
shutil.copy(path_from, path_to)
398
except (IOError, OSError),e:
399
# TODO: What about path_to?
400
self._translate_error(e, path_from)
402
def rename(self, rel_from, rel_to):
403
path_from = self._abspath(rel_from)
404
path_to = self._abspath(rel_to)
406
# *don't* call bzrlib.osutils.rename, because we want to
407
# detect conflicting names on rename, and osutils.rename tries to
408
# mask cross-platform differences there
409
os.rename(path_from, path_to)
410
except (IOError, OSError),e:
411
# TODO: What about path_to?
412
self._translate_error(e, path_from)
148
raise LocalTransportError(orig_error=e)
414
150
def move(self, rel_from, rel_to):
415
151
"""Move the item at rel_from to the location at rel_to"""
416
path_from = self._abspath(rel_from)
417
path_to = self._abspath(rel_to)
152
path_from = self.abspath(rel_from)
153
path_to = self.abspath(rel_to)
420
# this version will delete the destination if necessary
421
osutils.rename(path_from, path_to)
422
except (IOError, OSError),e:
423
# TODO: What about path_to?
424
self._translate_error(e, path_from)
156
os.rename(path_from, path_to)
158
raise LocalTransportError(orig_error=e)
426
160
def delete(self, relpath):
427
161
"""Delete the item at relpath"""
430
path = self._abspath(relpath)
432
except (IOError, OSError),e:
433
self._translate_error(e, path)
435
def external_url(self):
436
"""See bzrlib.transport.Transport.external_url."""
437
# File URL's are externally usable.
440
def copy_to(self, relpaths, other, mode=None, pb=None):
163
os.remove(self.abspath(relpath))
165
raise LocalTransportError(orig_error=e)
167
def copy_to(self, relpaths, other, pb=None):
441
168
"""Copy a set of entries from self into another Transport.
443
170
:param relpaths: A list/generator of entries to be copied.
508
221
:return: A lock object, which should be passed to Transport.unlock()
510
223
from bzrlib.lock import WriteLock
511
return WriteLock(self._abspath(relpath))
513
def rmdir(self, relpath):
514
"""See Transport.rmdir."""
517
path = self._abspath(relpath)
519
except (IOError, OSError),e:
520
self._translate_error(e, path)
522
if osutils.host_os_dereferences_symlinks():
523
def readlink(self, relpath):
524
"""See Transport.readlink."""
525
return osutils.readlink(self._abspath(relpath))
527
if osutils.hardlinks_good():
528
def hardlink(self, source, link_name):
529
"""See Transport.link."""
531
os.link(self._abspath(source), self._abspath(link_name))
532
except (IOError, OSError), e:
533
self._translate_error(e, source)
535
if osutils.has_symlinks():
536
def symlink(self, source, link_name):
537
"""See Transport.symlink."""
538
abs_link_dirpath = urlutils.dirname(self.abspath(link_name))
539
source_rel = urlutils.file_relpath(
540
urlutils.strip_trailing_slash(abs_link_dirpath),
541
urlutils.strip_trailing_slash(self.abspath(source))
545
os.symlink(source_rel, self._abspath(link_name))
546
except (IOError, OSError), e:
547
self._translate_error(e, source_rel)
549
def _can_roundtrip_unix_modebits(self):
550
if sys.platform == 'win32':
557
class EmulatedWin32LocalTransport(LocalTransport):
558
"""Special transport for testing Win32 [UNC] paths on non-windows"""
560
def __init__(self, base):
563
super(LocalTransport, self).__init__(base)
564
self._local_base = urlutils._win32_local_path_from_url(base)
566
def abspath(self, relpath):
567
path = osutils.normpath(osutils.pathjoin(
568
self._local_base, urlutils.unescape(relpath)))
569
return urlutils._win32_local_path_to_url(path)
571
def clone(self, offset=None):
572
"""Return a new LocalTransport with root at self.base + offset
573
Because the local filesystem does not require a connection,
574
we can just return a new object.
577
return EmulatedWin32LocalTransport(self.base)
579
abspath = self.abspath(offset)
580
if abspath == 'file://':
581
# fix upwalk for UNC path
582
# when clone from //HOST/path updir recursively
583
# we should stop at least at //HOST part
585
return EmulatedWin32LocalTransport(abspath)
588
def get_test_permutations():
589
"""Return the permutations to be used in testing."""
590
from bzrlib.tests import test_server
591
return [(LocalTransport, test_server.LocalURLServer),]
224
return WriteLock(self.abspath(relpath))
227
class ScratchTransport(LocalTransport):
228
"""A transport that works in a temporary dir and cleans up after itself.
230
The dir only exists for the lifetime of the Python object.
231
Obviously you should not put anything precious in it.
234
def __init__(self, base=None):
236
base = tempfile.mkdtemp()
237
super(ScratchTransport, self).__init__(base)
240
shutil.rmtree(self.base, ignore_errors=True)
241
mutter("%r destroyed" % self)
243
# If nothing else matches, try the LocalTransport
244
register_transport(None, LocalTransport)
245
register_transport('file://', LocalTransport)
added
removed
bzrlib/transport/local.py
