~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Jelmer Vernooij
  • Date: 2012-01-24 13:14:06 UTC
  • mto: (6445.4.5 nested-trees-spec)
  • mto: This revision was merged to the branch mainline in revision 6518.
  • Revision ID: jelmer@samba.org-20120124131406-wedftkorbpv37bm0
Import nested tree doc from devnotes.

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_getuser_unicode():
 
346
    """Get username from environment or password database as unicode"""
 
347
    name = getpass.getuser()
 
348
    user_encoding = get_user_encoding()
 
349
    try:
 
350
        return name.decode(user_encoding)
 
351
    except UnicodeDecodeError:
 
352
        raise errors.BzrError("Encoding of username %r is unsupported by %s "
 
353
            "application locale." % (name, user_encoding))
 
354
 
 
355
 
292
356
def _win32_fixdrive(path):
293
357
    """Force drive letters to be consistent.
294
358
 
382
446
abspath = _posix_abspath
383
447
realpath = _posix_realpath
384
448
pathjoin = os.path.join
385
 
normpath = os.path.normpath
 
449
normpath = _posix_normpath
 
450
path_from_environ = _posix_path_from_environ
 
451
getuser_unicode = _posix_getuser_unicode
386
452
getcwd = os.getcwdu
387
453
rename = os.rename
388
454
dirname = os.path.dirname
392
458
# These were already lazily imported into local scope
393
459
# mkdtemp = tempfile.mkdtemp
394
460
# rmtree = shutil.rmtree
 
461
lstat = os.lstat
 
462
fstat = os.fstat
 
463
 
 
464
def wrap_stat(st):
 
465
    return st
 
466
 
395
467
 
396
468
MIN_ABS_PATHLENGTH = 1
397
469
 
407
479
    getcwd = _win32_getcwd
408
480
    mkdtemp = _win32_mkdtemp
409
481
    rename = _win32_rename
 
482
    try:
 
483
        from bzrlib import _walkdirs_win32
 
484
    except ImportError:
 
485
        pass
 
486
    else:
 
487
        lstat = _walkdirs_win32.lstat
 
488
        fstat = _walkdirs_win32.fstat
 
489
        wrap_stat = _walkdirs_win32.wrap_stat
410
490
 
411
491
    MIN_ABS_PATHLENGTH = 3
412
492
 
430
510
    f = win32utils.get_unicode_argv     # special function or None
431
511
    if f is not None:
432
512
        get_unicode_argv = f
 
513
    path_from_environ = win32utils.get_environ_unicode
 
514
    getuser_unicode = win32utils.get_user_name
433
515
 
434
516
elif sys.platform == 'darwin':
435
517
    getcwd = _mac_getcwd
867
949
    return os.fstat(f.fileno())[stat.ST_SIZE]
868
950
 
869
951
 
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
 
952
# Alias os.urandom to support platforms (which?) without /dev/urandom and 
 
953
# override if it doesn't work. Avoid checking on windows where there is
 
954
# significant initialisation cost that can be avoided for some bzr calls.
 
955
 
 
956
rand_bytes = os.urandom
 
957
 
 
958
if rand_bytes.__module__ != "nt":
879
959
    try:
880
 
        rand_bytes = file('/dev/urandom', 'rb').read
881
 
    # Otherwise, use this hack as a last resort
882
 
    except (IOError, OSError):
 
960
        rand_bytes(1)
 
961
    except NotImplementedError:
883
962
        # not well seeded, but better than nothing
884
963
        def rand_bytes(n):
885
964
            import random
915
994
    rps = []
916
995
    for f in ps:
917
996
        if f == '..':
918
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
997
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
919
998
        elif (f == '.') or (f == ''):
920
999
            pass
921
1000
        else:
926
1005
def joinpath(p):
927
1006
    for f in p:
928
1007
        if (f == '..') or (f is None) or (f == ''):
929
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1008
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
930
1009
    return pathjoin(*p)
931
1010
 
932
1011
 
967
1046
    # they tend to happen very early in startup when we can't check config
968
1047
    # files etc, and also we want to report all failures but not spam the user
969
1048
    # with 10 warnings.
970
 
    from bzrlib import trace
971
1049
    exception_str = str(exception)
972
1050
    if exception_str not in _extension_load_failures:
973
1051
        trace.mutter("failed to load compiled extension: %s" % exception_str)
977
1055
def report_extension_load_failures():
978
1056
    if not _extension_load_failures:
979
1057
        return
980
 
    from bzrlib.config import GlobalConfig
981
 
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
 
1058
    if config.GlobalStack().get('ignore_missing_extensions'):
982
1059
        return
983
1060
    # the warnings framework should by default show this only once
984
1061
    from bzrlib.trace import warning
1146
1223
 
1147
1224
    if len(base) < MIN_ABS_PATHLENGTH:
1148
1225
        # must have space for e.g. a drive letter
1149
 
        raise ValueError('%r is too short to calculate a relative path'
 
1226
        raise ValueError(gettext('%r is too short to calculate a relative path')
1150
1227
            % (base,))
1151
1228
 
1152
1229
    rp = abspath(path)
1462
1539
    # a similar effect.
1463
1540
 
1464
1541
    # If BZR_COLUMNS is set, take it, user is always right
 
1542
    # Except if they specified 0 in which case, impose no limit here
1465
1543
    try:
1466
 
        return int(os.environ['BZR_COLUMNS'])
 
1544
        width = int(os.environ['BZR_COLUMNS'])
1467
1545
    except (KeyError, ValueError):
1468
 
        pass
 
1546
        width = None
 
1547
    if width is not None:
 
1548
        if width > 0:
 
1549
            return width
 
1550
        else:
 
1551
            return None
1469
1552
 
1470
1553
    isatty = getattr(sys.stdout, 'isatty', None)
1471
1554
    if isatty is None or not isatty():
1721
1804
    """
1722
1805
    global _selected_dir_reader
1723
1806
    if _selected_dir_reader is None:
1724
 
        fs_encoding = _fs_enc.upper()
1725
1807
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1726
1808
            # Win98 doesn't have unicode apis like FindFirstFileW
1727
1809
            # TODO: We possibly could support Win98 by falling back to the
1733
1815
                _selected_dir_reader = Win32ReadDir()
1734
1816
            except ImportError:
1735
1817
                pass
1736
 
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1737
 
            # ANSI_X3.4-1968 is a form of ASCII
 
1818
        elif _fs_enc in ('utf-8', 'ascii'):
1738
1819
            try:
1739
1820
                from bzrlib._readdir_pyx import UTF8DirReader
1740
1821
                _selected_dir_reader = UTF8DirReader()
1875
1956
        s = os.stat(src)
1876
1957
        chown(dst, s.st_uid, s.st_gid)
1877
1958
    except OSError, e:
1878
 
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
 
1959
        trace.warning(
 
1960
            'Unable to copy ownership from "%s" to "%s". '
 
1961
            'You may want to set it manually.', src, dst)
 
1962
        trace.log_exception_quietly()
1879
1963
 
1880
1964
 
1881
1965
def path_prefix_key(path):
1896
1980
_cached_user_encoding = None
1897
1981
 
1898
1982
 
1899
 
def get_user_encoding(use_cache=True):
 
1983
def get_user_encoding(use_cache=DEPRECATED_PARAMETER):
1900
1984
    """Find out what the preferred user encoding is.
1901
1985
 
1902
1986
    This is generally the encoding that is used for command line parameters
1903
1987
    and file contents. This may be different from the terminal encoding
1904
1988
    or the filesystem encoding.
1905
1989
 
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
1990
    :return: A string defining the preferred user encoding
1911
1991
    """
1912
1992
    global _cached_user_encoding
1913
 
    if _cached_user_encoding is not None and use_cache:
 
1993
    if deprecated_passed(use_cache):
 
1994
        warn_deprecated("use_cache should only have been used for tests",
 
1995
            DeprecationWarning, stacklevel=2) 
 
1996
    if _cached_user_encoding is not None:
1914
1997
        return _cached_user_encoding
1915
1998
 
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'
 
1999
    if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
 
2000
        # Use the existing locale settings and call nl_langinfo directly
 
2001
        # rather than going through getpreferredencoding. This avoids
 
2002
        # <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
 
2003
        # possibility of the setlocale call throwing an error.
 
2004
        user_encoding = locale.nl_langinfo(locale.CODESET)
1933
2005
    else:
1934
 
        import locale
 
2006
        # GZ 2011-12-19: On windows could call GetACP directly instead.
 
2007
        user_encoding = locale.getpreferredencoding(False)
1935
2008
 
1936
2009
    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:
 
2010
        user_encoding = codecs.lookup(user_encoding).name
 
2011
    except LookupError:
 
2012
        if user_encoding not in ("", "cp0"):
1959
2013
            sys.stderr.write('bzr: warning:'
1960
2014
                             ' unknown encoding %s.'
1961
2015
                             ' Continuing with ascii encoding.\n'
1962
2016
                             % user_encoding
1963
2017
                            )
1964
 
            user_encoding = 'ascii'
1965
 
 
1966
 
    if use_cache:
1967
 
        _cached_user_encoding = user_encoding
1968
 
 
 
2018
        user_encoding = 'ascii'
 
2019
    else:
 
2020
        # Get 'ascii' when setlocale has not been called or LANG=C or unset.
 
2021
        if user_encoding == 'ascii':
 
2022
            if sys.platform == 'darwin':
 
2023
                # OSX is special-cased in Python to have a UTF-8 filesystem
 
2024
                # encoding and previously had LANG set here if not present.
 
2025
                user_encoding = 'utf-8'
 
2026
            # GZ 2011-12-19: Maybe UTF-8 should be the default in this case
 
2027
            #                for some other posix platforms as well.
 
2028
 
 
2029
    _cached_user_encoding = user_encoding
1969
2030
    return user_encoding
1970
2031
 
1971
2032
 
1980
2041
    behaves inconsistently on different platforms.
1981
2042
    """
1982
2043
    if sys.platform == "win32":
1983
 
        import win32utils
1984
2044
        return win32utils.get_host_name()
1985
2045
    else:
1986
2046
        import socket
1993
2053
# data at once.
1994
2054
MAX_SOCKET_CHUNK = 64 * 1024
1995
2055
 
 
2056
_end_of_stream_errors = [errno.ECONNRESET]
 
2057
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
 
2058
    _eno = getattr(errno, _eno, None)
 
2059
    if _eno is not None:
 
2060
        _end_of_stream_errors.append(_eno)
 
2061
del _eno
 
2062
 
 
2063
 
1996
2064
def read_bytes_from_socket(sock, report_activity=None,
1997
2065
        max_read_size=MAX_SOCKET_CHUNK):
1998
2066
    """Read up to max_read_size of bytes from sock and notify of progress.
2006
2074
            bytes = sock.recv(max_read_size)
2007
2075
        except socket.error, e:
2008
2076
            eno = e.args[0]
2009
 
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
 
2077
            if eno in _end_of_stream_errors:
2010
2078
                # The connection was closed by the other side.  Callers expect
2011
2079
                # an empty string to signal end-of-stream.
2012
2080
                return ""
2153
2221
    return file_kind_from_stat_mode(mode)
2154
2222
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2155
2223
 
2156
 
 
2157
 
def file_kind(f, _lstat=os.lstat):
 
2224
def file_stat(f, _lstat=os.lstat):
2158
2225
    try:
2159
 
        return file_kind_from_stat_mode(_lstat(f).st_mode)
 
2226
        # XXX cache?
 
2227
        return _lstat(f)
2160
2228
    except OSError, e:
2161
2229
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2162
2230
            raise errors.NoSuchFile(f)
2163
2231
        raise
2164
2232
 
 
2233
def file_kind(f, _lstat=os.lstat):
 
2234
    stat_value = file_stat(f, _lstat)
 
2235
    return file_kind_from_stat_mode(stat_value.st_mode)
2165
2236
 
2166
2237
def until_no_eintr(f, *a, **kw):
2167
2238
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2211
2282
 
2212
2283
 
2213
2284
if sys.platform == "win32":
2214
 
    import msvcrt
2215
2285
    def getchar():
 
2286
        import msvcrt
2216
2287
        return msvcrt.getch()
2217
2288
else:
2218
 
    import tty
2219
 
    import termios
2220
2289
    def getchar():
 
2290
        import tty
 
2291
        import termios
2221
2292
        fd = sys.stdin.fileno()
2222
2293
        settings = termios.tcgetattr(fd)
2223
2294
        try:
2227
2298
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2228
2299
        return ch
2229
2300
 
2230
 
 
2231
 
if sys.platform == 'linux2':
 
2301
if sys.platform.startswith('linux'):
2232
2302
    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
 
2303
        try:
 
2304
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2305
        except (ValueError, OSError, AttributeError):
 
2306
            return None
2239
2307
elif sys.platform == 'darwin':
2240
2308
    def _local_concurrency():
2241
2309
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2242
2310
                                stdout=subprocess.PIPE).communicate()[0]
2243
 
elif sys.platform[0:7] == 'freebsd':
 
2311
elif "bsd" in sys.platform:
2244
2312
    def _local_concurrency():
2245
2313
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2246
2314
                                stdout=subprocess.PIPE).communicate()[0]
2274
2342
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2275
2343
    if concurrency is None:
2276
2344
        try:
2277
 
            concurrency = _local_concurrency()
2278
 
        except (OSError, IOError):
2279
 
            pass
 
2345
            import multiprocessing
 
2346
            concurrency = multiprocessing.cpu_count()
 
2347
        except (ImportError, NotImplementedError):
 
2348
            # multiprocessing is only available on Python >= 2.6
 
2349
            # and multiprocessing.cpu_count() isn't implemented on all
 
2350
            # platforms
 
2351
            try:
 
2352
                concurrency = _local_concurrency()
 
2353
            except (OSError, IOError):
 
2354
                pass
2280
2355
    try:
2281
2356
        concurrency = int(concurrency)
2282
2357
    except (TypeError, ValueError):
2344
2419
    open_file = open
2345
2420
 
2346
2421
 
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
 
2422
def available_backup_name(base, exists):
 
2423
    """Find a non-existing backup file name.
 
2424
 
 
2425
    This will *not* create anything, this only return a 'free' entry.  This
 
2426
    should be used for checking names in a directory below a locked
 
2427
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
 
2428
    Leap) and generally discouraged.
 
2429
 
 
2430
    :param base: The base name.
 
2431
 
 
2432
    :param exists: A callable returning True if the path parameter exists.
 
2433
    """
 
2434
    counter = 1
 
2435
    name = "%s.~%d~" % (base, counter)
 
2436
    while exists(name):
 
2437
        counter += 1
 
2438
        name = "%s.~%d~" % (base, counter)
 
2439
    return name
 
2440
 
 
2441
 
 
2442
def set_fd_cloexec(fd):
 
2443
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
 
2444
    support for this is not available.
 
2445
    """
 
2446
    try:
 
2447
        import fcntl
 
2448
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
 
2449
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
 
2450
    except (ImportError, AttributeError):
 
2451
        # Either the fcntl module or specific constants are not present
 
2452
        pass
 
2453
 
 
2454
 
 
2455
def find_executable_on_path(name):
 
2456
    """Finds an executable on the PATH.
 
2457
    
 
2458
    On Windows, this will try to append each extension in the PATHEXT
 
2459
    environment variable to the name, if it cannot be found with the name
 
2460
    as given.
 
2461
    
 
2462
    :param name: The base name of the executable.
 
2463
    :return: The path to the executable found or None.
 
2464
    """
 
2465
    path = os.environ.get('PATH')
 
2466
    if path is None:
 
2467
        return None
 
2468
    path = path.split(os.pathsep)
 
2469
    if sys.platform == 'win32':
 
2470
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
 
2471
        exts = [ext.lower() for ext in exts]
 
2472
        base, ext = os.path.splitext(name)
 
2473
        if ext != '':
 
2474
            if ext.lower() not in exts:
 
2475
                return None
 
2476
            name = base
 
2477
            exts = [ext]
 
2478
    else:
 
2479
        exts = ['']
 
2480
    for ext in exts:
 
2481
        for d in path:
 
2482
            f = os.path.join(d, name) + ext
 
2483
            if os.access(f, os.X_OK):
 
2484
                return f
 
2485
    return None
 
2486
 
 
2487
 
 
2488
def _posix_is_local_pid_dead(pid):
 
2489
    """True if pid doesn't correspond to live process on this machine"""
 
2490
    try:
 
2491
        # Special meaning of unix kill: just check if it's there.
 
2492
        os.kill(pid, 0)
 
2493
    except OSError, e:
 
2494
        if e.errno == errno.ESRCH:
 
2495
            # On this machine, and really not found: as sure as we can be
 
2496
            # that it's dead.
 
2497
            return True
 
2498
        elif e.errno == errno.EPERM:
 
2499
            # exists, though not ours
 
2500
            return False
 
2501
        else:
 
2502
            mutter("os.kill(%d, 0) failed: %s" % (pid, e))
 
2503
            # Don't really know.
 
2504
            return False
 
2505
    else:
 
2506
        # Exists and our process: not dead.
 
2507
        return False
 
2508
 
 
2509
if sys.platform == "win32":
 
2510
    is_local_pid_dead = win32utils.is_local_pid_dead
 
2511
else:
 
2512
    is_local_pid_dead = _posix_is_local_pid_dead
 
2513
 
 
2514
 
 
2515
def fdatasync(fileno):
 
2516
    """Flush file contents to disk if possible.
 
2517
    
 
2518
    :param fileno: Integer OS file handle.
 
2519
    :raises TransportNotPossible: If flushing to disk is not possible.
 
2520
    """
 
2521
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
 
2522
    if fn is not None:
 
2523
        fn(fileno)
 
2524
 
 
2525
 
 
2526
def ensure_empty_directory_exists(path, exception_class):
 
2527
    """Make sure a local directory exists and is empty.
 
2528
    
 
2529
    If it does not exist, it is created.  If it exists and is not empty, an
 
2530
    instance of exception_class is raised.
 
2531
    """
 
2532
    try:
 
2533
        os.mkdir(path)
 
2534
    except OSError, e:
 
2535
        if e.errno != errno.EEXIST:
 
2536
            raise
 
2537
        if os.listdir(path) != []:
 
2538
            raise exception_class(path)
 
2539
 
 
2540
 
 
2541
def is_environment_error(evalue):
 
2542
    """True if exception instance is due to a process environment issue
 
2543
 
 
2544
    This includes OSError and IOError, but also other errors that come from
 
2545
    the operating system or core libraries but are not subclasses of those.
 
2546
    """
 
2547
    if isinstance(evalue, (EnvironmentError, select.error)):
 
2548
        return True
 
2549
    if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
 
2550
        return True
 
2551
    return False