~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

(gz) Remove bzrlib/util/elementtree/ package (Martin Packman)

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
65
from hashlib import (
60
69
 
61
70
 
62
71
import bzrlib
63
 
from bzrlib import symbol_versioning
 
72
from bzrlib import symbol_versioning, _fs_enc
64
73
 
65
74
 
66
75
# Cross platform wall-clock time functionality with decent resolution.
88
97
        user_encoding = get_user_encoding()
89
98
        return [a.decode(user_encoding) for a in sys.argv[1:]]
90
99
    except UnicodeDecodeError:
91
 
        raise errors.BzrError("Parameter %r encoding is unsupported by %s "
92
 
            "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))
93
102
 
94
103
 
95
104
def make_readonly(filename):
97
106
    mod = os.lstat(filename).st_mode
98
107
    if not stat.S_ISLNK(mod):
99
108
        mod = mod & 0777555
100
 
        os.chmod(filename, mod)
 
109
        chmod_if_possible(filename, mod)
101
110
 
102
111
 
103
112
def make_writable(filename):
104
113
    mod = os.lstat(filename).st_mode
105
114
    if not stat.S_ISLNK(mod):
106
115
        mod = mod | 0200
107
 
        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
108
136
 
109
137
 
110
138
def minimum_path_selection(paths):
189
217
            if e.errno == errno.ENOENT:
190
218
                return False;
191
219
            else:
192
 
                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))
193
221
 
194
222
 
195
223
def fancy_rename(old, new, rename_func, unlink_func):
271
299
# choke on a Unicode string containing a relative path if
272
300
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
273
301
# string.
274
 
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
275
302
def _posix_abspath(path):
276
303
    # jam 20060426 rather than encoding to fsencoding
277
304
    # copy posixpath.abspath, but use os.getcwdu instead
278
305
    if not posixpath.isabs(path):
279
306
        path = posixpath.join(getcwd(), path)
280
 
    return posixpath.normpath(path)
 
307
    return _posix_normpath(path)
281
308
 
282
309
 
283
310
def _posix_realpath(path):
284
311
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
285
312
 
286
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
 
287
356
def _win32_fixdrive(path):
288
357
    """Force drive letters to be consistent.
289
358
 
377
446
abspath = _posix_abspath
378
447
realpath = _posix_realpath
379
448
pathjoin = os.path.join
380
 
normpath = os.path.normpath
 
449
normpath = _posix_normpath
 
450
path_from_environ = _posix_path_from_environ
 
451
getuser_unicode = _posix_getuser_unicode
381
452
getcwd = os.getcwdu
382
453
rename = os.rename
383
454
dirname = os.path.dirname
439
510
    f = win32utils.get_unicode_argv     # special function or None
440
511
    if f is not None:
441
512
        get_unicode_argv = f
 
513
    path_from_environ = win32utils.get_environ_unicode
 
514
    getuser_unicode = win32utils.get_user_name
442
515
 
443
516
elif sys.platform == 'darwin':
444
517
    getcwd = _mac_getcwd
876
949
    return os.fstat(f.fileno())[stat.ST_SIZE]
877
950
 
878
951
 
879
 
# Define rand_bytes based on platform.
880
 
try:
881
 
    # Python 2.4 and later have os.urandom,
882
 
    # but it doesn't work on some arches
883
 
    os.urandom(1)
884
 
    rand_bytes = os.urandom
885
 
except (NotImplementedError, AttributeError):
886
 
    # If python doesn't have os.urandom, or it doesn't work,
887
 
    # 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":
888
959
    try:
889
 
        rand_bytes = file('/dev/urandom', 'rb').read
890
 
    # Otherwise, use this hack as a last resort
891
 
    except (IOError, OSError):
 
960
        rand_bytes(1)
 
961
    except NotImplementedError:
892
962
        # not well seeded, but better than nothing
893
963
        def rand_bytes(n):
894
964
            import random
924
994
    rps = []
925
995
    for f in ps:
926
996
        if f == '..':
927
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
997
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
928
998
        elif (f == '.') or (f == ''):
929
999
            pass
930
1000
        else:
935
1005
def joinpath(p):
936
1006
    for f in p:
937
1007
        if (f == '..') or (f is None) or (f == ''):
938
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1008
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
939
1009
    return pathjoin(*p)
940
1010
 
941
1011
 
985
1055
def report_extension_load_failures():
986
1056
    if not _extension_load_failures:
987
1057
        return
988
 
    from bzrlib.config import GlobalConfig
989
 
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
 
1058
    if config.GlobalStack().get('ignore_missing_extensions'):
990
1059
        return
991
1060
    # the warnings framework should by default show this only once
992
1061
    from bzrlib.trace import warning
1154
1223
 
1155
1224
    if len(base) < MIN_ABS_PATHLENGTH:
1156
1225
        # must have space for e.g. a drive letter
1157
 
        raise ValueError('%r is too short to calculate a relative path'
 
1226
        raise ValueError(gettext('%r is too short to calculate a relative path')
1158
1227
            % (base,))
1159
1228
 
1160
1229
    rp = abspath(path)
1735
1804
    """
1736
1805
    global _selected_dir_reader
1737
1806
    if _selected_dir_reader is None:
1738
 
        fs_encoding = _fs_enc.upper()
1739
1807
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1740
1808
            # Win98 doesn't have unicode apis like FindFirstFileW
1741
1809
            # TODO: We possibly could support Win98 by falling back to the
1747
1815
                _selected_dir_reader = Win32ReadDir()
1748
1816
            except ImportError:
1749
1817
                pass
1750
 
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1751
 
            # ANSI_X3.4-1968 is a form of ASCII
 
1818
        elif _fs_enc in ('utf-8', 'ascii'):
1752
1819
            try:
1753
1820
                from bzrlib._readdir_pyx import UTF8DirReader
1754
1821
                _selected_dir_reader = UTF8DirReader()
1913
1980
_cached_user_encoding = None
1914
1981
 
1915
1982
 
1916
 
def get_user_encoding(use_cache=True):
 
1983
def get_user_encoding(use_cache=DEPRECATED_PARAMETER):
1917
1984
    """Find out what the preferred user encoding is.
1918
1985
 
1919
1986
    This is generally the encoding that is used for command line parameters
1920
1987
    and file contents. This may be different from the terminal encoding
1921
1988
    or the filesystem encoding.
1922
1989
 
1923
 
    :param  use_cache:  Enable cache for detected encoding.
1924
 
                        (This parameter is turned on by default,
1925
 
                        and required only for selftesting)
1926
 
 
1927
1990
    :return: A string defining the preferred user encoding
1928
1991
    """
1929
1992
    global _cached_user_encoding
1930
 
    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:
1931
1997
        return _cached_user_encoding
1932
1998
 
1933
 
    if sys.platform == 'darwin':
1934
 
        # python locale.getpreferredencoding() always return
1935
 
        # 'mac-roman' on darwin. That's a lie.
1936
 
        sys.platform = 'posix'
1937
 
        try:
1938
 
            if os.environ.get('LANG', None) is None:
1939
 
                # If LANG is not set, we end up with 'ascii', which is bad
1940
 
                # ('mac-roman' is more than ascii), so we set a default which
1941
 
                # will give us UTF-8 (which appears to work in all cases on
1942
 
                # OSX). Users are still free to override LANG of course, as
1943
 
                # long as it give us something meaningful. This work-around
1944
 
                # *may* not be needed with python 3k and/or OSX 10.5, but will
1945
 
                # work with them too -- vila 20080908
1946
 
                os.environ['LANG'] = 'en_US.UTF-8'
1947
 
            import locale
1948
 
        finally:
1949
 
            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)
1950
2005
    else:
1951
 
        import locale
 
2006
        # GZ 2011-12-19: On windows could call GetACP directly instead.
 
2007
        user_encoding = locale.getpreferredencoding(False)
1952
2008
 
1953
2009
    try:
1954
 
        user_encoding = locale.getpreferredencoding()
1955
 
    except locale.Error, e:
1956
 
        sys.stderr.write('bzr: warning: %s\n'
1957
 
                         '  Could not determine what text encoding to use.\n'
1958
 
                         '  This error usually means your Python interpreter\n'
1959
 
                         '  doesn\'t support the locale set by $LANG (%s)\n'
1960
 
                         "  Continuing with ascii encoding.\n"
1961
 
                         % (e, os.environ.get('LANG')))
1962
 
        user_encoding = 'ascii'
1963
 
 
1964
 
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
1965
 
    # treat that as ASCII, and not support printing unicode characters to the
1966
 
    # console.
1967
 
    #
1968
 
    # For python scripts run under vim, we get '', so also treat that as ASCII
1969
 
    if user_encoding in (None, 'cp0', ''):
1970
 
        user_encoding = 'ascii'
1971
 
    else:
1972
 
        # check encoding
1973
 
        try:
1974
 
            codecs.lookup(user_encoding)
1975
 
        except LookupError:
 
2010
        user_encoding = codecs.lookup(user_encoding).name
 
2011
    except LookupError:
 
2012
        if user_encoding not in ("", "cp0"):
1976
2013
            sys.stderr.write('bzr: warning:'
1977
2014
                             ' unknown encoding %s.'
1978
2015
                             ' Continuing with ascii encoding.\n'
1979
2016
                             % user_encoding
1980
2017
                            )
1981
 
            user_encoding = 'ascii'
1982
 
 
1983
 
    if use_cache:
1984
 
        _cached_user_encoding = user_encoding
1985
 
 
 
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
1986
2030
    return user_encoding
1987
2031
 
1988
2032
 
1997
2041
    behaves inconsistently on different platforms.
1998
2042
    """
1999
2043
    if sys.platform == "win32":
2000
 
        import win32utils
2001
2044
        return win32utils.get_host_name()
2002
2045
    else:
2003
2046
        import socket
2178
2221
    return file_kind_from_stat_mode(mode)
2179
2222
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2180
2223
 
2181
 
 
2182
 
def file_kind(f, _lstat=os.lstat):
 
2224
def file_stat(f, _lstat=os.lstat):
2183
2225
    try:
2184
 
        return file_kind_from_stat_mode(_lstat(f).st_mode)
 
2226
        # XXX cache?
 
2227
        return _lstat(f)
2185
2228
    except OSError, e:
2186
2229
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2187
2230
            raise errors.NoSuchFile(f)
2188
2231
        raise
2189
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)
2190
2236
 
2191
2237
def until_no_eintr(f, *a, **kw):
2192
2238
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2236
2282
 
2237
2283
 
2238
2284
if sys.platform == "win32":
2239
 
    import msvcrt
2240
2285
    def getchar():
 
2286
        import msvcrt
2241
2287
        return msvcrt.getch()
2242
2288
else:
2243
 
    import tty
2244
 
    import termios
2245
2289
    def getchar():
 
2290
        import tty
 
2291
        import termios
2246
2292
        fd = sys.stdin.fileno()
2247
2293
        settings = termios.tcgetattr(fd)
2248
2294
        try:
2252
2298
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2253
2299
        return ch
2254
2300
 
2255
 
if sys.platform == 'linux2':
 
2301
if sys.platform.startswith('linux'):
2256
2302
    def _local_concurrency():
2257
2303
        try:
2258
2304
            return os.sysconf('SC_NPROCESSORS_ONLN')
2297
2343
    if concurrency is None:
2298
2344
        try:
2299
2345
            import multiprocessing
2300
 
        except ImportError:
 
2346
            concurrency = multiprocessing.cpu_count()
 
2347
        except (ImportError, NotImplementedError):
2301
2348
            # multiprocessing is only available on Python >= 2.6
 
2349
            # and multiprocessing.cpu_count() isn't implemented on all
 
2350
            # platforms
2302
2351
            try:
2303
2352
                concurrency = _local_concurrency()
2304
2353
            except (OSError, IOError):
2305
2354
                pass
2306
 
        else:
2307
 
            concurrency = multiprocessing.cpu_count()
2308
2355
    try:
2309
2356
        concurrency = int(concurrency)
2310
2357
    except (TypeError, ValueError):
2372
2419
    open_file = open
2373
2420
 
2374
2421
 
2375
 
def getuser_unicode():
2376
 
    """Return the username as unicode.
2377
 
    """
2378
 
    try:
2379
 
        user_encoding = get_user_encoding()
2380
 
        username = getpass.getuser().decode(user_encoding)
2381
 
    except UnicodeDecodeError:
2382
 
        raise errors.BzrError("Can't decode username as %s." % \
2383
 
                user_encoding)
2384
 
    return username
2385
 
 
2386
 
 
2387
2422
def available_backup_name(base, exists):
2388
2423
    """Find a non-existing backup file name.
2389
2424
 
2448
2483
            if os.access(f, os.X_OK):
2449
2484
                return f
2450
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