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
38
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):
41
from bzrlib.transport import Transport, Server
44
_append_flags = os.O_CREAT | os.O_APPEND | os.O_WRONLY | osutils.O_BINARY
45
_put_non_atomic_flags = os.O_CREAT | os.O_TRUNC | os.O_WRONLY | osutils.O_BINARY
48
class LocalTransport(Transport):
50
49
"""This is the transport agent for local filesystem access."""
52
51
def __init__(self, base):
63
62
base = urlutils.local_path_to_url(base)
64
63
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
65
super(LocalTransport, self).__init__(base)
76
66
self._local_base = urlutils.local_path_from_url(base)
68
def should_cache(self):
78
71
def clone(self, offset=None):
79
72
"""Return a new LocalTransport with root at self.base + offset
80
Because the local filesystem does not require a connection,
73
Because the local filesystem does not require a connection,
81
74
we can just return a new object.
105
98
def abspath(self, relpath):
106
99
"""Return the full url to the given relative URL."""
107
100
# TODO: url escape the result. RBC 20060523.
101
assert isinstance(relpath, basestring), (type(relpath), relpath)
108
102
# jam 20060426 Using normpath on the real path, because that ensures
109
103
# proper handling of stuff like
110
104
path = osutils.normpath(osutils.pathjoin(
111
105
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
106
return urlutils.local_path_to_url(path)
124
108
def local_abspath(self, relpath):
127
111
This function only exists for the LocalTransport, since it is
128
112
the only one that has direct local access.
129
113
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.
114
the local working directory.
133
116
This function is quite expensive: it calls realpath which resolves
146
129
return urlutils.file_relpath(
147
urlutils.strip_trailing_slash(self.base),
130
urlutils.strip_trailing_slash(self.base),
148
131
urlutils.strip_trailing_slash(abspath))
150
133
def has(self, relpath):
156
139
: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
142
path = self._abspath(relpath)
163
return osutils.open_file(path, 'rb')
143
return open(path, 'rb')
164
144
except (IOError, OSError),e:
165
145
if e.errno == errno.EISDIR:
166
146
return LateReadError(relpath)
172
152
:param relpath: Location to put the contents, relative to base.
173
153
:param f: File-like object.
174
:param mode: The mode for the newly created file,
154
:param mode: The mode for the newly created file,
175
155
None means just use the default
183
163
except (IOError, OSError),e:
184
164
self._translate_error(e, path)
186
length = self._pump(f, fp)
192
171
def put_bytes(self, relpath, bytes, mode=None):
193
172
"""Copy the string into the location.
286
264
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
287
265
create_parent_dir=False, dir_mode=None):
291
268
self._put_non_atomic_helper(relpath, writer, mode=mode,
292
269
create_parent_dir=create_parent_dir,
293
270
dir_mode=dir_mode)
324
301
"""Create a directory at the given path."""
325
302
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
304
def _get_append_file(self, relpath, mode=None):
339
305
"""Call os.open() for the given relpath"""
340
306
file_abspath = self._abspath(relpath)
400
365
def rename(self, rel_from, rel_to):
401
366
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)
368
# *don't* call bzrlib.osutils.rename, because we want to
369
# detect errors on rename
370
os.rename(path_from, self._abspath(rel_to))
409
371
except (IOError, OSError),e:
410
372
# TODO: What about path_to?
411
self._translate_error(
412
osutils._add_rename_error_details(e, path_from, path_to),
373
self._translate_error(e, path_from)
415
375
def move(self, rel_from, rel_to):
416
376
"""Move the item at rel_from to the location at rel_to"""
433
393
except (IOError, OSError),e:
434
394
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
396
def copy_to(self, relpaths, other, mode=None, pb=None):
442
397
"""Copy a set of entries from self into another Transport.
520
475
except (IOError, OSError),e:
521
476
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
478
def _can_roundtrip_unix_modebits(self):
551
479
if sys.platform == 'win32':
565
493
self._local_base = urlutils._win32_local_path_from_url(base)
567
495
def abspath(self, relpath):
496
assert isinstance(relpath, basestring), (type(relpath), relpath)
568
497
path = osutils.normpath(osutils.pathjoin(
569
498
self._local_base, urlutils.unescape(relpath)))
570
499
return urlutils._win32_local_path_to_url(path)
572
501
def clone(self, offset=None):
573
502
"""Return a new LocalTransport with root at self.base + offset
574
Because the local filesystem does not require a connection,
503
Because the local filesystem does not require a connection,
575
504
we can just return a new object.
577
506
if offset is None:
586
515
return EmulatedWin32LocalTransport(abspath)
518
class LocalURLServer(Server):
519
"""A pretend server for local transports, using file:// urls.
521
Of course no actual server is required to access the local filesystem, so
522
this just exists to tell the test code how to get to it.
526
"""Setup the server to service requests.
528
:param decorated_transport: ignored by this implementation.
532
"""See Transport.Server.get_url."""
533
return urlutils.local_path_to_url('')
589
536
def get_test_permutations():
590
537
"""Return the permutations to be used in testing."""
591
from bzrlib.tests import test_server
592
return [(LocalTransport, test_server.LocalURLServer),]
539
(LocalTransport, LocalURLServer),
added
removed
bzrlib/transport/local.py
