~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Robert Collins
  • Date: 2010-02-27 12:27:33 UTC
  • mto: This revision was merged to the branch mainline in revision 5061.
  • Revision ID: robertc@robertcollins.net-20100227122733-2o3me3fkk3pk36ns
``bzrlib.branchbuilder.BranchBuilder.build_snapshot`` now accepts a
``message_callback`` in the same way that commit does. (Robert Collins)

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