~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Vincent Ladeuil
  • Date: 2011-12-21 14:25:26 UTC
  • mto: This revision was merged to the branch mainline in revision 6397.
  • Revision ID: v.ladeuil+lp@free.fr-20111221142526-pnwau0xnalimujts
Provides MemoryStack to simplify configuration setup in tests

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from __future__ import absolute_import
 
18
 
 
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
 
                  S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
22
23
import sys
23
24
import time
24
 
import warnings
 
25
import codecs
25
26
 
26
27
from bzrlib.lazy_import import lazy_import
27
28
lazy_import(globals(), """
28
 
import codecs
29
29
from datetime import datetime
30
 
import errno
31
 
from ntpath import (abspath as _nt_abspath,
32
 
                    join as _nt_join,
33
 
                    normpath as _nt_normpath,
34
 
                    realpath as _nt_realpath,
35
 
                    splitdrive as _nt_splitdrive,
36
 
                    )
 
30
import getpass
 
31
import ntpath
37
32
import posixpath
 
33
import select
 
34
# We need to import both shutil and rmtree as we export the later on posix
 
35
# and need the former on windows
38
36
import shutil
39
 
from shutil import (
40
 
    rmtree,
41
 
    )
42
 
import signal
 
37
from shutil import rmtree
 
38
import socket
43
39
import subprocess
 
40
# We need to import both tempfile and mkdtemp as we export the later on posix
 
41
# and need the former on windows
44
42
import tempfile
45
 
from tempfile import (
46
 
    mkdtemp,
47
 
    )
 
43
from tempfile import mkdtemp
48
44
import unicodedata
49
45
 
50
46
from bzrlib import (
51
47
    cache_utf8,
 
48
    config,
52
49
    errors,
 
50
    trace,
53
51
    win32utils,
54
52
    )
 
53
from bzrlib.i18n import gettext
55
54
""")
56
55
 
57
 
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
58
 
# of 2.5
59
 
if sys.version_info < (2, 5):
60
 
    import md5 as _mod_md5
61
 
    md5 = _mod_md5.new
62
 
    import sha as _mod_sha
63
 
    sha = _mod_sha.new
64
 
else:
65
 
    from hashlib import (
66
 
        md5,
67
 
        sha1 as sha,
68
 
        )
 
56
from bzrlib.symbol_versioning import (
 
57
    deprecated_function,
 
58
    deprecated_in,
 
59
    )
 
60
 
 
61
from hashlib import (
 
62
    md5,
 
63
    sha1 as sha,
 
64
    )
69
65
 
70
66
 
71
67
import bzrlib
72
 
from bzrlib import symbol_versioning
 
68
from bzrlib import symbol_versioning, _fs_enc
73
69
 
74
70
 
75
71
# Cross platform wall-clock time functionality with decent resolution.
85
81
# be opened in binary mode, rather than text mode.
86
82
# On other platforms, O_BINARY doesn't exist, because
87
83
# they always open in binary mode, so it is okay to
88
 
# OR with 0 on those platforms
 
84
# OR with 0 on those platforms.
 
85
# O_NOINHERIT and O_TEXT exists only on win32 too.
89
86
O_BINARY = getattr(os, 'O_BINARY', 0)
 
87
O_TEXT = getattr(os, 'O_TEXT', 0)
 
88
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
90
89
 
91
90
 
92
91
def get_unicode_argv():
94
93
        user_encoding = get_user_encoding()
95
94
        return [a.decode(user_encoding) for a in sys.argv[1:]]
96
95
    except UnicodeDecodeError:
97
 
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
98
 
                                                            "encoding." % a))
 
96
        raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
 
97
            "application locale.").format(a, user_encoding))
99
98
 
100
99
 
101
100
def make_readonly(filename):
103
102
    mod = os.lstat(filename).st_mode
104
103
    if not stat.S_ISLNK(mod):
105
104
        mod = mod & 0777555
106
 
        os.chmod(filename, mod)
 
105
        chmod_if_possible(filename, mod)
107
106
 
108
107
 
109
108
def make_writable(filename):
110
109
    mod = os.lstat(filename).st_mode
111
110
    if not stat.S_ISLNK(mod):
112
111
        mod = mod | 0200
113
 
        os.chmod(filename, mod)
 
112
        chmod_if_possible(filename, mod)
 
113
 
 
114
 
 
115
def chmod_if_possible(filename, mode):
 
116
    # Set file mode if that can be safely done.
 
117
    # Sometimes even on unix the filesystem won't allow it - see
 
118
    # https://bugs.launchpad.net/bzr/+bug/606537
 
119
    try:
 
120
        # It is probably faster to just do the chmod, rather than
 
121
        # doing a stat, and then trying to compare
 
122
        os.chmod(filename, mode)
 
123
    except (IOError, OSError),e:
 
124
        # Permission/access denied seems to commonly happen on smbfs; there's
 
125
        # probably no point warning about it.
 
126
        # <https://bugs.launchpad.net/bzr/+bug/606537>
 
127
        if getattr(e, 'errno') in (errno.EPERM, errno.EACCES):
 
128
            trace.mutter("ignore error on chmod of %r: %r" % (
 
129
                filename, e))
 
130
            return
 
131
        raise
114
132
 
115
133
 
116
134
def minimum_path_selection(paths):
195
213
            if e.errno == errno.ENOENT:
196
214
                return False;
197
215
            else:
198
 
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
 
216
                raise errors.BzrError(gettext("lstat/stat of ({0!r}): {1!r}").format(f, e))
199
217
 
200
218
 
201
219
def fancy_rename(old, new, rename_func, unlink_func):
267
285
            else:
268
286
                rename_func(tmp_name, new)
269
287
    if failure_exc is not None:
270
 
        raise failure_exc[0], failure_exc[1], failure_exc[2]
 
288
        try:
 
289
            raise failure_exc[0], failure_exc[1], failure_exc[2]
 
290
        finally:
 
291
            del failure_exc
271
292
 
272
293
 
273
294
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
274
295
# choke on a Unicode string containing a relative path if
275
296
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
276
297
# string.
277
 
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
278
298
def _posix_abspath(path):
279
299
    # jam 20060426 rather than encoding to fsencoding
280
300
    # copy posixpath.abspath, but use os.getcwdu instead
281
301
    if not posixpath.isabs(path):
282
302
        path = posixpath.join(getcwd(), path)
283
 
    return posixpath.normpath(path)
 
303
    return _posix_normpath(path)
284
304
 
285
305
 
286
306
def _posix_realpath(path):
287
307
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
288
308
 
289
309
 
 
310
def _posix_normpath(path):
 
311
    path = posixpath.normpath(path)
 
312
    # Bug 861008: posixpath.normpath() returns a path normalized according to
 
313
    # the POSIX standard, which stipulates (for compatibility reasons) that two
 
314
    # leading slashes must not be simplified to one, and only if there are 3 or
 
315
    # more should they be simplified as one. So we treat the leading 2 slashes
 
316
    # as a special case here by simply removing the first slash, as we consider
 
317
    # that breaking POSIX compatibility for this obscure feature is acceptable.
 
318
    # This is not a paranoid precaution, as we notably get paths like this when
 
319
    # the repo is hosted at the root of the filesystem, i.e. in "/".    
 
320
    if path.startswith('//'):
 
321
        path = path[1:]
 
322
    return path
 
323
 
 
324
 
 
325
def _posix_path_from_environ(key):
 
326
    """Get unicode path from `key` in environment or None if not present
 
327
 
 
328
    Note that posix systems use arbitrary byte strings for filesystem objects,
 
329
    so a path that raises BadFilenameEncoding here may still be accessible.
 
330
    """
 
331
    val = os.environ.get(key, None)
 
332
    if val is None:
 
333
        return val
 
334
    try:
 
335
        return val.decode(_fs_enc)
 
336
    except UnicodeDecodeError:
 
337
        # GZ 2011-12-12:Ideally want to include `key` in the exception message
 
338
        raise errors.BadFilenameEncoding(val, _fs_enc)
 
339
 
 
340
 
 
341
def _posix_getuser_unicode():
 
342
    """Get username from environment or password database as unicode"""
 
343
    name = getpass.getuser()
 
344
    user_encoding = get_user_encoding()
 
345
    try:
 
346
        return name.decode(user_encoding)
 
347
    except UnicodeDecodeError:
 
348
        raise errors.BzrError("Encoding of username %r is unsupported by %s "
 
349
            "application locale." % (name, user_encoding))
 
350
 
 
351
 
290
352
def _win32_fixdrive(path):
291
353
    """Force drive letters to be consistent.
292
354
 
296
358
    running python.exe under cmd.exe return capital C:\\
297
359
    running win32 python inside a cygwin shell returns lowercase c:\\
298
360
    """
299
 
    drive, path = _nt_splitdrive(path)
 
361
    drive, path = ntpath.splitdrive(path)
300
362
    return drive.upper() + path
301
363
 
302
364
 
303
365
def _win32_abspath(path):
304
 
    # Real _nt_abspath doesn't have a problem with a unicode cwd
305
 
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
 
366
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
 
367
    return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
306
368
 
307
369
 
308
370
def _win98_abspath(path):
319
381
    #   /path       => C:/path
320
382
    path = unicode(path)
321
383
    # check for absolute path
322
 
    drive = _nt_splitdrive(path)[0]
 
384
    drive = ntpath.splitdrive(path)[0]
323
385
    if drive == '' and path[:2] not in('//','\\\\'):
324
386
        cwd = os.getcwdu()
325
387
        # we cannot simply os.path.join cwd and path
326
388
        # because os.path.join('C:','/path') produce '/path'
327
389
        # and this is incorrect
328
390
        if path[:1] in ('/','\\'):
329
 
            cwd = _nt_splitdrive(cwd)[0]
 
391
            cwd = ntpath.splitdrive(cwd)[0]
330
392
            path = path[1:]
331
393
        path = cwd + '\\' + path
332
 
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
 
394
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
333
395
 
334
396
 
335
397
def _win32_realpath(path):
336
 
    # Real _nt_realpath doesn't have a problem with a unicode cwd
337
 
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
 
398
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
 
399
    return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
338
400
 
339
401
 
340
402
def _win32_pathjoin(*args):
341
 
    return _nt_join(*args).replace('\\', '/')
 
403
    return ntpath.join(*args).replace('\\', '/')
342
404
 
343
405
 
344
406
def _win32_normpath(path):
345
 
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
407
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
346
408
 
347
409
 
348
410
def _win32_getcwd():
380
442
abspath = _posix_abspath
381
443
realpath = _posix_realpath
382
444
pathjoin = os.path.join
383
 
normpath = os.path.normpath
 
445
normpath = _posix_normpath
 
446
path_from_environ = _posix_path_from_environ
 
447
getuser_unicode = _posix_getuser_unicode
384
448
getcwd = os.getcwdu
385
449
rename = os.rename
386
450
dirname = os.path.dirname
387
451
basename = os.path.basename
388
452
split = os.path.split
389
453
splitext = os.path.splitext
390
 
# These were already imported into local scope
 
454
# These were already lazily imported into local scope
391
455
# mkdtemp = tempfile.mkdtemp
392
456
# rmtree = shutil.rmtree
 
457
lstat = os.lstat
 
458
fstat = os.fstat
 
459
 
 
460
def wrap_stat(st):
 
461
    return st
 
462
 
393
463
 
394
464
MIN_ABS_PATHLENGTH = 1
395
465
 
405
475
    getcwd = _win32_getcwd
406
476
    mkdtemp = _win32_mkdtemp
407
477
    rename = _win32_rename
 
478
    try:
 
479
        from bzrlib import _walkdirs_win32
 
480
    except ImportError:
 
481
        pass
 
482
    else:
 
483
        lstat = _walkdirs_win32.lstat
 
484
        fstat = _walkdirs_win32.fstat
 
485
        wrap_stat = _walkdirs_win32.wrap_stat
408
486
 
409
487
    MIN_ABS_PATHLENGTH = 3
410
488
 
428
506
    f = win32utils.get_unicode_argv     # special function or None
429
507
    if f is not None:
430
508
        get_unicode_argv = f
 
509
    path_from_environ = win32utils.get_environ_unicode
 
510
    getuser_unicode = win32utils.get_user_name
431
511
 
432
512
elif sys.platform == 'darwin':
433
513
    getcwd = _mac_getcwd
434
514
 
435
515
 
436
 
def get_terminal_encoding():
 
516
def get_terminal_encoding(trace=False):
437
517
    """Find the best encoding for printing to the screen.
438
518
 
439
519
    This attempts to check both sys.stdout and sys.stdin to see
445
525
 
446
526
    On my standard US Windows XP, the preferred encoding is
447
527
    cp1252, but the console is cp437
 
528
 
 
529
    :param trace: If True trace the selected encoding via mutter().
448
530
    """
449
531
    from bzrlib.trace import mutter
450
532
    output_encoding = getattr(sys.stdout, 'encoding', None)
452
534
        input_encoding = getattr(sys.stdin, 'encoding', None)
453
535
        if not input_encoding:
454
536
            output_encoding = get_user_encoding()
455
 
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
537
            if trace:
 
538
                mutter('encoding stdout as osutils.get_user_encoding() %r',
456
539
                   output_encoding)
457
540
        else:
458
541
            output_encoding = input_encoding
459
 
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
542
            if trace:
 
543
                mutter('encoding stdout as sys.stdin encoding %r',
 
544
                    output_encoding)
460
545
    else:
461
 
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
546
        if trace:
 
547
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
462
548
    if output_encoding == 'cp0':
463
549
        # invalid encoding (cp0 means 'no codepage' on Windows)
464
550
        output_encoding = get_user_encoding()
465
 
        mutter('cp0 is invalid encoding.'
 
551
        if trace:
 
552
            mutter('cp0 is invalid encoding.'
466
553
               ' encoding stdout as osutils.get_user_encoding() %r',
467
554
               output_encoding)
468
555
    # check encoding
494
581
def isdir(f):
495
582
    """True if f is an accessible directory."""
496
583
    try:
497
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
584
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
498
585
    except OSError:
499
586
        return False
500
587
 
502
589
def isfile(f):
503
590
    """True if f is a regular file."""
504
591
    try:
505
 
        return S_ISREG(os.lstat(f)[ST_MODE])
 
592
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
506
593
    except OSError:
507
594
        return False
508
595
 
509
596
def islink(f):
510
597
    """True if f is a symlink."""
511
598
    try:
512
 
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
599
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
513
600
    except OSError:
514
601
        return False
515
602
 
663
750
def sha_file_by_name(fname):
664
751
    """Calculate the SHA1 of a file by reading the full text"""
665
752
    s = sha()
666
 
    f = os.open(fname, os.O_RDONLY | O_BINARY)
 
753
    f = os.open(fname, os.O_RDONLY | O_BINARY | O_NOINHERIT)
667
754
    try:
668
755
        while True:
669
756
            b = os.read(f, 1<<16)
855
942
 
856
943
def filesize(f):
857
944
    """Return size of given open file."""
858
 
    return os.fstat(f.fileno())[ST_SIZE]
 
945
    return os.fstat(f.fileno())[stat.ST_SIZE]
859
946
 
860
947
 
861
948
# Define rand_bytes based on platform.
906
993
    rps = []
907
994
    for f in ps:
908
995
        if f == '..':
909
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
996
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
910
997
        elif (f == '.') or (f == ''):
911
998
            pass
912
999
        else:
917
1004
def joinpath(p):
918
1005
    for f in p:
919
1006
        if (f == '..') or (f is None) or (f == ''):
920
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1007
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
921
1008
    return pathjoin(*p)
922
1009
 
923
1010
 
924
1011
def parent_directories(filename):
925
1012
    """Return the list of parent directories, deepest first.
926
 
    
 
1013
 
927
1014
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
928
1015
    """
929
1016
    parents = []
953
1040
    # NB: This docstring is just an example, not a doctest, because doctest
954
1041
    # currently can't cope with the use of lazy imports in this namespace --
955
1042
    # mbp 20090729
956
 
    
 
1043
 
957
1044
    # This currently doesn't report the failure at the time it occurs, because
958
1045
    # they tend to happen very early in startup when we can't check config
959
1046
    # files etc, and also we want to report all failures but not spam the user
960
1047
    # with 10 warnings.
961
 
    from bzrlib import trace
962
1048
    exception_str = str(exception)
963
1049
    if exception_str not in _extension_load_failures:
964
1050
        trace.mutter("failed to load compiled extension: %s" % exception_str)
968
1054
def report_extension_load_failures():
969
1055
    if not _extension_load_failures:
970
1056
        return
971
 
    from bzrlib.config import GlobalConfig
972
 
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
 
1057
    if config.GlobalStack().get('ignore_missing_extensions'):
973
1058
        return
974
1059
    # the warnings framework should by default show this only once
975
1060
    from bzrlib.trace import warning
1029
1114
 
1030
1115
 
1031
1116
def delete_any(path):
1032
 
    """Delete a file, symlink or directory.  
1033
 
    
 
1117
    """Delete a file, symlink or directory.
 
1118
 
1034
1119
    Will delete even if readonly.
1035
1120
    """
1036
1121
    try:
1122
1207
 
1123
1208
 
1124
1209
def relpath(base, path):
1125
 
    """Return path relative to base, or raise exception.
 
1210
    """Return path relative to base, or raise PathNotChild exception.
1126
1211
 
1127
1212
    The path may be either an absolute path or a path relative to the
1128
1213
    current working directory.
1130
1215
    os.path.commonprefix (python2.4) has a bad bug that it works just
1131
1216
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
1132
1217
    avoids that problem.
 
1218
 
 
1219
    NOTE: `base` should not have a trailing slash otherwise you'll get
 
1220
    PathNotChild exceptions regardless of `path`.
1133
1221
    """
1134
1222
 
1135
1223
    if len(base) < MIN_ABS_PATHLENGTH:
1136
1224
        # must have space for e.g. a drive letter
1137
 
        raise ValueError('%r is too short to calculate a relative path'
 
1225
        raise ValueError(gettext('%r is too short to calculate a relative path')
1138
1226
            % (base,))
1139
1227
 
1140
1228
    rp = abspath(path)
1222
1310
    # but for now, we haven't optimized...
1223
1311
    return [canonical_relpath(base, p) for p in paths]
1224
1312
 
 
1313
 
 
1314
def decode_filename(filename):
 
1315
    """Decode the filename using the filesystem encoding
 
1316
 
 
1317
    If it is unicode, it is returned.
 
1318
    Otherwise it is decoded from the the filesystem's encoding. If decoding
 
1319
    fails, a errors.BadFilenameEncoding exception is raised.
 
1320
    """
 
1321
    if type(filename) is unicode:
 
1322
        return filename
 
1323
    try:
 
1324
        return filename.decode(_fs_enc)
 
1325
    except UnicodeDecodeError:
 
1326
        raise errors.BadFilenameEncoding(filename, _fs_enc)
 
1327
 
 
1328
 
1225
1329
def safe_unicode(unicode_or_utf8_string):
1226
1330
    """Coerce unicode_or_utf8_string into unicode.
1227
1331
 
1310
1414
def normalizes_filenames():
1311
1415
    """Return True if this platform normalizes unicode filenames.
1312
1416
 
1313
 
    Mac OSX does, Windows/Linux do not.
 
1417
    Only Mac OSX.
1314
1418
    """
1315
1419
    return _platform_normalizes_filenames
1316
1420
 
1321
1425
    On platforms where the system normalizes filenames (Mac OSX),
1322
1426
    you can access a file by any path which will normalize correctly.
1323
1427
    On platforms where the system does not normalize filenames
1324
 
    (Windows, Linux), you have to access a file by its exact path.
 
1428
    (everything else), you have to access a file by its exact path.
1325
1429
 
1326
1430
    Internally, bzr only supports NFC normalization, since that is
1327
1431
    the standard for XML documents.
1346
1450
    normalized_filename = _inaccessible_normalized_filename
1347
1451
 
1348
1452
 
 
1453
def set_signal_handler(signum, handler, restart_syscall=True):
 
1454
    """A wrapper for signal.signal that also calls siginterrupt(signum, False)
 
1455
    on platforms that support that.
 
1456
 
 
1457
    :param restart_syscall: if set, allow syscalls interrupted by a signal to
 
1458
        automatically restart (by calling `signal.siginterrupt(signum,
 
1459
        False)`).  May be ignored if the feature is not available on this
 
1460
        platform or Python version.
 
1461
    """
 
1462
    try:
 
1463
        import signal
 
1464
        siginterrupt = signal.siginterrupt
 
1465
    except ImportError:
 
1466
        # This python implementation doesn't provide signal support, hence no
 
1467
        # handler exists
 
1468
        return None
 
1469
    except AttributeError:
 
1470
        # siginterrupt doesn't exist on this platform, or for this version
 
1471
        # of Python.
 
1472
        siginterrupt = lambda signum, flag: None
 
1473
    if restart_syscall:
 
1474
        def sig_handler(*args):
 
1475
            # Python resets the siginterrupt flag when a signal is
 
1476
            # received.  <http://bugs.python.org/issue8354>
 
1477
            # As a workaround for some cases, set it back the way we want it.
 
1478
            siginterrupt(signum, False)
 
1479
            # Now run the handler function passed to set_signal_handler.
 
1480
            handler(*args)
 
1481
    else:
 
1482
        sig_handler = handler
 
1483
    old_handler = signal.signal(signum, sig_handler)
 
1484
    if restart_syscall:
 
1485
        siginterrupt(signum, False)
 
1486
    return old_handler
 
1487
 
 
1488
 
1349
1489
default_terminal_width = 80
1350
1490
"""The default terminal width for ttys.
1351
1491
 
1353
1493
terminal_width() returns None.
1354
1494
"""
1355
1495
 
 
1496
# Keep some state so that terminal_width can detect if _terminal_size has
 
1497
# returned a different size since the process started.  See docstring and
 
1498
# comments of terminal_width for details.
 
1499
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
 
1500
_terminal_size_state = 'no_data'
 
1501
_first_terminal_size = None
1356
1502
 
1357
1503
def terminal_width():
1358
1504
    """Return terminal width.
1362
1508
    The rules are:
1363
1509
    - if BZR_COLUMNS is set, returns its value
1364
1510
    - if there is no controlling terminal, returns None
 
1511
    - query the OS, if the queried size has changed since the last query,
 
1512
      return its value,
1365
1513
    - if COLUMNS is set, returns its value,
 
1514
    - if the OS has a value (even though it's never changed), return its value.
1366
1515
 
1367
1516
    From there, we need to query the OS to get the size of the controlling
1368
1517
    terminal.
1369
1518
 
1370
 
    Unices:
 
1519
    On Unices we query the OS by:
1371
1520
    - get termios.TIOCGWINSZ
1372
1521
    - if an error occurs or a negative value is obtained, returns None
1373
1522
 
1374
 
    Windows:
1375
 
    
 
1523
    On Windows we query the OS by:
1376
1524
    - win32utils.get_console_size() decides,
1377
1525
    - returns None on error (provided default value)
1378
1526
    """
 
1527
    # Note to implementors: if changing the rules for determining the width,
 
1528
    # make sure you've considered the behaviour in these cases:
 
1529
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
 
1530
    #  - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
 
1531
    #    0,0.
 
1532
    #  - (add more interesting cases here, if you find any)
 
1533
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
 
1534
    # but we don't want to register a signal handler because it is impossible
 
1535
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
 
1536
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
 
1537
    # time so we can notice if the reported size has changed, which should have
 
1538
    # a similar effect.
1379
1539
 
1380
1540
    # If BZR_COLUMNS is set, take it, user is always right
 
1541
    # Except if they specified 0 in which case, impose no limit here
1381
1542
    try:
1382
 
        return int(os.environ['BZR_COLUMNS'])
 
1543
        width = int(os.environ['BZR_COLUMNS'])
1383
1544
    except (KeyError, ValueError):
1384
 
        pass
 
1545
        width = None
 
1546
    if width is not None:
 
1547
        if width > 0:
 
1548
            return width
 
1549
        else:
 
1550
            return None
1385
1551
 
1386
1552
    isatty = getattr(sys.stdout, 'isatty', None)
1387
 
    if  isatty is None or not isatty():
 
1553
    if isatty is None or not isatty():
1388
1554
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1389
1555
        return None
1390
1556
 
1391
 
    # If COLUMNS is set, take it, the terminal knows better (even inside a
1392
 
    # given terminal, the application can decide to set COLUMNS to a lower
1393
 
    # value (splitted screen) or a bigger value (scroll bars))
 
1557
    # Query the OS
 
1558
    width, height = os_size = _terminal_size(None, None)
 
1559
    global _first_terminal_size, _terminal_size_state
 
1560
    if _terminal_size_state == 'no_data':
 
1561
        _first_terminal_size = os_size
 
1562
        _terminal_size_state = 'unchanged'
 
1563
    elif (_terminal_size_state == 'unchanged' and
 
1564
          _first_terminal_size != os_size):
 
1565
        _terminal_size_state = 'changed'
 
1566
 
 
1567
    # If the OS claims to know how wide the terminal is, and this value has
 
1568
    # ever changed, use that.
 
1569
    if _terminal_size_state == 'changed':
 
1570
        if width is not None and width > 0:
 
1571
            return width
 
1572
 
 
1573
    # If COLUMNS is set, use it.
1394
1574
    try:
1395
1575
        return int(os.environ['COLUMNS'])
1396
1576
    except (KeyError, ValueError):
1397
1577
        pass
1398
1578
 
1399
 
    width, height = _terminal_size(None, None)
1400
 
    if width <= 0:
1401
 
        # Consider invalid values as meaning no width
1402
 
        return None
 
1579
    # Finally, use an unchanged size from the OS, if we have one.
 
1580
    if _terminal_size_state == 'unchanged':
 
1581
        if width is not None and width > 0:
 
1582
            return width
1403
1583
 
1404
 
    return width
 
1584
    # The width could not be determined.
 
1585
    return None
1405
1586
 
1406
1587
 
1407
1588
def _win32_terminal_size(width, height):
1434
1615
    _terminal_size = _ioctl_terminal_size
1435
1616
 
1436
1617
 
1437
 
def _terminal_size_changed(signum, frame):
1438
 
    """Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
1439
 
    width, height = _terminal_size(None, None)
1440
 
    if width is not None:
1441
 
        os.environ['COLUMNS'] = str(width)
1442
 
 
1443
 
if sys.platform == 'win32':
1444
 
    # Martin (gz) mentioned WINDOW_BUFFER_SIZE_RECORD from ReadConsoleInput but
1445
 
    # I've no idea how to plug that in the current design -- vila 20091216
1446
 
    pass
1447
 
else:
1448
 
    signal.signal(signal.SIGWINCH, _terminal_size_changed)
1449
 
 
1450
 
 
1451
1618
def supports_executable():
1452
1619
    return sys.platform != "win32"
1453
1620
 
1576
1743
        dirblock = []
1577
1744
        append = dirblock.append
1578
1745
        try:
1579
 
            names = sorted(_listdir(top))
 
1746
            names = sorted(map(decode_filename, _listdir(top)))
1580
1747
        except OSError, e:
1581
1748
            if not _is_error_enotdir(e):
1582
1749
                raise
1636
1803
    """
1637
1804
    global _selected_dir_reader
1638
1805
    if _selected_dir_reader is None:
1639
 
        fs_encoding = _fs_enc.upper()
1640
1806
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1641
1807
            # Win98 doesn't have unicode apis like FindFirstFileW
1642
1808
            # TODO: We possibly could support Win98 by falling back to the
1648
1814
                _selected_dir_reader = Win32ReadDir()
1649
1815
            except ImportError:
1650
1816
                pass
1651
 
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1652
 
            # ANSI_X3.4-1968 is a form of ASCII
 
1817
        elif _fs_enc in ('utf-8', 'ascii'):
1653
1818
            try:
1654
1819
                from bzrlib._readdir_pyx import UTF8DirReader
1655
1820
                _selected_dir_reader = UTF8DirReader()
1771
1936
            real_handlers[kind](abspath, relpath)
1772
1937
 
1773
1938
 
 
1939
def copy_ownership_from_path(dst, src=None):
 
1940
    """Copy usr/grp ownership from src file/dir to dst file/dir.
 
1941
 
 
1942
    If src is None, the containing directory is used as source. If chown
 
1943
    fails, the error is ignored and a warning is printed.
 
1944
    """
 
1945
    chown = getattr(os, 'chown', None)
 
1946
    if chown is None:
 
1947
        return
 
1948
 
 
1949
    if src == None:
 
1950
        src = os.path.dirname(dst)
 
1951
        if src == '':
 
1952
            src = '.'
 
1953
 
 
1954
    try:
 
1955
        s = os.stat(src)
 
1956
        chown(dst, s.st_uid, s.st_gid)
 
1957
    except OSError, e:
 
1958
        trace.warning(
 
1959
            'Unable to copy ownership from "%s" to "%s". '
 
1960
            'You may want to set it manually.', src, dst)
 
1961
        trace.log_exception_quietly()
 
1962
 
 
1963
 
1774
1964
def path_prefix_key(path):
1775
1965
    """Generate a prefix-order path key for path.
1776
1966
 
1862
2052
    return user_encoding
1863
2053
 
1864
2054
 
 
2055
def get_diff_header_encoding():
 
2056
    return get_terminal_encoding()
 
2057
 
 
2058
 
 
2059
_message_encoding = None
 
2060
 
 
2061
 
 
2062
def get_message_encoding():
 
2063
    """Return the encoding used for messages
 
2064
 
 
2065
    While the message encoding is a general setting it should usually only be
 
2066
    needed for decoding system error strings such as from OSError instances.
 
2067
    """
 
2068
    global _message_encoding
 
2069
    if _message_encoding is None:
 
2070
        if os.name == "posix":
 
2071
            import locale
 
2072
            # This is a process-global setting that can change, but should in
 
2073
            # general just get set once at process startup then be constant.
 
2074
            _message_encoding = locale.getlocale(locale.LC_MESSAGES)[1]
 
2075
        else:
 
2076
            # On windows want the result of GetACP() which this boils down to.
 
2077
            _message_encoding = get_user_encoding()
 
2078
    return _message_encoding or "ascii"
 
2079
        
 
2080
 
1865
2081
def get_host_name():
1866
2082
    """Return the current unicode host name.
1867
2083
 
1876
2092
        return socket.gethostname().decode(get_user_encoding())
1877
2093
 
1878
2094
 
1879
 
def recv_all(socket, bytes):
 
2095
# We must not read/write any more than 64k at a time from/to a socket so we
 
2096
# don't risk "no buffer space available" errors on some platforms.  Windows in
 
2097
# particular is likely to throw WSAECONNABORTED or WSAENOBUFS if given too much
 
2098
# data at once.
 
2099
MAX_SOCKET_CHUNK = 64 * 1024
 
2100
 
 
2101
_end_of_stream_errors = [errno.ECONNRESET]
 
2102
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
 
2103
    _eno = getattr(errno, _eno, None)
 
2104
    if _eno is not None:
 
2105
        _end_of_stream_errors.append(_eno)
 
2106
del _eno
 
2107
 
 
2108
 
 
2109
def read_bytes_from_socket(sock, report_activity=None,
 
2110
        max_read_size=MAX_SOCKET_CHUNK):
 
2111
    """Read up to max_read_size of bytes from sock and notify of progress.
 
2112
 
 
2113
    Translates "Connection reset by peer" into file-like EOF (return an
 
2114
    empty string rather than raise an error), and repeats the recv if
 
2115
    interrupted by a signal.
 
2116
    """
 
2117
    while 1:
 
2118
        try:
 
2119
            bytes = sock.recv(max_read_size)
 
2120
        except socket.error, e:
 
2121
            eno = e.args[0]
 
2122
            if eno in _end_of_stream_errors:
 
2123
                # The connection was closed by the other side.  Callers expect
 
2124
                # an empty string to signal end-of-stream.
 
2125
                return ""
 
2126
            elif eno == errno.EINTR:
 
2127
                # Retry the interrupted recv.
 
2128
                continue
 
2129
            raise
 
2130
        else:
 
2131
            if report_activity is not None:
 
2132
                report_activity(len(bytes), 'read')
 
2133
            return bytes
 
2134
 
 
2135
 
 
2136
def recv_all(socket, count):
1880
2137
    """Receive an exact number of bytes.
1881
2138
 
1882
2139
    Regular Socket.recv() may return less than the requested number of bytes,
1883
 
    dependning on what's in the OS buffer.  MSG_WAITALL is not available
 
2140
    depending on what's in the OS buffer.  MSG_WAITALL is not available
1884
2141
    on all platforms, but this should work everywhere.  This will return
1885
2142
    less than the requested amount if the remote end closes.
1886
2143
 
1887
2144
    This isn't optimized and is intended mostly for use in testing.
1888
2145
    """
1889
2146
    b = ''
1890
 
    while len(b) < bytes:
1891
 
        new = until_no_eintr(socket.recv, bytes - len(b))
 
2147
    while len(b) < count:
 
2148
        new = read_bytes_from_socket(socket, None, count - len(b))
1892
2149
        if new == '':
1893
2150
            break # eof
1894
2151
        b += new
1895
2152
    return b
1896
2153
 
1897
2154
 
1898
 
def send_all(socket, bytes, report_activity=None):
 
2155
def send_all(sock, bytes, report_activity=None):
1899
2156
    """Send all bytes on a socket.
1900
2157
 
1901
 
    Regular socket.sendall() can give socket error 10053 on Windows.  This
1902
 
    implementation sends no more than 64k at a time, which avoids this problem.
 
2158
    Breaks large blocks in smaller chunks to avoid buffering limitations on
 
2159
    some platforms, and catches EINTR which may be thrown if the send is
 
2160
    interrupted by a signal.
 
2161
 
 
2162
    This is preferred to socket.sendall(), because it avoids portability bugs
 
2163
    and provides activity reporting.
1903
2164
 
1904
2165
    :param report_activity: Call this as bytes are read, see
1905
2166
        Transport._report_activity
1906
2167
    """
1907
 
    chunk_size = 2**16
1908
 
    for pos in xrange(0, len(bytes), chunk_size):
1909
 
        block = bytes[pos:pos+chunk_size]
1910
 
        if report_activity is not None:
1911
 
            report_activity(len(block), 'write')
1912
 
        until_no_eintr(socket.sendall, block)
 
2168
    sent_total = 0
 
2169
    byte_count = len(bytes)
 
2170
    while sent_total < byte_count:
 
2171
        try:
 
2172
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
 
2173
        except socket.error, e:
 
2174
            if e.args[0] != errno.EINTR:
 
2175
                raise
 
2176
        else:
 
2177
            sent_total += sent
 
2178
            report_activity(sent, 'write')
 
2179
 
 
2180
 
 
2181
def connect_socket(address):
 
2182
    # Slight variation of the socket.create_connection() function (provided by
 
2183
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
 
2184
    # provide it for previous python versions. Also, we don't use the timeout
 
2185
    # parameter (provided by the python implementation) so we don't implement
 
2186
    # it either).
 
2187
    err = socket.error('getaddrinfo returns an empty list')
 
2188
    host, port = address
 
2189
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
 
2190
        af, socktype, proto, canonname, sa = res
 
2191
        sock = None
 
2192
        try:
 
2193
            sock = socket.socket(af, socktype, proto)
 
2194
            sock.connect(sa)
 
2195
            return sock
 
2196
 
 
2197
        except socket.error, err:
 
2198
            # 'err' is now the most recent error
 
2199
            if sock is not None:
 
2200
                sock.close()
 
2201
    raise err
1913
2202
 
1914
2203
 
1915
2204
def dereference_path(path):
1956
2245
    base = dirname(bzrlib.__file__)
1957
2246
    if getattr(sys, 'frozen', None):    # bzr.exe
1958
2247
        base = abspath(pathjoin(base, '..', '..'))
1959
 
    filename = pathjoin(base, resource_relpath)
1960
 
    return open(filename, 'rU').read()
1961
 
 
 
2248
    f = file(pathjoin(base, resource_relpath), "rU")
 
2249
    try:
 
2250
        return f.read()
 
2251
    finally:
 
2252
        f.close()
1962
2253
 
1963
2254
def file_kind_from_stat_mode_thunk(mode):
1964
2255
    global file_kind_from_stat_mode
1975
2266
    return file_kind_from_stat_mode(mode)
1976
2267
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
1977
2268
 
1978
 
 
1979
 
def file_kind(f, _lstat=os.lstat):
 
2269
def file_stat(f, _lstat=os.lstat):
1980
2270
    try:
1981
 
        return file_kind_from_stat_mode(_lstat(f).st_mode)
 
2271
        # XXX cache?
 
2272
        return _lstat(f)
1982
2273
    except OSError, e:
1983
2274
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
1984
2275
            raise errors.NoSuchFile(f)
1985
2276
        raise
1986
2277
 
 
2278
def file_kind(f, _lstat=os.lstat):
 
2279
    stat_value = file_stat(f, _lstat)
 
2280
    return file_kind_from_stat_mode(stat_value.st_mode)
1987
2281
 
1988
2282
def until_no_eintr(f, *a, **kw):
1989
 
    """Run f(*a, **kw), retrying if an EINTR error occurs."""
 
2283
    """Run f(*a, **kw), retrying if an EINTR error occurs.
 
2284
 
 
2285
    WARNING: you must be certain that it is safe to retry the call repeatedly
 
2286
    if EINTR does occur.  This is typically only true for low-level operations
 
2287
    like os.read.  If in any doubt, don't use this.
 
2288
 
 
2289
    Keep in mind that this is not a complete solution to EINTR.  There is
 
2290
    probably code in the Python standard library and other dependencies that
 
2291
    may encounter EINTR if a signal arrives (and there is signal handler for
 
2292
    that signal).  So this function can reduce the impact for IO that bzrlib
 
2293
    directly controls, but it is not a complete solution.
 
2294
    """
1990
2295
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
1991
2296
    while True:
1992
2297
        try:
1996
2301
                continue
1997
2302
            raise
1998
2303
 
 
2304
 
 
2305
@deprecated_function(deprecated_in((2, 2, 0)))
1999
2306
def re_compile_checked(re_string, flags=0, where=""):
2000
2307
    """Return a compiled re, or raise a sensible error.
2001
2308
 
2011
2318
        re_obj = re.compile(re_string, flags)
2012
2319
        re_obj.search("")
2013
2320
        return re_obj
2014
 
    except re.error, e:
 
2321
    except errors.InvalidPattern, e:
2015
2322
        if where:
2016
2323
            where = ' in ' + where
2017
2324
        # despite the name 'error' is a type
2018
 
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2019
 
            % (where, re_string, e))
 
2325
        raise errors.BzrCommandError('Invalid regular expression%s: %s'
 
2326
            % (where, e.msg))
2020
2327
 
2021
2328
 
2022
2329
if sys.platform == "win32":
2023
 
    import msvcrt
2024
2330
    def getchar():
 
2331
        import msvcrt
2025
2332
        return msvcrt.getch()
2026
2333
else:
2027
 
    import tty
2028
 
    import termios
2029
2334
    def getchar():
 
2335
        import tty
 
2336
        import termios
2030
2337
        fd = sys.stdin.fileno()
2031
2338
        settings = termios.tcgetattr(fd)
2032
2339
        try:
2036
2343
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2037
2344
        return ch
2038
2345
 
2039
 
 
2040
 
if sys.platform == 'linux2':
 
2346
if sys.platform.startswith('linux'):
2041
2347
    def _local_concurrency():
2042
 
        concurrency = None
2043
 
        prefix = 'processor'
2044
 
        for line in file('/proc/cpuinfo', 'rb'):
2045
 
            if line.startswith(prefix):
2046
 
                concurrency = int(line[line.find(':')+1:]) + 1
2047
 
        return concurrency
 
2348
        try:
 
2349
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2350
        except (ValueError, OSError, AttributeError):
 
2351
            return None
2048
2352
elif sys.platform == 'darwin':
2049
2353
    def _local_concurrency():
2050
2354
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2051
2355
                                stdout=subprocess.PIPE).communicate()[0]
2052
 
elif sys.platform[0:7] == 'freebsd':
 
2356
elif "bsd" in sys.platform:
2053
2357
    def _local_concurrency():
2054
2358
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2055
2359
                                stdout=subprocess.PIPE).communicate()[0]
2083
2387
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2084
2388
    if concurrency is None:
2085
2389
        try:
2086
 
            concurrency = _local_concurrency()
2087
 
        except (OSError, IOError):
2088
 
            pass
 
2390
            import multiprocessing
 
2391
            concurrency = multiprocessing.cpu_count()
 
2392
        except (ImportError, NotImplementedError):
 
2393
            # multiprocessing is only available on Python >= 2.6
 
2394
            # and multiprocessing.cpu_count() isn't implemented on all
 
2395
            # platforms
 
2396
            try:
 
2397
                concurrency = _local_concurrency()
 
2398
            except (OSError, IOError):
 
2399
                pass
2089
2400
    try:
2090
2401
        concurrency = int(concurrency)
2091
2402
    except (TypeError, ValueError):
2108
2419
        else:
2109
2420
            data, _ = self.encode(object, self.errors)
2110
2421
            self.stream.write(data)
 
2422
 
 
2423
if sys.platform == 'win32':
 
2424
    def open_file(filename, mode='r', bufsize=-1):
 
2425
        """This function is used to override the ``open`` builtin.
 
2426
 
 
2427
        But it uses O_NOINHERIT flag so the file handle is not inherited by
 
2428
        child processes.  Deleting or renaming a closed file opened with this
 
2429
        function is not blocking child processes.
 
2430
        """
 
2431
        writing = 'w' in mode
 
2432
        appending = 'a' in mode
 
2433
        updating = '+' in mode
 
2434
        binary = 'b' in mode
 
2435
 
 
2436
        flags = O_NOINHERIT
 
2437
        # see http://msdn.microsoft.com/en-us/library/yeby3zcb%28VS.71%29.aspx
 
2438
        # for flags for each modes.
 
2439
        if binary:
 
2440
            flags |= O_BINARY
 
2441
        else:
 
2442
            flags |= O_TEXT
 
2443
 
 
2444
        if writing:
 
2445
            if updating:
 
2446
                flags |= os.O_RDWR
 
2447
            else:
 
2448
                flags |= os.O_WRONLY
 
2449
            flags |= os.O_CREAT | os.O_TRUNC
 
2450
        elif appending:
 
2451
            if updating:
 
2452
                flags |= os.O_RDWR
 
2453
            else:
 
2454
                flags |= os.O_WRONLY
 
2455
            flags |= os.O_CREAT | os.O_APPEND
 
2456
        else: #reading
 
2457
            if updating:
 
2458
                flags |= os.O_RDWR
 
2459
            else:
 
2460
                flags |= os.O_RDONLY
 
2461
 
 
2462
        return os.fdopen(os.open(filename, flags), mode, bufsize)
 
2463
else:
 
2464
    open_file = open
 
2465
 
 
2466
 
 
2467
def available_backup_name(base, exists):
 
2468
    """Find a non-existing backup file name.
 
2469
 
 
2470
    This will *not* create anything, this only return a 'free' entry.  This
 
2471
    should be used for checking names in a directory below a locked
 
2472
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
 
2473
    Leap) and generally discouraged.
 
2474
 
 
2475
    :param base: The base name.
 
2476
 
 
2477
    :param exists: A callable returning True if the path parameter exists.
 
2478
    """
 
2479
    counter = 1
 
2480
    name = "%s.~%d~" % (base, counter)
 
2481
    while exists(name):
 
2482
        counter += 1
 
2483
        name = "%s.~%d~" % (base, counter)
 
2484
    return name
 
2485
 
 
2486
 
 
2487
def set_fd_cloexec(fd):
 
2488
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
 
2489
    support for this is not available.
 
2490
    """
 
2491
    try:
 
2492
        import fcntl
 
2493
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
 
2494
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
 
2495
    except (ImportError, AttributeError):
 
2496
        # Either the fcntl module or specific constants are not present
 
2497
        pass
 
2498
 
 
2499
 
 
2500
def find_executable_on_path(name):
 
2501
    """Finds an executable on the PATH.
 
2502
    
 
2503
    On Windows, this will try to append each extension in the PATHEXT
 
2504
    environment variable to the name, if it cannot be found with the name
 
2505
    as given.
 
2506
    
 
2507
    :param name: The base name of the executable.
 
2508
    :return: The path to the executable found or None.
 
2509
    """
 
2510
    path = os.environ.get('PATH')
 
2511
    if path is None:
 
2512
        return None
 
2513
    path = path.split(os.pathsep)
 
2514
    if sys.platform == 'win32':
 
2515
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
 
2516
        exts = [ext.lower() for ext in exts]
 
2517
        base, ext = os.path.splitext(name)
 
2518
        if ext != '':
 
2519
            if ext.lower() not in exts:
 
2520
                return None
 
2521
            name = base
 
2522
            exts = [ext]
 
2523
    else:
 
2524
        exts = ['']
 
2525
    for ext in exts:
 
2526
        for d in path:
 
2527
            f = os.path.join(d, name) + ext
 
2528
            if os.access(f, os.X_OK):
 
2529
                return f
 
2530
    return None
 
2531
 
 
2532
 
 
2533
def _posix_is_local_pid_dead(pid):
 
2534
    """True if pid doesn't correspond to live process on this machine"""
 
2535
    try:
 
2536
        # Special meaning of unix kill: just check if it's there.
 
2537
        os.kill(pid, 0)
 
2538
    except OSError, e:
 
2539
        if e.errno == errno.ESRCH:
 
2540
            # On this machine, and really not found: as sure as we can be
 
2541
            # that it's dead.
 
2542
            return True
 
2543
        elif e.errno == errno.EPERM:
 
2544
            # exists, though not ours
 
2545
            return False
 
2546
        else:
 
2547
            mutter("os.kill(%d, 0) failed: %s" % (pid, e))
 
2548
            # Don't really know.
 
2549
            return False
 
2550
    else:
 
2551
        # Exists and our process: not dead.
 
2552
        return False
 
2553
 
 
2554
if sys.platform == "win32":
 
2555
    is_local_pid_dead = win32utils.is_local_pid_dead
 
2556
else:
 
2557
    is_local_pid_dead = _posix_is_local_pid_dead
 
2558
 
 
2559
 
 
2560
def fdatasync(fileno):
 
2561
    """Flush file contents to disk if possible.
 
2562
    
 
2563
    :param fileno: Integer OS file handle.
 
2564
    :raises TransportNotPossible: If flushing to disk is not possible.
 
2565
    """
 
2566
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
 
2567
    if fn is not None:
 
2568
        fn(fileno)
 
2569
 
 
2570
 
 
2571
def ensure_empty_directory_exists(path, exception_class):
 
2572
    """Make sure a local directory exists and is empty.
 
2573
    
 
2574
    If it does not exist, it is created.  If it exists and is not empty, an
 
2575
    instance of exception_class is raised.
 
2576
    """
 
2577
    try:
 
2578
        os.mkdir(path)
 
2579
    except OSError, e:
 
2580
        if e.errno != errno.EEXIST:
 
2581
            raise
 
2582
        if os.listdir(path) != []:
 
2583
            raise exception_class(path)
 
2584
 
 
2585
 
 
2586
def is_environment_error(evalue):
 
2587
    """True if exception instance is due to a process environment issue
 
2588
 
 
2589
    This includes OSError and IOError, but also other errors that come from
 
2590
    the operating system or core libraries but are not subclasses of those.
 
2591
    """
 
2592
    if isinstance(evalue, (EnvironmentError, select.error)):
 
2593
        return True
 
2594
    if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
 
2595
        return True
 
2596
    return False