← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transport/local.py

  • Committer: John Arbash Meinel
  • Date: 2006-09-20 14:51:03 UTC
  • mfrom: (0.8.23 version_info)
  • mto: This revision was merged to the branch mainline in revision 2028.
  • Revision ID: john@arbash-meinel.com-20060920145103-02725c6d6c886040
[merge] version-info plugin, and cleanup for layout in bzr

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/transport/local.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
2
2
#
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
12
12
#
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Transport for the local filesystem.
18
18
 
19
19
This is a fairly thin wrapper on regular file IO.
20
20
"""
21
21
 
 
22
import errno
22
23
import os
 
24
import shutil
 
25
import sys
23
26
from stat import ST_MODE, S_ISDIR, ST_SIZE, S_IMODE
24
 
import sys
25
 
 
26
 
from bzrlib.lazy_import import lazy_import
27
 
lazy_import(globals(), """
28
 
import errno
29
 
import shutil
 
27
import tempfile
30
28
 
31
29
from bzrlib import (
32
30
    atomicfile,
33
31
    osutils,
34
32
    urlutils,
35
 
    symbol_versioning,
36
 
    transport,
37
33
    )
 
34
from bzrlib.osutils import (abspath, realpath, normpath, pathjoin, rename,
 
35
                            check_legal_path, rmtree)
 
36
from bzrlib.symbol_versioning import warn
38
37
from bzrlib.trace import mutter
39
 
from bzrlib.transport import LateReadError
40
 
""")
41
 
 
42
 
from bzrlib import transport
43
 
 
44
 
 
45
 
_append_flags = os.O_CREAT | os.O_APPEND | os.O_WRONLY | osutils.O_BINARY | osutils.O_NOINHERIT
46
 
_put_non_atomic_flags = os.O_CREAT | os.O_TRUNC | os.O_WRONLY | osutils.O_BINARY | osutils.O_NOINHERIT
47
 
 
48
 
 
49
 
class LocalTransport(transport.Transport):
 
38
from bzrlib.transport import Transport, Server
 
39
 
 
40
 
 
41
_append_flags = os.O_CREAT | os.O_APPEND | os.O_WRONLY | osutils.O_BINARY
 
42
_put_non_atomic_flags = os.O_CREAT | os.O_TRUNC | os.O_WRONLY | osutils.O_BINARY
 
43
 
 
44
 
 
45
class LocalTransport(Transport):
50
46
    """This is the transport agent for local filesystem access."""
51
47
 
52
48
    def __init__(self, base):
53
49
        """Set the base path where files will be stored."""
54
50
        if not base.startswith('file://'):
55
 
            symbol_versioning.warn(
56
 
                "Instantiating LocalTransport with a filesystem path"
 
51
            warn("Instantiating LocalTransport with a filesystem path"
57
52
                " is deprecated as of bzr 0.8."
58
53
                " Please use bzrlib.transport.get_transport()"
59
54
                " or pass in a file:// url.",
63
58
            base = urlutils.local_path_to_url(base)
64
59
        if base[-1] != '/':
65
60
            base = base + '/'
66
 
 
67
 
        # Special case : windows has no "root", but does have
68
 
        # multiple lettered drives inside it. #240910
69
 
        if sys.platform == 'win32' and base == 'file:///':
70
 
            base = ''
71
 
            self._local_base = ''
72
 
            super(LocalTransport, self).__init__(base)
73
 
            return
74
 
 
75
61
        super(LocalTransport, self).__init__(base)
76
62
        self._local_base = urlutils.local_path_from_url(base)
77
63
 
 
64
    def should_cache(self):
 
65
        return False
 
66
 
78
67
    def clone(self, offset=None):
79
68
        """Return a new LocalTransport with root at self.base + offset
80
 
        Because the local filesystem does not require a connection,
 
69
        Because the local filesystem does not require a connection, 
81
70
        we can just return a new object.
82
71
        """
83
72
        if offset is None:
84
73
            return LocalTransport(self.base)
85
74
        else:
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
91
 
                abspath = self.base
92
 
            return LocalTransport(abspath)
 
75
            return LocalTransport(self.abspath(offset))
93
76
 
94
77
    def _abspath(self, relative_reference):
95
78
        """Return a path for use in os calls.
105
88
    def abspath(self, relpath):
106
89
        """Return the full url to the given relative URL."""
107
90
        # TODO: url escape the result. RBC 20060523.
 
91
        assert isinstance(relpath, basestring), (type(relpath), relpath)
108
92
        # jam 20060426 Using normpath on the real path, because that ensures
109
93
        #       proper handling of stuff like
110
 
        path = osutils.normpath(osutils.pathjoin(
111
 
                    self._local_base, urlutils.unescape(relpath)))
112
 
        # on windows, our _local_base may or may not have a drive specified
113
 
        # (ie, it may be "/" or "c:/foo").
114
 
        # If 'relpath' is '/' we *always* get back an abspath without
115
 
        # the drive letter - but if our transport already has a drive letter,
116
 
        # we want our abspaths to have a drive letter too - so handle that
117
 
        # here.
118
 
        if (sys.platform == "win32" and self._local_base[1:2] == ":"
119
 
            and path == '/'):
120
 
            path = self._local_base[:3]
121
 
 
 
94
        path = normpath(pathjoin(self._local_base, urlutils.unescape(relpath)))
122
95
        return urlutils.local_path_to_url(path)
123
96
 
124
97
    def local_abspath(self, relpath):
127
100
        This function only exists for the LocalTransport, since it is
128
101
        the only one that has direct local access.
129
102
        This is mostly for stuff like WorkingTree which needs to know
130
 
        the local working directory.  The returned path will always contain
131
 
        forward slashes as the path separator, regardless of the platform.
132
 
 
 
103
        the local working directory.
 
104
        
133
105
        This function is quite expensive: it calls realpath which resolves
134
106
        symlinks.
135
107
        """
144
116
            abspath = u'.'
145
117
 
146
118
        return urlutils.file_relpath(
147
 
            urlutils.strip_trailing_slash(self.base),
 
119
            urlutils.strip_trailing_slash(self.base), 
148
120
            urlutils.strip_trailing_slash(abspath))
149
121
 
150
122
    def has(self, relpath):
155
127
 
156
128
        :param relpath: The relative path to the file
157
129
        """
158
 
        canonical_url = self.abspath(relpath)
159
 
        if canonical_url in transport._file_streams:
160
 
            transport._file_streams[canonical_url].flush()
161
130
        try:
162
131
            path = self._abspath(relpath)
163
 
            return osutils.open_file(path, 'rb')
 
132
            return open(path, 'rb')
164
133
        except (IOError, OSError),e:
165
 
            if e.errno == errno.EISDIR:
166
 
                return LateReadError(relpath)
167
134
            self._translate_error(e, path)
168
135
 
169
136
    def put_file(self, relpath, f, mode=None):
171
138
 
172
139
        :param relpath: Location to put the contents, relative to base.
173
140
        :param f:       File-like object.
174
 
        :param mode: The mode for the newly created file,
 
141
        :param mode: The mode for the newly created file, 
175
142
                     None means just use the default
176
143
        """
177
144
 
178
145
        path = relpath
179
146
        try:
180
147
            path = self._abspath(relpath)
181
 
            osutils.check_legal_path(path)
 
148
            check_legal_path(path)
182
149
            fp = atomicfile.AtomicFile(path, 'wb', new_mode=mode)
183
150
        except (IOError, OSError),e:
184
151
            self._translate_error(e, path)
185
152
        try:
186
 
            length = self._pump(f, fp)
 
153
            self._pump(f, fp)
187
154
            fp.commit()
188
155
        finally:
189
156
            fp.close()
190
 
        return length
191
157
 
192
158
    def put_bytes(self, relpath, bytes, mode=None):
193
159
        """Copy the string into the location.
199
165
        path = relpath
200
166
        try:
201
167
            path = self._abspath(relpath)
202
 
            osutils.check_legal_path(path)
 
168
            check_legal_path(path)
203
169
            fp = atomicfile.AtomicFile(path, 'wb', new_mode=mode)
204
170
        except (IOError, OSError),e:
205
171
            self._translate_error(e, path)
206
172
        try:
207
 
            if bytes:
208
 
                fp.write(bytes)
 
173
            fp.write(bytes)
209
174
            fp.commit()
210
175
        finally:
211
176
            fp.close()
286
251
    def put_bytes_non_atomic(self, relpath, bytes, mode=None,
287
252
                             create_parent_dir=False, dir_mode=None):
288
253
        def writer(fd):
289
 
            if bytes:
290
 
                os.write(fd, bytes)
 
254
            os.write(fd, bytes)
291
255
        self._put_non_atomic_helper(relpath, writer, mode=mode,
292
256
                                    create_parent_dir=create_parent_dir,
293
257
                                    dir_mode=dir_mode)
324
288
        """Create a directory at the given path."""
325
289
        self._mkdir(self._abspath(relpath), mode=mode)
326
290
 
327
 
    def open_write_stream(self, relpath, mode=None):
328
 
        """See Transport.open_write_stream."""
329
 
        # initialise the file
330
 
        self.put_bytes_non_atomic(relpath, "", mode=mode)
331
 
        abspath = self._abspath(relpath)
332
 
        handle = osutils.open_file(abspath, 'wb')
333
 
        if mode is not None:
334
 
            self._check_mode_and_size(abspath, handle.fileno(), mode)
335
 
        transport._file_streams[self.abspath(relpath)] = handle
336
 
        return transport.FileFileStream(self, relpath, handle)
337
 
 
338
291
    def _get_append_file(self, relpath, mode=None):
339
292
        """Call os.open() for the given relpath"""
340
293
        file_abspath = self._abspath(relpath)
372
325
        file_abspath, fd = self._get_append_file(relpath, mode=mode)
373
326
        try:
374
327
            result = self._check_mode_and_size(file_abspath, fd, mode=mode)
375
 
            if bytes:
376
 
                os.write(fd, bytes)
 
328
            os.write(fd, bytes)
377
329
        finally:
378
330
            os.close(fd)
379
331
        return result
399
351
 
400
352
    def rename(self, rel_from, rel_to):
401
353
        path_from = self._abspath(rel_from)
402
 
        path_to = self._abspath(rel_to)
403
354
        try:
404
 
            # *don't* call bzrlib.osutils.rename, because we want to
405
 
            # detect conflicting names on rename, and osutils.rename tries to
406
 
            # mask cross-platform differences there; however we do update the
407
 
            # exception to include the filenames
408
 
            os.rename(path_from, path_to)
 
355
            # *don't* call bzrlib.osutils.rename, because we want to 
 
356
            # detect errors on rename
 
357
            os.rename(path_from, self._abspath(rel_to))
409
358
        except (IOError, OSError),e:
410
359
            # TODO: What about path_to?
411
 
            self._translate_error(
412
 
                osutils._add_rename_error_details(e, path_from, path_to),
413
 
                path_from)
 
360
            self._translate_error(e, path_from)
414
361
 
415
362
    def move(self, rel_from, rel_to):
416
363
        """Move the item at rel_from to the location at rel_to"""
419
366
 
420
367
        try:
421
368
            # this version will delete the destination if necessary
422
 
            osutils.rename(path_from, path_to)
 
369
            rename(path_from, path_to)
423
370
        except (IOError, OSError),e:
424
371
            # TODO: What about path_to?
425
372
            self._translate_error(e, path_from)
433
380
        except (IOError, OSError),e:
434
381
            self._translate_error(e, path)
435
382
 
436
 
    def external_url(self):
437
 
        """See bzrlib.transport.Transport.external_url."""
438
 
        # File URL's are externally usable.
439
 
        return self.base
440
 
 
441
383
    def copy_to(self, relpaths, other, mode=None, pb=None):
442
384
        """Copy a set of entries from self into another Transport.
443
385
 
486
428
        path = relpath
487
429
        try:
488
430
            path = self._abspath(relpath)
489
 
            return os.lstat(path)
 
431
            return os.stat(path)
490
432
        except (IOError, OSError),e:
491
433
            self._translate_error(e, path)
492
434
 
520
462
        except (IOError, OSError),e:
521
463
            self._translate_error(e, path)
522
464
 
523
 
    if osutils.host_os_dereferences_symlinks():
524
 
        def readlink(self, relpath):
525
 
            """See Transport.readlink."""
526
 
            return osutils.readlink(self._abspath(relpath))
527
 
 
528
 
    if osutils.hardlinks_good():
529
 
        def hardlink(self, source, link_name):
530
 
            """See Transport.link."""
531
 
            try:
532
 
                os.link(self._abspath(source), self._abspath(link_name))
533
 
            except (IOError, OSError), e:
534
 
                self._translate_error(e, source)
535
 
 
536
 
    if osutils.has_symlinks():
537
 
        def symlink(self, source, link_name):
538
 
            """See Transport.symlink."""
539
 
            abs_link_dirpath = urlutils.dirname(self.abspath(link_name))
540
 
            source_rel = urlutils.file_relpath(
541
 
                urlutils.strip_trailing_slash(abs_link_dirpath),
542
 
                urlutils.strip_trailing_slash(self.abspath(source))
543
 
            )
544
 
 
545
 
            try:
546
 
                os.symlink(source_rel, self._abspath(link_name))
547
 
            except (IOError, OSError), e:
548
 
                self._translate_error(e, source_rel)
549
 
 
550
465
    def _can_roundtrip_unix_modebits(self):
551
466
        if sys.platform == 'win32':
552
467
            # anyone else?
555
470
            return True
556
471
 
557
472
 
558
 
class EmulatedWin32LocalTransport(LocalTransport):
559
 
    """Special transport for testing Win32 [UNC] paths on non-windows"""
560
 
 
561
 
    def __init__(self, base):
562
 
        if base[-1] != '/':
563
 
            base = base + '/'
564
 
        super(LocalTransport, self).__init__(base)
565
 
        self._local_base = urlutils._win32_local_path_from_url(base)
566
 
 
567
 
    def abspath(self, relpath):
568
 
        path = osutils.normpath(osutils.pathjoin(
569
 
                    self._local_base, urlutils.unescape(relpath)))
570
 
        return urlutils._win32_local_path_to_url(path)
571
 
 
572
 
    def clone(self, offset=None):
573
 
        """Return a new LocalTransport with root at self.base + offset
574
 
        Because the local filesystem does not require a connection,
575
 
        we can just return a new object.
576
 
        """
577
 
        if offset is None:
578
 
            return EmulatedWin32LocalTransport(self.base)
579
 
        else:
580
 
            abspath = self.abspath(offset)
581
 
            if abspath == 'file://':
582
 
                # fix upwalk for UNC path
583
 
                # when clone from //HOST/path updir recursively
584
 
                # we should stop at least at //HOST part
585
 
                abspath = self.base
586
 
            return EmulatedWin32LocalTransport(abspath)
 
473
class LocalRelpathServer(Server):
 
474
    """A pretend server for local transports, using relpaths."""
 
475
 
 
476
    def get_url(self):
 
477
        """See Transport.Server.get_url."""
 
478
        return "."
 
479
 
 
480
 
 
481
class LocalAbspathServer(Server):
 
482
    """A pretend server for local transports, using absolute paths."""
 
483
 
 
484
    def get_url(self):
 
485
        """See Transport.Server.get_url."""
 
486
        return os.path.abspath("")
 
487
 
 
488
 
 
489
class LocalURLServer(Server):
 
490
    """A pretend server for local transports, using file:// urls."""
 
491
 
 
492
    def get_url(self):
 
493
        """See Transport.Server.get_url."""
 
494
        return urlutils.local_path_to_url('')
587
495
 
588
496
 
589
497
def get_test_permutations():
590
498
    """Return the permutations to be used in testing."""
591
 
    from bzrlib.tests import test_server
592
 
    return [(LocalTransport, test_server.LocalURLServer),]
 
499
    return [(LocalTransport, LocalRelpathServer),
 
500
            (LocalTransport, LocalAbspathServer),
 
501
            (LocalTransport, LocalURLServer),
 
502
            ]