1
# Copyright (C) 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
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
17
"""Transport for the local filesystem.
19
This is a fairly thin wrapper on regular file IO."""
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
from bzrlib.trace import mutter
31
from bzrlib.transport import Transport, Server
32
import bzrlib.urlutils as urlutils
35
class LocalTransport(Transport):
36
"""This is the transport agent for local filesystem access."""
38
def __init__(self, base):
39
"""Set the base path where files will be stored."""
40
if not base.startswith('file://'):
41
warn("Instantiating LocalTransport with a filesystem path"
42
" is deprecated as of bzr 0.8."
43
" Please use bzrlib.transport.get_transport()"
44
" or pass in a file:// url.",
48
base = urlutils.local_path_to_url(base)
51
super(LocalTransport, self).__init__(base)
52
self._local_base = urlutils.local_path_from_url(base)
54
def should_cache(self):
57
def clone(self, offset=None):
58
"""Return a new LocalTransport with root at self.base + offset
59
Because the local filesystem does not require a connection,
60
we can just return a new object.
63
return LocalTransport(self.base)
65
return LocalTransport(self.abspath(offset))
67
def abspath(self, relpath):
68
"""Return the full url to the given relative URL."""
69
assert isinstance(relpath, basestring), (type(relpath), relpath)
70
# jam 20060426 Using normpath on the real path, because that ensures
71
# proper handling of stuff like
72
path = normpath(pathjoin(self._local_base, urlutils.unescape(relpath)))
73
return urlutils.local_path_to_url(path)
75
def local_abspath(self, relpath):
76
"""Transform the given relative path URL into the actual path on disk
78
This function only exists for the LocalTransport, since it is
79
the only one that has direct local access.
80
This is mostly for stuff like WorkingTree which needs to know
81
the local working directory.
83
absurl = self.abspath(relpath)
84
# mutter(u'relpath %s => base: %s, absurl %s', relpath, self.base, absurl)
85
return urlutils.local_path_from_url(absurl)
87
def relpath(self, abspath):
88
"""Return the local path portion from a given absolute path.
93
return urlutils.file_relpath(
94
urlutils.strip_trailing_slash(self.base),
95
urlutils.strip_trailing_slash(abspath))
97
def has(self, relpath):
98
return os.access(self.local_abspath(relpath), os.F_OK)
100
def get(self, relpath):
101
"""Get the file at the given relative path.
103
:param relpath: The relative path to the file
106
path = self.local_abspath(relpath)
107
# mutter('LocalTransport.get(%r) => %r', relpath, path)
108
return open(path, 'rb')
109
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)
133
def iter_files_recursive(self):
134
"""Iter the relative paths of files in the transports sub-tree."""
135
queue = list(self.list_dir(u'.'))
137
relpath = queue.pop(0)
138
st = self.stat(relpath)
139
if S_ISDIR(st[ST_MODE]):
140
for i, basename in enumerate(self.list_dir(relpath)):
141
queue.insert(i, relpath+'/'+basename)
145
def mkdir(self, relpath, mode=None):
146
"""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)
164
except (IOError, OSError),e:
165
self._translate_error(e, relpath)
166
# win32 workaround (tell on an unwritten file returns 0)
172
def copy(self, rel_from, rel_to):
173
"""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)
177
shutil.copy(path_from, path_to)
178
except (IOError, OSError),e:
179
# TODO: What about path_to?
180
self._translate_error(e, path_from)
182
def rename(self, rel_from, rel_to):
183
path_from = self.local_abspath(rel_from)
185
# *don't* call bzrlib.osutils.rename, because we want to
186
# detect errors on rename
187
os.rename(path_from, self.local_abspath(rel_to))
188
except (IOError, OSError),e:
189
# TODO: What about path_to?
190
self._translate_error(e, path_from)
192
def move(self, rel_from, rel_to):
193
"""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)
198
# this version will delete the destination if necessary
199
rename(path_from, path_to)
200
except (IOError, OSError),e:
201
# TODO: What about path_to?
202
self._translate_error(e, path_from)
204
def delete(self, relpath):
205
"""Delete the item at relpath"""
208
path = self.local_abspath(relpath)
210
except (IOError, OSError),e:
211
# TODO: What about path_to?
212
self._translate_error(e, path)
214
def copy_to(self, relpaths, other, mode=None, pb=None):
215
"""Copy a set of entries from self into another Transport.
217
:param relpaths: A list/generator of entries to be copied.
219
if isinstance(other, LocalTransport):
220
# Both from & to are on the local filesystem
221
# Unfortunately, I can't think of anything faster than just
222
# copying them across, one by one :(
223
total = self._get_total(relpaths)
225
for path in relpaths:
226
self._update_pb(pb, 'copy-to', count, total)
228
mypath = self.local_abspath(path)
229
otherpath = other.local_abspath(path)
230
shutil.copy(mypath, otherpath)
232
os.chmod(otherpath, mode)
233
except (IOError, OSError),e:
234
self._translate_error(e, path)
238
return super(LocalTransport, self).copy_to(relpaths, other, mode=mode, pb=pb)
241
"""See Transport.listable."""
244
def list_dir(self, relpath):
245
"""Return a list of all files at the given location.
246
WARNING: many transports do not support this, so trying avoid using
247
it if at all possible.
249
path = self.local_abspath(relpath)
251
return [urlutils.escape(entry) for entry in os.listdir(path)]
252
except (IOError, OSError), e:
253
self._translate_error(e, path)
255
def stat(self, relpath):
256
"""Return the stat information for a file.
260
path = self.local_abspath(relpath)
262
except (IOError, OSError),e:
263
self._translate_error(e, path)
265
def lock_read(self, relpath):
266
"""Lock the given file for shared (read) access.
267
:return: A lock object, which should be passed to Transport.unlock()
269
from bzrlib.lock import ReadLock
272
path = self.local_abspath(relpath)
273
return ReadLock(path)
274
except (IOError, OSError), e:
275
self._translate_error(e, path)
277
def lock_write(self, relpath):
278
"""Lock the given file for exclusive (write) access.
279
WARNING: many transports do not support this, so trying avoid using it
281
:return: A lock object, which should be passed to Transport.unlock()
283
from bzrlib.lock import WriteLock
284
return WriteLock(self.local_abspath(relpath))
286
def rmdir(self, relpath):
287
"""See Transport.rmdir."""
290
path = self.local_abspath(relpath)
292
except (IOError, OSError),e:
293
self._translate_error(e, path)
295
def _can_roundtrip_unix_modebits(self):
296
if sys.platform == 'win32':
303
class ScratchTransport(LocalTransport):
304
"""A transport that works in a temporary dir and cleans up after itself.
306
The dir only exists for the lifetime of the Python object.
307
Obviously you should not put anything precious in 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."""
340
"""See Transport.Server.get_url."""
341
return urlutils.local_path_to_url('')
344
def get_test_permutations():
345
"""Return the permutations to be used in testing."""
346
return [(LocalTransport, LocalRelpathServer),
347
(LocalTransport, LocalAbspathServer),
348
(LocalTransport, LocalURLServer),
added
removed
bzrlib/transport/local.py
