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
23
from stat import ST_MODE, S_ISDIR, ST_SIZE, S_IMODE
26
from bzrlib.lazy_import import lazy_import
27
lazy_import(globals(), """
25
from stat import ST_MODE, S_ISDIR, ST_SIZE
28
from bzrlib.osutils import (abspath, realpath, normpath, pathjoin, rename,
29
check_legal_path, rmtree)
30
from bzrlib.symbol_versioning import warn
31
37
from bzrlib.trace import mutter
32
40
from bzrlib.transport import Transport, Server
33
import bzrlib.urlutils as urlutils
43
_append_flags = os.O_CREAT | os.O_APPEND | os.O_WRONLY | osutils.O_BINARY
44
_put_non_atomic_flags = os.O_CREAT | os.O_TRUNC | os.O_WRONLY | osutils.O_BINARY
36
47
class LocalTransport(Transport):
124
143
except (IOError, OSError),e:
125
144
self._translate_error(e, path)
127
def put(self, relpath, f, mode=None):
128
"""Copy the file-like or string object into the location.
146
def put_file(self, relpath, f, mode=None):
147
"""Copy the file-like object into the location.
130
149
:param relpath: Location to put the contents, relative to base.
131
:param f: File-like or string object.
150
:param f: File-like object.
151
:param mode: The mode for the newly created file,
152
None means just use the default
133
from bzrlib.atomicfile import AtomicFile
137
157
path = self._abspath(relpath)
138
check_legal_path(path)
139
fp = AtomicFile(path, 'wb', new_mode=mode)
158
osutils.check_legal_path(path)
159
fp = atomicfile.AtomicFile(path, 'wb', new_mode=mode)
140
160
except (IOError, OSError),e:
141
161
self._translate_error(e, path)
168
def put_bytes(self, relpath, bytes, mode=None):
169
"""Copy the string into the location.
171
:param relpath: Location to put the contents, relative to base.
177
path = self._abspath(relpath)
178
osutils.check_legal_path(path)
179
fp = atomicfile.AtomicFile(path, 'wb', new_mode=mode)
180
except (IOError, OSError),e:
181
self._translate_error(e, path)
188
def _put_non_atomic_helper(self, relpath, writer,
190
create_parent_dir=False,
192
"""Common functionality information for the put_*_non_atomic.
194
This tracks all the create_parent_dir stuff.
196
:param relpath: the path we are putting to.
197
:param writer: A function that takes an os level file descriptor
198
and writes whatever data it needs to write there.
199
:param mode: The final file mode.
200
:param create_parent_dir: Should we be creating the parent directory
203
abspath = self._abspath(relpath)
205
# os.open() will automatically use the umask
210
fd = os.open(abspath, _put_non_atomic_flags, local_mode)
211
except (IOError, OSError),e:
212
# We couldn't create the file, maybe we need to create
213
# the parent directory, and try again
214
if (not create_parent_dir
215
or e.errno not in (errno.ENOENT,errno.ENOTDIR)):
216
self._translate_error(e, relpath)
217
parent_dir = os.path.dirname(abspath)
219
self._translate_error(e, relpath)
220
self._mkdir(parent_dir, mode=dir_mode)
221
# We created the parent directory, lets try to open the
224
fd = os.open(abspath, _put_non_atomic_flags, local_mode)
225
except (IOError, OSError), e:
226
self._translate_error(e, relpath)
229
if mode is not None and mode != S_IMODE(st.st_mode):
230
# Because of umask, we may still need to chmod the file.
231
# But in the general case, we won't have to
232
os.chmod(abspath, mode)
237
def put_file_non_atomic(self, relpath, f, mode=None,
238
create_parent_dir=False,
240
"""Copy the file-like object into the target location.
242
This function is not strictly safe to use. It is only meant to
243
be used when you already know that the target does not exist.
244
It is not safe, because it will open and truncate the remote
245
file. So there may be a time when the file has invalid contents.
247
:param relpath: The remote location to put the contents.
248
:param f: File-like object.
249
:param mode: Possible access permissions for new file.
250
None means do not set remote permissions.
251
:param create_parent_dir: If we cannot create the target file because
252
the parent directory does not exist, go ahead and
253
create it, and then try again.
256
self._pump_to_fd(f, fd)
257
self._put_non_atomic_helper(relpath, writer, mode=mode,
258
create_parent_dir=create_parent_dir,
261
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
262
create_parent_dir=False, dir_mode=None):
265
self._put_non_atomic_helper(relpath, writer, mode=mode,
266
create_parent_dir=create_parent_dir,
148
269
def iter_files_recursive(self):
149
270
"""Iter the relative paths of files in the transports sub-tree."""
150
271
queue = list(self.list_dir(u'.'))
281
def _mkdir(self, abspath, mode=None):
282
"""Create a real directory, filtering through mode"""
284
# os.mkdir() will filter through umask
289
os.mkdir(abspath, local_mode)
291
# It is probably faster to just do the chmod, rather than
292
# doing a stat, and then trying to compare
293
os.chmod(abspath, mode)
294
except (IOError, OSError),e:
295
self._translate_error(e, abspath)
160
297
def mkdir(self, relpath, mode=None):
161
298
"""Create a directory at the given path."""
299
self._mkdir(self._abspath(relpath), mode=mode)
301
def _get_append_file(self, relpath, mode=None):
302
"""Call os.open() for the given relpath"""
303
file_abspath = self._abspath(relpath)
305
# os.open() will automatically use the umask
164
path = self._abspath(relpath)
310
return file_abspath, os.open(file_abspath, _append_flags, local_mode)
168
311
except (IOError, OSError),e:
169
self._translate_error(e, path)
171
def append(self, relpath, f, mode=None):
312
self._translate_error(e, relpath)
314
def _check_mode_and_size(self, file_abspath, fd, mode=None):
315
"""Check the mode of the file, and return the current size"""
317
if mode is not None and mode != S_IMODE(st.st_mode):
318
# Because of umask, we may still need to chmod the file.
319
# But in the general case, we won't have to
320
os.chmod(file_abspath, mode)
323
def append_file(self, relpath, f, mode=None):
172
324
"""Append the text in the file-like object into the final location."""
173
abspath = self._abspath(relpath)
175
fp = open(abspath, 'ab')
176
# FIXME should we really be chmodding every time ? RBC 20060523
178
os.chmod(abspath, mode)
179
except (IOError, OSError),e:
180
self._translate_error(e, relpath)
181
# win32 workaround (tell on an unwritten file returns 0)
325
file_abspath, fd = self._get_append_file(relpath, mode=mode)
327
result = self._check_mode_and_size(file_abspath, fd, mode=mode)
328
self._pump_to_fd(f, fd)
333
def append_bytes(self, relpath, bytes, mode=None):
334
"""Append the text in the string into the final location."""
335
file_abspath, fd = self._get_append_file(relpath, mode=mode)
337
result = self._check_mode_and_size(file_abspath, fd, mode=mode)
343
def _pump_to_fd(self, fromfile, to_fd):
344
"""Copy contents of one file to another."""
347
b = fromfile.read(BUFSIZE)
187
352
def copy(self, rel_from, rel_to):
188
353
"""Copy the item at rel_from to the location at rel_to"""
317
class ScratchTransport(LocalTransport):
318
"""A transport that works in a temporary dir and cleans up after itself.
483
class EmulatedWin32LocalTransport(LocalTransport):
484
"""Special transport for testing Win32 [UNC] paths on non-windows"""
486
def __init__(self, base):
489
super(LocalTransport, self).__init__(base)
490
self._local_base = urlutils._win32_local_path_from_url(base)
492
def abspath(self, relpath):
493
assert isinstance(relpath, basestring), (type(relpath), relpath)
494
path = osutils.normpath(osutils.pathjoin(
495
self._local_base, urlutils.unescape(relpath)))
496
return urlutils._win32_local_path_to_url(path)
498
def clone(self, offset=None):
499
"""Return a new LocalTransport with root at self.base + offset
500
Because the local filesystem does not require a connection,
501
we can just return a new object.
504
return EmulatedWin32LocalTransport(self.base)
506
abspath = self.abspath(offset)
507
if abspath == 'file://':
508
# fix upwalk for UNC path
509
# when clone from //HOST/path updir recursively
510
# we should stop at least at //HOST part
512
return EmulatedWin32LocalTransport(abspath)
515
class LocalURLServer(Server):
516
"""A pretend server for local transports, using file:// urls.
320
The dir only exists for the lifetime of the Python object.
321
Obviously you should not put anything precious in it.
518
Of course no actual server is required to access the local filesystem, so
519
this just exists to tell the test code how to get to it.
324
def __init__(self, base=None):
326
base = tempfile.mkdtemp()
327
super(ScratchTransport, self).__init__(base)
330
rmtree(self.base, ignore_errors=True)
331
mutter("%r destroyed" % self)
334
class LocalRelpathServer(Server):
335
"""A pretend server for local transports, using relpaths."""
338
"""See Transport.Server.get_url."""
342
class LocalAbspathServer(Server):
343
"""A pretend server for local transports, using absolute paths."""
346
"""See Transport.Server.get_url."""
347
return os.path.abspath("")
350
class LocalURLServer(Server):
351
"""A pretend server for local transports, using file:// urls."""
523
"""Setup the server to service requests.
525
:param decorated_transport: ignored by this implementation.
353
528
def get_url(self):
354
529
"""See Transport.Server.get_url."""
added
removed
bzrlib/transport/local.py
