~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Patch Queue Manager
  • Date: 2012-03-16 14:15:06 UTC
  • mfrom: (6503.3.1 typo-fix)
  • Revision ID: pqm@pqm.ubuntu.com-20120316141506-30gdc3wkbgmwkdus
(jelmer) Fix a typo: extention -> extension. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from __future__ import absolute_import
 
18
 
 
19
import errno
17
20
import os
18
21
import re
19
22
import stat
20
 
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
21
 
                  S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
22
23
import sys
23
24
import time
24
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.
97
97
        user_encoding = get_user_encoding()
98
98
        return [a.decode(user_encoding) for a in sys.argv[1:]]
99
99
    except UnicodeDecodeError:
100
 
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
101
 
                                                            "encoding." % a))
 
100
        raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
 
101
            "application locale.").format(a, user_encoding))
102
102
 
103
103
 
104
104
def make_readonly(filename):
106
106
    mod = os.lstat(filename).st_mode
107
107
    if not stat.S_ISLNK(mod):
108
108
        mod = mod & 0777555
109
 
        os.chmod(filename, mod)
 
109
        chmod_if_possible(filename, mod)
110
110
 
111
111
 
112
112
def make_writable(filename):
113
113
    mod = os.lstat(filename).st_mode
114
114
    if not stat.S_ISLNK(mod):
115
115
        mod = mod | 0200
116
 
        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
117
136
 
118
137
 
119
138
def minimum_path_selection(paths):
198
217
            if e.errno == errno.ENOENT:
199
218
                return False;
200
219
            else:
201
 
                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))
202
221
 
203
222
 
204
223
def fancy_rename(old, new, rename_func, unlink_func):
270
289
            else:
271
290
                rename_func(tmp_name, new)
272
291
    if failure_exc is not None:
273
 
        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
274
296
 
275
297
 
276
298
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
277
299
# choke on a Unicode string containing a relative path if
278
300
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
279
301
# string.
280
 
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
281
302
def _posix_abspath(path):
282
303
    # jam 20060426 rather than encoding to fsencoding
283
304
    # copy posixpath.abspath, but use os.getcwdu instead
284
305
    if not posixpath.isabs(path):
285
306
        path = posixpath.join(getcwd(), path)
286
 
    return posixpath.normpath(path)
 
307
    return _posix_normpath(path)
287
308
 
288
309
 
289
310
def _posix_realpath(path):
290
311
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
291
312
 
292
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
 
293
365
def _win32_fixdrive(path):
294
366
    """Force drive letters to be consistent.
295
367
 
299
371
    running python.exe under cmd.exe return capital C:\\
300
372
    running win32 python inside a cygwin shell returns lowercase c:\\
301
373
    """
302
 
    drive, path = _nt_splitdrive(path)
 
374
    drive, path = ntpath.splitdrive(path)
303
375
    return drive.upper() + path
304
376
 
305
377
 
306
378
def _win32_abspath(path):
307
 
    # Real _nt_abspath doesn't have a problem with a unicode cwd
308
 
    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('\\', '/'))
309
381
 
310
382
 
311
383
def _win98_abspath(path):
322
394
    #   /path       => C:/path
323
395
    path = unicode(path)
324
396
    # check for absolute path
325
 
    drive = _nt_splitdrive(path)[0]
 
397
    drive = ntpath.splitdrive(path)[0]
326
398
    if drive == '' and path[:2] not in('//','\\\\'):
327
399
        cwd = os.getcwdu()
328
400
        # we cannot simply os.path.join cwd and path
329
401
        # because os.path.join('C:','/path') produce '/path'
330
402
        # and this is incorrect
331
403
        if path[:1] in ('/','\\'):
332
 
            cwd = _nt_splitdrive(cwd)[0]
 
404
            cwd = ntpath.splitdrive(cwd)[0]
333
405
            path = path[1:]
334
406
        path = cwd + '\\' + path
335
 
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
 
407
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
336
408
 
337
409
 
338
410
def _win32_realpath(path):
339
 
    # Real _nt_realpath doesn't have a problem with a unicode cwd
340
 
    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('\\', '/'))
341
413
 
342
414
 
343
415
def _win32_pathjoin(*args):
344
 
    return _nt_join(*args).replace('\\', '/')
 
416
    return ntpath.join(*args).replace('\\', '/')
345
417
 
346
418
 
347
419
def _win32_normpath(path):
348
 
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
420
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
349
421
 
350
422
 
351
423
def _win32_getcwd():
378
450
    return unicodedata.normalize('NFC', os.getcwdu())
379
451
 
380
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
 
381
476
# Default is to just use the python builtins, but these can be rebound on
382
477
# particular platforms.
383
478
abspath = _posix_abspath
384
479
realpath = _posix_realpath
385
480
pathjoin = os.path.join
386
 
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
387
485
getcwd = os.getcwdu
388
 
rename = os.rename
389
486
dirname = os.path.dirname
390
487
basename = os.path.basename
391
488
split = os.path.split
392
489
splitext = os.path.splitext
393
 
# These were already imported into local scope
 
490
# These were already lazily imported into local scope
394
491
# mkdtemp = tempfile.mkdtemp
395
492
# rmtree = shutil.rmtree
 
493
lstat = os.lstat
 
494
fstat = os.fstat
 
495
 
 
496
def wrap_stat(st):
 
497
    return st
 
498
 
396
499
 
397
500
MIN_ABS_PATHLENGTH = 1
398
501
 
407
510
    normpath = _win32_normpath
408
511
    getcwd = _win32_getcwd
409
512
    mkdtemp = _win32_mkdtemp
410
 
    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
411
522
 
412
523
    MIN_ABS_PATHLENGTH = 3
413
524
 
431
542
    f = win32utils.get_unicode_argv     # special function or None
432
543
    if f is not None:
433
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
434
548
 
435
549
elif sys.platform == 'darwin':
436
550
    getcwd = _mac_getcwd
437
551
 
438
552
 
439
 
def get_terminal_encoding():
 
553
def get_terminal_encoding(trace=False):
440
554
    """Find the best encoding for printing to the screen.
441
555
 
442
556
    This attempts to check both sys.stdout and sys.stdin to see
448
562
 
449
563
    On my standard US Windows XP, the preferred encoding is
450
564
    cp1252, but the console is cp437
 
565
 
 
566
    :param trace: If True trace the selected encoding via mutter().
451
567
    """
452
568
    from bzrlib.trace import mutter
453
569
    output_encoding = getattr(sys.stdout, 'encoding', None)
455
571
        input_encoding = getattr(sys.stdin, 'encoding', None)
456
572
        if not input_encoding:
457
573
            output_encoding = get_user_encoding()
458
 
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
574
            if trace:
 
575
                mutter('encoding stdout as osutils.get_user_encoding() %r',
459
576
                   output_encoding)
460
577
        else:
461
578
            output_encoding = input_encoding
462
 
            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)
463
582
    else:
464
 
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
583
        if trace:
 
584
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
465
585
    if output_encoding == 'cp0':
466
586
        # invalid encoding (cp0 means 'no codepage' on Windows)
467
587
        output_encoding = get_user_encoding()
468
 
        mutter('cp0 is invalid encoding.'
 
588
        if trace:
 
589
            mutter('cp0 is invalid encoding.'
469
590
               ' encoding stdout as osutils.get_user_encoding() %r',
470
591
               output_encoding)
471
592
    # check encoding
497
618
def isdir(f):
498
619
    """True if f is an accessible directory."""
499
620
    try:
500
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
621
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
501
622
    except OSError:
502
623
        return False
503
624
 
505
626
def isfile(f):
506
627
    """True if f is a regular file."""
507
628
    try:
508
 
        return S_ISREG(os.lstat(f)[ST_MODE])
 
629
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
509
630
    except OSError:
510
631
        return False
511
632
 
512
633
def islink(f):
513
634
    """True if f is a symlink."""
514
635
    try:
515
 
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
636
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
516
637
    except OSError:
517
638
        return False
518
639
 
858
979
 
859
980
def filesize(f):
860
981
    """Return size of given open file."""
861
 
    return os.fstat(f.fileno())[ST_SIZE]
862
 
 
863
 
 
864
 
# Define rand_bytes based on platform.
865
 
try:
866
 
    # Python 2.4 and later have os.urandom,
867
 
    # but it doesn't work on some arches
868
 
    os.urandom(1)
869
 
    rand_bytes = os.urandom
870
 
except (NotImplementedError, AttributeError):
871
 
    # If python doesn't have os.urandom, or it doesn't work,
872
 
    # 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":
873
992
    try:
874
 
        rand_bytes = file('/dev/urandom', 'rb').read
875
 
    # Otherwise, use this hack as a last resort
876
 
    except (IOError, OSError):
 
993
        rand_bytes(1)
 
994
    except NotImplementedError:
877
995
        # not well seeded, but better than nothing
878
996
        def rand_bytes(n):
879
997
            import random
909
1027
    rps = []
910
1028
    for f in ps:
911
1029
        if f == '..':
912
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1030
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
913
1031
        elif (f == '.') or (f == ''):
914
1032
            pass
915
1033
        else:
920
1038
def joinpath(p):
921
1039
    for f in p:
922
1040
        if (f == '..') or (f is None) or (f == ''):
923
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1041
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
924
1042
    return pathjoin(*p)
925
1043
 
926
1044
 
927
1045
def parent_directories(filename):
928
1046
    """Return the list of parent directories, deepest first.
929
 
    
 
1047
 
930
1048
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
931
1049
    """
932
1050
    parents = []
956
1074
    # NB: This docstring is just an example, not a doctest, because doctest
957
1075
    # currently can't cope with the use of lazy imports in this namespace --
958
1076
    # mbp 20090729
959
 
    
 
1077
 
960
1078
    # This currently doesn't report the failure at the time it occurs, because
961
1079
    # they tend to happen very early in startup when we can't check config
962
1080
    # files etc, and also we want to report all failures but not spam the user
963
1081
    # with 10 warnings.
964
 
    from bzrlib import trace
965
1082
    exception_str = str(exception)
966
1083
    if exception_str not in _extension_load_failures:
967
1084
        trace.mutter("failed to load compiled extension: %s" % exception_str)
971
1088
def report_extension_load_failures():
972
1089
    if not _extension_load_failures:
973
1090
        return
974
 
    from bzrlib.config import GlobalConfig
975
 
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
 
1091
    if config.GlobalStack().get('ignore_missing_extensions'):
976
1092
        return
977
1093
    # the warnings framework should by default show this only once
978
1094
    from bzrlib.trace import warning
1032
1148
 
1033
1149
 
1034
1150
def delete_any(path):
1035
 
    """Delete a file, symlink or directory.  
1036
 
    
 
1151
    """Delete a file, symlink or directory.
 
1152
 
1037
1153
    Will delete even if readonly.
1038
1154
    """
1039
1155
    try:
1125
1241
 
1126
1242
 
1127
1243
def relpath(base, path):
1128
 
    """Return path relative to base, or raise exception.
 
1244
    """Return path relative to base, or raise PathNotChild exception.
1129
1245
 
1130
1246
    The path may be either an absolute path or a path relative to the
1131
1247
    current working directory.
1133
1249
    os.path.commonprefix (python2.4) has a bad bug that it works just
1134
1250
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
1135
1251
    avoids that problem.
 
1252
 
 
1253
    NOTE: `base` should not have a trailing slash otherwise you'll get
 
1254
    PathNotChild exceptions regardless of `path`.
1136
1255
    """
1137
1256
 
1138
1257
    if len(base) < MIN_ABS_PATHLENGTH:
1139
1258
        # must have space for e.g. a drive letter
1140
 
        raise ValueError('%r is too short to calculate a relative path'
 
1259
        raise ValueError(gettext('%r is too short to calculate a relative path')
1141
1260
            % (base,))
1142
1261
 
1143
1262
    rp = abspath(path)
1225
1344
    # but for now, we haven't optimized...
1226
1345
    return [canonical_relpath(base, p) for p in paths]
1227
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
 
1228
1363
def safe_unicode(unicode_or_utf8_string):
1229
1364
    """Coerce unicode_or_utf8_string into unicode.
1230
1365
 
1313
1448
def normalizes_filenames():
1314
1449
    """Return True if this platform normalizes unicode filenames.
1315
1450
 
1316
 
    Mac OSX does, Windows/Linux do not.
 
1451
    Only Mac OSX.
1317
1452
    """
1318
1453
    return _platform_normalizes_filenames
1319
1454
 
1324
1459
    On platforms where the system normalizes filenames (Mac OSX),
1325
1460
    you can access a file by any path which will normalize correctly.
1326
1461
    On platforms where the system does not normalize filenames
1327
 
    (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.
1328
1463
 
1329
1464
    Internally, bzr only supports NFC normalization, since that is
1330
1465
    the standard for XML documents.
1349
1484
    normalized_filename = _inaccessible_normalized_filename
1350
1485
 
1351
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
 
1352
1523
default_terminal_width = 80
1353
1524
"""The default terminal width for ttys.
1354
1525
 
1356
1527
terminal_width() returns None.
1357
1528
"""
1358
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
1359
1536
 
1360
1537
def terminal_width():
1361
1538
    """Return terminal width.
1365
1542
    The rules are:
1366
1543
    - if BZR_COLUMNS is set, returns its value
1367
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,
1368
1547
    - if COLUMNS is set, returns its value,
 
1548
    - if the OS has a value (even though it's never changed), return its value.
1369
1549
 
1370
1550
    From there, we need to query the OS to get the size of the controlling
1371
1551
    terminal.
1372
1552
 
1373
 
    Unices:
 
1553
    On Unices we query the OS by:
1374
1554
    - get termios.TIOCGWINSZ
1375
1555
    - if an error occurs or a negative value is obtained, returns None
1376
1556
 
1377
 
    Windows:
1378
 
    
 
1557
    On Windows we query the OS by:
1379
1558
    - win32utils.get_console_size() decides,
1380
1559
    - returns None on error (provided default value)
1381
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.
1382
1573
 
1383
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
1384
1576
    try:
1385
 
        return int(os.environ['BZR_COLUMNS'])
 
1577
        width = int(os.environ['BZR_COLUMNS'])
1386
1578
    except (KeyError, ValueError):
1387
 
        pass
 
1579
        width = None
 
1580
    if width is not None:
 
1581
        if width > 0:
 
1582
            return width
 
1583
        else:
 
1584
            return None
1388
1585
 
1389
1586
    isatty = getattr(sys.stdout, 'isatty', None)
1390
 
    if  isatty is None or not isatty():
 
1587
    if isatty is None or not isatty():
1391
1588
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1392
1589
        return None
1393
1590
 
1394
 
    # If COLUMNS is set, take it, the terminal knows better (even inside a
1395
 
    # given terminal, the application can decide to set COLUMNS to a lower
1396
 
    # 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.
1397
1608
    try:
1398
1609
        return int(os.environ['COLUMNS'])
1399
1610
    except (KeyError, ValueError):
1400
1611
        pass
1401
1612
 
1402
 
    width, height = _terminal_size(None, None)
1403
 
    if width <= 0:
1404
 
        # Consider invalid values as meaning no width
1405
 
        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
1406
1617
 
1407
 
    return width
 
1618
    # The width could not be determined.
 
1619
    return None
1408
1620
 
1409
1621
 
1410
1622
def _win32_terminal_size(width, height):
1437
1649
    _terminal_size = _ioctl_terminal_size
1438
1650
 
1439
1651
 
1440
 
def _terminal_size_changed(signum, frame):
1441
 
    """Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
1442
 
    width, height = _terminal_size(None, None)
1443
 
    if width is not None:
1444
 
        os.environ['COLUMNS'] = str(width)
1445
 
 
1446
 
 
1447
 
_registered_sigwinch = False
1448
 
 
1449
 
def watch_sigwinch():
1450
 
    """Register for SIGWINCH, once and only once."""
1451
 
    global _registered_sigwinch
1452
 
    if not _registered_sigwinch:
1453
 
        if sys.platform == 'win32':
1454
 
            # Martin (gz) mentioned WINDOW_BUFFER_SIZE_RECORD from
1455
 
            # ReadConsoleInput but I've no idea how to plug that in
1456
 
            # the current design -- vila 20091216
1457
 
            pass
1458
 
        else:
1459
 
            signal.signal(signal.SIGWINCH, _terminal_size_changed)
1460
 
        _registered_sigwinch = True
1461
 
 
1462
 
 
1463
1652
def supports_executable():
1464
1653
    return sys.platform != "win32"
1465
1654
 
1588
1777
        dirblock = []
1589
1778
        append = dirblock.append
1590
1779
        try:
1591
 
            names = sorted(_listdir(top))
 
1780
            names = sorted(map(decode_filename, _listdir(top)))
1592
1781
        except OSError, e:
1593
1782
            if not _is_error_enotdir(e):
1594
1783
                raise
1648
1837
    """
1649
1838
    global _selected_dir_reader
1650
1839
    if _selected_dir_reader is None:
1651
 
        fs_encoding = _fs_enc.upper()
1652
1840
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1653
1841
            # Win98 doesn't have unicode apis like FindFirstFileW
1654
1842
            # TODO: We possibly could support Win98 by falling back to the
1660
1848
                _selected_dir_reader = Win32ReadDir()
1661
1849
            except ImportError:
1662
1850
                pass
1663
 
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1664
 
            # ANSI_X3.4-1968 is a form of ASCII
 
1851
        elif _fs_enc in ('utf-8', 'ascii'):
1665
1852
            try:
1666
1853
                from bzrlib._readdir_pyx import UTF8DirReader
1667
1854
                _selected_dir_reader = UTF8DirReader()
1783
1970
            real_handlers[kind](abspath, relpath)
1784
1971
 
1785
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
 
1786
1998
def path_prefix_key(path):
1787
1999
    """Generate a prefix-order path key for path.
1788
2000
 
1801
2013
_cached_user_encoding = None
1802
2014
 
1803
2015
 
1804
 
def get_user_encoding(use_cache=True):
 
2016
def get_user_encoding(use_cache=DEPRECATED_PARAMETER):
1805
2017
    """Find out what the preferred user encoding is.
1806
2018
 
1807
2019
    This is generally the encoding that is used for command line parameters
1808
2020
    and file contents. This may be different from the terminal encoding
1809
2021
    or the filesystem encoding.
1810
2022
 
1811
 
    :param  use_cache:  Enable cache for detected encoding.
1812
 
                        (This parameter is turned on by default,
1813
 
                        and required only for selftesting)
1814
 
 
1815
2023
    :return: A string defining the preferred user encoding
1816
2024
    """
1817
2025
    global _cached_user_encoding
1818
 
    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:
1819
2030
        return _cached_user_encoding
1820
2031
 
1821
 
    if sys.platform == 'darwin':
1822
 
        # python locale.getpreferredencoding() always return
1823
 
        # 'mac-roman' on darwin. That's a lie.
1824
 
        sys.platform = 'posix'
1825
 
        try:
1826
 
            if os.environ.get('LANG', None) is None:
1827
 
                # If LANG is not set, we end up with 'ascii', which is bad
1828
 
                # ('mac-roman' is more than ascii), so we set a default which
1829
 
                # will give us UTF-8 (which appears to work in all cases on
1830
 
                # OSX). Users are still free to override LANG of course, as
1831
 
                # long as it give us something meaningful. This work-around
1832
 
                # *may* not be needed with python 3k and/or OSX 10.5, but will
1833
 
                # work with them too -- vila 20080908
1834
 
                os.environ['LANG'] = 'en_US.UTF-8'
1835
 
            import locale
1836
 
        finally:
1837
 
            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)
1838
2038
    else:
1839
 
        import locale
 
2039
        # GZ 2011-12-19: On windows could call GetACP directly instead.
 
2040
        user_encoding = locale.getpreferredencoding(False)
1840
2041
 
1841
2042
    try:
1842
 
        user_encoding = locale.getpreferredencoding()
1843
 
    except locale.Error, e:
1844
 
        sys.stderr.write('bzr: warning: %s\n'
1845
 
                         '  Could not determine what text encoding to use.\n'
1846
 
                         '  This error usually means your Python interpreter\n'
1847
 
                         '  doesn\'t support the locale set by $LANG (%s)\n'
1848
 
                         "  Continuing with ascii encoding.\n"
1849
 
                         % (e, os.environ.get('LANG')))
1850
 
        user_encoding = 'ascii'
1851
 
 
1852
 
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
1853
 
    # treat that as ASCII, and not support printing unicode characters to the
1854
 
    # console.
1855
 
    #
1856
 
    # For python scripts run under vim, we get '', so also treat that as ASCII
1857
 
    if user_encoding in (None, 'cp0', ''):
1858
 
        user_encoding = 'ascii'
1859
 
    else:
1860
 
        # check encoding
1861
 
        try:
1862
 
            codecs.lookup(user_encoding)
1863
 
        except LookupError:
 
2043
        user_encoding = codecs.lookup(user_encoding).name
 
2044
    except LookupError:
 
2045
        if user_encoding not in ("", "cp0"):
1864
2046
            sys.stderr.write('bzr: warning:'
1865
2047
                             ' unknown encoding %s.'
1866
2048
                             ' Continuing with ascii encoding.\n'
1867
2049
                             % user_encoding
1868
2050
                            )
1869
 
            user_encoding = 'ascii'
1870
 
 
1871
 
    if use_cache:
1872
 
        _cached_user_encoding = user_encoding
1873
 
 
 
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
1874
2063
    return user_encoding
1875
2064
 
1876
2065
 
 
2066
def get_diff_header_encoding():
 
2067
    return get_terminal_encoding()
 
2068
 
 
2069
 
1877
2070
def get_host_name():
1878
2071
    """Return the current unicode host name.
1879
2072
 
1881
2074
    behaves inconsistently on different platforms.
1882
2075
    """
1883
2076
    if sys.platform == "win32":
1884
 
        import win32utils
1885
2077
        return win32utils.get_host_name()
1886
2078
    else:
1887
2079
        import socket
1888
2080
        return socket.gethostname().decode(get_user_encoding())
1889
2081
 
1890
2082
 
1891
 
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]
 
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):
1892
2125
    """Receive an exact number of bytes.
1893
2126
 
1894
2127
    Regular Socket.recv() may return less than the requested number of bytes,
1895
 
    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
1896
2129
    on all platforms, but this should work everywhere.  This will return
1897
2130
    less than the requested amount if the remote end closes.
1898
2131
 
1899
2132
    This isn't optimized and is intended mostly for use in testing.
1900
2133
    """
1901
2134
    b = ''
1902
 
    while len(b) < bytes:
1903
 
        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))
1904
2137
        if new == '':
1905
2138
            break # eof
1906
2139
        b += new
1907
2140
    return b
1908
2141
 
1909
2142
 
1910
 
def send_all(socket, bytes, report_activity=None):
 
2143
def send_all(sock, bytes, report_activity=None):
1911
2144
    """Send all bytes on a socket.
1912
2145
 
1913
 
    Regular socket.sendall() can give socket error 10053 on Windows.  This
1914
 
    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.
1915
2152
 
1916
2153
    :param report_activity: Call this as bytes are read, see
1917
2154
        Transport._report_activity
1918
2155
    """
1919
 
    chunk_size = 2**16
1920
 
    for pos in xrange(0, len(bytes), chunk_size):
1921
 
        block = bytes[pos:pos+chunk_size]
1922
 
        if report_activity is not None:
1923
 
            report_activity(len(block), 'write')
1924
 
        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, e:
 
2162
            if e.args[0] != errno.EINTR:
 
2163
                raise
 
2164
        else:
 
2165
            sent_total += sent
 
2166
            report_activity(sent, 'write')
 
2167
 
 
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
1925
2190
 
1926
2191
 
1927
2192
def dereference_path(path):
1968
2233
    base = dirname(bzrlib.__file__)
1969
2234
    if getattr(sys, 'frozen', None):    # bzr.exe
1970
2235
        base = abspath(pathjoin(base, '..', '..'))
1971
 
    filename = pathjoin(base, resource_relpath)
1972
 
    return open(filename, 'rU').read()
1973
 
 
 
2236
    f = file(pathjoin(base, resource_relpath), "rU")
 
2237
    try:
 
2238
        return f.read()
 
2239
    finally:
 
2240
        f.close()
1974
2241
 
1975
2242
def file_kind_from_stat_mode_thunk(mode):
1976
2243
    global file_kind_from_stat_mode
1987
2254
    return file_kind_from_stat_mode(mode)
1988
2255
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
1989
2256
 
1990
 
 
1991
 
def file_kind(f, _lstat=os.lstat):
 
2257
def file_stat(f, _lstat=os.lstat):
1992
2258
    try:
1993
 
        return file_kind_from_stat_mode(_lstat(f).st_mode)
 
2259
        # XXX cache?
 
2260
        return _lstat(f)
1994
2261
    except OSError, e:
1995
2262
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
1996
2263
            raise errors.NoSuchFile(f)
1997
2264
        raise
1998
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)
1999
2269
 
2000
2270
def until_no_eintr(f, *a, **kw):
2001
 
    """Run f(*a, **kw), retrying if an EINTR error occurs."""
 
2271
    """Run f(*a, **kw), retrying if an EINTR error occurs.
 
2272
 
 
2273
    WARNING: you must be certain that it is safe to retry the call repeatedly
 
2274
    if EINTR does occur.  This is typically only true for low-level operations
 
2275
    like os.read.  If in any doubt, don't use this.
 
2276
 
 
2277
    Keep in mind that this is not a complete solution to EINTR.  There is
 
2278
    probably code in the Python standard library and other dependencies that
 
2279
    may encounter EINTR if a signal arrives (and there is signal handler for
 
2280
    that signal).  So this function can reduce the impact for IO that bzrlib
 
2281
    directly controls, but it is not a complete solution.
 
2282
    """
2002
2283
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
2003
2284
    while True:
2004
2285
        try:
2008
2289
                continue
2009
2290
            raise
2010
2291
 
 
2292
 
 
2293
@deprecated_function(deprecated_in((2, 2, 0)))
2011
2294
def re_compile_checked(re_string, flags=0, where=""):
2012
2295
    """Return a compiled re, or raise a sensible error.
2013
2296
 
2023
2306
        re_obj = re.compile(re_string, flags)
2024
2307
        re_obj.search("")
2025
2308
        return re_obj
2026
 
    except re.error, e:
 
2309
    except errors.InvalidPattern, e:
2027
2310
        if where:
2028
2311
            where = ' in ' + where
2029
2312
        # despite the name 'error' is a type
2030
 
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2031
 
            % (where, re_string, e))
 
2313
        raise errors.BzrCommandError('Invalid regular expression%s: %s'
 
2314
            % (where, e.msg))
2032
2315
 
2033
2316
 
2034
2317
if sys.platform == "win32":
2035
 
    import msvcrt
2036
2318
    def getchar():
 
2319
        import msvcrt
2037
2320
        return msvcrt.getch()
2038
2321
else:
2039
 
    import tty
2040
 
    import termios
2041
2322
    def getchar():
 
2323
        import tty
 
2324
        import termios
2042
2325
        fd = sys.stdin.fileno()
2043
2326
        settings = termios.tcgetattr(fd)
2044
2327
        try:
2048
2331
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2049
2332
        return ch
2050
2333
 
2051
 
 
2052
 
if sys.platform == 'linux2':
 
2334
if sys.platform.startswith('linux'):
2053
2335
    def _local_concurrency():
2054
 
        concurrency = None
2055
 
        prefix = 'processor'
2056
 
        for line in file('/proc/cpuinfo', 'rb'):
2057
 
            if line.startswith(prefix):
2058
 
                concurrency = int(line[line.find(':')+1:]) + 1
2059
 
        return concurrency
 
2336
        try:
 
2337
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2338
        except (ValueError, OSError, AttributeError):
 
2339
            return None
2060
2340
elif sys.platform == 'darwin':
2061
2341
    def _local_concurrency():
2062
2342
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2063
2343
                                stdout=subprocess.PIPE).communicate()[0]
2064
 
elif sys.platform[0:7] == 'freebsd':
 
2344
elif "bsd" in sys.platform:
2065
2345
    def _local_concurrency():
2066
2346
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2067
2347
                                stdout=subprocess.PIPE).communicate()[0]
2095
2375
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2096
2376
    if concurrency is None:
2097
2377
        try:
2098
 
            concurrency = _local_concurrency()
2099
 
        except (OSError, IOError):
2100
 
            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
2101
2388
    try:
2102
2389
        concurrency = int(concurrency)
2103
2390
    except (TypeError, ValueError):
2124
2411
if sys.platform == 'win32':
2125
2412
    def open_file(filename, mode='r', bufsize=-1):
2126
2413
        """This function is used to override the ``open`` builtin.
2127
 
        
 
2414
 
2128
2415
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2129
2416
        child processes.  Deleting or renaming a closed file opened with this
2130
2417
        function is not blocking child processes.
2163
2450
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2164
2451
else:
2165
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