1
# Copyright (C) 2005, 2006 Canonical Ltd
1
# Copyright (C) 2005-2011 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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, S_IMODE
26
from bzrlib.lazy_import import lazy_import
27
lazy_import(globals(), """
24
from stat import ST_MODE, S_ISDIR, ST_SIZE
28
from bzrlib.trace import mutter
29
from bzrlib.transport import Transport, Server
30
from bzrlib.osutils import (abspath, realpath, normpath, pathjoin, rename,
34
class LocalTransport(Transport):
37
from bzrlib.transport import LateReadError
40
from bzrlib import transport
43
_append_flags = os.O_CREAT | os.O_APPEND | os.O_WRONLY | osutils.O_BINARY | osutils.O_NOINHERIT
44
_put_non_atomic_flags = os.O_CREAT | os.O_TRUNC | os.O_WRONLY | osutils.O_BINARY | osutils.O_NOINHERIT
47
class LocalTransport(transport.Transport):
35
48
"""This is the transport agent for local filesystem access."""
37
50
def __init__(self, base):
38
51
"""Set the base path where files will be stored."""
39
if base.startswith('file://'):
40
base = base[len('file://'):]
41
# realpath is incompatible with symlinks. When we traverse
42
# up we might be able to normpath stuff. RBC 20051003
43
base = normpath(abspath(base))
52
if not base.startswith('file://'):
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)
44
62
if base[-1] != '/':
65
# Special case : windows has no "root", but does have
66
# multiple lettered drives inside it. #240910
67
if sys.platform == 'win32' and base == 'file:///':
70
super(LocalTransport, self).__init__(base)
46
73
super(LocalTransport, self).__init__(base)
48
def should_cache(self):
74
self._local_base = urlutils.local_path_from_url(base)
51
76
def clone(self, offset=None):
52
77
"""Return a new LocalTransport with root at self.base + offset
53
Because the local filesystem does not require a connection,
78
Because the local filesystem does not require a connection,
54
79
we can just return a new object.
57
82
return LocalTransport(self.base)
59
return LocalTransport(self.abspath(offset))
84
abspath = self.abspath(offset)
85
if abspath == 'file://':
86
# fix upwalk for UNC path
87
# when clone from //HOST/path updir recursively
88
# we should stop at least at //HOST part
90
return LocalTransport(abspath)
92
def _abspath(self, relative_reference):
93
"""Return a path for use in os calls.
95
Several assumptions are made:
96
- relative_reference does not contain '..'
97
- relative_reference is url escaped.
99
if relative_reference in ('.', ''):
100
# _local_base normally has a trailing slash; strip it so that stat
101
# on a transport pointing to a symlink reads the link not the
102
# referent but be careful of / and c:\
103
return osutils.split(self._local_base)[0]
104
return self._local_base + urlutils.unescape(relative_reference)
61
106
def abspath(self, relpath):
62
107
"""Return the full url to the given relative URL."""
63
assert isinstance(relpath, basestring), (type(relpath), relpath)
64
result = normpath(pathjoin(self.base, urllib.unquote(relpath)))
65
#if result[-1] != '/':
108
# TODO: url escape the result. RBC 20060523.
109
# jam 20060426 Using normpath on the real path, because that ensures
110
# proper handling of stuff like
111
path = osutils.normpath(osutils.pathjoin(
112
self._local_base, urlutils.unescape(relpath)))
113
# on windows, our _local_base may or may not have a drive specified
114
# (ie, it may be "/" or "c:/foo").
115
# If 'relpath' is '/' we *always* get back an abspath without
116
# the drive letter - but if our transport already has a drive letter,
117
# we want our abspaths to have a drive letter too - so handle that
119
if (sys.platform == "win32" and self._local_base[1:2] == ":"
121
path = self._local_base[:3]
123
return urlutils.local_path_to_url(path)
125
def local_abspath(self, relpath):
126
"""Transform the given relative path URL into the actual path on disk
128
This function only exists for the LocalTransport, since it is
129
the only one that has direct local access.
130
This is mostly for stuff like WorkingTree which needs to know
131
the local working directory. The returned path will always contain
132
forward slashes as the path separator, regardless of the platform.
134
This function is quite expensive: it calls realpath which resolves
137
absurl = self.abspath(relpath)
138
# mutter(u'relpath %s => base: %s, absurl %s', relpath, self.base, absurl)
139
return urlutils.local_path_from_url(absurl)
69
141
def relpath(self, abspath):
70
142
"""Return the local path portion from a given absolute path.
72
from bzrlib.osutils import relpath, strip_trailing_slash
73
144
if abspath is None:
76
return relpath(strip_trailing_slash(self.base),
77
strip_trailing_slash(abspath))
147
return urlutils.file_relpath(
148
urlutils.strip_trailing_slash(self.base),
149
urlutils.strip_trailing_slash(abspath))
79
151
def has(self, relpath):
80
return os.access(self.abspath(relpath), os.F_OK)
152
return os.access(self._abspath(relpath), os.F_OK)
82
154
def get(self, relpath):
83
155
"""Get the file at the given relative path.
85
157
:param relpath: The relative path to the file
88
path = self.abspath(relpath)
89
return open(path, 'rb')
90
except (IOError, OSError),e:
91
self._translate_error(e, path)
93
def put(self, relpath, f, mode=None):
94
"""Copy the file-like or string object into the location.
96
:param relpath: Location to put the contents, relative to base.
97
:param f: File-like or string object.
99
from bzrlib.atomicfile import AtomicFile
103
path = self.abspath(relpath)
104
check_legal_path(path)
105
fp = AtomicFile(path, 'wb', new_mode=mode)
106
except (IOError, OSError),e:
107
self._translate_error(e, path)
159
canonical_url = self.abspath(relpath)
160
if canonical_url in transport._file_streams:
161
transport._file_streams[canonical_url].flush()
163
path = self._abspath(relpath)
164
return osutils.open_file(path, 'rb')
165
except (IOError, OSError),e:
166
if e.errno == errno.EISDIR:
167
return LateReadError(relpath)
168
self._translate_error(e, path)
170
def put_file(self, relpath, f, mode=None):
171
"""Copy the file-like object into the location.
173
:param relpath: Location to put the contents, relative to base.
174
:param f: File-like object.
175
:param mode: The mode for the newly created file,
176
None means just use the default
181
path = self._abspath(relpath)
182
osutils.check_legal_path(path)
183
fp = atomicfile.AtomicFile(path, 'wb', new_mode=mode)
184
except (IOError, OSError),e:
185
self._translate_error(e, path)
187
length = self._pump(f, fp)
193
def put_bytes(self, relpath, bytes, mode=None):
194
"""Copy the string into the location.
196
:param relpath: Location to put the contents, relative to base.
202
path = self._abspath(relpath)
203
osutils.check_legal_path(path)
204
fp = atomicfile.AtomicFile(path, 'wb', new_mode=mode)
205
except (IOError, OSError),e:
206
self._translate_error(e, path)
214
def _put_non_atomic_helper(self, relpath, writer,
216
create_parent_dir=False,
218
"""Common functionality information for the put_*_non_atomic.
220
This tracks all the create_parent_dir stuff.
222
:param relpath: the path we are putting to.
223
:param writer: A function that takes an os level file descriptor
224
and writes whatever data it needs to write there.
225
:param mode: The final file mode.
226
:param create_parent_dir: Should we be creating the parent directory
229
abspath = self._abspath(relpath)
231
# os.open() will automatically use the umask
236
fd = os.open(abspath, _put_non_atomic_flags, local_mode)
237
except (IOError, OSError),e:
238
# We couldn't create the file, maybe we need to create
239
# the parent directory, and try again
240
if (not create_parent_dir
241
or e.errno not in (errno.ENOENT,errno.ENOTDIR)):
242
self._translate_error(e, relpath)
243
parent_dir = os.path.dirname(abspath)
245
self._translate_error(e, relpath)
246
self._mkdir(parent_dir, mode=dir_mode)
247
# We created the parent directory, lets try to open the
250
fd = os.open(abspath, _put_non_atomic_flags, local_mode)
251
except (IOError, OSError), e:
252
self._translate_error(e, relpath)
255
if mode is not None and mode != S_IMODE(st.st_mode):
256
# Because of umask, we may still need to chmod the file.
257
# But in the general case, we won't have to
258
os.chmod(abspath, mode)
263
def put_file_non_atomic(self, relpath, f, mode=None,
264
create_parent_dir=False,
266
"""Copy the file-like object into the target location.
268
This function is not strictly safe to use. It is only meant to
269
be used when you already know that the target does not exist.
270
It is not safe, because it will open and truncate the remote
271
file. So there may be a time when the file has invalid contents.
273
:param relpath: The remote location to put the contents.
274
:param f: File-like object.
275
:param mode: Possible access permissions for new file.
276
None means do not set remote permissions.
277
:param create_parent_dir: If we cannot create the target file because
278
the parent directory does not exist, go ahead and
279
create it, and then try again.
282
self._pump_to_fd(f, fd)
283
self._put_non_atomic_helper(relpath, writer, mode=mode,
284
create_parent_dir=create_parent_dir,
287
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
288
create_parent_dir=False, dir_mode=None):
292
self._put_non_atomic_helper(relpath, writer, mode=mode,
293
create_parent_dir=create_parent_dir,
114
296
def iter_files_recursive(self):
115
297
"""Iter the relative paths of files in the transports sub-tree."""
308
def _mkdir(self, abspath, mode=None):
309
"""Create a real directory, filtering through mode"""
311
# os.mkdir() will filter through umask
316
os.mkdir(abspath, local_mode)
318
# It is probably faster to just do the chmod, rather than
319
# doing a stat, and then trying to compare
320
os.chmod(abspath, mode)
321
except (IOError, OSError),e:
322
self._translate_error(e, abspath)
126
324
def mkdir(self, relpath, mode=None):
127
325
"""Create a directory at the given path."""
130
path = self.abspath(relpath)
134
except (IOError, OSError),e:
135
self._translate_error(e, path)
137
def append(self, relpath, f, mode=None):
138
"""Append the text in the file-like object into the final
142
fp = open(self.abspath(relpath), 'ab')
144
os.chmod(self.abspath(relpath), mode)
326
self._mkdir(self._abspath(relpath), mode=mode)
328
def open_write_stream(self, relpath, mode=None):
329
"""See Transport.open_write_stream."""
330
# initialise the file
331
self.put_bytes_non_atomic(relpath, "", mode=mode)
332
abspath = self._abspath(relpath)
333
handle = osutils.open_file(abspath, 'wb')
335
self._check_mode_and_size(abspath, handle.fileno(), mode)
336
transport._file_streams[self.abspath(relpath)] = handle
337
return transport.FileFileStream(self, relpath, handle)
339
def _get_append_file(self, relpath, mode=None):
340
"""Call os.open() for the given relpath"""
341
file_abspath = self._abspath(relpath)
343
# os.open() will automatically use the umask
348
return file_abspath, os.open(file_abspath, _append_flags, local_mode)
145
349
except (IOError, OSError),e:
146
350
self._translate_error(e, relpath)
147
# win32 workaround (tell on an unwritten file returns 0)
352
def _check_mode_and_size(self, file_abspath, fd, mode=None):
353
"""Check the mode of the file, and return the current size"""
355
if mode is not None and mode != S_IMODE(st.st_mode):
356
# Because of umask, we may still need to chmod the file.
357
# But in the general case, we won't have to
358
os.chmod(file_abspath, mode)
361
def append_file(self, relpath, f, mode=None):
362
"""Append the text in the file-like object into the final location."""
363
file_abspath, fd = self._get_append_file(relpath, mode=mode)
365
result = self._check_mode_and_size(file_abspath, fd, mode=mode)
366
self._pump_to_fd(f, fd)
371
def append_bytes(self, relpath, bytes, mode=None):
372
"""Append the text in the string into the final location."""
373
file_abspath, fd = self._get_append_file(relpath, mode=mode)
375
result = self._check_mode_and_size(file_abspath, fd, mode=mode)
382
def _pump_to_fd(self, fromfile, to_fd):
383
"""Copy contents of one file to another."""
386
b = fromfile.read(BUFSIZE)
153
391
def copy(self, rel_from, rel_to):
154
392
"""Copy the item at rel_from to the location at rel_to"""
156
path_from = self.abspath(rel_from)
157
path_to = self.abspath(rel_to)
393
path_from = self._abspath(rel_from)
394
path_to = self._abspath(rel_to)
159
396
shutil.copy(path_from, path_to)
160
397
except (IOError, OSError),e:
287
class ScratchTransport(LocalTransport):
288
"""A transport that works in a temporary dir and cleans up after itself.
290
The dir only exists for the lifetime of the Python object.
291
Obviously you should not put anything precious in it.
294
def __init__(self, base=None):
296
base = tempfile.mkdtemp()
297
super(ScratchTransport, self).__init__(base)
300
shutil.rmtree(self.base, ignore_errors=True)
301
mutter("%r destroyed" % self)
304
class LocalRelpathServer(Server):
305
"""A pretend server for local transports, using relpaths."""
308
"""See Transport.Server.get_url."""
312
class LocalAbspathServer(Server):
313
"""A pretend server for local transports, using absolute paths."""
316
"""See Transport.Server.get_url."""
317
return os.path.abspath("")
320
class LocalURLServer(Server):
321
"""A pretend server for local transports, using file:// urls."""
324
"""See Transport.Server.get_url."""
325
# FIXME: \ to / on windows
326
return "file://%s" % os.path.abspath("")
556
class EmulatedWin32LocalTransport(LocalTransport):
557
"""Special transport for testing Win32 [UNC] paths on non-windows"""
559
def __init__(self, base):
562
super(LocalTransport, self).__init__(base)
563
self._local_base = urlutils._win32_local_path_from_url(base)
565
def abspath(self, relpath):
566
path = osutils.normpath(osutils.pathjoin(
567
self._local_base, urlutils.unescape(relpath)))
568
return urlutils._win32_local_path_to_url(path)
570
def clone(self, offset=None):
571
"""Return a new LocalTransport with root at self.base + offset
572
Because the local filesystem does not require a connection,
573
we can just return a new object.
576
return EmulatedWin32LocalTransport(self.base)
578
abspath = self.abspath(offset)
579
if abspath == 'file://':
580
# fix upwalk for UNC path
581
# when clone from //HOST/path updir recursively
582
# we should stop at least at //HOST part
584
return EmulatedWin32LocalTransport(abspath)
329
587
def get_test_permutations():
330
588
"""Return the permutations to be used in testing."""
331
return [(LocalTransport, LocalRelpathServer),
332
(LocalTransport, LocalAbspathServer),
333
(LocalTransport, LocalURLServer),
589
from bzrlib.tests import test_server
590
return [(LocalTransport, test_server.LocalURLServer),]
added
removed
bzrlib/transport/local.py
