1
# Copyright (C) 2005-2012, 2016 Canonical Ltd
1
# Copyright (C) 2005, 2006 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
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""Transport for the local filesystem.
19
19
This is a fairly thin wrapper on regular file IO.
22
from __future__ import absolute_import
25
from stat import ST_MODE, S_ISDIR, S_IMODE
23
from stat import ST_MODE, S_ISDIR, ST_SIZE, S_IMODE
28
26
from bzrlib.lazy_import import lazy_import
39
from bzrlib.transport import LateReadError
37
from bzrlib.trace import mutter
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):
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
47
class LocalTransport(Transport):
50
48
"""This is the transport agent for local filesystem access."""
52
50
def __init__(self, base):
53
51
"""Set the base path where files will be stored."""
54
52
if not base.startswith('file://'):
55
raise AssertionError("not a file:// url: %r" % base)
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)
56
62
if base[-1] != '/':
59
# Special case : windows has no "root", but does have
60
# multiple lettered drives inside it. #240910
61
if sys.platform == 'win32' and base == 'file:///':
64
super(LocalTransport, self).__init__(base)
67
64
super(LocalTransport, self).__init__(base)
68
65
self._local_base = urlutils.local_path_from_url(base)
69
if self._local_base[-1] != '/':
70
self._local_base = self._local_base + '/'
67
def should_cache(self):
72
70
def clone(self, offset=None):
73
71
"""Return a new LocalTransport with root at self.base + offset
74
Because the local filesystem does not require a connection,
72
Because the local filesystem does not require a connection,
75
73
we can just return a new object.
93
91
- relative_reference is url escaped.
95
93
if relative_reference in ('.', ''):
96
# _local_base normally has a trailing slash; strip it so that stat
97
# on a transport pointing to a symlink reads the link not the
98
# referent but be careful of / and c:\
99
return osutils.split(self._local_base)[0]
94
return self._local_base
100
95
return self._local_base + urlutils.unescape(relative_reference)
102
97
def abspath(self, relpath):
103
98
"""Return the full url to the given relative URL."""
104
99
# TODO: url escape the result. RBC 20060523.
100
assert isinstance(relpath, basestring), (type(relpath), relpath)
105
101
# jam 20060426 Using normpath on the real path, because that ensures
106
102
# proper handling of stuff like
107
103
path = osutils.normpath(osutils.pathjoin(
108
104
self._local_base, urlutils.unescape(relpath)))
109
# on windows, our _local_base may or may not have a drive specified
110
# (ie, it may be "/" or "c:/foo").
111
# If 'relpath' is '/' we *always* get back an abspath without
112
# the drive letter - but if our transport already has a drive letter,
113
# we want our abspaths to have a drive letter too - so handle that
115
if (sys.platform == "win32" and self._local_base[1:2] == ":"
117
path = self._local_base[:3]
119
105
return urlutils.local_path_to_url(path)
121
107
def local_abspath(self, relpath):
124
110
This function only exists for the LocalTransport, since it is
125
111
the only one that has direct local access.
126
112
This is mostly for stuff like WorkingTree which needs to know
127
the local working directory. The returned path will always contain
128
forward slashes as the path separator, regardless of the platform.
113
the local working directory.
130
115
This function is quite expensive: it calls realpath which resolves
140
125
if abspath is None:
143
return urlutils.file_relpath(self.base, abspath)
128
return urlutils.file_relpath(
129
urlutils.strip_trailing_slash(self.base),
130
urlutils.strip_trailing_slash(abspath))
145
132
def has(self, relpath):
146
133
return os.access(self._abspath(relpath), os.F_OK)
151
138
:param relpath: The relative path to the file
153
canonical_url = self.abspath(relpath)
154
if canonical_url in transport._file_streams:
155
transport._file_streams[canonical_url].flush()
157
141
path = self._abspath(relpath)
158
return osutils.open_file(path, 'rb')
142
return open(path, 'rb')
159
143
except (IOError, OSError),e:
160
if e.errno == errno.EISDIR:
161
return LateReadError(relpath)
162
144
self._translate_error(e, path)
164
146
def put_file(self, relpath, f, mode=None):
167
149
:param relpath: Location to put the contents, relative to base.
168
150
:param f: File-like object.
169
:param mode: The mode for the newly created file,
151
:param mode: The mode for the newly created file,
170
152
None means just use the default
178
160
except (IOError, OSError),e:
179
161
self._translate_error(e, path)
181
length = self._pump(f, fp)
187
def put_bytes(self, relpath, raw_bytes, mode=None):
168
def put_bytes(self, relpath, bytes, mode=None):
188
169
"""Copy the string into the location.
190
171
:param relpath: Location to put the contents, relative to base.
191
:param raw_bytes: String
193
if not isinstance(raw_bytes, str):
195
'raw_bytes must be a plain string, not %s' % type(raw_bytes))
198
177
path = self._abspath(relpath)
251
229
if mode is not None and mode != S_IMODE(st.st_mode):
252
230
# Because of umask, we may still need to chmod the file.
253
231
# But in the general case, we won't have to
254
osutils.chmod_if_possible(abspath, mode)
232
os.chmod(abspath, mode)
283
261
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
284
262
create_parent_dir=False, dir_mode=None):
288
265
self._put_non_atomic_helper(relpath, writer, mode=mode,
289
266
create_parent_dir=create_parent_dir,
290
267
dir_mode=dir_mode)
310
287
local_mode = mode
312
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)
313
294
except (IOError, OSError),e:
314
295
self._translate_error(e, abspath)
317
osutils.chmod_if_possible(abspath, mode)
318
except (IOError, OSError), e:
319
self._translate_error(e, abspath)
321
297
def mkdir(self, relpath, mode=None):
322
298
"""Create a directory at the given path."""
323
299
self._mkdir(self._abspath(relpath), mode=mode)
325
def open_write_stream(self, relpath, mode=None):
326
"""See Transport.open_write_stream."""
327
abspath = self._abspath(relpath)
329
handle = osutils.open_file(abspath, 'wb')
330
except (IOError, OSError),e:
331
self._translate_error(e, abspath)
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
301
def _get_append_file(self, relpath, mode=None):
339
302
"""Call os.open() for the given relpath"""
340
303
file_abspath = self._abspath(relpath)
354
317
if mode is not None and mode != S_IMODE(st.st_mode):
355
318
# Because of umask, we may still need to chmod the file.
356
319
# But in the general case, we won't have to
357
osutils.chmod_if_possible(file_abspath, mode)
320
os.chmod(file_abspath, mode)
358
321
return st.st_size
360
323
def append_file(self, relpath, f, mode=None):
400
362
def rename(self, rel_from, rel_to):
401
363
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
407
os.rename(path_from, path_to)
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))
408
368
except (IOError, OSError),e:
409
369
# TODO: What about path_to?
410
370
self._translate_error(e, path_from)
430
390
except (IOError, OSError),e:
431
391
self._translate_error(e, path)
433
def external_url(self):
434
"""See bzrlib.transport.Transport.external_url."""
435
# File URL's are externally usable.
438
393
def copy_to(self, relpaths, other, mode=None, pb=None):
439
394
"""Copy a set of entries from self into another Transport.
453
408
otherpath = other._abspath(path)
454
409
shutil.copy(mypath, otherpath)
455
410
if mode is not None:
456
osutils.chmod_if_possible(otherpath, mode)
411
os.chmod(otherpath, mode)
457
412
except (IOError, OSError),e:
458
413
self._translate_error(e, path)
517
472
except (IOError, OSError),e:
518
473
self._translate_error(e, path)
520
if osutils.host_os_dereferences_symlinks():
521
def readlink(self, relpath):
522
"""See Transport.readlink."""
523
return osutils.readlink(self._abspath(relpath))
525
if osutils.hardlinks_good():
526
def hardlink(self, source, link_name):
527
"""See Transport.link."""
529
os.link(self._abspath(source), self._abspath(link_name))
530
except (IOError, OSError), e:
531
self._translate_error(e, source)
533
if osutils.has_symlinks():
534
def symlink(self, source, link_name):
535
"""See Transport.symlink."""
536
abs_link_dirpath = urlutils.dirname(self.abspath(link_name))
537
source_rel = urlutils.file_relpath(
538
abs_link_dirpath, self.abspath(source))
541
os.symlink(source_rel, self._abspath(link_name))
542
except (IOError, OSError), e:
543
self._translate_error(e, source_rel)
545
475
def _can_roundtrip_unix_modebits(self):
546
476
if sys.platform == 'win32':
560
490
self._local_base = urlutils._win32_local_path_from_url(base)
562
492
def abspath(self, relpath):
563
path = osutils._win32_normpath(osutils.pathjoin(
493
assert isinstance(relpath, basestring), (type(relpath), relpath)
494
path = osutils.normpath(osutils.pathjoin(
564
495
self._local_base, urlutils.unescape(relpath)))
565
496
return urlutils._win32_local_path_to_url(path)
567
498
def clone(self, offset=None):
568
499
"""Return a new LocalTransport with root at self.base + offset
569
Because the local filesystem does not require a connection,
500
Because the local filesystem does not require a connection,
570
501
we can just return a new object.
572
503
if offset is None:
581
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('')
584
527
def get_test_permutations():
585
528
"""Return the permutations to be used in testing."""
586
from bzrlib.tests import test_server
587
return [(LocalTransport, test_server.LocalURLServer),]
530
(LocalTransport, LocalURLServer),
added
removed
bzrlib/transport/local.py
