/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: Martin
  • Date: 2011-05-21 16:43:19 UTC
  • mto: This revision was merged to the branch mainline in revision 5907.
  • Revision ID: gzlist@googlemail.com-20110521164319-5ua6aoazejsvef0w
Avoid implicit str casting in trace methods by calling unicode() on conflict objects first

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 (
59
53
    deprecated_in,
60
54
    )
61
55
 
62
 
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
63
 
# of 2.5
64
 
if sys.version_info < (2, 5):
65
 
    import md5 as _mod_md5
66
 
    md5 = _mod_md5.new
67
 
    import sha as _mod_sha
68
 
    sha = _mod_sha.new
69
 
else:
70
 
    from hashlib import (
71
 
        md5,
72
 
        sha1 as sha,
73
 
        )
 
56
from hashlib import (
 
57
    md5,
 
58
    sha1 as sha,
 
59
    )
74
60
 
75
61
 
76
62
import bzrlib
102
88
        user_encoding = get_user_encoding()
103
89
        return [a.decode(user_encoding) for a in sys.argv[1:]]
104
90
    except UnicodeDecodeError:
105
 
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
106
 
                                                            "encoding." % a))
 
91
        raise errors.BzrError("Parameter %r encoding is unsupported by %s "
 
92
            "application locale." % (a, user_encoding))
107
93
 
108
94
 
109
95
def make_readonly(filename):
304
290
    running python.exe under cmd.exe return capital C:\\
305
291
    running win32 python inside a cygwin shell returns lowercase c:\\
306
292
    """
307
 
    drive, path = _nt_splitdrive(path)
 
293
    drive, path = ntpath.splitdrive(path)
308
294
    return drive.upper() + path
309
295
 
310
296
 
311
297
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('\\', '/'))
 
298
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
 
299
    return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
314
300
 
315
301
 
316
302
def _win98_abspath(path):
327
313
    #   /path       => C:/path
328
314
    path = unicode(path)
329
315
    # check for absolute path
330
 
    drive = _nt_splitdrive(path)[0]
 
316
    drive = ntpath.splitdrive(path)[0]
331
317
    if drive == '' and path[:2] not in('//','\\\\'):
332
318
        cwd = os.getcwdu()
333
319
        # we cannot simply os.path.join cwd and path
334
320
        # because os.path.join('C:','/path') produce '/path'
335
321
        # and this is incorrect
336
322
        if path[:1] in ('/','\\'):
337
 
            cwd = _nt_splitdrive(cwd)[0]
 
323
            cwd = ntpath.splitdrive(cwd)[0]
338
324
            path = path[1:]
339
325
        path = cwd + '\\' + path
340
 
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
 
326
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
341
327
 
342
328
 
343
329
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('\\', '/'))
 
330
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
 
331
    return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
346
332
 
347
333
 
348
334
def _win32_pathjoin(*args):
349
 
    return _nt_join(*args).replace('\\', '/')
 
335
    return ntpath.join(*args).replace('\\', '/')
350
336
 
351
337
 
352
338
def _win32_normpath(path):
353
 
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
339
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
354
340
 
355
341
 
356
342
def _win32_getcwd():
361
347
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
362
348
 
363
349
 
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
350
def _win32_rename(old, new):
373
351
    """We expect to be able to atomically replace 'new' with old.
374
352
 
376
354
    and then deleted.
377
355
    """
378
356
    try:
379
 
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
 
357
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
380
358
    except OSError, e:
381
359
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
382
360
            # If we try to rename a non-existant file onto cwd, we get
387
365
        raise
388
366
 
389
367
 
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
368
def _mac_getcwd():
401
369
    return unicodedata.normalize('NFC', os.getcwdu())
402
370
 
407
375
realpath = _posix_realpath
408
376
pathjoin = os.path.join
409
377
normpath = os.path.normpath
410
 
rename = _wrapped_rename # overridden below on win32
411
378
getcwd = os.getcwdu
 
379
rename = os.rename
412
380
dirname = os.path.dirname
413
381
basename = os.path.basename
414
382
split = os.path.split
415
383
splitext = os.path.splitext
416
 
# These were already imported into local scope
 
384
# These were already lazily imported into local scope
417
385
# mkdtemp = tempfile.mkdtemp
418
386
# rmtree = shutil.rmtree
 
387
lstat = os.lstat
 
388
fstat = os.fstat
 
389
 
 
390
def wrap_stat(st):
 
391
    return st
 
392
 
419
393
 
420
394
MIN_ABS_PATHLENGTH = 1
421
395
 
431
405
    getcwd = _win32_getcwd
432
406
    mkdtemp = _win32_mkdtemp
433
407
    rename = _win32_rename
 
408
    try:
 
409
        from bzrlib import _walkdirs_win32
 
410
    except ImportError:
 
411
        pass
 
412
    else:
 
413
        lstat = _walkdirs_win32.lstat
 
414
        fstat = _walkdirs_win32.fstat
 
415
        wrap_stat = _walkdirs_win32.wrap_stat
434
416
 
435
417
    MIN_ABS_PATHLENGTH = 3
436
418
 
459
441
    getcwd = _mac_getcwd
460
442
 
461
443
 
462
 
def get_terminal_encoding():
 
444
def get_terminal_encoding(trace=False):
463
445
    """Find the best encoding for printing to the screen.
464
446
 
465
447
    This attempts to check both sys.stdout and sys.stdin to see
471
453
 
472
454
    On my standard US Windows XP, the preferred encoding is
473
455
    cp1252, but the console is cp437
 
456
 
 
457
    :param trace: If True trace the selected encoding via mutter().
474
458
    """
475
459
    from bzrlib.trace import mutter
476
460
    output_encoding = getattr(sys.stdout, 'encoding', None)
478
462
        input_encoding = getattr(sys.stdin, 'encoding', None)
479
463
        if not input_encoding:
480
464
            output_encoding = get_user_encoding()
481
 
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
465
            if trace:
 
466
                mutter('encoding stdout as osutils.get_user_encoding() %r',
482
467
                   output_encoding)
483
468
        else:
484
469
            output_encoding = input_encoding
485
 
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
470
            if trace:
 
471
                mutter('encoding stdout as sys.stdin encoding %r',
 
472
                    output_encoding)
486
473
    else:
487
 
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
474
        if trace:
 
475
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
488
476
    if output_encoding == 'cp0':
489
477
        # invalid encoding (cp0 means 'no codepage' on Windows)
490
478
        output_encoding = get_user_encoding()
491
 
        mutter('cp0 is invalid encoding.'
 
479
        if trace:
 
480
            mutter('cp0 is invalid encoding.'
492
481
               ' encoding stdout as osutils.get_user_encoding() %r',
493
482
               output_encoding)
494
483
    # check encoding
520
509
def isdir(f):
521
510
    """True if f is an accessible directory."""
522
511
    try:
523
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
512
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
524
513
    except OSError:
525
514
        return False
526
515
 
528
517
def isfile(f):
529
518
    """True if f is a regular file."""
530
519
    try:
531
 
        return S_ISREG(os.lstat(f)[ST_MODE])
 
520
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
532
521
    except OSError:
533
522
        return False
534
523
 
535
524
def islink(f):
536
525
    """True if f is a symlink."""
537
526
    try:
538
 
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
527
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
539
528
    except OSError:
540
529
        return False
541
530
 
881
870
 
882
871
def filesize(f):
883
872
    """Return size of given open file."""
884
 
    return os.fstat(f.fileno())[ST_SIZE]
 
873
    return os.fstat(f.fileno())[stat.ST_SIZE]
885
874
 
886
875
 
887
876
# Define rand_bytes based on platform.
949
938
 
950
939
def parent_directories(filename):
951
940
    """Return the list of parent directories, deepest first.
952
 
    
 
941
 
953
942
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
954
943
    """
955
944
    parents = []
979
968
    # NB: This docstring is just an example, not a doctest, because doctest
980
969
    # currently can't cope with the use of lazy imports in this namespace --
981
970
    # mbp 20090729
982
 
    
 
971
 
983
972
    # This currently doesn't report the failure at the time it occurs, because
984
973
    # they tend to happen very early in startup when we can't check config
985
974
    # files etc, and also we want to report all failures but not spam the user
986
975
    # with 10 warnings.
987
 
    from bzrlib import trace
988
976
    exception_str = str(exception)
989
977
    if exception_str not in _extension_load_failures:
990
978
        trace.mutter("failed to load compiled extension: %s" % exception_str)
1055
1043
 
1056
1044
 
1057
1045
def delete_any(path):
1058
 
    """Delete a file, symlink or directory.  
1059
 
    
 
1046
    """Delete a file, symlink or directory.
 
1047
 
1060
1048
    Will delete even if readonly.
1061
1049
    """
1062
1050
    try:
1251
1239
    # but for now, we haven't optimized...
1252
1240
    return [canonical_relpath(base, p) for p in paths]
1253
1241
 
 
1242
 
 
1243
def decode_filename(filename):
 
1244
    """Decode the filename using the filesystem encoding
 
1245
 
 
1246
    If it is unicode, it is returned.
 
1247
    Otherwise it is decoded from the the filesystem's encoding. If decoding
 
1248
    fails, a errors.BadFilenameEncoding exception is raised.
 
1249
    """
 
1250
    if type(filename) is unicode:
 
1251
        return filename
 
1252
    try:
 
1253
        return filename.decode(_fs_enc)
 
1254
    except UnicodeDecodeError:
 
1255
        raise errors.BadFilenameEncoding(filename, _fs_enc)
 
1256
 
 
1257
 
1254
1258
def safe_unicode(unicode_or_utf8_string):
1255
1259
    """Coerce unicode_or_utf8_string into unicode.
1256
1260
 
1339
1343
def normalizes_filenames():
1340
1344
    """Return True if this platform normalizes unicode filenames.
1341
1345
 
1342
 
    Mac OSX does, Windows/Linux do not.
 
1346
    Only Mac OSX.
1343
1347
    """
1344
1348
    return _platform_normalizes_filenames
1345
1349
 
1350
1354
    On platforms where the system normalizes filenames (Mac OSX),
1351
1355
    you can access a file by any path which will normalize correctly.
1352
1356
    On platforms where the system does not normalize filenames
1353
 
    (Windows, Linux), you have to access a file by its exact path.
 
1357
    (everything else), you have to access a file by its exact path.
1354
1358
 
1355
1359
    Internally, bzr only supports NFC normalization, since that is
1356
1360
    the standard for XML documents.
1418
1422
terminal_width() returns None.
1419
1423
"""
1420
1424
 
 
1425
# Keep some state so that terminal_width can detect if _terminal_size has
 
1426
# returned a different size since the process started.  See docstring and
 
1427
# comments of terminal_width for details.
 
1428
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
 
1429
_terminal_size_state = 'no_data'
 
1430
_first_terminal_size = None
1421
1431
 
1422
1432
def terminal_width():
1423
1433
    """Return terminal width.
1427
1437
    The rules are:
1428
1438
    - if BZR_COLUMNS is set, returns its value
1429
1439
    - if there is no controlling terminal, returns None
 
1440
    - query the OS, if the queried size has changed since the last query,
 
1441
      return its value,
1430
1442
    - if COLUMNS is set, returns its value,
 
1443
    - if the OS has a value (even though it's never changed), return its value.
1431
1444
 
1432
1445
    From there, we need to query the OS to get the size of the controlling
1433
1446
    terminal.
1434
1447
 
1435
 
    Unices:
 
1448
    On Unices we query the OS by:
1436
1449
    - get termios.TIOCGWINSZ
1437
1450
    - if an error occurs or a negative value is obtained, returns None
1438
1451
 
1439
 
    Windows:
1440
 
    
 
1452
    On Windows we query the OS by:
1441
1453
    - win32utils.get_console_size() decides,
1442
1454
    - returns None on error (provided default value)
1443
1455
    """
 
1456
    # Note to implementors: if changing the rules for determining the width,
 
1457
    # make sure you've considered the behaviour in these cases:
 
1458
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
 
1459
    #  - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
 
1460
    #    0,0.
 
1461
    #  - (add more interesting cases here, if you find any)
 
1462
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
 
1463
    # but we don't want to register a signal handler because it is impossible
 
1464
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
 
1465
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
 
1466
    # time so we can notice if the reported size has changed, which should have
 
1467
    # a similar effect.
1444
1468
 
1445
1469
    # If BZR_COLUMNS is set, take it, user is always right
 
1470
    # Except if they specified 0 in which case, impose no limit here
1446
1471
    try:
1447
 
        return int(os.environ['BZR_COLUMNS'])
 
1472
        width = int(os.environ['BZR_COLUMNS'])
1448
1473
    except (KeyError, ValueError):
1449
 
        pass
 
1474
        width = None
 
1475
    if width is not None:
 
1476
        if width > 0:
 
1477
            return width
 
1478
        else:
 
1479
            return None
1450
1480
 
1451
1481
    isatty = getattr(sys.stdout, 'isatty', None)
1452
 
    if  isatty is None or not isatty():
 
1482
    if isatty is None or not isatty():
1453
1483
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1454
1484
        return None
1455
1485
 
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))
 
1486
    # Query the OS
 
1487
    width, height = os_size = _terminal_size(None, None)
 
1488
    global _first_terminal_size, _terminal_size_state
 
1489
    if _terminal_size_state == 'no_data':
 
1490
        _first_terminal_size = os_size
 
1491
        _terminal_size_state = 'unchanged'
 
1492
    elif (_terminal_size_state == 'unchanged' and
 
1493
          _first_terminal_size != os_size):
 
1494
        _terminal_size_state = 'changed'
 
1495
 
 
1496
    # If the OS claims to know how wide the terminal is, and this value has
 
1497
    # ever changed, use that.
 
1498
    if _terminal_size_state == 'changed':
 
1499
        if width is not None and width > 0:
 
1500
            return width
 
1501
 
 
1502
    # If COLUMNS is set, use it.
1459
1503
    try:
1460
1504
        return int(os.environ['COLUMNS'])
1461
1505
    except (KeyError, ValueError):
1462
1506
        pass
1463
1507
 
1464
 
    width, height = _terminal_size(None, None)
1465
 
    if width <= 0:
1466
 
        # Consider invalid values as meaning no width
1467
 
        return None
 
1508
    # Finally, use an unchanged size from the OS, if we have one.
 
1509
    if _terminal_size_state == 'unchanged':
 
1510
        if width is not None and width > 0:
 
1511
            return width
1468
1512
 
1469
 
    return width
 
1513
    # The width could not be determined.
 
1514
    return None
1470
1515
 
1471
1516
 
1472
1517
def _win32_terminal_size(width, height):
1499
1544
    _terminal_size = _ioctl_terminal_size
1500
1545
 
1501
1546
 
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
1547
def supports_executable():
1528
1548
    return sys.platform != "win32"
1529
1549
 
1652
1672
        dirblock = []
1653
1673
        append = dirblock.append
1654
1674
        try:
1655
 
            names = sorted(_listdir(top))
 
1675
            names = sorted(map(decode_filename, _listdir(top)))
1656
1676
        except OSError, e:
1657
1677
            if not _is_error_enotdir(e):
1658
1678
                raise
1866
1886
        s = os.stat(src)
1867
1887
        chown(dst, s.st_uid, s.st_gid)
1868
1888
    except OSError, e:
1869
 
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
 
1889
        trace.warning(
 
1890
            'Unable to copy ownership from "%s" to "%s". '
 
1891
            'You may want to set it manually.', src, dst)
 
1892
        trace.log_exception_quietly()
1870
1893
 
1871
1894
 
1872
1895
def path_prefix_key(path):
1960
1983
    return user_encoding
1961
1984
 
1962
1985
 
 
1986
def get_diff_header_encoding():
 
1987
    return get_terminal_encoding()
 
1988
 
 
1989
 
1963
1990
def get_host_name():
1964
1991
    """Return the current unicode host name.
1965
1992
 
1980
2007
# data at once.
1981
2008
MAX_SOCKET_CHUNK = 64 * 1024
1982
2009
 
 
2010
_end_of_stream_errors = [errno.ECONNRESET]
 
2011
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
 
2012
    _eno = getattr(errno, _eno, None)
 
2013
    if _eno is not None:
 
2014
        _end_of_stream_errors.append(_eno)
 
2015
del _eno
 
2016
 
 
2017
 
1983
2018
def read_bytes_from_socket(sock, report_activity=None,
1984
2019
        max_read_size=MAX_SOCKET_CHUNK):
1985
2020
    """Read up to max_read_size of bytes from sock and notify of progress.
1993
2028
            bytes = sock.recv(max_read_size)
1994
2029
        except socket.error, e:
1995
2030
            eno = e.args[0]
1996
 
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
 
2031
            if eno in _end_of_stream_errors:
1997
2032
                # The connection was closed by the other side.  Callers expect
1998
2033
                # an empty string to signal end-of-stream.
1999
2034
                return ""
2028
2063
 
2029
2064
def send_all(sock, bytes, report_activity=None):
2030
2065
    """Send all bytes on a socket.
2031
 
 
 
2066
 
2032
2067
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2033
2068
    some platforms, and catches EINTR which may be thrown if the send is
2034
2069
    interrupted by a signal.
2035
2070
 
2036
2071
    This is preferred to socket.sendall(), because it avoids portability bugs
2037
2072
    and provides activity reporting.
2038
 
 
 
2073
 
2039
2074
    :param report_activity: Call this as bytes are read, see
2040
2075
        Transport._report_activity
2041
2076
    """
2052
2087
            report_activity(sent, 'write')
2053
2088
 
2054
2089
 
 
2090
def connect_socket(address):
 
2091
    # Slight variation of the socket.create_connection() function (provided by
 
2092
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
 
2093
    # provide it for previous python versions. Also, we don't use the timeout
 
2094
    # parameter (provided by the python implementation) so we don't implement
 
2095
    # it either).
 
2096
    err = socket.error('getaddrinfo returns an empty list')
 
2097
    host, port = address
 
2098
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
 
2099
        af, socktype, proto, canonname, sa = res
 
2100
        sock = None
 
2101
        try:
 
2102
            sock = socket.socket(af, socktype, proto)
 
2103
            sock.connect(sa)
 
2104
            return sock
 
2105
 
 
2106
        except socket.error, err:
 
2107
            # 'err' is now the most recent error
 
2108
            if sock is not None:
 
2109
                sock.close()
 
2110
    raise err
 
2111
 
 
2112
 
2055
2113
def dereference_path(path):
2056
2114
    """Determine the real path to a file.
2057
2115
 
2096
2154
    base = dirname(bzrlib.__file__)
2097
2155
    if getattr(sys, 'frozen', None):    # bzr.exe
2098
2156
        base = abspath(pathjoin(base, '..', '..'))
2099
 
    filename = pathjoin(base, resource_relpath)
2100
 
    return open(filename, 'rU').read()
2101
 
 
 
2157
    f = file(pathjoin(base, resource_relpath), "rU")
 
2158
    try:
 
2159
        return f.read()
 
2160
    finally:
 
2161
        f.close()
2102
2162
 
2103
2163
def file_kind_from_stat_mode_thunk(mode):
2104
2164
    global file_kind_from_stat_mode
2127
2187
 
2128
2188
def until_no_eintr(f, *a, **kw):
2129
2189
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2130
 
    
 
2190
 
2131
2191
    WARNING: you must be certain that it is safe to retry the call repeatedly
2132
2192
    if EINTR does occur.  This is typically only true for low-level operations
2133
2193
    like os.read.  If in any doubt, don't use this.
2148
2208
            raise
2149
2209
 
2150
2210
 
 
2211
@deprecated_function(deprecated_in((2, 2, 0)))
2151
2212
def re_compile_checked(re_string, flags=0, where=""):
2152
2213
    """Return a compiled re, or raise a sensible error.
2153
2214
 
2163
2224
        re_obj = re.compile(re_string, flags)
2164
2225
        re_obj.search("")
2165
2226
        return re_obj
2166
 
    except re.error, e:
 
2227
    except errors.InvalidPattern, e:
2167
2228
        if where:
2168
2229
            where = ' in ' + where
2169
2230
        # despite the name 'error' is a type
2170
 
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2171
 
            % (where, re_string, e))
 
2231
        raise errors.BzrCommandError('Invalid regular expression%s: %s'
 
2232
            % (where, e.msg))
2172
2233
 
2173
2234
 
2174
2235
if sys.platform == "win32":
2188
2249
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2189
2250
        return ch
2190
2251
 
2191
 
 
2192
2252
if sys.platform == 'linux2':
2193
2253
    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
 
2254
        try:
 
2255
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2256
        except (ValueError, OSError, AttributeError):
 
2257
            return None
2200
2258
elif sys.platform == 'darwin':
2201
2259
    def _local_concurrency():
2202
2260
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2203
2261
                                stdout=subprocess.PIPE).communicate()[0]
2204
 
elif sys.platform[0:7] == 'freebsd':
 
2262
elif "bsd" in sys.platform:
2205
2263
    def _local_concurrency():
2206
2264
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2207
2265
                                stdout=subprocess.PIPE).communicate()[0]
2235
2293
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2236
2294
    if concurrency is None:
2237
2295
        try:
2238
 
            concurrency = _local_concurrency()
2239
 
        except (OSError, IOError):
2240
 
            pass
 
2296
            import multiprocessing
 
2297
        except ImportError:
 
2298
            # multiprocessing is only available on Python >= 2.6
 
2299
            try:
 
2300
                concurrency = _local_concurrency()
 
2301
            except (OSError, IOError):
 
2302
                pass
 
2303
        else:
 
2304
            concurrency = multiprocessing.cpu_count()
2241
2305
    try:
2242
2306
        concurrency = int(concurrency)
2243
2307
    except (TypeError, ValueError):
2264
2328
if sys.platform == 'win32':
2265
2329
    def open_file(filename, mode='r', bufsize=-1):
2266
2330
        """This function is used to override the ``open`` builtin.
2267
 
        
 
2331
 
2268
2332
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2269
2333
        child processes.  Deleting or renaming a closed file opened with this
2270
2334
        function is not blocking child processes.
2315
2379
        raise errors.BzrError("Can't decode username as %s." % \
2316
2380
                user_encoding)
2317
2381
    return username
 
2382
 
 
2383
 
 
2384
def available_backup_name(base, exists):
 
2385
    """Find a non-existing backup file name.
 
2386
 
 
2387
    This will *not* create anything, this only return a 'free' entry.  This
 
2388
    should be used for checking names in a directory below a locked
 
2389
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
 
2390
    Leap) and generally discouraged.
 
2391
 
 
2392
    :param base: The base name.
 
2393
 
 
2394
    :param exists: A callable returning True if the path parameter exists.
 
2395
    """
 
2396
    counter = 1
 
2397
    name = "%s.~%d~" % (base, counter)
 
2398
    while exists(name):
 
2399
        counter += 1
 
2400
        name = "%s.~%d~" % (base, counter)
 
2401
    return name
 
2402
 
 
2403
 
 
2404
def set_fd_cloexec(fd):
 
2405
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
 
2406
    support for this is not available.
 
2407
    """
 
2408
    try:
 
2409
        import fcntl
 
2410
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
 
2411
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
 
2412
    except (ImportError, AttributeError):
 
2413
        # Either the fcntl module or specific constants are not present
 
2414
        pass
 
2415
 
 
2416
 
 
2417
def find_executable_on_path(name):
 
2418
    """Finds an executable on the PATH.
 
2419
    
 
2420
    On Windows, this will try to append each extension in the PATHEXT
 
2421
    environment variable to the name, if it cannot be found with the name
 
2422
    as given.
 
2423
    
 
2424
    :param name: The base name of the executable.
 
2425
    :return: The path to the executable found or None.
 
2426
    """
 
2427
    path = os.environ.get('PATH')
 
2428
    if path is None:
 
2429
        return None
 
2430
    path = path.split(os.pathsep)
 
2431
    if sys.platform == 'win32':
 
2432
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
 
2433
        exts = [ext.lower() for ext in exts]
 
2434
        base, ext = os.path.splitext(name)
 
2435
        if ext != '':
 
2436
            if ext.lower() not in exts:
 
2437
                return None
 
2438
            name = base
 
2439
            exts = [ext]
 
2440
    else:
 
2441
        exts = ['']
 
2442
    for ext in exts:
 
2443
        for d in path:
 
2444
            f = os.path.join(d, name) + ext
 
2445
            if os.access(f, os.X_OK):
 
2446
                return f
 
2447
    return None