1
# Copyright (C) 2005-2010 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.
38
37
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):
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):
63
61
base = urlutils.local_path_to_url(base)
64
62
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
64
super(LocalTransport, self).__init__(base)
76
65
self._local_base = urlutils.local_path_from_url(base)
67
def should_cache(self):
78
70
def clone(self, offset=None):
79
71
"""Return a new LocalTransport with root at self.base + offset
80
Because the local filesystem does not require a connection,
72
Because the local filesystem does not require a connection,
81
73
we can just return a new object.
84
76
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)
78
return LocalTransport(self.abspath(offset))
94
80
def _abspath(self, relative_reference):
95
81
"""Return a path for use in os calls.
105
91
def abspath(self, relpath):
106
92
"""Return the full url to the given relative URL."""
107
93
# TODO: url escape the result. RBC 20060523.
94
assert isinstance(relpath, basestring), (type(relpath), relpath)
108
95
# jam 20060426 Using normpath on the real path, because that ensures
109
96
# proper handling of stuff like
110
97
path = osutils.normpath(osutils.pathjoin(
111
98
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]
122
99
return urlutils.local_path_to_url(path)
124
101
def local_abspath(self, relpath):
127
104
This function only exists for the LocalTransport, since it is
128
105
the only one that has direct local access.
129
106
This is mostly for stuff like WorkingTree which needs to know
130
the local working directory. The returned path will always contain
131
forward slashes as the path separator, regardless of the platform.
107
the local working directory.
133
109
This function is quite expensive: it calls realpath which resolves
146
122
return urlutils.file_relpath(
147
urlutils.strip_trailing_slash(self.base),
123
urlutils.strip_trailing_slash(self.base),
148
124
urlutils.strip_trailing_slash(abspath))
150
126
def has(self, relpath):
156
132
: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
135
path = self._abspath(relpath)
163
return osutils.open_file(path, 'rb')
136
return open(path, 'rb')
164
137
except (IOError, OSError),e:
165
if e.errno == errno.EISDIR:
166
return LateReadError(relpath)
167
138
self._translate_error(e, path)
169
140
def put_file(self, relpath, f, mode=None):
172
143
:param relpath: Location to put the contents, relative to base.
173
144
:param f: File-like object.
174
:param mode: The mode for the newly created file,
145
:param mode: The mode for the newly created file,
175
146
None means just use the default
183
154
except (IOError, OSError),e:
184
155
self._translate_error(e, path)
186
length = self._pump(f, fp)
192
162
def put_bytes(self, relpath, bytes, mode=None):
193
163
"""Copy the string into the location.
286
255
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
287
256
create_parent_dir=False, dir_mode=None):
291
259
self._put_non_atomic_helper(relpath, writer, mode=mode,
292
260
create_parent_dir=create_parent_dir,
293
261
dir_mode=dir_mode)
324
292
"""Create a directory at the given path."""
325
293
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)
331
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
295
def _get_append_file(self, relpath, mode=None):
339
296
"""Call os.open() for the given relpath"""
340
297
file_abspath = self._abspath(relpath)
400
356
def rename(self, rel_from, rel_to):
401
357
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)
359
# *don't* call bzrlib.osutils.rename, because we want to
360
# detect errors on rename
361
os.rename(path_from, self._abspath(rel_to))
409
362
except (IOError, OSError),e:
410
363
# TODO: What about path_to?
411
self._translate_error(
412
osutils._add_rename_error_details(e, path_from, path_to),
364
self._translate_error(e, path_from)
415
366
def move(self, rel_from, rel_to):
416
367
"""Move the item at rel_from to the location at rel_to"""
433
384
except (IOError, OSError),e:
434
385
self._translate_error(e, path)
436
def external_url(self):
437
"""See bzrlib.transport.Transport.external_url."""
438
# File URL's are externally usable.
441
387
def copy_to(self, relpaths, other, mode=None, pb=None):
442
388
"""Copy a set of entries from self into another Transport.
520
466
except (IOError, OSError),e:
521
467
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
469
def _can_roundtrip_unix_modebits(self):
551
470
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)
477
class LocalURLServer(Server):
478
"""A pretend server for local transports, using file:// urls.
480
Of course no actual server is required to access the local filesystem, so
481
this just exists to tell the test code how to get to it.
485
"""See Transport.Server.get_url."""
486
return urlutils.local_path_to_url('')
589
489
def get_test_permutations():
590
490
"""Return the permutations to be used in testing."""
591
from bzrlib.tests import test_server
592
return [(LocalTransport, test_server.LocalURLServer),]
492
(LocalTransport, LocalURLServer),
added
removed
bzrlib/transport/local.py
