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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
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
This is a fairly thin wrapper on regular file IO.
19
This is a fairly thin wrapper on regular file IO."""
23
from stat import ST_MODE, S_ISDIR, ST_SIZE, S_IMODE
26
from bzrlib.lazy_import import lazy_import
27
lazy_import(globals(), """
23
from stat import ST_MODE, S_ISDIR, ST_SIZE
38
27
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):
28
from bzrlib.transport import Transport, Server
29
from bzrlib.osutils import abspath, realpath, normpath, pathjoin, rename
32
class LocalTransport(Transport):
50
33
"""This is the transport agent for local filesystem access."""
52
35
def __init__(self, base):
53
36
"""Set the base path where files will be stored."""
54
if not base.startswith('file://'):
55
symbol_versioning.warn(
56
"Instantiating LocalTransport with a filesystem path"
57
" is deprecated as of bzr 0.8."
58
" Please use bzrlib.transport.get_transport()"
59
" or pass in a file:// url.",
63
base = urlutils.local_path_to_url(base)
37
if base.startswith('file://'):
39
# realpath is incompatible with symlinks. When we traverse
40
# up we might be able to normpath stuff. RBC 20051003
41
base = normpath(abspath(base))
64
42
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
44
super(LocalTransport, self).__init__(base)
76
self._local_base = urlutils.local_path_from_url(base)
46
def should_cache(self):
78
49
def clone(self, offset=None):
79
50
"""Return a new LocalTransport with root at self.base + offset
80
Because the local filesystem does not require a connection,
51
Because the local filesystem does not require a connection,
81
52
we can just return a new object.
84
55
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)
94
def _abspath(self, relative_reference):
95
"""Return a path for use in os calls.
97
Several assumptions are made:
98
- relative_reference does not contain '..'
99
- relative_reference is url escaped.
101
if relative_reference in ('.', ''):
102
return self._local_base
103
return self._local_base + urlutils.unescape(relative_reference)
57
return LocalTransport(self.abspath(offset))
105
59
def abspath(self, relpath):
106
"""Return the full url to the given relative URL."""
107
# TODO: url escape the result. RBC 20060523.
108
# jam 20060426 Using normpath on the real path, because that ensures
109
# 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]
122
return urlutils.local_path_to_url(path)
124
def local_abspath(self, relpath):
125
"""Transform the given relative path URL into the actual path on disk
127
This function only exists for the LocalTransport, since it is
128
the only one that has direct local access.
129
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.
133
This function is quite expensive: it calls realpath which resolves
60
"""Return the full url to the given relative URL.
61
This can be supplied with a string or a list
136
absurl = self.abspath(relpath)
137
# mutter(u'relpath %s => base: %s, absurl %s', relpath, self.base, absurl)
138
return urlutils.local_path_from_url(absurl)
63
assert isinstance(relpath, basestring), (type(relpath), relpath)
64
return pathjoin(self.base, urllib.unquote(relpath))
140
66
def relpath(self, abspath):
141
67
"""Return the local path portion from a given absolute path.
69
from bzrlib.osutils import relpath
143
70
if abspath is None:
146
return urlutils.file_relpath(
147
urlutils.strip_trailing_slash(self.base),
148
urlutils.strip_trailing_slash(abspath))
72
if abspath.endswith('/'):
73
abspath = abspath[:-1]
74
return relpath(self.base[:-1], abspath)
150
76
def has(self, relpath):
151
return os.access(self._abspath(relpath), os.F_OK)
77
return os.access(self.abspath(relpath), os.F_OK)
153
79
def get(self, relpath):
154
80
"""Get the file at the given relative path.
156
82
: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,
85
path = self.abspath(relpath)
86
return open(path, 'rb')
87
except (IOError, OSError),e:
88
self._translate_error(e, path)
90
def put(self, relpath, f, mode=None):
91
"""Copy the file-like or string object into the location.
93
:param relpath: Location to put the contents, relative to base.
94
:param f: File-like or string object.
96
from bzrlib.atomicfile import AtomicFile
100
path = self.abspath(relpath)
101
fp = AtomicFile(path, 'wb', new_mode=mode)
102
except (IOError, OSError),e:
103
self._translate_error(e, path)
295
110
def iter_files_recursive(self):
296
111
"""Iter the relative paths of files in the transports sub-tree."""
297
112
queue = list(self.list_dir(u'.'))
299
relpath = queue.pop(0)
114
relpath = urllib.quote(queue.pop(0))
300
115
st = self.stat(relpath)
301
116
if S_ISDIR(st[ST_MODE]):
302
117
for i, basename in enumerate(self.list_dir(relpath)):
307
def _mkdir(self, abspath, mode=None):
308
"""Create a real directory, filtering through mode"""
310
# os.mkdir() will filter through umask
315
os.mkdir(abspath, local_mode)
317
# It is probably faster to just do the chmod, rather than
318
# doing a stat, and then trying to compare
319
os.chmod(abspath, mode)
320
except (IOError, OSError),e:
321
self._translate_error(e, abspath)
323
122
def mkdir(self, relpath, mode=None):
324
123
"""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)
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
def _get_append_file(self, relpath, mode=None):
339
"""Call os.open() for the given relpath"""
340
file_abspath = self._abspath(relpath)
342
# os.open() will automatically use the umask
347
return file_abspath, os.open(file_abspath, _append_flags, local_mode)
126
path = self.abspath(relpath)
130
except (IOError, OSError),e:
131
self._translate_error(e, path)
133
def append(self, relpath, f):
134
"""Append the text in the file-like object into the final
138
fp = open(self.abspath(relpath), 'ab')
348
139
except (IOError, OSError),e:
349
140
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)
365
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
def _pump_to_fd(self, fromfile, to_fd):
382
"""Copy contents of one file to another."""
385
b = fromfile.read(BUFSIZE)
390
143
def copy(self, rel_from, rel_to):
391
144
"""Copy the item at rel_from to the location at rel_to"""
392
path_from = self._abspath(rel_from)
393
path_to = self._abspath(rel_to)
146
path_from = self.abspath(rel_from)
147
path_to = self.abspath(rel_to)
395
149
shutil.copy(path_from, path_to)
396
150
except (IOError, OSError),e:
509
256
:return: A lock object, which should be passed to Transport.unlock()
511
258
from bzrlib.lock import WriteLock
512
return WriteLock(self._abspath(relpath))
259
return WriteLock(self.abspath(relpath))
514
261
def rmdir(self, relpath):
515
262
"""See Transport.rmdir."""
518
path = self._abspath(relpath)
265
path = self.abspath(relpath)
520
267
except (IOError, OSError),e:
521
268
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
def _can_roundtrip_unix_modebits(self):
551
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)
270
class ScratchTransport(LocalTransport):
271
"""A transport that works in a temporary dir and cleans up after itself.
273
The dir only exists for the lifetime of the Python object.
274
Obviously you should not put anything precious in it.
277
def __init__(self, base=None):
279
base = tempfile.mkdtemp()
280
super(ScratchTransport, self).__init__(base)
283
shutil.rmtree(self.base, ignore_errors=True)
284
mutter("%r destroyed" % self)
287
class LocalRelpathServer(Server):
288
"""A pretend server for local transports, using relpaths."""
291
"""See Transport.Server.get_url."""
295
class LocalAbspathServer(Server):
296
"""A pretend server for local transports, using absolute paths."""
299
"""See Transport.Server.get_url."""
300
return os.path.abspath("")
303
class LocalURLServer(Server):
304
"""A pretend server for local transports, using file:// urls."""
307
"""See Transport.Server.get_url."""
308
# FIXME: \ to / on windows
309
return "file://%s" % os.path.abspath("")
589
312
def get_test_permutations():
590
313
"""Return the permutations to be used in testing."""
591
from bzrlib.tests import test_server
592
return [(LocalTransport, test_server.LocalURLServer),]
314
return [(LocalTransport, LocalRelpathServer),
315
(LocalTransport, LocalAbspathServer),
316
(LocalTransport, LocalURLServer),
added
removed
bzrlib/transport/local.py
