← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Tarmac
  • Author(s): Vincent Ladeuil
  • Date: 2017-01-30 14:42:05 UTC
  • mfrom: (6620.1.1 trunk)
  • Revision ID: tarmac-20170130144205-r8fh2xpmiuxyozpv
Merge  2.7 into trunk including fix for bug #1657238 [r=vila]

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/osutils.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from __future__ import absolute_import
 
18
 
 
19
import errno
17
20
import os
18
21
import re
19
22
import stat
20
 
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
21
 
                  S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
22
23
import sys
23
24
import time
24
25
import codecs
25
 
import warnings
26
26
 
27
27
from bzrlib.lazy_import import lazy_import
28
28
lazy_import(globals(), """
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 locale
 
32
import ntpath
37
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
38
37
import shutil
39
 
from shutil import (
40
 
    rmtree,
41
 
    )
42
 
import signal
 
38
from shutil import rmtree
 
39
import socket
43
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
44
43
import tempfile
45
 
from tempfile import (
46
 
    mkdtemp,
47
 
    )
 
44
from tempfile import mkdtemp
48
45
import unicodedata
49
46
 
50
47
from bzrlib import (
51
48
    cache_utf8,
 
49
    config,
52
50
    errors,
 
51
    trace,
53
52
    win32utils,
54
53
    )
 
54
from bzrlib.i18n import gettext
55
55
""")
56
56
 
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
 
        )
 
57
from bzrlib.symbol_versioning import (
 
58
    DEPRECATED_PARAMETER,
 
59
    deprecated_function,
 
60
    deprecated_in,
 
61
    deprecated_passed,
 
62
    warn as warn_deprecated,
 
63
    )
 
64
 
 
65
from hashlib import (
 
66
    md5,
 
67
    sha1 as sha,
 
68
    )
69
69
 
70
70
 
71
71
import bzrlib
72
 
from bzrlib import symbol_versioning
 
72
from bzrlib import symbol_versioning, _fs_enc
73
73
 
74
74
 
75
75
# Cross platform wall-clock time functionality with decent resolution.
85
85
# be opened in binary mode, rather than text mode.
86
86
# On other platforms, O_BINARY doesn't exist, because
87
87
# they always open in binary mode, so it is okay to
88
 
# OR with 0 on those platforms
 
88
# OR with 0 on those platforms.
 
89
# O_NOINHERIT and O_TEXT exists only on win32 too.
89
90
O_BINARY = getattr(os, 'O_BINARY', 0)
 
91
O_TEXT = getattr(os, 'O_TEXT', 0)
 
92
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
90
93
 
91
94
 
92
95
def get_unicode_argv():
94
97
        user_encoding = get_user_encoding()
95
98
        return [a.decode(user_encoding) for a in sys.argv[1:]]
96
99
    except UnicodeDecodeError:
97
 
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
98
 
                                                            "encoding." % a))
 
100
        raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
 
101
            "application locale.").format(a, user_encoding))
99
102
 
100
103
 
101
104
def make_readonly(filename):
103
106
    mod = os.lstat(filename).st_mode
104
107
    if not stat.S_ISLNK(mod):
105
108
        mod = mod & 0777555
106
 
        os.chmod(filename, mod)
 
109
        chmod_if_possible(filename, mod)
107
110
 
108
111
 
109
112
def make_writable(filename):
110
113
    mod = os.lstat(filename).st_mode
111
114
    if not stat.S_ISLNK(mod):
112
115
        mod = mod | 0200
113
 
        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
114
136
 
115
137
 
116
138
def minimum_path_selection(paths):
195
217
            if e.errno == errno.ENOENT:
196
218
                return False;
197
219
            else:
198
 
                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))
199
221
 
200
222
 
201
223
def fancy_rename(old, new, rename_func, unlink_func):
267
289
            else:
268
290
                rename_func(tmp_name, new)
269
291
    if failure_exc is not None:
270
 
        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
271
296
 
272
297
 
273
298
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
274
299
# choke on a Unicode string containing a relative path if
275
300
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
276
301
# string.
277
 
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
278
302
def _posix_abspath(path):
279
303
    # jam 20060426 rather than encoding to fsencoding
280
304
    # copy posixpath.abspath, but use os.getcwdu instead
281
305
    if not posixpath.isabs(path):
282
306
        path = posixpath.join(getcwd(), path)
283
 
    return posixpath.normpath(path)
 
307
    return _posix_normpath(path)
284
308
 
285
309
 
286
310
def _posix_realpath(path):
287
311
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
288
312
 
289
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
 
290
365
def _win32_fixdrive(path):
291
366
    """Force drive letters to be consistent.
292
367
 
296
371
    running python.exe under cmd.exe return capital C:\\
297
372
    running win32 python inside a cygwin shell returns lowercase c:\\
298
373
    """
299
 
    drive, path = _nt_splitdrive(path)
 
374
    drive, path = ntpath.splitdrive(path)
300
375
    return drive.upper() + path
301
376
 
302
377
 
303
378
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('\\', '/'))
 
379
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
 
380
    return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
306
381
 
307
382
 
308
383
def _win98_abspath(path):
319
394
    #   /path       => C:/path
320
395
    path = unicode(path)
321
396
    # check for absolute path
322
 
    drive = _nt_splitdrive(path)[0]
 
397
    drive = ntpath.splitdrive(path)[0]
323
398
    if drive == '' and path[:2] not in('//','\\\\'):
324
399
        cwd = os.getcwdu()
325
400
        # we cannot simply os.path.join cwd and path
326
401
        # because os.path.join('C:','/path') produce '/path'
327
402
        # and this is incorrect
328
403
        if path[:1] in ('/','\\'):
329
 
            cwd = _nt_splitdrive(cwd)[0]
 
404
            cwd = ntpath.splitdrive(cwd)[0]
330
405
            path = path[1:]
331
406
        path = cwd + '\\' + path
332
 
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
 
407
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
333
408
 
334
409
 
335
410
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('\\', '/'))
 
411
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
 
412
    return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
338
413
 
339
414
 
340
415
def _win32_pathjoin(*args):
341
 
    return _nt_join(*args).replace('\\', '/')
 
416
    return ntpath.join(*args).replace('\\', '/')
342
417
 
343
418
 
344
419
def _win32_normpath(path):
345
 
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
420
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
346
421
 
347
422
 
348
423
def _win32_getcwd():
375
450
    return unicodedata.normalize('NFC', os.getcwdu())
376
451
 
377
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
 
378
476
# Default is to just use the python builtins, but these can be rebound on
379
477
# particular platforms.
380
478
abspath = _posix_abspath
381
479
realpath = _posix_realpath
382
480
pathjoin = os.path.join
383
 
normpath = os.path.normpath
 
481
normpath = _posix_normpath
 
482
path_from_environ = _posix_path_from_environ
 
483
_get_home_dir = _posix_get_home_dir
 
484
getuser_unicode = _posix_getuser_unicode
384
485
getcwd = os.getcwdu
385
 
rename = os.rename
386
486
dirname = os.path.dirname
387
487
basename = os.path.basename
388
488
split = os.path.split
389
489
splitext = os.path.splitext
390
 
# These were already imported into local scope
 
490
# These were already lazily imported into local scope
391
491
# mkdtemp = tempfile.mkdtemp
392
492
# rmtree = shutil.rmtree
 
493
lstat = os.lstat
 
494
fstat = os.fstat
 
495
 
 
496
def wrap_stat(st):
 
497
    return st
 
498
 
393
499
 
394
500
MIN_ABS_PATHLENGTH = 1
395
501
 
404
510
    normpath = _win32_normpath
405
511
    getcwd = _win32_getcwd
406
512
    mkdtemp = _win32_mkdtemp
407
 
    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
408
522
 
409
523
    MIN_ABS_PATHLENGTH = 3
410
524
 
428
542
    f = win32utils.get_unicode_argv     # special function or None
429
543
    if f is not None:
430
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
431
548
 
432
549
elif sys.platform == 'darwin':
433
550
    getcwd = _mac_getcwd
434
551
 
435
552
 
436
 
def get_terminal_encoding():
 
553
def get_terminal_encoding(trace=False):
437
554
    """Find the best encoding for printing to the screen.
438
555
 
439
556
    This attempts to check both sys.stdout and sys.stdin to see
445
562
 
446
563
    On my standard US Windows XP, the preferred encoding is
447
564
    cp1252, but the console is cp437
 
565
 
 
566
    :param trace: If True trace the selected encoding via mutter().
448
567
    """
449
568
    from bzrlib.trace import mutter
450
569
    output_encoding = getattr(sys.stdout, 'encoding', None)
452
571
        input_encoding = getattr(sys.stdin, 'encoding', None)
453
572
        if not input_encoding:
454
573
            output_encoding = get_user_encoding()
455
 
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
574
            if trace:
 
575
                mutter('encoding stdout as osutils.get_user_encoding() %r',
456
576
                   output_encoding)
457
577
        else:
458
578
            output_encoding = input_encoding
459
 
            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)
460
582
    else:
461
 
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
583
        if trace:
 
584
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
462
585
    if output_encoding == 'cp0':
463
586
        # invalid encoding (cp0 means 'no codepage' on Windows)
464
587
        output_encoding = get_user_encoding()
465
 
        mutter('cp0 is invalid encoding.'
 
588
        if trace:
 
589
            mutter('cp0 is invalid encoding.'
466
590
               ' encoding stdout as osutils.get_user_encoding() %r',
467
591
               output_encoding)
468
592
    # check encoding
494
618
def isdir(f):
495
619
    """True if f is an accessible directory."""
496
620
    try:
497
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
621
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
498
622
    except OSError:
499
623
        return False
500
624
 
502
626
def isfile(f):
503
627
    """True if f is a regular file."""
504
628
    try:
505
 
        return S_ISREG(os.lstat(f)[ST_MODE])
 
629
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
506
630
    except OSError:
507
631
        return False
508
632
 
509
633
def islink(f):
510
634
    """True if f is a symlink."""
511
635
    try:
512
 
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
636
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
513
637
    except OSError:
514
638
        return False
515
639
 
663
787
def sha_file_by_name(fname):
664
788
    """Calculate the SHA1 of a file by reading the full text"""
665
789
    s = sha()
666
 
    f = os.open(fname, os.O_RDONLY | O_BINARY)
 
790
    f = os.open(fname, os.O_RDONLY | O_BINARY | O_NOINHERIT)
667
791
    try:
668
792
        while True:
669
793
            b = os.read(f, 1<<16)
855
979
 
856
980
def filesize(f):
857
981
    """Return size of given open file."""
858
 
    return os.fstat(f.fileno())[ST_SIZE]
859
 
 
860
 
 
861
 
# Define rand_bytes based on platform.
862
 
try:
863
 
    # Python 2.4 and later have os.urandom,
864
 
    # but it doesn't work on some arches
865
 
    os.urandom(1)
866
 
    rand_bytes = os.urandom
867
 
except (NotImplementedError, AttributeError):
868
 
    # If python doesn't have os.urandom, or it doesn't work,
869
 
    # 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":
870
992
    try:
871
 
        rand_bytes = file('/dev/urandom', 'rb').read
872
 
    # Otherwise, use this hack as a last resort
873
 
    except (IOError, OSError):
 
993
        rand_bytes(1)
 
994
    except NotImplementedError:
874
995
        # not well seeded, but better than nothing
875
996
        def rand_bytes(n):
876
997
            import random
906
1027
    rps = []
907
1028
    for f in ps:
908
1029
        if f == '..':
909
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1030
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
910
1031
        elif (f == '.') or (f == ''):
911
1032
            pass
912
1033
        else:
917
1038
def joinpath(p):
918
1039
    for f in p:
919
1040
        if (f == '..') or (f is None) or (f == ''):
920
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1041
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
921
1042
    return pathjoin(*p)
922
1043
 
923
1044
 
924
1045
def parent_directories(filename):
925
1046
    """Return the list of parent directories, deepest first.
926
 
    
 
1047
 
927
1048
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
928
1049
    """
929
1050
    parents = []
953
1074
    # NB: This docstring is just an example, not a doctest, because doctest
954
1075
    # currently can't cope with the use of lazy imports in this namespace --
955
1076
    # mbp 20090729
956
 
    
 
1077
 
957
1078
    # This currently doesn't report the failure at the time it occurs, because
958
1079
    # they tend to happen very early in startup when we can't check config
959
1080
    # files etc, and also we want to report all failures but not spam the user
960
1081
    # with 10 warnings.
961
 
    from bzrlib import trace
962
1082
    exception_str = str(exception)
963
1083
    if exception_str not in _extension_load_failures:
964
1084
        trace.mutter("failed to load compiled extension: %s" % exception_str)
968
1088
def report_extension_load_failures():
969
1089
    if not _extension_load_failures:
970
1090
        return
971
 
    from bzrlib.config import GlobalConfig
972
 
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
 
1091
    if config.GlobalStack().get('ignore_missing_extensions'):
973
1092
        return
974
1093
    # the warnings framework should by default show this only once
975
1094
    from bzrlib.trace import warning
1029
1148
 
1030
1149
 
1031
1150
def delete_any(path):
1032
 
    """Delete a file, symlink or directory.  
1033
 
    
 
1151
    """Delete a file, symlink or directory.
 
1152
 
1034
1153
    Will delete even if readonly.
1035
1154
    """
1036
1155
    try:
1122
1241
 
1123
1242
 
1124
1243
def relpath(base, path):
1125
 
    """Return path relative to base, or raise exception.
 
1244
    """Return path relative to base, or raise PathNotChild exception.
1126
1245
 
1127
1246
    The path may be either an absolute path or a path relative to the
1128
1247
    current working directory.
1130
1249
    os.path.commonprefix (python2.4) has a bad bug that it works just
1131
1250
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
1132
1251
    avoids that problem.
 
1252
 
 
1253
    NOTE: `base` should not have a trailing slash otherwise you'll get
 
1254
    PathNotChild exceptions regardless of `path`.
1133
1255
    """
1134
1256
 
1135
1257
    if len(base) < MIN_ABS_PATHLENGTH:
1136
1258
        # must have space for e.g. a drive letter
1137
 
        raise ValueError('%r is too short to calculate a relative path'
 
1259
        raise ValueError(gettext('%r is too short to calculate a relative path')
1138
1260
            % (base,))
1139
1261
 
1140
1262
    rp = abspath(path)
1222
1344
    # but for now, we haven't optimized...
1223
1345
    return [canonical_relpath(base, p) for p in paths]
1224
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
 
1225
1363
def safe_unicode(unicode_or_utf8_string):
1226
1364
    """Coerce unicode_or_utf8_string into unicode.
1227
1365
 
1310
1448
def normalizes_filenames():
1311
1449
    """Return True if this platform normalizes unicode filenames.
1312
1450
 
1313
 
    Mac OSX does, Windows/Linux do not.
 
1451
    Only Mac OSX.
1314
1452
    """
1315
1453
    return _platform_normalizes_filenames
1316
1454
 
1321
1459
    On platforms where the system normalizes filenames (Mac OSX),
1322
1460
    you can access a file by any path which will normalize correctly.
1323
1461
    On platforms where the system does not normalize filenames
1324
 
    (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.
1325
1463
 
1326
1464
    Internally, bzr only supports NFC normalization, since that is
1327
1465
    the standard for XML documents.
1346
1484
    normalized_filename = _inaccessible_normalized_filename
1347
1485
 
1348
1486
 
 
1487
def set_signal_handler(signum, handler, restart_syscall=True):
 
1488
    """A wrapper for signal.signal that also calls siginterrupt(signum, False)
 
1489
    on platforms that support that.
 
1490
 
 
1491
    :param restart_syscall: if set, allow syscalls interrupted by a signal to
 
1492
        automatically restart (by calling `signal.siginterrupt(signum,
 
1493
        False)`).  May be ignored if the feature is not available on this
 
1494
        platform or Python version.
 
1495
    """
 
1496
    try:
 
1497
        import signal
 
1498
        siginterrupt = signal.siginterrupt
 
1499
    except ImportError:
 
1500
        # This python implementation doesn't provide signal support, hence no
 
1501
        # handler exists
 
1502
        return None
 
1503
    except AttributeError:
 
1504
        # siginterrupt doesn't exist on this platform, or for this version
 
1505
        # of Python.
 
1506
        siginterrupt = lambda signum, flag: None
 
1507
    if restart_syscall:
 
1508
        def sig_handler(*args):
 
1509
            # Python resets the siginterrupt flag when a signal is
 
1510
            # received.  <http://bugs.python.org/issue8354>
 
1511
            # As a workaround for some cases, set it back the way we want it.
 
1512
            siginterrupt(signum, False)
 
1513
            # Now run the handler function passed to set_signal_handler.
 
1514
            handler(*args)
 
1515
    else:
 
1516
        sig_handler = handler
 
1517
    old_handler = signal.signal(signum, sig_handler)
 
1518
    if restart_syscall:
 
1519
        siginterrupt(signum, False)
 
1520
    return old_handler
 
1521
 
 
1522
 
1349
1523
default_terminal_width = 80
1350
1524
"""The default terminal width for ttys.
1351
1525
 
1353
1527
terminal_width() returns None.
1354
1528
"""
1355
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
1356
1536
 
1357
1537
def terminal_width():
1358
1538
    """Return terminal width.
1362
1542
    The rules are:
1363
1543
    - if BZR_COLUMNS is set, returns its value
1364
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,
1365
1547
    - if COLUMNS is set, returns its value,
 
1548
    - if the OS has a value (even though it's never changed), return its value.
1366
1549
 
1367
1550
    From there, we need to query the OS to get the size of the controlling
1368
1551
    terminal.
1369
1552
 
1370
 
    Unices:
 
1553
    On Unices we query the OS by:
1371
1554
    - get termios.TIOCGWINSZ
1372
1555
    - if an error occurs or a negative value is obtained, returns None
1373
1556
 
1374
 
    Windows:
1375
 
    
 
1557
    On Windows we query the OS by:
1376
1558
    - win32utils.get_console_size() decides,
1377
1559
    - returns None on error (provided default value)
1378
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.
1379
1573
 
1380
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
1381
1576
    try:
1382
 
        return int(os.environ['BZR_COLUMNS'])
 
1577
        width = int(os.environ['BZR_COLUMNS'])
1383
1578
    except (KeyError, ValueError):
1384
 
        pass
 
1579
        width = None
 
1580
    if width is not None:
 
1581
        if width > 0:
 
1582
            return width
 
1583
        else:
 
1584
            return None
1385
1585
 
1386
1586
    isatty = getattr(sys.stdout, 'isatty', None)
1387
 
    if  isatty is None or not isatty():
 
1587
    if isatty is None or not isatty():
1388
1588
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1389
1589
        return None
1390
1590
 
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))
 
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.
1394
1608
    try:
1395
1609
        return int(os.environ['COLUMNS'])
1396
1610
    except (KeyError, ValueError):
1397
1611
        pass
1398
1612
 
1399
 
    width, height = _terminal_size(None, None)
1400
 
    if width <= 0:
1401
 
        # Consider invalid values as meaning no width
1402
 
        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
1403
1617
 
1404
 
    return width
 
1618
    # The width could not be determined.
 
1619
    return None
1405
1620
 
1406
1621
 
1407
1622
def _win32_terminal_size(width, height):
1434
1649
    _terminal_size = _ioctl_terminal_size
1435
1650
 
1436
1651
 
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
 
 
1444
 
_registered_sigwinch = False
1445
 
 
1446
 
def watch_sigwinch():
1447
 
    """Register for SIGWINCH, once and only once."""
1448
 
    global _registered_sigwinch
1449
 
    if not _registered_sigwinch:
1450
 
        if sys.platform == 'win32':
1451
 
            # Martin (gz) mentioned WINDOW_BUFFER_SIZE_RECORD from
1452
 
            # ReadConsoleInput but I've no idea how to plug that in
1453
 
            # the current design -- vila 20091216
1454
 
            pass
1455
 
        else:
1456
 
            signal.signal(signal.SIGWINCH, _terminal_size_changed)
1457
 
        _registered_sigwinch = True
1458
 
 
1459
 
 
1460
1652
def supports_executable():
1461
1653
    return sys.platform != "win32"
1462
1654
 
1585
1777
        dirblock = []
1586
1778
        append = dirblock.append
1587
1779
        try:
1588
 
            names = sorted(_listdir(top))
 
1780
            names = sorted(map(decode_filename, _listdir(top)))
1589
1781
        except OSError, e:
1590
1782
            if not _is_error_enotdir(e):
1591
1783
                raise
1645
1837
    """
1646
1838
    global _selected_dir_reader
1647
1839
    if _selected_dir_reader is None:
1648
 
        fs_encoding = _fs_enc.upper()
1649
1840
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1650
1841
            # Win98 doesn't have unicode apis like FindFirstFileW
1651
1842
            # TODO: We possibly could support Win98 by falling back to the
1657
1848
                _selected_dir_reader = Win32ReadDir()
1658
1849
            except ImportError:
1659
1850
                pass
1660
 
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1661
 
            # ANSI_X3.4-1968 is a form of ASCII
 
1851
        elif _fs_enc in ('utf-8', 'ascii'):
1662
1852
            try:
1663
1853
                from bzrlib._readdir_pyx import UTF8DirReader
1664
1854
                _selected_dir_reader = UTF8DirReader()
1780
1970
            real_handlers[kind](abspath, relpath)
1781
1971
 
1782
1972
 
 
1973
def copy_ownership_from_path(dst, src=None):
 
1974
    """Copy usr/grp ownership from src file/dir to dst file/dir.
 
1975
 
 
1976
    If src is None, the containing directory is used as source. If chown
 
1977
    fails, the error is ignored and a warning is printed.
 
1978
    """
 
1979
    chown = getattr(os, 'chown', None)
 
1980
    if chown is None:
 
1981
        return
 
1982
 
 
1983
    if src == None:
 
1984
        src = os.path.dirname(dst)
 
1985
        if src == '':
 
1986
            src = '.'
 
1987
 
 
1988
    try:
 
1989
        s = os.stat(src)
 
1990
        chown(dst, s.st_uid, s.st_gid)
 
1991
    except OSError, 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()
 
1996
 
 
1997
 
1783
1998
def path_prefix_key(path):
1784
1999
    """Generate a prefix-order path key for path.
1785
2000
 
1798
2013
_cached_user_encoding = None
1799
2014
 
1800
2015
 
1801
 
def get_user_encoding(use_cache=True):
 
2016
def get_user_encoding(use_cache=DEPRECATED_PARAMETER):
1802
2017
    """Find out what the preferred user encoding is.
1803
2018
 
1804
2019
    This is generally the encoding that is used for command line parameters
1805
2020
    and file contents. This may be different from the terminal encoding
1806
2021
    or the filesystem encoding.
1807
2022
 
1808
 
    :param  use_cache:  Enable cache for detected encoding.
1809
 
                        (This parameter is turned on by default,
1810
 
                        and required only for selftesting)
1811
 
 
1812
2023
    :return: A string defining the preferred user encoding
1813
2024
    """
1814
2025
    global _cached_user_encoding
1815
 
    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:
1816
2030
        return _cached_user_encoding
1817
2031
 
1818
 
    if sys.platform == 'darwin':
1819
 
        # python locale.getpreferredencoding() always return
1820
 
        # 'mac-roman' on darwin. That's a lie.
1821
 
        sys.platform = 'posix'
1822
 
        try:
1823
 
            if os.environ.get('LANG', None) is None:
1824
 
                # If LANG is not set, we end up with 'ascii', which is bad
1825
 
                # ('mac-roman' is more than ascii), so we set a default which
1826
 
                # will give us UTF-8 (which appears to work in all cases on
1827
 
                # OSX). Users are still free to override LANG of course, as
1828
 
                # long as it give us something meaningful. This work-around
1829
 
                # *may* not be needed with python 3k and/or OSX 10.5, but will
1830
 
                # work with them too -- vila 20080908
1831
 
                os.environ['LANG'] = 'en_US.UTF-8'
1832
 
            import locale
1833
 
        finally:
1834
 
            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)
1835
2038
    else:
1836
 
        import locale
 
2039
        # GZ 2011-12-19: On windows could call GetACP directly instead.
 
2040
        user_encoding = locale.getpreferredencoding(False)
1837
2041
 
1838
2042
    try:
1839
 
        user_encoding = locale.getpreferredencoding()
1840
 
    except locale.Error, e:
1841
 
        sys.stderr.write('bzr: warning: %s\n'
1842
 
                         '  Could not determine what text encoding to use.\n'
1843
 
                         '  This error usually means your Python interpreter\n'
1844
 
                         '  doesn\'t support the locale set by $LANG (%s)\n'
1845
 
                         "  Continuing with ascii encoding.\n"
1846
 
                         % (e, os.environ.get('LANG')))
1847
 
        user_encoding = 'ascii'
1848
 
 
1849
 
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
1850
 
    # treat that as ASCII, and not support printing unicode characters to the
1851
 
    # console.
1852
 
    #
1853
 
    # For python scripts run under vim, we get '', so also treat that as ASCII
1854
 
    if user_encoding in (None, 'cp0', ''):
1855
 
        user_encoding = 'ascii'
1856
 
    else:
1857
 
        # check encoding
1858
 
        try:
1859
 
            codecs.lookup(user_encoding)
1860
 
        except LookupError:
 
2043
        user_encoding = codecs.lookup(user_encoding).name
 
2044
    except LookupError:
 
2045
        if user_encoding not in ("", "cp0"):
1861
2046
            sys.stderr.write('bzr: warning:'
1862
2047
                             ' unknown encoding %s.'
1863
2048
                             ' Continuing with ascii encoding.\n'
1864
2049
                             % user_encoding
1865
2050
                            )
1866
 
            user_encoding = 'ascii'
1867
 
 
1868
 
    if use_cache:
1869
 
        _cached_user_encoding = user_encoding
1870
 
 
 
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
1871
2063
    return user_encoding
1872
2064
 
1873
2065
 
 
2066
def get_diff_header_encoding():
 
2067
    return get_terminal_encoding()
 
2068
 
 
2069
 
1874
2070
def get_host_name():
1875
2071
    """Return the current unicode host name.
1876
2072
 
1878
2074
    behaves inconsistently on different platforms.
1879
2075
    """
1880
2076
    if sys.platform == "win32":
1881
 
        import win32utils
1882
2077
        return win32utils.get_host_name()
1883
2078
    else:
1884
2079
        import socket
1885
2080
        return socket.gethostname().decode(get_user_encoding())
1886
2081
 
1887
2082
 
1888
 
def recv_all(socket, bytes):
 
2083
# We must not read/write any more than 64k at a time from/to a socket so we
 
2084
# don't risk "no buffer space available" errors on some platforms.  Windows in
 
2085
# particular is likely to throw WSAECONNABORTED or WSAENOBUFS if given too much
 
2086
# data at once.
 
2087
MAX_SOCKET_CHUNK = 64 * 1024
 
2088
 
 
2089
_end_of_stream_errors = [errno.ECONNRESET, errno.EPIPE, errno.EINVAL]
 
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
 
 
2097
def read_bytes_from_socket(sock, report_activity=None,
 
2098
        max_read_size=MAX_SOCKET_CHUNK):
 
2099
    """Read up to max_read_size of bytes from sock and notify of progress.
 
2100
 
 
2101
    Translates "Connection reset by peer" into file-like EOF (return an
 
2102
    empty string rather than raise an error), and repeats the recv if
 
2103
    interrupted by a signal.
 
2104
    """
 
2105
    while 1:
 
2106
        try:
 
2107
            bytes = sock.recv(max_read_size)
 
2108
        except socket.error, e:
 
2109
            eno = e.args[0]
 
2110
            if eno in _end_of_stream_errors:
 
2111
                # The connection was closed by the other side.  Callers expect
 
2112
                # an empty string to signal end-of-stream.
 
2113
                return ""
 
2114
            elif eno == errno.EINTR:
 
2115
                # Retry the interrupted recv.
 
2116
                continue
 
2117
            raise
 
2118
        else:
 
2119
            if report_activity is not None:
 
2120
                report_activity(len(bytes), 'read')
 
2121
            return bytes
 
2122
 
 
2123
 
 
2124
def recv_all(socket, count):
1889
2125
    """Receive an exact number of bytes.
1890
2126
 
1891
2127
    Regular Socket.recv() may return less than the requested number of bytes,
1892
 
    dependning on what's in the OS buffer.  MSG_WAITALL is not available
 
2128
    depending on what's in the OS buffer.  MSG_WAITALL is not available
1893
2129
    on all platforms, but this should work everywhere.  This will return
1894
2130
    less than the requested amount if the remote end closes.
1895
2131
 
1896
2132
    This isn't optimized and is intended mostly for use in testing.
1897
2133
    """
1898
2134
    b = ''
1899
 
    while len(b) < bytes:
1900
 
        new = until_no_eintr(socket.recv, bytes - len(b))
 
2135
    while len(b) < count:
 
2136
        new = read_bytes_from_socket(socket, None, count - len(b))
1901
2137
        if new == '':
1902
2138
            break # eof
1903
2139
        b += new
1904
2140
    return b
1905
2141
 
1906
2142
 
1907
 
def send_all(socket, bytes, report_activity=None):
 
2143
def send_all(sock, bytes, report_activity=None):
1908
2144
    """Send all bytes on a socket.
1909
2145
 
1910
 
    Regular socket.sendall() can give socket error 10053 on Windows.  This
1911
 
    implementation sends no more than 64k at a time, which avoids this problem.
 
2146
    Breaks large blocks in smaller chunks to avoid buffering limitations on
 
2147
    some platforms, and catches EINTR which may be thrown if the send is
 
2148
    interrupted by a signal.
 
2149
 
 
2150
    This is preferred to socket.sendall(), because it avoids portability bugs
 
2151
    and provides activity reporting.
1912
2152
 
1913
2153
    :param report_activity: Call this as bytes are read, see
1914
2154
        Transport._report_activity
1915
2155
    """
1916
 
    chunk_size = 2**16
1917
 
    for pos in xrange(0, len(bytes), chunk_size):
1918
 
        block = bytes[pos:pos+chunk_size]
1919
 
        if report_activity is not None:
1920
 
            report_activity(len(block), 'write')
1921
 
        until_no_eintr(socket.sendall, block)
 
2156
    sent_total = 0
 
2157
    byte_count = len(bytes)
 
2158
    while sent_total < byte_count:
 
2159
        try:
 
2160
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
 
2161
        except (socket.error, IOError), e:
 
2162
            if e.args[0] in _end_of_stream_errors:
 
2163
                raise errors.ConnectionReset(
 
2164
                    "Error trying to write to socket", e)
 
2165
            if e.args[0] != errno.EINTR:
 
2166
                raise
 
2167
        else:
 
2168
            if sent == 0:
 
2169
                raise errors.ConnectionReset('Sending to %s returned 0 bytes'
 
2170
                                             % (sock,))
 
2171
            sent_total += sent
 
2172
            if report_activity is not None:
 
2173
                report_activity(sent, 'write')
 
2174
 
 
2175
 
 
2176
def connect_socket(address):
 
2177
    # Slight variation of the socket.create_connection() function (provided by
 
2178
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
 
2179
    # provide it for previous python versions. Also, we don't use the timeout
 
2180
    # parameter (provided by the python implementation) so we don't implement
 
2181
    # it either).
 
2182
    err = socket.error('getaddrinfo returns an empty list')
 
2183
    host, port = address
 
2184
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
 
2185
        af, socktype, proto, canonname, sa = res
 
2186
        sock = None
 
2187
        try:
 
2188
            sock = socket.socket(af, socktype, proto)
 
2189
            sock.connect(sa)
 
2190
            return sock
 
2191
 
 
2192
        except socket.error, err:
 
2193
            # 'err' is now the most recent error
 
2194
            if sock is not None:
 
2195
                sock.close()
 
2196
    raise err
1922
2197
 
1923
2198
 
1924
2199
def dereference_path(path):
1965
2240
    base = dirname(bzrlib.__file__)
1966
2241
    if getattr(sys, 'frozen', None):    # bzr.exe
1967
2242
        base = abspath(pathjoin(base, '..', '..'))
1968
 
    filename = pathjoin(base, resource_relpath)
1969
 
    return open(filename, 'rU').read()
1970
 
 
 
2243
    f = file(pathjoin(base, resource_relpath), "rU")
 
2244
    try:
 
2245
        return f.read()
 
2246
    finally:
 
2247
        f.close()
1971
2248
 
1972
2249
def file_kind_from_stat_mode_thunk(mode):
1973
2250
    global file_kind_from_stat_mode
1984
2261
    return file_kind_from_stat_mode(mode)
1985
2262
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
1986
2263
 
1987
 
 
1988
 
def file_kind(f, _lstat=os.lstat):
 
2264
def file_stat(f, _lstat=os.lstat):
1989
2265
    try:
1990
 
        return file_kind_from_stat_mode(_lstat(f).st_mode)
 
2266
        # XXX cache?
 
2267
        return _lstat(f)
1991
2268
    except OSError, e:
1992
2269
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
1993
2270
            raise errors.NoSuchFile(f)
1994
2271
        raise
1995
2272
 
 
2273
def file_kind(f, _lstat=os.lstat):
 
2274
    stat_value = file_stat(f, _lstat)
 
2275
    return file_kind_from_stat_mode(stat_value.st_mode)
1996
2276
 
1997
2277
def until_no_eintr(f, *a, **kw):
1998
 
    """Run f(*a, **kw), retrying if an EINTR error occurs."""
 
2278
    """Run f(*a, **kw), retrying if an EINTR error occurs.
 
2279
 
 
2280
    WARNING: you must be certain that it is safe to retry the call repeatedly
 
2281
    if EINTR does occur.  This is typically only true for low-level operations
 
2282
    like os.read.  If in any doubt, don't use this.
 
2283
 
 
2284
    Keep in mind that this is not a complete solution to EINTR.  There is
 
2285
    probably code in the Python standard library and other dependencies that
 
2286
    may encounter EINTR if a signal arrives (and there is signal handler for
 
2287
    that signal).  So this function can reduce the impact for IO that bzrlib
 
2288
    directly controls, but it is not a complete solution.
 
2289
    """
1999
2290
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
2000
2291
    while True:
2001
2292
        try:
2005
2296
                continue
2006
2297
            raise
2007
2298
 
 
2299
 
 
2300
@deprecated_function(deprecated_in((2, 2, 0)))
2008
2301
def re_compile_checked(re_string, flags=0, where=""):
2009
2302
    """Return a compiled re, or raise a sensible error.
2010
2303
 
2020
2313
        re_obj = re.compile(re_string, flags)
2021
2314
        re_obj.search("")
2022
2315
        return re_obj
2023
 
    except re.error, e:
 
2316
    except errors.InvalidPattern, e:
2024
2317
        if where:
2025
2318
            where = ' in ' + where
2026
2319
        # despite the name 'error' is a type
2027
 
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2028
 
            % (where, re_string, e))
 
2320
        raise errors.BzrCommandError('Invalid regular expression%s: %s'
 
2321
            % (where, e.msg))
2029
2322
 
2030
2323
 
2031
2324
if sys.platform == "win32":
2032
 
    import msvcrt
2033
2325
    def getchar():
 
2326
        import msvcrt
2034
2327
        return msvcrt.getch()
2035
2328
else:
2036
 
    import tty
2037
 
    import termios
2038
2329
    def getchar():
 
2330
        import tty
 
2331
        import termios
2039
2332
        fd = sys.stdin.fileno()
2040
2333
        settings = termios.tcgetattr(fd)
2041
2334
        try:
2045
2338
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2046
2339
        return ch
2047
2340
 
2048
 
 
2049
 
if sys.platform == 'linux2':
 
2341
if sys.platform.startswith('linux'):
2050
2342
    def _local_concurrency():
2051
 
        concurrency = None
2052
 
        prefix = 'processor'
2053
 
        for line in file('/proc/cpuinfo', 'rb'):
2054
 
            if line.startswith(prefix):
2055
 
                concurrency = int(line[line.find(':')+1:]) + 1
2056
 
        return concurrency
 
2343
        try:
 
2344
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2345
        except (ValueError, OSError, AttributeError):
 
2346
            return None
2057
2347
elif sys.platform == 'darwin':
2058
2348
    def _local_concurrency():
2059
2349
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2060
2350
                                stdout=subprocess.PIPE).communicate()[0]
2061
 
elif sys.platform[0:7] == 'freebsd':
 
2351
elif "bsd" in sys.platform:
2062
2352
    def _local_concurrency():
2063
2353
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2064
2354
                                stdout=subprocess.PIPE).communicate()[0]
2092
2382
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2093
2383
    if concurrency is None:
2094
2384
        try:
2095
 
            concurrency = _local_concurrency()
2096
 
        except (OSError, IOError):
2097
 
            pass
 
2385
            import multiprocessing
 
2386
            concurrency = multiprocessing.cpu_count()
 
2387
        except (ImportError, NotImplementedError):
 
2388
            # multiprocessing is only available on Python >= 2.6
 
2389
            # and multiprocessing.cpu_count() isn't implemented on all
 
2390
            # platforms
 
2391
            try:
 
2392
                concurrency = _local_concurrency()
 
2393
            except (OSError, IOError):
 
2394
                pass
2098
2395
    try:
2099
2396
        concurrency = int(concurrency)
2100
2397
    except (TypeError, ValueError):
2117
2414
        else:
2118
2415
            data, _ = self.encode(object, self.errors)
2119
2416
            self.stream.write(data)
 
2417
 
 
2418
if sys.platform == 'win32':
 
2419
    def open_file(filename, mode='r', bufsize=-1):
 
2420
        """This function is used to override the ``open`` builtin.
 
2421
 
 
2422
        But it uses O_NOINHERIT flag so the file handle is not inherited by
 
2423
        child processes.  Deleting or renaming a closed file opened with this
 
2424
        function is not blocking child processes.
 
2425
        """
 
2426
        writing = 'w' in mode
 
2427
        appending = 'a' in mode
 
2428
        updating = '+' in mode
 
2429
        binary = 'b' in mode
 
2430
 
 
2431
        flags = O_NOINHERIT
 
2432
        # see http://msdn.microsoft.com/en-us/library/yeby3zcb%28VS.71%29.aspx
 
2433
        # for flags for each modes.
 
2434
        if binary:
 
2435
            flags |= O_BINARY
 
2436
        else:
 
2437
            flags |= O_TEXT
 
2438
 
 
2439
        if writing:
 
2440
            if updating:
 
2441
                flags |= os.O_RDWR
 
2442
            else:
 
2443
                flags |= os.O_WRONLY
 
2444
            flags |= os.O_CREAT | os.O_TRUNC
 
2445
        elif appending:
 
2446
            if updating:
 
2447
                flags |= os.O_RDWR
 
2448
            else:
 
2449
                flags |= os.O_WRONLY
 
2450
            flags |= os.O_CREAT | os.O_APPEND
 
2451
        else: #reading
 
2452
            if updating:
 
2453
                flags |= os.O_RDWR
 
2454
            else:
 
2455
                flags |= os.O_RDONLY
 
2456
 
 
2457
        return os.fdopen(os.open(filename, flags), mode, bufsize)
 
2458
else:
 
2459
    open_file = open
 
2460
 
 
2461
 
 
2462
def available_backup_name(base, exists):
 
2463
    """Find a non-existing backup file name.
 
2464
 
 
2465
    This will *not* create anything, this only return a 'free' entry.  This
 
2466
    should be used for checking names in a directory below a locked
 
2467
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
 
2468
    Leap) and generally discouraged.
 
2469
 
 
2470
    :param base: The base name.
 
2471
 
 
2472
    :param exists: A callable returning True if the path parameter exists.
 
2473
    """
 
2474
    counter = 1
 
2475
    name = "%s.~%d~" % (base, counter)
 
2476
    while exists(name):
 
2477
        counter += 1
 
2478
        name = "%s.~%d~" % (base, counter)
 
2479
    return name
 
2480
 
 
2481
 
 
2482
def set_fd_cloexec(fd):
 
2483
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
 
2484
    support for this is not available.
 
2485
    """
 
2486
    try:
 
2487
        import fcntl
 
2488
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
 
2489
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
 
2490
    except (ImportError, AttributeError):
 
2491
        # Either the fcntl module or specific constants are not present
 
2492
        pass
 
2493
 
 
2494
 
 
2495
def find_executable_on_path(name):
 
2496
    """Finds an executable on the PATH.
 
2497
    
 
2498
    On Windows, this will try to append each extension in the PATHEXT
 
2499
    environment variable to the name, if it cannot be found with the name
 
2500
    as given.
 
2501
    
 
2502
    :param name: The base name of the executable.
 
2503
    :return: The path to the executable found or None.
 
2504
    """
 
2505
    if sys.platform == 'win32':
 
2506
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
 
2507
        exts = [ext.lower() for ext in exts]
 
2508
        base, ext = os.path.splitext(name)
 
2509
        if ext != '':
 
2510
            if ext.lower() not in exts:
 
2511
                return None
 
2512
            name = base
 
2513
            exts = [ext]
 
2514
    else:
 
2515
        exts = ['']
 
2516
    path = os.environ.get('PATH')
 
2517
    if path is not None:
 
2518
        path = path.split(os.pathsep)
 
2519
        for ext in exts:
 
2520
            for d in path:
 
2521
                f = os.path.join(d, name) + ext
 
2522
                if os.access(f, os.X_OK):
 
2523
                    return f
 
2524
    if sys.platform == 'win32':
 
2525
        app_path = win32utils.get_app_path(name)
 
2526
        if app_path != name:
 
2527
            return app_path
 
2528
    return None
 
2529
 
 
2530
 
 
2531
def _posix_is_local_pid_dead(pid):
 
2532
    """True if pid doesn't correspond to live process on this machine"""
 
2533
    try:
 
2534
        # Special meaning of unix kill: just check if it's there.
 
2535
        os.kill(pid, 0)
 
2536
    except OSError, e:
 
2537
        if e.errno == errno.ESRCH:
 
2538
            # On this machine, and really not found: as sure as we can be
 
2539
            # that it's dead.
 
2540
            return True
 
2541
        elif e.errno == errno.EPERM:
 
2542
            # exists, though not ours
 
2543
            return False
 
2544
        else:
 
2545
            mutter("os.kill(%d, 0) failed: %s" % (pid, e))
 
2546
            # Don't really know.
 
2547
            return False
 
2548
    else:
 
2549
        # Exists and our process: not dead.
 
2550
        return False
 
2551
 
 
2552
if sys.platform == "win32":
 
2553
    is_local_pid_dead = win32utils.is_local_pid_dead
 
2554
else:
 
2555
    is_local_pid_dead = _posix_is_local_pid_dead
 
2556
 
 
2557
_maybe_ignored = ['EAGAIN', 'EINTR', 'ENOTSUP', 'EOPNOTSUPP', 'EACCES']
 
2558
_fdatasync_ignored = [getattr(errno, name) for name in _maybe_ignored
 
2559
                      if getattr(errno, name, None) is not None]
 
2560
 
 
2561
 
 
2562
def fdatasync(fileno):
 
2563
    """Flush file contents to disk if possible.
 
2564
    
 
2565
    :param fileno: Integer OS file handle.
 
2566
    :raises TransportNotPossible: If flushing to disk is not possible.
 
2567
    """
 
2568
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
 
2569
    if fn is not None:
 
2570
        try:
 
2571
            fn(fileno)
 
2572
        except IOError, e:
 
2573
            # See bug #1075108, on some platforms fdatasync exists, but can
 
2574
            # raise ENOTSUP. However, we are calling fdatasync to be helpful
 
2575
            # and reduce the chance of corruption-on-powerloss situations. It
 
2576
            # is not a mandatory call, so it is ok to suppress failures.
 
2577
            trace.mutter("ignoring error calling fdatasync: %s" % (e,))
 
2578
            if getattr(e, 'errno', None) not in _fdatasync_ignored:
 
2579
                raise
 
2580
 
 
2581
 
 
2582
def ensure_empty_directory_exists(path, exception_class):
 
2583
    """Make sure a local directory exists and is empty.
 
2584
    
 
2585
    If it does not exist, it is created.  If it exists and is not empty, an
 
2586
    instance of exception_class is raised.
 
2587
    """
 
2588
    try:
 
2589
        os.mkdir(path)
 
2590
    except OSError, e:
 
2591
        if e.errno != errno.EEXIST:
 
2592
            raise
 
2593
        if os.listdir(path) != []:
 
2594
            raise exception_class(path)
 
2595
 
 
2596
 
 
2597
def is_environment_error(evalue):
 
2598
    """True if exception instance is due to a process environment issue
 
2599
 
 
2600
    This includes OSError and IOError, but also other errors that come from
 
2601
    the operating system or core libraries but are not subclasses of those.
 
2602
    """
 
2603
    if isinstance(evalue, (EnvironmentError, select.error)):
 
2604
        return True
 
2605
    if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
 
2606
        return True
 
2607
    return False