~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Jelmer Vernooij
  • Date: 2012-02-29 13:55:25 UTC
  • mto: (6437.23.22 2.5)
  • mto: This revision was merged to the branch mainline in revision 6493.
  • Revision ID: jelmer@samba.org-20120229135525-1krnrr2imulo56xj
Merge fix for bzrlib API link.

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
 
382
455
abspath = _posix_abspath
383
456
realpath = _posix_realpath
384
457
pathjoin = os.path.join
385
 
normpath = os.path.normpath
 
458
normpath = _posix_normpath
 
459
path_from_environ = _posix_path_from_environ
 
460
_get_home_dir = _posix_get_home_dir
 
461
getuser_unicode = _posix_getuser_unicode
386
462
getcwd = os.getcwdu
387
463
rename = os.rename
388
464
dirname = os.path.dirname
392
468
# These were already lazily imported into local scope
393
469
# mkdtemp = tempfile.mkdtemp
394
470
# rmtree = shutil.rmtree
 
471
lstat = os.lstat
 
472
fstat = os.fstat
 
473
 
 
474
def wrap_stat(st):
 
475
    return st
 
476
 
395
477
 
396
478
MIN_ABS_PATHLENGTH = 1
397
479
 
407
489
    getcwd = _win32_getcwd
408
490
    mkdtemp = _win32_mkdtemp
409
491
    rename = _win32_rename
 
492
    try:
 
493
        from bzrlib import _walkdirs_win32
 
494
    except ImportError:
 
495
        pass
 
496
    else:
 
497
        lstat = _walkdirs_win32.lstat
 
498
        fstat = _walkdirs_win32.fstat
 
499
        wrap_stat = _walkdirs_win32.wrap_stat
410
500
 
411
501
    MIN_ABS_PATHLENGTH = 3
412
502
 
430
520
    f = win32utils.get_unicode_argv     # special function or None
431
521
    if f is not None:
432
522
        get_unicode_argv = f
 
523
    path_from_environ = win32utils.get_environ_unicode
 
524
    _get_home_dir = win32utils.get_home_location
 
525
    getuser_unicode = win32utils.get_user_name
433
526
 
434
527
elif sys.platform == 'darwin':
435
528
    getcwd = _mac_getcwd
867
960
    return os.fstat(f.fileno())[stat.ST_SIZE]
868
961
 
869
962
 
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
 
963
# Alias os.urandom to support platforms (which?) without /dev/urandom and 
 
964
# override if it doesn't work. Avoid checking on windows where there is
 
965
# significant initialisation cost that can be avoided for some bzr calls.
 
966
 
 
967
rand_bytes = os.urandom
 
968
 
 
969
if rand_bytes.__module__ != "nt":
879
970
    try:
880
 
        rand_bytes = file('/dev/urandom', 'rb').read
881
 
    # Otherwise, use this hack as a last resort
882
 
    except (IOError, OSError):
 
971
        rand_bytes(1)
 
972
    except NotImplementedError:
883
973
        # not well seeded, but better than nothing
884
974
        def rand_bytes(n):
885
975
            import random
915
1005
    rps = []
916
1006
    for f in ps:
917
1007
        if f == '..':
918
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1008
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
919
1009
        elif (f == '.') or (f == ''):
920
1010
            pass
921
1011
        else:
926
1016
def joinpath(p):
927
1017
    for f in p:
928
1018
        if (f == '..') or (f is None) or (f == ''):
929
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1019
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
930
1020
    return pathjoin(*p)
931
1021
 
932
1022
 
967
1057
    # they tend to happen very early in startup when we can't check config
968
1058
    # files etc, and also we want to report all failures but not spam the user
969
1059
    # with 10 warnings.
970
 
    from bzrlib import trace
971
1060
    exception_str = str(exception)
972
1061
    if exception_str not in _extension_load_failures:
973
1062
        trace.mutter("failed to load compiled extension: %s" % exception_str)
977
1066
def report_extension_load_failures():
978
1067
    if not _extension_load_failures:
979
1068
        return
980
 
    from bzrlib.config import GlobalConfig
981
 
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
 
1069
    if config.GlobalStack().get('ignore_missing_extensions'):
982
1070
        return
983
1071
    # the warnings framework should by default show this only once
984
1072
    from bzrlib.trace import warning
1146
1234
 
1147
1235
    if len(base) < MIN_ABS_PATHLENGTH:
1148
1236
        # must have space for e.g. a drive letter
1149
 
        raise ValueError('%r is too short to calculate a relative path'
 
1237
        raise ValueError(gettext('%r is too short to calculate a relative path')
1150
1238
            % (base,))
1151
1239
 
1152
1240
    rp = abspath(path)
1462
1550
    # a similar effect.
1463
1551
 
1464
1552
    # If BZR_COLUMNS is set, take it, user is always right
 
1553
    # Except if they specified 0 in which case, impose no limit here
1465
1554
    try:
1466
 
        return int(os.environ['BZR_COLUMNS'])
 
1555
        width = int(os.environ['BZR_COLUMNS'])
1467
1556
    except (KeyError, ValueError):
1468
 
        pass
 
1557
        width = None
 
1558
    if width is not None:
 
1559
        if width > 0:
 
1560
            return width
 
1561
        else:
 
1562
            return None
1469
1563
 
1470
1564
    isatty = getattr(sys.stdout, 'isatty', None)
1471
1565
    if isatty is None or not isatty():
1721
1815
    """
1722
1816
    global _selected_dir_reader
1723
1817
    if _selected_dir_reader is None:
1724
 
        fs_encoding = _fs_enc.upper()
1725
1818
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1726
1819
            # Win98 doesn't have unicode apis like FindFirstFileW
1727
1820
            # TODO: We possibly could support Win98 by falling back to the
1733
1826
                _selected_dir_reader = Win32ReadDir()
1734
1827
            except ImportError:
1735
1828
                pass
1736
 
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1737
 
            # ANSI_X3.4-1968 is a form of ASCII
 
1829
        elif _fs_enc in ('utf-8', 'ascii'):
1738
1830
            try:
1739
1831
                from bzrlib._readdir_pyx import UTF8DirReader
1740
1832
                _selected_dir_reader = UTF8DirReader()
1875
1967
        s = os.stat(src)
1876
1968
        chown(dst, s.st_uid, s.st_gid)
1877
1969
    except OSError, e:
1878
 
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
 
1970
        trace.warning(
 
1971
            'Unable to copy ownership from "%s" to "%s". '
 
1972
            'You may want to set it manually.', src, dst)
 
1973
        trace.log_exception_quietly()
1879
1974
 
1880
1975
 
1881
1976
def path_prefix_key(path):
1896
1991
_cached_user_encoding = None
1897
1992
 
1898
1993
 
1899
 
def get_user_encoding(use_cache=True):
 
1994
def get_user_encoding(use_cache=DEPRECATED_PARAMETER):
1900
1995
    """Find out what the preferred user encoding is.
1901
1996
 
1902
1997
    This is generally the encoding that is used for command line parameters
1903
1998
    and file contents. This may be different from the terminal encoding
1904
1999
    or the filesystem encoding.
1905
2000
 
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
2001
    :return: A string defining the preferred user encoding
1911
2002
    """
1912
2003
    global _cached_user_encoding
1913
 
    if _cached_user_encoding is not None and use_cache:
 
2004
    if deprecated_passed(use_cache):
 
2005
        warn_deprecated("use_cache should only have been used for tests",
 
2006
            DeprecationWarning, stacklevel=2) 
 
2007
    if _cached_user_encoding is not None:
1914
2008
        return _cached_user_encoding
1915
2009
 
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'
 
2010
    if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
 
2011
        # Use the existing locale settings and call nl_langinfo directly
 
2012
        # rather than going through getpreferredencoding. This avoids
 
2013
        # <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
 
2014
        # possibility of the setlocale call throwing an error.
 
2015
        user_encoding = locale.nl_langinfo(locale.CODESET)
1933
2016
    else:
1934
 
        import locale
 
2017
        # GZ 2011-12-19: On windows could call GetACP directly instead.
 
2018
        user_encoding = locale.getpreferredencoding(False)
1935
2019
 
1936
2020
    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:
 
2021
        user_encoding = codecs.lookup(user_encoding).name
 
2022
    except LookupError:
 
2023
        if user_encoding not in ("", "cp0"):
1959
2024
            sys.stderr.write('bzr: warning:'
1960
2025
                             ' unknown encoding %s.'
1961
2026
                             ' Continuing with ascii encoding.\n'
1962
2027
                             % user_encoding
1963
2028
                            )
1964
 
            user_encoding = 'ascii'
1965
 
 
1966
 
    if use_cache:
1967
 
        _cached_user_encoding = user_encoding
1968
 
 
 
2029
        user_encoding = 'ascii'
 
2030
    else:
 
2031
        # Get 'ascii' when setlocale has not been called or LANG=C or unset.
 
2032
        if user_encoding == 'ascii':
 
2033
            if sys.platform == 'darwin':
 
2034
                # OSX is special-cased in Python to have a UTF-8 filesystem
 
2035
                # encoding and previously had LANG set here if not present.
 
2036
                user_encoding = 'utf-8'
 
2037
            # GZ 2011-12-19: Maybe UTF-8 should be the default in this case
 
2038
            #                for some other posix platforms as well.
 
2039
 
 
2040
    _cached_user_encoding = user_encoding
1969
2041
    return user_encoding
1970
2042
 
1971
2043
 
1980
2052
    behaves inconsistently on different platforms.
1981
2053
    """
1982
2054
    if sys.platform == "win32":
1983
 
        import win32utils
1984
2055
        return win32utils.get_host_name()
1985
2056
    else:
1986
2057
        import socket
1993
2064
# data at once.
1994
2065
MAX_SOCKET_CHUNK = 64 * 1024
1995
2066
 
 
2067
_end_of_stream_errors = [errno.ECONNRESET]
 
2068
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
 
2069
    _eno = getattr(errno, _eno, None)
 
2070
    if _eno is not None:
 
2071
        _end_of_stream_errors.append(_eno)
 
2072
del _eno
 
2073
 
 
2074
 
1996
2075
def read_bytes_from_socket(sock, report_activity=None,
1997
2076
        max_read_size=MAX_SOCKET_CHUNK):
1998
2077
    """Read up to max_read_size of bytes from sock and notify of progress.
2006
2085
            bytes = sock.recv(max_read_size)
2007
2086
        except socket.error, e:
2008
2087
            eno = e.args[0]
2009
 
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
 
2088
            if eno in _end_of_stream_errors:
2010
2089
                # The connection was closed by the other side.  Callers expect
2011
2090
                # an empty string to signal end-of-stream.
2012
2091
                return ""
2153
2232
    return file_kind_from_stat_mode(mode)
2154
2233
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2155
2234
 
2156
 
 
2157
 
def file_kind(f, _lstat=os.lstat):
 
2235
def file_stat(f, _lstat=os.lstat):
2158
2236
    try:
2159
 
        return file_kind_from_stat_mode(_lstat(f).st_mode)
 
2237
        # XXX cache?
 
2238
        return _lstat(f)
2160
2239
    except OSError, e:
2161
2240
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2162
2241
            raise errors.NoSuchFile(f)
2163
2242
        raise
2164
2243
 
 
2244
def file_kind(f, _lstat=os.lstat):
 
2245
    stat_value = file_stat(f, _lstat)
 
2246
    return file_kind_from_stat_mode(stat_value.st_mode)
2165
2247
 
2166
2248
def until_no_eintr(f, *a, **kw):
2167
2249
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2211
2293
 
2212
2294
 
2213
2295
if sys.platform == "win32":
2214
 
    import msvcrt
2215
2296
    def getchar():
 
2297
        import msvcrt
2216
2298
        return msvcrt.getch()
2217
2299
else:
2218
 
    import tty
2219
 
    import termios
2220
2300
    def getchar():
 
2301
        import tty
 
2302
        import termios
2221
2303
        fd = sys.stdin.fileno()
2222
2304
        settings = termios.tcgetattr(fd)
2223
2305
        try:
2227
2309
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2228
2310
        return ch
2229
2311
 
2230
 
 
2231
 
if sys.platform == 'linux2':
 
2312
if sys.platform.startswith('linux'):
2232
2313
    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
 
2314
        try:
 
2315
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2316
        except (ValueError, OSError, AttributeError):
 
2317
            return None
2239
2318
elif sys.platform == 'darwin':
2240
2319
    def _local_concurrency():
2241
2320
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2242
2321
                                stdout=subprocess.PIPE).communicate()[0]
2243
 
elif sys.platform[0:7] == 'freebsd':
 
2322
elif "bsd" in sys.platform:
2244
2323
    def _local_concurrency():
2245
2324
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2246
2325
                                stdout=subprocess.PIPE).communicate()[0]
2274
2353
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2275
2354
    if concurrency is None:
2276
2355
        try:
2277
 
            concurrency = _local_concurrency()
2278
 
        except (OSError, IOError):
2279
 
            pass
 
2356
            import multiprocessing
 
2357
            concurrency = multiprocessing.cpu_count()
 
2358
        except (ImportError, NotImplementedError):
 
2359
            # multiprocessing is only available on Python >= 2.6
 
2360
            # and multiprocessing.cpu_count() isn't implemented on all
 
2361
            # platforms
 
2362
            try:
 
2363
                concurrency = _local_concurrency()
 
2364
            except (OSError, IOError):
 
2365
                pass
2280
2366
    try:
2281
2367
        concurrency = int(concurrency)
2282
2368
    except (TypeError, ValueError):
2344
2430
    open_file = open
2345
2431
 
2346
2432
 
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
 
2433
def available_backup_name(base, exists):
 
2434
    """Find a non-existing backup file name.
 
2435
 
 
2436
    This will *not* create anything, this only return a 'free' entry.  This
 
2437
    should be used for checking names in a directory below a locked
 
2438
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
 
2439
    Leap) and generally discouraged.
 
2440
 
 
2441
    :param base: The base name.
 
2442
 
 
2443
    :param exists: A callable returning True if the path parameter exists.
 
2444
    """
 
2445
    counter = 1
 
2446
    name = "%s.~%d~" % (base, counter)
 
2447
    while exists(name):
 
2448
        counter += 1
 
2449
        name = "%s.~%d~" % (base, counter)
 
2450
    return name
 
2451
 
 
2452
 
 
2453
def set_fd_cloexec(fd):
 
2454
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
 
2455
    support for this is not available.
 
2456
    """
 
2457
    try:
 
2458
        import fcntl
 
2459
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
 
2460
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
 
2461
    except (ImportError, AttributeError):
 
2462
        # Either the fcntl module or specific constants are not present
 
2463
        pass
 
2464
 
 
2465
 
 
2466
def find_executable_on_path(name):
 
2467
    """Finds an executable on the PATH.
 
2468
    
 
2469
    On Windows, this will try to append each extension in the PATHEXT
 
2470
    environment variable to the name, if it cannot be found with the name
 
2471
    as given.
 
2472
    
 
2473
    :param name: The base name of the executable.
 
2474
    :return: The path to the executable found or None.
 
2475
    """
 
2476
    if sys.platform == 'win32':
 
2477
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
 
2478
        exts = [ext.lower() for ext in exts]
 
2479
        base, ext = os.path.splitext(name)
 
2480
        if ext != '':
 
2481
            if ext.lower() not in exts:
 
2482
                return None
 
2483
            name = base
 
2484
            exts = [ext]
 
2485
    else:
 
2486
        exts = ['']
 
2487
    path = os.environ.get('PATH')
 
2488
    if path is not None:
 
2489
        path = path.split(os.pathsep)
 
2490
        for ext in exts:
 
2491
            for d in path:
 
2492
                f = os.path.join(d, name) + ext
 
2493
                if os.access(f, os.X_OK):
 
2494
                    return f
 
2495
    if sys.platform == 'win32':
 
2496
        app_path = win32utils.get_app_path(name)
 
2497
        if app_path != name:
 
2498
            return app_path
 
2499
    return None
 
2500
 
 
2501
 
 
2502
def _posix_is_local_pid_dead(pid):
 
2503
    """True if pid doesn't correspond to live process on this machine"""
 
2504
    try:
 
2505
        # Special meaning of unix kill: just check if it's there.
 
2506
        os.kill(pid, 0)
 
2507
    except OSError, e:
 
2508
        if e.errno == errno.ESRCH:
 
2509
            # On this machine, and really not found: as sure as we can be
 
2510
            # that it's dead.
 
2511
            return True
 
2512
        elif e.errno == errno.EPERM:
 
2513
            # exists, though not ours
 
2514
            return False
 
2515
        else:
 
2516
            mutter("os.kill(%d, 0) failed: %s" % (pid, e))
 
2517
            # Don't really know.
 
2518
            return False
 
2519
    else:
 
2520
        # Exists and our process: not dead.
 
2521
        return False
 
2522
 
 
2523
if sys.platform == "win32":
 
2524
    is_local_pid_dead = win32utils.is_local_pid_dead
 
2525
else:
 
2526
    is_local_pid_dead = _posix_is_local_pid_dead
 
2527
 
 
2528
 
 
2529
def fdatasync(fileno):
 
2530
    """Flush file contents to disk if possible.
 
2531
    
 
2532
    :param fileno: Integer OS file handle.
 
2533
    :raises TransportNotPossible: If flushing to disk is not possible.
 
2534
    """
 
2535
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
 
2536
    if fn is not None:
 
2537
        fn(fileno)
 
2538
 
 
2539
 
 
2540
def ensure_empty_directory_exists(path, exception_class):
 
2541
    """Make sure a local directory exists and is empty.
 
2542
    
 
2543
    If it does not exist, it is created.  If it exists and is not empty, an
 
2544
    instance of exception_class is raised.
 
2545
    """
 
2546
    try:
 
2547
        os.mkdir(path)
 
2548
    except OSError, e:
 
2549
        if e.errno != errno.EEXIST:
 
2550
            raise
 
2551
        if os.listdir(path) != []:
 
2552
            raise exception_class(path)
 
2553
 
 
2554
 
 
2555
def is_environment_error(evalue):
 
2556
    """True if exception instance is due to a process environment issue
 
2557
 
 
2558
    This includes OSError and IOError, but also other errors that come from
 
2559
    the operating system or core libraries but are not subclasses of those.
 
2560
    """
 
2561
    if isinstance(evalue, (EnvironmentError, select.error)):
 
2562
        return True
 
2563
    if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
 
2564
        return True
 
2565
    return False