/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: Samuel Bronson
  • Date: 2012-08-30 21:54:35 UTC
  • mto: (6015.57.3 2.4)
  • mto: This revision was merged to the branch mainline in revision 6558.
  • Revision ID: naesten@gmail.com-20120830215435-akw1leqrtioh4q1d
Update "Python versions" section of doc/developers/code-style.txt.

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 (
58
53
    deprecated_in,
59
54
    )
60
55
 
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
 
        )
 
56
from hashlib import (
 
57
    md5,
 
58
    sha1 as sha,
 
59
    )
73
60
 
74
61
 
75
62
import bzrlib
101
88
        user_encoding = get_user_encoding()
102
89
        return [a.decode(user_encoding) for a in sys.argv[1:]]
103
90
    except UnicodeDecodeError:
104
 
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
105
 
                                                            "encoding." % a))
 
91
        raise errors.BzrError("Parameter %r encoding is unsupported by %s "
 
92
            "application locale." % (a, user_encoding))
106
93
 
107
94
 
108
95
def make_readonly(filename):
110
97
    mod = os.lstat(filename).st_mode
111
98
    if not stat.S_ISLNK(mod):
112
99
        mod = mod & 0777555
113
 
        os.chmod(filename, mod)
 
100
        chmod_if_possible(filename, mod)
114
101
 
115
102
 
116
103
def make_writable(filename):
117
104
    mod = os.lstat(filename).st_mode
118
105
    if not stat.S_ISLNK(mod):
119
106
        mod = mod | 0200
120
 
        os.chmod(filename, mod)
 
107
        chmod_if_possible(filename, mod)
 
108
 
 
109
 
 
110
def chmod_if_possible(filename, mode):
 
111
    # Set file mode if that can be safely done.
 
112
    # Sometimes even on unix the filesystem won't allow it - see
 
113
    # https://bugs.launchpad.net/bzr/+bug/606537
 
114
    try:
 
115
        # It is probably faster to just do the chmod, rather than
 
116
        # doing a stat, and then trying to compare
 
117
        os.chmod(filename, mode)
 
118
    except (IOError, OSError),e:
 
119
        # Permission/access denied seems to commonly happen on smbfs; there's
 
120
        # probably no point warning about it.
 
121
        # <https://bugs.launchpad.net/bzr/+bug/606537>
 
122
        if getattr(e, 'errno') in (errno.EPERM, errno.EACCES):
 
123
            trace.mutter("ignore error on chmod of %r: %r" % (
 
124
                filename, e))
 
125
            return
 
126
        raise
121
127
 
122
128
 
123
129
def minimum_path_selection(paths):
274
280
            else:
275
281
                rename_func(tmp_name, new)
276
282
    if failure_exc is not None:
277
 
        raise failure_exc[0], failure_exc[1], failure_exc[2]
 
283
        try:
 
284
            raise failure_exc[0], failure_exc[1], failure_exc[2]
 
285
        finally:
 
286
            del failure_exc
278
287
 
279
288
 
280
289
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
287
296
    # copy posixpath.abspath, but use os.getcwdu instead
288
297
    if not posixpath.isabs(path):
289
298
        path = posixpath.join(getcwd(), path)
290
 
    return posixpath.normpath(path)
 
299
    return _posix_normpath(path)
291
300
 
292
301
 
293
302
def _posix_realpath(path):
294
303
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
295
304
 
296
305
 
 
306
def _posix_normpath(path):
 
307
    path = posixpath.normpath(path)
 
308
    # Bug 861008: posixpath.normpath() returns a path normalized according to
 
309
    # the POSIX standard, which stipulates (for compatibility reasons) that two
 
310
    # leading slashes must not be simplified to one, and only if there are 3 or
 
311
    # more should they be simplified as one. So we treat the leading 2 slashes
 
312
    # as a special case here by simply removing the first slash, as we consider
 
313
    # that breaking POSIX compatibility for this obscure feature is acceptable.
 
314
    # This is not a paranoid precaution, as we notably get paths like this when
 
315
    # the repo is hosted at the root of the filesystem, i.e. in "/".    
 
316
    if path.startswith('//'):
 
317
        path = path[1:]
 
318
    return path
 
319
 
 
320
 
297
321
def _win32_fixdrive(path):
298
322
    """Force drive letters to be consistent.
299
323
 
303
327
    running python.exe under cmd.exe return capital C:\\
304
328
    running win32 python inside a cygwin shell returns lowercase c:\\
305
329
    """
306
 
    drive, path = _nt_splitdrive(path)
 
330
    drive, path = ntpath.splitdrive(path)
307
331
    return drive.upper() + path
308
332
 
309
333
 
310
334
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('\\', '/'))
 
335
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
 
336
    return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
313
337
 
314
338
 
315
339
def _win98_abspath(path):
326
350
    #   /path       => C:/path
327
351
    path = unicode(path)
328
352
    # check for absolute path
329
 
    drive = _nt_splitdrive(path)[0]
 
353
    drive = ntpath.splitdrive(path)[0]
330
354
    if drive == '' and path[:2] not in('//','\\\\'):
331
355
        cwd = os.getcwdu()
332
356
        # we cannot simply os.path.join cwd and path
333
357
        # because os.path.join('C:','/path') produce '/path'
334
358
        # and this is incorrect
335
359
        if path[:1] in ('/','\\'):
336
 
            cwd = _nt_splitdrive(cwd)[0]
 
360
            cwd = ntpath.splitdrive(cwd)[0]
337
361
            path = path[1:]
338
362
        path = cwd + '\\' + path
339
 
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
 
363
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
340
364
 
341
365
 
342
366
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('\\', '/'))
 
367
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
 
368
    return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
345
369
 
346
370
 
347
371
def _win32_pathjoin(*args):
348
 
    return _nt_join(*args).replace('\\', '/')
 
372
    return ntpath.join(*args).replace('\\', '/')
349
373
 
350
374
 
351
375
def _win32_normpath(path):
352
 
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
376
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
353
377
 
354
378
 
355
379
def _win32_getcwd():
360
384
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
361
385
 
362
386
 
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
387
def _win32_rename(old, new):
372
388
    """We expect to be able to atomically replace 'new' with old.
373
389
 
375
391
    and then deleted.
376
392
    """
377
393
    try:
378
 
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
 
394
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
379
395
    except OSError, e:
380
396
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
381
397
            # If we try to rename a non-existant file onto cwd, we get
386
402
        raise
387
403
 
388
404
 
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
405
def _mac_getcwd():
400
406
    return unicodedata.normalize('NFC', os.getcwdu())
401
407
 
405
411
abspath = _posix_abspath
406
412
realpath = _posix_realpath
407
413
pathjoin = os.path.join
408
 
normpath = os.path.normpath
409
 
rename = _wrapped_rename # overridden below on win32
 
414
normpath = _posix_normpath
410
415
getcwd = os.getcwdu
 
416
rename = os.rename
411
417
dirname = os.path.dirname
412
418
basename = os.path.basename
413
419
split = os.path.split
414
420
splitext = os.path.splitext
415
 
# These were already imported into local scope
 
421
# These were already lazily imported into local scope
416
422
# mkdtemp = tempfile.mkdtemp
417
423
# rmtree = shutil.rmtree
 
424
lstat = os.lstat
 
425
fstat = os.fstat
 
426
 
 
427
def wrap_stat(st):
 
428
    return st
 
429
 
418
430
 
419
431
MIN_ABS_PATHLENGTH = 1
420
432
 
430
442
    getcwd = _win32_getcwd
431
443
    mkdtemp = _win32_mkdtemp
432
444
    rename = _win32_rename
 
445
    try:
 
446
        from bzrlib import _walkdirs_win32
 
447
    except ImportError:
 
448
        pass
 
449
    else:
 
450
        lstat = _walkdirs_win32.lstat
 
451
        fstat = _walkdirs_win32.fstat
 
452
        wrap_stat = _walkdirs_win32.wrap_stat
433
453
 
434
454
    MIN_ABS_PATHLENGTH = 3
435
455
 
458
478
    getcwd = _mac_getcwd
459
479
 
460
480
 
461
 
def get_terminal_encoding():
 
481
def get_terminal_encoding(trace=False):
462
482
    """Find the best encoding for printing to the screen.
463
483
 
464
484
    This attempts to check both sys.stdout and sys.stdin to see
470
490
 
471
491
    On my standard US Windows XP, the preferred encoding is
472
492
    cp1252, but the console is cp437
 
493
 
 
494
    :param trace: If True trace the selected encoding via mutter().
473
495
    """
474
496
    from bzrlib.trace import mutter
475
497
    output_encoding = getattr(sys.stdout, 'encoding', None)
477
499
        input_encoding = getattr(sys.stdin, 'encoding', None)
478
500
        if not input_encoding:
479
501
            output_encoding = get_user_encoding()
480
 
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
502
            if trace:
 
503
                mutter('encoding stdout as osutils.get_user_encoding() %r',
481
504
                   output_encoding)
482
505
        else:
483
506
            output_encoding = input_encoding
484
 
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
507
            if trace:
 
508
                mutter('encoding stdout as sys.stdin encoding %r',
 
509
                    output_encoding)
485
510
    else:
486
 
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
511
        if trace:
 
512
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
487
513
    if output_encoding == 'cp0':
488
514
        # invalid encoding (cp0 means 'no codepage' on Windows)
489
515
        output_encoding = get_user_encoding()
490
 
        mutter('cp0 is invalid encoding.'
 
516
        if trace:
 
517
            mutter('cp0 is invalid encoding.'
491
518
               ' encoding stdout as osutils.get_user_encoding() %r',
492
519
               output_encoding)
493
520
    # check encoding
519
546
def isdir(f):
520
547
    """True if f is an accessible directory."""
521
548
    try:
522
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
549
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
523
550
    except OSError:
524
551
        return False
525
552
 
527
554
def isfile(f):
528
555
    """True if f is a regular file."""
529
556
    try:
530
 
        return S_ISREG(os.lstat(f)[ST_MODE])
 
557
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
531
558
    except OSError:
532
559
        return False
533
560
 
534
561
def islink(f):
535
562
    """True if f is a symlink."""
536
563
    try:
537
 
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
564
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
538
565
    except OSError:
539
566
        return False
540
567
 
880
907
 
881
908
def filesize(f):
882
909
    """Return size of given open file."""
883
 
    return os.fstat(f.fileno())[ST_SIZE]
 
910
    return os.fstat(f.fileno())[stat.ST_SIZE]
884
911
 
885
912
 
886
913
# Define rand_bytes based on platform.
948
975
 
949
976
def parent_directories(filename):
950
977
    """Return the list of parent directories, deepest first.
951
 
    
 
978
 
952
979
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
953
980
    """
954
981
    parents = []
978
1005
    # NB: This docstring is just an example, not a doctest, because doctest
979
1006
    # currently can't cope with the use of lazy imports in this namespace --
980
1007
    # mbp 20090729
981
 
    
 
1008
 
982
1009
    # This currently doesn't report the failure at the time it occurs, because
983
1010
    # they tend to happen very early in startup when we can't check config
984
1011
    # files etc, and also we want to report all failures but not spam the user
985
1012
    # with 10 warnings.
986
 
    from bzrlib import trace
987
1013
    exception_str = str(exception)
988
1014
    if exception_str not in _extension_load_failures:
989
1015
        trace.mutter("failed to load compiled extension: %s" % exception_str)
1054
1080
 
1055
1081
 
1056
1082
def delete_any(path):
1057
 
    """Delete a file, symlink or directory.  
1058
 
    
 
1083
    """Delete a file, symlink or directory.
 
1084
 
1059
1085
    Will delete even if readonly.
1060
1086
    """
1061
1087
    try:
1250
1276
    # but for now, we haven't optimized...
1251
1277
    return [canonical_relpath(base, p) for p in paths]
1252
1278
 
 
1279
 
 
1280
def decode_filename(filename):
 
1281
    """Decode the filename using the filesystem encoding
 
1282
 
 
1283
    If it is unicode, it is returned.
 
1284
    Otherwise it is decoded from the the filesystem's encoding. If decoding
 
1285
    fails, a errors.BadFilenameEncoding exception is raised.
 
1286
    """
 
1287
    if type(filename) is unicode:
 
1288
        return filename
 
1289
    try:
 
1290
        return filename.decode(_fs_enc)
 
1291
    except UnicodeDecodeError:
 
1292
        raise errors.BadFilenameEncoding(filename, _fs_enc)
 
1293
 
 
1294
 
1253
1295
def safe_unicode(unicode_or_utf8_string):
1254
1296
    """Coerce unicode_or_utf8_string into unicode.
1255
1297
 
1338
1380
def normalizes_filenames():
1339
1381
    """Return True if this platform normalizes unicode filenames.
1340
1382
 
1341
 
    Mac OSX does, Windows/Linux do not.
 
1383
    Only Mac OSX.
1342
1384
    """
1343
1385
    return _platform_normalizes_filenames
1344
1386
 
1349
1391
    On platforms where the system normalizes filenames (Mac OSX),
1350
1392
    you can access a file by any path which will normalize correctly.
1351
1393
    On platforms where the system does not normalize filenames
1352
 
    (Windows, Linux), you have to access a file by its exact path.
 
1394
    (everything else), you have to access a file by its exact path.
1353
1395
 
1354
1396
    Internally, bzr only supports NFC normalization, since that is
1355
1397
    the standard for XML documents.
1417
1459
terminal_width() returns None.
1418
1460
"""
1419
1461
 
 
1462
# Keep some state so that terminal_width can detect if _terminal_size has
 
1463
# returned a different size since the process started.  See docstring and
 
1464
# comments of terminal_width for details.
 
1465
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
 
1466
_terminal_size_state = 'no_data'
 
1467
_first_terminal_size = None
1420
1468
 
1421
1469
def terminal_width():
1422
1470
    """Return terminal width.
1426
1474
    The rules are:
1427
1475
    - if BZR_COLUMNS is set, returns its value
1428
1476
    - if there is no controlling terminal, returns None
 
1477
    - query the OS, if the queried size has changed since the last query,
 
1478
      return its value,
1429
1479
    - if COLUMNS is set, returns its value,
 
1480
    - if the OS has a value (even though it's never changed), return its value.
1430
1481
 
1431
1482
    From there, we need to query the OS to get the size of the controlling
1432
1483
    terminal.
1433
1484
 
1434
 
    Unices:
 
1485
    On Unices we query the OS by:
1435
1486
    - get termios.TIOCGWINSZ
1436
1487
    - if an error occurs or a negative value is obtained, returns None
1437
1488
 
1438
 
    Windows:
1439
 
    
 
1489
    On Windows we query the OS by:
1440
1490
    - win32utils.get_console_size() decides,
1441
1491
    - returns None on error (provided default value)
1442
1492
    """
 
1493
    # Note to implementors: if changing the rules for determining the width,
 
1494
    # make sure you've considered the behaviour in these cases:
 
1495
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
 
1496
    #  - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
 
1497
    #    0,0.
 
1498
    #  - (add more interesting cases here, if you find any)
 
1499
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
 
1500
    # but we don't want to register a signal handler because it is impossible
 
1501
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
 
1502
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
 
1503
    # time so we can notice if the reported size has changed, which should have
 
1504
    # a similar effect.
1443
1505
 
1444
1506
    # If BZR_COLUMNS is set, take it, user is always right
 
1507
    # Except if they specified 0 in which case, impose no limit here
1445
1508
    try:
1446
 
        return int(os.environ['BZR_COLUMNS'])
 
1509
        width = int(os.environ['BZR_COLUMNS'])
1447
1510
    except (KeyError, ValueError):
1448
 
        pass
 
1511
        width = None
 
1512
    if width is not None:
 
1513
        if width > 0:
 
1514
            return width
 
1515
        else:
 
1516
            return None
1449
1517
 
1450
1518
    isatty = getattr(sys.stdout, 'isatty', None)
1451
 
    if  isatty is None or not isatty():
 
1519
    if isatty is None or not isatty():
1452
1520
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1453
1521
        return None
1454
1522
 
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))
 
1523
    # Query the OS
 
1524
    width, height = os_size = _terminal_size(None, None)
 
1525
    global _first_terminal_size, _terminal_size_state
 
1526
    if _terminal_size_state == 'no_data':
 
1527
        _first_terminal_size = os_size
 
1528
        _terminal_size_state = 'unchanged'
 
1529
    elif (_terminal_size_state == 'unchanged' and
 
1530
          _first_terminal_size != os_size):
 
1531
        _terminal_size_state = 'changed'
 
1532
 
 
1533
    # If the OS claims to know how wide the terminal is, and this value has
 
1534
    # ever changed, use that.
 
1535
    if _terminal_size_state == 'changed':
 
1536
        if width is not None and width > 0:
 
1537
            return width
 
1538
 
 
1539
    # If COLUMNS is set, use it.
1458
1540
    try:
1459
1541
        return int(os.environ['COLUMNS'])
1460
1542
    except (KeyError, ValueError):
1461
1543
        pass
1462
1544
 
1463
 
    width, height = _terminal_size(None, None)
1464
 
    if width <= 0:
1465
 
        # Consider invalid values as meaning no width
1466
 
        return None
 
1545
    # Finally, use an unchanged size from the OS, if we have one.
 
1546
    if _terminal_size_state == 'unchanged':
 
1547
        if width is not None and width > 0:
 
1548
            return width
1467
1549
 
1468
 
    return width
 
1550
    # The width could not be determined.
 
1551
    return None
1469
1552
 
1470
1553
 
1471
1554
def _win32_terminal_size(width, height):
1498
1581
    _terminal_size = _ioctl_terminal_size
1499
1582
 
1500
1583
 
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
1584
def supports_executable():
1527
1585
    return sys.platform != "win32"
1528
1586
 
1651
1709
        dirblock = []
1652
1710
        append = dirblock.append
1653
1711
        try:
1654
 
            names = sorted(_listdir(top))
 
1712
            names = sorted(map(decode_filename, _listdir(top)))
1655
1713
        except OSError, e:
1656
1714
            if not _is_error_enotdir(e):
1657
1715
                raise
1865
1923
        s = os.stat(src)
1866
1924
        chown(dst, s.st_uid, s.st_gid)
1867
1925
    except OSError, e:
1868
 
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
 
1926
        trace.warning(
 
1927
            'Unable to copy ownership from "%s" to "%s". '
 
1928
            'You may want to set it manually.', src, dst)
 
1929
        trace.log_exception_quietly()
1869
1930
 
1870
1931
 
1871
1932
def path_prefix_key(path):
1959
2020
    return user_encoding
1960
2021
 
1961
2022
 
 
2023
def get_diff_header_encoding():
 
2024
    return get_terminal_encoding()
 
2025
 
 
2026
 
1962
2027
def get_host_name():
1963
2028
    """Return the current unicode host name.
1964
2029
 
1979
2044
# data at once.
1980
2045
MAX_SOCKET_CHUNK = 64 * 1024
1981
2046
 
 
2047
_end_of_stream_errors = [errno.ECONNRESET]
 
2048
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
 
2049
    _eno = getattr(errno, _eno, None)
 
2050
    if _eno is not None:
 
2051
        _end_of_stream_errors.append(_eno)
 
2052
del _eno
 
2053
 
 
2054
 
1982
2055
def read_bytes_from_socket(sock, report_activity=None,
1983
2056
        max_read_size=MAX_SOCKET_CHUNK):
1984
2057
    """Read up to max_read_size of bytes from sock and notify of progress.
1992
2065
            bytes = sock.recv(max_read_size)
1993
2066
        except socket.error, e:
1994
2067
            eno = e.args[0]
1995
 
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
 
2068
            if eno in _end_of_stream_errors:
1996
2069
                # The connection was closed by the other side.  Callers expect
1997
2070
                # an empty string to signal end-of-stream.
1998
2071
                return ""
2027
2100
 
2028
2101
def send_all(sock, bytes, report_activity=None):
2029
2102
    """Send all bytes on a socket.
2030
 
 
 
2103
 
2031
2104
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2032
2105
    some platforms, and catches EINTR which may be thrown if the send is
2033
2106
    interrupted by a signal.
2034
2107
 
2035
2108
    This is preferred to socket.sendall(), because it avoids portability bugs
2036
2109
    and provides activity reporting.
2037
 
 
 
2110
 
2038
2111
    :param report_activity: Call this as bytes are read, see
2039
2112
        Transport._report_activity
2040
2113
    """
2051
2124
            report_activity(sent, 'write')
2052
2125
 
2053
2126
 
 
2127
def connect_socket(address):
 
2128
    # Slight variation of the socket.create_connection() function (provided by
 
2129
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
 
2130
    # provide it for previous python versions. Also, we don't use the timeout
 
2131
    # parameter (provided by the python implementation) so we don't implement
 
2132
    # it either).
 
2133
    err = socket.error('getaddrinfo returns an empty list')
 
2134
    host, port = address
 
2135
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
 
2136
        af, socktype, proto, canonname, sa = res
 
2137
        sock = None
 
2138
        try:
 
2139
            sock = socket.socket(af, socktype, proto)
 
2140
            sock.connect(sa)
 
2141
            return sock
 
2142
 
 
2143
        except socket.error, err:
 
2144
            # 'err' is now the most recent error
 
2145
            if sock is not None:
 
2146
                sock.close()
 
2147
    raise err
 
2148
 
 
2149
 
2054
2150
def dereference_path(path):
2055
2151
    """Determine the real path to a file.
2056
2152
 
2095
2191
    base = dirname(bzrlib.__file__)
2096
2192
    if getattr(sys, 'frozen', None):    # bzr.exe
2097
2193
        base = abspath(pathjoin(base, '..', '..'))
2098
 
    filename = pathjoin(base, resource_relpath)
2099
 
    return open(filename, 'rU').read()
2100
 
 
 
2194
    f = file(pathjoin(base, resource_relpath), "rU")
 
2195
    try:
 
2196
        return f.read()
 
2197
    finally:
 
2198
        f.close()
2101
2199
 
2102
2200
def file_kind_from_stat_mode_thunk(mode):
2103
2201
    global file_kind_from_stat_mode
2126
2224
 
2127
2225
def until_no_eintr(f, *a, **kw):
2128
2226
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2129
 
    
 
2227
 
2130
2228
    WARNING: you must be certain that it is safe to retry the call repeatedly
2131
2229
    if EINTR does occur.  This is typically only true for low-level operations
2132
2230
    like os.read.  If in any doubt, don't use this.
2147
2245
            raise
2148
2246
 
2149
2247
 
 
2248
@deprecated_function(deprecated_in((2, 2, 0)))
2150
2249
def re_compile_checked(re_string, flags=0, where=""):
2151
2250
    """Return a compiled re, or raise a sensible error.
2152
2251
 
2162
2261
        re_obj = re.compile(re_string, flags)
2163
2262
        re_obj.search("")
2164
2263
        return re_obj
2165
 
    except re.error, e:
 
2264
    except errors.InvalidPattern, e:
2166
2265
        if where:
2167
2266
            where = ' in ' + where
2168
2267
        # despite the name 'error' is a type
2169
 
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2170
 
            % (where, re_string, e))
 
2268
        raise errors.BzrCommandError('Invalid regular expression%s: %s'
 
2269
            % (where, e.msg))
2171
2270
 
2172
2271
 
2173
2272
if sys.platform == "win32":
2187
2286
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2188
2287
        return ch
2189
2288
 
2190
 
 
2191
2289
if sys.platform == 'linux2':
2192
2290
    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
 
2291
        try:
 
2292
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2293
        except (ValueError, OSError, AttributeError):
 
2294
            return None
2199
2295
elif sys.platform == 'darwin':
2200
2296
    def _local_concurrency():
2201
2297
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2202
2298
                                stdout=subprocess.PIPE).communicate()[0]
2203
 
elif sys.platform[0:7] == 'freebsd':
 
2299
elif "bsd" in sys.platform:
2204
2300
    def _local_concurrency():
2205
2301
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2206
2302
                                stdout=subprocess.PIPE).communicate()[0]
2234
2330
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2235
2331
    if concurrency is None:
2236
2332
        try:
2237
 
            concurrency = _local_concurrency()
2238
 
        except (OSError, IOError):
2239
 
            pass
 
2333
            import multiprocessing
 
2334
        except ImportError:
 
2335
            # multiprocessing is only available on Python >= 2.6
 
2336
            try:
 
2337
                concurrency = _local_concurrency()
 
2338
            except (OSError, IOError):
 
2339
                pass
 
2340
        else:
 
2341
            concurrency = multiprocessing.cpu_count()
2240
2342
    try:
2241
2343
        concurrency = int(concurrency)
2242
2344
    except (TypeError, ValueError):
2263
2365
if sys.platform == 'win32':
2264
2366
    def open_file(filename, mode='r', bufsize=-1):
2265
2367
        """This function is used to override the ``open`` builtin.
2266
 
        
 
2368
 
2267
2369
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2268
2370
        child processes.  Deleting or renaming a closed file opened with this
2269
2371
        function is not blocking child processes.
2302
2404
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2303
2405
else:
2304
2406
    open_file = open
 
2407
 
 
2408
 
 
2409
def getuser_unicode():
 
2410
    """Return the username as unicode.
 
2411
    """
 
2412
    try:
 
2413
        user_encoding = get_user_encoding()
 
2414
        username = getpass.getuser().decode(user_encoding)
 
2415
    except UnicodeDecodeError:
 
2416
        raise errors.BzrError("Can't decode username as %s." % \
 
2417
                user_encoding)
 
2418
    except ImportError, e:
 
2419
        if sys.platform != 'win32':
 
2420
            raise
 
2421
        if str(e) != 'No module named pwd':
 
2422
            raise
 
2423
        # https://bugs.launchpad.net/bzr/+bug/660174
 
2424
        # getpass.getuser() is unable to return username on Windows
 
2425
        # if there is no USERNAME environment variable set.
 
2426
        # That could be true if bzr is running as a service,
 
2427
        # e.g. running `bzr serve` as a service on Windows.
 
2428
        # We should not fail with traceback in this case.
 
2429
        username = u'UNKNOWN'
 
2430
    return username
 
2431
 
 
2432
 
 
2433
def available_backup_name(base, exists):
 
2434
    """Find a non-existing backup file name.
 
2435
 
 
2436
    This will *not* create anything, this only return a 'free' entry.  This
 
2437
    should be used for checking names in a directory below a locked
 
2438
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
 
2439
    Leap) and generally discouraged.
 
2440
 
 
2441
    :param base: The base name.
 
2442
 
 
2443
    :param exists: A callable returning True if the path parameter exists.
 
2444
    """
 
2445
    counter = 1
 
2446
    name = "%s.~%d~" % (base, counter)
 
2447
    while exists(name):
 
2448
        counter += 1
 
2449
        name = "%s.~%d~" % (base, counter)
 
2450
    return name
 
2451
 
 
2452
 
 
2453
def set_fd_cloexec(fd):
 
2454
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
 
2455
    support for this is not available.
 
2456
    """
 
2457
    try:
 
2458
        import fcntl
 
2459
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
 
2460
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
 
2461
    except (ImportError, AttributeError):
 
2462
        # Either the fcntl module or specific constants are not present
 
2463
        pass
 
2464
 
 
2465
 
 
2466
def find_executable_on_path(name):
 
2467
    """Finds an executable on the PATH.
 
2468
    
 
2469
    On Windows, this will try to append each extension in the PATHEXT
 
2470
    environment variable to the name, if it cannot be found with the name
 
2471
    as given.
 
2472
    
 
2473
    :param name: The base name of the executable.
 
2474
    :return: The path to the executable found or None.
 
2475
    """
 
2476
    path = os.environ.get('PATH')
 
2477
    if path is None:
 
2478
        return None
 
2479
    path = path.split(os.pathsep)
 
2480
    if sys.platform == 'win32':
 
2481
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
 
2482
        exts = [ext.lower() for ext in exts]
 
2483
        base, ext = os.path.splitext(name)
 
2484
        if ext != '':
 
2485
            if ext.lower() not in exts:
 
2486
                return None
 
2487
            name = base
 
2488
            exts = [ext]
 
2489
    else:
 
2490
        exts = ['']
 
2491
    for ext in exts:
 
2492
        for d in path:
 
2493
            f = os.path.join(d, name) + ext
 
2494
            if os.access(f, os.X_OK):
 
2495
                return f
 
2496
    return None
 
2497
 
 
2498
 
 
2499
def _posix_is_local_pid_dead(pid):
 
2500
    """True if pid doesn't correspond to live process on this machine"""
 
2501
    try:
 
2502
        # Special meaning of unix kill: just check if it's there.
 
2503
        os.kill(pid, 0)
 
2504
    except OSError, e:
 
2505
        if e.errno == errno.ESRCH:
 
2506
            # On this machine, and really not found: as sure as we can be
 
2507
            # that it's dead.
 
2508
            return True
 
2509
        elif e.errno == errno.EPERM:
 
2510
            # exists, though not ours
 
2511
            return False
 
2512
        else:
 
2513
            mutter("os.kill(%d, 0) failed: %s" % (pid, e))
 
2514
            # Don't really know.
 
2515
            return False
 
2516
    else:
 
2517
        # Exists and our process: not dead.
 
2518
        return False
 
2519
 
 
2520
if sys.platform == "win32":
 
2521
    is_local_pid_dead = win32utils.is_local_pid_dead
 
2522
else:
 
2523
    is_local_pid_dead = _posix_is_local_pid_dead
 
2524
 
 
2525
 
 
2526
def fdatasync(fileno):
 
2527
    """Flush file contents to disk if possible.
 
2528
    
 
2529
    :param fileno: Integer OS file handle.
 
2530
    :raises TransportNotPossible: If flushing to disk is not possible.
 
2531
    """
 
2532
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
 
2533
    if fn is not None:
 
2534
        fn(fileno)
 
2535
 
 
2536
 
 
2537
def ensure_empty_directory_exists(path, exception_class):
 
2538
    """Make sure a local directory exists and is empty.
 
2539
    
 
2540
    If it does not exist, it is created.  If it exists and is not empty, an
 
2541
    instance of exception_class is raised.
 
2542
    """
 
2543
    try:
 
2544
        os.mkdir(path)
 
2545
    except OSError, e:
 
2546
        if e.errno != errno.EEXIST:
 
2547
            raise
 
2548
        if os.listdir(path) != []:
 
2549
            raise exception_class(path)