/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/osutils.py

  • Committer: Ian Clatworthy
  • Date: 2010-02-19 05:08:31 UTC
  • mfrom: (4797.22.2 whats-new)
  • mto: (4797.2.20 2.1)
  • mto: This revision was merged to the branch mainline in revision 5055.
  • Revision ID: ian.clatworthy@canonical.com-20100219050831-9mpmhon76n6omda1
(igc) What's New in Bazaar 2.1 document

Show diffs side-by-side

added added

removed removed

Lines of Context:
17
17
import os
18
18
import re
19
19
import stat
20
 
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
 
20
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
 
21
                  S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
21
22
import sys
22
23
import time
23
 
import codecs
 
24
import warnings
24
25
 
25
26
from bzrlib.lazy_import import lazy_import
26
27
lazy_import(globals(), """
 
28
import codecs
27
29
from datetime import datetime
28
30
import errno
29
 
import getpass
30
31
from ntpath import (abspath as _nt_abspath,
31
32
                    join as _nt_join,
32
33
                    normpath as _nt_normpath,
38
39
from shutil import (
39
40
    rmtree,
40
41
    )
41
 
import socket
 
42
import signal
42
43
import subprocess
43
44
import tempfile
44
45
from tempfile import (
49
50
from bzrlib import (
50
51
    cache_utf8,
51
52
    errors,
52
 
    trace,
53
53
    win32utils,
54
54
    )
55
55
""")
56
56
 
57
 
from bzrlib.symbol_versioning import (
58
 
    deprecated_function,
59
 
    deprecated_in,
60
 
    )
61
 
 
62
57
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
63
58
# of 2.5
64
59
if sys.version_info < (2, 5):
90
85
# be opened in binary mode, rather than text mode.
91
86
# On other platforms, O_BINARY doesn't exist, because
92
87
# they always open in binary mode, so it is okay to
93
 
# OR with 0 on those platforms.
94
 
# O_NOINHERIT and O_TEXT exists only on win32 too.
 
88
# OR with 0 on those platforms
95
89
O_BINARY = getattr(os, 'O_BINARY', 0)
96
 
O_TEXT = getattr(os, 'O_TEXT', 0)
97
 
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
98
90
 
99
91
 
100
92
def get_unicode_argv():
187
179
    try:
188
180
        return _kind_marker_map[kind]
189
181
    except KeyError:
190
 
        # Slightly faster than using .get(, '') when the common case is that
191
 
        # kind will be found
192
 
        return ''
 
182
        raise errors.BzrError('invalid file kind %r' % kind)
193
183
 
194
184
 
195
185
lexists = getattr(os.path, 'lexists', None)
361
351
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
362
352
 
363
353
 
364
 
def _add_rename_error_details(e, old, new):
365
 
    new_e = OSError(e.errno, "failed to rename %s to %s: %s"
366
 
        % (old, new, e.strerror))
367
 
    new_e.filename = old
368
 
    new_e.to_filename = new
369
 
    return new_e
370
 
 
371
 
 
372
354
def _win32_rename(old, new):
373
355
    """We expect to be able to atomically replace 'new' with old.
374
356
 
376
358
    and then deleted.
377
359
    """
378
360
    try:
379
 
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
 
361
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
380
362
    except OSError, e:
381
363
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
382
364
            # If we try to rename a non-existant file onto cwd, we get
387
369
        raise
388
370
 
389
371
 
390
 
def _wrapped_rename(old, new):
391
 
    """Rename a file or directory"""
392
 
    try:
393
 
        os.rename(old, new)
394
 
    except (IOError, OSError), e:
395
 
        # this is eventually called by all rename-like functions, so should 
396
 
        # catch all of them
397
 
        raise _add_rename_error_details(e, old, new)
398
 
 
399
 
 
400
372
def _mac_getcwd():
401
373
    return unicodedata.normalize('NFC', os.getcwdu())
402
374
 
407
379
realpath = _posix_realpath
408
380
pathjoin = os.path.join
409
381
normpath = os.path.normpath
410
 
rename = _wrapped_rename # overridden below on win32
411
382
getcwd = os.getcwdu
 
383
rename = os.rename
412
384
dirname = os.path.dirname
413
385
basename = os.path.basename
414
386
split = os.path.split
689
661
def sha_file_by_name(fname):
690
662
    """Calculate the SHA1 of a file by reading the full text"""
691
663
    s = sha()
692
 
    f = os.open(fname, os.O_RDONLY | O_BINARY | O_NOINHERIT)
 
664
    f = os.open(fname, os.O_RDONLY | O_BINARY)
693
665
    try:
694
666
        while True:
695
667
            b = os.read(f, 1<<16)
1148
1120
 
1149
1121
 
1150
1122
def relpath(base, path):
1151
 
    """Return path relative to base, or raise PathNotChild exception.
 
1123
    """Return path relative to base, or raise exception.
1152
1124
 
1153
1125
    The path may be either an absolute path or a path relative to the
1154
1126
    current working directory.
1156
1128
    os.path.commonprefix (python2.4) has a bad bug that it works just
1157
1129
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
1158
1130
    avoids that problem.
1159
 
 
1160
 
    NOTE: `base` should not have a trailing slash otherwise you'll get
1161
 
    PathNotChild exceptions regardless of `path`.
1162
1131
    """
1163
1132
 
1164
1133
    if len(base) < MIN_ABS_PATHLENGTH:
1375
1344
    normalized_filename = _inaccessible_normalized_filename
1376
1345
 
1377
1346
 
1378
 
def set_signal_handler(signum, handler, restart_syscall=True):
1379
 
    """A wrapper for signal.signal that also calls siginterrupt(signum, False)
1380
 
    on platforms that support that.
1381
 
 
1382
 
    :param restart_syscall: if set, allow syscalls interrupted by a signal to
1383
 
        automatically restart (by calling `signal.siginterrupt(signum,
1384
 
        False)`).  May be ignored if the feature is not available on this
1385
 
        platform or Python version.
1386
 
    """
1387
 
    try:
1388
 
        import signal
1389
 
        siginterrupt = signal.siginterrupt
1390
 
    except ImportError:
1391
 
        # This python implementation doesn't provide signal support, hence no
1392
 
        # handler exists
1393
 
        return None
1394
 
    except AttributeError:
1395
 
        # siginterrupt doesn't exist on this platform, or for this version
1396
 
        # of Python.
1397
 
        siginterrupt = lambda signum, flag: None
1398
 
    if restart_syscall:
1399
 
        def sig_handler(*args):
1400
 
            # Python resets the siginterrupt flag when a signal is
1401
 
            # received.  <http://bugs.python.org/issue8354>
1402
 
            # As a workaround for some cases, set it back the way we want it.
1403
 
            siginterrupt(signum, False)
1404
 
            # Now run the handler function passed to set_signal_handler.
1405
 
            handler(*args)
1406
 
    else:
1407
 
        sig_handler = handler
1408
 
    old_handler = signal.signal(signum, sig_handler)
1409
 
    if restart_syscall:
1410
 
        siginterrupt(signum, False)
1411
 
    return old_handler
1412
 
 
1413
 
 
1414
1347
default_terminal_width = 80
1415
1348
"""The default terminal width for ttys.
1416
1349
 
1507
1440
 
1508
1441
 
1509
1442
_registered_sigwinch = False
 
1443
 
1510
1444
def watch_sigwinch():
1511
 
    """Register for SIGWINCH, once and only once.
1512
 
 
1513
 
    Do nothing if the signal module is not available.
1514
 
    """
 
1445
    """Register for SIGWINCH, once and only once."""
1515
1446
    global _registered_sigwinch
1516
1447
    if not _registered_sigwinch:
1517
 
        try:
1518
 
            import signal
1519
 
            if getattr(signal, "SIGWINCH", None) is not None:
1520
 
                set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
1521
 
        except ImportError:
1522
 
            # python doesn't provide signal support, nothing we can do about it
 
1448
        if sys.platform == 'win32':
 
1449
            # Martin (gz) mentioned WINDOW_BUFFER_SIZE_RECORD from
 
1450
            # ReadConsoleInput but I've no idea how to plug that in
 
1451
            # the current design -- vila 20091216
1523
1452
            pass
 
1453
        else:
 
1454
            signal.signal(signal.SIGWINCH, _terminal_size_changed)
1524
1455
        _registered_sigwinch = True
1525
1456
 
1526
1457
 
1847
1778
            real_handlers[kind](abspath, relpath)
1848
1779
 
1849
1780
 
1850
 
def copy_ownership_from_path(dst, src=None):
1851
 
    """Copy usr/grp ownership from src file/dir to dst file/dir.
1852
 
 
1853
 
    If src is None, the containing directory is used as source. If chown
1854
 
    fails, the error is ignored and a warning is printed.
1855
 
    """
1856
 
    chown = getattr(os, 'chown', None)
1857
 
    if chown is None:
1858
 
        return
1859
 
 
1860
 
    if src == None:
1861
 
        src = os.path.dirname(dst)
1862
 
        if src == '':
1863
 
            src = '.'
1864
 
 
1865
 
    try:
1866
 
        s = os.stat(src)
1867
 
        chown(dst, s.st_uid, s.st_gid)
1868
 
    except OSError, e:
1869
 
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
1870
 
 
1871
 
 
1872
1781
def path_prefix_key(path):
1873
1782
    """Generate a prefix-order path key for path.
1874
1783
 
1974
1883
        return socket.gethostname().decode(get_user_encoding())
1975
1884
 
1976
1885
 
1977
 
# We must not read/write any more than 64k at a time from/to a socket so we
1978
 
# don't risk "no buffer space available" errors on some platforms.  Windows in
1979
 
# particular is likely to throw WSAECONNABORTED or WSAENOBUFS if given too much
1980
 
# data at once.
1981
 
MAX_SOCKET_CHUNK = 64 * 1024
1982
 
 
1983
 
def read_bytes_from_socket(sock, report_activity=None,
1984
 
        max_read_size=MAX_SOCKET_CHUNK):
1985
 
    """Read up to max_read_size of bytes from sock and notify of progress.
1986
 
 
1987
 
    Translates "Connection reset by peer" into file-like EOF (return an
1988
 
    empty string rather than raise an error), and repeats the recv if
1989
 
    interrupted by a signal.
1990
 
    """
1991
 
    while 1:
1992
 
        try:
1993
 
            bytes = sock.recv(max_read_size)
1994
 
        except socket.error, e:
1995
 
            eno = e.args[0]
1996
 
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
1997
 
                # The connection was closed by the other side.  Callers expect
1998
 
                # an empty string to signal end-of-stream.
1999
 
                return ""
2000
 
            elif eno == errno.EINTR:
2001
 
                # Retry the interrupted recv.
2002
 
                continue
2003
 
            raise
2004
 
        else:
2005
 
            if report_activity is not None:
2006
 
                report_activity(len(bytes), 'read')
2007
 
            return bytes
2008
 
 
2009
 
 
2010
 
def recv_all(socket, count):
 
1886
def recv_all(socket, bytes):
2011
1887
    """Receive an exact number of bytes.
2012
1888
 
2013
1889
    Regular Socket.recv() may return less than the requested number of bytes,
2014
 
    depending on what's in the OS buffer.  MSG_WAITALL is not available
 
1890
    dependning on what's in the OS buffer.  MSG_WAITALL is not available
2015
1891
    on all platforms, but this should work everywhere.  This will return
2016
1892
    less than the requested amount if the remote end closes.
2017
1893
 
2018
1894
    This isn't optimized and is intended mostly for use in testing.
2019
1895
    """
2020
1896
    b = ''
2021
 
    while len(b) < count:
2022
 
        new = read_bytes_from_socket(socket, None, count - len(b))
 
1897
    while len(b) < bytes:
 
1898
        new = until_no_eintr(socket.recv, bytes - len(b))
2023
1899
        if new == '':
2024
1900
            break # eof
2025
1901
        b += new
2026
1902
    return b
2027
1903
 
2028
1904
 
2029
 
def send_all(sock, bytes, report_activity=None):
 
1905
def send_all(socket, bytes, report_activity=None):
2030
1906
    """Send all bytes on a socket.
2031
 
 
2032
 
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2033
 
    some platforms, and catches EINTR which may be thrown if the send is
2034
 
    interrupted by a signal.
2035
 
 
2036
 
    This is preferred to socket.sendall(), because it avoids portability bugs
2037
 
    and provides activity reporting.
2038
 
 
 
1907
 
 
1908
    Regular socket.sendall() can give socket error 10053 on Windows.  This
 
1909
    implementation sends no more than 64k at a time, which avoids this problem.
 
1910
 
2039
1911
    :param report_activity: Call this as bytes are read, see
2040
1912
        Transport._report_activity
2041
1913
    """
2042
 
    sent_total = 0
2043
 
    byte_count = len(bytes)
2044
 
    while sent_total < byte_count:
2045
 
        try:
2046
 
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2047
 
        except socket.error, e:
2048
 
            if e.args[0] != errno.EINTR:
2049
 
                raise
2050
 
        else:
2051
 
            sent_total += sent
2052
 
            report_activity(sent, 'write')
 
1914
    chunk_size = 2**16
 
1915
    for pos in xrange(0, len(bytes), chunk_size):
 
1916
        block = bytes[pos:pos+chunk_size]
 
1917
        if report_activity is not None:
 
1918
            report_activity(len(block), 'write')
 
1919
        until_no_eintr(socket.sendall, block)
2053
1920
 
2054
1921
 
2055
1922
def dereference_path(path):
2126
1993
 
2127
1994
 
2128
1995
def until_no_eintr(f, *a, **kw):
2129
 
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2130
 
    
2131
 
    WARNING: you must be certain that it is safe to retry the call repeatedly
2132
 
    if EINTR does occur.  This is typically only true for low-level operations
2133
 
    like os.read.  If in any doubt, don't use this.
2134
 
 
2135
 
    Keep in mind that this is not a complete solution to EINTR.  There is
2136
 
    probably code in the Python standard library and other dependencies that
2137
 
    may encounter EINTR if a signal arrives (and there is signal handler for
2138
 
    that signal).  So this function can reduce the impact for IO that bzrlib
2139
 
    directly controls, but it is not a complete solution.
2140
 
    """
 
1996
    """Run f(*a, **kw), retrying if an EINTR error occurs."""
2141
1997
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
2142
1998
    while True:
2143
1999
        try:
2147
2003
                continue
2148
2004
            raise
2149
2005
 
2150
 
 
2151
2006
def re_compile_checked(re_string, flags=0, where=""):
2152
2007
    """Return a compiled re, or raise a sensible error.
2153
2008
 
2260
2115
        else:
2261
2116
            data, _ = self.encode(object, self.errors)
2262
2117
            self.stream.write(data)
2263
 
 
2264
 
if sys.platform == 'win32':
2265
 
    def open_file(filename, mode='r', bufsize=-1):
2266
 
        """This function is used to override the ``open`` builtin.
2267
 
        
2268
 
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2269
 
        child processes.  Deleting or renaming a closed file opened with this
2270
 
        function is not blocking child processes.
2271
 
        """
2272
 
        writing = 'w' in mode
2273
 
        appending = 'a' in mode
2274
 
        updating = '+' in mode
2275
 
        binary = 'b' in mode
2276
 
 
2277
 
        flags = O_NOINHERIT
2278
 
        # see http://msdn.microsoft.com/en-us/library/yeby3zcb%28VS.71%29.aspx
2279
 
        # for flags for each modes.
2280
 
        if binary:
2281
 
            flags |= O_BINARY
2282
 
        else:
2283
 
            flags |= O_TEXT
2284
 
 
2285
 
        if writing:
2286
 
            if updating:
2287
 
                flags |= os.O_RDWR
2288
 
            else:
2289
 
                flags |= os.O_WRONLY
2290
 
            flags |= os.O_CREAT | os.O_TRUNC
2291
 
        elif appending:
2292
 
            if updating:
2293
 
                flags |= os.O_RDWR
2294
 
            else:
2295
 
                flags |= os.O_WRONLY
2296
 
            flags |= os.O_CREAT | os.O_APPEND
2297
 
        else: #reading
2298
 
            if updating:
2299
 
                flags |= os.O_RDWR
2300
 
            else:
2301
 
                flags |= os.O_RDONLY
2302
 
 
2303
 
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2304
 
else:
2305
 
    open_file = open
2306
 
 
2307
 
 
2308
 
def getuser_unicode():
2309
 
    """Return the username as unicode.
2310
 
    """
2311
 
    try:
2312
 
        user_encoding = get_user_encoding()
2313
 
        username = getpass.getuser().decode(user_encoding)
2314
 
    except UnicodeDecodeError:
2315
 
        raise errors.BzrError("Can't decode username as %s." % \
2316
 
                user_encoding)
2317
 
    return username