/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

Merge 2.1.1, especially the fetch format warning, back to trunk

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(), """
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,
 
53
    win32utils,
52
54
    trace,
53
 
    win32utils,
54
55
    )
 
56
 
55
57
""")
56
58
 
57
 
from bzrlib.symbol_versioning import (
58
 
    deprecated_function,
59
 
    deprecated_in,
60
 
    )
61
 
 
62
59
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
63
60
# of 2.5
64
61
if sys.version_info < (2, 5):
361
358
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
362
359
 
363
360
 
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
361
def _win32_rename(old, new):
373
362
    """We expect to be able to atomically replace 'new' with old.
374
363
 
376
365
    and then deleted.
377
366
    """
378
367
    try:
379
 
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
 
368
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
380
369
    except OSError, e:
381
370
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
382
371
            # If we try to rename a non-existant file onto cwd, we get
387
376
        raise
388
377
 
389
378
 
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
379
def _mac_getcwd():
401
380
    return unicodedata.normalize('NFC', os.getcwdu())
402
381
 
407
386
realpath = _posix_realpath
408
387
pathjoin = os.path.join
409
388
normpath = os.path.normpath
410
 
rename = _wrapped_rename # overridden below on win32
411
389
getcwd = os.getcwdu
 
390
rename = os.rename
412
391
dirname = os.path.dirname
413
392
basename = os.path.basename
414
393
split = os.path.split
1148
1127
 
1149
1128
 
1150
1129
def relpath(base, path):
1151
 
    """Return path relative to base, or raise PathNotChild exception.
 
1130
    """Return path relative to base, or raise exception.
1152
1131
 
1153
1132
    The path may be either an absolute path or a path relative to the
1154
1133
    current working directory.
1156
1135
    os.path.commonprefix (python2.4) has a bad bug that it works just
1157
1136
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
1158
1137
    avoids that problem.
1159
 
 
1160
 
    NOTE: `base` should not have a trailing slash otherwise you'll get
1161
 
    PathNotChild exceptions regardless of `path`.
1162
1138
    """
1163
1139
 
1164
1140
    if len(base) < MIN_ABS_PATHLENGTH:
1384
1360
        False)`).  May be ignored if the feature is not available on this
1385
1361
        platform or Python version.
1386
1362
    """
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
 
1363
    old_handler = signal.signal(signum, handler)
1398
1364
    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.
 
1365
        try:
 
1366
            siginterrupt = signal.siginterrupt
 
1367
        except AttributeError: # siginterrupt doesn't exist on this platform, or for this version of
 
1368
            # Python.
 
1369
            pass
 
1370
        else:
1403
1371
            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
1372
    return old_handler
1412
1373
 
1413
1374
 
1507
1468
 
1508
1469
 
1509
1470
_registered_sigwinch = False
 
1471
 
1510
1472
def watch_sigwinch():
1511
 
    """Register for SIGWINCH, once and only once.
1512
 
 
1513
 
    Do nothing if the signal module is not available.
1514
 
    """
 
1473
    """Register for SIGWINCH, once and only once."""
1515
1474
    global _registered_sigwinch
1516
1475
    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
 
1476
        if sys.platform == 'win32':
 
1477
            # Martin (gz) mentioned WINDOW_BUFFER_SIZE_RECORD from
 
1478
            # ReadConsoleInput but I've no idea how to plug that in
 
1479
            # the current design -- vila 20091216
1523
1480
            pass
 
1481
        else:
 
1482
            set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
1524
1483
        _registered_sigwinch = True
1525
1484
 
1526
1485
 
1847
1806
            real_handlers[kind](abspath, relpath)
1848
1807
 
1849
1808
 
1850
 
def copy_ownership_from_path(dst, src=None):
 
1809
def copy_ownership(dst, src=None):
1851
1810
    """Copy usr/grp ownership from src file/dir to dst file/dir.
1852
1811
 
1853
1812
    If src is None, the containing directory is used as source. If chown
1854
1813
    fails, the error is ignored and a warning is printed.
1855
1814
    """
1856
 
    chown = getattr(os, 'chown', None)
1857
 
    if chown is None:
1858
 
        return
 
1815
    has_chown = getattr(os, 'chown')
 
1816
    if has_chown is None: return
1859
1817
 
1860
1818
    if src == None:
1861
1819
        src = os.path.dirname(dst)
1864
1822
 
1865
1823
    try:
1866
1824
        s = os.stat(src)
1867
 
        chown(dst, s.st_uid, s.st_gid)
 
1825
        os.chown(dst, s.st_uid, s.st_gid)
1868
1826
    except OSError, e:
1869
1827
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
1870
1828
 
1871
1829
 
 
1830
def mkdir_with_ownership(path, ownership_src=None):
 
1831
    """Create the directory 'path' with specified ownership.
 
1832
 
 
1833
    If ownership_src is given, copies (chown) usr/grp ownership
 
1834
    from 'ownership_src' to 'path'. If ownership_src is None, use the
 
1835
    containing dir ownership.
 
1836
    """
 
1837
    os.mkdir(path)
 
1838
    copy_ownership(path, ownership_src)
 
1839
 
 
1840
 
 
1841
def open_with_ownership(filename, mode='r', bufsize=-1, ownership_src=None):
 
1842
    """Open the file 'filename' with the specified ownership.
 
1843
 
 
1844
    If ownership_src is specified, copy usr/grp ownership from ownership_src
 
1845
    to filename. If ownership_src is None, copy ownership from containing
 
1846
    directory.
 
1847
    Returns the opened file object.
 
1848
    """
 
1849
    f = open(filename, mode, bufsize)
 
1850
    copy_ownership(filename, ownership_src)
 
1851
    return f
 
1852
 
 
1853
 
1872
1854
def path_prefix_key(path):
1873
1855
    """Generate a prefix-order path key for path.
1874
1856
 
1974
1956
        return socket.gethostname().decode(get_user_encoding())
1975
1957
 
1976
1958
 
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):
 
1959
def recv_all(socket, bytes):
2011
1960
    """Receive an exact number of bytes.
2012
1961
 
2013
1962
    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
 
1963
    dependning on what's in the OS buffer.  MSG_WAITALL is not available
2015
1964
    on all platforms, but this should work everywhere.  This will return
2016
1965
    less than the requested amount if the remote end closes.
2017
1966
 
2018
1967
    This isn't optimized and is intended mostly for use in testing.
2019
1968
    """
2020
1969
    b = ''
2021
 
    while len(b) < count:
2022
 
        new = read_bytes_from_socket(socket, None, count - len(b))
 
1970
    while len(b) < bytes:
 
1971
        new = until_no_eintr(socket.recv, bytes - len(b))
2023
1972
        if new == '':
2024
1973
            break # eof
2025
1974
        b += new
2026
1975
    return b
2027
1976
 
2028
1977
 
2029
 
def send_all(sock, bytes, report_activity=None):
 
1978
def send_all(socket, bytes, report_activity=None):
2030
1979
    """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
 
 
 
1980
 
 
1981
    Regular socket.sendall() can give socket error 10053 on Windows.  This
 
1982
    implementation sends no more than 64k at a time, which avoids this problem.
 
1983
 
2039
1984
    :param report_activity: Call this as bytes are read, see
2040
1985
        Transport._report_activity
2041
1986
    """
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')
 
1987
    chunk_size = 2**16
 
1988
    for pos in xrange(0, len(bytes), chunk_size):
 
1989
        block = bytes[pos:pos+chunk_size]
 
1990
        if report_activity is not None:
 
1991
            report_activity(len(block), 'write')
 
1992
        until_no_eintr(socket.sendall, block)
2053
1993
 
2054
1994
 
2055
1995
def dereference_path(path):
2126
2066
 
2127
2067
 
2128
2068
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
 
    """
 
2069
    """Run f(*a, **kw), retrying if an EINTR error occurs."""
2141
2070
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
2142
2071
    while True:
2143
2072
        try:
2147
2076
                continue
2148
2077
            raise
2149
2078
 
2150
 
 
2151
2079
def re_compile_checked(re_string, flags=0, where=""):
2152
2080
    """Return a compiled re, or raise a sensible error.
2153
2081
 
2303
2231
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2304
2232
else:
2305
2233
    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