~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Robert Collins
  • Date: 2010-06-21 01:30:45 UTC
  • mfrom: (5309 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5310.
  • Revision ID: robertc@robertcollins.net-20100621013045-s59nfjps3rkcn53j
Merge trunk to fix NEWS sections.

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
17
18
import os
18
19
import re
19
20
import stat
25
26
from bzrlib.lazy_import import lazy_import
26
27
lazy_import(globals(), """
27
28
from datetime import datetime
28
 
import errno
29
29
import getpass
30
30
from ntpath import (abspath as _nt_abspath,
31
31
                    join as _nt_join,
361
361
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
362
362
 
363
363
 
364
 
def _add_rename_error_details(e, old, new):
365
 
    new_e = OSError(e.errno, "failed to rename %s to %s: %s"
366
 
        % (old, new, e.strerror))
367
 
    new_e.filename = old
368
 
    new_e.to_filename = new
369
 
    return new_e
370
 
 
371
 
 
372
364
def _win32_rename(old, new):
373
365
    """We expect to be able to atomically replace 'new' with old.
374
366
 
376
368
    and then deleted.
377
369
    """
378
370
    try:
379
 
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
 
371
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
380
372
    except OSError, e:
381
373
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
382
374
            # If we try to rename a non-existant file onto cwd, we get
387
379
        raise
388
380
 
389
381
 
390
 
def _wrapped_rename(old, new):
391
 
    """Rename a file or directory"""
392
 
    try:
393
 
        os.rename(old, new)
394
 
    except (IOError, OSError), e:
395
 
        # this is eventually called by all rename-like functions, so should 
396
 
        # catch all of them
397
 
        raise _add_rename_error_details(e, old, new)
398
 
 
399
 
 
400
382
def _mac_getcwd():
401
383
    return unicodedata.normalize('NFC', os.getcwdu())
402
384
 
407
389
realpath = _posix_realpath
408
390
pathjoin = os.path.join
409
391
normpath = os.path.normpath
410
 
rename = _wrapped_rename # overridden below on win32
411
392
getcwd = os.getcwdu
 
393
rename = os.rename
412
394
dirname = os.path.dirname
413
395
basename = os.path.basename
414
396
split = os.path.split
949
931
 
950
932
def parent_directories(filename):
951
933
    """Return the list of parent directories, deepest first.
952
 
    
 
934
 
953
935
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
954
936
    """
955
937
    parents = []
979
961
    # NB: This docstring is just an example, not a doctest, because doctest
980
962
    # currently can't cope with the use of lazy imports in this namespace --
981
963
    # mbp 20090729
982
 
    
 
964
 
983
965
    # This currently doesn't report the failure at the time it occurs, because
984
966
    # they tend to happen very early in startup when we can't check config
985
967
    # files etc, and also we want to report all failures but not spam the user
1055
1037
 
1056
1038
 
1057
1039
def delete_any(path):
1058
 
    """Delete a file, symlink or directory.  
1059
 
    
 
1040
    """Delete a file, symlink or directory.
 
1041
 
1060
1042
    Will delete even if readonly.
1061
1043
    """
1062
1044
    try:
1251
1233
    # but for now, we haven't optimized...
1252
1234
    return [canonical_relpath(base, p) for p in paths]
1253
1235
 
 
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
 
1254
1252
def safe_unicode(unicode_or_utf8_string):
1255
1253
    """Coerce unicode_or_utf8_string into unicode.
1256
1254
 
1339
1337
def normalizes_filenames():
1340
1338
    """Return True if this platform normalizes unicode filenames.
1341
1339
 
1342
 
    Mac OSX does, Windows/Linux do not.
 
1340
    Only Mac OSX.
1343
1341
    """
1344
1342
    return _platform_normalizes_filenames
1345
1343
 
1350
1348
    On platforms where the system normalizes filenames (Mac OSX),
1351
1349
    you can access a file by any path which will normalize correctly.
1352
1350
    On platforms where the system does not normalize filenames
1353
 
    (Windows, Linux), you have to access a file by its exact path.
 
1351
    (everything else), you have to access a file by its exact path.
1354
1352
 
1355
1353
    Internally, bzr only supports NFC normalization, since that is
1356
1354
    the standard for XML documents.
1418
1416
terminal_width() returns None.
1419
1417
"""
1420
1418
 
 
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
1421
1425
 
1422
1426
def terminal_width():
1423
1427
    """Return terminal width.
1427
1431
    The rules are:
1428
1432
    - if BZR_COLUMNS is set, returns its value
1429
1433
    - 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,
1430
1436
    - if COLUMNS is set, returns its value,
 
1437
    - if the OS has a value (even though it's never changed), return its value.
1431
1438
 
1432
1439
    From there, we need to query the OS to get the size of the controlling
1433
1440
    terminal.
1434
1441
 
1435
 
    Unices:
 
1442
    On Unices we query the OS by:
1436
1443
    - get termios.TIOCGWINSZ
1437
1444
    - if an error occurs or a negative value is obtained, returns None
1438
1445
 
1439
 
    Windows:
1440
 
    
 
1446
    On Windows we query the OS by:
1441
1447
    - win32utils.get_console_size() decides,
1442
1448
    - returns None on error (provided default value)
1443
1449
    """
 
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.
1444
1462
 
1445
1463
    # If BZR_COLUMNS is set, take it, user is always right
1446
1464
    try:
1449
1467
        pass
1450
1468
 
1451
1469
    isatty = getattr(sys.stdout, 'isatty', None)
1452
 
    if  isatty is None or not isatty():
 
1470
    if isatty is None or not isatty():
1453
1471
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1454
1472
        return None
1455
1473
 
1456
 
    # If COLUMNS is set, take it, the terminal knows better (even inside a
1457
 
    # given terminal, the application can decide to set COLUMNS to a lower
1458
 
    # value (splitted screen) or a bigger value (scroll bars))
 
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.
1459
1491
    try:
1460
1492
        return int(os.environ['COLUMNS'])
1461
1493
    except (KeyError, ValueError):
1462
1494
        pass
1463
1495
 
1464
 
    width, height = _terminal_size(None, None)
1465
 
    if width <= 0:
1466
 
        # Consider invalid values as meaning no width
1467
 
        return None
 
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
1468
1500
 
1469
 
    return width
 
1501
    # The width could not be determined.
 
1502
    return None
1470
1503
 
1471
1504
 
1472
1505
def _win32_terminal_size(width, height):
1499
1532
    _terminal_size = _ioctl_terminal_size
1500
1533
 
1501
1534
 
1502
 
def _terminal_size_changed(signum, frame):
1503
 
    """Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
1504
 
    width, height = _terminal_size(None, None)
1505
 
    if width is not None:
1506
 
        os.environ['COLUMNS'] = str(width)
1507
 
 
1508
 
 
1509
 
_registered_sigwinch = False
1510
 
def watch_sigwinch():
1511
 
    """Register for SIGWINCH, once and only once.
1512
 
 
1513
 
    Do nothing if the signal module is not available.
1514
 
    """
1515
 
    global _registered_sigwinch
1516
 
    if not _registered_sigwinch:
1517
 
        try:
1518
 
            import signal
1519
 
            if getattr(signal, "SIGWINCH", None) is not None:
1520
 
                set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
1521
 
        except ImportError:
1522
 
            # python doesn't provide signal support, nothing we can do about it
1523
 
            pass
1524
 
        _registered_sigwinch = True
1525
 
 
1526
 
 
1527
1535
def supports_executable():
1528
1536
    return sys.platform != "win32"
1529
1537
 
1652
1660
        dirblock = []
1653
1661
        append = dirblock.append
1654
1662
        try:
1655
 
            names = sorted(_listdir(top))
 
1663
            names = sorted(map(decode_filename, _listdir(top)))
1656
1664
        except OSError, e:
1657
1665
            if not _is_error_enotdir(e):
1658
1666
                raise
1960
1968
    return user_encoding
1961
1969
 
1962
1970
 
 
1971
def get_diff_header_encoding():
 
1972
    return get_terminal_encoding()
 
1973
 
 
1974
 
1963
1975
def get_host_name():
1964
1976
    """Return the current unicode host name.
1965
1977
 
2028
2040
 
2029
2041
def send_all(sock, bytes, report_activity=None):
2030
2042
    """Send all bytes on a socket.
2031
 
 
 
2043
 
2032
2044
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2033
2045
    some platforms, and catches EINTR which may be thrown if the send is
2034
2046
    interrupted by a signal.
2035
2047
 
2036
2048
    This is preferred to socket.sendall(), because it avoids portability bugs
2037
2049
    and provides activity reporting.
2038
 
 
 
2050
 
2039
2051
    :param report_activity: Call this as bytes are read, see
2040
2052
        Transport._report_activity
2041
2053
    """
2096
2108
    base = dirname(bzrlib.__file__)
2097
2109
    if getattr(sys, 'frozen', None):    # bzr.exe
2098
2110
        base = abspath(pathjoin(base, '..', '..'))
2099
 
    filename = pathjoin(base, resource_relpath)
2100
 
    return open(filename, 'rU').read()
2101
 
 
 
2111
    f = file(pathjoin(base, resource_relpath), "rU")
 
2112
    try:
 
2113
        return f.read()
 
2114
    finally:
 
2115
        f.close()
2102
2116
 
2103
2117
def file_kind_from_stat_mode_thunk(mode):
2104
2118
    global file_kind_from_stat_mode
2127
2141
 
2128
2142
def until_no_eintr(f, *a, **kw):
2129
2143
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2130
 
    
 
2144
 
2131
2145
    WARNING: you must be certain that it is safe to retry the call repeatedly
2132
2146
    if EINTR does occur.  This is typically only true for low-level operations
2133
2147
    like os.read.  If in any doubt, don't use this.
2264
2278
if sys.platform == 'win32':
2265
2279
    def open_file(filename, mode='r', bufsize=-1):
2266
2280
        """This function is used to override the ``open`` builtin.
2267
 
        
 
2281
 
2268
2282
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2269
2283
        child processes.  Deleting or renaming a closed file opened with this
2270
2284
        function is not blocking child processes.