← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Jelmer Vernooij
  • Date: 2011-04-19 10:42:59 UTC
  • mto: This revision was merged to the branch mainline in revision 5806.
  • Revision ID: jelmer@samba.org-20110419104259-g9exlcp1f5jdu3ci
Move Inventory._get_mutable_inventory -> mutable_inventory_from_tree.

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
 
from ntpath import (abspath as _nt_abspath,
30
 
                    join as _nt_join,
31
 
                    normpath as _nt_normpath,
32
 
                    realpath as _nt_realpath,
33
 
                    splitdrive as _nt_splitdrive,
34
 
                    )
 
28
import getpass
 
29
import ntpath
35
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
36
33
import shutil
37
 
from shutil import (
38
 
    rmtree,
39
 
    )
 
34
from shutil import rmtree
40
35
import socket
41
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
42
39
import tempfile
43
 
from tempfile import (
44
 
    mkdtemp,
45
 
    )
 
40
from tempfile import mkdtemp
46
41
import unicodedata
47
42
 
48
43
from bzrlib import (
101
96
        user_encoding = get_user_encoding()
102
97
        return [a.decode(user_encoding) for a in sys.argv[1:]]
103
98
    except UnicodeDecodeError:
104
 
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
105
 
                                                            "encoding." % a))
 
99
        raise errors.BzrError("Parameter %r encoding is unsupported by %s "
 
100
            "application locale." % (a, user_encoding))
106
101
 
107
102
 
108
103
def make_readonly(filename):
303
298
    running python.exe under cmd.exe return capital C:\\
304
299
    running win32 python inside a cygwin shell returns lowercase c:\\
305
300
    """
306
 
    drive, path = _nt_splitdrive(path)
 
301
    drive, path = ntpath.splitdrive(path)
307
302
    return drive.upper() + path
308
303
 
309
304
 
310
305
def _win32_abspath(path):
311
 
    # Real _nt_abspath doesn't have a problem with a unicode cwd
312
 
    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('\\', '/'))
313
308
 
314
309
 
315
310
def _win98_abspath(path):
326
321
    #   /path       => C:/path
327
322
    path = unicode(path)
328
323
    # check for absolute path
329
 
    drive = _nt_splitdrive(path)[0]
 
324
    drive = ntpath.splitdrive(path)[0]
330
325
    if drive == '' and path[:2] not in('//','\\\\'):
331
326
        cwd = os.getcwdu()
332
327
        # we cannot simply os.path.join cwd and path
333
328
        # because os.path.join('C:','/path') produce '/path'
334
329
        # and this is incorrect
335
330
        if path[:1] in ('/','\\'):
336
 
            cwd = _nt_splitdrive(cwd)[0]
 
331
            cwd = ntpath.splitdrive(cwd)[0]
337
332
            path = path[1:]
338
333
        path = cwd + '\\' + path
339
 
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
 
334
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
340
335
 
341
336
 
342
337
def _win32_realpath(path):
343
 
    # Real _nt_realpath doesn't have a problem with a unicode cwd
344
 
    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('\\', '/'))
345
340
 
346
341
 
347
342
def _win32_pathjoin(*args):
348
 
    return _nt_join(*args).replace('\\', '/')
 
343
    return ntpath.join(*args).replace('\\', '/')
349
344
 
350
345
 
351
346
def _win32_normpath(path):
352
 
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
347
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
353
348
 
354
349
 
355
350
def _win32_getcwd():
360
355
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
361
356
 
362
357
 
363
 
def _add_rename_error_details(e, old, new):
364
 
    new_e = OSError(e.errno, "failed to rename %s to %s: %s"
365
 
        % (old, new, e.strerror))
366
 
    new_e.filename = old
367
 
    new_e.to_filename = new
368
 
    return new_e
369
 
 
370
 
 
371
358
def _win32_rename(old, new):
372
359
    """We expect to be able to atomically replace 'new' with old.
373
360
 
375
362
    and then deleted.
376
363
    """
377
364
    try:
378
 
        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)
379
366
    except OSError, e:
380
367
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
381
368
            # If we try to rename a non-existant file onto cwd, we get
386
373
        raise
387
374
 
388
375
 
389
 
def _wrapped_rename(old, new):
390
 
    """Rename a file or directory"""
391
 
    try:
392
 
        os.rename(old, new)
393
 
    except (IOError, OSError), e:
394
 
        # this is eventually called by all rename-like functions, so should 
395
 
        # catch all of them
396
 
        raise _add_rename_error_details(e, old, new)
397
 
 
398
 
 
399
376
def _mac_getcwd():
400
377
    return unicodedata.normalize('NFC', os.getcwdu())
401
378
 
406
383
realpath = _posix_realpath
407
384
pathjoin = os.path.join
408
385
normpath = os.path.normpath
409
 
rename = _wrapped_rename # overridden below on win32
410
386
getcwd = os.getcwdu
 
387
rename = os.rename
411
388
dirname = os.path.dirname
412
389
basename = os.path.basename
413
390
split = os.path.split
414
391
splitext = os.path.splitext
415
 
# These were already imported into local scope
 
392
# These were already lazily imported into local scope
416
393
# mkdtemp = tempfile.mkdtemp
417
394
# rmtree = shutil.rmtree
 
395
lstat = os.lstat
 
396
fstat = os.fstat
 
397
 
 
398
def wrap_stat(st):
 
399
    return st
 
400
 
418
401
 
419
402
MIN_ABS_PATHLENGTH = 1
420
403
 
430
413
    getcwd = _win32_getcwd
431
414
    mkdtemp = _win32_mkdtemp
432
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
433
424
 
434
425
    MIN_ABS_PATHLENGTH = 3
435
426
 
458
449
    getcwd = _mac_getcwd
459
450
 
460
451
 
461
 
def get_terminal_encoding():
 
452
def get_terminal_encoding(trace=False):
462
453
    """Find the best encoding for printing to the screen.
463
454
 
464
455
    This attempts to check both sys.stdout and sys.stdin to see
470
461
 
471
462
    On my standard US Windows XP, the preferred encoding is
472
463
    cp1252, but the console is cp437
 
464
 
 
465
    :param trace: If True trace the selected encoding via mutter().
473
466
    """
474
467
    from bzrlib.trace import mutter
475
468
    output_encoding = getattr(sys.stdout, 'encoding', None)
477
470
        input_encoding = getattr(sys.stdin, 'encoding', None)
478
471
        if not input_encoding:
479
472
            output_encoding = get_user_encoding()
480
 
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
473
            if trace:
 
474
                mutter('encoding stdout as osutils.get_user_encoding() %r',
481
475
                   output_encoding)
482
476
        else:
483
477
            output_encoding = input_encoding
484
 
            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)
485
481
    else:
486
 
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
482
        if trace:
 
483
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
487
484
    if output_encoding == 'cp0':
488
485
        # invalid encoding (cp0 means 'no codepage' on Windows)
489
486
        output_encoding = get_user_encoding()
490
 
        mutter('cp0 is invalid encoding.'
 
487
        if trace:
 
488
            mutter('cp0 is invalid encoding.'
491
489
               ' encoding stdout as osutils.get_user_encoding() %r',
492
490
               output_encoding)
493
491
    # check encoding
519
517
def isdir(f):
520
518
    """True if f is an accessible directory."""
521
519
    try:
522
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
520
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
523
521
    except OSError:
524
522
        return False
525
523
 
527
525
def isfile(f):
528
526
    """True if f is a regular file."""
529
527
    try:
530
 
        return S_ISREG(os.lstat(f)[ST_MODE])
 
528
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
531
529
    except OSError:
532
530
        return False
533
531
 
534
532
def islink(f):
535
533
    """True if f is a symlink."""
536
534
    try:
537
 
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
535
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
538
536
    except OSError:
539
537
        return False
540
538
 
880
878
 
881
879
def filesize(f):
882
880
    """Return size of given open file."""
883
 
    return os.fstat(f.fileno())[ST_SIZE]
 
881
    return os.fstat(f.fileno())[stat.ST_SIZE]
884
882
 
885
883
 
886
884
# Define rand_bytes based on platform.
948
946
 
949
947
def parent_directories(filename):
950
948
    """Return the list of parent directories, deepest first.
951
 
    
 
949
 
952
950
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
953
951
    """
954
952
    parents = []
978
976
    # NB: This docstring is just an example, not a doctest, because doctest
979
977
    # currently can't cope with the use of lazy imports in this namespace --
980
978
    # mbp 20090729
981
 
    
 
979
 
982
980
    # This currently doesn't report the failure at the time it occurs, because
983
981
    # they tend to happen very early in startup when we can't check config
984
982
    # files etc, and also we want to report all failures but not spam the user
985
983
    # with 10 warnings.
986
 
    from bzrlib import trace
987
984
    exception_str = str(exception)
988
985
    if exception_str not in _extension_load_failures:
989
986
        trace.mutter("failed to load compiled extension: %s" % exception_str)
1054
1051
 
1055
1052
 
1056
1053
def delete_any(path):
1057
 
    """Delete a file, symlink or directory.  
1058
 
    
 
1054
    """Delete a file, symlink or directory.
 
1055
 
1059
1056
    Will delete even if readonly.
1060
1057
    """
1061
1058
    try:
1250
1247
    # but for now, we haven't optimized...
1251
1248
    return [canonical_relpath(base, p) for p in paths]
1252
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
 
1253
1266
def safe_unicode(unicode_or_utf8_string):
1254
1267
    """Coerce unicode_or_utf8_string into unicode.
1255
1268
 
1338
1351
def normalizes_filenames():
1339
1352
    """Return True if this platform normalizes unicode filenames.
1340
1353
 
1341
 
    Mac OSX does, Windows/Linux do not.
 
1354
    Only Mac OSX.
1342
1355
    """
1343
1356
    return _platform_normalizes_filenames
1344
1357
 
1349
1362
    On platforms where the system normalizes filenames (Mac OSX),
1350
1363
    you can access a file by any path which will normalize correctly.
1351
1364
    On platforms where the system does not normalize filenames
1352
 
    (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.
1353
1366
 
1354
1367
    Internally, bzr only supports NFC normalization, since that is
1355
1368
    the standard for XML documents.
1417
1430
terminal_width() returns None.
1418
1431
"""
1419
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
1420
1439
 
1421
1440
def terminal_width():
1422
1441
    """Return terminal width.
1426
1445
    The rules are:
1427
1446
    - if BZR_COLUMNS is set, returns its value
1428
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,
1429
1450
    - if COLUMNS is set, returns its value,
 
1451
    - if the OS has a value (even though it's never changed), return its value.
1430
1452
 
1431
1453
    From there, we need to query the OS to get the size of the controlling
1432
1454
    terminal.
1433
1455
 
1434
 
    Unices:
 
1456
    On Unices we query the OS by:
1435
1457
    - get termios.TIOCGWINSZ
1436
1458
    - if an error occurs or a negative value is obtained, returns None
1437
1459
 
1438
 
    Windows:
1439
 
    
 
1460
    On Windows we query the OS by:
1440
1461
    - win32utils.get_console_size() decides,
1441
1462
    - returns None on error (provided default value)
1442
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.
1443
1476
 
1444
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
1445
1479
    try:
1446
 
        return int(os.environ['BZR_COLUMNS'])
 
1480
        width = int(os.environ['BZR_COLUMNS'])
1447
1481
    except (KeyError, ValueError):
1448
 
        pass
 
1482
        width = None
 
1483
    if width is not None:
 
1484
        if width > 0:
 
1485
            return width
 
1486
        else:
 
1487
            return None
1449
1488
 
1450
1489
    isatty = getattr(sys.stdout, 'isatty', None)
1451
 
    if  isatty is None or not isatty():
 
1490
    if isatty is None or not isatty():
1452
1491
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1453
1492
        return None
1454
1493
 
1455
 
    # If COLUMNS is set, take it, the terminal knows better (even inside a
1456
 
    # given terminal, the application can decide to set COLUMNS to a lower
1457
 
    # 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.
1458
1511
    try:
1459
1512
        return int(os.environ['COLUMNS'])
1460
1513
    except (KeyError, ValueError):
1461
1514
        pass
1462
1515
 
1463
 
    width, height = _terminal_size(None, None)
1464
 
    if width <= 0:
1465
 
        # Consider invalid values as meaning no width
1466
 
        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
1467
1520
 
1468
 
    return width
 
1521
    # The width could not be determined.
 
1522
    return None
1469
1523
 
1470
1524
 
1471
1525
def _win32_terminal_size(width, height):
1498
1552
    _terminal_size = _ioctl_terminal_size
1499
1553
 
1500
1554
 
1501
 
def _terminal_size_changed(signum, frame):
1502
 
    """Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
1503
 
    width, height = _terminal_size(None, None)
1504
 
    if width is not None:
1505
 
        os.environ['COLUMNS'] = str(width)
1506
 
 
1507
 
 
1508
 
_registered_sigwinch = False
1509
 
def watch_sigwinch():
1510
 
    """Register for SIGWINCH, once and only once.
1511
 
 
1512
 
    Do nothing if the signal module is not available.
1513
 
    """
1514
 
    global _registered_sigwinch
1515
 
    if not _registered_sigwinch:
1516
 
        try:
1517
 
            import signal
1518
 
            if getattr(signal, "SIGWINCH", None) is not None:
1519
 
                set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
1520
 
        except ImportError:
1521
 
            # python doesn't provide signal support, nothing we can do about it
1522
 
            pass
1523
 
        _registered_sigwinch = True
1524
 
 
1525
 
 
1526
1555
def supports_executable():
1527
1556
    return sys.platform != "win32"
1528
1557
 
1651
1680
        dirblock = []
1652
1681
        append = dirblock.append
1653
1682
        try:
1654
 
            names = sorted(_listdir(top))
 
1683
            names = sorted(map(decode_filename, _listdir(top)))
1655
1684
        except OSError, e:
1656
1685
            if not _is_error_enotdir(e):
1657
1686
                raise
1865
1894
        s = os.stat(src)
1866
1895
        chown(dst, s.st_uid, s.st_gid)
1867
1896
    except OSError, e:
1868
 
        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()
1869
1901
 
1870
1902
 
1871
1903
def path_prefix_key(path):
1959
1991
    return user_encoding
1960
1992
 
1961
1993
 
 
1994
def get_diff_header_encoding():
 
1995
    return get_terminal_encoding()
 
1996
 
 
1997
 
1962
1998
def get_host_name():
1963
1999
    """Return the current unicode host name.
1964
2000
 
1979
2015
# data at once.
1980
2016
MAX_SOCKET_CHUNK = 64 * 1024
1981
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
 
1982
2026
def read_bytes_from_socket(sock, report_activity=None,
1983
2027
        max_read_size=MAX_SOCKET_CHUNK):
1984
2028
    """Read up to max_read_size of bytes from sock and notify of progress.
1992
2036
            bytes = sock.recv(max_read_size)
1993
2037
        except socket.error, e:
1994
2038
            eno = e.args[0]
1995
 
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
 
2039
            if eno in _end_of_stream_errors:
1996
2040
                # The connection was closed by the other side.  Callers expect
1997
2041
                # an empty string to signal end-of-stream.
1998
2042
                return ""
2027
2071
 
2028
2072
def send_all(sock, bytes, report_activity=None):
2029
2073
    """Send all bytes on a socket.
2030
 
 
 
2074
 
2031
2075
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2032
2076
    some platforms, and catches EINTR which may be thrown if the send is
2033
2077
    interrupted by a signal.
2034
2078
 
2035
2079
    This is preferred to socket.sendall(), because it avoids portability bugs
2036
2080
    and provides activity reporting.
2037
 
 
 
2081
 
2038
2082
    :param report_activity: Call this as bytes are read, see
2039
2083
        Transport._report_activity
2040
2084
    """
2051
2095
            report_activity(sent, 'write')
2052
2096
 
2053
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
 
2054
2121
def dereference_path(path):
2055
2122
    """Determine the real path to a file.
2056
2123
 
2095
2162
    base = dirname(bzrlib.__file__)
2096
2163
    if getattr(sys, 'frozen', None):    # bzr.exe
2097
2164
        base = abspath(pathjoin(base, '..', '..'))
2098
 
    filename = pathjoin(base, resource_relpath)
2099
 
    return open(filename, 'rU').read()
2100
 
 
 
2165
    f = file(pathjoin(base, resource_relpath), "rU")
 
2166
    try:
 
2167
        return f.read()
 
2168
    finally:
 
2169
        f.close()
2101
2170
 
2102
2171
def file_kind_from_stat_mode_thunk(mode):
2103
2172
    global file_kind_from_stat_mode
2126
2195
 
2127
2196
def until_no_eintr(f, *a, **kw):
2128
2197
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2129
 
    
 
2198
 
2130
2199
    WARNING: you must be certain that it is safe to retry the call repeatedly
2131
2200
    if EINTR does occur.  This is typically only true for low-level operations
2132
2201
    like os.read.  If in any doubt, don't use this.
2147
2216
            raise
2148
2217
 
2149
2218
 
 
2219
@deprecated_function(deprecated_in((2, 2, 0)))
2150
2220
def re_compile_checked(re_string, flags=0, where=""):
2151
2221
    """Return a compiled re, or raise a sensible error.
2152
2222
 
2162
2232
        re_obj = re.compile(re_string, flags)
2163
2233
        re_obj.search("")
2164
2234
        return re_obj
2165
 
    except re.error, e:
 
2235
    except errors.InvalidPattern, e:
2166
2236
        if where:
2167
2237
            where = ' in ' + where
2168
2238
        # despite the name 'error' is a type
2169
 
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2170
 
            % (where, re_string, e))
 
2239
        raise errors.BzrCommandError('Invalid regular expression%s: %s'
 
2240
            % (where, e.msg))
2171
2241
 
2172
2242
 
2173
2243
if sys.platform == "win32":
2187
2257
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2188
2258
        return ch
2189
2259
 
2190
 
 
2191
2260
if sys.platform == 'linux2':
2192
2261
    def _local_concurrency():
2193
 
        concurrency = None
2194
 
        prefix = 'processor'
2195
 
        for line in file('/proc/cpuinfo', 'rb'):
2196
 
            if line.startswith(prefix):
2197
 
                concurrency = int(line[line.find(':')+1:]) + 1
2198
 
        return concurrency
 
2262
        try:
 
2263
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2264
        except (ValueError, OSError, AttributeError):
 
2265
            return None
2199
2266
elif sys.platform == 'darwin':
2200
2267
    def _local_concurrency():
2201
2268
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2202
2269
                                stdout=subprocess.PIPE).communicate()[0]
2203
 
elif sys.platform[0:7] == 'freebsd':
 
2270
elif "bsd" in sys.platform:
2204
2271
    def _local_concurrency():
2205
2272
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2206
2273
                                stdout=subprocess.PIPE).communicate()[0]
2234
2301
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2235
2302
    if concurrency is None:
2236
2303
        try:
2237
 
            concurrency = _local_concurrency()
2238
 
        except (OSError, IOError):
2239
 
            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()
2240
2313
    try:
2241
2314
        concurrency = int(concurrency)
2242
2315
    except (TypeError, ValueError):
2263
2336
if sys.platform == 'win32':
2264
2337
    def open_file(filename, mode='r', bufsize=-1):
2265
2338
        """This function is used to override the ``open`` builtin.
2266
 
        
 
2339
 
2267
2340
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2268
2341
        child processes.  Deleting or renaming a closed file opened with this
2269
2342
        function is not blocking child processes.
2302
2375
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2303
2376
else:
2304
2377
    open_file = open
 
2378
 
 
2379
 
 
2380
def getuser_unicode():
 
2381
    """Return the username as unicode.
 
2382
    """
 
2383
    try:
 
2384
        user_encoding = get_user_encoding()
 
2385
        username = getpass.getuser().decode(user_encoding)
 
2386
    except UnicodeDecodeError:
 
2387
        raise errors.BzrError("Can't decode username as %s." % \
 
2388
                user_encoding)
 
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