/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/transport/local.py

  • Committer: Martin Pool
  • Date: 2007-09-18 04:21:20 UTC
  • mto: This revision was merged to the branch mainline in revision 2831.
  • Revision ID: mbp@sourcefrog.net-20070918042120-wg39u5k1itshbsks
Better explanation of deprecation

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
39
39
from bzrlib.transport import LateReadError
40
40
""")
41
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):
 
42
from bzrlib.transport import Transport, Server
 
43
 
 
44
 
 
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
 
47
 
 
48
 
 
49
class LocalTransport(Transport):
50
50
    """This is the transport agent for local filesystem access."""
51
51
 
52
52
    def __init__(self, base):
63
63
            base = urlutils.local_path_to_url(base)
64
64
        if base[-1] != '/':
65
65
            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
66
        super(LocalTransport, self).__init__(base)
76
67
        self._local_base = urlutils.local_path_from_url(base)
77
68
 
78
69
    def clone(self, offset=None):
79
70
        """Return a new LocalTransport with root at self.base + offset
80
 
        Because the local filesystem does not require a connection,
 
71
        Because the local filesystem does not require a connection, 
81
72
        we can just return a new object.
82
73
        """
83
74
        if offset is None:
105
96
    def abspath(self, relpath):
106
97
        """Return the full url to the given relative URL."""
107
98
        # TODO: url escape the result. RBC 20060523.
 
99
        assert isinstance(relpath, basestring), (type(relpath), relpath)
108
100
        # jam 20060426 Using normpath on the real path, because that ensures
109
101
        #       proper handling of stuff like
110
102
        path = osutils.normpath(osutils.pathjoin(
111
103
                    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
 
 
122
104
        return urlutils.local_path_to_url(path)
123
105
 
124
106
    def local_abspath(self, relpath):
127
109
        This function only exists for the LocalTransport, since it is
128
110
        the only one that has direct local access.
129
111
        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
 
 
 
112
        the local working directory.
 
113
        
133
114
        This function is quite expensive: it calls realpath which resolves
134
115
        symlinks.
135
116
        """
160
141
            transport._file_streams[canonical_url].flush()
161
142
        try:
162
143
            path = self._abspath(relpath)
163
 
            return osutils.open_file(path, 'rb')
 
144
            return open(path, 'rb')
164
145
        except (IOError, OSError),e:
165
146
            if e.errno == errno.EISDIR:
166
147
                return LateReadError(relpath)
171
152
 
172
153
        :param relpath: Location to put the contents, relative to base.
173
154
        :param f:       File-like object.
174
 
        :param mode: The mode for the newly created file,
 
155
        :param mode: The mode for the newly created file, 
175
156
                     None means just use the default
176
157
        """
177
158
 
183
164
        except (IOError, OSError),e:
184
165
            self._translate_error(e, path)
185
166
        try:
186
 
            length = self._pump(f, fp)
 
167
            self._pump(f, fp)
187
168
            fp.commit()
188
169
        finally:
189
170
            fp.close()
190
 
        return length
191
171
 
192
172
    def put_bytes(self, relpath, bytes, mode=None):
193
173
        """Copy the string into the location.
204
184
        except (IOError, OSError),e:
205
185
            self._translate_error(e, path)
206
186
        try:
207
 
            if bytes:
208
 
                fp.write(bytes)
 
187
            fp.write(bytes)
209
188
            fp.commit()
210
189
        finally:
211
190
            fp.close()
286
265
    def put_bytes_non_atomic(self, relpath, bytes, mode=None,
287
266
                             create_parent_dir=False, dir_mode=None):
288
267
        def writer(fd):
289
 
            if bytes:
290
 
                os.write(fd, bytes)
 
268
            os.write(fd, bytes)
291
269
        self._put_non_atomic_helper(relpath, writer, mode=mode,
292
270
                                    create_parent_dir=create_parent_dir,
293
271
                                    dir_mode=dir_mode)
328
306
        """See Transport.open_write_stream."""
329
307
        # initialise the file
330
308
        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)
 
309
        handle = open(self._abspath(relpath), 'wb')
335
310
        transport._file_streams[self.abspath(relpath)] = handle
336
311
        return transport.FileFileStream(self, relpath, handle)
337
312
 
372
347
        file_abspath, fd = self._get_append_file(relpath, mode=mode)
373
348
        try:
374
349
            result = self._check_mode_and_size(file_abspath, fd, mode=mode)
375
 
            if bytes:
376
 
                os.write(fd, bytes)
 
350
            os.write(fd, bytes)
377
351
        finally:
378
352
            os.close(fd)
379
353
        return result
399
373
 
400
374
    def rename(self, rel_from, rel_to):
401
375
        path_from = self._abspath(rel_from)
402
 
        path_to = self._abspath(rel_to)
403
376
        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)
 
377
            # *don't* call bzrlib.osutils.rename, because we want to 
 
378
            # detect errors on rename
 
379
            os.rename(path_from, self._abspath(rel_to))
409
380
        except (IOError, OSError),e:
410
381
            # TODO: What about path_to?
411
 
            self._translate_error(
412
 
                osutils._add_rename_error_details(e, path_from, path_to),
413
 
                path_from)
 
382
            self._translate_error(e, path_from)
414
383
 
415
384
    def move(self, rel_from, rel_to):
416
385
        """Move the item at rel_from to the location at rel_to"""
486
455
        path = relpath
487
456
        try:
488
457
            path = self._abspath(relpath)
489
 
            return os.lstat(path)
 
458
            return os.stat(path)
490
459
        except (IOError, OSError),e:
491
460
            self._translate_error(e, path)
492
461
 
520
489
        except (IOError, OSError),e:
521
490
            self._translate_error(e, path)
522
491
 
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
492
    def _can_roundtrip_unix_modebits(self):
551
493
        if sys.platform == 'win32':
552
494
            # anyone else?
565
507
        self._local_base = urlutils._win32_local_path_from_url(base)
566
508
 
567
509
    def abspath(self, relpath):
 
510
        assert isinstance(relpath, basestring), (type(relpath), relpath)
568
511
        path = osutils.normpath(osutils.pathjoin(
569
512
                    self._local_base, urlutils.unescape(relpath)))
570
513
        return urlutils._win32_local_path_to_url(path)
571
514
 
572
515
    def clone(self, offset=None):
573
516
        """Return a new LocalTransport with root at self.base + offset
574
 
        Because the local filesystem does not require a connection,
 
517
        Because the local filesystem does not require a connection, 
575
518
        we can just return a new object.
576
519
        """
577
520
        if offset is None:
586
529
            return EmulatedWin32LocalTransport(abspath)
587
530
 
588
531
 
 
532
class LocalURLServer(Server):
 
533
    """A pretend server for local transports, using file:// urls.
 
534
    
 
535
    Of course no actual server is required to access the local filesystem, so
 
536
    this just exists to tell the test code how to get to it.
 
537
    """
 
538
 
 
539
    def setUp(self):
 
540
        """Setup the server to service requests.
 
541
        
 
542
        :param decorated_transport: ignored by this implementation.
 
543
        """
 
544
 
 
545
    def get_url(self):
 
546
        """See Transport.Server.get_url."""
 
547
        return urlutils.local_path_to_url('')
 
548
 
 
549
 
589
550
def get_test_permutations():
590
551
    """Return the permutations to be used in testing."""
591
 
    from bzrlib.tests import test_server
592
 
    return [(LocalTransport, test_server.LocalURLServer),]
 
552
    return [
 
553
            (LocalTransport, LocalURLServer),
 
554
            ]