← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

(jameinel) Allow 'bzr serve' to interpret SIGHUP as a graceful shutdown.
 (bug #795025) (John A Meinel)

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 (
49
44
    cache_utf8,
 
45
    config,
50
46
    errors,
51
47
    trace,
52
48
    win32utils,
53
49
    )
 
50
from bzrlib.i18n import gettext
54
51
""")
55
52
 
56
53
from bzrlib.symbol_versioning import (
58
55
    deprecated_in,
59
56
    )
60
57
 
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
 
        )
 
58
from hashlib import (
 
59
    md5,
 
60
    sha1 as sha,
 
61
    )
73
62
 
74
63
 
75
64
import bzrlib
101
90
        user_encoding = get_user_encoding()
102
91
        return [a.decode(user_encoding) for a in sys.argv[1:]]
103
92
    except UnicodeDecodeError:
104
 
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
105
 
                                                            "encoding." % a))
 
93
        raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
 
94
            "application locale.").format(a, user_encoding))
106
95
 
107
96
 
108
97
def make_readonly(filename):
202
191
            if e.errno == errno.ENOENT:
203
192
                return False;
204
193
            else:
205
 
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
 
194
                raise errors.BzrError(gettext("lstat/stat of ({0!r}): {1!r}").format(f, e))
206
195
 
207
196
 
208
197
def fancy_rename(old, new, rename_func, unlink_func):
274
263
            else:
275
264
                rename_func(tmp_name, new)
276
265
    if failure_exc is not None:
277
 
        raise failure_exc[0], failure_exc[1], failure_exc[2]
 
266
        try:
 
267
            raise failure_exc[0], failure_exc[1], failure_exc[2]
 
268
        finally:
 
269
            del failure_exc
278
270
 
279
271
 
280
272
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
303
295
    running python.exe under cmd.exe return capital C:\\
304
296
    running win32 python inside a cygwin shell returns lowercase c:\\
305
297
    """
306
 
    drive, path = _nt_splitdrive(path)
 
298
    drive, path = ntpath.splitdrive(path)
307
299
    return drive.upper() + path
308
300
 
309
301
 
310
302
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('\\', '/'))
 
303
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
 
304
    return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
313
305
 
314
306
 
315
307
def _win98_abspath(path):
326
318
    #   /path       => C:/path
327
319
    path = unicode(path)
328
320
    # check for absolute path
329
 
    drive = _nt_splitdrive(path)[0]
 
321
    drive = ntpath.splitdrive(path)[0]
330
322
    if drive == '' and path[:2] not in('//','\\\\'):
331
323
        cwd = os.getcwdu()
332
324
        # we cannot simply os.path.join cwd and path
333
325
        # because os.path.join('C:','/path') produce '/path'
334
326
        # and this is incorrect
335
327
        if path[:1] in ('/','\\'):
336
 
            cwd = _nt_splitdrive(cwd)[0]
 
328
            cwd = ntpath.splitdrive(cwd)[0]
337
329
            path = path[1:]
338
330
        path = cwd + '\\' + path
339
 
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
 
331
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
340
332
 
341
333
 
342
334
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('\\', '/'))
 
335
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
 
336
    return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
345
337
 
346
338
 
347
339
def _win32_pathjoin(*args):
348
 
    return _nt_join(*args).replace('\\', '/')
 
340
    return ntpath.join(*args).replace('\\', '/')
349
341
 
350
342
 
351
343
def _win32_normpath(path):
352
 
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
344
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
353
345
 
354
346
 
355
347
def _win32_getcwd():
360
352
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
361
353
 
362
354
 
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
355
def _win32_rename(old, new):
372
356
    """We expect to be able to atomically replace 'new' with old.
373
357
 
375
359
    and then deleted.
376
360
    """
377
361
    try:
378
 
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
 
362
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
379
363
    except OSError, e:
380
364
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
381
365
            # If we try to rename a non-existant file onto cwd, we get
386
370
        raise
387
371
 
388
372
 
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
373
def _mac_getcwd():
400
374
    return unicodedata.normalize('NFC', os.getcwdu())
401
375
 
406
380
realpath = _posix_realpath
407
381
pathjoin = os.path.join
408
382
normpath = os.path.normpath
409
 
rename = _wrapped_rename # overridden below on win32
410
383
getcwd = os.getcwdu
 
384
rename = os.rename
411
385
dirname = os.path.dirname
412
386
basename = os.path.basename
413
387
split = os.path.split
414
388
splitext = os.path.splitext
415
 
# These were already imported into local scope
 
389
# These were already lazily imported into local scope
416
390
# mkdtemp = tempfile.mkdtemp
417
391
# rmtree = shutil.rmtree
 
392
lstat = os.lstat
 
393
fstat = os.fstat
 
394
 
 
395
def wrap_stat(st):
 
396
    return st
 
397
 
418
398
 
419
399
MIN_ABS_PATHLENGTH = 1
420
400
 
430
410
    getcwd = _win32_getcwd
431
411
    mkdtemp = _win32_mkdtemp
432
412
    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
433
421
 
434
422
    MIN_ABS_PATHLENGTH = 3
435
423
 
458
446
    getcwd = _mac_getcwd
459
447
 
460
448
 
461
 
def get_terminal_encoding():
 
449
def get_terminal_encoding(trace=False):
462
450
    """Find the best encoding for printing to the screen.
463
451
 
464
452
    This attempts to check both sys.stdout and sys.stdin to see
470
458
 
471
459
    On my standard US Windows XP, the preferred encoding is
472
460
    cp1252, but the console is cp437
 
461
 
 
462
    :param trace: If True trace the selected encoding via mutter().
473
463
    """
474
464
    from bzrlib.trace import mutter
475
465
    output_encoding = getattr(sys.stdout, 'encoding', None)
477
467
        input_encoding = getattr(sys.stdin, 'encoding', None)
478
468
        if not input_encoding:
479
469
            output_encoding = get_user_encoding()
480
 
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
470
            if trace:
 
471
                mutter('encoding stdout as osutils.get_user_encoding() %r',
481
472
                   output_encoding)
482
473
        else:
483
474
            output_encoding = input_encoding
484
 
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
475
            if trace:
 
476
                mutter('encoding stdout as sys.stdin encoding %r',
 
477
                    output_encoding)
485
478
    else:
486
 
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
479
        if trace:
 
480
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
487
481
    if output_encoding == 'cp0':
488
482
        # invalid encoding (cp0 means 'no codepage' on Windows)
489
483
        output_encoding = get_user_encoding()
490
 
        mutter('cp0 is invalid encoding.'
 
484
        if trace:
 
485
            mutter('cp0 is invalid encoding.'
491
486
               ' encoding stdout as osutils.get_user_encoding() %r',
492
487
               output_encoding)
493
488
    # check encoding
519
514
def isdir(f):
520
515
    """True if f is an accessible directory."""
521
516
    try:
522
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
517
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
523
518
    except OSError:
524
519
        return False
525
520
 
527
522
def isfile(f):
528
523
    """True if f is a regular file."""
529
524
    try:
530
 
        return S_ISREG(os.lstat(f)[ST_MODE])
 
525
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
531
526
    except OSError:
532
527
        return False
533
528
 
534
529
def islink(f):
535
530
    """True if f is a symlink."""
536
531
    try:
537
 
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
532
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
538
533
    except OSError:
539
534
        return False
540
535
 
880
875
 
881
876
def filesize(f):
882
877
    """Return size of given open file."""
883
 
    return os.fstat(f.fileno())[ST_SIZE]
 
878
    return os.fstat(f.fileno())[stat.ST_SIZE]
884
879
 
885
880
 
886
881
# Define rand_bytes based on platform.
931
926
    rps = []
932
927
    for f in ps:
933
928
        if f == '..':
934
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
929
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
935
930
        elif (f == '.') or (f == ''):
936
931
            pass
937
932
        else:
942
937
def joinpath(p):
943
938
    for f in p:
944
939
        if (f == '..') or (f is None) or (f == ''):
945
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
940
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
946
941
    return pathjoin(*p)
947
942
 
948
943
 
949
944
def parent_directories(filename):
950
945
    """Return the list of parent directories, deepest first.
951
 
    
 
946
 
952
947
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
953
948
    """
954
949
    parents = []
978
973
    # NB: This docstring is just an example, not a doctest, because doctest
979
974
    # currently can't cope with the use of lazy imports in this namespace --
980
975
    # mbp 20090729
981
 
    
 
976
 
982
977
    # This currently doesn't report the failure at the time it occurs, because
983
978
    # they tend to happen very early in startup when we can't check config
984
979
    # files etc, and also we want to report all failures but not spam the user
985
980
    # with 10 warnings.
986
 
    from bzrlib import trace
987
981
    exception_str = str(exception)
988
982
    if exception_str not in _extension_load_failures:
989
983
        trace.mutter("failed to load compiled extension: %s" % exception_str)
993
987
def report_extension_load_failures():
994
988
    if not _extension_load_failures:
995
989
        return
996
 
    from bzrlib.config import GlobalConfig
997
 
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
 
990
    if config.GlobalStack().get('ignore_missing_extensions'):
998
991
        return
999
992
    # the warnings framework should by default show this only once
1000
993
    from bzrlib.trace import warning
1054
1047
 
1055
1048
 
1056
1049
def delete_any(path):
1057
 
    """Delete a file, symlink or directory.  
1058
 
    
 
1050
    """Delete a file, symlink or directory.
 
1051
 
1059
1052
    Will delete even if readonly.
1060
1053
    """
1061
1054
    try:
1162
1155
 
1163
1156
    if len(base) < MIN_ABS_PATHLENGTH:
1164
1157
        # must have space for e.g. a drive letter
1165
 
        raise ValueError('%r is too short to calculate a relative path'
 
1158
        raise ValueError(gettext('%r is too short to calculate a relative path')
1166
1159
            % (base,))
1167
1160
 
1168
1161
    rp = abspath(path)
1250
1243
    # but for now, we haven't optimized...
1251
1244
    return [canonical_relpath(base, p) for p in paths]
1252
1245
 
 
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
 
1253
1262
def safe_unicode(unicode_or_utf8_string):
1254
1263
    """Coerce unicode_or_utf8_string into unicode.
1255
1264
 
1338
1347
def normalizes_filenames():
1339
1348
    """Return True if this platform normalizes unicode filenames.
1340
1349
 
1341
 
    Mac OSX does, Windows/Linux do not.
 
1350
    Only Mac OSX.
1342
1351
    """
1343
1352
    return _platform_normalizes_filenames
1344
1353
 
1349
1358
    On platforms where the system normalizes filenames (Mac OSX),
1350
1359
    you can access a file by any path which will normalize correctly.
1351
1360
    On platforms where the system does not normalize filenames
1352
 
    (Windows, Linux), you have to access a file by its exact path.
 
1361
    (everything else), you have to access a file by its exact path.
1353
1362
 
1354
1363
    Internally, bzr only supports NFC normalization, since that is
1355
1364
    the standard for XML documents.
1417
1426
terminal_width() returns None.
1418
1427
"""
1419
1428
 
 
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
1420
1435
 
1421
1436
def terminal_width():
1422
1437
    """Return terminal width.
1426
1441
    The rules are:
1427
1442
    - if BZR_COLUMNS is set, returns its value
1428
1443
    - 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,
1429
1446
    - if COLUMNS is set, returns its value,
 
1447
    - if the OS has a value (even though it's never changed), return its value.
1430
1448
 
1431
1449
    From there, we need to query the OS to get the size of the controlling
1432
1450
    terminal.
1433
1451
 
1434
 
    Unices:
 
1452
    On Unices we query the OS by:
1435
1453
    - get termios.TIOCGWINSZ
1436
1454
    - if an error occurs or a negative value is obtained, returns None
1437
1455
 
1438
 
    Windows:
1439
 
    
 
1456
    On Windows we query the OS by:
1440
1457
    - win32utils.get_console_size() decides,
1441
1458
    - returns None on error (provided default value)
1442
1459
    """
 
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.
1443
1472
 
1444
1473
    # If BZR_COLUMNS is set, take it, user is always right
 
1474
    # Except if they specified 0 in which case, impose no limit here
1445
1475
    try:
1446
 
        return int(os.environ['BZR_COLUMNS'])
 
1476
        width = int(os.environ['BZR_COLUMNS'])
1447
1477
    except (KeyError, ValueError):
1448
 
        pass
 
1478
        width = None
 
1479
    if width is not None:
 
1480
        if width > 0:
 
1481
            return width
 
1482
        else:
 
1483
            return None
1449
1484
 
1450
1485
    isatty = getattr(sys.stdout, 'isatty', None)
1451
 
    if  isatty is None or not isatty():
 
1486
    if isatty is None or not isatty():
1452
1487
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1453
1488
        return None
1454
1489
 
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))
 
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.
1458
1507
    try:
1459
1508
        return int(os.environ['COLUMNS'])
1460
1509
    except (KeyError, ValueError):
1461
1510
        pass
1462
1511
 
1463
 
    width, height = _terminal_size(None, None)
1464
 
    if width <= 0:
1465
 
        # Consider invalid values as meaning no width
1466
 
        return None
 
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
1467
1516
 
1468
 
    return width
 
1517
    # The width could not be determined.
 
1518
    return None
1469
1519
 
1470
1520
 
1471
1521
def _win32_terminal_size(width, height):
1498
1548
    _terminal_size = _ioctl_terminal_size
1499
1549
 
1500
1550
 
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
1551
def supports_executable():
1527
1552
    return sys.platform != "win32"
1528
1553
 
1651
1676
        dirblock = []
1652
1677
        append = dirblock.append
1653
1678
        try:
1654
 
            names = sorted(_listdir(top))
 
1679
            names = sorted(map(decode_filename, _listdir(top)))
1655
1680
        except OSError, e:
1656
1681
            if not _is_error_enotdir(e):
1657
1682
                raise
1865
1890
        s = os.stat(src)
1866
1891
        chown(dst, s.st_uid, s.st_gid)
1867
1892
    except OSError, e:
1868
 
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, 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()
1869
1897
 
1870
1898
 
1871
1899
def path_prefix_key(path):
1959
1987
    return user_encoding
1960
1988
 
1961
1989
 
 
1990
def get_diff_header_encoding():
 
1991
    return get_terminal_encoding()
 
1992
 
 
1993
 
1962
1994
def get_host_name():
1963
1995
    """Return the current unicode host name.
1964
1996
 
1979
2011
# data at once.
1980
2012
MAX_SOCKET_CHUNK = 64 * 1024
1981
2013
 
 
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
 
1982
2022
def read_bytes_from_socket(sock, report_activity=None,
1983
2023
        max_read_size=MAX_SOCKET_CHUNK):
1984
2024
    """Read up to max_read_size of bytes from sock and notify of progress.
1992
2032
            bytes = sock.recv(max_read_size)
1993
2033
        except socket.error, e:
1994
2034
            eno = e.args[0]
1995
 
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
 
2035
            if eno in _end_of_stream_errors:
1996
2036
                # The connection was closed by the other side.  Callers expect
1997
2037
                # an empty string to signal end-of-stream.
1998
2038
                return ""
2027
2067
 
2028
2068
def send_all(sock, bytes, report_activity=None):
2029
2069
    """Send all bytes on a socket.
2030
 
 
 
2070
 
2031
2071
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2032
2072
    some platforms, and catches EINTR which may be thrown if the send is
2033
2073
    interrupted by a signal.
2034
2074
 
2035
2075
    This is preferred to socket.sendall(), because it avoids portability bugs
2036
2076
    and provides activity reporting.
2037
 
 
 
2077
 
2038
2078
    :param report_activity: Call this as bytes are read, see
2039
2079
        Transport._report_activity
2040
2080
    """
2051
2091
            report_activity(sent, 'write')
2052
2092
 
2053
2093
 
 
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
 
2054
2117
def dereference_path(path):
2055
2118
    """Determine the real path to a file.
2056
2119
 
2095
2158
    base = dirname(bzrlib.__file__)
2096
2159
    if getattr(sys, 'frozen', None):    # bzr.exe
2097
2160
        base = abspath(pathjoin(base, '..', '..'))
2098
 
    filename = pathjoin(base, resource_relpath)
2099
 
    return open(filename, 'rU').read()
2100
 
 
 
2161
    f = file(pathjoin(base, resource_relpath), "rU")
 
2162
    try:
 
2163
        return f.read()
 
2164
    finally:
 
2165
        f.close()
2101
2166
 
2102
2167
def file_kind_from_stat_mode_thunk(mode):
2103
2168
    global file_kind_from_stat_mode
2114
2179
    return file_kind_from_stat_mode(mode)
2115
2180
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2116
2181
 
2117
 
 
2118
 
def file_kind(f, _lstat=os.lstat):
 
2182
def file_stat(f, _lstat=os.lstat):
2119
2183
    try:
2120
 
        return file_kind_from_stat_mode(_lstat(f).st_mode)
 
2184
        # XXX cache?
 
2185
        return _lstat(f)
2121
2186
    except OSError, e:
2122
2187
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2123
2188
            raise errors.NoSuchFile(f)
2124
2189
        raise
2125
2190
 
 
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)
2126
2194
 
2127
2195
def until_no_eintr(f, *a, **kw):
2128
2196
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2129
 
    
 
2197
 
2130
2198
    WARNING: you must be certain that it is safe to retry the call repeatedly
2131
2199
    if EINTR does occur.  This is typically only true for low-level operations
2132
2200
    like os.read.  If in any doubt, don't use this.
2147
2215
            raise
2148
2216
 
2149
2217
 
 
2218
@deprecated_function(deprecated_in((2, 2, 0)))
2150
2219
def re_compile_checked(re_string, flags=0, where=""):
2151
2220
    """Return a compiled re, or raise a sensible error.
2152
2221
 
2162
2231
        re_obj = re.compile(re_string, flags)
2163
2232
        re_obj.search("")
2164
2233
        return re_obj
2165
 
    except re.error, e:
 
2234
    except errors.InvalidPattern, e:
2166
2235
        if where:
2167
2236
            where = ' in ' + where
2168
2237
        # despite the name 'error' is a type
2169
 
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2170
 
            % (where, re_string, e))
 
2238
        raise errors.BzrCommandError('Invalid regular expression%s: %s'
 
2239
            % (where, e.msg))
2171
2240
 
2172
2241
 
2173
2242
if sys.platform == "win32":
2187
2256
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2188
2257
        return ch
2189
2258
 
2190
 
 
2191
 
if sys.platform == 'linux2':
 
2259
if sys.platform.startswith('linux'):
2192
2260
    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
 
2261
        try:
 
2262
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2263
        except (ValueError, OSError, AttributeError):
 
2264
            return None
2199
2265
elif sys.platform == 'darwin':
2200
2266
    def _local_concurrency():
2201
2267
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2202
2268
                                stdout=subprocess.PIPE).communicate()[0]
2203
 
elif sys.platform[0:7] == 'freebsd':
 
2269
elif "bsd" in sys.platform:
2204
2270
    def _local_concurrency():
2205
2271
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2206
2272
                                stdout=subprocess.PIPE).communicate()[0]
2234
2300
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2235
2301
    if concurrency is None:
2236
2302
        try:
2237
 
            concurrency = _local_concurrency()
2238
 
        except (OSError, IOError):
2239
 
            pass
 
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()
2240
2312
    try:
2241
2313
        concurrency = int(concurrency)
2242
2314
    except (TypeError, ValueError):
2263
2335
if sys.platform == 'win32':
2264
2336
    def open_file(filename, mode='r', bufsize=-1):
2265
2337
        """This function is used to override the ``open`` builtin.
2266
 
        
 
2338
 
2267
2339
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2268
2340
        child processes.  Deleting or renaming a closed file opened with this
2269
2341
        function is not blocking child processes.
2302
2374
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2303
2375
else:
2304
2376
    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)