1
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
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(), """
24
from stat import ST_MODE, S_ISDIR, ST_SIZE
27
from bzrlib.osutils import (abspath, realpath, normpath, pathjoin, rename,
28
check_legal_path, rmtree)
29
from bzrlib.symbol_versioning import warn
30
38
from bzrlib.trace import mutter
39
from bzrlib.transport import LateReadError
31
42
from bzrlib.transport import Transport, Server
32
import bzrlib.urlutils as urlutils
45
_append_flags = os.O_CREAT | os.O_APPEND | os.O_WRONLY | osutils.O_BINARY
46
_put_non_atomic_flags = os.O_CREAT | os.O_TRUNC | os.O_WRONLY | osutils.O_BINARY
35
49
class LocalTransport(Transport):
63
84
return LocalTransport(self.base)
65
return LocalTransport(self.abspath(offset))
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)
67
105
def abspath(self, relpath):
68
106
"""Return the full url to the given relative URL."""
69
assert isinstance(relpath, basestring), (type(relpath), relpath)
107
# TODO: url escape the result. RBC 20060523.
70
108
# jam 20060426 Using normpath on the real path, because that ensures
71
109
# proper handling of stuff like
72
path = normpath(pathjoin(self._local_base, urlutils.unescape(relpath)))
110
path = osutils.normpath(osutils.pathjoin(
111
self._local_base, urlutils.unescape(relpath)))
73
112
return urlutils.local_path_to_url(path)
75
114
def local_abspath(self, relpath):
93
136
return urlutils.file_relpath(
94
urlutils.strip_trailing_slash(self.base),
137
urlutils.strip_trailing_slash(self.base),
95
138
urlutils.strip_trailing_slash(abspath))
97
140
def has(self, relpath):
98
return os.access(self.local_abspath(relpath), os.F_OK)
141
return os.access(self._abspath(relpath), os.F_OK)
100
143
def get(self, relpath):
101
144
"""Get the file at the given relative path.
103
146
:param relpath: The relative path to the file
148
canonical_url = self.abspath(relpath)
149
if canonical_url in transport._file_streams:
150
transport._file_streams[canonical_url].flush()
106
path = self.local_abspath(relpath)
107
# mutter('LocalTransport.get(%r) => %r', relpath, path)
152
path = self._abspath(relpath)
108
153
return open(path, 'rb')
109
154
except (IOError, OSError),e:
110
self._translate_error(e, path)
112
def put(self, relpath, f, mode=None):
113
"""Copy the file-like or string object into the location.
115
:param relpath: Location to put the contents, relative to base.
116
:param f: File-like or string object.
118
from bzrlib.atomicfile import AtomicFile
122
path = self.local_abspath(relpath)
123
check_legal_path(path)
124
fp = AtomicFile(path, 'wb', new_mode=mode)
125
except (IOError, OSError),e:
126
self._translate_error(e, path)
155
if e.errno == errno.EISDIR:
156
return LateReadError(relpath)
157
self._translate_error(e, path)
159
def put_file(self, relpath, f, mode=None):
160
"""Copy the file-like object into the location.
162
:param relpath: Location to put the contents, relative to base.
163
:param f: File-like object.
164
:param mode: The mode for the newly created file,
165
None means just use the default
170
path = self._abspath(relpath)
171
osutils.check_legal_path(path)
172
fp = atomicfile.AtomicFile(path, 'wb', new_mode=mode)
173
except (IOError, OSError),e:
174
self._translate_error(e, path)
176
length = self._pump(f, fp)
182
def put_bytes(self, relpath, bytes, mode=None):
183
"""Copy the string into the location.
185
:param relpath: Location to put the contents, relative to base.
191
path = self._abspath(relpath)
192
osutils.check_legal_path(path)
193
fp = atomicfile.AtomicFile(path, 'wb', new_mode=mode)
194
except (IOError, OSError),e:
195
self._translate_error(e, path)
202
def _put_non_atomic_helper(self, relpath, writer,
204
create_parent_dir=False,
206
"""Common functionality information for the put_*_non_atomic.
208
This tracks all the create_parent_dir stuff.
210
:param relpath: the path we are putting to.
211
:param writer: A function that takes an os level file descriptor
212
and writes whatever data it needs to write there.
213
:param mode: The final file mode.
214
:param create_parent_dir: Should we be creating the parent directory
217
abspath = self._abspath(relpath)
219
# os.open() will automatically use the umask
224
fd = os.open(abspath, _put_non_atomic_flags, local_mode)
225
except (IOError, OSError),e:
226
# We couldn't create the file, maybe we need to create
227
# the parent directory, and try again
228
if (not create_parent_dir
229
or e.errno not in (errno.ENOENT,errno.ENOTDIR)):
230
self._translate_error(e, relpath)
231
parent_dir = os.path.dirname(abspath)
233
self._translate_error(e, relpath)
234
self._mkdir(parent_dir, mode=dir_mode)
235
# We created the parent directory, lets try to open the
238
fd = os.open(abspath, _put_non_atomic_flags, local_mode)
239
except (IOError, OSError), e:
240
self._translate_error(e, relpath)
243
if mode is not None and mode != S_IMODE(st.st_mode):
244
# Because of umask, we may still need to chmod the file.
245
# But in the general case, we won't have to
246
os.chmod(abspath, mode)
251
def put_file_non_atomic(self, relpath, f, mode=None,
252
create_parent_dir=False,
254
"""Copy the file-like object into the target location.
256
This function is not strictly safe to use. It is only meant to
257
be used when you already know that the target does not exist.
258
It is not safe, because it will open and truncate the remote
259
file. So there may be a time when the file has invalid contents.
261
:param relpath: The remote location to put the contents.
262
:param f: File-like object.
263
:param mode: Possible access permissions for new file.
264
None means do not set remote permissions.
265
:param create_parent_dir: If we cannot create the target file because
266
the parent directory does not exist, go ahead and
267
create it, and then try again.
270
self._pump_to_fd(f, fd)
271
self._put_non_atomic_helper(relpath, writer, mode=mode,
272
create_parent_dir=create_parent_dir,
275
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
276
create_parent_dir=False, dir_mode=None):
279
self._put_non_atomic_helper(relpath, writer, mode=mode,
280
create_parent_dir=create_parent_dir,
133
283
def iter_files_recursive(self):
134
284
"""Iter the relative paths of files in the transports sub-tree."""
295
def _mkdir(self, abspath, mode=None):
296
"""Create a real directory, filtering through mode"""
298
# os.mkdir() will filter through umask
303
os.mkdir(abspath, local_mode)
305
# It is probably faster to just do the chmod, rather than
306
# doing a stat, and then trying to compare
307
os.chmod(abspath, mode)
308
except (IOError, OSError),e:
309
self._translate_error(e, abspath)
145
311
def mkdir(self, relpath, mode=None):
146
312
"""Create a directory at the given path."""
149
path = self.local_abspath(relpath)
153
except (IOError, OSError),e:
154
self._translate_error(e, path)
156
def append(self, relpath, f, mode=None):
157
"""Append the text in the file-like object into the final
161
fp = open(self.local_abspath(relpath), 'ab')
163
os.chmod(self.local_abspath(relpath), mode)
313
self._mkdir(self._abspath(relpath), mode=mode)
315
def open_write_stream(self, relpath, mode=None):
316
"""See Transport.open_write_stream."""
317
# initialise the file
318
self.put_bytes_non_atomic(relpath, "", mode=mode)
319
abspath = self._abspath(relpath)
320
handle = open(abspath, 'wb')
322
self._check_mode_and_size(abspath, handle.fileno(), mode)
323
transport._file_streams[self.abspath(relpath)] = handle
324
return transport.FileFileStream(self, relpath, handle)
326
def _get_append_file(self, relpath, mode=None):
327
"""Call os.open() for the given relpath"""
328
file_abspath = self._abspath(relpath)
330
# os.open() will automatically use the umask
335
return file_abspath, os.open(file_abspath, _append_flags, local_mode)
164
336
except (IOError, OSError),e:
165
337
self._translate_error(e, relpath)
166
# win32 workaround (tell on an unwritten file returns 0)
339
def _check_mode_and_size(self, file_abspath, fd, mode=None):
340
"""Check the mode of the file, and return the current size"""
342
if mode is not None and mode != S_IMODE(st.st_mode):
343
# Because of umask, we may still need to chmod the file.
344
# But in the general case, we won't have to
345
os.chmod(file_abspath, mode)
348
def append_file(self, relpath, f, mode=None):
349
"""Append the text in the file-like object into the final location."""
350
file_abspath, fd = self._get_append_file(relpath, mode=mode)
352
result = self._check_mode_and_size(file_abspath, fd, mode=mode)
353
self._pump_to_fd(f, fd)
358
def append_bytes(self, relpath, bytes, mode=None):
359
"""Append the text in the string into the final location."""
360
file_abspath, fd = self._get_append_file(relpath, mode=mode)
362
result = self._check_mode_and_size(file_abspath, fd, mode=mode)
368
def _pump_to_fd(self, fromfile, to_fd):
369
"""Copy contents of one file to another."""
372
b = fromfile.read(BUFSIZE)
172
377
def copy(self, rel_from, rel_to):
173
378
"""Copy the item at rel_from to the location at rel_to"""
174
path_from = self.local_abspath(rel_from)
175
path_to = self.local_abspath(rel_to)
379
path_from = self._abspath(rel_from)
380
path_to = self._abspath(rel_to)
177
382
shutil.copy(path_from, path_to)
178
383
except (IOError, OSError),e:
180
385
self._translate_error(e, path_from)
182
387
def rename(self, rel_from, rel_to):
183
path_from = self.local_abspath(rel_from)
388
path_from = self._abspath(rel_from)
185
390
# *don't* call bzrlib.osutils.rename, because we want to
186
391
# detect errors on rename
187
os.rename(path_from, self.local_abspath(rel_to))
392
os.rename(path_from, self._abspath(rel_to))
188
393
except (IOError, OSError),e:
189
394
# TODO: What about path_to?
190
395
self._translate_error(e, path_from)
192
397
def move(self, rel_from, rel_to):
193
398
"""Move the item at rel_from to the location at rel_to"""
194
path_from = self.local_abspath(rel_from)
195
path_to = self.local_abspath(rel_to)
399
path_from = self._abspath(rel_from)
400
path_to = self._abspath(rel_to)
198
403
# this version will delete the destination if necessary
199
rename(path_from, path_to)
404
osutils.rename(path_from, path_to)
200
405
except (IOError, OSError),e:
201
406
# TODO: What about path_to?
202
407
self._translate_error(e, path_from)
303
class ScratchTransport(LocalTransport):
304
"""A transport that works in a temporary dir and cleans up after itself.
513
class EmulatedWin32LocalTransport(LocalTransport):
514
"""Special transport for testing Win32 [UNC] paths on non-windows"""
516
def __init__(self, base):
519
super(LocalTransport, self).__init__(base)
520
self._local_base = urlutils._win32_local_path_from_url(base)
522
def abspath(self, relpath):
523
path = osutils.normpath(osutils.pathjoin(
524
self._local_base, urlutils.unescape(relpath)))
525
return urlutils._win32_local_path_to_url(path)
527
def clone(self, offset=None):
528
"""Return a new LocalTransport with root at self.base + offset
529
Because the local filesystem does not require a connection,
530
we can just return a new object.
533
return EmulatedWin32LocalTransport(self.base)
535
abspath = self.abspath(offset)
536
if abspath == 'file://':
537
# fix upwalk for UNC path
538
# when clone from //HOST/path updir recursively
539
# we should stop at least at //HOST part
541
return EmulatedWin32LocalTransport(abspath)
544
class LocalURLServer(Server):
545
"""A pretend server for local transports, using file:// urls.
306
The dir only exists for the lifetime of the Python object.
307
Obviously you should not put anything precious in it.
547
Of course no actual server is required to access the local filesystem, so
548
this just exists to tell the test code how to get to it.
310
def __init__(self, base=None):
312
base = tempfile.mkdtemp()
313
super(ScratchTransport, self).__init__(base)
316
rmtree(self.base, ignore_errors=True)
317
mutter("%r destroyed" % self)
320
class LocalRelpathServer(Server):
321
"""A pretend server for local transports, using relpaths."""
324
"""See Transport.Server.get_url."""
328
class LocalAbspathServer(Server):
329
"""A pretend server for local transports, using absolute paths."""
332
"""See Transport.Server.get_url."""
333
return os.path.abspath("")
336
class LocalURLServer(Server):
337
"""A pretend server for local transports, using file:// urls."""
552
"""Setup the server to service requests.
554
:param decorated_transport: ignored by this implementation.
339
557
def get_url(self):
340
558
"""See Transport.Server.get_url."""