~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

(vila) Fix bzrlib.tests.test_gpg.TestVerify.test_verify_revoked_signature
 with recent versions of gpg. (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from __future__ import absolute_import
 
18
 
17
19
import errno
18
20
import os
19
21
import re
26
28
lazy_import(globals(), """
27
29
from datetime import datetime
28
30
import getpass
 
31
import locale
29
32
import ntpath
30
33
import posixpath
 
34
import select
31
35
# We need to import both shutil and rmtree as we export the later on posix
32
36
# and need the former on windows
33
37
import shutil
42
46
 
43
47
from bzrlib import (
44
48
    cache_utf8,
 
49
    config,
45
50
    errors,
46
51
    trace,
47
52
    win32utils,
48
53
    )
 
54
from bzrlib.i18n import gettext
49
55
""")
50
56
 
51
57
from bzrlib.symbol_versioning import (
 
58
    DEPRECATED_PARAMETER,
52
59
    deprecated_function,
53
60
    deprecated_in,
 
61
    deprecated_passed,
 
62
    warn as warn_deprecated,
54
63
    )
55
64
 
56
 
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
57
 
# of 2.5
58
 
if sys.version_info < (2, 5):
59
 
    import md5 as _mod_md5
60
 
    md5 = _mod_md5.new
61
 
    import sha as _mod_sha
62
 
    sha = _mod_sha.new
63
 
else:
64
 
    from hashlib import (
65
 
        md5,
66
 
        sha1 as sha,
67
 
        )
 
65
from hashlib import (
 
66
    md5,
 
67
    sha1 as sha,
 
68
    )
68
69
 
69
70
 
70
71
import bzrlib
71
 
from bzrlib import symbol_versioning
 
72
from bzrlib import symbol_versioning, _fs_enc
72
73
 
73
74
 
74
75
# Cross platform wall-clock time functionality with decent resolution.
96
97
        user_encoding = get_user_encoding()
97
98
        return [a.decode(user_encoding) for a in sys.argv[1:]]
98
99
    except UnicodeDecodeError:
99
 
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
100
 
                                                            "encoding." % a))
 
100
        raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
 
101
            "application locale.").format(a, user_encoding))
101
102
 
102
103
 
103
104
def make_readonly(filename):
105
106
    mod = os.lstat(filename).st_mode
106
107
    if not stat.S_ISLNK(mod):
107
108
        mod = mod & 0777555
108
 
        os.chmod(filename, mod)
 
109
        chmod_if_possible(filename, mod)
109
110
 
110
111
 
111
112
def make_writable(filename):
112
113
    mod = os.lstat(filename).st_mode
113
114
    if not stat.S_ISLNK(mod):
114
115
        mod = mod | 0200
115
 
        os.chmod(filename, mod)
 
116
        chmod_if_possible(filename, mod)
 
117
 
 
118
 
 
119
def chmod_if_possible(filename, mode):
 
120
    # Set file mode if that can be safely done.
 
121
    # Sometimes even on unix the filesystem won't allow it - see
 
122
    # https://bugs.launchpad.net/bzr/+bug/606537
 
123
    try:
 
124
        # It is probably faster to just do the chmod, rather than
 
125
        # doing a stat, and then trying to compare
 
126
        os.chmod(filename, mode)
 
127
    except (IOError, OSError),e:
 
128
        # Permission/access denied seems to commonly happen on smbfs; there's
 
129
        # probably no point warning about it.
 
130
        # <https://bugs.launchpad.net/bzr/+bug/606537>
 
131
        if getattr(e, 'errno') in (errno.EPERM, errno.EACCES):
 
132
            trace.mutter("ignore error on chmod of %r: %r" % (
 
133
                filename, e))
 
134
            return
 
135
        raise
116
136
 
117
137
 
118
138
def minimum_path_selection(paths):
197
217
            if e.errno == errno.ENOENT:
198
218
                return False;
199
219
            else:
200
 
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
 
220
                raise errors.BzrError(gettext("lstat/stat of ({0!r}): {1!r}").format(f, e))
201
221
 
202
222
 
203
223
def fancy_rename(old, new, rename_func, unlink_func):
269
289
            else:
270
290
                rename_func(tmp_name, new)
271
291
    if failure_exc is not None:
272
 
        raise failure_exc[0], failure_exc[1], failure_exc[2]
 
292
        try:
 
293
            raise failure_exc[0], failure_exc[1], failure_exc[2]
 
294
        finally:
 
295
            del failure_exc
273
296
 
274
297
 
275
298
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
276
299
# choke on a Unicode string containing a relative path if
277
300
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
278
301
# string.
279
 
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
280
302
def _posix_abspath(path):
281
303
    # jam 20060426 rather than encoding to fsencoding
282
304
    # copy posixpath.abspath, but use os.getcwdu instead
283
305
    if not posixpath.isabs(path):
284
306
        path = posixpath.join(getcwd(), path)
285
 
    return posixpath.normpath(path)
 
307
    return _posix_normpath(path)
286
308
 
287
309
 
288
310
def _posix_realpath(path):
289
311
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
290
312
 
291
313
 
 
314
def _posix_normpath(path):
 
315
    path = posixpath.normpath(path)
 
316
    # Bug 861008: posixpath.normpath() returns a path normalized according to
 
317
    # the POSIX standard, which stipulates (for compatibility reasons) that two
 
318
    # leading slashes must not be simplified to one, and only if there are 3 or
 
319
    # more should they be simplified as one. So we treat the leading 2 slashes
 
320
    # as a special case here by simply removing the first slash, as we consider
 
321
    # that breaking POSIX compatibility for this obscure feature is acceptable.
 
322
    # This is not a paranoid precaution, as we notably get paths like this when
 
323
    # the repo is hosted at the root of the filesystem, i.e. in "/".    
 
324
    if path.startswith('//'):
 
325
        path = path[1:]
 
326
    return path
 
327
 
 
328
 
 
329
def _posix_path_from_environ(key):
 
330
    """Get unicode path from `key` in environment or None if not present
 
331
 
 
332
    Note that posix systems use arbitrary byte strings for filesystem objects,
 
333
    so a path that raises BadFilenameEncoding here may still be accessible.
 
334
    """
 
335
    val = os.environ.get(key, None)
 
336
    if val is None:
 
337
        return val
 
338
    try:
 
339
        return val.decode(_fs_enc)
 
340
    except UnicodeDecodeError:
 
341
        # GZ 2011-12-12:Ideally want to include `key` in the exception message
 
342
        raise errors.BadFilenameEncoding(val, _fs_enc)
 
343
 
 
344
 
 
345
def _posix_get_home_dir():
 
346
    """Get the home directory of the current user as a unicode path"""
 
347
    path = posixpath.expanduser("~")
 
348
    try:
 
349
        return path.decode(_fs_enc)
 
350
    except UnicodeDecodeError:
 
351
        raise errors.BadFilenameEncoding(path, _fs_enc)
 
352
 
 
353
 
 
354
def _posix_getuser_unicode():
 
355
    """Get username from environment or password database as unicode"""
 
356
    name = getpass.getuser()
 
357
    user_encoding = get_user_encoding()
 
358
    try:
 
359
        return name.decode(user_encoding)
 
360
    except UnicodeDecodeError:
 
361
        raise errors.BzrError("Encoding of username %r is unsupported by %s "
 
362
            "application locale." % (name, user_encoding))
 
363
 
 
364
 
292
365
def _win32_fixdrive(path):
293
366
    """Force drive letters to be consistent.
294
367
 
377
450
    return unicodedata.normalize('NFC', os.getcwdu())
378
451
 
379
452
 
 
453
def _rename_wrap_exception(rename_func):
 
454
    """Adds extra information to any exceptions that come from rename().
 
455
 
 
456
    The exception has an updated message and 'old_filename' and 'new_filename'
 
457
    attributes.
 
458
    """
 
459
 
 
460
    def _rename_wrapper(old, new):
 
461
        try:
 
462
            rename_func(old, new)
 
463
        except OSError, e:
 
464
            detailed_error = OSError(e.errno, e.strerror +
 
465
                                " [occurred when renaming '%s' to '%s']" %
 
466
                                (old, new))
 
467
            detailed_error.old_filename = old
 
468
            detailed_error.new_filename = new
 
469
            raise detailed_error
 
470
 
 
471
    return _rename_wrapper
 
472
 
 
473
# Default rename wraps os.rename()
 
474
rename = _rename_wrap_exception(os.rename)
 
475
 
380
476
# Default is to just use the python builtins, but these can be rebound on
381
477
# particular platforms.
382
478
abspath = _posix_abspath
383
479
realpath = _posix_realpath
384
480
pathjoin = os.path.join
385
 
normpath = os.path.normpath
 
481
normpath = _posix_normpath
 
482
path_from_environ = _posix_path_from_environ
 
483
_get_home_dir = _posix_get_home_dir
 
484
getuser_unicode = _posix_getuser_unicode
386
485
getcwd = os.getcwdu
387
 
rename = os.rename
388
486
dirname = os.path.dirname
389
487
basename = os.path.basename
390
488
split = os.path.split
392
490
# These were already lazily imported into local scope
393
491
# mkdtemp = tempfile.mkdtemp
394
492
# rmtree = shutil.rmtree
 
493
lstat = os.lstat
 
494
fstat = os.fstat
 
495
 
 
496
def wrap_stat(st):
 
497
    return st
 
498
 
395
499
 
396
500
MIN_ABS_PATHLENGTH = 1
397
501
 
406
510
    normpath = _win32_normpath
407
511
    getcwd = _win32_getcwd
408
512
    mkdtemp = _win32_mkdtemp
409
 
    rename = _win32_rename
 
513
    rename = _rename_wrap_exception(_win32_rename)
 
514
    try:
 
515
        from bzrlib import _walkdirs_win32
 
516
    except ImportError:
 
517
        pass
 
518
    else:
 
519
        lstat = _walkdirs_win32.lstat
 
520
        fstat = _walkdirs_win32.fstat
 
521
        wrap_stat = _walkdirs_win32.wrap_stat
410
522
 
411
523
    MIN_ABS_PATHLENGTH = 3
412
524
 
430
542
    f = win32utils.get_unicode_argv     # special function or None
431
543
    if f is not None:
432
544
        get_unicode_argv = f
 
545
    path_from_environ = win32utils.get_environ_unicode
 
546
    _get_home_dir = win32utils.get_home_location
 
547
    getuser_unicode = win32utils.get_user_name
433
548
 
434
549
elif sys.platform == 'darwin':
435
550
    getcwd = _mac_getcwd
867
982
    return os.fstat(f.fileno())[stat.ST_SIZE]
868
983
 
869
984
 
870
 
# Define rand_bytes based on platform.
871
 
try:
872
 
    # Python 2.4 and later have os.urandom,
873
 
    # but it doesn't work on some arches
874
 
    os.urandom(1)
875
 
    rand_bytes = os.urandom
876
 
except (NotImplementedError, AttributeError):
877
 
    # If python doesn't have os.urandom, or it doesn't work,
878
 
    # then try to first pull random data from /dev/urandom
 
985
# Alias os.urandom to support platforms (which?) without /dev/urandom and 
 
986
# override if it doesn't work. Avoid checking on windows where there is
 
987
# significant initialisation cost that can be avoided for some bzr calls.
 
988
 
 
989
rand_bytes = os.urandom
 
990
 
 
991
if rand_bytes.__module__ != "nt":
879
992
    try:
880
 
        rand_bytes = file('/dev/urandom', 'rb').read
881
 
    # Otherwise, use this hack as a last resort
882
 
    except (IOError, OSError):
 
993
        rand_bytes(1)
 
994
    except NotImplementedError:
883
995
        # not well seeded, but better than nothing
884
996
        def rand_bytes(n):
885
997
            import random
915
1027
    rps = []
916
1028
    for f in ps:
917
1029
        if f == '..':
918
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1030
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
919
1031
        elif (f == '.') or (f == ''):
920
1032
            pass
921
1033
        else:
926
1038
def joinpath(p):
927
1039
    for f in p:
928
1040
        if (f == '..') or (f is None) or (f == ''):
929
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1041
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
930
1042
    return pathjoin(*p)
931
1043
 
932
1044
 
967
1079
    # they tend to happen very early in startup when we can't check config
968
1080
    # files etc, and also we want to report all failures but not spam the user
969
1081
    # with 10 warnings.
970
 
    from bzrlib import trace
971
1082
    exception_str = str(exception)
972
1083
    if exception_str not in _extension_load_failures:
973
1084
        trace.mutter("failed to load compiled extension: %s" % exception_str)
977
1088
def report_extension_load_failures():
978
1089
    if not _extension_load_failures:
979
1090
        return
980
 
    from bzrlib.config import GlobalConfig
981
 
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
 
1091
    if config.GlobalStack().get('ignore_missing_extensions'):
982
1092
        return
983
1093
    # the warnings framework should by default show this only once
984
1094
    from bzrlib.trace import warning
1146
1256
 
1147
1257
    if len(base) < MIN_ABS_PATHLENGTH:
1148
1258
        # must have space for e.g. a drive letter
1149
 
        raise ValueError('%r is too short to calculate a relative path'
 
1259
        raise ValueError(gettext('%r is too short to calculate a relative path')
1150
1260
            % (base,))
1151
1261
 
1152
1262
    rp = abspath(path)
1462
1572
    # a similar effect.
1463
1573
 
1464
1574
    # If BZR_COLUMNS is set, take it, user is always right
 
1575
    # Except if they specified 0 in which case, impose no limit here
1465
1576
    try:
1466
 
        return int(os.environ['BZR_COLUMNS'])
 
1577
        width = int(os.environ['BZR_COLUMNS'])
1467
1578
    except (KeyError, ValueError):
1468
 
        pass
 
1579
        width = None
 
1580
    if width is not None:
 
1581
        if width > 0:
 
1582
            return width
 
1583
        else:
 
1584
            return None
1469
1585
 
1470
1586
    isatty = getattr(sys.stdout, 'isatty', None)
1471
1587
    if isatty is None or not isatty():
1721
1837
    """
1722
1838
    global _selected_dir_reader
1723
1839
    if _selected_dir_reader is None:
1724
 
        fs_encoding = _fs_enc.upper()
1725
1840
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1726
1841
            # Win98 doesn't have unicode apis like FindFirstFileW
1727
1842
            # TODO: We possibly could support Win98 by falling back to the
1733
1848
                _selected_dir_reader = Win32ReadDir()
1734
1849
            except ImportError:
1735
1850
                pass
1736
 
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1737
 
            # ANSI_X3.4-1968 is a form of ASCII
 
1851
        elif _fs_enc in ('utf-8', 'ascii'):
1738
1852
            try:
1739
1853
                from bzrlib._readdir_pyx import UTF8DirReader
1740
1854
                _selected_dir_reader = UTF8DirReader()
1875
1989
        s = os.stat(src)
1876
1990
        chown(dst, s.st_uid, s.st_gid)
1877
1991
    except OSError, e:
1878
 
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
 
1992
        trace.warning(
 
1993
            'Unable to copy ownership from "%s" to "%s". '
 
1994
            'You may want to set it manually.', src, dst)
 
1995
        trace.log_exception_quietly()
1879
1996
 
1880
1997
 
1881
1998
def path_prefix_key(path):
1896
2013
_cached_user_encoding = None
1897
2014
 
1898
2015
 
1899
 
def get_user_encoding(use_cache=True):
 
2016
def get_user_encoding(use_cache=DEPRECATED_PARAMETER):
1900
2017
    """Find out what the preferred user encoding is.
1901
2018
 
1902
2019
    This is generally the encoding that is used for command line parameters
1903
2020
    and file contents. This may be different from the terminal encoding
1904
2021
    or the filesystem encoding.
1905
2022
 
1906
 
    :param  use_cache:  Enable cache for detected encoding.
1907
 
                        (This parameter is turned on by default,
1908
 
                        and required only for selftesting)
1909
 
 
1910
2023
    :return: A string defining the preferred user encoding
1911
2024
    """
1912
2025
    global _cached_user_encoding
1913
 
    if _cached_user_encoding is not None and use_cache:
 
2026
    if deprecated_passed(use_cache):
 
2027
        warn_deprecated("use_cache should only have been used for tests",
 
2028
            DeprecationWarning, stacklevel=2) 
 
2029
    if _cached_user_encoding is not None:
1914
2030
        return _cached_user_encoding
1915
2031
 
1916
 
    if sys.platform == 'darwin':
1917
 
        # python locale.getpreferredencoding() always return
1918
 
        # 'mac-roman' on darwin. That's a lie.
1919
 
        sys.platform = 'posix'
1920
 
        try:
1921
 
            if os.environ.get('LANG', None) is None:
1922
 
                # If LANG is not set, we end up with 'ascii', which is bad
1923
 
                # ('mac-roman' is more than ascii), so we set a default which
1924
 
                # will give us UTF-8 (which appears to work in all cases on
1925
 
                # OSX). Users are still free to override LANG of course, as
1926
 
                # long as it give us something meaningful. This work-around
1927
 
                # *may* not be needed with python 3k and/or OSX 10.5, but will
1928
 
                # work with them too -- vila 20080908
1929
 
                os.environ['LANG'] = 'en_US.UTF-8'
1930
 
            import locale
1931
 
        finally:
1932
 
            sys.platform = 'darwin'
 
2032
    if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
 
2033
        # Use the existing locale settings and call nl_langinfo directly
 
2034
        # rather than going through getpreferredencoding. This avoids
 
2035
        # <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
 
2036
        # possibility of the setlocale call throwing an error.
 
2037
        user_encoding = locale.nl_langinfo(locale.CODESET)
1933
2038
    else:
1934
 
        import locale
 
2039
        # GZ 2011-12-19: On windows could call GetACP directly instead.
 
2040
        user_encoding = locale.getpreferredencoding(False)
1935
2041
 
1936
2042
    try:
1937
 
        user_encoding = locale.getpreferredencoding()
1938
 
    except locale.Error, e:
1939
 
        sys.stderr.write('bzr: warning: %s\n'
1940
 
                         '  Could not determine what text encoding to use.\n'
1941
 
                         '  This error usually means your Python interpreter\n'
1942
 
                         '  doesn\'t support the locale set by $LANG (%s)\n'
1943
 
                         "  Continuing with ascii encoding.\n"
1944
 
                         % (e, os.environ.get('LANG')))
1945
 
        user_encoding = 'ascii'
1946
 
 
1947
 
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
1948
 
    # treat that as ASCII, and not support printing unicode characters to the
1949
 
    # console.
1950
 
    #
1951
 
    # For python scripts run under vim, we get '', so also treat that as ASCII
1952
 
    if user_encoding in (None, 'cp0', ''):
1953
 
        user_encoding = 'ascii'
1954
 
    else:
1955
 
        # check encoding
1956
 
        try:
1957
 
            codecs.lookup(user_encoding)
1958
 
        except LookupError:
 
2043
        user_encoding = codecs.lookup(user_encoding).name
 
2044
    except LookupError:
 
2045
        if user_encoding not in ("", "cp0"):
1959
2046
            sys.stderr.write('bzr: warning:'
1960
2047
                             ' unknown encoding %s.'
1961
2048
                             ' Continuing with ascii encoding.\n'
1962
2049
                             % user_encoding
1963
2050
                            )
1964
 
            user_encoding = 'ascii'
1965
 
 
1966
 
    if use_cache:
1967
 
        _cached_user_encoding = user_encoding
1968
 
 
 
2051
        user_encoding = 'ascii'
 
2052
    else:
 
2053
        # Get 'ascii' when setlocale has not been called or LANG=C or unset.
 
2054
        if user_encoding == 'ascii':
 
2055
            if sys.platform == 'darwin':
 
2056
                # OSX is special-cased in Python to have a UTF-8 filesystem
 
2057
                # encoding and previously had LANG set here if not present.
 
2058
                user_encoding = 'utf-8'
 
2059
            # GZ 2011-12-19: Maybe UTF-8 should be the default in this case
 
2060
            #                for some other posix platforms as well.
 
2061
 
 
2062
    _cached_user_encoding = user_encoding
1969
2063
    return user_encoding
1970
2064
 
1971
2065
 
1980
2074
    behaves inconsistently on different platforms.
1981
2075
    """
1982
2076
    if sys.platform == "win32":
1983
 
        import win32utils
1984
2077
        return win32utils.get_host_name()
1985
2078
    else:
1986
2079
        import socket
1993
2086
# data at once.
1994
2087
MAX_SOCKET_CHUNK = 64 * 1024
1995
2088
 
 
2089
_end_of_stream_errors = [errno.ECONNRESET, errno.EPIPE, errno.EINVAL]
 
2090
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
 
2091
    _eno = getattr(errno, _eno, None)
 
2092
    if _eno is not None:
 
2093
        _end_of_stream_errors.append(_eno)
 
2094
del _eno
 
2095
 
 
2096
 
1996
2097
def read_bytes_from_socket(sock, report_activity=None,
1997
2098
        max_read_size=MAX_SOCKET_CHUNK):
1998
2099
    """Read up to max_read_size of bytes from sock and notify of progress.
2006
2107
            bytes = sock.recv(max_read_size)
2007
2108
        except socket.error, e:
2008
2109
            eno = e.args[0]
2009
 
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
 
2110
            if eno in _end_of_stream_errors:
2010
2111
                # The connection was closed by the other side.  Callers expect
2011
2112
                # an empty string to signal end-of-stream.
2012
2113
                return ""
2057
2158
    while sent_total < byte_count:
2058
2159
        try:
2059
2160
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2060
 
        except socket.error, e:
 
2161
        except (socket.error, IOError), e:
 
2162
            if e.args[0] in _end_of_stream_errors:
 
2163
                raise errors.ConnectionReset(
 
2164
                    "Error trying to write to socket", e)
2061
2165
            if e.args[0] != errno.EINTR:
2062
2166
                raise
2063
2167
        else:
 
2168
            if sent == 0:
 
2169
                raise errors.ConnectionReset('Sending to %s returned 0 bytes'
 
2170
                                             % (sock,))
2064
2171
            sent_total += sent
2065
 
            report_activity(sent, 'write')
 
2172
            if report_activity is not None:
 
2173
                report_activity(sent, 'write')
2066
2174
 
2067
2175
 
2068
2176
def connect_socket(address):
2153
2261
    return file_kind_from_stat_mode(mode)
2154
2262
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2155
2263
 
2156
 
 
2157
 
def file_kind(f, _lstat=os.lstat):
 
2264
def file_stat(f, _lstat=os.lstat):
2158
2265
    try:
2159
 
        return file_kind_from_stat_mode(_lstat(f).st_mode)
 
2266
        # XXX cache?
 
2267
        return _lstat(f)
2160
2268
    except OSError, e:
2161
2269
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2162
2270
            raise errors.NoSuchFile(f)
2163
2271
        raise
2164
2272
 
 
2273
def file_kind(f, _lstat=os.lstat):
 
2274
    stat_value = file_stat(f, _lstat)
 
2275
    return file_kind_from_stat_mode(stat_value.st_mode)
2165
2276
 
2166
2277
def until_no_eintr(f, *a, **kw):
2167
2278
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2211
2322
 
2212
2323
 
2213
2324
if sys.platform == "win32":
2214
 
    import msvcrt
2215
2325
    def getchar():
 
2326
        import msvcrt
2216
2327
        return msvcrt.getch()
2217
2328
else:
2218
 
    import tty
2219
 
    import termios
2220
2329
    def getchar():
 
2330
        import tty
 
2331
        import termios
2221
2332
        fd = sys.stdin.fileno()
2222
2333
        settings = termios.tcgetattr(fd)
2223
2334
        try:
2227
2338
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2228
2339
        return ch
2229
2340
 
2230
 
 
2231
 
if sys.platform == 'linux2':
 
2341
if sys.platform.startswith('linux'):
2232
2342
    def _local_concurrency():
2233
 
        concurrency = None
2234
 
        prefix = 'processor'
2235
 
        for line in file('/proc/cpuinfo', 'rb'):
2236
 
            if line.startswith(prefix):
2237
 
                concurrency = int(line[line.find(':')+1:]) + 1
2238
 
        return concurrency
 
2343
        try:
 
2344
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2345
        except (ValueError, OSError, AttributeError):
 
2346
            return None
2239
2347
elif sys.platform == 'darwin':
2240
2348
    def _local_concurrency():
2241
2349
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2242
2350
                                stdout=subprocess.PIPE).communicate()[0]
2243
 
elif sys.platform[0:7] == 'freebsd':
 
2351
elif "bsd" in sys.platform:
2244
2352
    def _local_concurrency():
2245
2353
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2246
2354
                                stdout=subprocess.PIPE).communicate()[0]
2274
2382
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2275
2383
    if concurrency is None:
2276
2384
        try:
2277
 
            concurrency = _local_concurrency()
2278
 
        except (OSError, IOError):
2279
 
            pass
 
2385
            import multiprocessing
 
2386
            concurrency = multiprocessing.cpu_count()
 
2387
        except (ImportError, NotImplementedError):
 
2388
            # multiprocessing is only available on Python >= 2.6
 
2389
            # and multiprocessing.cpu_count() isn't implemented on all
 
2390
            # platforms
 
2391
            try:
 
2392
                concurrency = _local_concurrency()
 
2393
            except (OSError, IOError):
 
2394
                pass
2280
2395
    try:
2281
2396
        concurrency = int(concurrency)
2282
2397
    except (TypeError, ValueError):
2344
2459
    open_file = open
2345
2460
 
2346
2461
 
2347
 
def getuser_unicode():
2348
 
    """Return the username as unicode.
2349
 
    """
2350
 
    try:
2351
 
        user_encoding = get_user_encoding()
2352
 
        username = getpass.getuser().decode(user_encoding)
2353
 
    except UnicodeDecodeError:
2354
 
        raise errors.BzrError("Can't decode username as %s." % \
2355
 
                user_encoding)
2356
 
    return username
 
2462
def available_backup_name(base, exists):
 
2463
    """Find a non-existing backup file name.
 
2464
 
 
2465
    This will *not* create anything, this only return a 'free' entry.  This
 
2466
    should be used for checking names in a directory below a locked
 
2467
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
 
2468
    Leap) and generally discouraged.
 
2469
 
 
2470
    :param base: The base name.
 
2471
 
 
2472
    :param exists: A callable returning True if the path parameter exists.
 
2473
    """
 
2474
    counter = 1
 
2475
    name = "%s.~%d~" % (base, counter)
 
2476
    while exists(name):
 
2477
        counter += 1
 
2478
        name = "%s.~%d~" % (base, counter)
 
2479
    return name
 
2480
 
 
2481
 
 
2482
def set_fd_cloexec(fd):
 
2483
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
 
2484
    support for this is not available.
 
2485
    """
 
2486
    try:
 
2487
        import fcntl
 
2488
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
 
2489
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
 
2490
    except (ImportError, AttributeError):
 
2491
        # Either the fcntl module or specific constants are not present
 
2492
        pass
 
2493
 
 
2494
 
 
2495
def find_executable_on_path(name):
 
2496
    """Finds an executable on the PATH.
 
2497
    
 
2498
    On Windows, this will try to append each extension in the PATHEXT
 
2499
    environment variable to the name, if it cannot be found with the name
 
2500
    as given.
 
2501
    
 
2502
    :param name: The base name of the executable.
 
2503
    :return: The path to the executable found or None.
 
2504
    """
 
2505
    if sys.platform == 'win32':
 
2506
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
 
2507
        exts = [ext.lower() for ext in exts]
 
2508
        base, ext = os.path.splitext(name)
 
2509
        if ext != '':
 
2510
            if ext.lower() not in exts:
 
2511
                return None
 
2512
            name = base
 
2513
            exts = [ext]
 
2514
    else:
 
2515
        exts = ['']
 
2516
    path = os.environ.get('PATH')
 
2517
    if path is not None:
 
2518
        path = path.split(os.pathsep)
 
2519
        for ext in exts:
 
2520
            for d in path:
 
2521
                f = os.path.join(d, name) + ext
 
2522
                if os.access(f, os.X_OK):
 
2523
                    return f
 
2524
    if sys.platform == 'win32':
 
2525
        app_path = win32utils.get_app_path(name)
 
2526
        if app_path != name:
 
2527
            return app_path
 
2528
    return None
 
2529
 
 
2530
 
 
2531
def _posix_is_local_pid_dead(pid):
 
2532
    """True if pid doesn't correspond to live process on this machine"""
 
2533
    try:
 
2534
        # Special meaning of unix kill: just check if it's there.
 
2535
        os.kill(pid, 0)
 
2536
    except OSError, e:
 
2537
        if e.errno == errno.ESRCH:
 
2538
            # On this machine, and really not found: as sure as we can be
 
2539
            # that it's dead.
 
2540
            return True
 
2541
        elif e.errno == errno.EPERM:
 
2542
            # exists, though not ours
 
2543
            return False
 
2544
        else:
 
2545
            mutter("os.kill(%d, 0) failed: %s" % (pid, e))
 
2546
            # Don't really know.
 
2547
            return False
 
2548
    else:
 
2549
        # Exists and our process: not dead.
 
2550
        return False
 
2551
 
 
2552
if sys.platform == "win32":
 
2553
    is_local_pid_dead = win32utils.is_local_pid_dead
 
2554
else:
 
2555
    is_local_pid_dead = _posix_is_local_pid_dead
 
2556
 
 
2557
_maybe_ignored = ['EAGAIN', 'EINTR', 'ENOTSUP', 'EOPNOTSUPP', 'EACCES']
 
2558
_fdatasync_ignored = [getattr(errno, name) for name in _maybe_ignored
 
2559
                      if getattr(errno, name, None) is not None]
 
2560
 
 
2561
 
 
2562
def fdatasync(fileno):
 
2563
    """Flush file contents to disk if possible.
 
2564
    
 
2565
    :param fileno: Integer OS file handle.
 
2566
    :raises TransportNotPossible: If flushing to disk is not possible.
 
2567
    """
 
2568
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
 
2569
    if fn is not None:
 
2570
        try:
 
2571
            fn(fileno)
 
2572
        except IOError, e:
 
2573
            # See bug #1075108, on some platforms fdatasync exists, but can
 
2574
            # raise ENOTSUP. However, we are calling fdatasync to be helpful
 
2575
            # and reduce the chance of corruption-on-powerloss situations. It
 
2576
            # is not a mandatory call, so it is ok to suppress failures.
 
2577
            trace.mutter("ignoring error calling fdatasync: %s" % (e,))
 
2578
            if getattr(e, 'errno', None) not in _fdatasync_ignored:
 
2579
                raise
 
2580
 
 
2581
 
 
2582
def ensure_empty_directory_exists(path, exception_class):
 
2583
    """Make sure a local directory exists and is empty.
 
2584
    
 
2585
    If it does not exist, it is created.  If it exists and is not empty, an
 
2586
    instance of exception_class is raised.
 
2587
    """
 
2588
    try:
 
2589
        os.mkdir(path)
 
2590
    except OSError, e:
 
2591
        if e.errno != errno.EEXIST:
 
2592
            raise
 
2593
        if os.listdir(path) != []:
 
2594
            raise exception_class(path)
 
2595
 
 
2596
 
 
2597
def is_environment_error(evalue):
 
2598
    """True if exception instance is due to a process environment issue
 
2599
 
 
2600
    This includes OSError and IOError, but also other errors that come from
 
2601
    the operating system or core libraries but are not subclasses of those.
 
2602
    """
 
2603
    if isinstance(evalue, (EnvironmentError, select.error)):
 
2604
        return True
 
2605
    if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
 
2606
        return True
 
2607
    return False