/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-04-08 04:34:03 UTC
  • mfrom: (5138 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5139.
  • Revision ID: robertc@robertcollins.net-20100408043403-56z0d07vdqrx7f3t
Update bugfix for 528114 to trunk.

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
21
 
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
 
20
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
 
21
                  S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
22
22
import sys
23
23
import time
24
24
import codecs
 
25
import warnings
25
26
 
26
27
from bzrlib.lazy_import import lazy_import
27
28
lazy_import(globals(), """
28
29
from datetime import datetime
29
 
import getpass
 
30
import errno
30
31
from ntpath import (abspath as _nt_abspath,
31
32
                    join as _nt_join,
32
33
                    normpath as _nt_normpath,
38
39
from shutil import (
39
40
    rmtree,
40
41
    )
 
42
import signal
41
43
import socket
42
44
import subprocess
43
45
import tempfile
1130
1132
 
1131
1133
 
1132
1134
def relpath(base, path):
1133
 
    """Return path relative to base, or raise PathNotChild exception.
 
1135
    """Return path relative to base, or raise exception.
1134
1136
 
1135
1137
    The path may be either an absolute path or a path relative to the
1136
1138
    current working directory.
1138
1140
    os.path.commonprefix (python2.4) has a bad bug that it works just
1139
1141
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
1140
1142
    avoids that problem.
1141
 
 
1142
 
    NOTE: `base` should not have a trailing slash otherwise you'll get
1143
 
    PathNotChild exceptions regardless of `path`.
1144
1143
    """
1145
1144
 
1146
1145
    if len(base) < MIN_ABS_PATHLENGTH:
1366
1365
        False)`).  May be ignored if the feature is not available on this
1367
1366
        platform or Python version.
1368
1367
    """
1369
 
    try:
1370
 
        import signal
1371
 
        siginterrupt = signal.siginterrupt
1372
 
    except ImportError:
1373
 
        # This python implementation doesn't provide signal support, hence no
1374
 
        # handler exists
1375
 
        return None
1376
 
    except AttributeError:
1377
 
        # siginterrupt doesn't exist on this platform, or for this version
1378
 
        # of Python.
1379
 
        siginterrupt = lambda signum, flag: None
 
1368
    old_handler = signal.signal(signum, handler)
1380
1369
    if restart_syscall:
1381
 
        def sig_handler(*args):
1382
 
            # Python resets the siginterrupt flag when a signal is
1383
 
            # received.  <http://bugs.python.org/issue8354>
1384
 
            # As a workaround for some cases, set it back the way we want it.
 
1370
        try:
 
1371
            siginterrupt = signal.siginterrupt
 
1372
        except AttributeError: # siginterrupt doesn't exist on this platform, or for this version of
 
1373
            # Python.
 
1374
            pass
 
1375
        else:
1385
1376
            siginterrupt(signum, False)
1386
 
            # Now run the handler function passed to set_signal_handler.
1387
 
            handler(*args)
1388
 
    else:
1389
 
        sig_handler = handler
1390
 
    old_handler = signal.signal(signum, sig_handler)
1391
 
    if restart_syscall:
1392
 
        siginterrupt(signum, False)
1393
1377
    return old_handler
1394
1378
 
1395
1379
 
1400
1384
terminal_width() returns None.
1401
1385
"""
1402
1386
 
1403
 
# Keep some state so that terminal_width can detect if _terminal_size has
1404
 
# returned a different size since the process started.  See docstring and
1405
 
# comments of terminal_width for details.
1406
 
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
1407
 
_terminal_size_state = 'no_data'
1408
 
_first_terminal_size = None
1409
1387
 
1410
1388
def terminal_width():
1411
1389
    """Return terminal width.
1415
1393
    The rules are:
1416
1394
    - if BZR_COLUMNS is set, returns its value
1417
1395
    - if there is no controlling terminal, returns None
1418
 
    - query the OS, if the queried size has changed since the last query,
1419
 
      return its value,
1420
1396
    - if COLUMNS is set, returns its value,
1421
 
    - if the OS has a value (even though it's never changed), return its value.
1422
1397
 
1423
1398
    From there, we need to query the OS to get the size of the controlling
1424
1399
    terminal.
1425
1400
 
1426
 
    On Unices we query the OS by:
 
1401
    Unices:
1427
1402
    - get termios.TIOCGWINSZ
1428
1403
    - if an error occurs or a negative value is obtained, returns None
1429
1404
 
1430
 
    On Windows we query the OS by:
 
1405
    Windows:
 
1406
    
1431
1407
    - win32utils.get_console_size() decides,
1432
1408
    - returns None on error (provided default value)
1433
1409
    """
1434
 
    # Note to implementors: if changing the rules for determining the width,
1435
 
    # make sure you've considered the behaviour in these cases:
1436
 
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1437
 
    #  - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1438
 
    #    0,0.
1439
 
    #  - (add more interesting cases here, if you find any)
1440
 
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1441
 
    # but we don't want to register a signal handler because it is impossible
1442
 
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
1443
 
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
1444
 
    # time so we can notice if the reported size has changed, which should have
1445
 
    # a similar effect.
1446
1410
 
1447
1411
    # If BZR_COLUMNS is set, take it, user is always right
1448
1412
    try:
1451
1415
        pass
1452
1416
 
1453
1417
    isatty = getattr(sys.stdout, 'isatty', None)
1454
 
    if isatty is None or not isatty():
 
1418
    if  isatty is None or not isatty():
1455
1419
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1456
1420
        return None
1457
1421
 
1458
 
    # Query the OS
1459
 
    width, height = os_size = _terminal_size(None, None)
1460
 
    global _first_terminal_size, _terminal_size_state
1461
 
    if _terminal_size_state == 'no_data':
1462
 
        _first_terminal_size = os_size
1463
 
        _terminal_size_state = 'unchanged'
1464
 
    elif (_terminal_size_state == 'unchanged' and
1465
 
          _first_terminal_size != os_size):
1466
 
        _terminal_size_state = 'changed'
1467
 
 
1468
 
    # If the OS claims to know how wide the terminal is, and this value has
1469
 
    # ever changed, use that.
1470
 
    if _terminal_size_state == 'changed':
1471
 
        if width is not None and width > 0:
1472
 
            return width
1473
 
 
1474
 
    # If COLUMNS is set, use it.
 
1422
    # If COLUMNS is set, take it, the terminal knows better (even inside a
 
1423
    # given terminal, the application can decide to set COLUMNS to a lower
 
1424
    # value (splitted screen) or a bigger value (scroll bars))
1475
1425
    try:
1476
1426
        return int(os.environ['COLUMNS'])
1477
1427
    except (KeyError, ValueError):
1478
1428
        pass
1479
1429
 
1480
 
    # Finally, use an unchanged size from the OS, if we have one.
1481
 
    if _terminal_size_state == 'unchanged':
1482
 
        if width is not None and width > 0:
1483
 
            return width
 
1430
    width, height = _terminal_size(None, None)
 
1431
    if width <= 0:
 
1432
        # Consider invalid values as meaning no width
 
1433
        return None
1484
1434
 
1485
 
    # The width could not be determined.
1486
 
    return None
 
1435
    return width
1487
1436
 
1488
1437
 
1489
1438
def _win32_terminal_size(width, height):
1516
1465
    _terminal_size = _ioctl_terminal_size
1517
1466
 
1518
1467
 
 
1468
def _terminal_size_changed(signum, frame):
 
1469
    """Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
 
1470
    width, height = _terminal_size(None, None)
 
1471
    if width is not None:
 
1472
        os.environ['COLUMNS'] = str(width)
 
1473
 
 
1474
 
 
1475
_registered_sigwinch = False
 
1476
 
 
1477
def watch_sigwinch():
 
1478
    """Register for SIGWINCH, once and only once."""
 
1479
    global _registered_sigwinch
 
1480
    if not _registered_sigwinch:
 
1481
        if sys.platform == 'win32':
 
1482
            # Martin (gz) mentioned WINDOW_BUFFER_SIZE_RECORD from
 
1483
            # ReadConsoleInput but I've no idea how to plug that in
 
1484
            # the current design -- vila 20091216
 
1485
            pass
 
1486
        else:
 
1487
            set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
 
1488
        _registered_sigwinch = True
 
1489
 
 
1490
 
1519
1491
def supports_executable():
1520
1492
    return sys.platform != "win32"
1521
1493
 
1839
1811
            real_handlers[kind](abspath, relpath)
1840
1812
 
1841
1813
 
1842
 
def copy_ownership_from_path(dst, src=None):
 
1814
def copy_ownership(dst, src=None):
1843
1815
    """Copy usr/grp ownership from src file/dir to dst file/dir.
1844
1816
 
1845
1817
    If src is None, the containing directory is used as source. If chown
1861
1833
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
1862
1834
 
1863
1835
 
 
1836
def mkdir_with_ownership(path, ownership_src=None):
 
1837
    """Create the directory 'path' with specified ownership.
 
1838
 
 
1839
    If ownership_src is given, copies (chown) usr/grp ownership
 
1840
    from 'ownership_src' to 'path'. If ownership_src is None, use the
 
1841
    containing dir ownership.
 
1842
    """
 
1843
    os.mkdir(path)
 
1844
    copy_ownership(path, ownership_src)
 
1845
 
 
1846
 
 
1847
def open_with_ownership(filename, mode='r', bufsize=-1, ownership_src=None):
 
1848
    """Open the file 'filename' with the specified ownership.
 
1849
 
 
1850
    If ownership_src is specified, copy usr/grp ownership from ownership_src
 
1851
    to filename. If ownership_src is None, copy ownership from containing
 
1852
    directory.
 
1853
    Returns the opened file object.
 
1854
    """
 
1855
    f = open(filename, mode, bufsize)
 
1856
    copy_ownership(filename, ownership_src)
 
1857
    return f
 
1858
 
 
1859
 
1864
1860
def path_prefix_key(path):
1865
1861
    """Generate a prefix-order path key for path.
1866
1862
 
2088
2084
    base = dirname(bzrlib.__file__)
2089
2085
    if getattr(sys, 'frozen', None):    # bzr.exe
2090
2086
        base = abspath(pathjoin(base, '..', '..'))
2091
 
    f = file(pathjoin(base, resource_relpath), "rU")
2092
 
    try:
2093
 
        return f.read()
2094
 
    finally:
2095
 
        f.close()
 
2087
    filename = pathjoin(base, resource_relpath)
 
2088
    return open(filename, 'rU').read()
 
2089
 
2096
2090
 
2097
2091
def file_kind_from_stat_mode_thunk(mode):
2098
2092
    global file_kind_from_stat_mode
2297
2291
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2298
2292
else:
2299
2293
    open_file = open
2300
 
 
2301
 
 
2302
 
def getuser_unicode():
2303
 
    """Return the username as unicode.
2304
 
    """
2305
 
    try:
2306
 
        user_encoding = get_user_encoding()
2307
 
        username = getpass.getuser().decode(user_encoding)
2308
 
    except UnicodeDecodeError:
2309
 
        raise errors.BzrError("Can't decode username as %s." % \
2310
 
                user_encoding)
2311
 
    return username