~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-12-02 14:58:47 UTC
  • mfrom: (5554.1.3 trunk)
  • Revision ID: pqm@pqm.ubuntu.com-20101202145847-fw822sd3nyhvrwmi
(vila) Merge 2.2 into trunk including fix for bug #583667 and bug
        #681885 (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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
 
 
19
17
import errno
20
18
import os
21
19
import re
28
26
lazy_import(globals(), """
29
27
from datetime import datetime
30
28
import getpass
31
 
import locale
32
29
import ntpath
33
30
import posixpath
34
 
import select
35
31
# We need to import both shutil and rmtree as we export the later on posix
36
32
# and need the former on windows
37
33
import shutil
46
42
 
47
43
from bzrlib import (
48
44
    cache_utf8,
49
 
    config,
50
45
    errors,
51
46
    trace,
52
47
    win32utils,
53
48
    )
54
 
from bzrlib.i18n import gettext
55
49
""")
56
50
 
57
51
from bzrlib.symbol_versioning import (
58
 
    DEPRECATED_PARAMETER,
59
52
    deprecated_function,
60
53
    deprecated_in,
61
 
    deprecated_passed,
62
 
    warn as warn_deprecated,
63
54
    )
64
55
 
65
 
from hashlib import (
66
 
    md5,
67
 
    sha1 as sha,
68
 
    )
 
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
        )
69
68
 
70
69
 
71
70
import bzrlib
72
 
from bzrlib import symbol_versioning, _fs_enc
 
71
from bzrlib import symbol_versioning
73
72
 
74
73
 
75
74
# Cross platform wall-clock time functionality with decent resolution.
97
96
        user_encoding = get_user_encoding()
98
97
        return [a.decode(user_encoding) for a in sys.argv[1:]]
99
98
    except UnicodeDecodeError:
100
 
        raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
101
 
            "application locale.").format(a, user_encoding))
 
99
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
 
100
                                                            "encoding." % a))
102
101
 
103
102
 
104
103
def make_readonly(filename):
106
105
    mod = os.lstat(filename).st_mode
107
106
    if not stat.S_ISLNK(mod):
108
107
        mod = mod & 0777555
109
 
        chmod_if_possible(filename, mod)
 
108
        os.chmod(filename, mod)
110
109
 
111
110
 
112
111
def make_writable(filename):
113
112
    mod = os.lstat(filename).st_mode
114
113
    if not stat.S_ISLNK(mod):
115
114
        mod = mod | 0200
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
 
115
        os.chmod(filename, mod)
136
116
 
137
117
 
138
118
def minimum_path_selection(paths):
217
197
            if e.errno == errno.ENOENT:
218
198
                return False;
219
199
            else:
220
 
                raise errors.BzrError(gettext("lstat/stat of ({0!r}): {1!r}").format(f, e))
 
200
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
221
201
 
222
202
 
223
203
def fancy_rename(old, new, rename_func, unlink_func):
289
269
            else:
290
270
                rename_func(tmp_name, new)
291
271
    if failure_exc is not None:
292
 
        try:
293
 
            raise failure_exc[0], failure_exc[1], failure_exc[2]
294
 
        finally:
295
 
            del failure_exc
 
272
        raise failure_exc[0], failure_exc[1], failure_exc[2]
296
273
 
297
274
 
298
275
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
299
276
# choke on a Unicode string containing a relative path if
300
277
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
301
278
# string.
 
279
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
302
280
def _posix_abspath(path):
303
281
    # jam 20060426 rather than encoding to fsencoding
304
282
    # copy posixpath.abspath, but use os.getcwdu instead
305
283
    if not posixpath.isabs(path):
306
284
        path = posixpath.join(getcwd(), path)
307
 
    return _posix_normpath(path)
 
285
    return posixpath.normpath(path)
308
286
 
309
287
 
310
288
def _posix_realpath(path):
311
289
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
312
290
 
313
291
 
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
 
 
365
292
def _win32_fixdrive(path):
366
293
    """Force drive letters to be consistent.
367
294
 
450
377
    return unicodedata.normalize('NFC', os.getcwdu())
451
378
 
452
379
 
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
 
 
476
380
# Default is to just use the python builtins, but these can be rebound on
477
381
# particular platforms.
478
382
abspath = _posix_abspath
479
383
realpath = _posix_realpath
480
384
pathjoin = os.path.join
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
 
385
normpath = os.path.normpath
485
386
getcwd = os.getcwdu
 
387
rename = os.rename
486
388
dirname = os.path.dirname
487
389
basename = os.path.basename
488
390
split = os.path.split
490
392
# These were already lazily imported into local scope
491
393
# mkdtemp = tempfile.mkdtemp
492
394
# rmtree = shutil.rmtree
493
 
lstat = os.lstat
494
 
fstat = os.fstat
495
 
 
496
 
def wrap_stat(st):
497
 
    return st
498
 
 
499
395
 
500
396
MIN_ABS_PATHLENGTH = 1
501
397
 
510
406
    normpath = _win32_normpath
511
407
    getcwd = _win32_getcwd
512
408
    mkdtemp = _win32_mkdtemp
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
 
409
    rename = _win32_rename
522
410
 
523
411
    MIN_ABS_PATHLENGTH = 3
524
412
 
542
430
    f = win32utils.get_unicode_argv     # special function or None
543
431
    if f is not None:
544
432
        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
548
433
 
549
434
elif sys.platform == 'darwin':
550
435
    getcwd = _mac_getcwd
982
867
    return os.fstat(f.fileno())[stat.ST_SIZE]
983
868
 
984
869
 
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":
 
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
992
879
    try:
993
 
        rand_bytes(1)
994
 
    except NotImplementedError:
 
880
        rand_bytes = file('/dev/urandom', 'rb').read
 
881
    # Otherwise, use this hack as a last resort
 
882
    except (IOError, OSError):
995
883
        # not well seeded, but better than nothing
996
884
        def rand_bytes(n):
997
885
            import random
1027
915
    rps = []
1028
916
    for f in ps:
1029
917
        if f == '..':
1030
 
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
 
918
            raise errors.BzrError("sorry, %r not allowed in path" % f)
1031
919
        elif (f == '.') or (f == ''):
1032
920
            pass
1033
921
        else:
1038
926
def joinpath(p):
1039
927
    for f in p:
1040
928
        if (f == '..') or (f is None) or (f == ''):
1041
 
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
 
929
            raise errors.BzrError("sorry, %r not allowed in path" % f)
1042
930
    return pathjoin(*p)
1043
931
 
1044
932
 
1088
976
def report_extension_load_failures():
1089
977
    if not _extension_load_failures:
1090
978
        return
1091
 
    if config.GlobalStack().get('ignore_missing_extensions'):
 
979
    from bzrlib.config import GlobalConfig
 
980
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
1092
981
        return
1093
982
    # the warnings framework should by default show this only once
1094
983
    from bzrlib.trace import warning
1256
1145
 
1257
1146
    if len(base) < MIN_ABS_PATHLENGTH:
1258
1147
        # must have space for e.g. a drive letter
1259
 
        raise ValueError(gettext('%r is too short to calculate a relative path')
 
1148
        raise ValueError('%r is too short to calculate a relative path'
1260
1149
            % (base,))
1261
1150
 
1262
1151
    rp = abspath(path)
1572
1461
    # a similar effect.
1573
1462
 
1574
1463
    # If BZR_COLUMNS is set, take it, user is always right
1575
 
    # Except if they specified 0 in which case, impose no limit here
1576
1464
    try:
1577
 
        width = int(os.environ['BZR_COLUMNS'])
 
1465
        return int(os.environ['BZR_COLUMNS'])
1578
1466
    except (KeyError, ValueError):
1579
 
        width = None
1580
 
    if width is not None:
1581
 
        if width > 0:
1582
 
            return width
1583
 
        else:
1584
 
            return None
 
1467
        pass
1585
1468
 
1586
1469
    isatty = getattr(sys.stdout, 'isatty', None)
1587
1470
    if isatty is None or not isatty():
1837
1720
    """
1838
1721
    global _selected_dir_reader
1839
1722
    if _selected_dir_reader is None:
 
1723
        fs_encoding = _fs_enc.upper()
1840
1724
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1841
1725
            # Win98 doesn't have unicode apis like FindFirstFileW
1842
1726
            # TODO: We possibly could support Win98 by falling back to the
1848
1732
                _selected_dir_reader = Win32ReadDir()
1849
1733
            except ImportError:
1850
1734
                pass
1851
 
        elif _fs_enc in ('utf-8', 'ascii'):
 
1735
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
 
1736
            # ANSI_X3.4-1968 is a form of ASCII
1852
1737
            try:
1853
1738
                from bzrlib._readdir_pyx import UTF8DirReader
1854
1739
                _selected_dir_reader = UTF8DirReader()
2013
1898
_cached_user_encoding = None
2014
1899
 
2015
1900
 
2016
 
def get_user_encoding(use_cache=DEPRECATED_PARAMETER):
 
1901
def get_user_encoding(use_cache=True):
2017
1902
    """Find out what the preferred user encoding is.
2018
1903
 
2019
1904
    This is generally the encoding that is used for command line parameters
2020
1905
    and file contents. This may be different from the terminal encoding
2021
1906
    or the filesystem encoding.
2022
1907
 
 
1908
    :param  use_cache:  Enable cache for detected encoding.
 
1909
                        (This parameter is turned on by default,
 
1910
                        and required only for selftesting)
 
1911
 
2023
1912
    :return: A string defining the preferred user encoding
2024
1913
    """
2025
1914
    global _cached_user_encoding
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:
 
1915
    if _cached_user_encoding is not None and use_cache:
2030
1916
        return _cached_user_encoding
2031
1917
 
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)
 
1918
    if sys.platform == 'darwin':
 
1919
        # python locale.getpreferredencoding() always return
 
1920
        # 'mac-roman' on darwin. That's a lie.
 
1921
        sys.platform = 'posix'
 
1922
        try:
 
1923
            if os.environ.get('LANG', None) is None:
 
1924
                # If LANG is not set, we end up with 'ascii', which is bad
 
1925
                # ('mac-roman' is more than ascii), so we set a default which
 
1926
                # will give us UTF-8 (which appears to work in all cases on
 
1927
                # OSX). Users are still free to override LANG of course, as
 
1928
                # long as it give us something meaningful. This work-around
 
1929
                # *may* not be needed with python 3k and/or OSX 10.5, but will
 
1930
                # work with them too -- vila 20080908
 
1931
                os.environ['LANG'] = 'en_US.UTF-8'
 
1932
            import locale
 
1933
        finally:
 
1934
            sys.platform = 'darwin'
2038
1935
    else:
2039
 
        # GZ 2011-12-19: On windows could call GetACP directly instead.
2040
 
        user_encoding = locale.getpreferredencoding(False)
 
1936
        import locale
2041
1937
 
2042
1938
    try:
2043
 
        user_encoding = codecs.lookup(user_encoding).name
2044
 
    except LookupError:
2045
 
        if user_encoding not in ("", "cp0"):
 
1939
        user_encoding = locale.getpreferredencoding()
 
1940
    except locale.Error, e:
 
1941
        sys.stderr.write('bzr: warning: %s\n'
 
1942
                         '  Could not determine what text encoding to use.\n'
 
1943
                         '  This error usually means your Python interpreter\n'
 
1944
                         '  doesn\'t support the locale set by $LANG (%s)\n'
 
1945
                         "  Continuing with ascii encoding.\n"
 
1946
                         % (e, os.environ.get('LANG')))
 
1947
        user_encoding = 'ascii'
 
1948
 
 
1949
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
 
1950
    # treat that as ASCII, and not support printing unicode characters to the
 
1951
    # console.
 
1952
    #
 
1953
    # For python scripts run under vim, we get '', so also treat that as ASCII
 
1954
    if user_encoding in (None, 'cp0', ''):
 
1955
        user_encoding = 'ascii'
 
1956
    else:
 
1957
        # check encoding
 
1958
        try:
 
1959
            codecs.lookup(user_encoding)
 
1960
        except LookupError:
2046
1961
            sys.stderr.write('bzr: warning:'
2047
1962
                             ' unknown encoding %s.'
2048
1963
                             ' Continuing with ascii encoding.\n'
2049
1964
                             % user_encoding
2050
1965
                            )
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
 
1966
            user_encoding = 'ascii'
 
1967
 
 
1968
    if use_cache:
 
1969
        _cached_user_encoding = user_encoding
 
1970
 
2063
1971
    return user_encoding
2064
1972
 
2065
1973
 
2074
1982
    behaves inconsistently on different platforms.
2075
1983
    """
2076
1984
    if sys.platform == "win32":
 
1985
        import win32utils
2077
1986
        return win32utils.get_host_name()
2078
1987
    else:
2079
1988
        import socket
2086
1995
# data at once.
2087
1996
MAX_SOCKET_CHUNK = 64 * 1024
2088
1997
 
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
 
 
2097
1998
def read_bytes_from_socket(sock, report_activity=None,
2098
1999
        max_read_size=MAX_SOCKET_CHUNK):
2099
2000
    """Read up to max_read_size of bytes from sock and notify of progress.
2107
2008
            bytes = sock.recv(max_read_size)
2108
2009
        except socket.error, e:
2109
2010
            eno = e.args[0]
2110
 
            if eno in _end_of_stream_errors:
 
2011
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
2111
2012
                # The connection was closed by the other side.  Callers expect
2112
2013
                # an empty string to signal end-of-stream.
2113
2014
                return ""
2158
2059
    while sent_total < byte_count:
2159
2060
        try:
2160
2061
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
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)
 
2062
        except socket.error, e:
2165
2063
            if e.args[0] != errno.EINTR:
2166
2064
                raise
2167
2065
        else:
2168
 
            if sent == 0:
2169
 
                raise errors.ConnectionReset('Sending to %s returned 0 bytes'
2170
 
                                             % (sock,))
2171
2066
            sent_total += sent
2172
 
            if report_activity is not None:
2173
 
                report_activity(sent, 'write')
 
2067
            report_activity(sent, 'write')
2174
2068
 
2175
2069
 
2176
2070
def connect_socket(address):
2261
2155
    return file_kind_from_stat_mode(mode)
2262
2156
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2263
2157
 
2264
 
def file_stat(f, _lstat=os.lstat):
 
2158
 
 
2159
def file_kind(f, _lstat=os.lstat):
2265
2160
    try:
2266
 
        # XXX cache?
2267
 
        return _lstat(f)
 
2161
        return file_kind_from_stat_mode(_lstat(f).st_mode)
2268
2162
    except OSError, e:
2269
2163
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2270
2164
            raise errors.NoSuchFile(f)
2271
2165
        raise
2272
2166
 
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)
2276
2167
 
2277
2168
def until_no_eintr(f, *a, **kw):
2278
2169
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2322
2213
 
2323
2214
 
2324
2215
if sys.platform == "win32":
 
2216
    import msvcrt
2325
2217
    def getchar():
2326
 
        import msvcrt
2327
2218
        return msvcrt.getch()
2328
2219
else:
 
2220
    import tty
 
2221
    import termios
2329
2222
    def getchar():
2330
 
        import tty
2331
 
        import termios
2332
2223
        fd = sys.stdin.fileno()
2333
2224
        settings = termios.tcgetattr(fd)
2334
2225
        try:
2338
2229
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2339
2230
        return ch
2340
2231
 
2341
 
if sys.platform.startswith('linux'):
 
2232
 
 
2233
if sys.platform == 'linux2':
2342
2234
    def _local_concurrency():
2343
 
        try:
2344
 
            return os.sysconf('SC_NPROCESSORS_ONLN')
2345
 
        except (ValueError, OSError, AttributeError):
2346
 
            return None
 
2235
        concurrency = None
 
2236
        prefix = 'processor'
 
2237
        for line in file('/proc/cpuinfo', 'rb'):
 
2238
            if line.startswith(prefix):
 
2239
                concurrency = int(line[line.find(':')+1:]) + 1
 
2240
        return concurrency
2347
2241
elif sys.platform == 'darwin':
2348
2242
    def _local_concurrency():
2349
2243
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2350
2244
                                stdout=subprocess.PIPE).communicate()[0]
2351
 
elif "bsd" in sys.platform:
 
2245
elif sys.platform[0:7] == 'freebsd':
2352
2246
    def _local_concurrency():
2353
2247
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2354
2248
                                stdout=subprocess.PIPE).communicate()[0]
2382
2276
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2383
2277
    if concurrency is None:
2384
2278
        try:
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
 
2279
            concurrency = _local_concurrency()
 
2280
        except (OSError, IOError):
 
2281
            pass
2395
2282
    try:
2396
2283
        concurrency = int(concurrency)
2397
2284
    except (TypeError, ValueError):
2459
2346
    open_file = open
2460
2347
 
2461
2348
 
 
2349
def getuser_unicode():
 
2350
    """Return the username as unicode.
 
2351
    """
 
2352
    try:
 
2353
        user_encoding = get_user_encoding()
 
2354
        username = getpass.getuser().decode(user_encoding)
 
2355
    except UnicodeDecodeError:
 
2356
        raise errors.BzrError("Can't decode username as %s." % \
 
2357
                user_encoding)
 
2358
    return username
 
2359
 
 
2360
 
2462
2361
def available_backup_name(base, exists):
2463
2362
    """Find a non-existing backup file name.
2464
2363
 
2477
2376
        counter += 1
2478
2377
        name = "%s.~%d~" % (base, counter)
2479
2378
    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