~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Aaron Bentley
  • Date: 2012-07-19 15:44:55 UTC
  • mto: This revision was merged to the branch mainline in revision 6540.
  • Revision ID: aaron@aaronbentley.com-20120719154455-j7y8fm7o9y95vo38
Eliminate get_stored_uncommitted from API.

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
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_get_home_dir():
 
346
    """Get the home directory of the current user as a unicode path"""
 
347
    path = posixpath.expanduser("~")
 
348
    try:
 
349
        return path.decode(_fs_enc)
 
350
    except UnicodeDecodeError:
 
351
        raise errors.BadFilenameEncoding(path, _fs_enc)
 
352
 
 
353
 
 
354
def _posix_getuser_unicode():
 
355
    """Get username from environment or password database as unicode"""
 
356
    name = getpass.getuser()
 
357
    user_encoding = get_user_encoding()
 
358
    try:
 
359
        return name.decode(user_encoding)
 
360
    except UnicodeDecodeError:
 
361
        raise errors.BzrError("Encoding of username %r is unsupported by %s "
 
362
            "application locale." % (name, user_encoding))
 
363
 
 
364
 
297
365
def _win32_fixdrive(path):
298
366
    """Force drive letters to be consistent.
299
367
 
303
371
    running python.exe under cmd.exe return capital C:\\
304
372
    running win32 python inside a cygwin shell returns lowercase c:\\
305
373
    """
306
 
    drive, path = _nt_splitdrive(path)
 
374
    drive, path = ntpath.splitdrive(path)
307
375
    return drive.upper() + path
308
376
 
309
377
 
310
378
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('\\', '/'))
 
379
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
 
380
    return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
313
381
 
314
382
 
315
383
def _win98_abspath(path):
326
394
    #   /path       => C:/path
327
395
    path = unicode(path)
328
396
    # check for absolute path
329
 
    drive = _nt_splitdrive(path)[0]
 
397
    drive = ntpath.splitdrive(path)[0]
330
398
    if drive == '' and path[:2] not in('//','\\\\'):
331
399
        cwd = os.getcwdu()
332
400
        # we cannot simply os.path.join cwd and path
333
401
        # because os.path.join('C:','/path') produce '/path'
334
402
        # and this is incorrect
335
403
        if path[:1] in ('/','\\'):
336
 
            cwd = _nt_splitdrive(cwd)[0]
 
404
            cwd = ntpath.splitdrive(cwd)[0]
337
405
            path = path[1:]
338
406
        path = cwd + '\\' + path
339
 
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
 
407
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
340
408
 
341
409
 
342
410
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('\\', '/'))
 
411
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
 
412
    return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
345
413
 
346
414
 
347
415
def _win32_pathjoin(*args):
348
 
    return _nt_join(*args).replace('\\', '/')
 
416
    return ntpath.join(*args).replace('\\', '/')
349
417
 
350
418
 
351
419
def _win32_normpath(path):
352
 
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
420
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
353
421
 
354
422
 
355
423
def _win32_getcwd():
360
428
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
361
429
 
362
430
 
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
431
def _win32_rename(old, new):
372
432
    """We expect to be able to atomically replace 'new' with old.
373
433
 
375
435
    and then deleted.
376
436
    """
377
437
    try:
378
 
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
 
438
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
379
439
    except OSError, e:
380
440
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
381
441
            # If we try to rename a non-existant file onto cwd, we get
386
446
        raise
387
447
 
388
448
 
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
449
def _mac_getcwd():
400
450
    return unicodedata.normalize('NFC', os.getcwdu())
401
451
 
402
452
 
 
453
def _rename_wrap_exception(rename_func):
 
454
    """Adds extra information to any exceptions that come from rename().
 
455
 
 
456
    The exception has an updated message and 'old_filename' and 'new_filename'
 
457
    attributes.
 
458
    """
 
459
 
 
460
    def _rename_wrapper(old, new):
 
461
        try:
 
462
            rename_func(old, new)
 
463
        except OSError, e:
 
464
            detailed_error = OSError(e.errno, e.strerror +
 
465
                                " [occurred when renaming '%s' to '%s']" %
 
466
                                (old, new))
 
467
            detailed_error.old_filename = old
 
468
            detailed_error.new_filename = new
 
469
            raise detailed_error
 
470
 
 
471
    return _rename_wrapper
 
472
 
 
473
# Default rename wraps os.rename()
 
474
rename = _rename_wrap_exception(os.rename)
 
475
 
403
476
# Default is to just use the python builtins, but these can be rebound on
404
477
# particular platforms.
405
478
abspath = _posix_abspath
406
479
realpath = _posix_realpath
407
480
pathjoin = os.path.join
408
 
normpath = os.path.normpath
409
 
rename = _wrapped_rename # overridden below on win32
 
481
normpath = _posix_normpath
 
482
path_from_environ = _posix_path_from_environ
 
483
_get_home_dir = _posix_get_home_dir
 
484
getuser_unicode = _posix_getuser_unicode
410
485
getcwd = os.getcwdu
411
486
dirname = os.path.dirname
412
487
basename = os.path.basename
413
488
split = os.path.split
414
489
splitext = os.path.splitext
415
 
# These were already imported into local scope
 
490
# These were already lazily imported into local scope
416
491
# mkdtemp = tempfile.mkdtemp
417
492
# rmtree = shutil.rmtree
 
493
lstat = os.lstat
 
494
fstat = os.fstat
 
495
 
 
496
def wrap_stat(st):
 
497
    return st
 
498
 
418
499
 
419
500
MIN_ABS_PATHLENGTH = 1
420
501
 
429
510
    normpath = _win32_normpath
430
511
    getcwd = _win32_getcwd
431
512
    mkdtemp = _win32_mkdtemp
432
 
    rename = _win32_rename
 
513
    rename = _rename_wrap_exception(_win32_rename)
 
514
    try:
 
515
        from bzrlib import _walkdirs_win32
 
516
    except ImportError:
 
517
        pass
 
518
    else:
 
519
        lstat = _walkdirs_win32.lstat
 
520
        fstat = _walkdirs_win32.fstat
 
521
        wrap_stat = _walkdirs_win32.wrap_stat
433
522
 
434
523
    MIN_ABS_PATHLENGTH = 3
435
524
 
453
542
    f = win32utils.get_unicode_argv     # special function or None
454
543
    if f is not None:
455
544
        get_unicode_argv = f
 
545
    path_from_environ = win32utils.get_environ_unicode
 
546
    _get_home_dir = win32utils.get_home_location
 
547
    getuser_unicode = win32utils.get_user_name
456
548
 
457
549
elif sys.platform == 'darwin':
458
550
    getcwd = _mac_getcwd
459
551
 
460
552
 
461
 
def get_terminal_encoding():
 
553
def get_terminal_encoding(trace=False):
462
554
    """Find the best encoding for printing to the screen.
463
555
 
464
556
    This attempts to check both sys.stdout and sys.stdin to see
470
562
 
471
563
    On my standard US Windows XP, the preferred encoding is
472
564
    cp1252, but the console is cp437
 
565
 
 
566
    :param trace: If True trace the selected encoding via mutter().
473
567
    """
474
568
    from bzrlib.trace import mutter
475
569
    output_encoding = getattr(sys.stdout, 'encoding', None)
477
571
        input_encoding = getattr(sys.stdin, 'encoding', None)
478
572
        if not input_encoding:
479
573
            output_encoding = get_user_encoding()
480
 
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
574
            if trace:
 
575
                mutter('encoding stdout as osutils.get_user_encoding() %r',
481
576
                   output_encoding)
482
577
        else:
483
578
            output_encoding = input_encoding
484
 
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
579
            if trace:
 
580
                mutter('encoding stdout as sys.stdin encoding %r',
 
581
                    output_encoding)
485
582
    else:
486
 
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
583
        if trace:
 
584
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
487
585
    if output_encoding == 'cp0':
488
586
        # invalid encoding (cp0 means 'no codepage' on Windows)
489
587
        output_encoding = get_user_encoding()
490
 
        mutter('cp0 is invalid encoding.'
 
588
        if trace:
 
589
            mutter('cp0 is invalid encoding.'
491
590
               ' encoding stdout as osutils.get_user_encoding() %r',
492
591
               output_encoding)
493
592
    # check encoding
519
618
def isdir(f):
520
619
    """True if f is an accessible directory."""
521
620
    try:
522
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
621
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
523
622
    except OSError:
524
623
        return False
525
624
 
527
626
def isfile(f):
528
627
    """True if f is a regular file."""
529
628
    try:
530
 
        return S_ISREG(os.lstat(f)[ST_MODE])
 
629
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
531
630
    except OSError:
532
631
        return False
533
632
 
534
633
def islink(f):
535
634
    """True if f is a symlink."""
536
635
    try:
537
 
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
636
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
538
637
    except OSError:
539
638
        return False
540
639
 
880
979
 
881
980
def filesize(f):
882
981
    """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
 
982
    return os.fstat(f.fileno())[stat.ST_SIZE]
 
983
 
 
984
 
 
985
# Alias os.urandom to support platforms (which?) without /dev/urandom and 
 
986
# override if it doesn't work. Avoid checking on windows where there is
 
987
# significant initialisation cost that can be avoided for some bzr calls.
 
988
 
 
989
rand_bytes = os.urandom
 
990
 
 
991
if rand_bytes.__module__ != "nt":
895
992
    try:
896
 
        rand_bytes = file('/dev/urandom', 'rb').read
897
 
    # Otherwise, use this hack as a last resort
898
 
    except (IOError, OSError):
 
993
        rand_bytes(1)
 
994
    except NotImplementedError:
899
995
        # not well seeded, but better than nothing
900
996
        def rand_bytes(n):
901
997
            import random
931
1027
    rps = []
932
1028
    for f in ps:
933
1029
        if f == '..':
934
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1030
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
935
1031
        elif (f == '.') or (f == ''):
936
1032
            pass
937
1033
        else:
942
1038
def joinpath(p):
943
1039
    for f in p:
944
1040
        if (f == '..') or (f is None) or (f == ''):
945
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1041
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
946
1042
    return pathjoin(*p)
947
1043
 
948
1044
 
949
1045
def parent_directories(filename):
950
1046
    """Return the list of parent directories, deepest first.
951
 
    
 
1047
 
952
1048
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
953
1049
    """
954
1050
    parents = []
978
1074
    # NB: This docstring is just an example, not a doctest, because doctest
979
1075
    # currently can't cope with the use of lazy imports in this namespace --
980
1076
    # mbp 20090729
981
 
    
 
1077
 
982
1078
    # This currently doesn't report the failure at the time it occurs, because
983
1079
    # they tend to happen very early in startup when we can't check config
984
1080
    # files etc, and also we want to report all failures but not spam the user
985
1081
    # with 10 warnings.
986
 
    from bzrlib import trace
987
1082
    exception_str = str(exception)
988
1083
    if exception_str not in _extension_load_failures:
989
1084
        trace.mutter("failed to load compiled extension: %s" % exception_str)
993
1088
def report_extension_load_failures():
994
1089
    if not _extension_load_failures:
995
1090
        return
996
 
    from bzrlib.config import GlobalConfig
997
 
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
 
1091
    if config.GlobalStack().get('ignore_missing_extensions'):
998
1092
        return
999
1093
    # the warnings framework should by default show this only once
1000
1094
    from bzrlib.trace import warning
1054
1148
 
1055
1149
 
1056
1150
def delete_any(path):
1057
 
    """Delete a file, symlink or directory.  
1058
 
    
 
1151
    """Delete a file, symlink or directory.
 
1152
 
1059
1153
    Will delete even if readonly.
1060
1154
    """
1061
1155
    try:
1162
1256
 
1163
1257
    if len(base) < MIN_ABS_PATHLENGTH:
1164
1258
        # must have space for e.g. a drive letter
1165
 
        raise ValueError('%r is too short to calculate a relative path'
 
1259
        raise ValueError(gettext('%r is too short to calculate a relative path')
1166
1260
            % (base,))
1167
1261
 
1168
1262
    rp = abspath(path)
1250
1344
    # but for now, we haven't optimized...
1251
1345
    return [canonical_relpath(base, p) for p in paths]
1252
1346
 
 
1347
 
 
1348
def decode_filename(filename):
 
1349
    """Decode the filename using the filesystem encoding
 
1350
 
 
1351
    If it is unicode, it is returned.
 
1352
    Otherwise it is decoded from the the filesystem's encoding. If decoding
 
1353
    fails, a errors.BadFilenameEncoding exception is raised.
 
1354
    """
 
1355
    if type(filename) is unicode:
 
1356
        return filename
 
1357
    try:
 
1358
        return filename.decode(_fs_enc)
 
1359
    except UnicodeDecodeError:
 
1360
        raise errors.BadFilenameEncoding(filename, _fs_enc)
 
1361
 
 
1362
 
1253
1363
def safe_unicode(unicode_or_utf8_string):
1254
1364
    """Coerce unicode_or_utf8_string into unicode.
1255
1365
 
1338
1448
def normalizes_filenames():
1339
1449
    """Return True if this platform normalizes unicode filenames.
1340
1450
 
1341
 
    Mac OSX does, Windows/Linux do not.
 
1451
    Only Mac OSX.
1342
1452
    """
1343
1453
    return _platform_normalizes_filenames
1344
1454
 
1349
1459
    On platforms where the system normalizes filenames (Mac OSX),
1350
1460
    you can access a file by any path which will normalize correctly.
1351
1461
    On platforms where the system does not normalize filenames
1352
 
    (Windows, Linux), you have to access a file by its exact path.
 
1462
    (everything else), you have to access a file by its exact path.
1353
1463
 
1354
1464
    Internally, bzr only supports NFC normalization, since that is
1355
1465
    the standard for XML documents.
1417
1527
terminal_width() returns None.
1418
1528
"""
1419
1529
 
 
1530
# Keep some state so that terminal_width can detect if _terminal_size has
 
1531
# returned a different size since the process started.  See docstring and
 
1532
# comments of terminal_width for details.
 
1533
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
 
1534
_terminal_size_state = 'no_data'
 
1535
_first_terminal_size = None
1420
1536
 
1421
1537
def terminal_width():
1422
1538
    """Return terminal width.
1426
1542
    The rules are:
1427
1543
    - if BZR_COLUMNS is set, returns its value
1428
1544
    - if there is no controlling terminal, returns None
 
1545
    - query the OS, if the queried size has changed since the last query,
 
1546
      return its value,
1429
1547
    - if COLUMNS is set, returns its value,
 
1548
    - if the OS has a value (even though it's never changed), return its value.
1430
1549
 
1431
1550
    From there, we need to query the OS to get the size of the controlling
1432
1551
    terminal.
1433
1552
 
1434
 
    Unices:
 
1553
    On Unices we query the OS by:
1435
1554
    - get termios.TIOCGWINSZ
1436
1555
    - if an error occurs or a negative value is obtained, returns None
1437
1556
 
1438
 
    Windows:
1439
 
    
 
1557
    On Windows we query the OS by:
1440
1558
    - win32utils.get_console_size() decides,
1441
1559
    - returns None on error (provided default value)
1442
1560
    """
 
1561
    # Note to implementors: if changing the rules for determining the width,
 
1562
    # make sure you've considered the behaviour in these cases:
 
1563
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
 
1564
    #  - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
 
1565
    #    0,0.
 
1566
    #  - (add more interesting cases here, if you find any)
 
1567
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
 
1568
    # but we don't want to register a signal handler because it is impossible
 
1569
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
 
1570
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
 
1571
    # time so we can notice if the reported size has changed, which should have
 
1572
    # a similar effect.
1443
1573
 
1444
1574
    # If BZR_COLUMNS is set, take it, user is always right
 
1575
    # Except if they specified 0 in which case, impose no limit here
1445
1576
    try:
1446
 
        return int(os.environ['BZR_COLUMNS'])
 
1577
        width = int(os.environ['BZR_COLUMNS'])
1447
1578
    except (KeyError, ValueError):
1448
 
        pass
 
1579
        width = None
 
1580
    if width is not None:
 
1581
        if width > 0:
 
1582
            return width
 
1583
        else:
 
1584
            return None
1449
1585
 
1450
1586
    isatty = getattr(sys.stdout, 'isatty', None)
1451
 
    if  isatty is None or not isatty():
 
1587
    if isatty is None or not isatty():
1452
1588
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1453
1589
        return None
1454
1590
 
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))
 
1591
    # Query the OS
 
1592
    width, height = os_size = _terminal_size(None, None)
 
1593
    global _first_terminal_size, _terminal_size_state
 
1594
    if _terminal_size_state == 'no_data':
 
1595
        _first_terminal_size = os_size
 
1596
        _terminal_size_state = 'unchanged'
 
1597
    elif (_terminal_size_state == 'unchanged' and
 
1598
          _first_terminal_size != os_size):
 
1599
        _terminal_size_state = 'changed'
 
1600
 
 
1601
    # If the OS claims to know how wide the terminal is, and this value has
 
1602
    # ever changed, use that.
 
1603
    if _terminal_size_state == 'changed':
 
1604
        if width is not None and width > 0:
 
1605
            return width
 
1606
 
 
1607
    # If COLUMNS is set, use it.
1458
1608
    try:
1459
1609
        return int(os.environ['COLUMNS'])
1460
1610
    except (KeyError, ValueError):
1461
1611
        pass
1462
1612
 
1463
 
    width, height = _terminal_size(None, None)
1464
 
    if width <= 0:
1465
 
        # Consider invalid values as meaning no width
1466
 
        return None
 
1613
    # Finally, use an unchanged size from the OS, if we have one.
 
1614
    if _terminal_size_state == 'unchanged':
 
1615
        if width is not None and width > 0:
 
1616
            return width
1467
1617
 
1468
 
    return width
 
1618
    # The width could not be determined.
 
1619
    return None
1469
1620
 
1470
1621
 
1471
1622
def _win32_terminal_size(width, height):
1498
1649
    _terminal_size = _ioctl_terminal_size
1499
1650
 
1500
1651
 
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
1652
def supports_executable():
1527
1653
    return sys.platform != "win32"
1528
1654
 
1651
1777
        dirblock = []
1652
1778
        append = dirblock.append
1653
1779
        try:
1654
 
            names = sorted(_listdir(top))
 
1780
            names = sorted(map(decode_filename, _listdir(top)))
1655
1781
        except OSError, e:
1656
1782
            if not _is_error_enotdir(e):
1657
1783
                raise
1711
1837
    """
1712
1838
    global _selected_dir_reader
1713
1839
    if _selected_dir_reader is None:
1714
 
        fs_encoding = _fs_enc.upper()
1715
1840
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1716
1841
            # Win98 doesn't have unicode apis like FindFirstFileW
1717
1842
            # TODO: We possibly could support Win98 by falling back to the
1723
1848
                _selected_dir_reader = Win32ReadDir()
1724
1849
            except ImportError:
1725
1850
                pass
1726
 
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1727
 
            # ANSI_X3.4-1968 is a form of ASCII
 
1851
        elif _fs_enc in ('utf-8', 'ascii'):
1728
1852
            try:
1729
1853
                from bzrlib._readdir_pyx import UTF8DirReader
1730
1854
                _selected_dir_reader = UTF8DirReader()
1865
1989
        s = os.stat(src)
1866
1990
        chown(dst, s.st_uid, s.st_gid)
1867
1991
    except OSError, e:
1868
 
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
 
1992
        trace.warning(
 
1993
            'Unable to copy ownership from "%s" to "%s". '
 
1994
            'You may want to set it manually.', src, dst)
 
1995
        trace.log_exception_quietly()
1869
1996
 
1870
1997
 
1871
1998
def path_prefix_key(path):
1886
2013
_cached_user_encoding = None
1887
2014
 
1888
2015
 
1889
 
def get_user_encoding(use_cache=True):
 
2016
def get_user_encoding(use_cache=DEPRECATED_PARAMETER):
1890
2017
    """Find out what the preferred user encoding is.
1891
2018
 
1892
2019
    This is generally the encoding that is used for command line parameters
1893
2020
    and file contents. This may be different from the terminal encoding
1894
2021
    or the filesystem encoding.
1895
2022
 
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
2023
    :return: A string defining the preferred user encoding
1901
2024
    """
1902
2025
    global _cached_user_encoding
1903
 
    if _cached_user_encoding is not None and use_cache:
 
2026
    if deprecated_passed(use_cache):
 
2027
        warn_deprecated("use_cache should only have been used for tests",
 
2028
            DeprecationWarning, stacklevel=2) 
 
2029
    if _cached_user_encoding is not None:
1904
2030
        return _cached_user_encoding
1905
2031
 
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'
 
2032
    if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
 
2033
        # Use the existing locale settings and call nl_langinfo directly
 
2034
        # rather than going through getpreferredencoding. This avoids
 
2035
        # <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
 
2036
        # possibility of the setlocale call throwing an error.
 
2037
        user_encoding = locale.nl_langinfo(locale.CODESET)
1923
2038
    else:
1924
 
        import locale
 
2039
        # GZ 2011-12-19: On windows could call GetACP directly instead.
 
2040
        user_encoding = locale.getpreferredencoding(False)
1925
2041
 
1926
2042
    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:
 
2043
        user_encoding = codecs.lookup(user_encoding).name
 
2044
    except LookupError:
 
2045
        if user_encoding not in ("", "cp0"):
1949
2046
            sys.stderr.write('bzr: warning:'
1950
2047
                             ' unknown encoding %s.'
1951
2048
                             ' Continuing with ascii encoding.\n'
1952
2049
                             % user_encoding
1953
2050
                            )
1954
 
            user_encoding = 'ascii'
1955
 
 
1956
 
    if use_cache:
1957
 
        _cached_user_encoding = user_encoding
1958
 
 
 
2051
        user_encoding = 'ascii'
 
2052
    else:
 
2053
        # Get 'ascii' when setlocale has not been called or LANG=C or unset.
 
2054
        if user_encoding == 'ascii':
 
2055
            if sys.platform == 'darwin':
 
2056
                # OSX is special-cased in Python to have a UTF-8 filesystem
 
2057
                # encoding and previously had LANG set here if not present.
 
2058
                user_encoding = 'utf-8'
 
2059
            # GZ 2011-12-19: Maybe UTF-8 should be the default in this case
 
2060
            #                for some other posix platforms as well.
 
2061
 
 
2062
    _cached_user_encoding = user_encoding
1959
2063
    return user_encoding
1960
2064
 
1961
2065
 
 
2066
def get_diff_header_encoding():
 
2067
    return get_terminal_encoding()
 
2068
 
 
2069
 
1962
2070
def get_host_name():
1963
2071
    """Return the current unicode host name.
1964
2072
 
1966
2074
    behaves inconsistently on different platforms.
1967
2075
    """
1968
2076
    if sys.platform == "win32":
1969
 
        import win32utils
1970
2077
        return win32utils.get_host_name()
1971
2078
    else:
1972
2079
        import socket
1979
2086
# data at once.
1980
2087
MAX_SOCKET_CHUNK = 64 * 1024
1981
2088
 
 
2089
_end_of_stream_errors = [errno.ECONNRESET]
 
2090
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
 
2091
    _eno = getattr(errno, _eno, None)
 
2092
    if _eno is not None:
 
2093
        _end_of_stream_errors.append(_eno)
 
2094
del _eno
 
2095
 
 
2096
 
1982
2097
def read_bytes_from_socket(sock, report_activity=None,
1983
2098
        max_read_size=MAX_SOCKET_CHUNK):
1984
2099
    """Read up to max_read_size of bytes from sock and notify of progress.
1992
2107
            bytes = sock.recv(max_read_size)
1993
2108
        except socket.error, e:
1994
2109
            eno = e.args[0]
1995
 
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
 
2110
            if eno in _end_of_stream_errors:
1996
2111
                # The connection was closed by the other side.  Callers expect
1997
2112
                # an empty string to signal end-of-stream.
1998
2113
                return ""
2027
2142
 
2028
2143
def send_all(sock, bytes, report_activity=None):
2029
2144
    """Send all bytes on a socket.
2030
 
 
 
2145
 
2031
2146
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2032
2147
    some platforms, and catches EINTR which may be thrown if the send is
2033
2148
    interrupted by a signal.
2034
2149
 
2035
2150
    This is preferred to socket.sendall(), because it avoids portability bugs
2036
2151
    and provides activity reporting.
2037
 
 
 
2152
 
2038
2153
    :param report_activity: Call this as bytes are read, see
2039
2154
        Transport._report_activity
2040
2155
    """
2051
2166
            report_activity(sent, 'write')
2052
2167
 
2053
2168
 
 
2169
def connect_socket(address):
 
2170
    # Slight variation of the socket.create_connection() function (provided by
 
2171
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
 
2172
    # provide it for previous python versions. Also, we don't use the timeout
 
2173
    # parameter (provided by the python implementation) so we don't implement
 
2174
    # it either).
 
2175
    err = socket.error('getaddrinfo returns an empty list')
 
2176
    host, port = address
 
2177
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
 
2178
        af, socktype, proto, canonname, sa = res
 
2179
        sock = None
 
2180
        try:
 
2181
            sock = socket.socket(af, socktype, proto)
 
2182
            sock.connect(sa)
 
2183
            return sock
 
2184
 
 
2185
        except socket.error, err:
 
2186
            # 'err' is now the most recent error
 
2187
            if sock is not None:
 
2188
                sock.close()
 
2189
    raise err
 
2190
 
 
2191
 
2054
2192
def dereference_path(path):
2055
2193
    """Determine the real path to a file.
2056
2194
 
2095
2233
    base = dirname(bzrlib.__file__)
2096
2234
    if getattr(sys, 'frozen', None):    # bzr.exe
2097
2235
        base = abspath(pathjoin(base, '..', '..'))
2098
 
    filename = pathjoin(base, resource_relpath)
2099
 
    return open(filename, 'rU').read()
2100
 
 
 
2236
    f = file(pathjoin(base, resource_relpath), "rU")
 
2237
    try:
 
2238
        return f.read()
 
2239
    finally:
 
2240
        f.close()
2101
2241
 
2102
2242
def file_kind_from_stat_mode_thunk(mode):
2103
2243
    global file_kind_from_stat_mode
2114
2254
    return file_kind_from_stat_mode(mode)
2115
2255
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2116
2256
 
2117
 
 
2118
 
def file_kind(f, _lstat=os.lstat):
 
2257
def file_stat(f, _lstat=os.lstat):
2119
2258
    try:
2120
 
        return file_kind_from_stat_mode(_lstat(f).st_mode)
 
2259
        # XXX cache?
 
2260
        return _lstat(f)
2121
2261
    except OSError, e:
2122
2262
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2123
2263
            raise errors.NoSuchFile(f)
2124
2264
        raise
2125
2265
 
 
2266
def file_kind(f, _lstat=os.lstat):
 
2267
    stat_value = file_stat(f, _lstat)
 
2268
    return file_kind_from_stat_mode(stat_value.st_mode)
2126
2269
 
2127
2270
def until_no_eintr(f, *a, **kw):
2128
2271
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2129
 
    
 
2272
 
2130
2273
    WARNING: you must be certain that it is safe to retry the call repeatedly
2131
2274
    if EINTR does occur.  This is typically only true for low-level operations
2132
2275
    like os.read.  If in any doubt, don't use this.
2147
2290
            raise
2148
2291
 
2149
2292
 
 
2293
@deprecated_function(deprecated_in((2, 2, 0)))
2150
2294
def re_compile_checked(re_string, flags=0, where=""):
2151
2295
    """Return a compiled re, or raise a sensible error.
2152
2296
 
2162
2306
        re_obj = re.compile(re_string, flags)
2163
2307
        re_obj.search("")
2164
2308
        return re_obj
2165
 
    except re.error, e:
 
2309
    except errors.InvalidPattern, e:
2166
2310
        if where:
2167
2311
            where = ' in ' + where
2168
2312
        # despite the name 'error' is a type
2169
 
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2170
 
            % (where, re_string, e))
 
2313
        raise errors.BzrCommandError('Invalid regular expression%s: %s'
 
2314
            % (where, e.msg))
2171
2315
 
2172
2316
 
2173
2317
if sys.platform == "win32":
2174
 
    import msvcrt
2175
2318
    def getchar():
 
2319
        import msvcrt
2176
2320
        return msvcrt.getch()
2177
2321
else:
2178
 
    import tty
2179
 
    import termios
2180
2322
    def getchar():
 
2323
        import tty
 
2324
        import termios
2181
2325
        fd = sys.stdin.fileno()
2182
2326
        settings = termios.tcgetattr(fd)
2183
2327
        try:
2187
2331
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2188
2332
        return ch
2189
2333
 
2190
 
 
2191
 
if sys.platform == 'linux2':
 
2334
if sys.platform.startswith('linux'):
2192
2335
    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
 
2336
        try:
 
2337
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2338
        except (ValueError, OSError, AttributeError):
 
2339
            return None
2199
2340
elif sys.platform == 'darwin':
2200
2341
    def _local_concurrency():
2201
2342
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2202
2343
                                stdout=subprocess.PIPE).communicate()[0]
2203
 
elif sys.platform[0:7] == 'freebsd':
 
2344
elif "bsd" in sys.platform:
2204
2345
    def _local_concurrency():
2205
2346
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2206
2347
                                stdout=subprocess.PIPE).communicate()[0]
2234
2375
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2235
2376
    if concurrency is None:
2236
2377
        try:
2237
 
            concurrency = _local_concurrency()
2238
 
        except (OSError, IOError):
2239
 
            pass
 
2378
            import multiprocessing
 
2379
            concurrency = multiprocessing.cpu_count()
 
2380
        except (ImportError, NotImplementedError):
 
2381
            # multiprocessing is only available on Python >= 2.6
 
2382
            # and multiprocessing.cpu_count() isn't implemented on all
 
2383
            # platforms
 
2384
            try:
 
2385
                concurrency = _local_concurrency()
 
2386
            except (OSError, IOError):
 
2387
                pass
2240
2388
    try:
2241
2389
        concurrency = int(concurrency)
2242
2390
    except (TypeError, ValueError):
2263
2411
if sys.platform == 'win32':
2264
2412
    def open_file(filename, mode='r', bufsize=-1):
2265
2413
        """This function is used to override the ``open`` builtin.
2266
 
        
 
2414
 
2267
2415
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2268
2416
        child processes.  Deleting or renaming a closed file opened with this
2269
2417
        function is not blocking child processes.
2302
2450
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2303
2451
else:
2304
2452
    open_file = open
 
2453
 
 
2454
 
 
2455
def available_backup_name(base, exists):
 
2456
    """Find a non-existing backup file name.
 
2457
 
 
2458
    This will *not* create anything, this only return a 'free' entry.  This
 
2459
    should be used for checking names in a directory below a locked
 
2460
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
 
2461
    Leap) and generally discouraged.
 
2462
 
 
2463
    :param base: The base name.
 
2464
 
 
2465
    :param exists: A callable returning True if the path parameter exists.
 
2466
    """
 
2467
    counter = 1
 
2468
    name = "%s.~%d~" % (base, counter)
 
2469
    while exists(name):
 
2470
        counter += 1
 
2471
        name = "%s.~%d~" % (base, counter)
 
2472
    return name
 
2473
 
 
2474
 
 
2475
def set_fd_cloexec(fd):
 
2476
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
 
2477
    support for this is not available.
 
2478
    """
 
2479
    try:
 
2480
        import fcntl
 
2481
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
 
2482
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
 
2483
    except (ImportError, AttributeError):
 
2484
        # Either the fcntl module or specific constants are not present
 
2485
        pass
 
2486
 
 
2487
 
 
2488
def find_executable_on_path(name):
 
2489
    """Finds an executable on the PATH.
 
2490
    
 
2491
    On Windows, this will try to append each extension in the PATHEXT
 
2492
    environment variable to the name, if it cannot be found with the name
 
2493
    as given.
 
2494
    
 
2495
    :param name: The base name of the executable.
 
2496
    :return: The path to the executable found or None.
 
2497
    """
 
2498
    if sys.platform == 'win32':
 
2499
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
 
2500
        exts = [ext.lower() for ext in exts]
 
2501
        base, ext = os.path.splitext(name)
 
2502
        if ext != '':
 
2503
            if ext.lower() not in exts:
 
2504
                return None
 
2505
            name = base
 
2506
            exts = [ext]
 
2507
    else:
 
2508
        exts = ['']
 
2509
    path = os.environ.get('PATH')
 
2510
    if path is not None:
 
2511
        path = path.split(os.pathsep)
 
2512
        for ext in exts:
 
2513
            for d in path:
 
2514
                f = os.path.join(d, name) + ext
 
2515
                if os.access(f, os.X_OK):
 
2516
                    return f
 
2517
    if sys.platform == 'win32':
 
2518
        app_path = win32utils.get_app_path(name)
 
2519
        if app_path != name:
 
2520
            return app_path
 
2521
    return None
 
2522
 
 
2523
 
 
2524
def _posix_is_local_pid_dead(pid):
 
2525
    """True if pid doesn't correspond to live process on this machine"""
 
2526
    try:
 
2527
        # Special meaning of unix kill: just check if it's there.
 
2528
        os.kill(pid, 0)
 
2529
    except OSError, e:
 
2530
        if e.errno == errno.ESRCH:
 
2531
            # On this machine, and really not found: as sure as we can be
 
2532
            # that it's dead.
 
2533
            return True
 
2534
        elif e.errno == errno.EPERM:
 
2535
            # exists, though not ours
 
2536
            return False
 
2537
        else:
 
2538
            mutter("os.kill(%d, 0) failed: %s" % (pid, e))
 
2539
            # Don't really know.
 
2540
            return False
 
2541
    else:
 
2542
        # Exists and our process: not dead.
 
2543
        return False
 
2544
 
 
2545
if sys.platform == "win32":
 
2546
    is_local_pid_dead = win32utils.is_local_pid_dead
 
2547
else:
 
2548
    is_local_pid_dead = _posix_is_local_pid_dead
 
2549
 
 
2550
 
 
2551
def fdatasync(fileno):
 
2552
    """Flush file contents to disk if possible.
 
2553
    
 
2554
    :param fileno: Integer OS file handle.
 
2555
    :raises TransportNotPossible: If flushing to disk is not possible.
 
2556
    """
 
2557
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
 
2558
    if fn is not None:
 
2559
        fn(fileno)
 
2560
 
 
2561
 
 
2562
def ensure_empty_directory_exists(path, exception_class):
 
2563
    """Make sure a local directory exists and is empty.
 
2564
    
 
2565
    If it does not exist, it is created.  If it exists and is not empty, an
 
2566
    instance of exception_class is raised.
 
2567
    """
 
2568
    try:
 
2569
        os.mkdir(path)
 
2570
    except OSError, e:
 
2571
        if e.errno != errno.EEXIST:
 
2572
            raise
 
2573
        if os.listdir(path) != []:
 
2574
            raise exception_class(path)
 
2575
 
 
2576
 
 
2577
def is_environment_error(evalue):
 
2578
    """True if exception instance is due to a process environment issue
 
2579
 
 
2580
    This includes OSError and IOError, but also other errors that come from
 
2581
    the operating system or core libraries but are not subclasses of those.
 
2582
    """
 
2583
    if isinstance(evalue, (EnvironmentError, select.error)):
 
2584
        return True
 
2585
    if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
 
2586
        return True
 
2587
    return False