~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Jelmer Vernooij
  • Date: 2012-02-20 14:15:25 UTC
  • mto: (6471.1.4 iter-child-entries)
  • mto: This revision was merged to the branch mainline in revision 6472.
  • Revision ID: jelmer@samba.org-20120220141525-9azkfei62st8yc7w
Use inventories directly in fewer places.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from __future__ import absolute_import
 
18
 
 
19
import errno
17
20
import os
18
21
import re
19
22
import stat
20
 
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
21
 
                  S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
22
23
import sys
23
24
import time
24
 
import warnings
 
25
import codecs
25
26
 
26
27
from bzrlib.lazy_import import lazy_import
27
28
lazy_import(globals(), """
28
 
import codecs
29
29
from datetime import datetime
30
 
import errno
31
 
from ntpath import (abspath as _nt_abspath,
32
 
                    join as _nt_join,
33
 
                    normpath as _nt_normpath,
34
 
                    realpath as _nt_realpath,
35
 
                    splitdrive as _nt_splitdrive,
36
 
                    )
 
30
import getpass
 
31
import 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():
380
455
abspath = _posix_abspath
381
456
realpath = _posix_realpath
382
457
pathjoin = os.path.join
383
 
normpath = os.path.normpath
 
458
normpath = _posix_normpath
 
459
path_from_environ = _posix_path_from_environ
 
460
_get_home_dir = _posix_get_home_dir
 
461
getuser_unicode = _posix_getuser_unicode
384
462
getcwd = os.getcwdu
385
463
rename = os.rename
386
464
dirname = os.path.dirname
387
465
basename = os.path.basename
388
466
split = os.path.split
389
467
splitext = os.path.splitext
390
 
# These were already imported into local scope
 
468
# These were already lazily imported into local scope
391
469
# mkdtemp = tempfile.mkdtemp
392
470
# rmtree = shutil.rmtree
 
471
lstat = os.lstat
 
472
fstat = os.fstat
 
473
 
 
474
def wrap_stat(st):
 
475
    return st
 
476
 
393
477
 
394
478
MIN_ABS_PATHLENGTH = 1
395
479
 
405
489
    getcwd = _win32_getcwd
406
490
    mkdtemp = _win32_mkdtemp
407
491
    rename = _win32_rename
 
492
    try:
 
493
        from bzrlib import _walkdirs_win32
 
494
    except ImportError:
 
495
        pass
 
496
    else:
 
497
        lstat = _walkdirs_win32.lstat
 
498
        fstat = _walkdirs_win32.fstat
 
499
        wrap_stat = _walkdirs_win32.wrap_stat
408
500
 
409
501
    MIN_ABS_PATHLENGTH = 3
410
502
 
428
520
    f = win32utils.get_unicode_argv     # special function or None
429
521
    if f is not None:
430
522
        get_unicode_argv = f
 
523
    path_from_environ = win32utils.get_environ_unicode
 
524
    _get_home_dir = win32utils.get_home_location
 
525
    getuser_unicode = win32utils.get_user_name
431
526
 
432
527
elif sys.platform == 'darwin':
433
528
    getcwd = _mac_getcwd
434
529
 
435
530
 
436
 
def get_terminal_encoding():
 
531
def get_terminal_encoding(trace=False):
437
532
    """Find the best encoding for printing to the screen.
438
533
 
439
534
    This attempts to check both sys.stdout and sys.stdin to see
445
540
 
446
541
    On my standard US Windows XP, the preferred encoding is
447
542
    cp1252, but the console is cp437
 
543
 
 
544
    :param trace: If True trace the selected encoding via mutter().
448
545
    """
449
546
    from bzrlib.trace import mutter
450
547
    output_encoding = getattr(sys.stdout, 'encoding', None)
452
549
        input_encoding = getattr(sys.stdin, 'encoding', None)
453
550
        if not input_encoding:
454
551
            output_encoding = get_user_encoding()
455
 
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
552
            if trace:
 
553
                mutter('encoding stdout as osutils.get_user_encoding() %r',
456
554
                   output_encoding)
457
555
        else:
458
556
            output_encoding = input_encoding
459
 
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
557
            if trace:
 
558
                mutter('encoding stdout as sys.stdin encoding %r',
 
559
                    output_encoding)
460
560
    else:
461
 
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
561
        if trace:
 
562
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
462
563
    if output_encoding == 'cp0':
463
564
        # invalid encoding (cp0 means 'no codepage' on Windows)
464
565
        output_encoding = get_user_encoding()
465
 
        mutter('cp0 is invalid encoding.'
 
566
        if trace:
 
567
            mutter('cp0 is invalid encoding.'
466
568
               ' encoding stdout as osutils.get_user_encoding() %r',
467
569
               output_encoding)
468
570
    # check encoding
494
596
def isdir(f):
495
597
    """True if f is an accessible directory."""
496
598
    try:
497
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
599
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
498
600
    except OSError:
499
601
        return False
500
602
 
502
604
def isfile(f):
503
605
    """True if f is a regular file."""
504
606
    try:
505
 
        return S_ISREG(os.lstat(f)[ST_MODE])
 
607
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
506
608
    except OSError:
507
609
        return False
508
610
 
509
611
def islink(f):
510
612
    """True if f is a symlink."""
511
613
    try:
512
 
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
614
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
513
615
    except OSError:
514
616
        return False
515
617
 
663
765
def sha_file_by_name(fname):
664
766
    """Calculate the SHA1 of a file by reading the full text"""
665
767
    s = sha()
666
 
    f = os.open(fname, os.O_RDONLY | O_BINARY)
 
768
    f = os.open(fname, os.O_RDONLY | O_BINARY | O_NOINHERIT)
667
769
    try:
668
770
        while True:
669
771
            b = os.read(f, 1<<16)
855
957
 
856
958
def filesize(f):
857
959
    """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
 
960
    return os.fstat(f.fileno())[stat.ST_SIZE]
 
961
 
 
962
 
 
963
# Alias os.urandom to support platforms (which?) without /dev/urandom and 
 
964
# override if it doesn't work. Avoid checking on windows where there is
 
965
# significant initialisation cost that can be avoided for some bzr calls.
 
966
 
 
967
rand_bytes = os.urandom
 
968
 
 
969
if rand_bytes.__module__ != "nt":
870
970
    try:
871
 
        rand_bytes = file('/dev/urandom', 'rb').read
872
 
    # Otherwise, use this hack as a last resort
873
 
    except (IOError, OSError):
 
971
        rand_bytes(1)
 
972
    except NotImplementedError:
874
973
        # not well seeded, but better than nothing
875
974
        def rand_bytes(n):
876
975
            import random
906
1005
    rps = []
907
1006
    for f in ps:
908
1007
        if f == '..':
909
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1008
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
910
1009
        elif (f == '.') or (f == ''):
911
1010
            pass
912
1011
        else:
917
1016
def joinpath(p):
918
1017
    for f in p:
919
1018
        if (f == '..') or (f is None) or (f == ''):
920
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1019
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
921
1020
    return pathjoin(*p)
922
1021
 
923
1022
 
924
1023
def parent_directories(filename):
925
1024
    """Return the list of parent directories, deepest first.
926
 
    
 
1025
 
927
1026
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
928
1027
    """
929
1028
    parents = []
953
1052
    # NB: This docstring is just an example, not a doctest, because doctest
954
1053
    # currently can't cope with the use of lazy imports in this namespace --
955
1054
    # mbp 20090729
956
 
    
 
1055
 
957
1056
    # This currently doesn't report the failure at the time it occurs, because
958
1057
    # they tend to happen very early in startup when we can't check config
959
1058
    # files etc, and also we want to report all failures but not spam the user
960
1059
    # with 10 warnings.
961
 
    from bzrlib import trace
962
1060
    exception_str = str(exception)
963
1061
    if exception_str not in _extension_load_failures:
964
1062
        trace.mutter("failed to load compiled extension: %s" % exception_str)
968
1066
def report_extension_load_failures():
969
1067
    if not _extension_load_failures:
970
1068
        return
971
 
    from bzrlib.config import GlobalConfig
972
 
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
 
1069
    if config.GlobalStack().get('ignore_missing_extensions'):
973
1070
        return
974
1071
    # the warnings framework should by default show this only once
975
1072
    from bzrlib.trace import warning
1029
1126
 
1030
1127
 
1031
1128
def delete_any(path):
1032
 
    """Delete a file, symlink or directory.  
1033
 
    
 
1129
    """Delete a file, symlink or directory.
 
1130
 
1034
1131
    Will delete even if readonly.
1035
1132
    """
1036
1133
    try:
1122
1219
 
1123
1220
 
1124
1221
def relpath(base, path):
1125
 
    """Return path relative to base, or raise exception.
 
1222
    """Return path relative to base, or raise PathNotChild exception.
1126
1223
 
1127
1224
    The path may be either an absolute path or a path relative to the
1128
1225
    current working directory.
1130
1227
    os.path.commonprefix (python2.4) has a bad bug that it works just
1131
1228
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
1132
1229
    avoids that problem.
 
1230
 
 
1231
    NOTE: `base` should not have a trailing slash otherwise you'll get
 
1232
    PathNotChild exceptions regardless of `path`.
1133
1233
    """
1134
1234
 
1135
1235
    if len(base) < MIN_ABS_PATHLENGTH:
1136
1236
        # must have space for e.g. a drive letter
1137
 
        raise ValueError('%r is too short to calculate a relative path'
 
1237
        raise ValueError(gettext('%r is too short to calculate a relative path')
1138
1238
            % (base,))
1139
1239
 
1140
1240
    rp = abspath(path)
1222
1322
    # but for now, we haven't optimized...
1223
1323
    return [canonical_relpath(base, p) for p in paths]
1224
1324
 
 
1325
 
 
1326
def decode_filename(filename):
 
1327
    """Decode the filename using the filesystem encoding
 
1328
 
 
1329
    If it is unicode, it is returned.
 
1330
    Otherwise it is decoded from the the filesystem's encoding. If decoding
 
1331
    fails, a errors.BadFilenameEncoding exception is raised.
 
1332
    """
 
1333
    if type(filename) is unicode:
 
1334
        return filename
 
1335
    try:
 
1336
        return filename.decode(_fs_enc)
 
1337
    except UnicodeDecodeError:
 
1338
        raise errors.BadFilenameEncoding(filename, _fs_enc)
 
1339
 
 
1340
 
1225
1341
def safe_unicode(unicode_or_utf8_string):
1226
1342
    """Coerce unicode_or_utf8_string into unicode.
1227
1343
 
1310
1426
def normalizes_filenames():
1311
1427
    """Return True if this platform normalizes unicode filenames.
1312
1428
 
1313
 
    Mac OSX does, Windows/Linux do not.
 
1429
    Only Mac OSX.
1314
1430
    """
1315
1431
    return _platform_normalizes_filenames
1316
1432
 
1321
1437
    On platforms where the system normalizes filenames (Mac OSX),
1322
1438
    you can access a file by any path which will normalize correctly.
1323
1439
    On platforms where the system does not normalize filenames
1324
 
    (Windows, Linux), you have to access a file by its exact path.
 
1440
    (everything else), you have to access a file by its exact path.
1325
1441
 
1326
1442
    Internally, bzr only supports NFC normalization, since that is
1327
1443
    the standard for XML documents.
1346
1462
    normalized_filename = _inaccessible_normalized_filename
1347
1463
 
1348
1464
 
 
1465
def set_signal_handler(signum, handler, restart_syscall=True):
 
1466
    """A wrapper for signal.signal that also calls siginterrupt(signum, False)
 
1467
    on platforms that support that.
 
1468
 
 
1469
    :param restart_syscall: if set, allow syscalls interrupted by a signal to
 
1470
        automatically restart (by calling `signal.siginterrupt(signum,
 
1471
        False)`).  May be ignored if the feature is not available on this
 
1472
        platform or Python version.
 
1473
    """
 
1474
    try:
 
1475
        import signal
 
1476
        siginterrupt = signal.siginterrupt
 
1477
    except ImportError:
 
1478
        # This python implementation doesn't provide signal support, hence no
 
1479
        # handler exists
 
1480
        return None
 
1481
    except AttributeError:
 
1482
        # siginterrupt doesn't exist on this platform, or for this version
 
1483
        # of Python.
 
1484
        siginterrupt = lambda signum, flag: None
 
1485
    if restart_syscall:
 
1486
        def sig_handler(*args):
 
1487
            # Python resets the siginterrupt flag when a signal is
 
1488
            # received.  <http://bugs.python.org/issue8354>
 
1489
            # As a workaround for some cases, set it back the way we want it.
 
1490
            siginterrupt(signum, False)
 
1491
            # Now run the handler function passed to set_signal_handler.
 
1492
            handler(*args)
 
1493
    else:
 
1494
        sig_handler = handler
 
1495
    old_handler = signal.signal(signum, sig_handler)
 
1496
    if restart_syscall:
 
1497
        siginterrupt(signum, False)
 
1498
    return old_handler
 
1499
 
 
1500
 
1349
1501
default_terminal_width = 80
1350
1502
"""The default terminal width for ttys.
1351
1503
 
1353
1505
terminal_width() returns None.
1354
1506
"""
1355
1507
 
 
1508
# Keep some state so that terminal_width can detect if _terminal_size has
 
1509
# returned a different size since the process started.  See docstring and
 
1510
# comments of terminal_width for details.
 
1511
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
 
1512
_terminal_size_state = 'no_data'
 
1513
_first_terminal_size = None
1356
1514
 
1357
1515
def terminal_width():
1358
1516
    """Return terminal width.
1362
1520
    The rules are:
1363
1521
    - if BZR_COLUMNS is set, returns its value
1364
1522
    - if there is no controlling terminal, returns None
 
1523
    - query the OS, if the queried size has changed since the last query,
 
1524
      return its value,
1365
1525
    - if COLUMNS is set, returns its value,
 
1526
    - if the OS has a value (even though it's never changed), return its value.
1366
1527
 
1367
1528
    From there, we need to query the OS to get the size of the controlling
1368
1529
    terminal.
1369
1530
 
1370
 
    Unices:
 
1531
    On Unices we query the OS by:
1371
1532
    - get termios.TIOCGWINSZ
1372
1533
    - if an error occurs or a negative value is obtained, returns None
1373
1534
 
1374
 
    Windows:
1375
 
    
 
1535
    On Windows we query the OS by:
1376
1536
    - win32utils.get_console_size() decides,
1377
1537
    - returns None on error (provided default value)
1378
1538
    """
 
1539
    # Note to implementors: if changing the rules for determining the width,
 
1540
    # make sure you've considered the behaviour in these cases:
 
1541
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
 
1542
    #  - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
 
1543
    #    0,0.
 
1544
    #  - (add more interesting cases here, if you find any)
 
1545
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
 
1546
    # but we don't want to register a signal handler because it is impossible
 
1547
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
 
1548
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
 
1549
    # time so we can notice if the reported size has changed, which should have
 
1550
    # a similar effect.
1379
1551
 
1380
1552
    # If BZR_COLUMNS is set, take it, user is always right
 
1553
    # Except if they specified 0 in which case, impose no limit here
1381
1554
    try:
1382
 
        return int(os.environ['BZR_COLUMNS'])
 
1555
        width = int(os.environ['BZR_COLUMNS'])
1383
1556
    except (KeyError, ValueError):
1384
 
        pass
 
1557
        width = None
 
1558
    if width is not None:
 
1559
        if width > 0:
 
1560
            return width
 
1561
        else:
 
1562
            return None
1385
1563
 
1386
1564
    isatty = getattr(sys.stdout, 'isatty', None)
1387
 
    if  isatty is None or not isatty():
 
1565
    if isatty is None or not isatty():
1388
1566
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1389
1567
        return None
1390
1568
 
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))
 
1569
    # Query the OS
 
1570
    width, height = os_size = _terminal_size(None, None)
 
1571
    global _first_terminal_size, _terminal_size_state
 
1572
    if _terminal_size_state == 'no_data':
 
1573
        _first_terminal_size = os_size
 
1574
        _terminal_size_state = 'unchanged'
 
1575
    elif (_terminal_size_state == 'unchanged' and
 
1576
          _first_terminal_size != os_size):
 
1577
        _terminal_size_state = 'changed'
 
1578
 
 
1579
    # If the OS claims to know how wide the terminal is, and this value has
 
1580
    # ever changed, use that.
 
1581
    if _terminal_size_state == 'changed':
 
1582
        if width is not None and width > 0:
 
1583
            return width
 
1584
 
 
1585
    # If COLUMNS is set, use it.
1394
1586
    try:
1395
1587
        return int(os.environ['COLUMNS'])
1396
1588
    except (KeyError, ValueError):
1397
1589
        pass
1398
1590
 
1399
 
    width, height = _terminal_size(None, None)
1400
 
    if width <= 0:
1401
 
        # Consider invalid values as meaning no width
1402
 
        return None
 
1591
    # Finally, use an unchanged size from the OS, if we have one.
 
1592
    if _terminal_size_state == 'unchanged':
 
1593
        if width is not None and width > 0:
 
1594
            return width
1403
1595
 
1404
 
    return width
 
1596
    # The width could not be determined.
 
1597
    return None
1405
1598
 
1406
1599
 
1407
1600
def _win32_terminal_size(width, height):
1434
1627
    _terminal_size = _ioctl_terminal_size
1435
1628
 
1436
1629
 
1437
 
def _terminal_size_changed(signum, frame):
1438
 
    """Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
1439
 
    width, height = _terminal_size(None, None)
1440
 
    if width is not None:
1441
 
        os.environ['COLUMNS'] = str(width)
1442
 
 
1443
 
if sys.platform == 'win32':
1444
 
    # Martin (gz) mentioned WINDOW_BUFFER_SIZE_RECORD from ReadConsoleInput but
1445
 
    # I've no idea how to plug that in the current design -- vila 20091216
1446
 
    pass
1447
 
else:
1448
 
    signal.signal(signal.SIGWINCH, _terminal_size_changed)
1449
 
 
1450
 
 
1451
1630
def supports_executable():
1452
1631
    return sys.platform != "win32"
1453
1632
 
1576
1755
        dirblock = []
1577
1756
        append = dirblock.append
1578
1757
        try:
1579
 
            names = sorted(_listdir(top))
 
1758
            names = sorted(map(decode_filename, _listdir(top)))
1580
1759
        except OSError, e:
1581
1760
            if not _is_error_enotdir(e):
1582
1761
                raise
1636
1815
    """
1637
1816
    global _selected_dir_reader
1638
1817
    if _selected_dir_reader is None:
1639
 
        fs_encoding = _fs_enc.upper()
1640
1818
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1641
1819
            # Win98 doesn't have unicode apis like FindFirstFileW
1642
1820
            # TODO: We possibly could support Win98 by falling back to the
1648
1826
                _selected_dir_reader = Win32ReadDir()
1649
1827
            except ImportError:
1650
1828
                pass
1651
 
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1652
 
            # ANSI_X3.4-1968 is a form of ASCII
 
1829
        elif _fs_enc in ('utf-8', 'ascii'):
1653
1830
            try:
1654
1831
                from bzrlib._readdir_pyx import UTF8DirReader
1655
1832
                _selected_dir_reader = UTF8DirReader()
1771
1948
            real_handlers[kind](abspath, relpath)
1772
1949
 
1773
1950
 
 
1951
def copy_ownership_from_path(dst, src=None):
 
1952
    """Copy usr/grp ownership from src file/dir to dst file/dir.
 
1953
 
 
1954
    If src is None, the containing directory is used as source. If chown
 
1955
    fails, the error is ignored and a warning is printed.
 
1956
    """
 
1957
    chown = getattr(os, 'chown', None)
 
1958
    if chown is None:
 
1959
        return
 
1960
 
 
1961
    if src == None:
 
1962
        src = os.path.dirname(dst)
 
1963
        if src == '':
 
1964
            src = '.'
 
1965
 
 
1966
    try:
 
1967
        s = os.stat(src)
 
1968
        chown(dst, s.st_uid, s.st_gid)
 
1969
    except OSError, e:
 
1970
        trace.warning(
 
1971
            'Unable to copy ownership from "%s" to "%s". '
 
1972
            'You may want to set it manually.', src, dst)
 
1973
        trace.log_exception_quietly()
 
1974
 
 
1975
 
1774
1976
def path_prefix_key(path):
1775
1977
    """Generate a prefix-order path key for path.
1776
1978
 
1789
1991
_cached_user_encoding = None
1790
1992
 
1791
1993
 
1792
 
def get_user_encoding(use_cache=True):
 
1994
def get_user_encoding(use_cache=DEPRECATED_PARAMETER):
1793
1995
    """Find out what the preferred user encoding is.
1794
1996
 
1795
1997
    This is generally the encoding that is used for command line parameters
1796
1998
    and file contents. This may be different from the terminal encoding
1797
1999
    or the filesystem encoding.
1798
2000
 
1799
 
    :param  use_cache:  Enable cache for detected encoding.
1800
 
                        (This parameter is turned on by default,
1801
 
                        and required only for selftesting)
1802
 
 
1803
2001
    :return: A string defining the preferred user encoding
1804
2002
    """
1805
2003
    global _cached_user_encoding
1806
 
    if _cached_user_encoding is not None and use_cache:
 
2004
    if deprecated_passed(use_cache):
 
2005
        warn_deprecated("use_cache should only have been used for tests",
 
2006
            DeprecationWarning, stacklevel=2) 
 
2007
    if _cached_user_encoding is not None:
1807
2008
        return _cached_user_encoding
1808
2009
 
1809
 
    if sys.platform == 'darwin':
1810
 
        # python locale.getpreferredencoding() always return
1811
 
        # 'mac-roman' on darwin. That's a lie.
1812
 
        sys.platform = 'posix'
1813
 
        try:
1814
 
            if os.environ.get('LANG', None) is None:
1815
 
                # If LANG is not set, we end up with 'ascii', which is bad
1816
 
                # ('mac-roman' is more than ascii), so we set a default which
1817
 
                # will give us UTF-8 (which appears to work in all cases on
1818
 
                # OSX). Users are still free to override LANG of course, as
1819
 
                # long as it give us something meaningful. This work-around
1820
 
                # *may* not be needed with python 3k and/or OSX 10.5, but will
1821
 
                # work with them too -- vila 20080908
1822
 
                os.environ['LANG'] = 'en_US.UTF-8'
1823
 
            import locale
1824
 
        finally:
1825
 
            sys.platform = 'darwin'
 
2010
    if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
 
2011
        # Use the existing locale settings and call nl_langinfo directly
 
2012
        # rather than going through getpreferredencoding. This avoids
 
2013
        # <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
 
2014
        # possibility of the setlocale call throwing an error.
 
2015
        user_encoding = locale.nl_langinfo(locale.CODESET)
1826
2016
    else:
1827
 
        import locale
 
2017
        # GZ 2011-12-19: On windows could call GetACP directly instead.
 
2018
        user_encoding = locale.getpreferredencoding(False)
1828
2019
 
1829
2020
    try:
1830
 
        user_encoding = locale.getpreferredencoding()
1831
 
    except locale.Error, e:
1832
 
        sys.stderr.write('bzr: warning: %s\n'
1833
 
                         '  Could not determine what text encoding to use.\n'
1834
 
                         '  This error usually means your Python interpreter\n'
1835
 
                         '  doesn\'t support the locale set by $LANG (%s)\n'
1836
 
                         "  Continuing with ascii encoding.\n"
1837
 
                         % (e, os.environ.get('LANG')))
1838
 
        user_encoding = 'ascii'
1839
 
 
1840
 
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
1841
 
    # treat that as ASCII, and not support printing unicode characters to the
1842
 
    # console.
1843
 
    #
1844
 
    # For python scripts run under vim, we get '', so also treat that as ASCII
1845
 
    if user_encoding in (None, 'cp0', ''):
1846
 
        user_encoding = 'ascii'
1847
 
    else:
1848
 
        # check encoding
1849
 
        try:
1850
 
            codecs.lookup(user_encoding)
1851
 
        except LookupError:
 
2021
        user_encoding = codecs.lookup(user_encoding).name
 
2022
    except LookupError:
 
2023
        if user_encoding not in ("", "cp0"):
1852
2024
            sys.stderr.write('bzr: warning:'
1853
2025
                             ' unknown encoding %s.'
1854
2026
                             ' Continuing with ascii encoding.\n'
1855
2027
                             % user_encoding
1856
2028
                            )
1857
 
            user_encoding = 'ascii'
1858
 
 
1859
 
    if use_cache:
1860
 
        _cached_user_encoding = user_encoding
1861
 
 
 
2029
        user_encoding = 'ascii'
 
2030
    else:
 
2031
        # Get 'ascii' when setlocale has not been called or LANG=C or unset.
 
2032
        if user_encoding == 'ascii':
 
2033
            if sys.platform == 'darwin':
 
2034
                # OSX is special-cased in Python to have a UTF-8 filesystem
 
2035
                # encoding and previously had LANG set here if not present.
 
2036
                user_encoding = 'utf-8'
 
2037
            # GZ 2011-12-19: Maybe UTF-8 should be the default in this case
 
2038
            #                for some other posix platforms as well.
 
2039
 
 
2040
    _cached_user_encoding = user_encoding
1862
2041
    return user_encoding
1863
2042
 
1864
2043
 
 
2044
def get_diff_header_encoding():
 
2045
    return get_terminal_encoding()
 
2046
 
 
2047
 
1865
2048
def get_host_name():
1866
2049
    """Return the current unicode host name.
1867
2050
 
1869
2052
    behaves inconsistently on different platforms.
1870
2053
    """
1871
2054
    if sys.platform == "win32":
1872
 
        import win32utils
1873
2055
        return win32utils.get_host_name()
1874
2056
    else:
1875
2057
        import socket
1876
2058
        return socket.gethostname().decode(get_user_encoding())
1877
2059
 
1878
2060
 
1879
 
def recv_all(socket, bytes):
 
2061
# We must not read/write any more than 64k at a time from/to a socket so we
 
2062
# don't risk "no buffer space available" errors on some platforms.  Windows in
 
2063
# particular is likely to throw WSAECONNABORTED or WSAENOBUFS if given too much
 
2064
# data at once.
 
2065
MAX_SOCKET_CHUNK = 64 * 1024
 
2066
 
 
2067
_end_of_stream_errors = [errno.ECONNRESET]
 
2068
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
 
2069
    _eno = getattr(errno, _eno, None)
 
2070
    if _eno is not None:
 
2071
        _end_of_stream_errors.append(_eno)
 
2072
del _eno
 
2073
 
 
2074
 
 
2075
def read_bytes_from_socket(sock, report_activity=None,
 
2076
        max_read_size=MAX_SOCKET_CHUNK):
 
2077
    """Read up to max_read_size of bytes from sock and notify of progress.
 
2078
 
 
2079
    Translates "Connection reset by peer" into file-like EOF (return an
 
2080
    empty string rather than raise an error), and repeats the recv if
 
2081
    interrupted by a signal.
 
2082
    """
 
2083
    while 1:
 
2084
        try:
 
2085
            bytes = sock.recv(max_read_size)
 
2086
        except socket.error, e:
 
2087
            eno = e.args[0]
 
2088
            if eno in _end_of_stream_errors:
 
2089
                # The connection was closed by the other side.  Callers expect
 
2090
                # an empty string to signal end-of-stream.
 
2091
                return ""
 
2092
            elif eno == errno.EINTR:
 
2093
                # Retry the interrupted recv.
 
2094
                continue
 
2095
            raise
 
2096
        else:
 
2097
            if report_activity is not None:
 
2098
                report_activity(len(bytes), 'read')
 
2099
            return bytes
 
2100
 
 
2101
 
 
2102
def recv_all(socket, count):
1880
2103
    """Receive an exact number of bytes.
1881
2104
 
1882
2105
    Regular Socket.recv() may return less than the requested number of bytes,
1883
 
    dependning on what's in the OS buffer.  MSG_WAITALL is not available
 
2106
    depending on what's in the OS buffer.  MSG_WAITALL is not available
1884
2107
    on all platforms, but this should work everywhere.  This will return
1885
2108
    less than the requested amount if the remote end closes.
1886
2109
 
1887
2110
    This isn't optimized and is intended mostly for use in testing.
1888
2111
    """
1889
2112
    b = ''
1890
 
    while len(b) < bytes:
1891
 
        new = until_no_eintr(socket.recv, bytes - len(b))
 
2113
    while len(b) < count:
 
2114
        new = read_bytes_from_socket(socket, None, count - len(b))
1892
2115
        if new == '':
1893
2116
            break # eof
1894
2117
        b += new
1895
2118
    return b
1896
2119
 
1897
2120
 
1898
 
def send_all(socket, bytes, report_activity=None):
 
2121
def send_all(sock, bytes, report_activity=None):
1899
2122
    """Send all bytes on a socket.
1900
2123
 
1901
 
    Regular socket.sendall() can give socket error 10053 on Windows.  This
1902
 
    implementation sends no more than 64k at a time, which avoids this problem.
 
2124
    Breaks large blocks in smaller chunks to avoid buffering limitations on
 
2125
    some platforms, and catches EINTR which may be thrown if the send is
 
2126
    interrupted by a signal.
 
2127
 
 
2128
    This is preferred to socket.sendall(), because it avoids portability bugs
 
2129
    and provides activity reporting.
1903
2130
 
1904
2131
    :param report_activity: Call this as bytes are read, see
1905
2132
        Transport._report_activity
1906
2133
    """
1907
 
    chunk_size = 2**16
1908
 
    for pos in xrange(0, len(bytes), chunk_size):
1909
 
        block = bytes[pos:pos+chunk_size]
1910
 
        if report_activity is not None:
1911
 
            report_activity(len(block), 'write')
1912
 
        until_no_eintr(socket.sendall, block)
 
2134
    sent_total = 0
 
2135
    byte_count = len(bytes)
 
2136
    while sent_total < byte_count:
 
2137
        try:
 
2138
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
 
2139
        except socket.error, e:
 
2140
            if e.args[0] != errno.EINTR:
 
2141
                raise
 
2142
        else:
 
2143
            sent_total += sent
 
2144
            report_activity(sent, 'write')
 
2145
 
 
2146
 
 
2147
def connect_socket(address):
 
2148
    # Slight variation of the socket.create_connection() function (provided by
 
2149
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
 
2150
    # provide it for previous python versions. Also, we don't use the timeout
 
2151
    # parameter (provided by the python implementation) so we don't implement
 
2152
    # it either).
 
2153
    err = socket.error('getaddrinfo returns an empty list')
 
2154
    host, port = address
 
2155
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
 
2156
        af, socktype, proto, canonname, sa = res
 
2157
        sock = None
 
2158
        try:
 
2159
            sock = socket.socket(af, socktype, proto)
 
2160
            sock.connect(sa)
 
2161
            return sock
 
2162
 
 
2163
        except socket.error, err:
 
2164
            # 'err' is now the most recent error
 
2165
            if sock is not None:
 
2166
                sock.close()
 
2167
    raise err
1913
2168
 
1914
2169
 
1915
2170
def dereference_path(path):
1956
2211
    base = dirname(bzrlib.__file__)
1957
2212
    if getattr(sys, 'frozen', None):    # bzr.exe
1958
2213
        base = abspath(pathjoin(base, '..', '..'))
1959
 
    filename = pathjoin(base, resource_relpath)
1960
 
    return open(filename, 'rU').read()
1961
 
 
 
2214
    f = file(pathjoin(base, resource_relpath), "rU")
 
2215
    try:
 
2216
        return f.read()
 
2217
    finally:
 
2218
        f.close()
1962
2219
 
1963
2220
def file_kind_from_stat_mode_thunk(mode):
1964
2221
    global file_kind_from_stat_mode
1975
2232
    return file_kind_from_stat_mode(mode)
1976
2233
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
1977
2234
 
1978
 
 
1979
 
def file_kind(f, _lstat=os.lstat):
 
2235
def file_stat(f, _lstat=os.lstat):
1980
2236
    try:
1981
 
        return file_kind_from_stat_mode(_lstat(f).st_mode)
 
2237
        # XXX cache?
 
2238
        return _lstat(f)
1982
2239
    except OSError, e:
1983
2240
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
1984
2241
            raise errors.NoSuchFile(f)
1985
2242
        raise
1986
2243
 
 
2244
def file_kind(f, _lstat=os.lstat):
 
2245
    stat_value = file_stat(f, _lstat)
 
2246
    return file_kind_from_stat_mode(stat_value.st_mode)
1987
2247
 
1988
2248
def until_no_eintr(f, *a, **kw):
1989
 
    """Run f(*a, **kw), retrying if an EINTR error occurs."""
 
2249
    """Run f(*a, **kw), retrying if an EINTR error occurs.
 
2250
 
 
2251
    WARNING: you must be certain that it is safe to retry the call repeatedly
 
2252
    if EINTR does occur.  This is typically only true for low-level operations
 
2253
    like os.read.  If in any doubt, don't use this.
 
2254
 
 
2255
    Keep in mind that this is not a complete solution to EINTR.  There is
 
2256
    probably code in the Python standard library and other dependencies that
 
2257
    may encounter EINTR if a signal arrives (and there is signal handler for
 
2258
    that signal).  So this function can reduce the impact for IO that bzrlib
 
2259
    directly controls, but it is not a complete solution.
 
2260
    """
1990
2261
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
1991
2262
    while True:
1992
2263
        try:
1996
2267
                continue
1997
2268
            raise
1998
2269
 
 
2270
 
 
2271
@deprecated_function(deprecated_in((2, 2, 0)))
1999
2272
def re_compile_checked(re_string, flags=0, where=""):
2000
2273
    """Return a compiled re, or raise a sensible error.
2001
2274
 
2011
2284
        re_obj = re.compile(re_string, flags)
2012
2285
        re_obj.search("")
2013
2286
        return re_obj
2014
 
    except re.error, e:
 
2287
    except errors.InvalidPattern, e:
2015
2288
        if where:
2016
2289
            where = ' in ' + where
2017
2290
        # despite the name 'error' is a type
2018
 
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2019
 
            % (where, re_string, e))
 
2291
        raise errors.BzrCommandError('Invalid regular expression%s: %s'
 
2292
            % (where, e.msg))
2020
2293
 
2021
2294
 
2022
2295
if sys.platform == "win32":
2023
 
    import msvcrt
2024
2296
    def getchar():
 
2297
        import msvcrt
2025
2298
        return msvcrt.getch()
2026
2299
else:
2027
 
    import tty
2028
 
    import termios
2029
2300
    def getchar():
 
2301
        import tty
 
2302
        import termios
2030
2303
        fd = sys.stdin.fileno()
2031
2304
        settings = termios.tcgetattr(fd)
2032
2305
        try:
2036
2309
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2037
2310
        return ch
2038
2311
 
2039
 
 
2040
 
if sys.platform == 'linux2':
 
2312
if sys.platform.startswith('linux'):
2041
2313
    def _local_concurrency():
2042
 
        concurrency = None
2043
 
        prefix = 'processor'
2044
 
        for line in file('/proc/cpuinfo', 'rb'):
2045
 
            if line.startswith(prefix):
2046
 
                concurrency = int(line[line.find(':')+1:]) + 1
2047
 
        return concurrency
 
2314
        try:
 
2315
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2316
        except (ValueError, OSError, AttributeError):
 
2317
            return None
2048
2318
elif sys.platform == 'darwin':
2049
2319
    def _local_concurrency():
2050
2320
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2051
2321
                                stdout=subprocess.PIPE).communicate()[0]
2052
 
elif sys.platform[0:7] == 'freebsd':
 
2322
elif "bsd" in sys.platform:
2053
2323
    def _local_concurrency():
2054
2324
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2055
2325
                                stdout=subprocess.PIPE).communicate()[0]
2083
2353
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2084
2354
    if concurrency is None:
2085
2355
        try:
2086
 
            concurrency = _local_concurrency()
2087
 
        except (OSError, IOError):
2088
 
            pass
 
2356
            import multiprocessing
 
2357
            concurrency = multiprocessing.cpu_count()
 
2358
        except (ImportError, NotImplementedError):
 
2359
            # multiprocessing is only available on Python >= 2.6
 
2360
            # and multiprocessing.cpu_count() isn't implemented on all
 
2361
            # platforms
 
2362
            try:
 
2363
                concurrency = _local_concurrency()
 
2364
            except (OSError, IOError):
 
2365
                pass
2089
2366
    try:
2090
2367
        concurrency = int(concurrency)
2091
2368
    except (TypeError, ValueError):
2108
2385
        else:
2109
2386
            data, _ = self.encode(object, self.errors)
2110
2387
            self.stream.write(data)
 
2388
 
 
2389
if sys.platform == 'win32':
 
2390
    def open_file(filename, mode='r', bufsize=-1):
 
2391
        """This function is used to override the ``open`` builtin.
 
2392
 
 
2393
        But it uses O_NOINHERIT flag so the file handle is not inherited by
 
2394
        child processes.  Deleting or renaming a closed file opened with this
 
2395
        function is not blocking child processes.
 
2396
        """
 
2397
        writing = 'w' in mode
 
2398
        appending = 'a' in mode
 
2399
        updating = '+' in mode
 
2400
        binary = 'b' in mode
 
2401
 
 
2402
        flags = O_NOINHERIT
 
2403
        # see http://msdn.microsoft.com/en-us/library/yeby3zcb%28VS.71%29.aspx
 
2404
        # for flags for each modes.
 
2405
        if binary:
 
2406
            flags |= O_BINARY
 
2407
        else:
 
2408
            flags |= O_TEXT
 
2409
 
 
2410
        if writing:
 
2411
            if updating:
 
2412
                flags |= os.O_RDWR
 
2413
            else:
 
2414
                flags |= os.O_WRONLY
 
2415
            flags |= os.O_CREAT | os.O_TRUNC
 
2416
        elif appending:
 
2417
            if updating:
 
2418
                flags |= os.O_RDWR
 
2419
            else:
 
2420
                flags |= os.O_WRONLY
 
2421
            flags |= os.O_CREAT | os.O_APPEND
 
2422
        else: #reading
 
2423
            if updating:
 
2424
                flags |= os.O_RDWR
 
2425
            else:
 
2426
                flags |= os.O_RDONLY
 
2427
 
 
2428
        return os.fdopen(os.open(filename, flags), mode, bufsize)
 
2429
else:
 
2430
    open_file = open
 
2431
 
 
2432
 
 
2433
def available_backup_name(base, exists):
 
2434
    """Find a non-existing backup file name.
 
2435
 
 
2436
    This will *not* create anything, this only return a 'free' entry.  This
 
2437
    should be used for checking names in a directory below a locked
 
2438
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
 
2439
    Leap) and generally discouraged.
 
2440
 
 
2441
    :param base: The base name.
 
2442
 
 
2443
    :param exists: A callable returning True if the path parameter exists.
 
2444
    """
 
2445
    counter = 1
 
2446
    name = "%s.~%d~" % (base, counter)
 
2447
    while exists(name):
 
2448
        counter += 1
 
2449
        name = "%s.~%d~" % (base, counter)
 
2450
    return name
 
2451
 
 
2452
 
 
2453
def set_fd_cloexec(fd):
 
2454
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
 
2455
    support for this is not available.
 
2456
    """
 
2457
    try:
 
2458
        import fcntl
 
2459
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
 
2460
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
 
2461
    except (ImportError, AttributeError):
 
2462
        # Either the fcntl module or specific constants are not present
 
2463
        pass
 
2464
 
 
2465
 
 
2466
def find_executable_on_path(name):
 
2467
    """Finds an executable on the PATH.
 
2468
    
 
2469
    On Windows, this will try to append each extension in the PATHEXT
 
2470
    environment variable to the name, if it cannot be found with the name
 
2471
    as given.
 
2472
    
 
2473
    :param name: The base name of the executable.
 
2474
    :return: The path to the executable found or None.
 
2475
    """
 
2476
    path = os.environ.get('PATH')
 
2477
    if path is None:
 
2478
        return None
 
2479
    path = path.split(os.pathsep)
 
2480
    if sys.platform == 'win32':
 
2481
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
 
2482
        exts = [ext.lower() for ext in exts]
 
2483
        base, ext = os.path.splitext(name)
 
2484
        if ext != '':
 
2485
            if ext.lower() not in exts:
 
2486
                return None
 
2487
            name = base
 
2488
            exts = [ext]
 
2489
    else:
 
2490
        exts = ['']
 
2491
    for ext in exts:
 
2492
        for d in path:
 
2493
            f = os.path.join(d, name) + ext
 
2494
            if os.access(f, os.X_OK):
 
2495
                return f
 
2496
    return None
 
2497
 
 
2498
 
 
2499
def _posix_is_local_pid_dead(pid):
 
2500
    """True if pid doesn't correspond to live process on this machine"""
 
2501
    try:
 
2502
        # Special meaning of unix kill: just check if it's there.
 
2503
        os.kill(pid, 0)
 
2504
    except OSError, e:
 
2505
        if e.errno == errno.ESRCH:
 
2506
            # On this machine, and really not found: as sure as we can be
 
2507
            # that it's dead.
 
2508
            return True
 
2509
        elif e.errno == errno.EPERM:
 
2510
            # exists, though not ours
 
2511
            return False
 
2512
        else:
 
2513
            mutter("os.kill(%d, 0) failed: %s" % (pid, e))
 
2514
            # Don't really know.
 
2515
            return False
 
2516
    else:
 
2517
        # Exists and our process: not dead.
 
2518
        return False
 
2519
 
 
2520
if sys.platform == "win32":
 
2521
    is_local_pid_dead = win32utils.is_local_pid_dead
 
2522
else:
 
2523
    is_local_pid_dead = _posix_is_local_pid_dead
 
2524
 
 
2525
 
 
2526
def fdatasync(fileno):
 
2527
    """Flush file contents to disk if possible.
 
2528
    
 
2529
    :param fileno: Integer OS file handle.
 
2530
    :raises TransportNotPossible: If flushing to disk is not possible.
 
2531
    """
 
2532
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
 
2533
    if fn is not None:
 
2534
        fn(fileno)
 
2535
 
 
2536
 
 
2537
def ensure_empty_directory_exists(path, exception_class):
 
2538
    """Make sure a local directory exists and is empty.
 
2539
    
 
2540
    If it does not exist, it is created.  If it exists and is not empty, an
 
2541
    instance of exception_class is raised.
 
2542
    """
 
2543
    try:
 
2544
        os.mkdir(path)
 
2545
    except OSError, e:
 
2546
        if e.errno != errno.EEXIST:
 
2547
            raise
 
2548
        if os.listdir(path) != []:
 
2549
            raise exception_class(path)
 
2550
 
 
2551
 
 
2552
def is_environment_error(evalue):
 
2553
    """True if exception instance is due to a process environment issue
 
2554
 
 
2555
    This includes OSError and IOError, but also other errors that come from
 
2556
    the operating system or core libraries but are not subclasses of those.
 
2557
    """
 
2558
    if isinstance(evalue, (EnvironmentError, select.error)):
 
2559
        return True
 
2560
    if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
 
2561
        return True
 
2562
    return False