/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: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

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