~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-02-03 10:06:19 UTC
  • mfrom: (4999.3.2 apport)
  • Revision ID: pqm@pqm.ubuntu.com-20100203100619-f76bo5y5bd5c14wk
(mbp) use apport to send bugs, not just store them

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2009 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
 
import codecs
 
24
import warnings
26
25
 
27
26
from bzrlib.lazy_import import lazy_import
28
27
lazy_import(globals(), """
 
28
import codecs
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,
51
 
    trace,
52
53
    win32utils,
53
54
    )
54
 
from bzrlib.i18n import gettext
55
55
""")
56
56
 
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
 
    )
 
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
        )
69
69
 
70
70
 
71
71
import bzrlib
72
 
from bzrlib import symbol_versioning, _fs_enc
 
72
from bzrlib import symbol_versioning
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.
89
 
# O_NOINHERIT and O_TEXT exists only on win32 too.
 
88
# OR with 0 on those platforms
90
89
O_BINARY = getattr(os, 'O_BINARY', 0)
91
 
O_TEXT = getattr(os, 'O_TEXT', 0)
92
 
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
93
90
 
94
91
 
95
92
def get_unicode_argv():
97
94
        user_encoding = get_user_encoding()
98
95
        return [a.decode(user_encoding) for a in sys.argv[1:]]
99
96
    except UnicodeDecodeError:
100
 
        raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
101
 
            "application locale.").format(a, user_encoding))
 
97
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
 
98
                                                            "encoding." % a))
102
99
 
103
100
 
104
101
def make_readonly(filename):
106
103
    mod = os.lstat(filename).st_mode
107
104
    if not stat.S_ISLNK(mod):
108
105
        mod = mod & 0777555
109
 
        chmod_if_possible(filename, mod)
 
106
        os.chmod(filename, mod)
110
107
 
111
108
 
112
109
def make_writable(filename):
113
110
    mod = os.lstat(filename).st_mode
114
111
    if not stat.S_ISLNK(mod):
115
112
        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
 
113
        os.chmod(filename, mod)
136
114
 
137
115
 
138
116
def minimum_path_selection(paths):
201
179
    try:
202
180
        return _kind_marker_map[kind]
203
181
    except KeyError:
204
 
        # Slightly faster than using .get(, '') when the common case is that
205
 
        # kind will be found
206
 
        return ''
 
182
        raise errors.BzrError('invalid file kind %r' % kind)
207
183
 
208
184
 
209
185
lexists = getattr(os.path, 'lexists', None)
217
193
            if e.errno == errno.ENOENT:
218
194
                return False;
219
195
            else:
220
 
                raise errors.BzrError(gettext("lstat/stat of ({0!r}): {1!r}").format(f, e))
 
196
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
221
197
 
222
198
 
223
199
def fancy_rename(old, new, rename_func, unlink_func):
289
265
            else:
290
266
                rename_func(tmp_name, new)
291
267
    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
 
268
        raise failure_exc[0], failure_exc[1], failure_exc[2]
296
269
 
297
270
 
298
271
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
299
272
# choke on a Unicode string containing a relative path if
300
273
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
301
274
# string.
 
275
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
302
276
def _posix_abspath(path):
303
277
    # jam 20060426 rather than encoding to fsencoding
304
278
    # copy posixpath.abspath, but use os.getcwdu instead
305
279
    if not posixpath.isabs(path):
306
280
        path = posixpath.join(getcwd(), path)
307
 
    return _posix_normpath(path)
 
281
    return posixpath.normpath(path)
308
282
 
309
283
 
310
284
def _posix_realpath(path):
311
285
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
312
286
 
313
287
 
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
288
def _win32_fixdrive(path):
366
289
    """Force drive letters to be consistent.
367
290
 
371
294
    running python.exe under cmd.exe return capital C:\\
372
295
    running win32 python inside a cygwin shell returns lowercase c:\\
373
296
    """
374
 
    drive, path = ntpath.splitdrive(path)
 
297
    drive, path = _nt_splitdrive(path)
375
298
    return drive.upper() + path
376
299
 
377
300
 
378
301
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('\\', '/'))
 
302
    # Real _nt_abspath doesn't have a problem with a unicode cwd
 
303
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
381
304
 
382
305
 
383
306
def _win98_abspath(path):
394
317
    #   /path       => C:/path
395
318
    path = unicode(path)
396
319
    # check for absolute path
397
 
    drive = ntpath.splitdrive(path)[0]
 
320
    drive = _nt_splitdrive(path)[0]
398
321
    if drive == '' and path[:2] not in('//','\\\\'):
399
322
        cwd = os.getcwdu()
400
323
        # we cannot simply os.path.join cwd and path
401
324
        # because os.path.join('C:','/path') produce '/path'
402
325
        # and this is incorrect
403
326
        if path[:1] in ('/','\\'):
404
 
            cwd = ntpath.splitdrive(cwd)[0]
 
327
            cwd = _nt_splitdrive(cwd)[0]
405
328
            path = path[1:]
406
329
        path = cwd + '\\' + path
407
 
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
 
330
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
408
331
 
409
332
 
410
333
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('\\', '/'))
 
334
    # Real _nt_realpath doesn't have a problem with a unicode cwd
 
335
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
413
336
 
414
337
 
415
338
def _win32_pathjoin(*args):
416
 
    return ntpath.join(*args).replace('\\', '/')
 
339
    return _nt_join(*args).replace('\\', '/')
417
340
 
418
341
 
419
342
def _win32_normpath(path):
420
 
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
 
343
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
421
344
 
422
345
 
423
346
def _win32_getcwd():
455
378
abspath = _posix_abspath
456
379
realpath = _posix_realpath
457
380
pathjoin = os.path.join
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
 
381
normpath = os.path.normpath
462
382
getcwd = os.getcwdu
463
383
rename = os.rename
464
384
dirname = os.path.dirname
465
385
basename = os.path.basename
466
386
split = os.path.split
467
387
splitext = os.path.splitext
468
 
# These were already lazily imported into local scope
 
388
# These were already imported into local scope
469
389
# mkdtemp = tempfile.mkdtemp
470
390
# rmtree = shutil.rmtree
471
 
lstat = os.lstat
472
 
fstat = os.fstat
473
 
 
474
 
def wrap_stat(st):
475
 
    return st
476
 
 
477
391
 
478
392
MIN_ABS_PATHLENGTH = 1
479
393
 
489
403
    getcwd = _win32_getcwd
490
404
    mkdtemp = _win32_mkdtemp
491
405
    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
500
406
 
501
407
    MIN_ABS_PATHLENGTH = 3
502
408
 
520
426
    f = win32utils.get_unicode_argv     # special function or None
521
427
    if f is not None:
522
428
        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
526
429
 
527
430
elif sys.platform == 'darwin':
528
431
    getcwd = _mac_getcwd
529
432
 
530
433
 
531
 
def get_terminal_encoding(trace=False):
 
434
def get_terminal_encoding():
532
435
    """Find the best encoding for printing to the screen.
533
436
 
534
437
    This attempts to check both sys.stdout and sys.stdin to see
540
443
 
541
444
    On my standard US Windows XP, the preferred encoding is
542
445
    cp1252, but the console is cp437
543
 
 
544
 
    :param trace: If True trace the selected encoding via mutter().
545
446
    """
546
447
    from bzrlib.trace import mutter
547
448
    output_encoding = getattr(sys.stdout, 'encoding', None)
549
450
        input_encoding = getattr(sys.stdin, 'encoding', None)
550
451
        if not input_encoding:
551
452
            output_encoding = get_user_encoding()
552
 
            if trace:
553
 
                mutter('encoding stdout as osutils.get_user_encoding() %r',
 
453
            mutter('encoding stdout as osutils.get_user_encoding() %r',
554
454
                   output_encoding)
555
455
        else:
556
456
            output_encoding = input_encoding
557
 
            if trace:
558
 
                mutter('encoding stdout as sys.stdin encoding %r',
559
 
                    output_encoding)
 
457
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
560
458
    else:
561
 
        if trace:
562
 
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
459
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
563
460
    if output_encoding == 'cp0':
564
461
        # invalid encoding (cp0 means 'no codepage' on Windows)
565
462
        output_encoding = get_user_encoding()
566
 
        if trace:
567
 
            mutter('cp0 is invalid encoding.'
 
463
        mutter('cp0 is invalid encoding.'
568
464
               ' encoding stdout as osutils.get_user_encoding() %r',
569
465
               output_encoding)
570
466
    # check encoding
596
492
def isdir(f):
597
493
    """True if f is an accessible directory."""
598
494
    try:
599
 
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
 
495
        return S_ISDIR(os.lstat(f)[ST_MODE])
600
496
    except OSError:
601
497
        return False
602
498
 
604
500
def isfile(f):
605
501
    """True if f is a regular file."""
606
502
    try:
607
 
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
 
503
        return S_ISREG(os.lstat(f)[ST_MODE])
608
504
    except OSError:
609
505
        return False
610
506
 
611
507
def islink(f):
612
508
    """True if f is a symlink."""
613
509
    try:
614
 
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
 
510
        return S_ISLNK(os.lstat(f)[ST_MODE])
615
511
    except OSError:
616
512
        return False
617
513
 
765
661
def sha_file_by_name(fname):
766
662
    """Calculate the SHA1 of a file by reading the full text"""
767
663
    s = sha()
768
 
    f = os.open(fname, os.O_RDONLY | O_BINARY | O_NOINHERIT)
 
664
    f = os.open(fname, os.O_RDONLY | O_BINARY)
769
665
    try:
770
666
        while True:
771
667
            b = os.read(f, 1<<16)
957
853
 
958
854
def filesize(f):
959
855
    """Return size of given open file."""
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":
 
856
    return os.fstat(f.fileno())[ST_SIZE]
 
857
 
 
858
 
 
859
# Define rand_bytes based on platform.
 
860
try:
 
861
    # Python 2.4 and later have os.urandom,
 
862
    # but it doesn't work on some arches
 
863
    os.urandom(1)
 
864
    rand_bytes = os.urandom
 
865
except (NotImplementedError, AttributeError):
 
866
    # If python doesn't have os.urandom, or it doesn't work,
 
867
    # then try to first pull random data from /dev/urandom
970
868
    try:
971
 
        rand_bytes(1)
972
 
    except NotImplementedError:
 
869
        rand_bytes = file('/dev/urandom', 'rb').read
 
870
    # Otherwise, use this hack as a last resort
 
871
    except (IOError, OSError):
973
872
        # not well seeded, but better than nothing
974
873
        def rand_bytes(n):
975
874
            import random
1005
904
    rps = []
1006
905
    for f in ps:
1007
906
        if f == '..':
1008
 
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
 
907
            raise errors.BzrError("sorry, %r not allowed in path" % f)
1009
908
        elif (f == '.') or (f == ''):
1010
909
            pass
1011
910
        else:
1016
915
def joinpath(p):
1017
916
    for f in p:
1018
917
        if (f == '..') or (f is None) or (f == ''):
1019
 
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
 
918
            raise errors.BzrError("sorry, %r not allowed in path" % f)
1020
919
    return pathjoin(*p)
1021
920
 
1022
921
 
1023
922
def parent_directories(filename):
1024
923
    """Return the list of parent directories, deepest first.
1025
 
 
 
924
    
1026
925
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
1027
926
    """
1028
927
    parents = []
1052
951
    # NB: This docstring is just an example, not a doctest, because doctest
1053
952
    # currently can't cope with the use of lazy imports in this namespace --
1054
953
    # mbp 20090729
1055
 
 
 
954
    
1056
955
    # This currently doesn't report the failure at the time it occurs, because
1057
956
    # they tend to happen very early in startup when we can't check config
1058
957
    # files etc, and also we want to report all failures but not spam the user
1059
958
    # with 10 warnings.
 
959
    from bzrlib import trace
1060
960
    exception_str = str(exception)
1061
961
    if exception_str not in _extension_load_failures:
1062
962
        trace.mutter("failed to load compiled extension: %s" % exception_str)
1066
966
def report_extension_load_failures():
1067
967
    if not _extension_load_failures:
1068
968
        return
1069
 
    if config.GlobalStack().get('ignore_missing_extensions'):
 
969
    from bzrlib.config import GlobalConfig
 
970
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
1070
971
        return
1071
972
    # the warnings framework should by default show this only once
1072
973
    from bzrlib.trace import warning
1126
1027
 
1127
1028
 
1128
1029
def delete_any(path):
1129
 
    """Delete a file, symlink or directory.
1130
 
 
 
1030
    """Delete a file, symlink or directory.  
 
1031
    
1131
1032
    Will delete even if readonly.
1132
1033
    """
1133
1034
    try:
1219
1120
 
1220
1121
 
1221
1122
def relpath(base, path):
1222
 
    """Return path relative to base, or raise PathNotChild exception.
 
1123
    """Return path relative to base, or raise exception.
1223
1124
 
1224
1125
    The path may be either an absolute path or a path relative to the
1225
1126
    current working directory.
1227
1128
    os.path.commonprefix (python2.4) has a bad bug that it works just
1228
1129
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
1229
1130
    avoids that problem.
1230
 
 
1231
 
    NOTE: `base` should not have a trailing slash otherwise you'll get
1232
 
    PathNotChild exceptions regardless of `path`.
1233
1131
    """
1234
1132
 
1235
1133
    if len(base) < MIN_ABS_PATHLENGTH:
1236
1134
        # must have space for e.g. a drive letter
1237
 
        raise ValueError(gettext('%r is too short to calculate a relative path')
 
1135
        raise ValueError('%r is too short to calculate a relative path'
1238
1136
            % (base,))
1239
1137
 
1240
1138
    rp = abspath(path)
1322
1220
    # but for now, we haven't optimized...
1323
1221
    return [canonical_relpath(base, p) for p in paths]
1324
1222
 
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
 
 
1341
1223
def safe_unicode(unicode_or_utf8_string):
1342
1224
    """Coerce unicode_or_utf8_string into unicode.
1343
1225
 
1426
1308
def normalizes_filenames():
1427
1309
    """Return True if this platform normalizes unicode filenames.
1428
1310
 
1429
 
    Only Mac OSX.
 
1311
    Mac OSX does, Windows/Linux do not.
1430
1312
    """
1431
1313
    return _platform_normalizes_filenames
1432
1314
 
1437
1319
    On platforms where the system normalizes filenames (Mac OSX),
1438
1320
    you can access a file by any path which will normalize correctly.
1439
1321
    On platforms where the system does not normalize filenames
1440
 
    (everything else), you have to access a file by its exact path.
 
1322
    (Windows, Linux), you have to access a file by its exact path.
1441
1323
 
1442
1324
    Internally, bzr only supports NFC normalization, since that is
1443
1325
    the standard for XML documents.
1462
1344
    normalized_filename = _inaccessible_normalized_filename
1463
1345
 
1464
1346
 
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
 
 
1501
1347
default_terminal_width = 80
1502
1348
"""The default terminal width for ttys.
1503
1349
 
1505
1351
terminal_width() returns None.
1506
1352
"""
1507
1353
 
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
1514
1354
 
1515
1355
def terminal_width():
1516
1356
    """Return terminal width.
1520
1360
    The rules are:
1521
1361
    - if BZR_COLUMNS is set, returns its value
1522
1362
    - 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,
1525
1363
    - if COLUMNS is set, returns its value,
1526
 
    - if the OS has a value (even though it's never changed), return its value.
1527
1364
 
1528
1365
    From there, we need to query the OS to get the size of the controlling
1529
1366
    terminal.
1530
1367
 
1531
 
    On Unices we query the OS by:
 
1368
    Unices:
1532
1369
    - get termios.TIOCGWINSZ
1533
1370
    - if an error occurs or a negative value is obtained, returns None
1534
1371
 
1535
 
    On Windows we query the OS by:
 
1372
    Windows:
 
1373
    
1536
1374
    - win32utils.get_console_size() decides,
1537
1375
    - returns None on error (provided default value)
1538
1376
    """
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.
1551
1377
 
1552
1378
    # If BZR_COLUMNS is set, take it, user is always right
1553
 
    # Except if they specified 0 in which case, impose no limit here
1554
1379
    try:
1555
 
        width = int(os.environ['BZR_COLUMNS'])
 
1380
        return int(os.environ['BZR_COLUMNS'])
1556
1381
    except (KeyError, ValueError):
1557
 
        width = None
1558
 
    if width is not None:
1559
 
        if width > 0:
1560
 
            return width
1561
 
        else:
1562
 
            return None
 
1382
        pass
1563
1383
 
1564
1384
    isatty = getattr(sys.stdout, 'isatty', None)
1565
 
    if isatty is None or not isatty():
 
1385
    if  isatty is None or not isatty():
1566
1386
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1567
1387
        return None
1568
1388
 
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.
 
1389
    # If COLUMNS is set, take it, the terminal knows better (even inside a
 
1390
    # given terminal, the application can decide to set COLUMNS to a lower
 
1391
    # value (splitted screen) or a bigger value (scroll bars))
1586
1392
    try:
1587
1393
        return int(os.environ['COLUMNS'])
1588
1394
    except (KeyError, ValueError):
1589
1395
        pass
1590
1396
 
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
 
1397
    width, height = _terminal_size(None, None)
 
1398
    if width <= 0:
 
1399
        # Consider invalid values as meaning no width
 
1400
        return None
1595
1401
 
1596
 
    # The width could not be determined.
1597
 
    return None
 
1402
    return width
1598
1403
 
1599
1404
 
1600
1405
def _win32_terminal_size(width, height):
1627
1432
    _terminal_size = _ioctl_terminal_size
1628
1433
 
1629
1434
 
 
1435
def _terminal_size_changed(signum, frame):
 
1436
    """Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
 
1437
    width, height = _terminal_size(None, None)
 
1438
    if width is not None:
 
1439
        os.environ['COLUMNS'] = str(width)
 
1440
 
 
1441
if sys.platform == 'win32':
 
1442
    # Martin (gz) mentioned WINDOW_BUFFER_SIZE_RECORD from ReadConsoleInput but
 
1443
    # I've no idea how to plug that in the current design -- vila 20091216
 
1444
    pass
 
1445
else:
 
1446
    signal.signal(signal.SIGWINCH, _terminal_size_changed)
 
1447
 
 
1448
 
1630
1449
def supports_executable():
1631
1450
    return sys.platform != "win32"
1632
1451
 
1755
1574
        dirblock = []
1756
1575
        append = dirblock.append
1757
1576
        try:
1758
 
            names = sorted(map(decode_filename, _listdir(top)))
 
1577
            names = sorted(_listdir(top))
1759
1578
        except OSError, e:
1760
1579
            if not _is_error_enotdir(e):
1761
1580
                raise
1815
1634
    """
1816
1635
    global _selected_dir_reader
1817
1636
    if _selected_dir_reader is None:
 
1637
        fs_encoding = _fs_enc.upper()
1818
1638
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1819
1639
            # Win98 doesn't have unicode apis like FindFirstFileW
1820
1640
            # TODO: We possibly could support Win98 by falling back to the
1826
1646
                _selected_dir_reader = Win32ReadDir()
1827
1647
            except ImportError:
1828
1648
                pass
1829
 
        elif _fs_enc in ('utf-8', 'ascii'):
 
1649
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
 
1650
            # ANSI_X3.4-1968 is a form of ASCII
1830
1651
            try:
1831
1652
                from bzrlib._readdir_pyx import UTF8DirReader
1832
1653
                _selected_dir_reader = UTF8DirReader()
1948
1769
            real_handlers[kind](abspath, relpath)
1949
1770
 
1950
1771
 
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
 
 
1976
1772
def path_prefix_key(path):
1977
1773
    """Generate a prefix-order path key for path.
1978
1774
 
1991
1787
_cached_user_encoding = None
1992
1788
 
1993
1789
 
1994
 
def get_user_encoding(use_cache=DEPRECATED_PARAMETER):
 
1790
def get_user_encoding(use_cache=True):
1995
1791
    """Find out what the preferred user encoding is.
1996
1792
 
1997
1793
    This is generally the encoding that is used for command line parameters
1998
1794
    and file contents. This may be different from the terminal encoding
1999
1795
    or the filesystem encoding.
2000
1796
 
 
1797
    :param  use_cache:  Enable cache for detected encoding.
 
1798
                        (This parameter is turned on by default,
 
1799
                        and required only for selftesting)
 
1800
 
2001
1801
    :return: A string defining the preferred user encoding
2002
1802
    """
2003
1803
    global _cached_user_encoding
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:
 
1804
    if _cached_user_encoding is not None and use_cache:
2008
1805
        return _cached_user_encoding
2009
1806
 
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)
 
1807
    if sys.platform == 'darwin':
 
1808
        # python locale.getpreferredencoding() always return
 
1809
        # 'mac-roman' on darwin. That's a lie.
 
1810
        sys.platform = 'posix'
 
1811
        try:
 
1812
            if os.environ.get('LANG', None) is None:
 
1813
                # If LANG is not set, we end up with 'ascii', which is bad
 
1814
                # ('mac-roman' is more than ascii), so we set a default which
 
1815
                # will give us UTF-8 (which appears to work in all cases on
 
1816
                # OSX). Users are still free to override LANG of course, as
 
1817
                # long as it give us something meaningful. This work-around
 
1818
                # *may* not be needed with python 3k and/or OSX 10.5, but will
 
1819
                # work with them too -- vila 20080908
 
1820
                os.environ['LANG'] = 'en_US.UTF-8'
 
1821
            import locale
 
1822
        finally:
 
1823
            sys.platform = 'darwin'
2016
1824
    else:
2017
 
        # GZ 2011-12-19: On windows could call GetACP directly instead.
2018
 
        user_encoding = locale.getpreferredencoding(False)
 
1825
        import locale
2019
1826
 
2020
1827
    try:
2021
 
        user_encoding = codecs.lookup(user_encoding).name
2022
 
    except LookupError:
2023
 
        if user_encoding not in ("", "cp0"):
 
1828
        user_encoding = locale.getpreferredencoding()
 
1829
    except locale.Error, e:
 
1830
        sys.stderr.write('bzr: warning: %s\n'
 
1831
                         '  Could not determine what text encoding to use.\n'
 
1832
                         '  This error usually means your Python interpreter\n'
 
1833
                         '  doesn\'t support the locale set by $LANG (%s)\n'
 
1834
                         "  Continuing with ascii encoding.\n"
 
1835
                         % (e, os.environ.get('LANG')))
 
1836
        user_encoding = 'ascii'
 
1837
 
 
1838
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
 
1839
    # treat that as ASCII, and not support printing unicode characters to the
 
1840
    # console.
 
1841
    #
 
1842
    # For python scripts run under vim, we get '', so also treat that as ASCII
 
1843
    if user_encoding in (None, 'cp0', ''):
 
1844
        user_encoding = 'ascii'
 
1845
    else:
 
1846
        # check encoding
 
1847
        try:
 
1848
            codecs.lookup(user_encoding)
 
1849
        except LookupError:
2024
1850
            sys.stderr.write('bzr: warning:'
2025
1851
                             ' unknown encoding %s.'
2026
1852
                             ' Continuing with ascii encoding.\n'
2027
1853
                             % user_encoding
2028
1854
                            )
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
 
1855
            user_encoding = 'ascii'
 
1856
 
 
1857
    if use_cache:
 
1858
        _cached_user_encoding = user_encoding
 
1859
 
2041
1860
    return user_encoding
2042
1861
 
2043
1862
 
2044
 
def get_diff_header_encoding():
2045
 
    return get_terminal_encoding()
2046
 
 
2047
 
 
2048
1863
def get_host_name():
2049
1864
    """Return the current unicode host name.
2050
1865
 
2052
1867
    behaves inconsistently on different platforms.
2053
1868
    """
2054
1869
    if sys.platform == "win32":
 
1870
        import win32utils
2055
1871
        return win32utils.get_host_name()
2056
1872
    else:
2057
1873
        import socket
2058
1874
        return socket.gethostname().decode(get_user_encoding())
2059
1875
 
2060
1876
 
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):
 
1877
def recv_all(socket, bytes):
2103
1878
    """Receive an exact number of bytes.
2104
1879
 
2105
1880
    Regular Socket.recv() may return less than the requested number of bytes,
2106
 
    depending on what's in the OS buffer.  MSG_WAITALL is not available
 
1881
    dependning on what's in the OS buffer.  MSG_WAITALL is not available
2107
1882
    on all platforms, but this should work everywhere.  This will return
2108
1883
    less than the requested amount if the remote end closes.
2109
1884
 
2110
1885
    This isn't optimized and is intended mostly for use in testing.
2111
1886
    """
2112
1887
    b = ''
2113
 
    while len(b) < count:
2114
 
        new = read_bytes_from_socket(socket, None, count - len(b))
 
1888
    while len(b) < bytes:
 
1889
        new = until_no_eintr(socket.recv, bytes - len(b))
2115
1890
        if new == '':
2116
1891
            break # eof
2117
1892
        b += new
2118
1893
    return b
2119
1894
 
2120
1895
 
2121
 
def send_all(sock, bytes, report_activity=None):
 
1896
def send_all(socket, bytes, report_activity=None):
2122
1897
    """Send all bytes on a socket.
2123
1898
 
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.
 
1899
    Regular socket.sendall() can give socket error 10053 on Windows.  This
 
1900
    implementation sends no more than 64k at a time, which avoids this problem.
2130
1901
 
2131
1902
    :param report_activity: Call this as bytes are read, see
2132
1903
        Transport._report_activity
2133
1904
    """
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
 
1905
    chunk_size = 2**16
 
1906
    for pos in xrange(0, len(bytes), chunk_size):
 
1907
        block = bytes[pos:pos+chunk_size]
 
1908
        if report_activity is not None:
 
1909
            report_activity(len(block), 'write')
 
1910
        until_no_eintr(socket.sendall, block)
2168
1911
 
2169
1912
 
2170
1913
def dereference_path(path):
2211
1954
    base = dirname(bzrlib.__file__)
2212
1955
    if getattr(sys, 'frozen', None):    # bzr.exe
2213
1956
        base = abspath(pathjoin(base, '..', '..'))
2214
 
    f = file(pathjoin(base, resource_relpath), "rU")
2215
 
    try:
2216
 
        return f.read()
2217
 
    finally:
2218
 
        f.close()
 
1957
    filename = pathjoin(base, resource_relpath)
 
1958
    return open(filename, 'rU').read()
 
1959
 
2219
1960
 
2220
1961
def file_kind_from_stat_mode_thunk(mode):
2221
1962
    global file_kind_from_stat_mode
2232
1973
    return file_kind_from_stat_mode(mode)
2233
1974
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2234
1975
 
2235
 
def file_stat(f, _lstat=os.lstat):
 
1976
 
 
1977
def file_kind(f, _lstat=os.lstat):
2236
1978
    try:
2237
 
        # XXX cache?
2238
 
        return _lstat(f)
 
1979
        return file_kind_from_stat_mode(_lstat(f).st_mode)
2239
1980
    except OSError, e:
2240
1981
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2241
1982
            raise errors.NoSuchFile(f)
2242
1983
        raise
2243
1984
 
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)
2247
1985
 
2248
1986
def until_no_eintr(f, *a, **kw):
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
 
    """
 
1987
    """Run f(*a, **kw), retrying if an EINTR error occurs."""
2261
1988
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
2262
1989
    while True:
2263
1990
        try:
2267
1994
                continue
2268
1995
            raise
2269
1996
 
2270
 
 
2271
 
@deprecated_function(deprecated_in((2, 2, 0)))
2272
1997
def re_compile_checked(re_string, flags=0, where=""):
2273
1998
    """Return a compiled re, or raise a sensible error.
2274
1999
 
2284
2009
        re_obj = re.compile(re_string, flags)
2285
2010
        re_obj.search("")
2286
2011
        return re_obj
2287
 
    except errors.InvalidPattern, e:
 
2012
    except re.error, e:
2288
2013
        if where:
2289
2014
            where = ' in ' + where
2290
2015
        # despite the name 'error' is a type
2291
 
        raise errors.BzrCommandError('Invalid regular expression%s: %s'
2292
 
            % (where, e.msg))
 
2016
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
 
2017
            % (where, re_string, e))
2293
2018
 
2294
2019
 
2295
2020
if sys.platform == "win32":
 
2021
    import msvcrt
2296
2022
    def getchar():
2297
 
        import msvcrt
2298
2023
        return msvcrt.getch()
2299
2024
else:
 
2025
    import tty
 
2026
    import termios
2300
2027
    def getchar():
2301
 
        import tty
2302
 
        import termios
2303
2028
        fd = sys.stdin.fileno()
2304
2029
        settings = termios.tcgetattr(fd)
2305
2030
        try:
2309
2034
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2310
2035
        return ch
2311
2036
 
2312
 
if sys.platform.startswith('linux'):
 
2037
 
 
2038
if sys.platform == 'linux2':
2313
2039
    def _local_concurrency():
2314
 
        try:
2315
 
            return os.sysconf('SC_NPROCESSORS_ONLN')
2316
 
        except (ValueError, OSError, AttributeError):
2317
 
            return None
 
2040
        concurrency = None
 
2041
        prefix = 'processor'
 
2042
        for line in file('/proc/cpuinfo', 'rb'):
 
2043
            if line.startswith(prefix):
 
2044
                concurrency = int(line[line.find(':')+1:]) + 1
 
2045
        return concurrency
2318
2046
elif sys.platform == 'darwin':
2319
2047
    def _local_concurrency():
2320
2048
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2321
2049
                                stdout=subprocess.PIPE).communicate()[0]
2322
 
elif "bsd" in sys.platform:
 
2050
elif sys.platform[0:7] == 'freebsd':
2323
2051
    def _local_concurrency():
2324
2052
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2325
2053
                                stdout=subprocess.PIPE).communicate()[0]
2353
2081
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2354
2082
    if concurrency is None:
2355
2083
        try:
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
 
2084
            concurrency = _local_concurrency()
 
2085
        except (OSError, IOError):
 
2086
            pass
2366
2087
    try:
2367
2088
        concurrency = int(concurrency)
2368
2089
    except (TypeError, ValueError):
2385
2106
        else:
2386
2107
            data, _ = self.encode(object, self.errors)
2387
2108
            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