/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: Vincent Ladeuil
  • Date: 2011-06-16 10:45:17 UTC
  • mto: This revision was merged to the branch mainline in revision 5981.
  • Revision ID: v.ladeuil+lp@free.fr-20110616104517-4qzhmzkxgozji88y
Add copyright notice, some docs and some cleanups.

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):
275
261
            else:
276
262
                rename_func(tmp_name, new)
277
263
    if failure_exc is not None:
278
 
        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
279
268
 
280
269
 
281
270
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
304
293
    running python.exe under cmd.exe return capital C:\\
305
294
    running win32 python inside a cygwin shell returns lowercase c:\\
306
295
    """
307
 
    drive, path = _nt_splitdrive(path)
 
296
    drive, path = ntpath.splitdrive(path)
308
297
    return drive.upper() + path
309
298
 
310
299
 
311
300
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('\\', '/'))
 
301
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
 
302
    return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
314
303
 
315
304
 
316
305
def _win98_abspath(path):
327
316
    #   /path       => C:/path
328
317
    path = unicode(path)
329
318
    # check for absolute path
330
 
    drive = _nt_splitdrive(path)[0]
 
319
    drive = ntpath.splitdrive(path)[0]
331
320
    if drive == '' and path[:2] not in('//','\\\\'):
332
321
        cwd = os.getcwdu()
333
322
        # we cannot simply os.path.join cwd and path
334
323
        # because os.path.join('C:','/path') produce '/path'
335
324
        # and this is incorrect
336
325
        if path[:1] in ('/','\\'):
337
 
            cwd = _nt_splitdrive(cwd)[0]
 
326
            cwd = ntpath.splitdrive(cwd)[0]
338
327
            path = path[1:]
339
328
        path = cwd + '\\' + path
340
 
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
 
329
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
341
330
 
342
331
 
343
332
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('\\', '/'))
 
333
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
 
334
    return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
346
335
 
347
336
 
348
337
def _win32_pathjoin(*args):
349
 
    return _nt_join(*args).replace('\\', '/')
 
338
    return ntpath.join(*args).replace('\\', '/')
350
339
 
351
340
 
352
341
def _win32_normpath(path):
353
 
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
342
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
354
343
 
355
344
 
356
345
def _win32_getcwd():
361
350
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
362
351
 
363
352
 
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
353
def _win32_rename(old, new):
373
354
    """We expect to be able to atomically replace 'new' with old.
374
355
 
376
357
    and then deleted.
377
358
    """
378
359
    try:
379
 
        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)
380
361
    except OSError, e:
381
362
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
382
363
            # If we try to rename a non-existant file onto cwd, we get
387
368
        raise
388
369
 
389
370
 
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
371
def _mac_getcwd():
401
372
    return unicodedata.normalize('NFC', os.getcwdu())
402
373
 
407
378
realpath = _posix_realpath
408
379
pathjoin = os.path.join
409
380
normpath = os.path.normpath
410
 
rename = _wrapped_rename # overridden below on win32
411
381
getcwd = os.getcwdu
 
382
rename = os.rename
412
383
dirname = os.path.dirname
413
384
basename = os.path.basename
414
385
split = os.path.split
415
386
splitext = os.path.splitext
416
 
# These were already imported into local scope
 
387
# These were already lazily imported into local scope
417
388
# mkdtemp = tempfile.mkdtemp
418
389
# rmtree = shutil.rmtree
 
390
lstat = os.lstat
 
391
fstat = os.fstat
 
392
 
 
393
def wrap_stat(st):
 
394
    return st
 
395
 
419
396
 
420
397
MIN_ABS_PATHLENGTH = 1
421
398
 
431
408
    getcwd = _win32_getcwd
432
409
    mkdtemp = _win32_mkdtemp
433
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
434
419
 
435
420
    MIN_ABS_PATHLENGTH = 3
436
421
 
459
444
    getcwd = _mac_getcwd
460
445
 
461
446
 
462
 
def get_terminal_encoding():
 
447
def get_terminal_encoding(trace=False):
463
448
    """Find the best encoding for printing to the screen.
464
449
 
465
450
    This attempts to check both sys.stdout and sys.stdin to see
471
456
 
472
457
    On my standard US Windows XP, the preferred encoding is
473
458
    cp1252, but the console is cp437
 
459
 
 
460
    :param trace: If True trace the selected encoding via mutter().
474
461
    """
475
462
    from bzrlib.trace import mutter
476
463
    output_encoding = getattr(sys.stdout, 'encoding', None)
478
465
        input_encoding = getattr(sys.stdin, 'encoding', None)
479
466
        if not input_encoding:
480
467
            output_encoding = get_user_encoding()
481
 
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
468
            if trace:
 
469
                mutter('encoding stdout as osutils.get_user_encoding() %r',
482
470
                   output_encoding)
483
471
        else:
484
472
            output_encoding = input_encoding
485
 
            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)
486
476
    else:
487
 
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
477
        if trace:
 
478
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
488
479
    if output_encoding == 'cp0':
489
480
        # invalid encoding (cp0 means 'no codepage' on Windows)
490
481
        output_encoding = get_user_encoding()
491
 
        mutter('cp0 is invalid encoding.'
 
482
        if trace:
 
483
            mutter('cp0 is invalid encoding.'
492
484
               ' encoding stdout as osutils.get_user_encoding() %r',
493
485
               output_encoding)
494
486
    # check encoding
520
512
def isdir(f):
521
513
    """True if f is an accessible directory."""
522
514
    try:
523
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
515
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
524
516
    except OSError:
525
517
        return False
526
518
 
528
520
def isfile(f):
529
521
    """True if f is a regular file."""
530
522
    try:
531
 
        return S_ISREG(os.lstat(f)[ST_MODE])
 
523
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
532
524
    except OSError:
533
525
        return False
534
526
 
535
527
def islink(f):
536
528
    """True if f is a symlink."""
537
529
    try:
538
 
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
530
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
539
531
    except OSError:
540
532
        return False
541
533
 
881
873
 
882
874
def filesize(f):
883
875
    """Return size of given open file."""
884
 
    return os.fstat(f.fileno())[ST_SIZE]
 
876
    return os.fstat(f.fileno())[stat.ST_SIZE]
885
877
 
886
878
 
887
879
# Define rand_bytes based on platform.
949
941
 
950
942
def parent_directories(filename):
951
943
    """Return the list of parent directories, deepest first.
952
 
    
 
944
 
953
945
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
954
946
    """
955
947
    parents = []
979
971
    # NB: This docstring is just an example, not a doctest, because doctest
980
972
    # currently can't cope with the use of lazy imports in this namespace --
981
973
    # mbp 20090729
982
 
    
 
974
 
983
975
    # This currently doesn't report the failure at the time it occurs, because
984
976
    # they tend to happen very early in startup when we can't check config
985
977
    # files etc, and also we want to report all failures but not spam the user
986
978
    # with 10 warnings.
987
 
    from bzrlib import trace
988
979
    exception_str = str(exception)
989
980
    if exception_str not in _extension_load_failures:
990
981
        trace.mutter("failed to load compiled extension: %s" % exception_str)
1055
1046
 
1056
1047
 
1057
1048
def delete_any(path):
1058
 
    """Delete a file, symlink or directory.  
1059
 
    
 
1049
    """Delete a file, symlink or directory.
 
1050
 
1060
1051
    Will delete even if readonly.
1061
1052
    """
1062
1053
    try:
1251
1242
    # but for now, we haven't optimized...
1252
1243
    return [canonical_relpath(base, p) for p in paths]
1253
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
 
1254
1261
def safe_unicode(unicode_or_utf8_string):
1255
1262
    """Coerce unicode_or_utf8_string into unicode.
1256
1263
 
1339
1346
def normalizes_filenames():
1340
1347
    """Return True if this platform normalizes unicode filenames.
1341
1348
 
1342
 
    Mac OSX does, Windows/Linux do not.
 
1349
    Only Mac OSX.
1343
1350
    """
1344
1351
    return _platform_normalizes_filenames
1345
1352
 
1350
1357
    On platforms where the system normalizes filenames (Mac OSX),
1351
1358
    you can access a file by any path which will normalize correctly.
1352
1359
    On platforms where the system does not normalize filenames
1353
 
    (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.
1354
1361
 
1355
1362
    Internally, bzr only supports NFC normalization, since that is
1356
1363
    the standard for XML documents.
1418
1425
terminal_width() returns None.
1419
1426
"""
1420
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
1421
1434
 
1422
1435
def terminal_width():
1423
1436
    """Return terminal width.
1427
1440
    The rules are:
1428
1441
    - if BZR_COLUMNS is set, returns its value
1429
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,
1430
1445
    - if COLUMNS is set, returns its value,
 
1446
    - if the OS has a value (even though it's never changed), return its value.
1431
1447
 
1432
1448
    From there, we need to query the OS to get the size of the controlling
1433
1449
    terminal.
1434
1450
 
1435
 
    Unices:
 
1451
    On Unices we query the OS by:
1436
1452
    - get termios.TIOCGWINSZ
1437
1453
    - if an error occurs or a negative value is obtained, returns None
1438
1454
 
1439
 
    Windows:
1440
 
    
 
1455
    On Windows we query the OS by:
1441
1456
    - win32utils.get_console_size() decides,
1442
1457
    - returns None on error (provided default value)
1443
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.
1444
1471
 
1445
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
1446
1474
    try:
1447
 
        return int(os.environ['BZR_COLUMNS'])
 
1475
        width = int(os.environ['BZR_COLUMNS'])
1448
1476
    except (KeyError, ValueError):
1449
 
        pass
 
1477
        width = None
 
1478
    if width is not None:
 
1479
        if width > 0:
 
1480
            return width
 
1481
        else:
 
1482
            return None
1450
1483
 
1451
1484
    isatty = getattr(sys.stdout, 'isatty', None)
1452
 
    if  isatty is None or not isatty():
 
1485
    if isatty is None or not isatty():
1453
1486
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1454
1487
        return None
1455
1488
 
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))
 
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.
1459
1506
    try:
1460
1507
        return int(os.environ['COLUMNS'])
1461
1508
    except (KeyError, ValueError):
1462
1509
        pass
1463
1510
 
1464
 
    width, height = _terminal_size(None, None)
1465
 
    if width <= 0:
1466
 
        # Consider invalid values as meaning no width
1467
 
        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
1468
1515
 
1469
 
    return width
 
1516
    # The width could not be determined.
 
1517
    return None
1470
1518
 
1471
1519
 
1472
1520
def _win32_terminal_size(width, height):
1499
1547
    _terminal_size = _ioctl_terminal_size
1500
1548
 
1501
1549
 
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
1550
def supports_executable():
1528
1551
    return sys.platform != "win32"
1529
1552
 
1652
1675
        dirblock = []
1653
1676
        append = dirblock.append
1654
1677
        try:
1655
 
            names = sorted(_listdir(top))
 
1678
            names = sorted(map(decode_filename, _listdir(top)))
1656
1679
        except OSError, e:
1657
1680
            if not _is_error_enotdir(e):
1658
1681
                raise
1866
1889
        s = os.stat(src)
1867
1890
        chown(dst, s.st_uid, s.st_gid)
1868
1891
    except OSError, e:
1869
 
        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()
1870
1896
 
1871
1897
 
1872
1898
def path_prefix_key(path):
1960
1986
    return user_encoding
1961
1987
 
1962
1988
 
 
1989
def get_diff_header_encoding():
 
1990
    return get_terminal_encoding()
 
1991
 
 
1992
 
1963
1993
def get_host_name():
1964
1994
    """Return the current unicode host name.
1965
1995
 
1980
2010
# data at once.
1981
2011
MAX_SOCKET_CHUNK = 64 * 1024
1982
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
 
1983
2021
def read_bytes_from_socket(sock, report_activity=None,
1984
2022
        max_read_size=MAX_SOCKET_CHUNK):
1985
2023
    """Read up to max_read_size of bytes from sock and notify of progress.
1993
2031
            bytes = sock.recv(max_read_size)
1994
2032
        except socket.error, e:
1995
2033
            eno = e.args[0]
1996
 
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
 
2034
            if eno in _end_of_stream_errors:
1997
2035
                # The connection was closed by the other side.  Callers expect
1998
2036
                # an empty string to signal end-of-stream.
1999
2037
                return ""
2028
2066
 
2029
2067
def send_all(sock, bytes, report_activity=None):
2030
2068
    """Send all bytes on a socket.
2031
 
 
 
2069
 
2032
2070
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2033
2071
    some platforms, and catches EINTR which may be thrown if the send is
2034
2072
    interrupted by a signal.
2035
2073
 
2036
2074
    This is preferred to socket.sendall(), because it avoids portability bugs
2037
2075
    and provides activity reporting.
2038
 
 
 
2076
 
2039
2077
    :param report_activity: Call this as bytes are read, see
2040
2078
        Transport._report_activity
2041
2079
    """
2052
2090
            report_activity(sent, 'write')
2053
2091
 
2054
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
 
2055
2116
def dereference_path(path):
2056
2117
    """Determine the real path to a file.
2057
2118
 
2096
2157
    base = dirname(bzrlib.__file__)
2097
2158
    if getattr(sys, 'frozen', None):    # bzr.exe
2098
2159
        base = abspath(pathjoin(base, '..', '..'))
2099
 
    filename = pathjoin(base, resource_relpath)
2100
 
    return open(filename, 'rU').read()
2101
 
 
 
2160
    f = file(pathjoin(base, resource_relpath), "rU")
 
2161
    try:
 
2162
        return f.read()
 
2163
    finally:
 
2164
        f.close()
2102
2165
 
2103
2166
def file_kind_from_stat_mode_thunk(mode):
2104
2167
    global file_kind_from_stat_mode
2127
2190
 
2128
2191
def until_no_eintr(f, *a, **kw):
2129
2192
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2130
 
    
 
2193
 
2131
2194
    WARNING: you must be certain that it is safe to retry the call repeatedly
2132
2195
    if EINTR does occur.  This is typically only true for low-level operations
2133
2196
    like os.read.  If in any doubt, don't use this.
2148
2211
            raise
2149
2212
 
2150
2213
 
 
2214
@deprecated_function(deprecated_in((2, 2, 0)))
2151
2215
def re_compile_checked(re_string, flags=0, where=""):
2152
2216
    """Return a compiled re, or raise a sensible error.
2153
2217
 
2163
2227
        re_obj = re.compile(re_string, flags)
2164
2228
        re_obj.search("")
2165
2229
        return re_obj
2166
 
    except re.error, e:
 
2230
    except errors.InvalidPattern, e:
2167
2231
        if where:
2168
2232
            where = ' in ' + where
2169
2233
        # despite the name 'error' is a type
2170
 
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2171
 
            % (where, re_string, e))
 
2234
        raise errors.BzrCommandError('Invalid regular expression%s: %s'
 
2235
            % (where, e.msg))
2172
2236
 
2173
2237
 
2174
2238
if sys.platform == "win32":
2188
2252
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2189
2253
        return ch
2190
2254
 
2191
 
 
2192
2255
if sys.platform == 'linux2':
2193
2256
    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
 
2257
        try:
 
2258
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2259
        except (ValueError, OSError, AttributeError):
 
2260
            return None
2200
2261
elif sys.platform == 'darwin':
2201
2262
    def _local_concurrency():
2202
2263
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2203
2264
                                stdout=subprocess.PIPE).communicate()[0]
2204
 
elif sys.platform[0:7] == 'freebsd':
 
2265
elif "bsd" in sys.platform:
2205
2266
    def _local_concurrency():
2206
2267
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2207
2268
                                stdout=subprocess.PIPE).communicate()[0]
2235
2296
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2236
2297
    if concurrency is None:
2237
2298
        try:
2238
 
            concurrency = _local_concurrency()
2239
 
        except (OSError, IOError):
2240
 
            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()
2241
2308
    try:
2242
2309
        concurrency = int(concurrency)
2243
2310
    except (TypeError, ValueError):
2264
2331
if sys.platform == 'win32':
2265
2332
    def open_file(filename, mode='r', bufsize=-1):
2266
2333
        """This function is used to override the ``open`` builtin.
2267
 
        
 
2334
 
2268
2335
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2269
2336
        child processes.  Deleting or renaming a closed file opened with this
2270
2337
        function is not blocking child processes.
2315
2382
        raise errors.BzrError("Can't decode username as %s." % \
2316
2383
                user_encoding)
2317
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