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."""
25
from stat import ST_MODE, S_ISDIR, ST_SIZE, S_IMODE
24
from stat import ST_MODE, S_ISDIR, ST_SIZE
32
from bzrlib.osutils import (abspath, realpath, normpath, pathjoin, rename,
33
check_legal_path, rmtree)
34
from bzrlib.symbol_versioning import warn
35
28
from bzrlib.trace import mutter
36
29
from bzrlib.transport import Transport, Server
39
_append_flags = os.O_CREAT | os.O_APPEND | os.O_WRONLY | osutils.O_BINARY
30
from bzrlib.osutils import (abspath, realpath, normpath, pathjoin, rename,
31
check_legal_path, rmtree)
42
34
class LocalTransport(Transport):
45
37
def __init__(self, base):
46
38
"""Set the base path where files will be stored."""
47
if not base.startswith('file://'):
48
warn("Instantiating LocalTransport with a filesystem path"
49
" is deprecated as of bzr 0.8."
50
" Please use bzrlib.transport.get_transport()"
51
" or pass in a file:// url.",
55
base = urlutils.local_path_to_url(base)
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))
56
44
if base[-1] != '/':
58
46
super(LocalTransport, self).__init__(base)
59
self._local_base = urlutils.local_path_from_url(base)
61
48
def should_cache(self):
72
59
return LocalTransport(self.abspath(offset))
74
def _abspath(self, relative_reference):
75
"""Return a path for use in os calls.
77
Several assumptions are made:
78
- relative_reference does not contain '..'
79
- relative_reference is url escaped.
81
if relative_reference in ('.', ''):
82
return self._local_base
83
return self._local_base + urlutils.unescape(relative_reference)
85
61
def abspath(self, relpath):
86
62
"""Return the full url to the given relative URL."""
87
# TODO: url escape the result. RBC 20060523.
88
63
assert isinstance(relpath, basestring), (type(relpath), relpath)
89
# jam 20060426 Using normpath on the real path, because that ensures
90
# proper handling of stuff like
91
path = normpath(pathjoin(self._local_base, urlutils.unescape(relpath)))
92
return urlutils.local_path_to_url(path)
94
def local_abspath(self, relpath):
95
"""Transform the given relative path URL into the actual path on disk
97
This function only exists for the LocalTransport, since it is
98
the only one that has direct local access.
99
This is mostly for stuff like WorkingTree which needs to know
100
the local working directory.
102
This function is quite expensive: it calls realpath which resolves
105
absurl = self.abspath(relpath)
106
# mutter(u'relpath %s => base: %s, absurl %s', relpath, self.base, absurl)
107
return urlutils.local_path_from_url(absurl)
64
result = normpath(pathjoin(self.base, urllib.unquote(relpath)))
65
#if result[-1] != '/':
109
69
def relpath(self, abspath):
110
70
"""Return the local path portion from a given absolute path.
72
from bzrlib.osutils import relpath, strip_trailing_slash
112
73
if abspath is None:
115
return urlutils.file_relpath(
116
urlutils.strip_trailing_slash(self.base),
117
urlutils.strip_trailing_slash(abspath))
76
return relpath(strip_trailing_slash(self.base),
77
strip_trailing_slash(abspath))
119
79
def has(self, relpath):
120
return os.access(self._abspath(relpath), os.F_OK)
80
return os.access(self.abspath(relpath), os.F_OK)
122
82
def get(self, relpath):
123
83
"""Get the file at the given relative path.
167
127
"""Create a directory at the given path."""
171
# os.mkdir() will filter through umask
175
path = self._abspath(relpath)
176
os.mkdir(path, local_mode)
130
path = self.abspath(relpath)
177
132
if mode is not None:
178
# It is probably faster to just do the chmod, rather than
179
# doing a stat, and then trying to compare
180
133
os.chmod(path, mode)
181
134
except (IOError, OSError),e:
182
135
self._translate_error(e, path)
184
137
def append(self, relpath, f, mode=None):
185
"""Append the text in the file-like object into the final location."""
186
abspath = self._abspath(relpath)
188
# os.open() will automatically use the umask
138
"""Append the text in the file-like object into the final
193
fd = os.open(abspath, _append_flags, local_mode)
142
fp = open(self.abspath(relpath), 'ab')
144
os.chmod(self.abspath(relpath), mode)
194
145
except (IOError, OSError),e:
195
146
self._translate_error(e, relpath)
199
if mode is not None and mode != S_IMODE(st.st_mode):
200
# Because of umask, we may still need to chmod the file.
201
# But in the general case, we won't have to
202
os.chmod(abspath, mode)
203
self._pump_to_fd(f, fd)
147
# win32 workaround (tell on an unwritten file returns 0)
208
def _pump_to_fd(self, fromfile, to_fd):
209
"""Copy contents of one file to another."""
212
b = fromfile.read(BUFSIZE)
217
153
def copy(self, rel_from, rel_to):
218
154
"""Copy the item at rel_from to the location at rel_to"""
219
path_from = self._abspath(rel_from)
220
path_to = self._abspath(rel_to)
155
path_from = self.abspath(rel_from)
156
path_to = self.abspath(rel_to)
222
158
shutil.copy(path_from, path_to)
223
159
except (IOError, OSError),e:
225
161
self._translate_error(e, path_from)
227
163
def rename(self, rel_from, rel_to):
228
path_from = self._abspath(rel_from)
164
path_from = self.abspath(rel_from)
230
166
# *don't* call bzrlib.osutils.rename, because we want to
231
167
# detect errors on rename
232
os.rename(path_from, self._abspath(rel_to))
168
os.rename(path_from, self.abspath(rel_to))
233
169
except (IOError, OSError),e:
234
170
# TODO: What about path_to?
235
171
self._translate_error(e, path_from)
237
173
def move(self, rel_from, rel_to):
238
174
"""Move the item at rel_from to the location at rel_to"""
239
path_from = self._abspath(rel_from)
240
path_to = self._abspath(rel_to)
175
path_from = self.abspath(rel_from)
176
path_to = self.abspath(rel_to)
243
179
# this version will delete the destination if necessary
250
186
"""Delete the item at relpath"""
253
path = self._abspath(relpath)
189
path = self.abspath(relpath)
255
191
except (IOError, OSError),e:
192
# TODO: What about path_to?
256
193
self._translate_error(e, path)
258
195
def copy_to(self, relpaths, other, mode=None, pb=None):
269
206
for path in relpaths:
270
207
self._update_pb(pb, 'copy-to', count, total)
272
mypath = self._abspath(path)
273
otherpath = other._abspath(path)
209
mypath = self.abspath(path)
210
otherpath = other.abspath(path)
274
211
shutil.copy(mypath, otherpath)
275
212
if mode is not None:
276
213
os.chmod(otherpath, mode)
290
227
WARNING: many transports do not support this, so trying avoid using
291
228
it if at all possible.
293
path = self._abspath(relpath)
230
path = self.abspath(relpath)
295
return [urlutils.escape(entry) for entry in os.listdir(path)]
232
return [urllib.quote(entry) for entry in os.listdir(path)]
296
233
except (IOError, OSError), e:
297
234
self._translate_error(e, path)
325
262
:return: A lock object, which should be passed to Transport.unlock()
327
264
from bzrlib.lock import WriteLock
328
return WriteLock(self._abspath(relpath))
265
return WriteLock(self.abspath(relpath))
330
267
def rmdir(self, relpath):
331
268
"""See Transport.rmdir."""
334
path = self._abspath(relpath)
271
path = self.abspath(relpath)
336
273
except (IOError, OSError),e:
337
274
self._translate_error(e, path)
284
class ScratchTransport(LocalTransport):
285
"""A transport that works in a temporary dir and cleans up after itself.
287
The dir only exists for the lifetime of the Python object.
288
Obviously you should not put anything precious in it.
291
def __init__(self, base=None):
293
base = tempfile.mkdtemp()
294
super(ScratchTransport, self).__init__(base)
297
rmtree(self.base, ignore_errors=True)
298
mutter("%r destroyed" % self)
347
301
class LocalRelpathServer(Server):
348
302
"""A pretend server for local transports, using relpaths."""
added
removed
bzrlib/transport/local.py
