/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-10-07 14:51:42 UTC
  • mto: (6015.33.11 2.4)
  • mto: This revision was merged to the branch mainline in revision 6206.
  • Revision ID: v.ladeuil+lp@free.fr-20111007145142-oyvn7y3fhz174gs5
Here are the useful print statements used to debug the previous commit.

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
287
277
    # copy posixpath.abspath, but use os.getcwdu instead
288
278
    if not posixpath.isabs(path):
289
279
        path = posixpath.join(getcwd(), path)
290
 
    return posixpath.normpath(path)
 
280
    return _posix_normpath(path)
291
281
 
292
282
 
293
283
def _posix_realpath(path):
294
284
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
295
285
 
296
286
 
 
287
def _posix_normpath(path):
 
288
    path = posixpath.normpath(path)
 
289
    # Bug 861008: posixpath.normpath() returns a path normalized according to
 
290
    # the POSIX standard, which stipulates (for compatibility reasons) that two
 
291
    # leading slashes must not be simplified to one, and only if there are 3 or
 
292
    # more should they be simplified as one. So we treat the leading 2 slashes
 
293
    # as a special case here by simply removing the first slash, as we consider
 
294
    # that breaking POSIX compatibility for this obscure feature is acceptable.
 
295
    # This is not a paranoid precaution, as we notably get paths like this when
 
296
    # the repo is hosted at the root of the filesystem, i.e. in "/".    
 
297
    if path.startswith('//'):
 
298
        path = path[1:]
 
299
    return path
 
300
 
 
301
 
297
302
def _win32_fixdrive(path):
298
303
    """Force drive letters to be consistent.
299
304
 
303
308
    running python.exe under cmd.exe return capital C:\\
304
309
    running win32 python inside a cygwin shell returns lowercase c:\\
305
310
    """
306
 
    drive, path = _nt_splitdrive(path)
 
311
    drive, path = ntpath.splitdrive(path)
307
312
    return drive.upper() + path
308
313
 
309
314
 
310
315
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('\\', '/'))
 
316
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
 
317
    return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
313
318
 
314
319
 
315
320
def _win98_abspath(path):
326
331
    #   /path       => C:/path
327
332
    path = unicode(path)
328
333
    # check for absolute path
329
 
    drive = _nt_splitdrive(path)[0]
 
334
    drive = ntpath.splitdrive(path)[0]
330
335
    if drive == '' and path[:2] not in('//','\\\\'):
331
336
        cwd = os.getcwdu()
332
337
        # we cannot simply os.path.join cwd and path
333
338
        # because os.path.join('C:','/path') produce '/path'
334
339
        # and this is incorrect
335
340
        if path[:1] in ('/','\\'):
336
 
            cwd = _nt_splitdrive(cwd)[0]
 
341
            cwd = ntpath.splitdrive(cwd)[0]
337
342
            path = path[1:]
338
343
        path = cwd + '\\' + path
339
 
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
 
344
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
340
345
 
341
346
 
342
347
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('\\', '/'))
 
348
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
 
349
    return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
345
350
 
346
351
 
347
352
def _win32_pathjoin(*args):
348
 
    return _nt_join(*args).replace('\\', '/')
 
353
    return ntpath.join(*args).replace('\\', '/')
349
354
 
350
355
 
351
356
def _win32_normpath(path):
352
 
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
357
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
353
358
 
354
359
 
355
360
def _win32_getcwd():
360
365
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
361
366
 
362
367
 
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
368
def _win32_rename(old, new):
372
369
    """We expect to be able to atomically replace 'new' with old.
373
370
 
375
372
    and then deleted.
376
373
    """
377
374
    try:
378
 
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
 
375
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
379
376
    except OSError, e:
380
377
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
381
378
            # If we try to rename a non-existant file onto cwd, we get
386
383
        raise
387
384
 
388
385
 
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
386
def _mac_getcwd():
400
387
    return unicodedata.normalize('NFC', os.getcwdu())
401
388
 
405
392
abspath = _posix_abspath
406
393
realpath = _posix_realpath
407
394
pathjoin = os.path.join
408
 
normpath = os.path.normpath
409
 
rename = _wrapped_rename # overridden below on win32
 
395
normpath = _posix_normpath
410
396
getcwd = os.getcwdu
 
397
rename = os.rename
411
398
dirname = os.path.dirname
412
399
basename = os.path.basename
413
400
split = os.path.split
414
401
splitext = os.path.splitext
415
 
# These were already imported into local scope
 
402
# These were already lazily imported into local scope
416
403
# mkdtemp = tempfile.mkdtemp
417
404
# rmtree = shutil.rmtree
 
405
lstat = os.lstat
 
406
fstat = os.fstat
 
407
 
 
408
def wrap_stat(st):
 
409
    return st
 
410
 
418
411
 
419
412
MIN_ABS_PATHLENGTH = 1
420
413
 
430
423
    getcwd = _win32_getcwd
431
424
    mkdtemp = _win32_mkdtemp
432
425
    rename = _win32_rename
 
426
    try:
 
427
        from bzrlib import _walkdirs_win32
 
428
    except ImportError:
 
429
        pass
 
430
    else:
 
431
        lstat = _walkdirs_win32.lstat
 
432
        fstat = _walkdirs_win32.fstat
 
433
        wrap_stat = _walkdirs_win32.wrap_stat
433
434
 
434
435
    MIN_ABS_PATHLENGTH = 3
435
436
 
458
459
    getcwd = _mac_getcwd
459
460
 
460
461
 
461
 
def get_terminal_encoding():
 
462
def get_terminal_encoding(trace=False):
462
463
    """Find the best encoding for printing to the screen.
463
464
 
464
465
    This attempts to check both sys.stdout and sys.stdin to see
470
471
 
471
472
    On my standard US Windows XP, the preferred encoding is
472
473
    cp1252, but the console is cp437
 
474
 
 
475
    :param trace: If True trace the selected encoding via mutter().
473
476
    """
474
477
    from bzrlib.trace import mutter
475
478
    output_encoding = getattr(sys.stdout, 'encoding', None)
477
480
        input_encoding = getattr(sys.stdin, 'encoding', None)
478
481
        if not input_encoding:
479
482
            output_encoding = get_user_encoding()
480
 
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
483
            if trace:
 
484
                mutter('encoding stdout as osutils.get_user_encoding() %r',
481
485
                   output_encoding)
482
486
        else:
483
487
            output_encoding = input_encoding
484
 
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
488
            if trace:
 
489
                mutter('encoding stdout as sys.stdin encoding %r',
 
490
                    output_encoding)
485
491
    else:
486
 
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
492
        if trace:
 
493
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
487
494
    if output_encoding == 'cp0':
488
495
        # invalid encoding (cp0 means 'no codepage' on Windows)
489
496
        output_encoding = get_user_encoding()
490
 
        mutter('cp0 is invalid encoding.'
 
497
        if trace:
 
498
            mutter('cp0 is invalid encoding.'
491
499
               ' encoding stdout as osutils.get_user_encoding() %r',
492
500
               output_encoding)
493
501
    # check encoding
519
527
def isdir(f):
520
528
    """True if f is an accessible directory."""
521
529
    try:
522
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
530
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
523
531
    except OSError:
524
532
        return False
525
533
 
527
535
def isfile(f):
528
536
    """True if f is a regular file."""
529
537
    try:
530
 
        return S_ISREG(os.lstat(f)[ST_MODE])
 
538
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
531
539
    except OSError:
532
540
        return False
533
541
 
534
542
def islink(f):
535
543
    """True if f is a symlink."""
536
544
    try:
537
 
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
545
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
538
546
    except OSError:
539
547
        return False
540
548
 
880
888
 
881
889
def filesize(f):
882
890
    """Return size of given open file."""
883
 
    return os.fstat(f.fileno())[ST_SIZE]
 
891
    return os.fstat(f.fileno())[stat.ST_SIZE]
884
892
 
885
893
 
886
894
# Define rand_bytes based on platform.
948
956
 
949
957
def parent_directories(filename):
950
958
    """Return the list of parent directories, deepest first.
951
 
    
 
959
 
952
960
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
953
961
    """
954
962
    parents = []
978
986
    # NB: This docstring is just an example, not a doctest, because doctest
979
987
    # currently can't cope with the use of lazy imports in this namespace --
980
988
    # mbp 20090729
981
 
    
 
989
 
982
990
    # This currently doesn't report the failure at the time it occurs, because
983
991
    # they tend to happen very early in startup when we can't check config
984
992
    # files etc, and also we want to report all failures but not spam the user
985
993
    # with 10 warnings.
986
 
    from bzrlib import trace
987
994
    exception_str = str(exception)
988
995
    if exception_str not in _extension_load_failures:
989
996
        trace.mutter("failed to load compiled extension: %s" % exception_str)
1054
1061
 
1055
1062
 
1056
1063
def delete_any(path):
1057
 
    """Delete a file, symlink or directory.  
1058
 
    
 
1064
    """Delete a file, symlink or directory.
 
1065
 
1059
1066
    Will delete even if readonly.
1060
1067
    """
1061
1068
    try:
1250
1257
    # but for now, we haven't optimized...
1251
1258
    return [canonical_relpath(base, p) for p in paths]
1252
1259
 
 
1260
 
 
1261
def decode_filename(filename):
 
1262
    """Decode the filename using the filesystem encoding
 
1263
 
 
1264
    If it is unicode, it is returned.
 
1265
    Otherwise it is decoded from the the filesystem's encoding. If decoding
 
1266
    fails, a errors.BadFilenameEncoding exception is raised.
 
1267
    """
 
1268
    if type(filename) is unicode:
 
1269
        return filename
 
1270
    try:
 
1271
        return filename.decode(_fs_enc)
 
1272
    except UnicodeDecodeError:
 
1273
        raise errors.BadFilenameEncoding(filename, _fs_enc)
 
1274
 
 
1275
 
1253
1276
def safe_unicode(unicode_or_utf8_string):
1254
1277
    """Coerce unicode_or_utf8_string into unicode.
1255
1278
 
1338
1361
def normalizes_filenames():
1339
1362
    """Return True if this platform normalizes unicode filenames.
1340
1363
 
1341
 
    Mac OSX does, Windows/Linux do not.
 
1364
    Only Mac OSX.
1342
1365
    """
1343
1366
    return _platform_normalizes_filenames
1344
1367
 
1349
1372
    On platforms where the system normalizes filenames (Mac OSX),
1350
1373
    you can access a file by any path which will normalize correctly.
1351
1374
    On platforms where the system does not normalize filenames
1352
 
    (Windows, Linux), you have to access a file by its exact path.
 
1375
    (everything else), you have to access a file by its exact path.
1353
1376
 
1354
1377
    Internally, bzr only supports NFC normalization, since that is
1355
1378
    the standard for XML documents.
1417
1440
terminal_width() returns None.
1418
1441
"""
1419
1442
 
 
1443
# Keep some state so that terminal_width can detect if _terminal_size has
 
1444
# returned a different size since the process started.  See docstring and
 
1445
# comments of terminal_width for details.
 
1446
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
 
1447
_terminal_size_state = 'no_data'
 
1448
_first_terminal_size = None
1420
1449
 
1421
1450
def terminal_width():
1422
1451
    """Return terminal width.
1426
1455
    The rules are:
1427
1456
    - if BZR_COLUMNS is set, returns its value
1428
1457
    - if there is no controlling terminal, returns None
 
1458
    - query the OS, if the queried size has changed since the last query,
 
1459
      return its value,
1429
1460
    - if COLUMNS is set, returns its value,
 
1461
    - if the OS has a value (even though it's never changed), return its value.
1430
1462
 
1431
1463
    From there, we need to query the OS to get the size of the controlling
1432
1464
    terminal.
1433
1465
 
1434
 
    Unices:
 
1466
    On Unices we query the OS by:
1435
1467
    - get termios.TIOCGWINSZ
1436
1468
    - if an error occurs or a negative value is obtained, returns None
1437
1469
 
1438
 
    Windows:
1439
 
    
 
1470
    On Windows we query the OS by:
1440
1471
    - win32utils.get_console_size() decides,
1441
1472
    - returns None on error (provided default value)
1442
1473
    """
 
1474
    # Note to implementors: if changing the rules for determining the width,
 
1475
    # make sure you've considered the behaviour in these cases:
 
1476
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
 
1477
    #  - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
 
1478
    #    0,0.
 
1479
    #  - (add more interesting cases here, if you find any)
 
1480
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
 
1481
    # but we don't want to register a signal handler because it is impossible
 
1482
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
 
1483
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
 
1484
    # time so we can notice if the reported size has changed, which should have
 
1485
    # a similar effect.
1443
1486
 
1444
1487
    # If BZR_COLUMNS is set, take it, user is always right
 
1488
    # Except if they specified 0 in which case, impose no limit here
1445
1489
    try:
1446
 
        return int(os.environ['BZR_COLUMNS'])
 
1490
        width = int(os.environ['BZR_COLUMNS'])
1447
1491
    except (KeyError, ValueError):
1448
 
        pass
 
1492
        width = None
 
1493
    if width is not None:
 
1494
        if width > 0:
 
1495
            return width
 
1496
        else:
 
1497
            return None
1449
1498
 
1450
1499
    isatty = getattr(sys.stdout, 'isatty', None)
1451
 
    if  isatty is None or not isatty():
 
1500
    if isatty is None or not isatty():
1452
1501
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1453
1502
        return None
1454
1503
 
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))
 
1504
    # Query the OS
 
1505
    width, height = os_size = _terminal_size(None, None)
 
1506
    global _first_terminal_size, _terminal_size_state
 
1507
    if _terminal_size_state == 'no_data':
 
1508
        _first_terminal_size = os_size
 
1509
        _terminal_size_state = 'unchanged'
 
1510
    elif (_terminal_size_state == 'unchanged' and
 
1511
          _first_terminal_size != os_size):
 
1512
        _terminal_size_state = 'changed'
 
1513
 
 
1514
    # If the OS claims to know how wide the terminal is, and this value has
 
1515
    # ever changed, use that.
 
1516
    if _terminal_size_state == 'changed':
 
1517
        if width is not None and width > 0:
 
1518
            return width
 
1519
 
 
1520
    # If COLUMNS is set, use it.
1458
1521
    try:
1459
1522
        return int(os.environ['COLUMNS'])
1460
1523
    except (KeyError, ValueError):
1461
1524
        pass
1462
1525
 
1463
 
    width, height = _terminal_size(None, None)
1464
 
    if width <= 0:
1465
 
        # Consider invalid values as meaning no width
1466
 
        return None
 
1526
    # Finally, use an unchanged size from the OS, if we have one.
 
1527
    if _terminal_size_state == 'unchanged':
 
1528
        if width is not None and width > 0:
 
1529
            return width
1467
1530
 
1468
 
    return width
 
1531
    # The width could not be determined.
 
1532
    return None
1469
1533
 
1470
1534
 
1471
1535
def _win32_terminal_size(width, height):
1498
1562
    _terminal_size = _ioctl_terminal_size
1499
1563
 
1500
1564
 
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
1565
def supports_executable():
1527
1566
    return sys.platform != "win32"
1528
1567
 
1651
1690
        dirblock = []
1652
1691
        append = dirblock.append
1653
1692
        try:
1654
 
            names = sorted(_listdir(top))
 
1693
            names = sorted(map(decode_filename, _listdir(top)))
1655
1694
        except OSError, e:
1656
1695
            if not _is_error_enotdir(e):
1657
1696
                raise
1865
1904
        s = os.stat(src)
1866
1905
        chown(dst, s.st_uid, s.st_gid)
1867
1906
    except OSError, e:
1868
 
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
 
1907
        trace.warning(
 
1908
            'Unable to copy ownership from "%s" to "%s". '
 
1909
            'You may want to set it manually.', src, dst)
 
1910
        trace.log_exception_quietly()
1869
1911
 
1870
1912
 
1871
1913
def path_prefix_key(path):
1959
2001
    return user_encoding
1960
2002
 
1961
2003
 
 
2004
def get_diff_header_encoding():
 
2005
    return get_terminal_encoding()
 
2006
 
 
2007
 
1962
2008
def get_host_name():
1963
2009
    """Return the current unicode host name.
1964
2010
 
1979
2025
# data at once.
1980
2026
MAX_SOCKET_CHUNK = 64 * 1024
1981
2027
 
 
2028
_end_of_stream_errors = [errno.ECONNRESET]
 
2029
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
 
2030
    _eno = getattr(errno, _eno, None)
 
2031
    if _eno is not None:
 
2032
        _end_of_stream_errors.append(_eno)
 
2033
del _eno
 
2034
 
 
2035
 
1982
2036
def read_bytes_from_socket(sock, report_activity=None,
1983
2037
        max_read_size=MAX_SOCKET_CHUNK):
1984
2038
    """Read up to max_read_size of bytes from sock and notify of progress.
1992
2046
            bytes = sock.recv(max_read_size)
1993
2047
        except socket.error, e:
1994
2048
            eno = e.args[0]
1995
 
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
 
2049
            if eno in _end_of_stream_errors:
1996
2050
                # The connection was closed by the other side.  Callers expect
1997
2051
                # an empty string to signal end-of-stream.
1998
2052
                return ""
2027
2081
 
2028
2082
def send_all(sock, bytes, report_activity=None):
2029
2083
    """Send all bytes on a socket.
2030
 
 
 
2084
 
2031
2085
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2032
2086
    some platforms, and catches EINTR which may be thrown if the send is
2033
2087
    interrupted by a signal.
2034
2088
 
2035
2089
    This is preferred to socket.sendall(), because it avoids portability bugs
2036
2090
    and provides activity reporting.
2037
 
 
 
2091
 
2038
2092
    :param report_activity: Call this as bytes are read, see
2039
2093
        Transport._report_activity
2040
2094
    """
2051
2105
            report_activity(sent, 'write')
2052
2106
 
2053
2107
 
 
2108
def connect_socket(address):
 
2109
    # Slight variation of the socket.create_connection() function (provided by
 
2110
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
 
2111
    # provide it for previous python versions. Also, we don't use the timeout
 
2112
    # parameter (provided by the python implementation) so we don't implement
 
2113
    # it either).
 
2114
    err = socket.error('getaddrinfo returns an empty list')
 
2115
    host, port = address
 
2116
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
 
2117
        af, socktype, proto, canonname, sa = res
 
2118
        sock = None
 
2119
        try:
 
2120
            sock = socket.socket(af, socktype, proto)
 
2121
            sock.connect(sa)
 
2122
            return sock
 
2123
 
 
2124
        except socket.error, err:
 
2125
            # 'err' is now the most recent error
 
2126
            if sock is not None:
 
2127
                sock.close()
 
2128
    raise err
 
2129
 
 
2130
 
2054
2131
def dereference_path(path):
2055
2132
    """Determine the real path to a file.
2056
2133
 
2095
2172
    base = dirname(bzrlib.__file__)
2096
2173
    if getattr(sys, 'frozen', None):    # bzr.exe
2097
2174
        base = abspath(pathjoin(base, '..', '..'))
2098
 
    filename = pathjoin(base, resource_relpath)
2099
 
    return open(filename, 'rU').read()
2100
 
 
 
2175
    f = file(pathjoin(base, resource_relpath), "rU")
 
2176
    try:
 
2177
        return f.read()
 
2178
    finally:
 
2179
        f.close()
2101
2180
 
2102
2181
def file_kind_from_stat_mode_thunk(mode):
2103
2182
    global file_kind_from_stat_mode
2126
2205
 
2127
2206
def until_no_eintr(f, *a, **kw):
2128
2207
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2129
 
    
 
2208
 
2130
2209
    WARNING: you must be certain that it is safe to retry the call repeatedly
2131
2210
    if EINTR does occur.  This is typically only true for low-level operations
2132
2211
    like os.read.  If in any doubt, don't use this.
2147
2226
            raise
2148
2227
 
2149
2228
 
 
2229
@deprecated_function(deprecated_in((2, 2, 0)))
2150
2230
def re_compile_checked(re_string, flags=0, where=""):
2151
2231
    """Return a compiled re, or raise a sensible error.
2152
2232
 
2162
2242
        re_obj = re.compile(re_string, flags)
2163
2243
        re_obj.search("")
2164
2244
        return re_obj
2165
 
    except re.error, e:
 
2245
    except errors.InvalidPattern, e:
2166
2246
        if where:
2167
2247
            where = ' in ' + where
2168
2248
        # despite the name 'error' is a type
2169
 
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2170
 
            % (where, re_string, e))
 
2249
        raise errors.BzrCommandError('Invalid regular expression%s: %s'
 
2250
            % (where, e.msg))
2171
2251
 
2172
2252
 
2173
2253
if sys.platform == "win32":
2187
2267
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2188
2268
        return ch
2189
2269
 
2190
 
 
2191
2270
if sys.platform == 'linux2':
2192
2271
    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
 
2272
        try:
 
2273
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2274
        except (ValueError, OSError, AttributeError):
 
2275
            return None
2199
2276
elif sys.platform == 'darwin':
2200
2277
    def _local_concurrency():
2201
2278
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2202
2279
                                stdout=subprocess.PIPE).communicate()[0]
2203
 
elif sys.platform[0:7] == 'freebsd':
 
2280
elif "bsd" in sys.platform:
2204
2281
    def _local_concurrency():
2205
2282
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2206
2283
                                stdout=subprocess.PIPE).communicate()[0]
2234
2311
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2235
2312
    if concurrency is None:
2236
2313
        try:
2237
 
            concurrency = _local_concurrency()
2238
 
        except (OSError, IOError):
2239
 
            pass
 
2314
            import multiprocessing
 
2315
        except ImportError:
 
2316
            # multiprocessing is only available on Python >= 2.6
 
2317
            try:
 
2318
                concurrency = _local_concurrency()
 
2319
            except (OSError, IOError):
 
2320
                pass
 
2321
        else:
 
2322
            concurrency = multiprocessing.cpu_count()
2240
2323
    try:
2241
2324
        concurrency = int(concurrency)
2242
2325
    except (TypeError, ValueError):
2263
2346
if sys.platform == 'win32':
2264
2347
    def open_file(filename, mode='r', bufsize=-1):
2265
2348
        """This function is used to override the ``open`` builtin.
2266
 
        
 
2349
 
2267
2350
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2268
2351
        child processes.  Deleting or renaming a closed file opened with this
2269
2352
        function is not blocking child processes.
2302
2385
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2303
2386
else:
2304
2387
    open_file = open
 
2388
 
 
2389
 
 
2390
def getuser_unicode():
 
2391
    """Return the username as unicode.
 
2392
    """
 
2393
    try:
 
2394
        user_encoding = get_user_encoding()
 
2395
        username = getpass.getuser().decode(user_encoding)
 
2396
    except UnicodeDecodeError:
 
2397
        raise errors.BzrError("Can't decode username as %s." % \
 
2398
                user_encoding)
 
2399
    except ImportError, e:
 
2400
        if sys.platform != 'win32':
 
2401
            raise
 
2402
        if str(e) != 'No module named pwd':
 
2403
            raise
 
2404
        # https://bugs.launchpad.net/bzr/+bug/660174
 
2405
        # getpass.getuser() is unable to return username on Windows
 
2406
        # if there is no USERNAME environment variable set.
 
2407
        # That could be true if bzr is running as a service,
 
2408
        # e.g. running `bzr serve` as a service on Windows.
 
2409
        # We should not fail with traceback in this case.
 
2410
        username = u'UNKNOWN'
 
2411
    return username
 
2412
 
 
2413
 
 
2414
def available_backup_name(base, exists):
 
2415
    """Find a non-existing backup file name.
 
2416
 
 
2417
    This will *not* create anything, this only return a 'free' entry.  This
 
2418
    should be used for checking names in a directory below a locked
 
2419
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
 
2420
    Leap) and generally discouraged.
 
2421
 
 
2422
    :param base: The base name.
 
2423
 
 
2424
    :param exists: A callable returning True if the path parameter exists.
 
2425
    """
 
2426
    counter = 1
 
2427
    name = "%s.~%d~" % (base, counter)
 
2428
    while exists(name):
 
2429
        counter += 1
 
2430
        name = "%s.~%d~" % (base, counter)
 
2431
    return name
 
2432
 
 
2433
 
 
2434
def set_fd_cloexec(fd):
 
2435
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
 
2436
    support for this is not available.
 
2437
    """
 
2438
    try:
 
2439
        import fcntl
 
2440
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
 
2441
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
 
2442
    except (ImportError, AttributeError):
 
2443
        # Either the fcntl module or specific constants are not present
 
2444
        pass
 
2445
 
 
2446
 
 
2447
def find_executable_on_path(name):
 
2448
    """Finds an executable on the PATH.
 
2449
    
 
2450
    On Windows, this will try to append each extension in the PATHEXT
 
2451
    environment variable to the name, if it cannot be found with the name
 
2452
    as given.
 
2453
    
 
2454
    :param name: The base name of the executable.
 
2455
    :return: The path to the executable found or None.
 
2456
    """
 
2457
    path = os.environ.get('PATH')
 
2458
    if path is None:
 
2459
        return None
 
2460
    path = path.split(os.pathsep)
 
2461
    if sys.platform == 'win32':
 
2462
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
 
2463
        exts = [ext.lower() for ext in exts]
 
2464
        base, ext = os.path.splitext(name)
 
2465
        if ext != '':
 
2466
            if ext.lower() not in exts:
 
2467
                return None
 
2468
            name = base
 
2469
            exts = [ext]
 
2470
    else:
 
2471
        exts = ['']
 
2472
    for ext in exts:
 
2473
        for d in path:
 
2474
            f = os.path.join(d, name) + ext
 
2475
            if os.access(f, os.X_OK):
 
2476
                return f
 
2477
    return None
 
2478
 
 
2479
 
 
2480
def _posix_is_local_pid_dead(pid):
 
2481
    """True if pid doesn't correspond to live process on this machine"""
 
2482
    try:
 
2483
        # Special meaning of unix kill: just check if it's there.
 
2484
        os.kill(pid, 0)
 
2485
    except OSError, e:
 
2486
        if e.errno == errno.ESRCH:
 
2487
            # On this machine, and really not found: as sure as we can be
 
2488
            # that it's dead.
 
2489
            return True
 
2490
        elif e.errno == errno.EPERM:
 
2491
            # exists, though not ours
 
2492
            return False
 
2493
        else:
 
2494
            mutter("os.kill(%d, 0) failed: %s" % (pid, e))
 
2495
            # Don't really know.
 
2496
            return False
 
2497
    else:
 
2498
        # Exists and our process: not dead.
 
2499
        return False
 
2500
 
 
2501
if sys.platform == "win32":
 
2502
    is_local_pid_dead = win32utils.is_local_pid_dead
 
2503
else:
 
2504
    is_local_pid_dead = _posix_is_local_pid_dead
 
2505
 
 
2506
 
 
2507
def fdatasync(fileno):
 
2508
    """Flush file contents to disk if possible.
 
2509
    
 
2510
    :param fileno: Integer OS file handle.
 
2511
    :raises TransportNotPossible: If flushing to disk is not possible.
 
2512
    """
 
2513
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
 
2514
    if fn is not None:
 
2515
        fn(fileno)