~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Patch Queue Manager
  • Date: 2016-04-21 04:10:52 UTC
  • mfrom: (6616.1.1 fix-en-user-guide)
  • Revision ID: pqm@pqm.ubuntu.com-20160421041052-clcye7ns1qcl2n7w
(richard-wilbur) Ensure build of English use guide always uses English text
 even when user's locale specifies a different language. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 encoding is unsupported by %s "
100
 
            "application locale." % (a, user_encoding))
 
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
412
510
    normpath = _win32_normpath
413
511
    getcwd = _win32_getcwd
414
512
    mkdtemp = _win32_mkdtemp
415
 
    rename = _win32_rename
 
513
    rename = _rename_wrap_exception(_win32_rename)
416
514
    try:
417
515
        from bzrlib import _walkdirs_win32
418
516
    except ImportError:
444
542
    f = win32utils.get_unicode_argv     # special function or None
445
543
    if f is not None:
446
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
447
548
 
448
549
elif sys.platform == 'darwin':
449
550
    getcwd = _mac_getcwd
881
982
    return os.fstat(f.fileno())[stat.ST_SIZE]
882
983
 
883
984
 
884
 
# Define rand_bytes based on platform.
885
 
try:
886
 
    # Python 2.4 and later have os.urandom,
887
 
    # but it doesn't work on some arches
888
 
    os.urandom(1)
889
 
    rand_bytes = os.urandom
890
 
except (NotImplementedError, AttributeError):
891
 
    # If python doesn't have os.urandom, or it doesn't work,
892
 
    # 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":
893
992
    try:
894
 
        rand_bytes = file('/dev/urandom', 'rb').read
895
 
    # Otherwise, use this hack as a last resort
896
 
    except (IOError, OSError):
 
993
        rand_bytes(1)
 
994
    except NotImplementedError:
897
995
        # not well seeded, but better than nothing
898
996
        def rand_bytes(n):
899
997
            import random
929
1027
    rps = []
930
1028
    for f in ps:
931
1029
        if f == '..':
932
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1030
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
933
1031
        elif (f == '.') or (f == ''):
934
1032
            pass
935
1033
        else:
940
1038
def joinpath(p):
941
1039
    for f in p:
942
1040
        if (f == '..') or (f is None) or (f == ''):
943
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1041
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
944
1042
    return pathjoin(*p)
945
1043
 
946
1044
 
990
1088
def report_extension_load_failures():
991
1089
    if not _extension_load_failures:
992
1090
        return
993
 
    from bzrlib.config import GlobalConfig
994
 
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
 
1091
    if config.GlobalStack().get('ignore_missing_extensions'):
995
1092
        return
996
1093
    # the warnings framework should by default show this only once
997
1094
    from bzrlib.trace import warning
1159
1256
 
1160
1257
    if len(base) < MIN_ABS_PATHLENGTH:
1161
1258
        # must have space for e.g. a drive letter
1162
 
        raise ValueError('%r is too short to calculate a relative path'
 
1259
        raise ValueError(gettext('%r is too short to calculate a relative path')
1163
1260
            % (base,))
1164
1261
 
1165
1262
    rp = abspath(path)
1740
1837
    """
1741
1838
    global _selected_dir_reader
1742
1839
    if _selected_dir_reader is None:
1743
 
        fs_encoding = _fs_enc.upper()
1744
1840
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1745
1841
            # Win98 doesn't have unicode apis like FindFirstFileW
1746
1842
            # TODO: We possibly could support Win98 by falling back to the
1752
1848
                _selected_dir_reader = Win32ReadDir()
1753
1849
            except ImportError:
1754
1850
                pass
1755
 
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1756
 
            # ANSI_X3.4-1968 is a form of ASCII
 
1851
        elif _fs_enc in ('utf-8', 'ascii'):
1757
1852
            try:
1758
1853
                from bzrlib._readdir_pyx import UTF8DirReader
1759
1854
                _selected_dir_reader = UTF8DirReader()
1918
2013
_cached_user_encoding = None
1919
2014
 
1920
2015
 
1921
 
def get_user_encoding(use_cache=True):
 
2016
def get_user_encoding(use_cache=DEPRECATED_PARAMETER):
1922
2017
    """Find out what the preferred user encoding is.
1923
2018
 
1924
2019
    This is generally the encoding that is used for command line parameters
1925
2020
    and file contents. This may be different from the terminal encoding
1926
2021
    or the filesystem encoding.
1927
2022
 
1928
 
    :param  use_cache:  Enable cache for detected encoding.
1929
 
                        (This parameter is turned on by default,
1930
 
                        and required only for selftesting)
1931
 
 
1932
2023
    :return: A string defining the preferred user encoding
1933
2024
    """
1934
2025
    global _cached_user_encoding
1935
 
    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:
1936
2030
        return _cached_user_encoding
1937
2031
 
1938
 
    if sys.platform == 'darwin':
1939
 
        # python locale.getpreferredencoding() always return
1940
 
        # 'mac-roman' on darwin. That's a lie.
1941
 
        sys.platform = 'posix'
1942
 
        try:
1943
 
            if os.environ.get('LANG', None) is None:
1944
 
                # If LANG is not set, we end up with 'ascii', which is bad
1945
 
                # ('mac-roman' is more than ascii), so we set a default which
1946
 
                # will give us UTF-8 (which appears to work in all cases on
1947
 
                # OSX). Users are still free to override LANG of course, as
1948
 
                # long as it give us something meaningful. This work-around
1949
 
                # *may* not be needed with python 3k and/or OSX 10.5, but will
1950
 
                # work with them too -- vila 20080908
1951
 
                os.environ['LANG'] = 'en_US.UTF-8'
1952
 
            import locale
1953
 
        finally:
1954
 
            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)
1955
2038
    else:
1956
 
        import locale
 
2039
        # GZ 2011-12-19: On windows could call GetACP directly instead.
 
2040
        user_encoding = locale.getpreferredencoding(False)
1957
2041
 
1958
2042
    try:
1959
 
        user_encoding = locale.getpreferredencoding()
1960
 
    except locale.Error, e:
1961
 
        sys.stderr.write('bzr: warning: %s\n'
1962
 
                         '  Could not determine what text encoding to use.\n'
1963
 
                         '  This error usually means your Python interpreter\n'
1964
 
                         '  doesn\'t support the locale set by $LANG (%s)\n'
1965
 
                         "  Continuing with ascii encoding.\n"
1966
 
                         % (e, os.environ.get('LANG')))
1967
 
        user_encoding = 'ascii'
1968
 
 
1969
 
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
1970
 
    # treat that as ASCII, and not support printing unicode characters to the
1971
 
    # console.
1972
 
    #
1973
 
    # For python scripts run under vim, we get '', so also treat that as ASCII
1974
 
    if user_encoding in (None, 'cp0', ''):
1975
 
        user_encoding = 'ascii'
1976
 
    else:
1977
 
        # check encoding
1978
 
        try:
1979
 
            codecs.lookup(user_encoding)
1980
 
        except LookupError:
 
2043
        user_encoding = codecs.lookup(user_encoding).name
 
2044
    except LookupError:
 
2045
        if user_encoding not in ("", "cp0"):
1981
2046
            sys.stderr.write('bzr: warning:'
1982
2047
                             ' unknown encoding %s.'
1983
2048
                             ' Continuing with ascii encoding.\n'
1984
2049
                             % user_encoding
1985
2050
                            )
1986
 
            user_encoding = 'ascii'
1987
 
 
1988
 
    if use_cache:
1989
 
        _cached_user_encoding = user_encoding
1990
 
 
 
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
1991
2063
    return user_encoding
1992
2064
 
1993
2065
 
2002
2074
    behaves inconsistently on different platforms.
2003
2075
    """
2004
2076
    if sys.platform == "win32":
2005
 
        import win32utils
2006
2077
        return win32utils.get_host_name()
2007
2078
    else:
2008
2079
        import socket
2015
2086
# data at once.
2016
2087
MAX_SOCKET_CHUNK = 64 * 1024
2017
2088
 
2018
 
_end_of_stream_errors = [errno.ECONNRESET]
 
2089
_end_of_stream_errors = [errno.ECONNRESET, errno.EPIPE, errno.EINVAL]
2019
2090
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
2020
2091
    _eno = getattr(errno, _eno, None)
2021
2092
    if _eno is not None:
2087
2158
    while sent_total < byte_count:
2088
2159
        try:
2089
2160
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2090
 
        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)
2091
2165
            if e.args[0] != errno.EINTR:
2092
2166
                raise
2093
2167
        else:
 
2168
            if sent == 0:
 
2169
                raise errors.ConnectionReset('Sending to %s returned 0 bytes'
 
2170
                                             % (sock,))
2094
2171
            sent_total += sent
2095
 
            report_activity(sent, 'write')
 
2172
            if report_activity is not None:
 
2173
                report_activity(sent, 'write')
2096
2174
 
2097
2175
 
2098
2176
def connect_socket(address):
2183
2261
    return file_kind_from_stat_mode(mode)
2184
2262
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2185
2263
 
2186
 
 
2187
 
def file_kind(f, _lstat=os.lstat):
 
2264
def file_stat(f, _lstat=os.lstat):
2188
2265
    try:
2189
 
        return file_kind_from_stat_mode(_lstat(f).st_mode)
 
2266
        # XXX cache?
 
2267
        return _lstat(f)
2190
2268
    except OSError, e:
2191
2269
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2192
2270
            raise errors.NoSuchFile(f)
2193
2271
        raise
2194
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)
2195
2276
 
2196
2277
def until_no_eintr(f, *a, **kw):
2197
2278
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2241
2322
 
2242
2323
 
2243
2324
if sys.platform == "win32":
2244
 
    import msvcrt
2245
2325
    def getchar():
 
2326
        import msvcrt
2246
2327
        return msvcrt.getch()
2247
2328
else:
2248
 
    import tty
2249
 
    import termios
2250
2329
    def getchar():
 
2330
        import tty
 
2331
        import termios
2251
2332
        fd = sys.stdin.fileno()
2252
2333
        settings = termios.tcgetattr(fd)
2253
2334
        try:
2257
2338
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2258
2339
        return ch
2259
2340
 
2260
 
if sys.platform == 'linux2':
 
2341
if sys.platform.startswith('linux'):
2261
2342
    def _local_concurrency():
2262
2343
        try:
2263
2344
            return os.sysconf('SC_NPROCESSORS_ONLN')
2302
2383
    if concurrency is None:
2303
2384
        try:
2304
2385
            import multiprocessing
2305
 
        except ImportError:
 
2386
            concurrency = multiprocessing.cpu_count()
 
2387
        except (ImportError, NotImplementedError):
2306
2388
            # multiprocessing is only available on Python >= 2.6
 
2389
            # and multiprocessing.cpu_count() isn't implemented on all
 
2390
            # platforms
2307
2391
            try:
2308
2392
                concurrency = _local_concurrency()
2309
2393
            except (OSError, IOError):
2310
2394
                pass
2311
 
        else:
2312
 
            concurrency = multiprocessing.cpu_count()
2313
2395
    try:
2314
2396
        concurrency = int(concurrency)
2315
2397
    except (TypeError, ValueError):
2377
2459
    open_file = open
2378
2460
 
2379
2461
 
2380
 
def getuser_unicode():
2381
 
    """Return the username as unicode.
2382
 
    """
2383
 
    try:
2384
 
        user_encoding = get_user_encoding()
2385
 
        username = getpass.getuser().decode(user_encoding)
2386
 
    except UnicodeDecodeError:
2387
 
        raise errors.BzrError("Can't decode username as %s." % \
2388
 
                user_encoding)
2389
 
    return username
2390
 
 
2391
 
 
2392
2462
def available_backup_name(base, exists):
2393
2463
    """Find a non-existing backup file name.
2394
2464
 
2432
2502
    :param name: The base name of the executable.
2433
2503
    :return: The path to the executable found or None.
2434
2504
    """
2435
 
    path = os.environ.get('PATH')
2436
 
    if path is None:
2437
 
        return None
2438
 
    path = path.split(os.pathsep)
2439
2505
    if sys.platform == 'win32':
2440
2506
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
2441
2507
        exts = [ext.lower() for ext in exts]
2447
2513
            exts = [ext]
2448
2514
    else:
2449
2515
        exts = ['']
2450
 
    for ext in exts:
2451
 
        for d in path:
2452
 
            f = os.path.join(d, name) + ext
2453
 
            if os.access(f, os.X_OK):
2454
 
                return f
 
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
2455
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