23
25
from stat import ST_MODE, S_ISDIR, ST_SIZE, S_IMODE
26
from bzrlib.lazy_import import lazy_import
27
lazy_import(globals(), """
31
28
from bzrlib import (
32
from bzrlib.osutils import (abspath, realpath, normpath, pathjoin, rename,
33
check_legal_path, rmtree)
34
from bzrlib.symbol_versioning import warn
38
35
from bzrlib.trace import mutter
39
from bzrlib.transport import LateReadError
42
from bzrlib import transport
45
_append_flags = os.O_CREAT | os.O_APPEND | os.O_WRONLY | osutils.O_BINARY | osutils.O_NOINHERIT
46
_put_non_atomic_flags = os.O_CREAT | os.O_TRUNC | os.O_WRONLY | osutils.O_BINARY | osutils.O_NOINHERIT
49
class LocalTransport(transport.Transport):
36
from bzrlib.transport import Transport, Server
39
_append_flags = os.O_CREAT | os.O_APPEND | os.O_WRONLY | osutils.O_BINARY
42
class LocalTransport(Transport):
50
43
"""This is the transport agent for local filesystem access."""
52
45
def __init__(self, base):
53
46
"""Set the base path where files will be stored."""
54
47
if not base.startswith('file://'):
55
symbol_versioning.warn(
56
"Instantiating LocalTransport with a filesystem path"
48
warn("Instantiating LocalTransport with a filesystem path"
57
49
" is deprecated as of bzr 0.8."
58
50
" Please use bzrlib.transport.get_transport()"
59
51
" or pass in a file:// url.",
63
55
base = urlutils.local_path_to_url(base)
64
56
if base[-1] != '/':
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
58
super(LocalTransport, self).__init__(base)
76
59
self._local_base = urlutils.local_path_from_url(base)
61
def should_cache(self):
78
64
def clone(self, offset=None):
79
65
"""Return a new LocalTransport with root at self.base + offset
80
Because the local filesystem does not require a connection,
66
Because the local filesystem does not require a connection,
81
67
we can just return a new object.
84
70
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)
72
return LocalTransport(self.abspath(offset))
94
74
def _abspath(self, relative_reference):
95
75
"""Return a path for use in os calls.
105
85
def abspath(self, relpath):
106
86
"""Return the full url to the given relative URL."""
107
87
# TODO: url escape the result. RBC 20060523.
88
assert isinstance(relpath, basestring), (type(relpath), relpath)
108
89
# jam 20060426 Using normpath on the real path, because that ensures
109
90
# 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]
91
path = normpath(pathjoin(self._local_base, urlutils.unescape(relpath)))
122
92
return urlutils.local_path_to_url(path)
124
94
def local_abspath(self, relpath):
156
125
: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 osutils.open_file(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)
213
def _put_non_atomic_helper(self, relpath, writer,
215
create_parent_dir=False,
217
"""Common functionality information for the put_*_non_atomic.
219
This tracks all the create_parent_dir stuff.
221
:param relpath: the path we are putting to.
222
:param writer: A function that takes an os level file descriptor
223
and writes whatever data it needs to write there.
224
:param mode: The final file mode.
225
:param create_parent_dir: Should we be creating the parent directory
228
abspath = self._abspath(relpath)
230
# os.open() will automatically use the umask
235
fd = os.open(abspath, _put_non_atomic_flags, local_mode)
236
except (IOError, OSError),e:
237
# We couldn't create the file, maybe we need to create
238
# the parent directory, and try again
239
if (not create_parent_dir
240
or e.errno not in (errno.ENOENT,errno.ENOTDIR)):
241
self._translate_error(e, relpath)
242
parent_dir = os.path.dirname(abspath)
244
self._translate_error(e, relpath)
245
self._mkdir(parent_dir, mode=dir_mode)
246
# We created the parent directory, lets try to open the
249
fd = os.open(abspath, _put_non_atomic_flags, local_mode)
250
except (IOError, OSError), e:
251
self._translate_error(e, relpath)
254
if mode is not None and mode != S_IMODE(st.st_mode):
255
# Because of umask, we may still need to chmod the file.
256
# But in the general case, we won't have to
257
os.chmod(abspath, mode)
262
def put_file_non_atomic(self, relpath, f, mode=None,
263
create_parent_dir=False,
265
"""Copy the file-like object into the target location.
267
This function is not strictly safe to use. It is only meant to
268
be used when you already know that the target does not exist.
269
It is not safe, because it will open and truncate the remote
270
file. So there may be a time when the file has invalid contents.
272
:param relpath: The remote location to put the contents.
273
:param f: File-like object.
274
:param mode: Possible access permissions for new file.
275
None means do not set remote permissions.
276
:param create_parent_dir: If we cannot create the target file because
277
the parent directory does not exist, go ahead and
278
create it, and then try again.
281
self._pump_to_fd(f, fd)
282
self._put_non_atomic_helper(relpath, writer, mode=mode,
283
create_parent_dir=create_parent_dir,
286
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
287
create_parent_dir=False, dir_mode=None):
291
self._put_non_atomic_helper(relpath, writer, mode=mode,
292
create_parent_dir=create_parent_dir,
128
path = self._abspath(relpath)
129
return open(path, 'rb')
130
except (IOError, OSError),e:
131
self._translate_error(e, path)
133
def put(self, relpath, f, mode=None):
134
"""Copy the file-like or string object into the location.
136
:param relpath: Location to put the contents, relative to base.
137
:param f: File-like or string object.
139
from bzrlib.atomicfile import AtomicFile
143
path = self._abspath(relpath)
144
check_legal_path(path)
145
fp = AtomicFile(path, 'wb', new_mode=mode)
146
except (IOError, OSError),e:
147
self._translate_error(e, path)
295
154
def iter_files_recursive(self):
296
155
"""Iter the relative paths of files in the transports sub-tree."""
307
def _mkdir(self, abspath, mode=None):
308
"""Create a real directory, filtering through mode"""
310
# os.mkdir() will filter through umask
166
def mkdir(self, relpath, mode=None):
167
"""Create a directory at the given path."""
315
os.mkdir(abspath, local_mode)
171
# os.mkdir() will filter through umask
175
path = self._abspath(relpath)
176
os.mkdir(path, local_mode)
316
177
if mode is not None:
317
178
# It is probably faster to just do the chmod, rather than
318
179
# doing a stat, and then trying to compare
319
os.chmod(abspath, mode)
320
181
except (IOError, OSError),e:
321
self._translate_error(e, abspath)
323
def mkdir(self, relpath, mode=None):
324
"""Create a directory at the given path."""
325
self._mkdir(self._abspath(relpath), mode=mode)
327
def open_write_stream(self, relpath, mode=None):
328
"""See Transport.open_write_stream."""
329
# initialise the file
330
self.put_bytes_non_atomic(relpath, "", mode=mode)
182
self._translate_error(e, path)
184
def append(self, relpath, f, mode=None):
185
"""Append the text in the file-like object into the final location."""
331
186
abspath = self._abspath(relpath)
332
handle = osutils.open_file(abspath, 'wb')
334
self._check_mode_and_size(abspath, handle.fileno(), mode)
335
transport._file_streams[self.abspath(relpath)] = handle
336
return transport.FileFileStream(self, relpath, handle)
338
def _get_append_file(self, relpath, mode=None):
339
"""Call os.open() for the given relpath"""
340
file_abspath = self._abspath(relpath)
342
188
# os.open() will automatically use the umask
343
189
local_mode = 0666
345
191
local_mode = mode
347
return file_abspath, os.open(file_abspath, _append_flags, local_mode)
193
fd = os.open(abspath, _append_flags, local_mode)
348
194
except (IOError, OSError),e:
349
195
self._translate_error(e, relpath)
351
def _check_mode_and_size(self, file_abspath, fd, mode=None):
352
"""Check the mode of the file, and return the current size"""
354
if mode is not None and mode != S_IMODE(st.st_mode):
355
# Because of umask, we may still need to chmod the file.
356
# But in the general case, we won't have to
357
os.chmod(file_abspath, mode)
360
def append_file(self, relpath, f, mode=None):
361
"""Append the text in the file-like object into the final location."""
362
file_abspath, fd = self._get_append_file(relpath, mode=mode)
364
result = self._check_mode_and_size(file_abspath, fd, mode=mode)
199
if mode is not None and mode != S_IMODE(st.st_mode):
200
# Because of umask, we may still need to chmod the file.
201
# But in the general case, we won't have to
202
os.chmod(abspath, mode)
365
203
self._pump_to_fd(f, fd)
370
def append_bytes(self, relpath, bytes, mode=None):
371
"""Append the text in the string into the final location."""
372
file_abspath, fd = self._get_append_file(relpath, mode=mode)
374
result = self._check_mode_and_size(file_abspath, fd, mode=mode)
381
208
def _pump_to_fd(self, fromfile, to_fd):
382
209
"""Copy contents of one file to another."""
400
227
def rename(self, rel_from, rel_to):
401
228
path_from = self._abspath(rel_from)
402
path_to = self._abspath(rel_to)
404
# *don't* call bzrlib.osutils.rename, because we want to
405
# detect conflicting names on rename, and osutils.rename tries to
406
# mask cross-platform differences there; however we do update the
407
# exception to include the filenames
408
os.rename(path_from, path_to)
230
# *don't* call bzrlib.osutils.rename, because we want to
231
# detect errors on rename
232
os.rename(path_from, self._abspath(rel_to))
409
233
except (IOError, OSError),e:
410
234
# TODO: What about path_to?
411
self._translate_error(
412
osutils._add_rename_error_details(e, path_from, path_to),
235
self._translate_error(e, path_from)
415
237
def move(self, rel_from, rel_to):
416
238
"""Move the item at rel_from to the location at rel_to"""
520
337
except (IOError, OSError),e:
521
338
self._translate_error(e, path)
523
if osutils.host_os_dereferences_symlinks():
524
def readlink(self, relpath):
525
"""See Transport.readlink."""
526
return osutils.readlink(self._abspath(relpath))
528
if osutils.hardlinks_good():
529
def hardlink(self, source, link_name):
530
"""See Transport.link."""
532
os.link(self._abspath(source), self._abspath(link_name))
533
except (IOError, OSError), e:
534
self._translate_error(e, source)
536
if osutils.has_symlinks():
537
def symlink(self, source, link_name):
538
"""See Transport.symlink."""
539
abs_link_dirpath = urlutils.dirname(self.abspath(link_name))
540
source_rel = urlutils.file_relpath(
541
urlutils.strip_trailing_slash(abs_link_dirpath),
542
urlutils.strip_trailing_slash(self.abspath(source))
546
os.symlink(source_rel, self._abspath(link_name))
547
except (IOError, OSError), e:
548
self._translate_error(e, source_rel)
550
340
def _can_roundtrip_unix_modebits(self):
551
341
if sys.platform == 'win32':
558
class EmulatedWin32LocalTransport(LocalTransport):
559
"""Special transport for testing Win32 [UNC] paths on non-windows"""
561
def __init__(self, base):
564
super(LocalTransport, self).__init__(base)
565
self._local_base = urlutils._win32_local_path_from_url(base)
567
def abspath(self, relpath):
568
path = osutils.normpath(osutils.pathjoin(
569
self._local_base, urlutils.unescape(relpath)))
570
return urlutils._win32_local_path_to_url(path)
572
def clone(self, offset=None):
573
"""Return a new LocalTransport with root at self.base + offset
574
Because the local filesystem does not require a connection,
575
we can just return a new object.
578
return EmulatedWin32LocalTransport(self.base)
580
abspath = self.abspath(offset)
581
if abspath == 'file://':
582
# fix upwalk for UNC path
583
# when clone from //HOST/path updir recursively
584
# we should stop at least at //HOST part
586
return EmulatedWin32LocalTransport(abspath)
348
class LocalRelpathServer(Server):
349
"""A pretend server for local transports, using relpaths."""
352
"""See Transport.Server.get_url."""
356
class LocalAbspathServer(Server):
357
"""A pretend server for local transports, using absolute paths."""
360
"""See Transport.Server.get_url."""
361
return os.path.abspath("")
364
class LocalURLServer(Server):
365
"""A pretend server for local transports, using file:// urls."""
368
"""See Transport.Server.get_url."""
369
return urlutils.local_path_to_url('')
589
372
def get_test_permutations():
590
373
"""Return the permutations to be used in testing."""
591
from bzrlib.tests import test_server
592
return [(LocalTransport, test_server.LocalURLServer),]
374
return [(LocalTransport, LocalRelpathServer),
375
(LocalTransport, LocalAbspathServer),
376
(LocalTransport, LocalURLServer),
added
removed
bzrlib/transport/local.py
