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):
25
from stat import ST_MODE, S_ISDIR, ST_SIZE
28
from bzrlib.osutils import (abspath, realpath, normpath, pathjoin, rename,
29
check_legal_path, rmtree)
30
from bzrlib.symbol_versioning import warn
31
from bzrlib.trace import mutter
32
from bzrlib.transport import Transport, Server
33
import bzrlib.urlutils as urlutils
36
class LocalTransport(Transport):
48
37
"""This is the transport agent for local filesystem access."""
50
39
def __init__(self, base):
51
40
"""Set the base path where files will be stored."""
52
41
if not base.startswith('file://'):
53
symbol_versioning.warn(
54
"Instantiating LocalTransport with a filesystem path"
42
warn("Instantiating LocalTransport with a filesystem path"
55
43
" is deprecated as of bzr 0.8."
56
44
" Please use bzrlib.transport.get_transport()"
57
45
" or pass in a file:// url.",
61
49
base = urlutils.local_path_to_url(base)
62
50
if base[-1] != '/':
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
52
super(LocalTransport, self).__init__(base)
74
53
self._local_base = urlutils.local_path_from_url(base)
54
## mutter("_local_base: %r => %r", base, self._local_base)
56
def should_cache(self):
76
59
def clone(self, offset=None):
77
60
"""Return a new LocalTransport with root at self.base + offset
78
Because the local filesystem does not require a connection,
61
Because the local filesystem does not require a connection,
79
62
we can just return a new object.
82
65
return LocalTransport(self.base)
84
abspath = self.abspath(offset)
85
if abspath == 'file://':
86
# fix upwalk for UNC path
87
# when clone from //HOST/path updir recursively
88
# we should stop at least at //HOST part
90
return LocalTransport(abspath)
67
return LocalTransport(self.abspath(offset))
92
69
def _abspath(self, relative_reference):
93
70
"""Return a path for use in os calls.
97
74
- relative_reference is url escaped.
99
76
if relative_reference in ('.', ''):
100
# _local_base normally has a trailing slash; strip it so that stat
101
# on a transport pointing to a symlink reads the link not the
102
# referent but be careful of / and c:\
103
return osutils.split(self._local_base)[0]
77
return self._local_base
104
78
return self._local_base + urlutils.unescape(relative_reference)
106
80
def abspath(self, relpath):
107
81
"""Return the full url to the given relative URL."""
108
82
# TODO: url escape the result. RBC 20060523.
83
assert isinstance(relpath, basestring), (type(relpath), relpath)
109
84
# jam 20060426 Using normpath on the real path, because that ensures
110
85
# proper handling of stuff like
111
path = osutils.normpath(osutils.pathjoin(
112
self._local_base, urlutils.unescape(relpath)))
113
# on windows, our _local_base may or may not have a drive specified
114
# (ie, it may be "/" or "c:/foo").
115
# If 'relpath' is '/' we *always* get back an abspath without
116
# the drive letter - but if our transport already has a drive letter,
117
# we want our abspaths to have a drive letter too - so handle that
119
if (sys.platform == "win32" and self._local_base[1:2] == ":"
121
path = self._local_base[:3]
86
path = normpath(pathjoin(self._local_base, urlutils.unescape(relpath)))
123
87
return urlutils.local_path_to_url(path)
125
89
def local_abspath(self, relpath):
157
120
:param relpath: The relative path to the file
159
canonical_url = self.abspath(relpath)
160
if canonical_url in transport._file_streams:
161
transport._file_streams[canonical_url].flush()
163
path = self._abspath(relpath)
164
return osutils.open_file(path, 'rb')
165
except (IOError, OSError),e:
166
if e.errno == errno.EISDIR:
167
return LateReadError(relpath)
168
self._translate_error(e, path)
170
def put_file(self, relpath, f, mode=None):
171
"""Copy the file-like object into the location.
173
:param relpath: Location to put the contents, relative to base.
174
:param f: File-like object.
175
:param mode: The mode for the newly created file,
176
None means just use the default
181
path = self._abspath(relpath)
182
osutils.check_legal_path(path)
183
fp = atomicfile.AtomicFile(path, 'wb', new_mode=mode)
184
except (IOError, OSError),e:
185
self._translate_error(e, path)
187
length = self._pump(f, fp)
193
def put_bytes(self, relpath, bytes, mode=None):
194
"""Copy the string into the location.
196
:param relpath: Location to put the contents, relative to base.
202
path = self._abspath(relpath)
203
osutils.check_legal_path(path)
204
fp = atomicfile.AtomicFile(path, 'wb', new_mode=mode)
205
except (IOError, OSError),e:
206
self._translate_error(e, path)
214
def _put_non_atomic_helper(self, relpath, writer,
216
create_parent_dir=False,
218
"""Common functionality information for the put_*_non_atomic.
220
This tracks all the create_parent_dir stuff.
222
:param relpath: the path we are putting to.
223
:param writer: A function that takes an os level file descriptor
224
and writes whatever data it needs to write there.
225
:param mode: The final file mode.
226
:param create_parent_dir: Should we be creating the parent directory
229
abspath = self._abspath(relpath)
231
# os.open() will automatically use the umask
236
fd = os.open(abspath, _put_non_atomic_flags, local_mode)
237
except (IOError, OSError),e:
238
# We couldn't create the file, maybe we need to create
239
# the parent directory, and try again
240
if (not create_parent_dir
241
or e.errno not in (errno.ENOENT,errno.ENOTDIR)):
242
self._translate_error(e, relpath)
243
parent_dir = os.path.dirname(abspath)
245
self._translate_error(e, relpath)
246
self._mkdir(parent_dir, mode=dir_mode)
247
# We created the parent directory, lets try to open the
250
fd = os.open(abspath, _put_non_atomic_flags, local_mode)
251
except (IOError, OSError), e:
252
self._translate_error(e, relpath)
255
if mode is not None and mode != S_IMODE(st.st_mode):
256
# Because of umask, we may still need to chmod the file.
257
# But in the general case, we won't have to
258
os.chmod(abspath, mode)
263
def put_file_non_atomic(self, relpath, f, mode=None,
264
create_parent_dir=False,
266
"""Copy the file-like object into the target location.
268
This function is not strictly safe to use. It is only meant to
269
be used when you already know that the target does not exist.
270
It is not safe, because it will open and truncate the remote
271
file. So there may be a time when the file has invalid contents.
273
:param relpath: The remote location to put the contents.
274
:param f: File-like object.
275
:param mode: Possible access permissions for new file.
276
None means do not set remote permissions.
277
:param create_parent_dir: If we cannot create the target file because
278
the parent directory does not exist, go ahead and
279
create it, and then try again.
282
self._pump_to_fd(f, fd)
283
self._put_non_atomic_helper(relpath, writer, mode=mode,
284
create_parent_dir=create_parent_dir,
287
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
288
create_parent_dir=False, dir_mode=None):
292
self._put_non_atomic_helper(relpath, writer, mode=mode,
293
create_parent_dir=create_parent_dir,
123
path = self._abspath(relpath)
124
return open(path, 'rb')
125
except (IOError, OSError),e:
126
self._translate_error(e, path)
128
def put(self, relpath, f, mode=None):
129
"""Copy the file-like or string object into the location.
131
:param relpath: Location to put the contents, relative to base.
132
:param f: File-like or string object.
134
from bzrlib.atomicfile import AtomicFile
138
path = self._abspath(relpath)
139
check_legal_path(path)
140
fp = AtomicFile(path, 'wb', new_mode=mode)
141
except (IOError, OSError),e:
142
self._translate_error(e, path)
296
149
def iter_files_recursive(self):
297
150
"""Iter the relative paths of files in the transports sub-tree."""
308
def _mkdir(self, abspath, mode=None):
309
"""Create a real directory, filtering through mode"""
311
# os.mkdir() will filter through umask
316
os.mkdir(abspath, local_mode)
318
# It is probably faster to just do the chmod, rather than
319
# doing a stat, and then trying to compare
320
os.chmod(abspath, mode)
321
except (IOError, OSError),e:
322
self._translate_error(e, abspath)
324
161
def mkdir(self, relpath, mode=None):
325
162
"""Create a directory at the given path."""
326
self._mkdir(self._abspath(relpath), mode=mode)
328
def open_write_stream(self, relpath, mode=None):
329
"""See Transport.open_write_stream."""
330
# initialise the file
331
self.put_bytes_non_atomic(relpath, "", mode=mode)
332
abspath = self._abspath(relpath)
333
handle = osutils.open_file(abspath, 'wb')
335
self._check_mode_and_size(abspath, handle.fileno(), mode)
336
transport._file_streams[self.abspath(relpath)] = handle
337
return transport.FileFileStream(self, relpath, handle)
339
def _get_append_file(self, relpath, mode=None):
340
"""Call os.open() for the given relpath"""
341
file_abspath = self._abspath(relpath)
343
# os.open() will automatically use the umask
348
return file_abspath, os.open(file_abspath, _append_flags, local_mode)
165
path = self._abspath(relpath)
349
169
except (IOError, OSError),e:
350
self._translate_error(e, relpath)
352
def _check_mode_and_size(self, file_abspath, fd, mode=None):
353
"""Check the mode of the file, and return the current size"""
355
if mode is not None and mode != S_IMODE(st.st_mode):
356
# Because of umask, we may still need to chmod the file.
357
# But in the general case, we won't have to
358
os.chmod(file_abspath, mode)
361
def append_file(self, relpath, f, mode=None):
170
self._translate_error(e, path)
172
def append(self, relpath, f, mode=None):
362
173
"""Append the text in the file-like object into the final location."""
363
file_abspath, fd = self._get_append_file(relpath, mode=mode)
365
result = self._check_mode_and_size(file_abspath, fd, mode=mode)
366
self._pump_to_fd(f, fd)
371
def append_bytes(self, relpath, bytes, mode=None):
372
"""Append the text in the string into the final location."""
373
file_abspath, fd = self._get_append_file(relpath, mode=mode)
375
result = self._check_mode_and_size(file_abspath, fd, mode=mode)
382
def _pump_to_fd(self, fromfile, to_fd):
383
"""Copy contents of one file to another."""
386
b = fromfile.read(BUFSIZE)
174
abspath = self._abspath(relpath)
178
fp = open(abspath, 'ab')
179
# FIXME should we really be chmodding every time ? RBC 20060523
181
os.chmod(abspath, mode)
182
except (IOError, OSError),e:
183
self._translate_error(e, relpath)
184
# win32 workaround (tell on an unwritten file returns 0)
391
193
def copy(self, rel_from, rel_to):
392
194
"""Copy the item at rel_from to the location at rel_to"""
518
312
except (IOError, OSError),e:
519
313
self._translate_error(e, path)
521
if osutils.host_os_dereferences_symlinks():
522
def readlink(self, relpath):
523
"""See Transport.readlink."""
524
return osutils.readlink(self._abspath(relpath))
526
if osutils.hardlinks_good():
527
def hardlink(self, source, link_name):
528
"""See Transport.link."""
530
os.link(self._abspath(source), self._abspath(link_name))
531
except (IOError, OSError), e:
532
self._translate_error(e, source)
534
if osutils.has_symlinks():
535
def symlink(self, source, link_name):
536
"""See Transport.symlink."""
537
abs_link_dirpath = urlutils.dirname(self.abspath(link_name))
538
source_rel = urlutils.file_relpath(
539
urlutils.strip_trailing_slash(abs_link_dirpath),
540
urlutils.strip_trailing_slash(self.abspath(source))
544
os.symlink(source_rel, self._abspath(link_name))
545
except (IOError, OSError), e:
546
self._translate_error(e, source_rel)
548
315
def _can_roundtrip_unix_modebits(self):
549
316
if sys.platform == 'win32':
556
class EmulatedWin32LocalTransport(LocalTransport):
557
"""Special transport for testing Win32 [UNC] paths on non-windows"""
559
def __init__(self, base):
562
super(LocalTransport, self).__init__(base)
563
self._local_base = urlutils._win32_local_path_from_url(base)
565
def abspath(self, relpath):
566
path = osutils.normpath(osutils.pathjoin(
567
self._local_base, urlutils.unescape(relpath)))
568
return urlutils._win32_local_path_to_url(path)
570
def clone(self, offset=None):
571
"""Return a new LocalTransport with root at self.base + offset
572
Because the local filesystem does not require a connection,
573
we can just return a new object.
576
return EmulatedWin32LocalTransport(self.base)
578
abspath = self.abspath(offset)
579
if abspath == 'file://':
580
# fix upwalk for UNC path
581
# when clone from //HOST/path updir recursively
582
# we should stop at least at //HOST part
584
return EmulatedWin32LocalTransport(abspath)
323
class LocalRelpathServer(Server):
324
"""A pretend server for local transports, using relpaths."""
327
"""See Transport.Server.get_url."""
331
class LocalAbspathServer(Server):
332
"""A pretend server for local transports, using absolute paths."""
335
"""See Transport.Server.get_url."""
336
return os.path.abspath("")
339
class LocalURLServer(Server):
340
"""A pretend server for local transports, using file:// urls."""
343
"""See Transport.Server.get_url."""
344
return urlutils.local_path_to_url('')
587
347
def get_test_permutations():
588
348
"""Return the permutations to be used in testing."""
589
from bzrlib.tests import test_server
590
return [(LocalTransport, test_server.LocalURLServer),]
349
return [(LocalTransport, LocalRelpathServer),
350
(LocalTransport, LocalAbspathServer),
351
(LocalTransport, LocalURLServer),
added
removed
bzrlib/transport/local.py
