/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:
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
26
25
from bzrlib.lazy_import import lazy_import
27
26
lazy_import(globals(), """
28
27
from datetime import datetime
29
 
import getpass
 
28
import errno
30
29
from ntpath import (abspath as _nt_abspath,
31
30
                    join as _nt_join,
32
31
                    normpath as _nt_normpath,
361
360
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
362
361
 
363
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
 
364
371
def _win32_rename(old, new):
365
372
    """We expect to be able to atomically replace 'new' with old.
366
373
 
368
375
    and then deleted.
369
376
    """
370
377
    try:
371
 
        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)
372
379
    except OSError, e:
373
380
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
374
381
            # If we try to rename a non-existant file onto cwd, we get
379
386
        raise
380
387
 
381
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
 
382
399
def _mac_getcwd():
383
400
    return unicodedata.normalize('NFC', os.getcwdu())
384
401
 
389
406
realpath = _posix_realpath
390
407
pathjoin = os.path.join
391
408
normpath = os.path.normpath
 
409
rename = _wrapped_rename # overridden below on win32
392
410
getcwd = os.getcwdu
393
 
rename = os.rename
394
411
dirname = os.path.dirname
395
412
basename = os.path.basename
396
413
split = os.path.split
931
948
 
932
949
def parent_directories(filename):
933
950
    """Return the list of parent directories, deepest first.
934
 
 
 
951
    
935
952
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
936
953
    """
937
954
    parents = []
961
978
    # NB: This docstring is just an example, not a doctest, because doctest
962
979
    # currently can't cope with the use of lazy imports in this namespace --
963
980
    # mbp 20090729
964
 
 
 
981
    
965
982
    # This currently doesn't report the failure at the time it occurs, because
966
983
    # they tend to happen very early in startup when we can't check config
967
984
    # files etc, and also we want to report all failures but not spam the user
1037
1054
 
1038
1055
 
1039
1056
def delete_any(path):
1040
 
    """Delete a file, symlink or directory.
1041
 
 
 
1057
    """Delete a file, symlink or directory.  
 
1058
    
1042
1059
    Will delete even if readonly.
1043
1060
    """
1044
1061
    try:
1233
1250
    # but for now, we haven't optimized...
1234
1251
    return [canonical_relpath(base, p) for p in paths]
1235
1252
 
1236
 
 
1237
 
def decode_filename(filename):
1238
 
    """Decode the filename using the filesystem encoding
1239
 
 
1240
 
    If it is unicode, it is returned.
1241
 
    Otherwise it is decoded from the the filesystem's encoding. If decoding
1242
 
    fails, a errors.BadFilenameEncoding exception is raised.
1243
 
    """
1244
 
    if type(filename) is unicode:
1245
 
        return filename
1246
 
    try:
1247
 
        return filename.decode(_fs_enc)
1248
 
    except UnicodeDecodeError:
1249
 
        raise errors.BadFilenameEncoding(filename, _fs_enc)
1250
 
 
1251
 
 
1252
1253
def safe_unicode(unicode_or_utf8_string):
1253
1254
    """Coerce unicode_or_utf8_string into unicode.
1254
1255
 
1337
1338
def normalizes_filenames():
1338
1339
    """Return True if this platform normalizes unicode filenames.
1339
1340
 
1340
 
    Only Mac OSX.
 
1341
    Mac OSX does, Windows/Linux do not.
1341
1342
    """
1342
1343
    return _platform_normalizes_filenames
1343
1344
 
1348
1349
    On platforms where the system normalizes filenames (Mac OSX),
1349
1350
    you can access a file by any path which will normalize correctly.
1350
1351
    On platforms where the system does not normalize filenames
1351
 
    (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.
1352
1353
 
1353
1354
    Internally, bzr only supports NFC normalization, since that is
1354
1355
    the standard for XML documents.
1416
1417
terminal_width() returns None.
1417
1418
"""
1418
1419
 
1419
 
# Keep some state so that terminal_width can detect if _terminal_size has
1420
 
# returned a different size since the process started.  See docstring and
1421
 
# comments of terminal_width for details.
1422
 
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
1423
 
_terminal_size_state = 'no_data'
1424
 
_first_terminal_size = None
1425
1420
 
1426
1421
def terminal_width():
1427
1422
    """Return terminal width.
1431
1426
    The rules are:
1432
1427
    - if BZR_COLUMNS is set, returns its value
1433
1428
    - if there is no controlling terminal, returns None
1434
 
    - query the OS, if the queried size has changed since the last query,
1435
 
      return its value,
1436
1429
    - if COLUMNS is set, returns its value,
1437
 
    - if the OS has a value (even though it's never changed), return its value.
1438
1430
 
1439
1431
    From there, we need to query the OS to get the size of the controlling
1440
1432
    terminal.
1441
1433
 
1442
 
    On Unices we query the OS by:
 
1434
    Unices:
1443
1435
    - get termios.TIOCGWINSZ
1444
1436
    - if an error occurs or a negative value is obtained, returns None
1445
1437
 
1446
 
    On Windows we query the OS by:
 
1438
    Windows:
 
1439
    
1447
1440
    - win32utils.get_console_size() decides,
1448
1441
    - returns None on error (provided default value)
1449
1442
    """
1450
 
    # Note to implementors: if changing the rules for determining the width,
1451
 
    # make sure you've considered the behaviour in these cases:
1452
 
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1453
 
    #  - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1454
 
    #    0,0.
1455
 
    #  - (add more interesting cases here, if you find any)
1456
 
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1457
 
    # but we don't want to register a signal handler because it is impossible
1458
 
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
1459
 
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
1460
 
    # time so we can notice if the reported size has changed, which should have
1461
 
    # a similar effect.
1462
1443
 
1463
1444
    # If BZR_COLUMNS is set, take it, user is always right
1464
1445
    try:
1467
1448
        pass
1468
1449
 
1469
1450
    isatty = getattr(sys.stdout, 'isatty', None)
1470
 
    if isatty is None or not isatty():
 
1451
    if  isatty is None or not isatty():
1471
1452
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1472
1453
        return None
1473
1454
 
1474
 
    # Query the OS
1475
 
    width, height = os_size = _terminal_size(None, None)
1476
 
    global _first_terminal_size, _terminal_size_state
1477
 
    if _terminal_size_state == 'no_data':
1478
 
        _first_terminal_size = os_size
1479
 
        _terminal_size_state = 'unchanged'
1480
 
    elif (_terminal_size_state == 'unchanged' and
1481
 
          _first_terminal_size != os_size):
1482
 
        _terminal_size_state = 'changed'
1483
 
 
1484
 
    # If the OS claims to know how wide the terminal is, and this value has
1485
 
    # ever changed, use that.
1486
 
    if _terminal_size_state == 'changed':
1487
 
        if width is not None and width > 0:
1488
 
            return width
1489
 
 
1490
 
    # 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))
1491
1458
    try:
1492
1459
        return int(os.environ['COLUMNS'])
1493
1460
    except (KeyError, ValueError):
1494
1461
        pass
1495
1462
 
1496
 
    # Finally, use an unchanged size from the OS, if we have one.
1497
 
    if _terminal_size_state == 'unchanged':
1498
 
        if width is not None and width > 0:
1499
 
            return width
 
1463
    width, height = _terminal_size(None, None)
 
1464
    if width <= 0:
 
1465
        # Consider invalid values as meaning no width
 
1466
        return None
1500
1467
 
1501
 
    # The width could not be determined.
1502
 
    return None
 
1468
    return width
1503
1469
 
1504
1470
 
1505
1471
def _win32_terminal_size(width, height):
1532
1498
    _terminal_size = _ioctl_terminal_size
1533
1499
 
1534
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
 
1535
1526
def supports_executable():
1536
1527
    return sys.platform != "win32"
1537
1528
 
1660
1651
        dirblock = []
1661
1652
        append = dirblock.append
1662
1653
        try:
1663
 
            names = sorted(map(decode_filename, _listdir(top)))
 
1654
            names = sorted(_listdir(top))
1664
1655
        except OSError, e:
1665
1656
            if not _is_error_enotdir(e):
1666
1657
                raise
1968
1959
    return user_encoding
1969
1960
 
1970
1961
 
1971
 
def get_diff_header_encoding():
1972
 
    return get_terminal_encoding()
1973
 
 
1974
 
 
1975
1962
def get_host_name():
1976
1963
    """Return the current unicode host name.
1977
1964
 
2040
2027
 
2041
2028
def send_all(sock, bytes, report_activity=None):
2042
2029
    """Send all bytes on a socket.
2043
 
 
 
2030
 
2044
2031
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2045
2032
    some platforms, and catches EINTR which may be thrown if the send is
2046
2033
    interrupted by a signal.
2047
2034
 
2048
2035
    This is preferred to socket.sendall(), because it avoids portability bugs
2049
2036
    and provides activity reporting.
2050
 
 
 
2037
 
2051
2038
    :param report_activity: Call this as bytes are read, see
2052
2039
        Transport._report_activity
2053
2040
    """
2108
2095
    base = dirname(bzrlib.__file__)
2109
2096
    if getattr(sys, 'frozen', None):    # bzr.exe
2110
2097
        base = abspath(pathjoin(base, '..', '..'))
2111
 
    f = file(pathjoin(base, resource_relpath), "rU")
2112
 
    try:
2113
 
        return f.read()
2114
 
    finally:
2115
 
        f.close()
 
2098
    filename = pathjoin(base, resource_relpath)
 
2099
    return open(filename, 'rU').read()
 
2100
 
2116
2101
 
2117
2102
def file_kind_from_stat_mode_thunk(mode):
2118
2103
    global file_kind_from_stat_mode
2141
2126
 
2142
2127
def until_no_eintr(f, *a, **kw):
2143
2128
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2144
 
 
 
2129
    
2145
2130
    WARNING: you must be certain that it is safe to retry the call repeatedly
2146
2131
    if EINTR does occur.  This is typically only true for low-level operations
2147
2132
    like os.read.  If in any doubt, don't use this.
2278
2263
if sys.platform == 'win32':
2279
2264
    def open_file(filename, mode='r', bufsize=-1):
2280
2265
        """This function is used to override the ``open`` builtin.
2281
 
 
 
2266
        
2282
2267
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2283
2268
        child processes.  Deleting or renaming a closed file opened with this
2284
2269
        function is not blocking child processes.
2317
2302
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2318
2303
else:
2319
2304
    open_file = open
2320
 
 
2321
 
 
2322
 
def getuser_unicode():
2323
 
    """Return the username as unicode.
2324
 
    """
2325
 
    try:
2326
 
        user_encoding = get_user_encoding()
2327
 
        username = getpass.getuser().decode(user_encoding)
2328
 
    except UnicodeDecodeError:
2329
 
        raise errors.BzrError("Can't decode username as %s." % \
2330
 
                user_encoding)
2331
 
    return username