← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Martin Pool
  • Date: 2011-06-14 02:21:41 UTC
  • mto: This revision was merged to the branch mainline in revision 6001.
  • Revision ID: mbp@canonical.com-20110614022141-18hmm7s0iw3utcbj
Deprecate __contains__ on Tree and Inventory

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