← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Vincent Ladeuil
  • Date: 2012-01-18 14:09:19 UTC
  • mto: This revision was merged to the branch mainline in revision 6468.
  • Revision ID: v.ladeuil+lp@free.fr-20120118140919-rlvdrhpc0nq1lbwi
Change set/remove to require a lock for the branch config files.

This means that tests (or any plugin for that matter) do not requires an
explicit lock on the branch anymore to change a single option. This also
means the optimisation becomes "opt-in" and as such won't be as
spectacular as it may be and/or harder to get right (nothing fails
anymore).

This reduces the diff by ~300 lines.

Code/tests that were updating more than one config option is still taking
a lock to at least avoid some IOs and demonstrate the benefits through
the decreased number of hpss calls.

The duplication between BranchStack and BranchOnlyStack will be removed
once the same sharing is in place for local config files, at which point
the Stack class itself may be able to host the changes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/osutils.py
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
 
 
19
import errno
17
20
import os
18
21
import re
19
22
import stat
20
 
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
21
23
import sys
22
24
import time
23
25
import codecs
25
27
from bzrlib.lazy_import import lazy_import
26
28
lazy_import(globals(), """
27
29
from datetime import datetime
28
 
import errno
29
 
from ntpath import (abspath as _nt_abspath,
30
 
                    join as _nt_join,
31
 
                    normpath as _nt_normpath,
32
 
                    realpath as _nt_realpath,
33
 
                    splitdrive as _nt_splitdrive,
34
 
                    )
 
30
import getpass
 
31
import locale
 
32
import ntpath
35
33
import posixpath
 
34
import select
 
35
# We need to import both shutil and rmtree as we export the later on posix
 
36
# and need the former on windows
36
37
import shutil
37
 
from shutil import (
38
 
    rmtree,
39
 
    )
 
38
from shutil import rmtree
40
39
import socket
41
40
import subprocess
 
41
# We need to import both tempfile and mkdtemp as we export the later on posix
 
42
# and need the former on windows
42
43
import tempfile
43
 
from tempfile import (
44
 
    mkdtemp,
45
 
    )
 
44
from tempfile import mkdtemp
46
45
import unicodedata
47
46
 
48
47
from bzrlib import (
49
48
    cache_utf8,
 
49
    config,
50
50
    errors,
51
51
    trace,
52
52
    win32utils,
53
53
    )
 
54
from bzrlib.i18n import gettext
54
55
""")
55
56
 
56
57
from bzrlib.symbol_versioning import (
 
58
    DEPRECATED_PARAMETER,
57
59
    deprecated_function,
58
60
    deprecated_in,
 
61
    deprecated_passed,
 
62
    warn as warn_deprecated,
59
63
    )
60
64
 
61
 
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
62
 
# of 2.5
63
 
if sys.version_info < (2, 5):
64
 
    import md5 as _mod_md5
65
 
    md5 = _mod_md5.new
66
 
    import sha as _mod_sha
67
 
    sha = _mod_sha.new
68
 
else:
69
 
    from hashlib import (
70
 
        md5,
71
 
        sha1 as sha,
72
 
        )
 
65
from hashlib import (
 
66
    md5,
 
67
    sha1 as sha,
 
68
    )
73
69
 
74
70
 
75
71
import bzrlib
76
 
from bzrlib import symbol_versioning
 
72
from bzrlib import symbol_versioning, _fs_enc
77
73
 
78
74
 
79
75
# Cross platform wall-clock time functionality with decent resolution.
101
97
        user_encoding = get_user_encoding()
102
98
        return [a.decode(user_encoding) for a in sys.argv[1:]]
103
99
    except UnicodeDecodeError:
104
 
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
105
 
                                                            "encoding." % a))
 
100
        raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
 
101
            "application locale.").format(a, user_encoding))
106
102
 
107
103
 
108
104
def make_readonly(filename):
110
106
    mod = os.lstat(filename).st_mode
111
107
    if not stat.S_ISLNK(mod):
112
108
        mod = mod & 0777555
113
 
        os.chmod(filename, mod)
 
109
        chmod_if_possible(filename, mod)
114
110
 
115
111
 
116
112
def make_writable(filename):
117
113
    mod = os.lstat(filename).st_mode
118
114
    if not stat.S_ISLNK(mod):
119
115
        mod = mod | 0200
120
 
        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
121
136
 
122
137
 
123
138
def minimum_path_selection(paths):
202
217
            if e.errno == errno.ENOENT:
203
218
                return False;
204
219
            else:
205
 
                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))
206
221
 
207
222
 
208
223
def fancy_rename(old, new, rename_func, unlink_func):
274
289
            else:
275
290
                rename_func(tmp_name, new)
276
291
    if failure_exc is not None:
277
 
        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
278
296
 
279
297
 
280
298
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
281
299
# choke on a Unicode string containing a relative path if
282
300
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
283
301
# string.
284
 
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
285
302
def _posix_abspath(path):
286
303
    # jam 20060426 rather than encoding to fsencoding
287
304
    # copy posixpath.abspath, but use os.getcwdu instead
288
305
    if not posixpath.isabs(path):
289
306
        path = posixpath.join(getcwd(), path)
290
 
    return posixpath.normpath(path)
 
307
    return _posix_normpath(path)
291
308
 
292
309
 
293
310
def _posix_realpath(path):
294
311
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
295
312
 
296
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
 
297
356
def _win32_fixdrive(path):
298
357
    """Force drive letters to be consistent.
299
358
 
303
362
    running python.exe under cmd.exe return capital C:\\
304
363
    running win32 python inside a cygwin shell returns lowercase c:\\
305
364
    """
306
 
    drive, path = _nt_splitdrive(path)
 
365
    drive, path = ntpath.splitdrive(path)
307
366
    return drive.upper() + path
308
367
 
309
368
 
310
369
def _win32_abspath(path):
311
 
    # Real _nt_abspath doesn't have a problem with a unicode cwd
312
 
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
 
370
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
 
371
    return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
313
372
 
314
373
 
315
374
def _win98_abspath(path):
326
385
    #   /path       => C:/path
327
386
    path = unicode(path)
328
387
    # check for absolute path
329
 
    drive = _nt_splitdrive(path)[0]
 
388
    drive = ntpath.splitdrive(path)[0]
330
389
    if drive == '' and path[:2] not in('//','\\\\'):
331
390
        cwd = os.getcwdu()
332
391
        # we cannot simply os.path.join cwd and path
333
392
        # because os.path.join('C:','/path') produce '/path'
334
393
        # and this is incorrect
335
394
        if path[:1] in ('/','\\'):
336
 
            cwd = _nt_splitdrive(cwd)[0]
 
395
            cwd = ntpath.splitdrive(cwd)[0]
337
396
            path = path[1:]
338
397
        path = cwd + '\\' + path
339
 
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
 
398
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
340
399
 
341
400
 
342
401
def _win32_realpath(path):
343
 
    # Real _nt_realpath doesn't have a problem with a unicode cwd
344
 
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
 
402
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
 
403
    return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
345
404
 
346
405
 
347
406
def _win32_pathjoin(*args):
348
 
    return _nt_join(*args).replace('\\', '/')
 
407
    return ntpath.join(*args).replace('\\', '/')
349
408
 
350
409
 
351
410
def _win32_normpath(path):
352
 
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
411
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
353
412
 
354
413
 
355
414
def _win32_getcwd():
360
419
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
361
420
 
362
421
 
363
 
def _add_rename_error_details(e, old, new):
364
 
    new_e = OSError(e.errno, "failed to rename %s to %s: %s"
365
 
        % (old, new, e.strerror))
366
 
    new_e.filename = old
367
 
    new_e.to_filename = new
368
 
    return new_e
369
 
 
370
 
 
371
422
def _win32_rename(old, new):
372
423
    """We expect to be able to atomically replace 'new' with old.
373
424
 
375
426
    and then deleted.
376
427
    """
377
428
    try:
378
 
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
 
429
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
379
430
    except OSError, e:
380
431
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
381
432
            # If we try to rename a non-existant file onto cwd, we get
386
437
        raise
387
438
 
388
439
 
389
 
def _wrapped_rename(old, new):
390
 
    """Rename a file or directory"""
391
 
    try:
392
 
        os.rename(old, new)
393
 
    except (IOError, OSError), e:
394
 
        # this is eventually called by all rename-like functions, so should 
395
 
        # catch all of them
396
 
        raise _add_rename_error_details(e, old, new)
397
 
 
398
 
 
399
440
def _mac_getcwd():
400
441
    return unicodedata.normalize('NFC', os.getcwdu())
401
442
 
405
446
abspath = _posix_abspath
406
447
realpath = _posix_realpath
407
448
pathjoin = os.path.join
408
 
normpath = os.path.normpath
409
 
rename = _wrapped_rename # overridden below on win32
 
449
normpath = _posix_normpath
 
450
path_from_environ = _posix_path_from_environ
 
451
getuser_unicode = _posix_getuser_unicode
410
452
getcwd = os.getcwdu
 
453
rename = os.rename
411
454
dirname = os.path.dirname
412
455
basename = os.path.basename
413
456
split = os.path.split
414
457
splitext = os.path.splitext
415
 
# These were already imported into local scope
 
458
# These were already lazily imported into local scope
416
459
# mkdtemp = tempfile.mkdtemp
417
460
# rmtree = shutil.rmtree
 
461
lstat = os.lstat
 
462
fstat = os.fstat
 
463
 
 
464
def wrap_stat(st):
 
465
    return st
 
466
 
418
467
 
419
468
MIN_ABS_PATHLENGTH = 1
420
469
 
430
479
    getcwd = _win32_getcwd
431
480
    mkdtemp = _win32_mkdtemp
432
481
    rename = _win32_rename
 
482
    try:
 
483
        from bzrlib import _walkdirs_win32
 
484
    except ImportError:
 
485
        pass
 
486
    else:
 
487
        lstat = _walkdirs_win32.lstat
 
488
        fstat = _walkdirs_win32.fstat
 
489
        wrap_stat = _walkdirs_win32.wrap_stat
433
490
 
434
491
    MIN_ABS_PATHLENGTH = 3
435
492
 
453
510
    f = win32utils.get_unicode_argv     # special function or None
454
511
    if f is not None:
455
512
        get_unicode_argv = f
 
513
    path_from_environ = win32utils.get_environ_unicode
 
514
    getuser_unicode = win32utils.get_user_name
456
515
 
457
516
elif sys.platform == 'darwin':
458
517
    getcwd = _mac_getcwd
459
518
 
460
519
 
461
 
def get_terminal_encoding():
 
520
def get_terminal_encoding(trace=False):
462
521
    """Find the best encoding for printing to the screen.
463
522
 
464
523
    This attempts to check both sys.stdout and sys.stdin to see
470
529
 
471
530
    On my standard US Windows XP, the preferred encoding is
472
531
    cp1252, but the console is cp437
 
532
 
 
533
    :param trace: If True trace the selected encoding via mutter().
473
534
    """
474
535
    from bzrlib.trace import mutter
475
536
    output_encoding = getattr(sys.stdout, 'encoding', None)
477
538
        input_encoding = getattr(sys.stdin, 'encoding', None)
478
539
        if not input_encoding:
479
540
            output_encoding = get_user_encoding()
480
 
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
541
            if trace:
 
542
                mutter('encoding stdout as osutils.get_user_encoding() %r',
481
543
                   output_encoding)
482
544
        else:
483
545
            output_encoding = input_encoding
484
 
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
546
            if trace:
 
547
                mutter('encoding stdout as sys.stdin encoding %r',
 
548
                    output_encoding)
485
549
    else:
486
 
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
550
        if trace:
 
551
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
487
552
    if output_encoding == 'cp0':
488
553
        # invalid encoding (cp0 means 'no codepage' on Windows)
489
554
        output_encoding = get_user_encoding()
490
 
        mutter('cp0 is invalid encoding.'
 
555
        if trace:
 
556
            mutter('cp0 is invalid encoding.'
491
557
               ' encoding stdout as osutils.get_user_encoding() %r',
492
558
               output_encoding)
493
559
    # check encoding
519
585
def isdir(f):
520
586
    """True if f is an accessible directory."""
521
587
    try:
522
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
588
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
523
589
    except OSError:
524
590
        return False
525
591
 
527
593
def isfile(f):
528
594
    """True if f is a regular file."""
529
595
    try:
530
 
        return S_ISREG(os.lstat(f)[ST_MODE])
 
596
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
531
597
    except OSError:
532
598
        return False
533
599
 
534
600
def islink(f):
535
601
    """True if f is a symlink."""
536
602
    try:
537
 
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
603
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
538
604
    except OSError:
539
605
        return False
540
606
 
880
946
 
881
947
def filesize(f):
882
948
    """Return size of given open file."""
883
 
    return os.fstat(f.fileno())[ST_SIZE]
884
 
 
885
 
 
886
 
# Define rand_bytes based on platform.
887
 
try:
888
 
    # Python 2.4 and later have os.urandom,
889
 
    # but it doesn't work on some arches
890
 
    os.urandom(1)
891
 
    rand_bytes = os.urandom
892
 
except (NotImplementedError, AttributeError):
893
 
    # If python doesn't have os.urandom, or it doesn't work,
894
 
    # then try to first pull random data from /dev/urandom
 
949
    return os.fstat(f.fileno())[stat.ST_SIZE]
 
950
 
 
951
 
 
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":
895
959
    try:
896
 
        rand_bytes = file('/dev/urandom', 'rb').read
897
 
    # Otherwise, use this hack as a last resort
898
 
    except (IOError, OSError):
 
960
        rand_bytes(1)
 
961
    except NotImplementedError:
899
962
        # not well seeded, but better than nothing
900
963
        def rand_bytes(n):
901
964
            import random
931
994
    rps = []
932
995
    for f in ps:
933
996
        if f == '..':
934
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
997
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
935
998
        elif (f == '.') or (f == ''):
936
999
            pass
937
1000
        else:
942
1005
def joinpath(p):
943
1006
    for f in p:
944
1007
        if (f == '..') or (f is None) or (f == ''):
945
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1008
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
946
1009
    return pathjoin(*p)
947
1010
 
948
1011
 
949
1012
def parent_directories(filename):
950
1013
    """Return the list of parent directories, deepest first.
951
 
    
 
1014
 
952
1015
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
953
1016
    """
954
1017
    parents = []
978
1041
    # NB: This docstring is just an example, not a doctest, because doctest
979
1042
    # currently can't cope with the use of lazy imports in this namespace --
980
1043
    # mbp 20090729
981
 
    
 
1044
 
982
1045
    # This currently doesn't report the failure at the time it occurs, because
983
1046
    # they tend to happen very early in startup when we can't check config
984
1047
    # files etc, and also we want to report all failures but not spam the user
985
1048
    # with 10 warnings.
986
 
    from bzrlib import trace
987
1049
    exception_str = str(exception)
988
1050
    if exception_str not in _extension_load_failures:
989
1051
        trace.mutter("failed to load compiled extension: %s" % exception_str)
993
1055
def report_extension_load_failures():
994
1056
    if not _extension_load_failures:
995
1057
        return
996
 
    from bzrlib.config import GlobalConfig
997
 
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
 
1058
    if config.GlobalStack().get('ignore_missing_extensions'):
998
1059
        return
999
1060
    # the warnings framework should by default show this only once
1000
1061
    from bzrlib.trace import warning
1054
1115
 
1055
1116
 
1056
1117
def delete_any(path):
1057
 
    """Delete a file, symlink or directory.  
1058
 
    
 
1118
    """Delete a file, symlink or directory.
 
1119
 
1059
1120
    Will delete even if readonly.
1060
1121
    """
1061
1122
    try:
1162
1223
 
1163
1224
    if len(base) < MIN_ABS_PATHLENGTH:
1164
1225
        # must have space for e.g. a drive letter
1165
 
        raise ValueError('%r is too short to calculate a relative path'
 
1226
        raise ValueError(gettext('%r is too short to calculate a relative path')
1166
1227
            % (base,))
1167
1228
 
1168
1229
    rp = abspath(path)
1250
1311
    # but for now, we haven't optimized...
1251
1312
    return [canonical_relpath(base, p) for p in paths]
1252
1313
 
 
1314
 
 
1315
def decode_filename(filename):
 
1316
    """Decode the filename using the filesystem encoding
 
1317
 
 
1318
    If it is unicode, it is returned.
 
1319
    Otherwise it is decoded from the the filesystem's encoding. If decoding
 
1320
    fails, a errors.BadFilenameEncoding exception is raised.
 
1321
    """
 
1322
    if type(filename) is unicode:
 
1323
        return filename
 
1324
    try:
 
1325
        return filename.decode(_fs_enc)
 
1326
    except UnicodeDecodeError:
 
1327
        raise errors.BadFilenameEncoding(filename, _fs_enc)
 
1328
 
 
1329
 
1253
1330
def safe_unicode(unicode_or_utf8_string):
1254
1331
    """Coerce unicode_or_utf8_string into unicode.
1255
1332
 
1338
1415
def normalizes_filenames():
1339
1416
    """Return True if this platform normalizes unicode filenames.
1340
1417
 
1341
 
    Mac OSX does, Windows/Linux do not.
 
1418
    Only Mac OSX.
1342
1419
    """
1343
1420
    return _platform_normalizes_filenames
1344
1421
 
1349
1426
    On platforms where the system normalizes filenames (Mac OSX),
1350
1427
    you can access a file by any path which will normalize correctly.
1351
1428
    On platforms where the system does not normalize filenames
1352
 
    (Windows, Linux), you have to access a file by its exact path.
 
1429
    (everything else), you have to access a file by its exact path.
1353
1430
 
1354
1431
    Internally, bzr only supports NFC normalization, since that is
1355
1432
    the standard for XML documents.
1417
1494
terminal_width() returns None.
1418
1495
"""
1419
1496
 
 
1497
# Keep some state so that terminal_width can detect if _terminal_size has
 
1498
# returned a different size since the process started.  See docstring and
 
1499
# comments of terminal_width for details.
 
1500
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
 
1501
_terminal_size_state = 'no_data'
 
1502
_first_terminal_size = None
1420
1503
 
1421
1504
def terminal_width():
1422
1505
    """Return terminal width.
1426
1509
    The rules are:
1427
1510
    - if BZR_COLUMNS is set, returns its value
1428
1511
    - if there is no controlling terminal, returns None
 
1512
    - query the OS, if the queried size has changed since the last query,
 
1513
      return its value,
1429
1514
    - if COLUMNS is set, returns its value,
 
1515
    - if the OS has a value (even though it's never changed), return its value.
1430
1516
 
1431
1517
    From there, we need to query the OS to get the size of the controlling
1432
1518
    terminal.
1433
1519
 
1434
 
    Unices:
 
1520
    On Unices we query the OS by:
1435
1521
    - get termios.TIOCGWINSZ
1436
1522
    - if an error occurs or a negative value is obtained, returns None
1437
1523
 
1438
 
    Windows:
1439
 
    
 
1524
    On Windows we query the OS by:
1440
1525
    - win32utils.get_console_size() decides,
1441
1526
    - returns None on error (provided default value)
1442
1527
    """
 
1528
    # Note to implementors: if changing the rules for determining the width,
 
1529
    # make sure you've considered the behaviour in these cases:
 
1530
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
 
1531
    #  - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
 
1532
    #    0,0.
 
1533
    #  - (add more interesting cases here, if you find any)
 
1534
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
 
1535
    # but we don't want to register a signal handler because it is impossible
 
1536
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
 
1537
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
 
1538
    # time so we can notice if the reported size has changed, which should have
 
1539
    # a similar effect.
1443
1540
 
1444
1541
    # If BZR_COLUMNS is set, take it, user is always right
 
1542
    # Except if they specified 0 in which case, impose no limit here
1445
1543
    try:
1446
 
        return int(os.environ['BZR_COLUMNS'])
 
1544
        width = int(os.environ['BZR_COLUMNS'])
1447
1545
    except (KeyError, ValueError):
1448
 
        pass
 
1546
        width = None
 
1547
    if width is not None:
 
1548
        if width > 0:
 
1549
            return width
 
1550
        else:
 
1551
            return None
1449
1552
 
1450
1553
    isatty = getattr(sys.stdout, 'isatty', None)
1451
 
    if  isatty is None or not isatty():
 
1554
    if isatty is None or not isatty():
1452
1555
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1453
1556
        return None
1454
1557
 
1455
 
    # If COLUMNS is set, take it, the terminal knows better (even inside a
1456
 
    # given terminal, the application can decide to set COLUMNS to a lower
1457
 
    # value (splitted screen) or a bigger value (scroll bars))
 
1558
    # Query the OS
 
1559
    width, height = os_size = _terminal_size(None, None)
 
1560
    global _first_terminal_size, _terminal_size_state
 
1561
    if _terminal_size_state == 'no_data':
 
1562
        _first_terminal_size = os_size
 
1563
        _terminal_size_state = 'unchanged'
 
1564
    elif (_terminal_size_state == 'unchanged' and
 
1565
          _first_terminal_size != os_size):
 
1566
        _terminal_size_state = 'changed'
 
1567
 
 
1568
    # If the OS claims to know how wide the terminal is, and this value has
 
1569
    # ever changed, use that.
 
1570
    if _terminal_size_state == 'changed':
 
1571
        if width is not None and width > 0:
 
1572
            return width
 
1573
 
 
1574
    # If COLUMNS is set, use it.
1458
1575
    try:
1459
1576
        return int(os.environ['COLUMNS'])
1460
1577
    except (KeyError, ValueError):
1461
1578
        pass
1462
1579
 
1463
 
    width, height = _terminal_size(None, None)
1464
 
    if width <= 0:
1465
 
        # Consider invalid values as meaning no width
1466
 
        return None
 
1580
    # Finally, use an unchanged size from the OS, if we have one.
 
1581
    if _terminal_size_state == 'unchanged':
 
1582
        if width is not None and width > 0:
 
1583
            return width
1467
1584
 
1468
 
    return width
 
1585
    # The width could not be determined.
 
1586
    return None
1469
1587
 
1470
1588
 
1471
1589
def _win32_terminal_size(width, height):
1498
1616
    _terminal_size = _ioctl_terminal_size
1499
1617
 
1500
1618
 
1501
 
def _terminal_size_changed(signum, frame):
1502
 
    """Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
1503
 
    width, height = _terminal_size(None, None)
1504
 
    if width is not None:
1505
 
        os.environ['COLUMNS'] = str(width)
1506
 
 
1507
 
 
1508
 
_registered_sigwinch = False
1509
 
def watch_sigwinch():
1510
 
    """Register for SIGWINCH, once and only once.
1511
 
 
1512
 
    Do nothing if the signal module is not available.
1513
 
    """
1514
 
    global _registered_sigwinch
1515
 
    if not _registered_sigwinch:
1516
 
        try:
1517
 
            import signal
1518
 
            if getattr(signal, "SIGWINCH", None) is not None:
1519
 
                set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
1520
 
        except ImportError:
1521
 
            # python doesn't provide signal support, nothing we can do about it
1522
 
            pass
1523
 
        _registered_sigwinch = True
1524
 
 
1525
 
 
1526
1619
def supports_executable():
1527
1620
    return sys.platform != "win32"
1528
1621
 
1651
1744
        dirblock = []
1652
1745
        append = dirblock.append
1653
1746
        try:
1654
 
            names = sorted(_listdir(top))
 
1747
            names = sorted(map(decode_filename, _listdir(top)))
1655
1748
        except OSError, e:
1656
1749
            if not _is_error_enotdir(e):
1657
1750
                raise
1711
1804
    """
1712
1805
    global _selected_dir_reader
1713
1806
    if _selected_dir_reader is None:
1714
 
        fs_encoding = _fs_enc.upper()
1715
1807
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1716
1808
            # Win98 doesn't have unicode apis like FindFirstFileW
1717
1809
            # TODO: We possibly could support Win98 by falling back to the
1723
1815
                _selected_dir_reader = Win32ReadDir()
1724
1816
            except ImportError:
1725
1817
                pass
1726
 
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1727
 
            # ANSI_X3.4-1968 is a form of ASCII
 
1818
        elif _fs_enc in ('utf-8', 'ascii'):
1728
1819
            try:
1729
1820
                from bzrlib._readdir_pyx import UTF8DirReader
1730
1821
                _selected_dir_reader = UTF8DirReader()
1865
1956
        s = os.stat(src)
1866
1957
        chown(dst, s.st_uid, s.st_gid)
1867
1958
    except OSError, e:
1868
 
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
 
1959
        trace.warning(
 
1960
            'Unable to copy ownership from "%s" to "%s". '
 
1961
            'You may want to set it manually.', src, dst)
 
1962
        trace.log_exception_quietly()
1869
1963
 
1870
1964
 
1871
1965
def path_prefix_key(path):
1886
1980
_cached_user_encoding = None
1887
1981
 
1888
1982
 
1889
 
def get_user_encoding(use_cache=True):
 
1983
def get_user_encoding(use_cache=DEPRECATED_PARAMETER):
1890
1984
    """Find out what the preferred user encoding is.
1891
1985
 
1892
1986
    This is generally the encoding that is used for command line parameters
1893
1987
    and file contents. This may be different from the terminal encoding
1894
1988
    or the filesystem encoding.
1895
1989
 
1896
 
    :param  use_cache:  Enable cache for detected encoding.
1897
 
                        (This parameter is turned on by default,
1898
 
                        and required only for selftesting)
1899
 
 
1900
1990
    :return: A string defining the preferred user encoding
1901
1991
    """
1902
1992
    global _cached_user_encoding
1903
 
    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:
1904
1997
        return _cached_user_encoding
1905
1998
 
1906
 
    if sys.platform == 'darwin':
1907
 
        # python locale.getpreferredencoding() always return
1908
 
        # 'mac-roman' on darwin. That's a lie.
1909
 
        sys.platform = 'posix'
1910
 
        try:
1911
 
            if os.environ.get('LANG', None) is None:
1912
 
                # If LANG is not set, we end up with 'ascii', which is bad
1913
 
                # ('mac-roman' is more than ascii), so we set a default which
1914
 
                # will give us UTF-8 (which appears to work in all cases on
1915
 
                # OSX). Users are still free to override LANG of course, as
1916
 
                # long as it give us something meaningful. This work-around
1917
 
                # *may* not be needed with python 3k and/or OSX 10.5, but will
1918
 
                # work with them too -- vila 20080908
1919
 
                os.environ['LANG'] = 'en_US.UTF-8'
1920
 
            import locale
1921
 
        finally:
1922
 
            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)
1923
2005
    else:
1924
 
        import locale
 
2006
        # GZ 2011-12-19: On windows could call GetACP directly instead.
 
2007
        user_encoding = locale.getpreferredencoding(False)
1925
2008
 
1926
2009
    try:
1927
 
        user_encoding = locale.getpreferredencoding()
1928
 
    except locale.Error, e:
1929
 
        sys.stderr.write('bzr: warning: %s\n'
1930
 
                         '  Could not determine what text encoding to use.\n'
1931
 
                         '  This error usually means your Python interpreter\n'
1932
 
                         '  doesn\'t support the locale set by $LANG (%s)\n'
1933
 
                         "  Continuing with ascii encoding.\n"
1934
 
                         % (e, os.environ.get('LANG')))
1935
 
        user_encoding = 'ascii'
1936
 
 
1937
 
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
1938
 
    # treat that as ASCII, and not support printing unicode characters to the
1939
 
    # console.
1940
 
    #
1941
 
    # For python scripts run under vim, we get '', so also treat that as ASCII
1942
 
    if user_encoding in (None, 'cp0', ''):
1943
 
        user_encoding = 'ascii'
1944
 
    else:
1945
 
        # check encoding
1946
 
        try:
1947
 
            codecs.lookup(user_encoding)
1948
 
        except LookupError:
 
2010
        user_encoding = codecs.lookup(user_encoding).name
 
2011
    except LookupError:
 
2012
        if user_encoding not in ("", "cp0"):
1949
2013
            sys.stderr.write('bzr: warning:'
1950
2014
                             ' unknown encoding %s.'
1951
2015
                             ' Continuing with ascii encoding.\n'
1952
2016
                             % user_encoding
1953
2017
                            )
1954
 
            user_encoding = 'ascii'
1955
 
 
1956
 
    if use_cache:
1957
 
        _cached_user_encoding = user_encoding
1958
 
 
 
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
1959
2030
    return user_encoding
1960
2031
 
1961
2032
 
 
2033
def get_diff_header_encoding():
 
2034
    return get_terminal_encoding()
 
2035
 
 
2036
 
1962
2037
def get_host_name():
1963
2038
    """Return the current unicode host name.
1964
2039
 
1966
2041
    behaves inconsistently on different platforms.
1967
2042
    """
1968
2043
    if sys.platform == "win32":
1969
 
        import win32utils
1970
2044
        return win32utils.get_host_name()
1971
2045
    else:
1972
2046
        import socket
1979
2053
# data at once.
1980
2054
MAX_SOCKET_CHUNK = 64 * 1024
1981
2055
 
 
2056
_end_of_stream_errors = [errno.ECONNRESET]
 
2057
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
 
2058
    _eno = getattr(errno, _eno, None)
 
2059
    if _eno is not None:
 
2060
        _end_of_stream_errors.append(_eno)
 
2061
del _eno
 
2062
 
 
2063
 
1982
2064
def read_bytes_from_socket(sock, report_activity=None,
1983
2065
        max_read_size=MAX_SOCKET_CHUNK):
1984
2066
    """Read up to max_read_size of bytes from sock and notify of progress.
1992
2074
            bytes = sock.recv(max_read_size)
1993
2075
        except socket.error, e:
1994
2076
            eno = e.args[0]
1995
 
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
 
2077
            if eno in _end_of_stream_errors:
1996
2078
                # The connection was closed by the other side.  Callers expect
1997
2079
                # an empty string to signal end-of-stream.
1998
2080
                return ""
2027
2109
 
2028
2110
def send_all(sock, bytes, report_activity=None):
2029
2111
    """Send all bytes on a socket.
2030
 
 
 
2112
 
2031
2113
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2032
2114
    some platforms, and catches EINTR which may be thrown if the send is
2033
2115
    interrupted by a signal.
2034
2116
 
2035
2117
    This is preferred to socket.sendall(), because it avoids portability bugs
2036
2118
    and provides activity reporting.
2037
 
 
 
2119
 
2038
2120
    :param report_activity: Call this as bytes are read, see
2039
2121
        Transport._report_activity
2040
2122
    """
2051
2133
            report_activity(sent, 'write')
2052
2134
 
2053
2135
 
 
2136
def connect_socket(address):
 
2137
    # Slight variation of the socket.create_connection() function (provided by
 
2138
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
 
2139
    # provide it for previous python versions. Also, we don't use the timeout
 
2140
    # parameter (provided by the python implementation) so we don't implement
 
2141
    # it either).
 
2142
    err = socket.error('getaddrinfo returns an empty list')
 
2143
    host, port = address
 
2144
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
 
2145
        af, socktype, proto, canonname, sa = res
 
2146
        sock = None
 
2147
        try:
 
2148
            sock = socket.socket(af, socktype, proto)
 
2149
            sock.connect(sa)
 
2150
            return sock
 
2151
 
 
2152
        except socket.error, err:
 
2153
            # 'err' is now the most recent error
 
2154
            if sock is not None:
 
2155
                sock.close()
 
2156
    raise err
 
2157
 
 
2158
 
2054
2159
def dereference_path(path):
2055
2160
    """Determine the real path to a file.
2056
2161
 
2095
2200
    base = dirname(bzrlib.__file__)
2096
2201
    if getattr(sys, 'frozen', None):    # bzr.exe
2097
2202
        base = abspath(pathjoin(base, '..', '..'))
2098
 
    filename = pathjoin(base, resource_relpath)
2099
 
    return open(filename, 'rU').read()
2100
 
 
 
2203
    f = file(pathjoin(base, resource_relpath), "rU")
 
2204
    try:
 
2205
        return f.read()
 
2206
    finally:
 
2207
        f.close()
2101
2208
 
2102
2209
def file_kind_from_stat_mode_thunk(mode):
2103
2210
    global file_kind_from_stat_mode
2114
2221
    return file_kind_from_stat_mode(mode)
2115
2222
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2116
2223
 
2117
 
 
2118
 
def file_kind(f, _lstat=os.lstat):
 
2224
def file_stat(f, _lstat=os.lstat):
2119
2225
    try:
2120
 
        return file_kind_from_stat_mode(_lstat(f).st_mode)
 
2226
        # XXX cache?
 
2227
        return _lstat(f)
2121
2228
    except OSError, e:
2122
2229
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2123
2230
            raise errors.NoSuchFile(f)
2124
2231
        raise
2125
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)
2126
2236
 
2127
2237
def until_no_eintr(f, *a, **kw):
2128
2238
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2129
 
    
 
2239
 
2130
2240
    WARNING: you must be certain that it is safe to retry the call repeatedly
2131
2241
    if EINTR does occur.  This is typically only true for low-level operations
2132
2242
    like os.read.  If in any doubt, don't use this.
2147
2257
            raise
2148
2258
 
2149
2259
 
 
2260
@deprecated_function(deprecated_in((2, 2, 0)))
2150
2261
def re_compile_checked(re_string, flags=0, where=""):
2151
2262
    """Return a compiled re, or raise a sensible error.
2152
2263
 
2162
2273
        re_obj = re.compile(re_string, flags)
2163
2274
        re_obj.search("")
2164
2275
        return re_obj
2165
 
    except re.error, e:
 
2276
    except errors.InvalidPattern, e:
2166
2277
        if where:
2167
2278
            where = ' in ' + where
2168
2279
        # despite the name 'error' is a type
2169
 
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2170
 
            % (where, re_string, e))
 
2280
        raise errors.BzrCommandError('Invalid regular expression%s: %s'
 
2281
            % (where, e.msg))
2171
2282
 
2172
2283
 
2173
2284
if sys.platform == "win32":
2174
 
    import msvcrt
2175
2285
    def getchar():
 
2286
        import msvcrt
2176
2287
        return msvcrt.getch()
2177
2288
else:
2178
 
    import tty
2179
 
    import termios
2180
2289
    def getchar():
 
2290
        import tty
 
2291
        import termios
2181
2292
        fd = sys.stdin.fileno()
2182
2293
        settings = termios.tcgetattr(fd)
2183
2294
        try:
2187
2298
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2188
2299
        return ch
2189
2300
 
2190
 
 
2191
 
if sys.platform == 'linux2':
 
2301
if sys.platform.startswith('linux'):
2192
2302
    def _local_concurrency():
2193
 
        concurrency = None
2194
 
        prefix = 'processor'
2195
 
        for line in file('/proc/cpuinfo', 'rb'):
2196
 
            if line.startswith(prefix):
2197
 
                concurrency = int(line[line.find(':')+1:]) + 1
2198
 
        return concurrency
 
2303
        try:
 
2304
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2305
        except (ValueError, OSError, AttributeError):
 
2306
            return None
2199
2307
elif sys.platform == 'darwin':
2200
2308
    def _local_concurrency():
2201
2309
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2202
2310
                                stdout=subprocess.PIPE).communicate()[0]
2203
 
elif sys.platform[0:7] == 'freebsd':
 
2311
elif "bsd" in sys.platform:
2204
2312
    def _local_concurrency():
2205
2313
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2206
2314
                                stdout=subprocess.PIPE).communicate()[0]
2234
2342
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2235
2343
    if concurrency is None:
2236
2344
        try:
2237
 
            concurrency = _local_concurrency()
2238
 
        except (OSError, IOError):
2239
 
            pass
 
2345
            import multiprocessing
 
2346
            concurrency = multiprocessing.cpu_count()
 
2347
        except (ImportError, NotImplementedError):
 
2348
            # multiprocessing is only available on Python >= 2.6
 
2349
            # and multiprocessing.cpu_count() isn't implemented on all
 
2350
            # platforms
 
2351
            try:
 
2352
                concurrency = _local_concurrency()
 
2353
            except (OSError, IOError):
 
2354
                pass
2240
2355
    try:
2241
2356
        concurrency = int(concurrency)
2242
2357
    except (TypeError, ValueError):
2263
2378
if sys.platform == 'win32':
2264
2379
    def open_file(filename, mode='r', bufsize=-1):
2265
2380
        """This function is used to override the ``open`` builtin.
2266
 
        
 
2381
 
2267
2382
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2268
2383
        child processes.  Deleting or renaming a closed file opened with this
2269
2384
        function is not blocking child processes.
2302
2417
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2303
2418
else:
2304
2419
    open_file = open
 
2420
 
 
2421
 
 
2422
def available_backup_name(base, exists):
 
2423
    """Find a non-existing backup file name.
 
2424
 
 
2425
    This will *not* create anything, this only return a 'free' entry.  This
 
2426
    should be used for checking names in a directory below a locked
 
2427
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
 
2428
    Leap) and generally discouraged.
 
2429
 
 
2430
    :param base: The base name.
 
2431
 
 
2432
    :param exists: A callable returning True if the path parameter exists.
 
2433
    """
 
2434
    counter = 1
 
2435
    name = "%s.~%d~" % (base, counter)
 
2436
    while exists(name):
 
2437
        counter += 1
 
2438
        name = "%s.~%d~" % (base, counter)
 
2439
    return name
 
2440
 
 
2441
 
 
2442
def set_fd_cloexec(fd):
 
2443
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
 
2444
    support for this is not available.
 
2445
    """
 
2446
    try:
 
2447
        import fcntl
 
2448
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
 
2449
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
 
2450
    except (ImportError, AttributeError):
 
2451
        # Either the fcntl module or specific constants are not present
 
2452
        pass
 
2453
 
 
2454
 
 
2455
def find_executable_on_path(name):
 
2456
    """Finds an executable on the PATH.
 
2457
    
 
2458
    On Windows, this will try to append each extension in the PATHEXT
 
2459
    environment variable to the name, if it cannot be found with the name
 
2460
    as given.
 
2461
    
 
2462
    :param name: The base name of the executable.
 
2463
    :return: The path to the executable found or None.
 
2464
    """
 
2465
    path = os.environ.get('PATH')
 
2466
    if path is None:
 
2467
        return None
 
2468
    path = path.split(os.pathsep)
 
2469
    if sys.platform == 'win32':
 
2470
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
 
2471
        exts = [ext.lower() for ext in exts]
 
2472
        base, ext = os.path.splitext(name)
 
2473
        if ext != '':
 
2474
            if ext.lower() not in exts:
 
2475
                return None
 
2476
            name = base
 
2477
            exts = [ext]
 
2478
    else:
 
2479
        exts = ['']
 
2480
    for ext in exts:
 
2481
        for d in path:
 
2482
            f = os.path.join(d, name) + ext
 
2483
            if os.access(f, os.X_OK):
 
2484
                return f
 
2485
    return None
 
2486
 
 
2487
 
 
2488
def _posix_is_local_pid_dead(pid):
 
2489
    """True if pid doesn't correspond to live process on this machine"""
 
2490
    try:
 
2491
        # Special meaning of unix kill: just check if it's there.
 
2492
        os.kill(pid, 0)
 
2493
    except OSError, e:
 
2494
        if e.errno == errno.ESRCH:
 
2495
            # On this machine, and really not found: as sure as we can be
 
2496
            # that it's dead.
 
2497
            return True
 
2498
        elif e.errno == errno.EPERM:
 
2499
            # exists, though not ours
 
2500
            return False
 
2501
        else:
 
2502
            mutter("os.kill(%d, 0) failed: %s" % (pid, e))
 
2503
            # Don't really know.
 
2504
            return False
 
2505
    else:
 
2506
        # Exists and our process: not dead.
 
2507
        return False
 
2508
 
 
2509
if sys.platform == "win32":
 
2510
    is_local_pid_dead = win32utils.is_local_pid_dead
 
2511
else:
 
2512
    is_local_pid_dead = _posix_is_local_pid_dead
 
2513
 
 
2514
 
 
2515
def fdatasync(fileno):
 
2516
    """Flush file contents to disk if possible.
 
2517
    
 
2518
    :param fileno: Integer OS file handle.
 
2519
    :raises TransportNotPossible: If flushing to disk is not possible.
 
2520
    """
 
2521
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
 
2522
    if fn is not None:
 
2523
        fn(fileno)
 
2524
 
 
2525
 
 
2526
def ensure_empty_directory_exists(path, exception_class):
 
2527
    """Make sure a local directory exists and is empty.
 
2528
    
 
2529
    If it does not exist, it is created.  If it exists and is not empty, an
 
2530
    instance of exception_class is raised.
 
2531
    """
 
2532
    try:
 
2533
        os.mkdir(path)
 
2534
    except OSError, e:
 
2535
        if e.errno != errno.EEXIST:
 
2536
            raise
 
2537
        if os.listdir(path) != []:
 
2538
            raise exception_class(path)
 
2539
 
 
2540
 
 
2541
def is_environment_error(evalue):
 
2542
    """True if exception instance is due to a process environment issue
 
2543
 
 
2544
    This includes OSError and IOError, but also other errors that come from
 
2545
    the operating system or core libraries but are not subclasses of those.
 
2546
    """
 
2547
    if isinstance(evalue, (EnvironmentError, select.error)):
 
2548
        return True
 
2549
    if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
 
2550
        return True
 
2551
    return False