~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: John Arbash Meinel
  • Date: 2009-12-15 19:59:00 UTC
  • mfrom: (4634.108.2 2.0)
  • mto: This revision was merged to the branch mainline in revision 4900.
  • Revision ID: john@arbash-meinel.com-20091215195900-fvgxdv9ycbrnzp1o
merge the 2.0.4 branch into 2.1.0b5

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2009 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
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
31
from ntpath import (abspath as _nt_abspath,
37
39
from shutil import (
38
40
    rmtree,
39
41
    )
40
 
import socket
41
42
import subprocess
42
43
import tempfile
43
44
from tempfile import (
48
49
from bzrlib import (
49
50
    cache_utf8,
50
51
    errors,
51
 
    trace,
52
52
    win32utils,
53
53
    )
54
54
""")
55
55
 
56
 
from bzrlib.symbol_versioning import (
57
 
    deprecated_function,
58
 
    deprecated_in,
59
 
    )
60
 
 
61
56
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
62
57
# of 2.5
63
58
if sys.version_info < (2, 5):
89
84
# be opened in binary mode, rather than text mode.
90
85
# On other platforms, O_BINARY doesn't exist, because
91
86
# 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.
 
87
# OR with 0 on those platforms
94
88
O_BINARY = getattr(os, 'O_BINARY', 0)
95
 
O_TEXT = getattr(os, 'O_TEXT', 0)
96
 
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
97
89
 
98
90
 
99
91
def get_unicode_argv():
186
178
    try:
187
179
        return _kind_marker_map[kind]
188
180
    except KeyError:
189
 
        # Slightly faster than using .get(, '') when the common case is that
190
 
        # kind will be found
191
 
        return ''
 
181
        raise errors.BzrError('invalid file kind %r' % kind)
192
182
 
193
183
 
194
184
lexists = getattr(os.path, 'lexists', None)
211
201
    :param old: The old path, to rename from
212
202
    :param new: The new path, to rename to
213
203
    :param rename_func: The potentially non-atomic rename function
214
 
    :param unlink_func: A way to delete the target file if the full rename
215
 
        succeeds
 
204
    :param unlink_func: A way to delete the target file if the full rename succeeds
216
205
    """
 
206
 
217
207
    # sftp rename doesn't allow overwriting, so play tricks:
218
208
    base = os.path.basename(new)
219
209
    dirname = os.path.dirname(new)
220
 
    # callers use different encodings for the paths so the following MUST
221
 
    # respect that. We rely on python upcasting to unicode if new is unicode
222
 
    # and keeping a str if not.
223
 
    tmp_name = 'tmp.%s.%.9f.%d.%s' % (base, time.time(),
224
 
                                      os.getpid(), rand_chars(10))
 
210
    tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
225
211
    tmp_name = pathjoin(dirname, tmp_name)
226
212
 
227
213
    # Rename the file out of the way, but keep track if it didn't exist
360
346
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
361
347
 
362
348
 
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
349
def _win32_rename(old, new):
372
350
    """We expect to be able to atomically replace 'new' with old.
373
351
 
375
353
    and then deleted.
376
354
    """
377
355
    try:
378
 
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
 
356
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
379
357
    except OSError, e:
380
358
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
381
359
            # If we try to rename a non-existant file onto cwd, we get
386
364
        raise
387
365
 
388
366
 
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
367
def _mac_getcwd():
400
368
    return unicodedata.normalize('NFC', os.getcwdu())
401
369
 
406
374
realpath = _posix_realpath
407
375
pathjoin = os.path.join
408
376
normpath = os.path.normpath
409
 
rename = _wrapped_rename # overridden below on win32
410
377
getcwd = os.getcwdu
 
378
rename = os.rename
411
379
dirname = os.path.dirname
412
380
basename = os.path.basename
413
381
split = os.path.split
688
656
def sha_file_by_name(fname):
689
657
    """Calculate the SHA1 of a file by reading the full text"""
690
658
    s = sha()
691
 
    f = os.open(fname, os.O_RDONLY | O_BINARY | O_NOINHERIT)
 
659
    f = os.open(fname, os.O_RDONLY | O_BINARY)
692
660
    try:
693
661
        while True:
694
662
            b = os.read(f, 1<<16)
1147
1115
 
1148
1116
 
1149
1117
def relpath(base, path):
1150
 
    """Return path relative to base, or raise PathNotChild exception.
 
1118
    """Return path relative to base, or raise exception.
1151
1119
 
1152
1120
    The path may be either an absolute path or a path relative to the
1153
1121
    current working directory.
1155
1123
    os.path.commonprefix (python2.4) has a bad bug that it works just
1156
1124
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
1157
1125
    avoids that problem.
1158
 
 
1159
 
    NOTE: `base` should not have a trailing slash otherwise you'll get
1160
 
    PathNotChild exceptions regardless of `path`.
1161
1126
    """
1162
1127
 
1163
1128
    if len(base) < MIN_ABS_PATHLENGTH:
1374
1339
    normalized_filename = _inaccessible_normalized_filename
1375
1340
 
1376
1341
 
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
1342
default_terminal_width = 80
1414
1343
"""The default terminal width for ttys.
1415
1344
 
1498
1427
    _terminal_size = _ioctl_terminal_size
1499
1428
 
1500
1429
 
1501
 
def _terminal_size_changed(signum, frame):
1502
 
    """Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
1503
 
    width, height = _terminal_size(None, None)
1504
 
    if width is not None:
1505
 
        os.environ['COLUMNS'] = str(width)
1506
 
 
1507
 
 
1508
 
_registered_sigwinch = False
1509
 
def watch_sigwinch():
1510
 
    """Register for SIGWINCH, once and only once.
1511
 
 
1512
 
    Do nothing if the signal module is not available.
1513
 
    """
1514
 
    global _registered_sigwinch
1515
 
    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
1522
 
            pass
1523
 
        _registered_sigwinch = True
1524
 
 
1525
 
 
1526
1430
def supports_executable():
1527
1431
    return sys.platform != "win32"
1528
1432
 
1846
1750
            real_handlers[kind](abspath, relpath)
1847
1751
 
1848
1752
 
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
1753
def path_prefix_key(path):
1872
1754
    """Generate a prefix-order path key for path.
1873
1755
 
1973
1855
        return socket.gethostname().decode(get_user_encoding())
1974
1856
 
1975
1857
 
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):
 
1858
def recv_all(socket, bytes):
2010
1859
    """Receive an exact number of bytes.
2011
1860
 
2012
1861
    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
 
1862
    dependning on what's in the OS buffer.  MSG_WAITALL is not available
2014
1863
    on all platforms, but this should work everywhere.  This will return
2015
1864
    less than the requested amount if the remote end closes.
2016
1865
 
2017
1866
    This isn't optimized and is intended mostly for use in testing.
2018
1867
    """
2019
1868
    b = ''
2020
 
    while len(b) < count:
2021
 
        new = read_bytes_from_socket(socket, None, count - len(b))
 
1869
    while len(b) < bytes:
 
1870
        new = until_no_eintr(socket.recv, bytes - len(b))
2022
1871
        if new == '':
2023
1872
            break # eof
2024
1873
        b += new
2025
1874
    return b
2026
1875
 
2027
1876
 
2028
 
def send_all(sock, bytes, report_activity=None):
 
1877
def send_all(socket, bytes, report_activity=None):
2029
1878
    """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
 
 
 
1879
 
 
1880
    Regular socket.sendall() can give socket error 10053 on Windows.  This
 
1881
    implementation sends no more than 64k at a time, which avoids this problem.
 
1882
 
2038
1883
    :param report_activity: Call this as bytes are read, see
2039
1884
        Transport._report_activity
2040
1885
    """
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')
 
1886
    chunk_size = 2**16
 
1887
    for pos in xrange(0, len(bytes), chunk_size):
 
1888
        block = bytes[pos:pos+chunk_size]
 
1889
        if report_activity is not None:
 
1890
            report_activity(len(block), 'write')
 
1891
        until_no_eintr(socket.sendall, block)
2052
1892
 
2053
1893
 
2054
1894
def dereference_path(path):
2125
1965
 
2126
1966
 
2127
1967
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
 
    """
 
1968
    """Run f(*a, **kw), retrying if an EINTR error occurs."""
2140
1969
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
2141
1970
    while True:
2142
1971
        try:
2146
1975
                continue
2147
1976
            raise
2148
1977
 
2149
 
 
2150
1978
def re_compile_checked(re_string, flags=0, where=""):
2151
1979
    """Return a compiled re, or raise a sensible error.
2152
1980
 
2244
2072
    if use_cache:
2245
2073
        _cached_concurrency = concurrency
2246
2074
    return concurrency
2247
 
 
2248
 
 
2249
 
class UnicodeOrBytesToBytesWriter(codecs.StreamWriter):
2250
 
    """A stream writer that doesn't decode str arguments."""
2251
 
 
2252
 
    def __init__(self, encode, stream, errors='strict'):
2253
 
        codecs.StreamWriter.__init__(self, stream, errors)
2254
 
        self.encode = encode
2255
 
 
2256
 
    def write(self, object):
2257
 
        if type(object) is str:
2258
 
            self.stream.write(object)
2259
 
        else:
2260
 
            data, _ = self.encode(object, self.errors)
2261
 
            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