← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Jelmer Vernooij
  • Date: 2011-08-29 19:06:57 UTC
  • mto: This revision was merged to the branch mainline in revision 6119.
  • Revision ID: jelmer@samba.org-20110829190657-o5sa35xv779g79g9
Add Tree.has_versioned_directories.

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 (
49
44
    cache_utf8,
 
45
    config,
50
46
    errors,
51
47
    trace,
52
48
    win32utils,
58
54
    deprecated_in,
59
55
    )
60
56
 
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
 
        )
 
57
from hashlib import (
 
58
    md5,
 
59
    sha1 as sha,
 
60
    )
73
61
 
74
62
 
75
63
import bzrlib
101
89
        user_encoding = get_user_encoding()
102
90
        return [a.decode(user_encoding) for a in sys.argv[1:]]
103
91
    except UnicodeDecodeError:
104
 
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
105
 
                                                            "encoding." % a))
 
92
        raise errors.BzrError("Parameter %r encoding is unsupported by %s "
 
93
            "application locale." % (a, user_encoding))
106
94
 
107
95
 
108
96
def make_readonly(filename):
274
262
            else:
275
263
                rename_func(tmp_name, new)
276
264
    if failure_exc is not None:
277
 
        raise failure_exc[0], failure_exc[1], failure_exc[2]
 
265
        try:
 
266
            raise failure_exc[0], failure_exc[1], failure_exc[2]
 
267
        finally:
 
268
            del failure_exc
278
269
 
279
270
 
280
271
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
303
294
    running python.exe under cmd.exe return capital C:\\
304
295
    running win32 python inside a cygwin shell returns lowercase c:\\
305
296
    """
306
 
    drive, path = _nt_splitdrive(path)
 
297
    drive, path = ntpath.splitdrive(path)
307
298
    return drive.upper() + path
308
299
 
309
300
 
310
301
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('\\', '/'))
 
302
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
 
303
    return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
313
304
 
314
305
 
315
306
def _win98_abspath(path):
326
317
    #   /path       => C:/path
327
318
    path = unicode(path)
328
319
    # check for absolute path
329
 
    drive = _nt_splitdrive(path)[0]
 
320
    drive = ntpath.splitdrive(path)[0]
330
321
    if drive == '' and path[:2] not in('//','\\\\'):
331
322
        cwd = os.getcwdu()
332
323
        # we cannot simply os.path.join cwd and path
333
324
        # because os.path.join('C:','/path') produce '/path'
334
325
        # and this is incorrect
335
326
        if path[:1] in ('/','\\'):
336
 
            cwd = _nt_splitdrive(cwd)[0]
 
327
            cwd = ntpath.splitdrive(cwd)[0]
337
328
            path = path[1:]
338
329
        path = cwd + '\\' + path
339
 
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
 
330
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
340
331
 
341
332
 
342
333
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('\\', '/'))
 
334
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
 
335
    return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
345
336
 
346
337
 
347
338
def _win32_pathjoin(*args):
348
 
    return _nt_join(*args).replace('\\', '/')
 
339
    return ntpath.join(*args).replace('\\', '/')
349
340
 
350
341
 
351
342
def _win32_normpath(path):
352
 
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
343
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
353
344
 
354
345
 
355
346
def _win32_getcwd():
360
351
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
361
352
 
362
353
 
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
354
def _win32_rename(old, new):
372
355
    """We expect to be able to atomically replace 'new' with old.
373
356
 
375
358
    and then deleted.
376
359
    """
377
360
    try:
378
 
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
 
361
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
379
362
    except OSError, e:
380
363
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
381
364
            # If we try to rename a non-existant file onto cwd, we get
386
369
        raise
387
370
 
388
371
 
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
372
def _mac_getcwd():
400
373
    return unicodedata.normalize('NFC', os.getcwdu())
401
374
 
406
379
realpath = _posix_realpath
407
380
pathjoin = os.path.join
408
381
normpath = os.path.normpath
409
 
rename = _wrapped_rename # overridden below on win32
410
382
getcwd = os.getcwdu
 
383
rename = os.rename
411
384
dirname = os.path.dirname
412
385
basename = os.path.basename
413
386
split = os.path.split
414
387
splitext = os.path.splitext
415
 
# These were already imported into local scope
 
388
# These were already lazily imported into local scope
416
389
# mkdtemp = tempfile.mkdtemp
417
390
# rmtree = shutil.rmtree
 
391
lstat = os.lstat
 
392
fstat = os.fstat
 
393
 
 
394
def wrap_stat(st):
 
395
    return st
 
396
 
418
397
 
419
398
MIN_ABS_PATHLENGTH = 1
420
399
 
430
409
    getcwd = _win32_getcwd
431
410
    mkdtemp = _win32_mkdtemp
432
411
    rename = _win32_rename
 
412
    try:
 
413
        from bzrlib import _walkdirs_win32
 
414
    except ImportError:
 
415
        pass
 
416
    else:
 
417
        lstat = _walkdirs_win32.lstat
 
418
        fstat = _walkdirs_win32.fstat
 
419
        wrap_stat = _walkdirs_win32.wrap_stat
433
420
 
434
421
    MIN_ABS_PATHLENGTH = 3
435
422
 
458
445
    getcwd = _mac_getcwd
459
446
 
460
447
 
461
 
def get_terminal_encoding():
 
448
def get_terminal_encoding(trace=False):
462
449
    """Find the best encoding for printing to the screen.
463
450
 
464
451
    This attempts to check both sys.stdout and sys.stdin to see
470
457
 
471
458
    On my standard US Windows XP, the preferred encoding is
472
459
    cp1252, but the console is cp437
 
460
 
 
461
    :param trace: If True trace the selected encoding via mutter().
473
462
    """
474
463
    from bzrlib.trace import mutter
475
464
    output_encoding = getattr(sys.stdout, 'encoding', None)
477
466
        input_encoding = getattr(sys.stdin, 'encoding', None)
478
467
        if not input_encoding:
479
468
            output_encoding = get_user_encoding()
480
 
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
469
            if trace:
 
470
                mutter('encoding stdout as osutils.get_user_encoding() %r',
481
471
                   output_encoding)
482
472
        else:
483
473
            output_encoding = input_encoding
484
 
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
474
            if trace:
 
475
                mutter('encoding stdout as sys.stdin encoding %r',
 
476
                    output_encoding)
485
477
    else:
486
 
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
478
        if trace:
 
479
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
487
480
    if output_encoding == 'cp0':
488
481
        # invalid encoding (cp0 means 'no codepage' on Windows)
489
482
        output_encoding = get_user_encoding()
490
 
        mutter('cp0 is invalid encoding.'
 
483
        if trace:
 
484
            mutter('cp0 is invalid encoding.'
491
485
               ' encoding stdout as osutils.get_user_encoding() %r',
492
486
               output_encoding)
493
487
    # check encoding
519
513
def isdir(f):
520
514
    """True if f is an accessible directory."""
521
515
    try:
522
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
516
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
523
517
    except OSError:
524
518
        return False
525
519
 
527
521
def isfile(f):
528
522
    """True if f is a regular file."""
529
523
    try:
530
 
        return S_ISREG(os.lstat(f)[ST_MODE])
 
524
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
531
525
    except OSError:
532
526
        return False
533
527
 
534
528
def islink(f):
535
529
    """True if f is a symlink."""
536
530
    try:
537
 
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
531
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
538
532
    except OSError:
539
533
        return False
540
534
 
880
874
 
881
875
def filesize(f):
882
876
    """Return size of given open file."""
883
 
    return os.fstat(f.fileno())[ST_SIZE]
 
877
    return os.fstat(f.fileno())[stat.ST_SIZE]
884
878
 
885
879
 
886
880
# Define rand_bytes based on platform.
948
942
 
949
943
def parent_directories(filename):
950
944
    """Return the list of parent directories, deepest first.
951
 
    
 
945
 
952
946
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
953
947
    """
954
948
    parents = []
978
972
    # NB: This docstring is just an example, not a doctest, because doctest
979
973
    # currently can't cope with the use of lazy imports in this namespace --
980
974
    # mbp 20090729
981
 
    
 
975
 
982
976
    # This currently doesn't report the failure at the time it occurs, because
983
977
    # they tend to happen very early in startup when we can't check config
984
978
    # files etc, and also we want to report all failures but not spam the user
985
979
    # with 10 warnings.
986
 
    from bzrlib import trace
987
980
    exception_str = str(exception)
988
981
    if exception_str not in _extension_load_failures:
989
982
        trace.mutter("failed to load compiled extension: %s" % exception_str)
993
986
def report_extension_load_failures():
994
987
    if not _extension_load_failures:
995
988
        return
996
 
    from bzrlib.config import GlobalConfig
997
 
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
 
989
    if config.GlobalStack().get('ignore_missing_extensions'):
998
990
        return
999
991
    # the warnings framework should by default show this only once
1000
992
    from bzrlib.trace import warning
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
2114
2178
    return file_kind_from_stat_mode(mode)
2115
2179
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2116
2180
 
2117
 
 
2118
 
def file_kind(f, _lstat=os.lstat):
 
2181
def file_stat(f, _lstat=os.lstat):
2119
2182
    try:
2120
 
        return file_kind_from_stat_mode(_lstat(f).st_mode)
 
2183
        # XXX cache?
 
2184
        return _lstat(f)
2121
2185
    except OSError, e:
2122
2186
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2123
2187
            raise errors.NoSuchFile(f)
2124
2188
        raise
2125
2189
 
 
2190
def file_kind(f, _lstat=os.lstat):
 
2191
    stat_value = file_stat(f, _lstat)
 
2192
    return file_kind_from_stat_mode(stat_value.st_mode)
2126
2193
 
2127
2194
def until_no_eintr(f, *a, **kw):
2128
2195
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2129
 
    
 
2196
 
2130
2197
    WARNING: you must be certain that it is safe to retry the call repeatedly
2131
2198
    if EINTR does occur.  This is typically only true for low-level operations
2132
2199
    like os.read.  If in any doubt, don't use this.
2147
2214
            raise
2148
2215
 
2149
2216
 
 
2217
@deprecated_function(deprecated_in((2, 2, 0)))
2150
2218
def re_compile_checked(re_string, flags=0, where=""):
2151
2219
    """Return a compiled re, or raise a sensible error.
2152
2220
 
2162
2230
        re_obj = re.compile(re_string, flags)
2163
2231
        re_obj.search("")
2164
2232
        return re_obj
2165
 
    except re.error, e:
 
2233
    except errors.InvalidPattern, e:
2166
2234
        if where:
2167
2235
            where = ' in ' + where
2168
2236
        # despite the name 'error' is a type
2169
 
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2170
 
            % (where, re_string, e))
 
2237
        raise errors.BzrCommandError('Invalid regular expression%s: %s'
 
2238
            % (where, e.msg))
2171
2239
 
2172
2240
 
2173
2241
if sys.platform == "win32":
2187
2255
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2188
2256
        return ch
2189
2257
 
2190
 
 
2191
 
if sys.platform == 'linux2':
 
2258
if sys.platform.startswith('linux'):
2192
2259
    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
 
2260
        try:
 
2261
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2262
        except (ValueError, OSError, AttributeError):
 
2263
            return None
2199
2264
elif sys.platform == 'darwin':
2200
2265
    def _local_concurrency():
2201
2266
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2202
2267
                                stdout=subprocess.PIPE).communicate()[0]
2203
 
elif sys.platform[0:7] == 'freebsd':
 
2268
elif "bsd" in sys.platform:
2204
2269
    def _local_concurrency():
2205
2270
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2206
2271
                                stdout=subprocess.PIPE).communicate()[0]
2234
2299
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2235
2300
    if concurrency is None:
2236
2301
        try:
2237
 
            concurrency = _local_concurrency()
2238
 
        except (OSError, IOError):
2239
 
            pass
 
2302
            import multiprocessing
 
2303
        except ImportError:
 
2304
            # multiprocessing is only available on Python >= 2.6
 
2305
            try:
 
2306
                concurrency = _local_concurrency()
 
2307
            except (OSError, IOError):
 
2308
                pass
 
2309
        else:
 
2310
            concurrency = multiprocessing.cpu_count()
2240
2311
    try:
2241
2312
        concurrency = int(concurrency)
2242
2313
    except (TypeError, ValueError):
2263
2334
if sys.platform == 'win32':
2264
2335
    def open_file(filename, mode='r', bufsize=-1):
2265
2336
        """This function is used to override the ``open`` builtin.
2266
 
        
 
2337
 
2267
2338
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2268
2339
        child processes.  Deleting or renaming a closed file opened with this
2269
2340
        function is not blocking child processes.
2302
2373
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2303
2374
else:
2304
2375
    open_file = open
 
2376
 
 
2377
 
 
2378
def getuser_unicode():
 
2379
    """Return the username as unicode.
 
2380
    """
 
2381
    try:
 
2382
        user_encoding = get_user_encoding()
 
2383
        username = getpass.getuser().decode(user_encoding)
 
2384
    except UnicodeDecodeError:
 
2385
        raise errors.BzrError("Can't decode username as %s." % \
 
2386
                user_encoding)
 
2387
    except ImportError, e:
 
2388
        if sys.platform != 'win32':
 
2389
            raise
 
2390
        if str(e) != 'No module named pwd':
 
2391
            raise
 
2392
        # https://bugs.launchpad.net/bzr/+bug/660174
 
2393
        # getpass.getuser() is unable to return username on Windows
 
2394
        # if there is no USERNAME environment variable set.
 
2395
        # That could be true if bzr is running as a service,
 
2396
        # e.g. running `bzr serve` as a service on Windows.
 
2397
        # We should not fail with traceback in this case.
 
2398
        username = u'UNKNOWN'
 
2399
    return username
 
2400
 
 
2401
 
 
2402
def available_backup_name(base, exists):
 
2403
    """Find a non-existing backup file name.
 
2404
 
 
2405
    This will *not* create anything, this only return a 'free' entry.  This
 
2406
    should be used for checking names in a directory below a locked
 
2407
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
 
2408
    Leap) and generally discouraged.
 
2409
 
 
2410
    :param base: The base name.
 
2411
 
 
2412
    :param exists: A callable returning True if the path parameter exists.
 
2413
    """
 
2414
    counter = 1
 
2415
    name = "%s.~%d~" % (base, counter)
 
2416
    while exists(name):
 
2417
        counter += 1
 
2418
        name = "%s.~%d~" % (base, counter)
 
2419
    return name
 
2420
 
 
2421
 
 
2422
def set_fd_cloexec(fd):
 
2423
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
 
2424
    support for this is not available.
 
2425
    """
 
2426
    try:
 
2427
        import fcntl
 
2428
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
 
2429
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
 
2430
    except (ImportError, AttributeError):
 
2431
        # Either the fcntl module or specific constants are not present
 
2432
        pass
 
2433
 
 
2434
 
 
2435
def find_executable_on_path(name):
 
2436
    """Finds an executable on the PATH.
 
2437
    
 
2438
    On Windows, this will try to append each extension in the PATHEXT
 
2439
    environment variable to the name, if it cannot be found with the name
 
2440
    as given.
 
2441
    
 
2442
    :param name: The base name of the executable.
 
2443
    :return: The path to the executable found or None.
 
2444
    """
 
2445
    path = os.environ.get('PATH')
 
2446
    if path is None:
 
2447
        return None
 
2448
    path = path.split(os.pathsep)
 
2449
    if sys.platform == 'win32':
 
2450
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
 
2451
        exts = [ext.lower() for ext in exts]
 
2452
        base, ext = os.path.splitext(name)
 
2453
        if ext != '':
 
2454
            if ext.lower() not in exts:
 
2455
                return None
 
2456
            name = base
 
2457
            exts = [ext]
 
2458
    else:
 
2459
        exts = ['']
 
2460
    for ext in exts:
 
2461
        for d in path:
 
2462
            f = os.path.join(d, name) + ext
 
2463
            if os.access(f, os.X_OK):
 
2464
                return f
 
2465
    return None
 
2466
 
 
2467
 
 
2468
def _posix_is_local_pid_dead(pid):
 
2469
    """True if pid doesn't correspond to live process on this machine"""
 
2470
    try:
 
2471
        # Special meaning of unix kill: just check if it's there.
 
2472
        os.kill(pid, 0)
 
2473
    except OSError, e:
 
2474
        if e.errno == errno.ESRCH:
 
2475
            # On this machine, and really not found: as sure as we can be
 
2476
            # that it's dead.
 
2477
            return True
 
2478
        elif e.errno == errno.EPERM:
 
2479
            # exists, though not ours
 
2480
            return False
 
2481
        else:
 
2482
            mutter("os.kill(%d, 0) failed: %s" % (pid, e))
 
2483
            # Don't really know.
 
2484
            return False
 
2485
    else:
 
2486
        # Exists and our process: not dead.
 
2487
        return False
 
2488
 
 
2489
if sys.platform == "win32":
 
2490
    is_local_pid_dead = win32utils.is_local_pid_dead
 
2491
else:
 
2492
    is_local_pid_dead = _posix_is_local_pid_dead
 
2493
 
 
2494
 
 
2495
def fdatasync(fileno):
 
2496
    """Flush file contents to disk if possible.
 
2497
    
 
2498
    :param fileno: Integer OS file handle.
 
2499
    :raises TransportNotPossible: If flushing to disk is not possible.
 
2500
    """
 
2501
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
 
2502
    if fn is not None:
 
2503
        fn(fileno)