/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: John Arbash Meinel
  • Date: 2011-04-07 10:36:24 UTC
  • mfrom: (5764 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5766.
  • Revision ID: john@arbash-meinel.com-20110407103624-n76g6tjeqmznwdcd
Merge bzr.dev 5764 to resolve release-notes (aka NEWS) conflicts

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/osutils.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
import errno
17
18
import os
18
19
import re
19
20
import stat
20
 
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
21
21
import sys
22
22
import time
23
23
import codecs
25
25
from bzrlib.lazy_import import lazy_import
26
26
lazy_import(globals(), """
27
27
from datetime import datetime
28
 
import errno
29
28
import getpass
30
 
from ntpath import (abspath as _nt_abspath,
31
 
                    join as _nt_join,
32
 
                    normpath as _nt_normpath,
33
 
                    realpath as _nt_realpath,
34
 
                    splitdrive as _nt_splitdrive,
35
 
                    )
 
29
import ntpath
36
30
import posixpath
 
31
# We need to import both shutil and rmtree as we export the later on posix
 
32
# and need the former on windows
37
33
import shutil
38
 
from shutil import (
39
 
    rmtree,
40
 
    )
 
34
from shutil import rmtree
41
35
import socket
42
36
import subprocess
 
37
# We need to import both tempfile and mkdtemp as we export the later on posix
 
38
# and need the former on windows
43
39
import tempfile
44
 
from tempfile import (
45
 
    mkdtemp,
46
 
    )
 
40
from tempfile import mkdtemp
47
41
import unicodedata
48
42
 
49
43
from bzrlib import (
304
298
    running python.exe under cmd.exe return capital C:\\
305
299
    running win32 python inside a cygwin shell returns lowercase c:\\
306
300
    """
307
 
    drive, path = _nt_splitdrive(path)
 
301
    drive, path = ntpath.splitdrive(path)
308
302
    return drive.upper() + path
309
303
 
310
304
 
311
305
def _win32_abspath(path):
312
 
    # Real _nt_abspath doesn't have a problem with a unicode cwd
313
 
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
 
306
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
 
307
    return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
314
308
 
315
309
 
316
310
def _win98_abspath(path):
327
321
    #   /path       => C:/path
328
322
    path = unicode(path)
329
323
    # check for absolute path
330
 
    drive = _nt_splitdrive(path)[0]
 
324
    drive = ntpath.splitdrive(path)[0]
331
325
    if drive == '' and path[:2] not in('//','\\\\'):
332
326
        cwd = os.getcwdu()
333
327
        # we cannot simply os.path.join cwd and path
334
328
        # because os.path.join('C:','/path') produce '/path'
335
329
        # and this is incorrect
336
330
        if path[:1] in ('/','\\'):
337
 
            cwd = _nt_splitdrive(cwd)[0]
 
331
            cwd = ntpath.splitdrive(cwd)[0]
338
332
            path = path[1:]
339
333
        path = cwd + '\\' + path
340
 
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
 
334
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
341
335
 
342
336
 
343
337
def _win32_realpath(path):
344
 
    # Real _nt_realpath doesn't have a problem with a unicode cwd
345
 
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
 
338
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
 
339
    return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
346
340
 
347
341
 
348
342
def _win32_pathjoin(*args):
349
 
    return _nt_join(*args).replace('\\', '/')
 
343
    return ntpath.join(*args).replace('\\', '/')
350
344
 
351
345
 
352
346
def _win32_normpath(path):
353
 
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
347
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
354
348
 
355
349
 
356
350
def _win32_getcwd():
361
355
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
362
356
 
363
357
 
364
 
def _add_rename_error_details(e, old, new):
365
 
    new_e = OSError(e.errno, "failed to rename %s to %s: %s"
366
 
        % (old, new, e.strerror))
367
 
    new_e.filename = old
368
 
    new_e.to_filename = new
369
 
    return new_e
370
 
 
371
 
 
372
358
def _win32_rename(old, new):
373
359
    """We expect to be able to atomically replace 'new' with old.
374
360
 
376
362
    and then deleted.
377
363
    """
378
364
    try:
379
 
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
 
365
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
380
366
    except OSError, e:
381
367
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
382
368
            # If we try to rename a non-existant file onto cwd, we get
387
373
        raise
388
374
 
389
375
 
390
 
def _wrapped_rename(old, new):
391
 
    """Rename a file or directory"""
392
 
    try:
393
 
        os.rename(old, new)
394
 
    except (IOError, OSError), e:
395
 
        # this is eventually called by all rename-like functions, so should 
396
 
        # catch all of them
397
 
        raise _add_rename_error_details(e, old, new)
398
 
 
399
 
 
400
376
def _mac_getcwd():
401
377
    return unicodedata.normalize('NFC', os.getcwdu())
402
378
 
407
383
realpath = _posix_realpath
408
384
pathjoin = os.path.join
409
385
normpath = os.path.normpath
410
 
rename = _wrapped_rename # overridden below on win32
411
386
getcwd = os.getcwdu
 
387
rename = os.rename
412
388
dirname = os.path.dirname
413
389
basename = os.path.basename
414
390
split = os.path.split
415
391
splitext = os.path.splitext
416
 
# These were already imported into local scope
 
392
# These were already lazily imported into local scope
417
393
# mkdtemp = tempfile.mkdtemp
418
394
# rmtree = shutil.rmtree
 
395
lstat = os.lstat
 
396
fstat = os.fstat
 
397
 
 
398
def wrap_stat(st):
 
399
    return st
 
400
 
419
401
 
420
402
MIN_ABS_PATHLENGTH = 1
421
403
 
431
413
    getcwd = _win32_getcwd
432
414
    mkdtemp = _win32_mkdtemp
433
415
    rename = _win32_rename
 
416
    try:
 
417
        from bzrlib import _walkdirs_win32
 
418
    except ImportError:
 
419
        pass
 
420
    else:
 
421
        lstat = _walkdirs_win32.lstat
 
422
        fstat = _walkdirs_win32.fstat
 
423
        wrap_stat = _walkdirs_win32.wrap_stat
434
424
 
435
425
    MIN_ABS_PATHLENGTH = 3
436
426
 
459
449
    getcwd = _mac_getcwd
460
450
 
461
451
 
462
 
def get_terminal_encoding():
 
452
def get_terminal_encoding(trace=False):
463
453
    """Find the best encoding for printing to the screen.
464
454
 
465
455
    This attempts to check both sys.stdout and sys.stdin to see
471
461
 
472
462
    On my standard US Windows XP, the preferred encoding is
473
463
    cp1252, but the console is cp437
 
464
 
 
465
    :param trace: If True trace the selected encoding via mutter().
474
466
    """
475
467
    from bzrlib.trace import mutter
476
468
    output_encoding = getattr(sys.stdout, 'encoding', None)
478
470
        input_encoding = getattr(sys.stdin, 'encoding', None)
479
471
        if not input_encoding:
480
472
            output_encoding = get_user_encoding()
481
 
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
473
            if trace:
 
474
                mutter('encoding stdout as osutils.get_user_encoding() %r',
482
475
                   output_encoding)
483
476
        else:
484
477
            output_encoding = input_encoding
485
 
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
478
            if trace:
 
479
                mutter('encoding stdout as sys.stdin encoding %r',
 
480
                    output_encoding)
486
481
    else:
487
 
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
482
        if trace:
 
483
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
488
484
    if output_encoding == 'cp0':
489
485
        # invalid encoding (cp0 means 'no codepage' on Windows)
490
486
        output_encoding = get_user_encoding()
491
 
        mutter('cp0 is invalid encoding.'
 
487
        if trace:
 
488
            mutter('cp0 is invalid encoding.'
492
489
               ' encoding stdout as osutils.get_user_encoding() %r',
493
490
               output_encoding)
494
491
    # check encoding
520
517
def isdir(f):
521
518
    """True if f is an accessible directory."""
522
519
    try:
523
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
520
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
524
521
    except OSError:
525
522
        return False
526
523
 
528
525
def isfile(f):
529
526
    """True if f is a regular file."""
530
527
    try:
531
 
        return S_ISREG(os.lstat(f)[ST_MODE])
 
528
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
532
529
    except OSError:
533
530
        return False
534
531
 
535
532
def islink(f):
536
533
    """True if f is a symlink."""
537
534
    try:
538
 
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
535
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
539
536
    except OSError:
540
537
        return False
541
538
 
881
878
 
882
879
def filesize(f):
883
880
    """Return size of given open file."""
884
 
    return os.fstat(f.fileno())[ST_SIZE]
 
881
    return os.fstat(f.fileno())[stat.ST_SIZE]
885
882
 
886
883
 
887
884
# Define rand_bytes based on platform.
949
946
 
950
947
def parent_directories(filename):
951
948
    """Return the list of parent directories, deepest first.
952
 
    
 
949
 
953
950
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
954
951
    """
955
952
    parents = []
979
976
    # NB: This docstring is just an example, not a doctest, because doctest
980
977
    # currently can't cope with the use of lazy imports in this namespace --
981
978
    # mbp 20090729
982
 
    
 
979
 
983
980
    # This currently doesn't report the failure at the time it occurs, because
984
981
    # they tend to happen very early in startup when we can't check config
985
982
    # files etc, and also we want to report all failures but not spam the user
986
983
    # with 10 warnings.
987
 
    from bzrlib import trace
988
984
    exception_str = str(exception)
989
985
    if exception_str not in _extension_load_failures:
990
986
        trace.mutter("failed to load compiled extension: %s" % exception_str)
1055
1051
 
1056
1052
 
1057
1053
def delete_any(path):
1058
 
    """Delete a file, symlink or directory.  
1059
 
    
 
1054
    """Delete a file, symlink or directory.
 
1055
 
1060
1056
    Will delete even if readonly.
1061
1057
    """
1062
1058
    try:
1251
1247
    # but for now, we haven't optimized...
1252
1248
    return [canonical_relpath(base, p) for p in paths]
1253
1249
 
 
1250
 
 
1251
def decode_filename(filename):
 
1252
    """Decode the filename using the filesystem encoding
 
1253
 
 
1254
    If it is unicode, it is returned.
 
1255
    Otherwise it is decoded from the the filesystem's encoding. If decoding
 
1256
    fails, a errors.BadFilenameEncoding exception is raised.
 
1257
    """
 
1258
    if type(filename) is unicode:
 
1259
        return filename
 
1260
    try:
 
1261
        return filename.decode(_fs_enc)
 
1262
    except UnicodeDecodeError:
 
1263
        raise errors.BadFilenameEncoding(filename, _fs_enc)
 
1264
 
 
1265
 
1254
1266
def safe_unicode(unicode_or_utf8_string):
1255
1267
    """Coerce unicode_or_utf8_string into unicode.
1256
1268
 
1339
1351
def normalizes_filenames():
1340
1352
    """Return True if this platform normalizes unicode filenames.
1341
1353
 
1342
 
    Mac OSX does, Windows/Linux do not.
 
1354
    Only Mac OSX.
1343
1355
    """
1344
1356
    return _platform_normalizes_filenames
1345
1357
 
1350
1362
    On platforms where the system normalizes filenames (Mac OSX),
1351
1363
    you can access a file by any path which will normalize correctly.
1352
1364
    On platforms where the system does not normalize filenames
1353
 
    (Windows, Linux), you have to access a file by its exact path.
 
1365
    (everything else), you have to access a file by its exact path.
1354
1366
 
1355
1367
    Internally, bzr only supports NFC normalization, since that is
1356
1368
    the standard for XML documents.
1418
1430
terminal_width() returns None.
1419
1431
"""
1420
1432
 
 
1433
# Keep some state so that terminal_width can detect if _terminal_size has
 
1434
# returned a different size since the process started.  See docstring and
 
1435
# comments of terminal_width for details.
 
1436
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
 
1437
_terminal_size_state = 'no_data'
 
1438
_first_terminal_size = None
1421
1439
 
1422
1440
def terminal_width():
1423
1441
    """Return terminal width.
1427
1445
    The rules are:
1428
1446
    - if BZR_COLUMNS is set, returns its value
1429
1447
    - if there is no controlling terminal, returns None
 
1448
    - query the OS, if the queried size has changed since the last query,
 
1449
      return its value,
1430
1450
    - if COLUMNS is set, returns its value,
 
1451
    - if the OS has a value (even though it's never changed), return its value.
1431
1452
 
1432
1453
    From there, we need to query the OS to get the size of the controlling
1433
1454
    terminal.
1434
1455
 
1435
 
    Unices:
 
1456
    On Unices we query the OS by:
1436
1457
    - get termios.TIOCGWINSZ
1437
1458
    - if an error occurs or a negative value is obtained, returns None
1438
1459
 
1439
 
    Windows:
1440
 
    
 
1460
    On Windows we query the OS by:
1441
1461
    - win32utils.get_console_size() decides,
1442
1462
    - returns None on error (provided default value)
1443
1463
    """
 
1464
    # Note to implementors: if changing the rules for determining the width,
 
1465
    # make sure you've considered the behaviour in these cases:
 
1466
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
 
1467
    #  - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
 
1468
    #    0,0.
 
1469
    #  - (add more interesting cases here, if you find any)
 
1470
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
 
1471
    # but we don't want to register a signal handler because it is impossible
 
1472
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
 
1473
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
 
1474
    # time so we can notice if the reported size has changed, which should have
 
1475
    # a similar effect.
1444
1476
 
1445
1477
    # If BZR_COLUMNS is set, take it, user is always right
 
1478
    # Except if they specified 0 in which case, impose no limit here
1446
1479
    try:
1447
 
        return int(os.environ['BZR_COLUMNS'])
 
1480
        width = int(os.environ['BZR_COLUMNS'])
1448
1481
    except (KeyError, ValueError):
1449
 
        pass
 
1482
        width = None
 
1483
    if width is not None:
 
1484
        if width > 0:
 
1485
            return width
 
1486
        else:
 
1487
            return None
1450
1488
 
1451
1489
    isatty = getattr(sys.stdout, 'isatty', None)
1452
 
    if  isatty is None or not isatty():
 
1490
    if isatty is None or not isatty():
1453
1491
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1454
1492
        return None
1455
1493
 
1456
 
    # If COLUMNS is set, take it, the terminal knows better (even inside a
1457
 
    # given terminal, the application can decide to set COLUMNS to a lower
1458
 
    # value (splitted screen) or a bigger value (scroll bars))
 
1494
    # Query the OS
 
1495
    width, height = os_size = _terminal_size(None, None)
 
1496
    global _first_terminal_size, _terminal_size_state
 
1497
    if _terminal_size_state == 'no_data':
 
1498
        _first_terminal_size = os_size
 
1499
        _terminal_size_state = 'unchanged'
 
1500
    elif (_terminal_size_state == 'unchanged' and
 
1501
          _first_terminal_size != os_size):
 
1502
        _terminal_size_state = 'changed'
 
1503
 
 
1504
    # If the OS claims to know how wide the terminal is, and this value has
 
1505
    # ever changed, use that.
 
1506
    if _terminal_size_state == 'changed':
 
1507
        if width is not None and width > 0:
 
1508
            return width
 
1509
 
 
1510
    # If COLUMNS is set, use it.
1459
1511
    try:
1460
1512
        return int(os.environ['COLUMNS'])
1461
1513
    except (KeyError, ValueError):
1462
1514
        pass
1463
1515
 
1464
 
    width, height = _terminal_size(None, None)
1465
 
    if width <= 0:
1466
 
        # Consider invalid values as meaning no width
1467
 
        return None
 
1516
    # Finally, use an unchanged size from the OS, if we have one.
 
1517
    if _terminal_size_state == 'unchanged':
 
1518
        if width is not None and width > 0:
 
1519
            return width
1468
1520
 
1469
 
    return width
 
1521
    # The width could not be determined.
 
1522
    return None
1470
1523
 
1471
1524
 
1472
1525
def _win32_terminal_size(width, height):
1499
1552
    _terminal_size = _ioctl_terminal_size
1500
1553
 
1501
1554
 
1502
 
def _terminal_size_changed(signum, frame):
1503
 
    """Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
1504
 
    width, height = _terminal_size(None, None)
1505
 
    if width is not None:
1506
 
        os.environ['COLUMNS'] = str(width)
1507
 
 
1508
 
 
1509
 
_registered_sigwinch = False
1510
 
def watch_sigwinch():
1511
 
    """Register for SIGWINCH, once and only once.
1512
 
 
1513
 
    Do nothing if the signal module is not available.
1514
 
    """
1515
 
    global _registered_sigwinch
1516
 
    if not _registered_sigwinch:
1517
 
        try:
1518
 
            import signal
1519
 
            if getattr(signal, "SIGWINCH", None) is not None:
1520
 
                set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
1521
 
        except ImportError:
1522
 
            # python doesn't provide signal support, nothing we can do about it
1523
 
            pass
1524
 
        _registered_sigwinch = True
1525
 
 
1526
 
 
1527
1555
def supports_executable():
1528
1556
    return sys.platform != "win32"
1529
1557
 
1652
1680
        dirblock = []
1653
1681
        append = dirblock.append
1654
1682
        try:
1655
 
            names = sorted(_listdir(top))
 
1683
            names = sorted(map(decode_filename, _listdir(top)))
1656
1684
        except OSError, e:
1657
1685
            if not _is_error_enotdir(e):
1658
1686
                raise
1866
1894
        s = os.stat(src)
1867
1895
        chown(dst, s.st_uid, s.st_gid)
1868
1896
    except OSError, e:
1869
 
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
 
1897
        trace.warning(
 
1898
            'Unable to copy ownership from "%s" to "%s". '
 
1899
            'You may want to set it manually.', src, dst)
 
1900
        trace.log_exception_quietly()
1870
1901
 
1871
1902
 
1872
1903
def path_prefix_key(path):
1960
1991
    return user_encoding
1961
1992
 
1962
1993
 
 
1994
def get_diff_header_encoding():
 
1995
    return get_terminal_encoding()
 
1996
 
 
1997
 
1963
1998
def get_host_name():
1964
1999
    """Return the current unicode host name.
1965
2000
 
1980
2015
# data at once.
1981
2016
MAX_SOCKET_CHUNK = 64 * 1024
1982
2017
 
 
2018
_end_of_stream_errors = [errno.ECONNRESET]
 
2019
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
 
2020
    _eno = getattr(errno, _eno, None)
 
2021
    if _eno is not None:
 
2022
        _end_of_stream_errors.append(_eno)
 
2023
del _eno
 
2024
 
 
2025
 
1983
2026
def read_bytes_from_socket(sock, report_activity=None,
1984
2027
        max_read_size=MAX_SOCKET_CHUNK):
1985
2028
    """Read up to max_read_size of bytes from sock and notify of progress.
1993
2036
            bytes = sock.recv(max_read_size)
1994
2037
        except socket.error, e:
1995
2038
            eno = e.args[0]
1996
 
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
 
2039
            if eno in _end_of_stream_errors:
1997
2040
                # The connection was closed by the other side.  Callers expect
1998
2041
                # an empty string to signal end-of-stream.
1999
2042
                return ""
2028
2071
 
2029
2072
def send_all(sock, bytes, report_activity=None):
2030
2073
    """Send all bytes on a socket.
2031
 
 
 
2074
 
2032
2075
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2033
2076
    some platforms, and catches EINTR which may be thrown if the send is
2034
2077
    interrupted by a signal.
2035
2078
 
2036
2079
    This is preferred to socket.sendall(), because it avoids portability bugs
2037
2080
    and provides activity reporting.
2038
 
 
 
2081
 
2039
2082
    :param report_activity: Call this as bytes are read, see
2040
2083
        Transport._report_activity
2041
2084
    """
2052
2095
            report_activity(sent, 'write')
2053
2096
 
2054
2097
 
 
2098
def connect_socket(address):
 
2099
    # Slight variation of the socket.create_connection() function (provided by
 
2100
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
 
2101
    # provide it for previous python versions. Also, we don't use the timeout
 
2102
    # parameter (provided by the python implementation) so we don't implement
 
2103
    # it either).
 
2104
    err = socket.error('getaddrinfo returns an empty list')
 
2105
    host, port = address
 
2106
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
 
2107
        af, socktype, proto, canonname, sa = res
 
2108
        sock = None
 
2109
        try:
 
2110
            sock = socket.socket(af, socktype, proto)
 
2111
            sock.connect(sa)
 
2112
            return sock
 
2113
 
 
2114
        except socket.error, err:
 
2115
            # 'err' is now the most recent error
 
2116
            if sock is not None:
 
2117
                sock.close()
 
2118
    raise err
 
2119
 
 
2120
 
2055
2121
def dereference_path(path):
2056
2122
    """Determine the real path to a file.
2057
2123
 
2096
2162
    base = dirname(bzrlib.__file__)
2097
2163
    if getattr(sys, 'frozen', None):    # bzr.exe
2098
2164
        base = abspath(pathjoin(base, '..', '..'))
2099
 
    filename = pathjoin(base, resource_relpath)
2100
 
    return open(filename, 'rU').read()
2101
 
 
 
2165
    f = file(pathjoin(base, resource_relpath), "rU")
 
2166
    try:
 
2167
        return f.read()
 
2168
    finally:
 
2169
        f.close()
2102
2170
 
2103
2171
def file_kind_from_stat_mode_thunk(mode):
2104
2172
    global file_kind_from_stat_mode
2127
2195
 
2128
2196
def until_no_eintr(f, *a, **kw):
2129
2197
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2130
 
    
 
2198
 
2131
2199
    WARNING: you must be certain that it is safe to retry the call repeatedly
2132
2200
    if EINTR does occur.  This is typically only true for low-level operations
2133
2201
    like os.read.  If in any doubt, don't use this.
2148
2216
            raise
2149
2217
 
2150
2218
 
 
2219
@deprecated_function(deprecated_in((2, 2, 0)))
2151
2220
def re_compile_checked(re_string, flags=0, where=""):
2152
2221
    """Return a compiled re, or raise a sensible error.
2153
2222
 
2163
2232
        re_obj = re.compile(re_string, flags)
2164
2233
        re_obj.search("")
2165
2234
        return re_obj
2166
 
    except re.error, e:
 
2235
    except errors.InvalidPattern, e:
2167
2236
        if where:
2168
2237
            where = ' in ' + where
2169
2238
        # despite the name 'error' is a type
2170
 
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2171
 
            % (where, re_string, e))
 
2239
        raise errors.BzrCommandError('Invalid regular expression%s: %s'
 
2240
            % (where, e.msg))
2172
2241
 
2173
2242
 
2174
2243
if sys.platform == "win32":
2188
2257
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2189
2258
        return ch
2190
2259
 
2191
 
 
2192
2260
if sys.platform == 'linux2':
2193
2261
    def _local_concurrency():
2194
 
        concurrency = None
2195
 
        prefix = 'processor'
2196
 
        for line in file('/proc/cpuinfo', 'rb'):
2197
 
            if line.startswith(prefix):
2198
 
                concurrency = int(line[line.find(':')+1:]) + 1
2199
 
        return concurrency
 
2262
        try:
 
2263
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2264
        except (ValueError, OSError, AttributeError):
 
2265
            return None
2200
2266
elif sys.platform == 'darwin':
2201
2267
    def _local_concurrency():
2202
2268
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2203
2269
                                stdout=subprocess.PIPE).communicate()[0]
2204
 
elif sys.platform[0:7] == 'freebsd':
 
2270
elif "bsd" in sys.platform:
2205
2271
    def _local_concurrency():
2206
2272
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2207
2273
                                stdout=subprocess.PIPE).communicate()[0]
2235
2301
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2236
2302
    if concurrency is None:
2237
2303
        try:
2238
 
            concurrency = _local_concurrency()
2239
 
        except (OSError, IOError):
2240
 
            pass
 
2304
            import multiprocessing
 
2305
        except ImportError:
 
2306
            # multiprocessing is only available on Python >= 2.6
 
2307
            try:
 
2308
                concurrency = _local_concurrency()
 
2309
            except (OSError, IOError):
 
2310
                pass
 
2311
        else:
 
2312
            concurrency = multiprocessing.cpu_count()
2241
2313
    try:
2242
2314
        concurrency = int(concurrency)
2243
2315
    except (TypeError, ValueError):
2264
2336
if sys.platform == 'win32':
2265
2337
    def open_file(filename, mode='r', bufsize=-1):
2266
2338
        """This function is used to override the ``open`` builtin.
2267
 
        
 
2339
 
2268
2340
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2269
2341
        child processes.  Deleting or renaming a closed file opened with this
2270
2342
        function is not blocking child processes.
2315
2387
        raise errors.BzrError("Can't decode username as %s." % \
2316
2388
                user_encoding)
2317
2389
    return username
 
2390
 
 
2391
 
 
2392
def available_backup_name(base, exists):
 
2393
    """Find a non-existing backup file name.
 
2394
 
 
2395
    This will *not* create anything, this only return a 'free' entry.  This
 
2396
    should be used for checking names in a directory below a locked
 
2397
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
 
2398
    Leap) and generally discouraged.
 
2399
 
 
2400
    :param base: The base name.
 
2401
 
 
2402
    :param exists: A callable returning True if the path parameter exists.
 
2403
    """
 
2404
    counter = 1
 
2405
    name = "%s.~%d~" % (base, counter)
 
2406
    while exists(name):
 
2407
        counter += 1
 
2408
        name = "%s.~%d~" % (base, counter)
 
2409
    return name
 
2410
 
 
2411
 
 
2412
def set_fd_cloexec(fd):
 
2413
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
 
2414
    support for this is not available.
 
2415
    """
 
2416
    try:
 
2417
        import fcntl
 
2418
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
 
2419
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
 
2420
    except (ImportError, AttributeError):
 
2421
        # Either the fcntl module or specific constants are not present
 
2422
        pass
 
2423
 
 
2424
 
 
2425
def find_executable_on_path(name):
 
2426
    """Finds an executable on the PATH.
 
2427
    
 
2428
    On Windows, this will try to append each extension in the PATHEXT
 
2429
    environment variable to the name, if it cannot be found with the name
 
2430
    as given.
 
2431
    
 
2432
    :param name: The base name of the executable.
 
2433
    :return: The path to the executable found or None.
 
2434
    """
 
2435
    path = os.environ.get('PATH')
 
2436
    if path is None:
 
2437
        return None
 
2438
    path = path.split(os.pathsep)
 
2439
    if sys.platform == 'win32':
 
2440
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
 
2441
        exts = [ext.lower() for ext in exts]
 
2442
        base, ext = os.path.splitext(name)
 
2443
        if ext != '':
 
2444
            if ext.lower() not in exts:
 
2445
                return None
 
2446
            name = base
 
2447
            exts = [ext]
 
2448
    else:
 
2449
        exts = ['']
 
2450
    for ext in exts:
 
2451
        for d in path:
 
2452
            f = os.path.join(d, name) + ext
 
2453
            if os.access(f, os.X_OK):
 
2454
                return f
 
2455
    return None