~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-03-25 00:02:51 UTC
  • mfrom: (5106.1.1 version-bump)
  • Revision ID: pqm@pqm.ubuntu.com-20100325000251-bwsv5c5d3l9x3lnn
(Jelmer) Bump API version for 2.2.0.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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
20
17
import os
21
18
import re
22
19
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)
23
22
import sys
24
23
import time
25
24
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 getpass
31
 
import locale
32
 
import ntpath
 
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
                    )
33
37
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
37
38
import shutil
38
 
from shutil import rmtree
39
 
import socket
 
39
from shutil import (
 
40
    rmtree,
 
41
    )
 
42
import signal
40
43
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
43
44
import tempfile
44
 
from tempfile import mkdtemp
 
45
from tempfile import (
 
46
    mkdtemp,
 
47
    )
45
48
import unicodedata
46
49
 
47
50
from bzrlib import (
48
51
    cache_utf8,
49
 
    config,
50
52
    errors,
 
53
    win32utils,
51
54
    trace,
52
 
    win32utils,
53
55
    )
54
 
from bzrlib.i18n import gettext
 
56
 
55
57
""")
56
58
 
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
 
    )
 
59
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
 
60
# of 2.5
 
61
if sys.version_info < (2, 5):
 
62
    import md5 as _mod_md5
 
63
    md5 = _mod_md5.new
 
64
    import sha as _mod_sha
 
65
    sha = _mod_sha.new
 
66
else:
 
67
    from hashlib import (
 
68
        md5,
 
69
        sha1 as sha,
 
70
        )
69
71
 
70
72
 
71
73
import bzrlib
72
 
from bzrlib import symbol_versioning, _fs_enc
 
74
from bzrlib import symbol_versioning
73
75
 
74
76
 
75
77
# Cross platform wall-clock time functionality with decent resolution.
97
99
        user_encoding = get_user_encoding()
98
100
        return [a.decode(user_encoding) for a in sys.argv[1:]]
99
101
    except UnicodeDecodeError:
100
 
        raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
101
 
            "application locale.").format(a, user_encoding))
 
102
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
 
103
                                                            "encoding." % a))
102
104
 
103
105
 
104
106
def make_readonly(filename):
106
108
    mod = os.lstat(filename).st_mode
107
109
    if not stat.S_ISLNK(mod):
108
110
        mod = mod & 0777555
109
 
        chmod_if_possible(filename, mod)
 
111
        os.chmod(filename, mod)
110
112
 
111
113
 
112
114
def make_writable(filename):
113
115
    mod = os.lstat(filename).st_mode
114
116
    if not stat.S_ISLNK(mod):
115
117
        mod = mod | 0200
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
 
118
        os.chmod(filename, mod)
136
119
 
137
120
 
138
121
def minimum_path_selection(paths):
217
200
            if e.errno == errno.ENOENT:
218
201
                return False;
219
202
            else:
220
 
                raise errors.BzrError(gettext("lstat/stat of ({0!r}): {1!r}").format(f, e))
 
203
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
221
204
 
222
205
 
223
206
def fancy_rename(old, new, rename_func, unlink_func):
289
272
            else:
290
273
                rename_func(tmp_name, new)
291
274
    if failure_exc is not None:
292
 
        try:
293
 
            raise failure_exc[0], failure_exc[1], failure_exc[2]
294
 
        finally:
295
 
            del failure_exc
 
275
        raise failure_exc[0], failure_exc[1], failure_exc[2]
296
276
 
297
277
 
298
278
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
299
279
# choke on a Unicode string containing a relative path if
300
280
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
301
281
# string.
 
282
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
302
283
def _posix_abspath(path):
303
284
    # jam 20060426 rather than encoding to fsencoding
304
285
    # copy posixpath.abspath, but use os.getcwdu instead
305
286
    if not posixpath.isabs(path):
306
287
        path = posixpath.join(getcwd(), path)
307
 
    return _posix_normpath(path)
 
288
    return posixpath.normpath(path)
308
289
 
309
290
 
310
291
def _posix_realpath(path):
311
292
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
312
293
 
313
294
 
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
 
 
365
295
def _win32_fixdrive(path):
366
296
    """Force drive letters to be consistent.
367
297
 
371
301
    running python.exe under cmd.exe return capital C:\\
372
302
    running win32 python inside a cygwin shell returns lowercase c:\\
373
303
    """
374
 
    drive, path = ntpath.splitdrive(path)
 
304
    drive, path = _nt_splitdrive(path)
375
305
    return drive.upper() + path
376
306
 
377
307
 
378
308
def _win32_abspath(path):
379
 
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
380
 
    return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
 
309
    # Real _nt_abspath doesn't have a problem with a unicode cwd
 
310
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
381
311
 
382
312
 
383
313
def _win98_abspath(path):
394
324
    #   /path       => C:/path
395
325
    path = unicode(path)
396
326
    # check for absolute path
397
 
    drive = ntpath.splitdrive(path)[0]
 
327
    drive = _nt_splitdrive(path)[0]
398
328
    if drive == '' and path[:2] not in('//','\\\\'):
399
329
        cwd = os.getcwdu()
400
330
        # we cannot simply os.path.join cwd and path
401
331
        # because os.path.join('C:','/path') produce '/path'
402
332
        # and this is incorrect
403
333
        if path[:1] in ('/','\\'):
404
 
            cwd = ntpath.splitdrive(cwd)[0]
 
334
            cwd = _nt_splitdrive(cwd)[0]
405
335
            path = path[1:]
406
336
        path = cwd + '\\' + path
407
 
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
 
337
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
408
338
 
409
339
 
410
340
def _win32_realpath(path):
411
 
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
412
 
    return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
 
341
    # Real _nt_realpath doesn't have a problem with a unicode cwd
 
342
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
413
343
 
414
344
 
415
345
def _win32_pathjoin(*args):
416
 
    return ntpath.join(*args).replace('\\', '/')
 
346
    return _nt_join(*args).replace('\\', '/')
417
347
 
418
348
 
419
349
def _win32_normpath(path):
420
 
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
 
350
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
421
351
 
422
352
 
423
353
def _win32_getcwd():
450
380
    return unicodedata.normalize('NFC', os.getcwdu())
451
381
 
452
382
 
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
 
 
476
383
# Default is to just use the python builtins, but these can be rebound on
477
384
# particular platforms.
478
385
abspath = _posix_abspath
479
386
realpath = _posix_realpath
480
387
pathjoin = os.path.join
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
 
388
normpath = os.path.normpath
485
389
getcwd = os.getcwdu
 
390
rename = os.rename
486
391
dirname = os.path.dirname
487
392
basename = os.path.basename
488
393
split = os.path.split
489
394
splitext = os.path.splitext
490
 
# These were already lazily imported into local scope
 
395
# These were already imported into local scope
491
396
# mkdtemp = tempfile.mkdtemp
492
397
# rmtree = shutil.rmtree
493
 
lstat = os.lstat
494
 
fstat = os.fstat
495
 
 
496
 
def wrap_stat(st):
497
 
    return st
498
 
 
499
398
 
500
399
MIN_ABS_PATHLENGTH = 1
501
400
 
510
409
    normpath = _win32_normpath
511
410
    getcwd = _win32_getcwd
512
411
    mkdtemp = _win32_mkdtemp
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
 
412
    rename = _win32_rename
522
413
 
523
414
    MIN_ABS_PATHLENGTH = 3
524
415
 
542
433
    f = win32utils.get_unicode_argv     # special function or None
543
434
    if f is not None:
544
435
        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
548
436
 
549
437
elif sys.platform == 'darwin':
550
438
    getcwd = _mac_getcwd
551
439
 
552
440
 
553
 
def get_terminal_encoding(trace=False):
 
441
def get_terminal_encoding():
554
442
    """Find the best encoding for printing to the screen.
555
443
 
556
444
    This attempts to check both sys.stdout and sys.stdin to see
562
450
 
563
451
    On my standard US Windows XP, the preferred encoding is
564
452
    cp1252, but the console is cp437
565
 
 
566
 
    :param trace: If True trace the selected encoding via mutter().
567
453
    """
568
454
    from bzrlib.trace import mutter
569
455
    output_encoding = getattr(sys.stdout, 'encoding', None)
571
457
        input_encoding = getattr(sys.stdin, 'encoding', None)
572
458
        if not input_encoding:
573
459
            output_encoding = get_user_encoding()
574
 
            if trace:
575
 
                mutter('encoding stdout as osutils.get_user_encoding() %r',
 
460
            mutter('encoding stdout as osutils.get_user_encoding() %r',
576
461
                   output_encoding)
577
462
        else:
578
463
            output_encoding = input_encoding
579
 
            if trace:
580
 
                mutter('encoding stdout as sys.stdin encoding %r',
581
 
                    output_encoding)
 
464
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
582
465
    else:
583
 
        if trace:
584
 
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
466
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
585
467
    if output_encoding == 'cp0':
586
468
        # invalid encoding (cp0 means 'no codepage' on Windows)
587
469
        output_encoding = get_user_encoding()
588
 
        if trace:
589
 
            mutter('cp0 is invalid encoding.'
 
470
        mutter('cp0 is invalid encoding.'
590
471
               ' encoding stdout as osutils.get_user_encoding() %r',
591
472
               output_encoding)
592
473
    # check encoding
618
499
def isdir(f):
619
500
    """True if f is an accessible directory."""
620
501
    try:
621
 
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
 
502
        return S_ISDIR(os.lstat(f)[ST_MODE])
622
503
    except OSError:
623
504
        return False
624
505
 
626
507
def isfile(f):
627
508
    """True if f is a regular file."""
628
509
    try:
629
 
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
 
510
        return S_ISREG(os.lstat(f)[ST_MODE])
630
511
    except OSError:
631
512
        return False
632
513
 
633
514
def islink(f):
634
515
    """True if f is a symlink."""
635
516
    try:
636
 
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
 
517
        return S_ISLNK(os.lstat(f)[ST_MODE])
637
518
    except OSError:
638
519
        return False
639
520
 
979
860
 
980
861
def filesize(f):
981
862
    """Return size of given open file."""
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":
 
863
    return os.fstat(f.fileno())[ST_SIZE]
 
864
 
 
865
 
 
866
# Define rand_bytes based on platform.
 
867
try:
 
868
    # Python 2.4 and later have os.urandom,
 
869
    # but it doesn't work on some arches
 
870
    os.urandom(1)
 
871
    rand_bytes = os.urandom
 
872
except (NotImplementedError, AttributeError):
 
873
    # If python doesn't have os.urandom, or it doesn't work,
 
874
    # then try to first pull random data from /dev/urandom
992
875
    try:
993
 
        rand_bytes(1)
994
 
    except NotImplementedError:
 
876
        rand_bytes = file('/dev/urandom', 'rb').read
 
877
    # Otherwise, use this hack as a last resort
 
878
    except (IOError, OSError):
995
879
        # not well seeded, but better than nothing
996
880
        def rand_bytes(n):
997
881
            import random
1027
911
    rps = []
1028
912
    for f in ps:
1029
913
        if f == '..':
1030
 
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
 
914
            raise errors.BzrError("sorry, %r not allowed in path" % f)
1031
915
        elif (f == '.') or (f == ''):
1032
916
            pass
1033
917
        else:
1038
922
def joinpath(p):
1039
923
    for f in p:
1040
924
        if (f == '..') or (f is None) or (f == ''):
1041
 
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
 
925
            raise errors.BzrError("sorry, %r not allowed in path" % f)
1042
926
    return pathjoin(*p)
1043
927
 
1044
928
 
1045
929
def parent_directories(filename):
1046
930
    """Return the list of parent directories, deepest first.
1047
 
 
 
931
    
1048
932
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
1049
933
    """
1050
934
    parents = []
1074
958
    # NB: This docstring is just an example, not a doctest, because doctest
1075
959
    # currently can't cope with the use of lazy imports in this namespace --
1076
960
    # mbp 20090729
1077
 
 
 
961
    
1078
962
    # This currently doesn't report the failure at the time it occurs, because
1079
963
    # they tend to happen very early in startup when we can't check config
1080
964
    # files etc, and also we want to report all failures but not spam the user
1081
965
    # with 10 warnings.
 
966
    from bzrlib import trace
1082
967
    exception_str = str(exception)
1083
968
    if exception_str not in _extension_load_failures:
1084
969
        trace.mutter("failed to load compiled extension: %s" % exception_str)
1088
973
def report_extension_load_failures():
1089
974
    if not _extension_load_failures:
1090
975
        return
1091
 
    if config.GlobalStack().get('ignore_missing_extensions'):
 
976
    from bzrlib.config import GlobalConfig
 
977
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
1092
978
        return
1093
979
    # the warnings framework should by default show this only once
1094
980
    from bzrlib.trace import warning
1148
1034
 
1149
1035
 
1150
1036
def delete_any(path):
1151
 
    """Delete a file, symlink or directory.
1152
 
 
 
1037
    """Delete a file, symlink or directory.  
 
1038
    
1153
1039
    Will delete even if readonly.
1154
1040
    """
1155
1041
    try:
1241
1127
 
1242
1128
 
1243
1129
def relpath(base, path):
1244
 
    """Return path relative to base, or raise PathNotChild exception.
 
1130
    """Return path relative to base, or raise exception.
1245
1131
 
1246
1132
    The path may be either an absolute path or a path relative to the
1247
1133
    current working directory.
1249
1135
    os.path.commonprefix (python2.4) has a bad bug that it works just
1250
1136
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
1251
1137
    avoids that problem.
1252
 
 
1253
 
    NOTE: `base` should not have a trailing slash otherwise you'll get
1254
 
    PathNotChild exceptions regardless of `path`.
1255
1138
    """
1256
1139
 
1257
1140
    if len(base) < MIN_ABS_PATHLENGTH:
1258
1141
        # must have space for e.g. a drive letter
1259
 
        raise ValueError(gettext('%r is too short to calculate a relative path')
 
1142
        raise ValueError('%r is too short to calculate a relative path'
1260
1143
            % (base,))
1261
1144
 
1262
1145
    rp = abspath(path)
1344
1227
    # but for now, we haven't optimized...
1345
1228
    return [canonical_relpath(base, p) for p in paths]
1346
1229
 
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
 
 
1363
1230
def safe_unicode(unicode_or_utf8_string):
1364
1231
    """Coerce unicode_or_utf8_string into unicode.
1365
1232
 
1448
1315
def normalizes_filenames():
1449
1316
    """Return True if this platform normalizes unicode filenames.
1450
1317
 
1451
 
    Only Mac OSX.
 
1318
    Mac OSX does, Windows/Linux do not.
1452
1319
    """
1453
1320
    return _platform_normalizes_filenames
1454
1321
 
1459
1326
    On platforms where the system normalizes filenames (Mac OSX),
1460
1327
    you can access a file by any path which will normalize correctly.
1461
1328
    On platforms where the system does not normalize filenames
1462
 
    (everything else), you have to access a file by its exact path.
 
1329
    (Windows, Linux), you have to access a file by its exact path.
1463
1330
 
1464
1331
    Internally, bzr only supports NFC normalization, since that is
1465
1332
    the standard for XML documents.
1493
1360
        False)`).  May be ignored if the feature is not available on this
1494
1361
        platform or Python version.
1495
1362
    """
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
 
1363
    old_handler = signal.signal(signum, handler)
1507
1364
    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.
 
1365
        try:
 
1366
            siginterrupt = signal.siginterrupt
 
1367
        except AttributeError: # siginterrupt doesn't exist on this platform, or for this version of
 
1368
            # Python.
 
1369
            pass
 
1370
        else:
1512
1371
            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
1372
    return old_handler
1521
1373
 
1522
1374
 
1527
1379
terminal_width() returns None.
1528
1380
"""
1529
1381
 
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
1536
1382
 
1537
1383
def terminal_width():
1538
1384
    """Return terminal width.
1542
1388
    The rules are:
1543
1389
    - if BZR_COLUMNS is set, returns its value
1544
1390
    - 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,
1547
1391
    - if COLUMNS is set, returns its value,
1548
 
    - if the OS has a value (even though it's never changed), return its value.
1549
1392
 
1550
1393
    From there, we need to query the OS to get the size of the controlling
1551
1394
    terminal.
1552
1395
 
1553
 
    On Unices we query the OS by:
 
1396
    Unices:
1554
1397
    - get termios.TIOCGWINSZ
1555
1398
    - if an error occurs or a negative value is obtained, returns None
1556
1399
 
1557
 
    On Windows we query the OS by:
 
1400
    Windows:
 
1401
    
1558
1402
    - win32utils.get_console_size() decides,
1559
1403
    - returns None on error (provided default value)
1560
1404
    """
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.
1573
1405
 
1574
1406
    # If BZR_COLUMNS is set, take it, user is always right
1575
 
    # Except if they specified 0 in which case, impose no limit here
1576
1407
    try:
1577
 
        width = int(os.environ['BZR_COLUMNS'])
 
1408
        return int(os.environ['BZR_COLUMNS'])
1578
1409
    except (KeyError, ValueError):
1579
 
        width = None
1580
 
    if width is not None:
1581
 
        if width > 0:
1582
 
            return width
1583
 
        else:
1584
 
            return None
 
1410
        pass
1585
1411
 
1586
1412
    isatty = getattr(sys.stdout, 'isatty', None)
1587
 
    if isatty is None or not isatty():
 
1413
    if  isatty is None or not isatty():
1588
1414
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1589
1415
        return None
1590
1416
 
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.
 
1417
    # If COLUMNS is set, take it, the terminal knows better (even inside a
 
1418
    # given terminal, the application can decide to set COLUMNS to a lower
 
1419
    # value (splitted screen) or a bigger value (scroll bars))
1608
1420
    try:
1609
1421
        return int(os.environ['COLUMNS'])
1610
1422
    except (KeyError, ValueError):
1611
1423
        pass
1612
1424
 
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
 
1425
    width, height = _terminal_size(None, None)
 
1426
    if width <= 0:
 
1427
        # Consider invalid values as meaning no width
 
1428
        return None
1617
1429
 
1618
 
    # The width could not be determined.
1619
 
    return None
 
1430
    return width
1620
1431
 
1621
1432
 
1622
1433
def _win32_terminal_size(width, height):
1649
1460
    _terminal_size = _ioctl_terminal_size
1650
1461
 
1651
1462
 
 
1463
def _terminal_size_changed(signum, frame):
 
1464
    """Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
 
1465
    width, height = _terminal_size(None, None)
 
1466
    if width is not None:
 
1467
        os.environ['COLUMNS'] = str(width)
 
1468
 
 
1469
 
 
1470
_registered_sigwinch = False
 
1471
 
 
1472
def watch_sigwinch():
 
1473
    """Register for SIGWINCH, once and only once."""
 
1474
    global _registered_sigwinch
 
1475
    if not _registered_sigwinch:
 
1476
        if sys.platform == 'win32':
 
1477
            # Martin (gz) mentioned WINDOW_BUFFER_SIZE_RECORD from
 
1478
            # ReadConsoleInput but I've no idea how to plug that in
 
1479
            # the current design -- vila 20091216
 
1480
            pass
 
1481
        else:
 
1482
            set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
 
1483
        _registered_sigwinch = True
 
1484
 
 
1485
 
1652
1486
def supports_executable():
1653
1487
    return sys.platform != "win32"
1654
1488
 
1777
1611
        dirblock = []
1778
1612
        append = dirblock.append
1779
1613
        try:
1780
 
            names = sorted(map(decode_filename, _listdir(top)))
 
1614
            names = sorted(_listdir(top))
1781
1615
        except OSError, e:
1782
1616
            if not _is_error_enotdir(e):
1783
1617
                raise
1837
1671
    """
1838
1672
    global _selected_dir_reader
1839
1673
    if _selected_dir_reader is None:
 
1674
        fs_encoding = _fs_enc.upper()
1840
1675
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1841
1676
            # Win98 doesn't have unicode apis like FindFirstFileW
1842
1677
            # TODO: We possibly could support Win98 by falling back to the
1848
1683
                _selected_dir_reader = Win32ReadDir()
1849
1684
            except ImportError:
1850
1685
                pass
1851
 
        elif _fs_enc in ('utf-8', 'ascii'):
 
1686
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
 
1687
            # ANSI_X3.4-1968 is a form of ASCII
1852
1688
            try:
1853
1689
                from bzrlib._readdir_pyx import UTF8DirReader
1854
1690
                _selected_dir_reader = UTF8DirReader()
1970
1806
            real_handlers[kind](abspath, relpath)
1971
1807
 
1972
1808
 
1973
 
def copy_ownership_from_path(dst, src=None):
 
1809
def copy_ownership(dst, src=None):
1974
1810
    """Copy usr/grp ownership from src file/dir to dst file/dir.
1975
1811
 
1976
1812
    If src is None, the containing directory is used as source. If chown
1977
1813
    fails, the error is ignored and a warning is printed.
1978
1814
    """
1979
 
    chown = getattr(os, 'chown', None)
1980
 
    if chown is None:
1981
 
        return
 
1815
    has_chown = getattr(os, 'chown')
 
1816
    if has_chown is None: return
1982
1817
 
1983
1818
    if src == None:
1984
1819
        src = os.path.dirname(dst)
1987
1822
 
1988
1823
    try:
1989
1824
        s = os.stat(src)
1990
 
        chown(dst, s.st_uid, s.st_gid)
 
1825
        os.chown(dst, s.st_uid, s.st_gid)
1991
1826
    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()
 
1827
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
 
1828
 
 
1829
 
 
1830
def mkdir_with_ownership(path, ownership_src=None):
 
1831
    """Create the directory 'path' with specified ownership.
 
1832
 
 
1833
    If ownership_src is given, copies (chown) usr/grp ownership
 
1834
    from 'ownership_src' to 'path'. If ownership_src is None, use the
 
1835
    containing dir ownership.
 
1836
    """
 
1837
    os.mkdir(path)
 
1838
    copy_ownership(path, ownership_src)
 
1839
 
 
1840
 
 
1841
def open_with_ownership(filename, mode='r', bufsize=-1, ownership_src=None):
 
1842
    """Open the file 'filename' with the specified ownership.
 
1843
 
 
1844
    If ownership_src is specified, copy usr/grp ownership from ownership_src
 
1845
    to filename. If ownership_src is None, copy ownership from containing
 
1846
    directory.
 
1847
    Returns the opened file object.
 
1848
    """
 
1849
    f = open(filename, mode, bufsize)
 
1850
    copy_ownership(filename, ownership_src)
 
1851
    return f
1996
1852
 
1997
1853
 
1998
1854
def path_prefix_key(path):
2013
1869
_cached_user_encoding = None
2014
1870
 
2015
1871
 
2016
 
def get_user_encoding(use_cache=DEPRECATED_PARAMETER):
 
1872
def get_user_encoding(use_cache=True):
2017
1873
    """Find out what the preferred user encoding is.
2018
1874
 
2019
1875
    This is generally the encoding that is used for command line parameters
2020
1876
    and file contents. This may be different from the terminal encoding
2021
1877
    or the filesystem encoding.
2022
1878
 
 
1879
    :param  use_cache:  Enable cache for detected encoding.
 
1880
                        (This parameter is turned on by default,
 
1881
                        and required only for selftesting)
 
1882
 
2023
1883
    :return: A string defining the preferred user encoding
2024
1884
    """
2025
1885
    global _cached_user_encoding
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:
 
1886
    if _cached_user_encoding is not None and use_cache:
2030
1887
        return _cached_user_encoding
2031
1888
 
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)
 
1889
    if sys.platform == 'darwin':
 
1890
        # python locale.getpreferredencoding() always return
 
1891
        # 'mac-roman' on darwin. That's a lie.
 
1892
        sys.platform = 'posix'
 
1893
        try:
 
1894
            if os.environ.get('LANG', None) is None:
 
1895
                # If LANG is not set, we end up with 'ascii', which is bad
 
1896
                # ('mac-roman' is more than ascii), so we set a default which
 
1897
                # will give us UTF-8 (which appears to work in all cases on
 
1898
                # OSX). Users are still free to override LANG of course, as
 
1899
                # long as it give us something meaningful. This work-around
 
1900
                # *may* not be needed with python 3k and/or OSX 10.5, but will
 
1901
                # work with them too -- vila 20080908
 
1902
                os.environ['LANG'] = 'en_US.UTF-8'
 
1903
            import locale
 
1904
        finally:
 
1905
            sys.platform = 'darwin'
2038
1906
    else:
2039
 
        # GZ 2011-12-19: On windows could call GetACP directly instead.
2040
 
        user_encoding = locale.getpreferredencoding(False)
 
1907
        import locale
2041
1908
 
2042
1909
    try:
2043
 
        user_encoding = codecs.lookup(user_encoding).name
2044
 
    except LookupError:
2045
 
        if user_encoding not in ("", "cp0"):
 
1910
        user_encoding = locale.getpreferredencoding()
 
1911
    except locale.Error, e:
 
1912
        sys.stderr.write('bzr: warning: %s\n'
 
1913
                         '  Could not determine what text encoding to use.\n'
 
1914
                         '  This error usually means your Python interpreter\n'
 
1915
                         '  doesn\'t support the locale set by $LANG (%s)\n'
 
1916
                         "  Continuing with ascii encoding.\n"
 
1917
                         % (e, os.environ.get('LANG')))
 
1918
        user_encoding = 'ascii'
 
1919
 
 
1920
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
 
1921
    # treat that as ASCII, and not support printing unicode characters to the
 
1922
    # console.
 
1923
    #
 
1924
    # For python scripts run under vim, we get '', so also treat that as ASCII
 
1925
    if user_encoding in (None, 'cp0', ''):
 
1926
        user_encoding = 'ascii'
 
1927
    else:
 
1928
        # check encoding
 
1929
        try:
 
1930
            codecs.lookup(user_encoding)
 
1931
        except LookupError:
2046
1932
            sys.stderr.write('bzr: warning:'
2047
1933
                             ' unknown encoding %s.'
2048
1934
                             ' Continuing with ascii encoding.\n'
2049
1935
                             % user_encoding
2050
1936
                            )
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
 
1937
            user_encoding = 'ascii'
 
1938
 
 
1939
    if use_cache:
 
1940
        _cached_user_encoding = user_encoding
 
1941
 
2063
1942
    return user_encoding
2064
1943
 
2065
1944
 
2066
 
def get_diff_header_encoding():
2067
 
    return get_terminal_encoding()
2068
 
 
2069
 
 
2070
1945
def get_host_name():
2071
1946
    """Return the current unicode host name.
2072
1947
 
2074
1949
    behaves inconsistently on different platforms.
2075
1950
    """
2076
1951
    if sys.platform == "win32":
 
1952
        import win32utils
2077
1953
        return win32utils.get_host_name()
2078
1954
    else:
2079
1955
        import socket
2080
1956
        return socket.gethostname().decode(get_user_encoding())
2081
1957
 
2082
1958
 
2083
 
# We must not read/write any more than 64k at a time from/to a socket so we
2084
 
# don't risk "no buffer space available" errors on some platforms.  Windows in
2085
 
# particular is likely to throw WSAECONNABORTED or WSAENOBUFS if given too much
2086
 
# data at once.
2087
 
MAX_SOCKET_CHUNK = 64 * 1024
2088
 
 
2089
 
_end_of_stream_errors = [errno.ECONNRESET, errno.EPIPE, errno.EINVAL]
2090
 
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
2091
 
    _eno = getattr(errno, _eno, None)
2092
 
    if _eno is not None:
2093
 
        _end_of_stream_errors.append(_eno)
2094
 
del _eno
2095
 
 
2096
 
 
2097
 
def read_bytes_from_socket(sock, report_activity=None,
2098
 
        max_read_size=MAX_SOCKET_CHUNK):
2099
 
    """Read up to max_read_size of bytes from sock and notify of progress.
2100
 
 
2101
 
    Translates "Connection reset by peer" into file-like EOF (return an
2102
 
    empty string rather than raise an error), and repeats the recv if
2103
 
    interrupted by a signal.
2104
 
    """
2105
 
    while 1:
2106
 
        try:
2107
 
            bytes = sock.recv(max_read_size)
2108
 
        except socket.error, e:
2109
 
            eno = e.args[0]
2110
 
            if eno in _end_of_stream_errors:
2111
 
                # The connection was closed by the other side.  Callers expect
2112
 
                # an empty string to signal end-of-stream.
2113
 
                return ""
2114
 
            elif eno == errno.EINTR:
2115
 
                # Retry the interrupted recv.
2116
 
                continue
2117
 
            raise
2118
 
        else:
2119
 
            if report_activity is not None:
2120
 
                report_activity(len(bytes), 'read')
2121
 
            return bytes
2122
 
 
2123
 
 
2124
 
def recv_all(socket, count):
 
1959
def recv_all(socket, bytes):
2125
1960
    """Receive an exact number of bytes.
2126
1961
 
2127
1962
    Regular Socket.recv() may return less than the requested number of bytes,
2128
 
    depending on what's in the OS buffer.  MSG_WAITALL is not available
 
1963
    dependning on what's in the OS buffer.  MSG_WAITALL is not available
2129
1964
    on all platforms, but this should work everywhere.  This will return
2130
1965
    less than the requested amount if the remote end closes.
2131
1966
 
2132
1967
    This isn't optimized and is intended mostly for use in testing.
2133
1968
    """
2134
1969
    b = ''
2135
 
    while len(b) < count:
2136
 
        new = read_bytes_from_socket(socket, None, count - len(b))
 
1970
    while len(b) < bytes:
 
1971
        new = until_no_eintr(socket.recv, bytes - len(b))
2137
1972
        if new == '':
2138
1973
            break # eof
2139
1974
        b += new
2140
1975
    return b
2141
1976
 
2142
1977
 
2143
 
def send_all(sock, bytes, report_activity=None):
 
1978
def send_all(socket, bytes, report_activity=None):
2144
1979
    """Send all bytes on a socket.
2145
1980
 
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.
 
1981
    Regular socket.sendall() can give socket error 10053 on Windows.  This
 
1982
    implementation sends no more than 64k at a time, which avoids this problem.
2152
1983
 
2153
1984
    :param report_activity: Call this as bytes are read, see
2154
1985
        Transport._report_activity
2155
1986
    """
2156
 
    sent_total = 0
2157
 
    byte_count = len(bytes)
2158
 
    while sent_total < byte_count:
2159
 
        try:
2160
 
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2161
 
        except (socket.error, IOError), e:
2162
 
            if e.args[0] in _end_of_stream_errors:
2163
 
                raise errors.ConnectionReset(
2164
 
                    "Error trying to write to socket", e)
2165
 
            if e.args[0] != errno.EINTR:
2166
 
                raise
2167
 
        else:
2168
 
            if sent == 0:
2169
 
                raise errors.ConnectionReset('Sending to %s returned 0 bytes'
2170
 
                                             % (sock,))
2171
 
            sent_total += sent
2172
 
            if report_activity is not None:
2173
 
                report_activity(sent, 'write')
2174
 
 
2175
 
 
2176
 
def connect_socket(address):
2177
 
    # Slight variation of the socket.create_connection() function (provided by
2178
 
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
2179
 
    # provide it for previous python versions. Also, we don't use the timeout
2180
 
    # parameter (provided by the python implementation) so we don't implement
2181
 
    # it either).
2182
 
    err = socket.error('getaddrinfo returns an empty list')
2183
 
    host, port = address
2184
 
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
2185
 
        af, socktype, proto, canonname, sa = res
2186
 
        sock = None
2187
 
        try:
2188
 
            sock = socket.socket(af, socktype, proto)
2189
 
            sock.connect(sa)
2190
 
            return sock
2191
 
 
2192
 
        except socket.error, err:
2193
 
            # 'err' is now the most recent error
2194
 
            if sock is not None:
2195
 
                sock.close()
2196
 
    raise err
 
1987
    chunk_size = 2**16
 
1988
    for pos in xrange(0, len(bytes), chunk_size):
 
1989
        block = bytes[pos:pos+chunk_size]
 
1990
        if report_activity is not None:
 
1991
            report_activity(len(block), 'write')
 
1992
        until_no_eintr(socket.sendall, block)
2197
1993
 
2198
1994
 
2199
1995
def dereference_path(path):
2240
2036
    base = dirname(bzrlib.__file__)
2241
2037
    if getattr(sys, 'frozen', None):    # bzr.exe
2242
2038
        base = abspath(pathjoin(base, '..', '..'))
2243
 
    f = file(pathjoin(base, resource_relpath), "rU")
2244
 
    try:
2245
 
        return f.read()
2246
 
    finally:
2247
 
        f.close()
 
2039
    filename = pathjoin(base, resource_relpath)
 
2040
    return open(filename, 'rU').read()
 
2041
 
2248
2042
 
2249
2043
def file_kind_from_stat_mode_thunk(mode):
2250
2044
    global file_kind_from_stat_mode
2261
2055
    return file_kind_from_stat_mode(mode)
2262
2056
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2263
2057
 
2264
 
def file_stat(f, _lstat=os.lstat):
 
2058
 
 
2059
def file_kind(f, _lstat=os.lstat):
2265
2060
    try:
2266
 
        # XXX cache?
2267
 
        return _lstat(f)
 
2061
        return file_kind_from_stat_mode(_lstat(f).st_mode)
2268
2062
    except OSError, e:
2269
2063
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2270
2064
            raise errors.NoSuchFile(f)
2271
2065
        raise
2272
2066
 
2273
 
def file_kind(f, _lstat=os.lstat):
2274
 
    stat_value = file_stat(f, _lstat)
2275
 
    return file_kind_from_stat_mode(stat_value.st_mode)
2276
2067
 
2277
2068
def until_no_eintr(f, *a, **kw):
2278
 
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2279
 
 
2280
 
    WARNING: you must be certain that it is safe to retry the call repeatedly
2281
 
    if EINTR does occur.  This is typically only true for low-level operations
2282
 
    like os.read.  If in any doubt, don't use this.
2283
 
 
2284
 
    Keep in mind that this is not a complete solution to EINTR.  There is
2285
 
    probably code in the Python standard library and other dependencies that
2286
 
    may encounter EINTR if a signal arrives (and there is signal handler for
2287
 
    that signal).  So this function can reduce the impact for IO that bzrlib
2288
 
    directly controls, but it is not a complete solution.
2289
 
    """
 
2069
    """Run f(*a, **kw), retrying if an EINTR error occurs."""
2290
2070
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
2291
2071
    while True:
2292
2072
        try:
2296
2076
                continue
2297
2077
            raise
2298
2078
 
2299
 
 
2300
 
@deprecated_function(deprecated_in((2, 2, 0)))
2301
2079
def re_compile_checked(re_string, flags=0, where=""):
2302
2080
    """Return a compiled re, or raise a sensible error.
2303
2081
 
2313
2091
        re_obj = re.compile(re_string, flags)
2314
2092
        re_obj.search("")
2315
2093
        return re_obj
2316
 
    except errors.InvalidPattern, e:
 
2094
    except re.error, e:
2317
2095
        if where:
2318
2096
            where = ' in ' + where
2319
2097
        # despite the name 'error' is a type
2320
 
        raise errors.BzrCommandError('Invalid regular expression%s: %s'
2321
 
            % (where, e.msg))
 
2098
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
 
2099
            % (where, re_string, e))
2322
2100
 
2323
2101
 
2324
2102
if sys.platform == "win32":
 
2103
    import msvcrt
2325
2104
    def getchar():
2326
 
        import msvcrt
2327
2105
        return msvcrt.getch()
2328
2106
else:
 
2107
    import tty
 
2108
    import termios
2329
2109
    def getchar():
2330
 
        import tty
2331
 
        import termios
2332
2110
        fd = sys.stdin.fileno()
2333
2111
        settings = termios.tcgetattr(fd)
2334
2112
        try:
2338
2116
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2339
2117
        return ch
2340
2118
 
2341
 
if sys.platform.startswith('linux'):
 
2119
 
 
2120
if sys.platform == 'linux2':
2342
2121
    def _local_concurrency():
2343
 
        try:
2344
 
            return os.sysconf('SC_NPROCESSORS_ONLN')
2345
 
        except (ValueError, OSError, AttributeError):
2346
 
            return None
 
2122
        concurrency = None
 
2123
        prefix = 'processor'
 
2124
        for line in file('/proc/cpuinfo', 'rb'):
 
2125
            if line.startswith(prefix):
 
2126
                concurrency = int(line[line.find(':')+1:]) + 1
 
2127
        return concurrency
2347
2128
elif sys.platform == 'darwin':
2348
2129
    def _local_concurrency():
2349
2130
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2350
2131
                                stdout=subprocess.PIPE).communicate()[0]
2351
 
elif "bsd" in sys.platform:
 
2132
elif sys.platform[0:7] == 'freebsd':
2352
2133
    def _local_concurrency():
2353
2134
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2354
2135
                                stdout=subprocess.PIPE).communicate()[0]
2382
2163
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2383
2164
    if concurrency is None:
2384
2165
        try:
2385
 
            import multiprocessing
2386
 
            concurrency = multiprocessing.cpu_count()
2387
 
        except (ImportError, NotImplementedError):
2388
 
            # multiprocessing is only available on Python >= 2.6
2389
 
            # and multiprocessing.cpu_count() isn't implemented on all
2390
 
            # platforms
2391
 
            try:
2392
 
                concurrency = _local_concurrency()
2393
 
            except (OSError, IOError):
2394
 
                pass
 
2166
            concurrency = _local_concurrency()
 
2167
        except (OSError, IOError):
 
2168
            pass
2395
2169
    try:
2396
2170
        concurrency = int(concurrency)
2397
2171
    except (TypeError, ValueError):
2418
2192
if sys.platform == 'win32':
2419
2193
    def open_file(filename, mode='r', bufsize=-1):
2420
2194
        """This function is used to override the ``open`` builtin.
2421
 
 
 
2195
        
2422
2196
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2423
2197
        child processes.  Deleting or renaming a closed file opened with this
2424
2198
        function is not blocking child processes.
2457
2231
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2458
2232
else:
2459
2233
    open_file = open
2460
 
 
2461
 
 
2462
 
def available_backup_name(base, exists):
2463
 
    """Find a non-existing backup file name.
2464
 
 
2465
 
    This will *not* create anything, this only return a 'free' entry.  This
2466
 
    should be used for checking names in a directory below a locked
2467
 
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
2468
 
    Leap) and generally discouraged.
2469
 
 
2470
 
    :param base: The base name.
2471
 
 
2472
 
    :param exists: A callable returning True if the path parameter exists.
2473
 
    """
2474
 
    counter = 1
2475
 
    name = "%s.~%d~" % (base, counter)
2476
 
    while exists(name):
2477
 
        counter += 1
2478
 
        name = "%s.~%d~" % (base, counter)
2479
 
    return name
2480
 
 
2481
 
 
2482
 
def set_fd_cloexec(fd):
2483
 
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
2484
 
    support for this is not available.
2485
 
    """
2486
 
    try:
2487
 
        import fcntl
2488
 
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
2489
 
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
2490
 
    except (ImportError, AttributeError):
2491
 
        # Either the fcntl module or specific constants are not present
2492
 
        pass
2493
 
 
2494
 
 
2495
 
def find_executable_on_path(name):
2496
 
    """Finds an executable on the PATH.
2497
 
    
2498
 
    On Windows, this will try to append each extension in the PATHEXT
2499
 
    environment variable to the name, if it cannot be found with the name
2500
 
    as given.
2501
 
    
2502
 
    :param name: The base name of the executable.
2503
 
    :return: The path to the executable found or None.
2504
 
    """
2505
 
    if sys.platform == 'win32':
2506
 
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
2507
 
        exts = [ext.lower() for ext in exts]
2508
 
        base, ext = os.path.splitext(name)
2509
 
        if ext != '':
2510
 
            if ext.lower() not in exts:
2511
 
                return None
2512
 
            name = base
2513
 
            exts = [ext]
2514
 
    else:
2515
 
        exts = ['']
2516
 
    path = os.environ.get('PATH')
2517
 
    if path is not None:
2518
 
        path = path.split(os.pathsep)
2519
 
        for ext in exts:
2520
 
            for d in path:
2521
 
                f = os.path.join(d, name) + ext
2522
 
                if os.access(f, os.X_OK):
2523
 
                    return f
2524
 
    if sys.platform == 'win32':
2525
 
        app_path = win32utils.get_app_path(name)
2526
 
        if app_path != name:
2527
 
            return app_path
2528
 
    return None
2529
 
 
2530
 
 
2531
 
def _posix_is_local_pid_dead(pid):
2532
 
    """True if pid doesn't correspond to live process on this machine"""
2533
 
    try:
2534
 
        # Special meaning of unix kill: just check if it's there.
2535
 
        os.kill(pid, 0)
2536
 
    except OSError, e:
2537
 
        if e.errno == errno.ESRCH:
2538
 
            # On this machine, and really not found: as sure as we can be
2539
 
            # that it's dead.
2540
 
            return True
2541
 
        elif e.errno == errno.EPERM:
2542
 
            # exists, though not ours
2543
 
            return False
2544
 
        else:
2545
 
            mutter("os.kill(%d, 0) failed: %s" % (pid, e))
2546
 
            # Don't really know.
2547
 
            return False
2548
 
    else:
2549
 
        # Exists and our process: not dead.
2550
 
        return False
2551
 
 
2552
 
if sys.platform == "win32":
2553
 
    is_local_pid_dead = win32utils.is_local_pid_dead
2554
 
else:
2555
 
    is_local_pid_dead = _posix_is_local_pid_dead
2556
 
 
2557
 
_maybe_ignored = ['EAGAIN', 'EINTR', 'ENOTSUP', 'EOPNOTSUPP', 'EACCES']
2558
 
_fdatasync_ignored = [getattr(errno, name) for name in _maybe_ignored
2559
 
                      if getattr(errno, name, None) is not None]
2560
 
 
2561
 
 
2562
 
def fdatasync(fileno):
2563
 
    """Flush file contents to disk if possible.
2564
 
    
2565
 
    :param fileno: Integer OS file handle.
2566
 
    :raises TransportNotPossible: If flushing to disk is not possible.
2567
 
    """
2568
 
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
2569
 
    if fn is not None:
2570
 
        try:
2571
 
            fn(fileno)
2572
 
        except IOError, e:
2573
 
            # See bug #1075108, on some platforms fdatasync exists, but can
2574
 
            # raise ENOTSUP. However, we are calling fdatasync to be helpful
2575
 
            # and reduce the chance of corruption-on-powerloss situations. It
2576
 
            # is not a mandatory call, so it is ok to suppress failures.
2577
 
            trace.mutter("ignoring error calling fdatasync: %s" % (e,))
2578
 
            if getattr(e, 'errno', None) not in _fdatasync_ignored:
2579
 
                raise
2580
 
 
2581
 
 
2582
 
def ensure_empty_directory_exists(path, exception_class):
2583
 
    """Make sure a local directory exists and is empty.
2584
 
    
2585
 
    If it does not exist, it is created.  If it exists and is not empty, an
2586
 
    instance of exception_class is raised.
2587
 
    """
2588
 
    try:
2589
 
        os.mkdir(path)
2590
 
    except OSError, e:
2591
 
        if e.errno != errno.EEXIST:
2592
 
            raise
2593
 
        if os.listdir(path) != []:
2594
 
            raise exception_class(path)
2595
 
 
2596
 
 
2597
 
def is_environment_error(evalue):
2598
 
    """True if exception instance is due to a process environment issue
2599
 
 
2600
 
    This includes OSError and IOError, but also other errors that come from
2601
 
    the operating system or core libraries but are not subclasses of those.
2602
 
    """
2603
 
    if isinstance(evalue, (EnvironmentError, select.error)):
2604
 
        return True
2605
 
    if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
2606
 
        return True
2607
 
    return False