← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Vincent Ladeuil
  • Date: 2011-10-06 09:20:02 UTC
  • mto: This revision was merged to the branch mainline in revision 6195.
  • Revision ID: v.ladeuil+lp@free.fr-20111006092002-5s63tmvqter71tlc
Open trunk again as 2.5dev3

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
287
279
    # copy posixpath.abspath, but use os.getcwdu instead
288
280
    if not posixpath.isabs(path):
289
281
        path = posixpath.join(getcwd(), path)
290
 
    return posixpath.normpath(path)
 
282
    return _posix_normpath(path)
291
283
 
292
284
 
293
285
def _posix_realpath(path):
294
286
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
295
287
 
296
288
 
 
289
def _posix_normpath(path):
 
290
    path = posixpath.normpath(path)
 
291
    # Bug 861008: posixpath.normpath() returns a path normalized according to
 
292
    # the POSIX standard, which stipulates (for compatibility reasons) that two
 
293
    # leading slashes must not be simplified to one, and only if there are 3 or
 
294
    # more should they be simplified as one. So we treat the leading 2 slashes
 
295
    # as a special case here by simply removing the first slash, as we consider
 
296
    # that breaking POSIX compatibility for this obscure feature is acceptable.
 
297
    # This is not a paranoid precaution, as we notably get paths like this when
 
298
    # the repo is hosted at the root of the filesystem, i.e. in "/".    
 
299
    if path.startswith('//'):
 
300
        path = path[1:]
 
301
    return path
 
302
 
 
303
 
297
304
def _win32_fixdrive(path):
298
305
    """Force drive letters to be consistent.
299
306
 
303
310
    running python.exe under cmd.exe return capital C:\\
304
311
    running win32 python inside a cygwin shell returns lowercase c:\\
305
312
    """
306
 
    drive, path = _nt_splitdrive(path)
 
313
    drive, path = ntpath.splitdrive(path)
307
314
    return drive.upper() + path
308
315
 
309
316
 
310
317
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('\\', '/'))
 
318
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
 
319
    return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
313
320
 
314
321
 
315
322
def _win98_abspath(path):
326
333
    #   /path       => C:/path
327
334
    path = unicode(path)
328
335
    # check for absolute path
329
 
    drive = _nt_splitdrive(path)[0]
 
336
    drive = ntpath.splitdrive(path)[0]
330
337
    if drive == '' and path[:2] not in('//','\\\\'):
331
338
        cwd = os.getcwdu()
332
339
        # we cannot simply os.path.join cwd and path
333
340
        # because os.path.join('C:','/path') produce '/path'
334
341
        # and this is incorrect
335
342
        if path[:1] in ('/','\\'):
336
 
            cwd = _nt_splitdrive(cwd)[0]
 
343
            cwd = ntpath.splitdrive(cwd)[0]
337
344
            path = path[1:]
338
345
        path = cwd + '\\' + path
339
 
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
 
346
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
340
347
 
341
348
 
342
349
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('\\', '/'))
 
350
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
 
351
    return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
345
352
 
346
353
 
347
354
def _win32_pathjoin(*args):
348
 
    return _nt_join(*args).replace('\\', '/')
 
355
    return ntpath.join(*args).replace('\\', '/')
349
356
 
350
357
 
351
358
def _win32_normpath(path):
352
 
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
359
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
353
360
 
354
361
 
355
362
def _win32_getcwd():
360
367
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
361
368
 
362
369
 
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
370
def _win32_rename(old, new):
372
371
    """We expect to be able to atomically replace 'new' with old.
373
372
 
375
374
    and then deleted.
376
375
    """
377
376
    try:
378
 
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
 
377
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
379
378
    except OSError, e:
380
379
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
381
380
            # If we try to rename a non-existant file onto cwd, we get
386
385
        raise
387
386
 
388
387
 
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
388
def _mac_getcwd():
400
389
    return unicodedata.normalize('NFC', os.getcwdu())
401
390
 
405
394
abspath = _posix_abspath
406
395
realpath = _posix_realpath
407
396
pathjoin = os.path.join
408
 
normpath = os.path.normpath
409
 
rename = _wrapped_rename # overridden below on win32
 
397
normpath = _posix_normpath
410
398
getcwd = os.getcwdu
 
399
rename = os.rename
411
400
dirname = os.path.dirname
412
401
basename = os.path.basename
413
402
split = os.path.split
414
403
splitext = os.path.splitext
415
 
# These were already imported into local scope
 
404
# These were already lazily imported into local scope
416
405
# mkdtemp = tempfile.mkdtemp
417
406
# rmtree = shutil.rmtree
 
407
lstat = os.lstat
 
408
fstat = os.fstat
 
409
 
 
410
def wrap_stat(st):
 
411
    return st
 
412
 
418
413
 
419
414
MIN_ABS_PATHLENGTH = 1
420
415
 
430
425
    getcwd = _win32_getcwd
431
426
    mkdtemp = _win32_mkdtemp
432
427
    rename = _win32_rename
 
428
    try:
 
429
        from bzrlib import _walkdirs_win32
 
430
    except ImportError:
 
431
        pass
 
432
    else:
 
433
        lstat = _walkdirs_win32.lstat
 
434
        fstat = _walkdirs_win32.fstat
 
435
        wrap_stat = _walkdirs_win32.wrap_stat
433
436
 
434
437
    MIN_ABS_PATHLENGTH = 3
435
438
 
458
461
    getcwd = _mac_getcwd
459
462
 
460
463
 
461
 
def get_terminal_encoding():
 
464
def get_terminal_encoding(trace=False):
462
465
    """Find the best encoding for printing to the screen.
463
466
 
464
467
    This attempts to check both sys.stdout and sys.stdin to see
470
473
 
471
474
    On my standard US Windows XP, the preferred encoding is
472
475
    cp1252, but the console is cp437
 
476
 
 
477
    :param trace: If True trace the selected encoding via mutter().
473
478
    """
474
479
    from bzrlib.trace import mutter
475
480
    output_encoding = getattr(sys.stdout, 'encoding', None)
477
482
        input_encoding = getattr(sys.stdin, 'encoding', None)
478
483
        if not input_encoding:
479
484
            output_encoding = get_user_encoding()
480
 
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
485
            if trace:
 
486
                mutter('encoding stdout as osutils.get_user_encoding() %r',
481
487
                   output_encoding)
482
488
        else:
483
489
            output_encoding = input_encoding
484
 
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
490
            if trace:
 
491
                mutter('encoding stdout as sys.stdin encoding %r',
 
492
                    output_encoding)
485
493
    else:
486
 
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
494
        if trace:
 
495
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
487
496
    if output_encoding == 'cp0':
488
497
        # invalid encoding (cp0 means 'no codepage' on Windows)
489
498
        output_encoding = get_user_encoding()
490
 
        mutter('cp0 is invalid encoding.'
 
499
        if trace:
 
500
            mutter('cp0 is invalid encoding.'
491
501
               ' encoding stdout as osutils.get_user_encoding() %r',
492
502
               output_encoding)
493
503
    # check encoding
519
529
def isdir(f):
520
530
    """True if f is an accessible directory."""
521
531
    try:
522
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
532
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
523
533
    except OSError:
524
534
        return False
525
535
 
527
537
def isfile(f):
528
538
    """True if f is a regular file."""
529
539
    try:
530
 
        return S_ISREG(os.lstat(f)[ST_MODE])
 
540
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
531
541
    except OSError:
532
542
        return False
533
543
 
534
544
def islink(f):
535
545
    """True if f is a symlink."""
536
546
    try:
537
 
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
547
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
538
548
    except OSError:
539
549
        return False
540
550
 
880
890
 
881
891
def filesize(f):
882
892
    """Return size of given open file."""
883
 
    return os.fstat(f.fileno())[ST_SIZE]
 
893
    return os.fstat(f.fileno())[stat.ST_SIZE]
884
894
 
885
895
 
886
896
# Define rand_bytes based on platform.
931
941
    rps = []
932
942
    for f in ps:
933
943
        if f == '..':
934
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
944
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
935
945
        elif (f == '.') or (f == ''):
936
946
            pass
937
947
        else:
942
952
def joinpath(p):
943
953
    for f in p:
944
954
        if (f == '..') or (f is None) or (f == ''):
945
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
955
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
946
956
    return pathjoin(*p)
947
957
 
948
958
 
949
959
def parent_directories(filename):
950
960
    """Return the list of parent directories, deepest first.
951
 
    
 
961
 
952
962
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
953
963
    """
954
964
    parents = []
978
988
    # NB: This docstring is just an example, not a doctest, because doctest
979
989
    # currently can't cope with the use of lazy imports in this namespace --
980
990
    # mbp 20090729
981
 
    
 
991
 
982
992
    # This currently doesn't report the failure at the time it occurs, because
983
993
    # they tend to happen very early in startup when we can't check config
984
994
    # files etc, and also we want to report all failures but not spam the user
985
995
    # with 10 warnings.
986
 
    from bzrlib import trace
987
996
    exception_str = str(exception)
988
997
    if exception_str not in _extension_load_failures:
989
998
        trace.mutter("failed to load compiled extension: %s" % exception_str)
993
1002
def report_extension_load_failures():
994
1003
    if not _extension_load_failures:
995
1004
        return
996
 
    from bzrlib.config import GlobalConfig
997
 
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
 
1005
    if config.GlobalStack().get('ignore_missing_extensions'):
998
1006
        return
999
1007
    # the warnings framework should by default show this only once
1000
1008
    from bzrlib.trace import warning
1054
1062
 
1055
1063
 
1056
1064
def delete_any(path):
1057
 
    """Delete a file, symlink or directory.  
1058
 
    
 
1065
    """Delete a file, symlink or directory.
 
1066
 
1059
1067
    Will delete even if readonly.
1060
1068
    """
1061
1069
    try:
1162
1170
 
1163
1171
    if len(base) < MIN_ABS_PATHLENGTH:
1164
1172
        # must have space for e.g. a drive letter
1165
 
        raise ValueError('%r is too short to calculate a relative path'
 
1173
        raise ValueError(gettext('%r is too short to calculate a relative path')
1166
1174
            % (base,))
1167
1175
 
1168
1176
    rp = abspath(path)
1250
1258
    # but for now, we haven't optimized...
1251
1259
    return [canonical_relpath(base, p) for p in paths]
1252
1260
 
 
1261
 
 
1262
def decode_filename(filename):
 
1263
    """Decode the filename using the filesystem encoding
 
1264
 
 
1265
    If it is unicode, it is returned.
 
1266
    Otherwise it is decoded from the the filesystem's encoding. If decoding
 
1267
    fails, a errors.BadFilenameEncoding exception is raised.
 
1268
    """
 
1269
    if type(filename) is unicode:
 
1270
        return filename
 
1271
    try:
 
1272
        return filename.decode(_fs_enc)
 
1273
    except UnicodeDecodeError:
 
1274
        raise errors.BadFilenameEncoding(filename, _fs_enc)
 
1275
 
 
1276
 
1253
1277
def safe_unicode(unicode_or_utf8_string):
1254
1278
    """Coerce unicode_or_utf8_string into unicode.
1255
1279
 
1338
1362
def normalizes_filenames():
1339
1363
    """Return True if this platform normalizes unicode filenames.
1340
1364
 
1341
 
    Mac OSX does, Windows/Linux do not.
 
1365
    Only Mac OSX.
1342
1366
    """
1343
1367
    return _platform_normalizes_filenames
1344
1368
 
1349
1373
    On platforms where the system normalizes filenames (Mac OSX),
1350
1374
    you can access a file by any path which will normalize correctly.
1351
1375
    On platforms where the system does not normalize filenames
1352
 
    (Windows, Linux), you have to access a file by its exact path.
 
1376
    (everything else), you have to access a file by its exact path.
1353
1377
 
1354
1378
    Internally, bzr only supports NFC normalization, since that is
1355
1379
    the standard for XML documents.
1417
1441
terminal_width() returns None.
1418
1442
"""
1419
1443
 
 
1444
# Keep some state so that terminal_width can detect if _terminal_size has
 
1445
# returned a different size since the process started.  See docstring and
 
1446
# comments of terminal_width for details.
 
1447
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
 
1448
_terminal_size_state = 'no_data'
 
1449
_first_terminal_size = None
1420
1450
 
1421
1451
def terminal_width():
1422
1452
    """Return terminal width.
1426
1456
    The rules are:
1427
1457
    - if BZR_COLUMNS is set, returns its value
1428
1458
    - if there is no controlling terminal, returns None
 
1459
    - query the OS, if the queried size has changed since the last query,
 
1460
      return its value,
1429
1461
    - if COLUMNS is set, returns its value,
 
1462
    - if the OS has a value (even though it's never changed), return its value.
1430
1463
 
1431
1464
    From there, we need to query the OS to get the size of the controlling
1432
1465
    terminal.
1433
1466
 
1434
 
    Unices:
 
1467
    On Unices we query the OS by:
1435
1468
    - get termios.TIOCGWINSZ
1436
1469
    - if an error occurs or a negative value is obtained, returns None
1437
1470
 
1438
 
    Windows:
1439
 
    
 
1471
    On Windows we query the OS by:
1440
1472
    - win32utils.get_console_size() decides,
1441
1473
    - returns None on error (provided default value)
1442
1474
    """
 
1475
    # Note to implementors: if changing the rules for determining the width,
 
1476
    # make sure you've considered the behaviour in these cases:
 
1477
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
 
1478
    #  - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
 
1479
    #    0,0.
 
1480
    #  - (add more interesting cases here, if you find any)
 
1481
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
 
1482
    # but we don't want to register a signal handler because it is impossible
 
1483
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
 
1484
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
 
1485
    # time so we can notice if the reported size has changed, which should have
 
1486
    # a similar effect.
1443
1487
 
1444
1488
    # If BZR_COLUMNS is set, take it, user is always right
 
1489
    # Except if they specified 0 in which case, impose no limit here
1445
1490
    try:
1446
 
        return int(os.environ['BZR_COLUMNS'])
 
1491
        width = int(os.environ['BZR_COLUMNS'])
1447
1492
    except (KeyError, ValueError):
1448
 
        pass
 
1493
        width = None
 
1494
    if width is not None:
 
1495
        if width > 0:
 
1496
            return width
 
1497
        else:
 
1498
            return None
1449
1499
 
1450
1500
    isatty = getattr(sys.stdout, 'isatty', None)
1451
 
    if  isatty is None or not isatty():
 
1501
    if isatty is None or not isatty():
1452
1502
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1453
1503
        return None
1454
1504
 
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))
 
1505
    # Query the OS
 
1506
    width, height = os_size = _terminal_size(None, None)
 
1507
    global _first_terminal_size, _terminal_size_state
 
1508
    if _terminal_size_state == 'no_data':
 
1509
        _first_terminal_size = os_size
 
1510
        _terminal_size_state = 'unchanged'
 
1511
    elif (_terminal_size_state == 'unchanged' and
 
1512
          _first_terminal_size != os_size):
 
1513
        _terminal_size_state = 'changed'
 
1514
 
 
1515
    # If the OS claims to know how wide the terminal is, and this value has
 
1516
    # ever changed, use that.
 
1517
    if _terminal_size_state == 'changed':
 
1518
        if width is not None and width > 0:
 
1519
            return width
 
1520
 
 
1521
    # If COLUMNS is set, use it.
1458
1522
    try:
1459
1523
        return int(os.environ['COLUMNS'])
1460
1524
    except (KeyError, ValueError):
1461
1525
        pass
1462
1526
 
1463
 
    width, height = _terminal_size(None, None)
1464
 
    if width <= 0:
1465
 
        # Consider invalid values as meaning no width
1466
 
        return None
 
1527
    # Finally, use an unchanged size from the OS, if we have one.
 
1528
    if _terminal_size_state == 'unchanged':
 
1529
        if width is not None and width > 0:
 
1530
            return width
1467
1531
 
1468
 
    return width
 
1532
    # The width could not be determined.
 
1533
    return None
1469
1534
 
1470
1535
 
1471
1536
def _win32_terminal_size(width, height):
1498
1563
    _terminal_size = _ioctl_terminal_size
1499
1564
 
1500
1565
 
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
1566
def supports_executable():
1527
1567
    return sys.platform != "win32"
1528
1568
 
1651
1691
        dirblock = []
1652
1692
        append = dirblock.append
1653
1693
        try:
1654
 
            names = sorted(_listdir(top))
 
1694
            names = sorted(map(decode_filename, _listdir(top)))
1655
1695
        except OSError, e:
1656
1696
            if not _is_error_enotdir(e):
1657
1697
                raise
1865
1905
        s = os.stat(src)
1866
1906
        chown(dst, s.st_uid, s.st_gid)
1867
1907
    except OSError, e:
1868
 
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
 
1908
        trace.warning(
 
1909
            'Unable to copy ownership from "%s" to "%s". '
 
1910
            'You may want to set it manually.', src, dst)
 
1911
        trace.log_exception_quietly()
1869
1912
 
1870
1913
 
1871
1914
def path_prefix_key(path):
1959
2002
    return user_encoding
1960
2003
 
1961
2004
 
 
2005
def get_diff_header_encoding():
 
2006
    return get_terminal_encoding()
 
2007
 
 
2008
 
1962
2009
def get_host_name():
1963
2010
    """Return the current unicode host name.
1964
2011
 
1979
2026
# data at once.
1980
2027
MAX_SOCKET_CHUNK = 64 * 1024
1981
2028
 
 
2029
_end_of_stream_errors = [errno.ECONNRESET]
 
2030
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
 
2031
    _eno = getattr(errno, _eno, None)
 
2032
    if _eno is not None:
 
2033
        _end_of_stream_errors.append(_eno)
 
2034
del _eno
 
2035
 
 
2036
 
1982
2037
def read_bytes_from_socket(sock, report_activity=None,
1983
2038
        max_read_size=MAX_SOCKET_CHUNK):
1984
2039
    """Read up to max_read_size of bytes from sock and notify of progress.
1992
2047
            bytes = sock.recv(max_read_size)
1993
2048
        except socket.error, e:
1994
2049
            eno = e.args[0]
1995
 
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
 
2050
            if eno in _end_of_stream_errors:
1996
2051
                # The connection was closed by the other side.  Callers expect
1997
2052
                # an empty string to signal end-of-stream.
1998
2053
                return ""
2027
2082
 
2028
2083
def send_all(sock, bytes, report_activity=None):
2029
2084
    """Send all bytes on a socket.
2030
 
 
 
2085
 
2031
2086
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2032
2087
    some platforms, and catches EINTR which may be thrown if the send is
2033
2088
    interrupted by a signal.
2034
2089
 
2035
2090
    This is preferred to socket.sendall(), because it avoids portability bugs
2036
2091
    and provides activity reporting.
2037
 
 
 
2092
 
2038
2093
    :param report_activity: Call this as bytes are read, see
2039
2094
        Transport._report_activity
2040
2095
    """
2051
2106
            report_activity(sent, 'write')
2052
2107
 
2053
2108
 
 
2109
def connect_socket(address):
 
2110
    # Slight variation of the socket.create_connection() function (provided by
 
2111
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
 
2112
    # provide it for previous python versions. Also, we don't use the timeout
 
2113
    # parameter (provided by the python implementation) so we don't implement
 
2114
    # it either).
 
2115
    err = socket.error('getaddrinfo returns an empty list')
 
2116
    host, port = address
 
2117
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
 
2118
        af, socktype, proto, canonname, sa = res
 
2119
        sock = None
 
2120
        try:
 
2121
            sock = socket.socket(af, socktype, proto)
 
2122
            sock.connect(sa)
 
2123
            return sock
 
2124
 
 
2125
        except socket.error, err:
 
2126
            # 'err' is now the most recent error
 
2127
            if sock is not None:
 
2128
                sock.close()
 
2129
    raise err
 
2130
 
 
2131
 
2054
2132
def dereference_path(path):
2055
2133
    """Determine the real path to a file.
2056
2134
 
2095
2173
    base = dirname(bzrlib.__file__)
2096
2174
    if getattr(sys, 'frozen', None):    # bzr.exe
2097
2175
        base = abspath(pathjoin(base, '..', '..'))
2098
 
    filename = pathjoin(base, resource_relpath)
2099
 
    return open(filename, 'rU').read()
2100
 
 
 
2176
    f = file(pathjoin(base, resource_relpath), "rU")
 
2177
    try:
 
2178
        return f.read()
 
2179
    finally:
 
2180
        f.close()
2101
2181
 
2102
2182
def file_kind_from_stat_mode_thunk(mode):
2103
2183
    global file_kind_from_stat_mode
2114
2194
    return file_kind_from_stat_mode(mode)
2115
2195
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2116
2196
 
2117
 
 
2118
 
def file_kind(f, _lstat=os.lstat):
 
2197
def file_stat(f, _lstat=os.lstat):
2119
2198
    try:
2120
 
        return file_kind_from_stat_mode(_lstat(f).st_mode)
 
2199
        # XXX cache?
 
2200
        return _lstat(f)
2121
2201
    except OSError, e:
2122
2202
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2123
2203
            raise errors.NoSuchFile(f)
2124
2204
        raise
2125
2205
 
 
2206
def file_kind(f, _lstat=os.lstat):
 
2207
    stat_value = file_stat(f, _lstat)
 
2208
    return file_kind_from_stat_mode(stat_value.st_mode)
2126
2209
 
2127
2210
def until_no_eintr(f, *a, **kw):
2128
2211
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2129
 
    
 
2212
 
2130
2213
    WARNING: you must be certain that it is safe to retry the call repeatedly
2131
2214
    if EINTR does occur.  This is typically only true for low-level operations
2132
2215
    like os.read.  If in any doubt, don't use this.
2147
2230
            raise
2148
2231
 
2149
2232
 
 
2233
@deprecated_function(deprecated_in((2, 2, 0)))
2150
2234
def re_compile_checked(re_string, flags=0, where=""):
2151
2235
    """Return a compiled re, or raise a sensible error.
2152
2236
 
2162
2246
        re_obj = re.compile(re_string, flags)
2163
2247
        re_obj.search("")
2164
2248
        return re_obj
2165
 
    except re.error, e:
 
2249
    except errors.InvalidPattern, e:
2166
2250
        if where:
2167
2251
            where = ' in ' + where
2168
2252
        # despite the name 'error' is a type
2169
 
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2170
 
            % (where, re_string, e))
 
2253
        raise errors.BzrCommandError('Invalid regular expression%s: %s'
 
2254
            % (where, e.msg))
2171
2255
 
2172
2256
 
2173
2257
if sys.platform == "win32":
2187
2271
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2188
2272
        return ch
2189
2273
 
2190
 
 
2191
 
if sys.platform == 'linux2':
 
2274
if sys.platform.startswith('linux'):
2192
2275
    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
 
2276
        try:
 
2277
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2278
        except (ValueError, OSError, AttributeError):
 
2279
            return None
2199
2280
elif sys.platform == 'darwin':
2200
2281
    def _local_concurrency():
2201
2282
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2202
2283
                                stdout=subprocess.PIPE).communicate()[0]
2203
 
elif sys.platform[0:7] == 'freebsd':
 
2284
elif "bsd" in sys.platform:
2204
2285
    def _local_concurrency():
2205
2286
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2206
2287
                                stdout=subprocess.PIPE).communicate()[0]
2234
2315
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2235
2316
    if concurrency is None:
2236
2317
        try:
2237
 
            concurrency = _local_concurrency()
2238
 
        except (OSError, IOError):
2239
 
            pass
 
2318
            import multiprocessing
 
2319
        except ImportError:
 
2320
            # multiprocessing is only available on Python >= 2.6
 
2321
            try:
 
2322
                concurrency = _local_concurrency()
 
2323
            except (OSError, IOError):
 
2324
                pass
 
2325
        else:
 
2326
            concurrency = multiprocessing.cpu_count()
2240
2327
    try:
2241
2328
        concurrency = int(concurrency)
2242
2329
    except (TypeError, ValueError):
2263
2350
if sys.platform == 'win32':
2264
2351
    def open_file(filename, mode='r', bufsize=-1):
2265
2352
        """This function is used to override the ``open`` builtin.
2266
 
        
 
2353
 
2267
2354
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2268
2355
        child processes.  Deleting or renaming a closed file opened with this
2269
2356
        function is not blocking child processes.
2302
2389
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2303
2390
else:
2304
2391
    open_file = open
 
2392
 
 
2393
 
 
2394
def getuser_unicode():
 
2395
    """Return the username as unicode.
 
2396
    """
 
2397
    try:
 
2398
        user_encoding = get_user_encoding()
 
2399
        username = getpass.getuser().decode(user_encoding)
 
2400
    except UnicodeDecodeError:
 
2401
        raise errors.BzrError("Can't decode username as %s." % \
 
2402
                user_encoding)
 
2403
    except ImportError, e:
 
2404
        if sys.platform != 'win32':
 
2405
            raise
 
2406
        if str(e) != 'No module named pwd':
 
2407
            raise
 
2408
        # https://bugs.launchpad.net/bzr/+bug/660174
 
2409
        # getpass.getuser() is unable to return username on Windows
 
2410
        # if there is no USERNAME environment variable set.
 
2411
        # That could be true if bzr is running as a service,
 
2412
        # e.g. running `bzr serve` as a service on Windows.
 
2413
        # We should not fail with traceback in this case.
 
2414
        username = u'UNKNOWN'
 
2415
    return username
 
2416
 
 
2417
 
 
2418
def available_backup_name(base, exists):
 
2419
    """Find a non-existing backup file name.
 
2420
 
 
2421
    This will *not* create anything, this only return a 'free' entry.  This
 
2422
    should be used for checking names in a directory below a locked
 
2423
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
 
2424
    Leap) and generally discouraged.
 
2425
 
 
2426
    :param base: The base name.
 
2427
 
 
2428
    :param exists: A callable returning True if the path parameter exists.
 
2429
    """
 
2430
    counter = 1
 
2431
    name = "%s.~%d~" % (base, counter)
 
2432
    while exists(name):
 
2433
        counter += 1
 
2434
        name = "%s.~%d~" % (base, counter)
 
2435
    return name
 
2436
 
 
2437
 
 
2438
def set_fd_cloexec(fd):
 
2439
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
 
2440
    support for this is not available.
 
2441
    """
 
2442
    try:
 
2443
        import fcntl
 
2444
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
 
2445
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
 
2446
    except (ImportError, AttributeError):
 
2447
        # Either the fcntl module or specific constants are not present
 
2448
        pass
 
2449
 
 
2450
 
 
2451
def find_executable_on_path(name):
 
2452
    """Finds an executable on the PATH.
 
2453
    
 
2454
    On Windows, this will try to append each extension in the PATHEXT
 
2455
    environment variable to the name, if it cannot be found with the name
 
2456
    as given.
 
2457
    
 
2458
    :param name: The base name of the executable.
 
2459
    :return: The path to the executable found or None.
 
2460
    """
 
2461
    path = os.environ.get('PATH')
 
2462
    if path is None:
 
2463
        return None
 
2464
    path = path.split(os.pathsep)
 
2465
    if sys.platform == 'win32':
 
2466
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
 
2467
        exts = [ext.lower() for ext in exts]
 
2468
        base, ext = os.path.splitext(name)
 
2469
        if ext != '':
 
2470
            if ext.lower() not in exts:
 
2471
                return None
 
2472
            name = base
 
2473
            exts = [ext]
 
2474
    else:
 
2475
        exts = ['']
 
2476
    for ext in exts:
 
2477
        for d in path:
 
2478
            f = os.path.join(d, name) + ext
 
2479
            if os.access(f, os.X_OK):
 
2480
                return f
 
2481
    return None
 
2482
 
 
2483
 
 
2484
def _posix_is_local_pid_dead(pid):
 
2485
    """True if pid doesn't correspond to live process on this machine"""
 
2486
    try:
 
2487
        # Special meaning of unix kill: just check if it's there.
 
2488
        os.kill(pid, 0)
 
2489
    except OSError, e:
 
2490
        if e.errno == errno.ESRCH:
 
2491
            # On this machine, and really not found: as sure as we can be
 
2492
            # that it's dead.
 
2493
            return True
 
2494
        elif e.errno == errno.EPERM:
 
2495
            # exists, though not ours
 
2496
            return False
 
2497
        else:
 
2498
            mutter("os.kill(%d, 0) failed: %s" % (pid, e))
 
2499
            # Don't really know.
 
2500
            return False
 
2501
    else:
 
2502
        # Exists and our process: not dead.
 
2503
        return False
 
2504
 
 
2505
if sys.platform == "win32":
 
2506
    is_local_pid_dead = win32utils.is_local_pid_dead
 
2507
else:
 
2508
    is_local_pid_dead = _posix_is_local_pid_dead
 
2509
 
 
2510
 
 
2511
def fdatasync(fileno):
 
2512
    """Flush file contents to disk if possible.
 
2513
    
 
2514
    :param fileno: Integer OS file handle.
 
2515
    :raises TransportNotPossible: If flushing to disk is not possible.
 
2516
    """
 
2517
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
 
2518
    if fn is not None:
 
2519
        fn(fileno)