/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: Jelmer Vernooij
  • Date: 2011-12-10 21:00:34 UTC
  • mto: This revision was merged to the branch mainline in revision 6357.
  • Revision ID: jelmer@samba.org-20111210210034-wwgiahmgqpo1re1j
add blackbox tests for mkdir.

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
import select
 
32
# We need to import both shutil and rmtree as we export the later on posix
 
33
# and need the former on windows
36
34
import shutil
37
 
from shutil import (
38
 
    rmtree,
39
 
    )
 
35
from shutil import rmtree
40
36
import socket
41
37
import subprocess
 
38
# We need to import both tempfile and mkdtemp as we export the later on posix
 
39
# and need the former on windows
42
40
import tempfile
43
 
from tempfile import (
44
 
    mkdtemp,
45
 
    )
 
41
from tempfile import mkdtemp
46
42
import unicodedata
47
43
 
48
44
from bzrlib import (
49
45
    cache_utf8,
 
46
    config,
50
47
    errors,
51
48
    trace,
52
49
    win32utils,
53
50
    )
 
51
from bzrlib.i18n import gettext
54
52
""")
55
53
 
56
54
from bzrlib.symbol_versioning import (
58
56
    deprecated_in,
59
57
    )
60
58
 
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
 
        )
 
59
from hashlib import (
 
60
    md5,
 
61
    sha1 as sha,
 
62
    )
73
63
 
74
64
 
75
65
import bzrlib
101
91
        user_encoding = get_user_encoding()
102
92
        return [a.decode(user_encoding) for a in sys.argv[1:]]
103
93
    except UnicodeDecodeError:
104
 
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
105
 
                                                            "encoding." % a))
 
94
        raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
 
95
            "application locale.").format(a, user_encoding))
106
96
 
107
97
 
108
98
def make_readonly(filename):
110
100
    mod = os.lstat(filename).st_mode
111
101
    if not stat.S_ISLNK(mod):
112
102
        mod = mod & 0777555
113
 
        os.chmod(filename, mod)
 
103
        chmod_if_possible(filename, mod)
114
104
 
115
105
 
116
106
def make_writable(filename):
117
107
    mod = os.lstat(filename).st_mode
118
108
    if not stat.S_ISLNK(mod):
119
109
        mod = mod | 0200
120
 
        os.chmod(filename, mod)
 
110
        chmod_if_possible(filename, mod)
 
111
 
 
112
 
 
113
def chmod_if_possible(filename, mode):
 
114
    # Set file mode if that can be safely done.
 
115
    # Sometimes even on unix the filesystem won't allow it - see
 
116
    # https://bugs.launchpad.net/bzr/+bug/606537
 
117
    try:
 
118
        # It is probably faster to just do the chmod, rather than
 
119
        # doing a stat, and then trying to compare
 
120
        os.chmod(filename, mode)
 
121
    except (IOError, OSError),e:
 
122
        # Permission/access denied seems to commonly happen on smbfs; there's
 
123
        # probably no point warning about it.
 
124
        # <https://bugs.launchpad.net/bzr/+bug/606537>
 
125
        if getattr(e, 'errno') in (errno.EPERM, errno.EACCES):
 
126
            trace.mutter("ignore error on chmod of %r: %r" % (
 
127
                filename, e))
 
128
            return
 
129
        raise
121
130
 
122
131
 
123
132
def minimum_path_selection(paths):
202
211
            if e.errno == errno.ENOENT:
203
212
                return False;
204
213
            else:
205
 
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
 
214
                raise errors.BzrError(gettext("lstat/stat of ({0!r}): {1!r}").format(f, e))
206
215
 
207
216
 
208
217
def fancy_rename(old, new, rename_func, unlink_func):
274
283
            else:
275
284
                rename_func(tmp_name, new)
276
285
    if failure_exc is not None:
277
 
        raise failure_exc[0], failure_exc[1], failure_exc[2]
 
286
        try:
 
287
            raise failure_exc[0], failure_exc[1], failure_exc[2]
 
288
        finally:
 
289
            del failure_exc
278
290
 
279
291
 
280
292
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
287
299
    # copy posixpath.abspath, but use os.getcwdu instead
288
300
    if not posixpath.isabs(path):
289
301
        path = posixpath.join(getcwd(), path)
290
 
    return posixpath.normpath(path)
 
302
    return _posix_normpath(path)
291
303
 
292
304
 
293
305
def _posix_realpath(path):
294
306
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
295
307
 
296
308
 
 
309
def _posix_normpath(path):
 
310
    path = posixpath.normpath(path)
 
311
    # Bug 861008: posixpath.normpath() returns a path normalized according to
 
312
    # the POSIX standard, which stipulates (for compatibility reasons) that two
 
313
    # leading slashes must not be simplified to one, and only if there are 3 or
 
314
    # more should they be simplified as one. So we treat the leading 2 slashes
 
315
    # as a special case here by simply removing the first slash, as we consider
 
316
    # that breaking POSIX compatibility for this obscure feature is acceptable.
 
317
    # This is not a paranoid precaution, as we notably get paths like this when
 
318
    # the repo is hosted at the root of the filesystem, i.e. in "/".    
 
319
    if path.startswith('//'):
 
320
        path = path[1:]
 
321
    return path
 
322
 
 
323
 
297
324
def _win32_fixdrive(path):
298
325
    """Force drive letters to be consistent.
299
326
 
303
330
    running python.exe under cmd.exe return capital C:\\
304
331
    running win32 python inside a cygwin shell returns lowercase c:\\
305
332
    """
306
 
    drive, path = _nt_splitdrive(path)
 
333
    drive, path = ntpath.splitdrive(path)
307
334
    return drive.upper() + path
308
335
 
309
336
 
310
337
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('\\', '/'))
 
338
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
 
339
    return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
313
340
 
314
341
 
315
342
def _win98_abspath(path):
326
353
    #   /path       => C:/path
327
354
    path = unicode(path)
328
355
    # check for absolute path
329
 
    drive = _nt_splitdrive(path)[0]
 
356
    drive = ntpath.splitdrive(path)[0]
330
357
    if drive == '' and path[:2] not in('//','\\\\'):
331
358
        cwd = os.getcwdu()
332
359
        # we cannot simply os.path.join cwd and path
333
360
        # because os.path.join('C:','/path') produce '/path'
334
361
        # and this is incorrect
335
362
        if path[:1] in ('/','\\'):
336
 
            cwd = _nt_splitdrive(cwd)[0]
 
363
            cwd = ntpath.splitdrive(cwd)[0]
337
364
            path = path[1:]
338
365
        path = cwd + '\\' + path
339
 
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
 
366
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
340
367
 
341
368
 
342
369
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('\\', '/'))
 
370
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
 
371
    return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
345
372
 
346
373
 
347
374
def _win32_pathjoin(*args):
348
 
    return _nt_join(*args).replace('\\', '/')
 
375
    return ntpath.join(*args).replace('\\', '/')
349
376
 
350
377
 
351
378
def _win32_normpath(path):
352
 
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
379
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
353
380
 
354
381
 
355
382
def _win32_getcwd():
360
387
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
361
388
 
362
389
 
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
390
def _win32_rename(old, new):
372
391
    """We expect to be able to atomically replace 'new' with old.
373
392
 
375
394
    and then deleted.
376
395
    """
377
396
    try:
378
 
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
 
397
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
379
398
    except OSError, e:
380
399
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
381
400
            # If we try to rename a non-existant file onto cwd, we get
386
405
        raise
387
406
 
388
407
 
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
408
def _mac_getcwd():
400
409
    return unicodedata.normalize('NFC', os.getcwdu())
401
410
 
405
414
abspath = _posix_abspath
406
415
realpath = _posix_realpath
407
416
pathjoin = os.path.join
408
 
normpath = os.path.normpath
409
 
rename = _wrapped_rename # overridden below on win32
 
417
normpath = _posix_normpath
410
418
getcwd = os.getcwdu
 
419
rename = os.rename
411
420
dirname = os.path.dirname
412
421
basename = os.path.basename
413
422
split = os.path.split
414
423
splitext = os.path.splitext
415
 
# These were already imported into local scope
 
424
# These were already lazily imported into local scope
416
425
# mkdtemp = tempfile.mkdtemp
417
426
# rmtree = shutil.rmtree
 
427
lstat = os.lstat
 
428
fstat = os.fstat
 
429
 
 
430
def wrap_stat(st):
 
431
    return st
 
432
 
418
433
 
419
434
MIN_ABS_PATHLENGTH = 1
420
435
 
430
445
    getcwd = _win32_getcwd
431
446
    mkdtemp = _win32_mkdtemp
432
447
    rename = _win32_rename
 
448
    try:
 
449
        from bzrlib import _walkdirs_win32
 
450
    except ImportError:
 
451
        pass
 
452
    else:
 
453
        lstat = _walkdirs_win32.lstat
 
454
        fstat = _walkdirs_win32.fstat
 
455
        wrap_stat = _walkdirs_win32.wrap_stat
433
456
 
434
457
    MIN_ABS_PATHLENGTH = 3
435
458
 
458
481
    getcwd = _mac_getcwd
459
482
 
460
483
 
461
 
def get_terminal_encoding():
 
484
def get_terminal_encoding(trace=False):
462
485
    """Find the best encoding for printing to the screen.
463
486
 
464
487
    This attempts to check both sys.stdout and sys.stdin to see
470
493
 
471
494
    On my standard US Windows XP, the preferred encoding is
472
495
    cp1252, but the console is cp437
 
496
 
 
497
    :param trace: If True trace the selected encoding via mutter().
473
498
    """
474
499
    from bzrlib.trace import mutter
475
500
    output_encoding = getattr(sys.stdout, 'encoding', None)
477
502
        input_encoding = getattr(sys.stdin, 'encoding', None)
478
503
        if not input_encoding:
479
504
            output_encoding = get_user_encoding()
480
 
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
505
            if trace:
 
506
                mutter('encoding stdout as osutils.get_user_encoding() %r',
481
507
                   output_encoding)
482
508
        else:
483
509
            output_encoding = input_encoding
484
 
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
510
            if trace:
 
511
                mutter('encoding stdout as sys.stdin encoding %r',
 
512
                    output_encoding)
485
513
    else:
486
 
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
514
        if trace:
 
515
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
487
516
    if output_encoding == 'cp0':
488
517
        # invalid encoding (cp0 means 'no codepage' on Windows)
489
518
        output_encoding = get_user_encoding()
490
 
        mutter('cp0 is invalid encoding.'
 
519
        if trace:
 
520
            mutter('cp0 is invalid encoding.'
491
521
               ' encoding stdout as osutils.get_user_encoding() %r',
492
522
               output_encoding)
493
523
    # check encoding
519
549
def isdir(f):
520
550
    """True if f is an accessible directory."""
521
551
    try:
522
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
552
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
523
553
    except OSError:
524
554
        return False
525
555
 
527
557
def isfile(f):
528
558
    """True if f is a regular file."""
529
559
    try:
530
 
        return S_ISREG(os.lstat(f)[ST_MODE])
 
560
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
531
561
    except OSError:
532
562
        return False
533
563
 
534
564
def islink(f):
535
565
    """True if f is a symlink."""
536
566
    try:
537
 
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
567
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
538
568
    except OSError:
539
569
        return False
540
570
 
880
910
 
881
911
def filesize(f):
882
912
    """Return size of given open file."""
883
 
    return os.fstat(f.fileno())[ST_SIZE]
 
913
    return os.fstat(f.fileno())[stat.ST_SIZE]
884
914
 
885
915
 
886
916
# Define rand_bytes based on platform.
931
961
    rps = []
932
962
    for f in ps:
933
963
        if f == '..':
934
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
964
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
935
965
        elif (f == '.') or (f == ''):
936
966
            pass
937
967
        else:
942
972
def joinpath(p):
943
973
    for f in p:
944
974
        if (f == '..') or (f is None) or (f == ''):
945
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
975
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
946
976
    return pathjoin(*p)
947
977
 
948
978
 
949
979
def parent_directories(filename):
950
980
    """Return the list of parent directories, deepest first.
951
 
    
 
981
 
952
982
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
953
983
    """
954
984
    parents = []
978
1008
    # NB: This docstring is just an example, not a doctest, because doctest
979
1009
    # currently can't cope with the use of lazy imports in this namespace --
980
1010
    # mbp 20090729
981
 
    
 
1011
 
982
1012
    # This currently doesn't report the failure at the time it occurs, because
983
1013
    # they tend to happen very early in startup when we can't check config
984
1014
    # files etc, and also we want to report all failures but not spam the user
985
1015
    # with 10 warnings.
986
 
    from bzrlib import trace
987
1016
    exception_str = str(exception)
988
1017
    if exception_str not in _extension_load_failures:
989
1018
        trace.mutter("failed to load compiled extension: %s" % exception_str)
993
1022
def report_extension_load_failures():
994
1023
    if not _extension_load_failures:
995
1024
        return
996
 
    from bzrlib.config import GlobalConfig
997
 
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
 
1025
    if config.GlobalStack().get('ignore_missing_extensions'):
998
1026
        return
999
1027
    # the warnings framework should by default show this only once
1000
1028
    from bzrlib.trace import warning
1054
1082
 
1055
1083
 
1056
1084
def delete_any(path):
1057
 
    """Delete a file, symlink or directory.  
1058
 
    
 
1085
    """Delete a file, symlink or directory.
 
1086
 
1059
1087
    Will delete even if readonly.
1060
1088
    """
1061
1089
    try:
1162
1190
 
1163
1191
    if len(base) < MIN_ABS_PATHLENGTH:
1164
1192
        # must have space for e.g. a drive letter
1165
 
        raise ValueError('%r is too short to calculate a relative path'
 
1193
        raise ValueError(gettext('%r is too short to calculate a relative path')
1166
1194
            % (base,))
1167
1195
 
1168
1196
    rp = abspath(path)
1250
1278
    # but for now, we haven't optimized...
1251
1279
    return [canonical_relpath(base, p) for p in paths]
1252
1280
 
 
1281
 
 
1282
def decode_filename(filename):
 
1283
    """Decode the filename using the filesystem encoding
 
1284
 
 
1285
    If it is unicode, it is returned.
 
1286
    Otherwise it is decoded from the the filesystem's encoding. If decoding
 
1287
    fails, a errors.BadFilenameEncoding exception is raised.
 
1288
    """
 
1289
    if type(filename) is unicode:
 
1290
        return filename
 
1291
    try:
 
1292
        return filename.decode(_fs_enc)
 
1293
    except UnicodeDecodeError:
 
1294
        raise errors.BadFilenameEncoding(filename, _fs_enc)
 
1295
 
 
1296
 
1253
1297
def safe_unicode(unicode_or_utf8_string):
1254
1298
    """Coerce unicode_or_utf8_string into unicode.
1255
1299
 
1338
1382
def normalizes_filenames():
1339
1383
    """Return True if this platform normalizes unicode filenames.
1340
1384
 
1341
 
    Mac OSX does, Windows/Linux do not.
 
1385
    Only Mac OSX.
1342
1386
    """
1343
1387
    return _platform_normalizes_filenames
1344
1388
 
1349
1393
    On platforms where the system normalizes filenames (Mac OSX),
1350
1394
    you can access a file by any path which will normalize correctly.
1351
1395
    On platforms where the system does not normalize filenames
1352
 
    (Windows, Linux), you have to access a file by its exact path.
 
1396
    (everything else), you have to access a file by its exact path.
1353
1397
 
1354
1398
    Internally, bzr only supports NFC normalization, since that is
1355
1399
    the standard for XML documents.
1417
1461
terminal_width() returns None.
1418
1462
"""
1419
1463
 
 
1464
# Keep some state so that terminal_width can detect if _terminal_size has
 
1465
# returned a different size since the process started.  See docstring and
 
1466
# comments of terminal_width for details.
 
1467
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
 
1468
_terminal_size_state = 'no_data'
 
1469
_first_terminal_size = None
1420
1470
 
1421
1471
def terminal_width():
1422
1472
    """Return terminal width.
1426
1476
    The rules are:
1427
1477
    - if BZR_COLUMNS is set, returns its value
1428
1478
    - if there is no controlling terminal, returns None
 
1479
    - query the OS, if the queried size has changed since the last query,
 
1480
      return its value,
1429
1481
    - if COLUMNS is set, returns its value,
 
1482
    - if the OS has a value (even though it's never changed), return its value.
1430
1483
 
1431
1484
    From there, we need to query the OS to get the size of the controlling
1432
1485
    terminal.
1433
1486
 
1434
 
    Unices:
 
1487
    On Unices we query the OS by:
1435
1488
    - get termios.TIOCGWINSZ
1436
1489
    - if an error occurs or a negative value is obtained, returns None
1437
1490
 
1438
 
    Windows:
1439
 
    
 
1491
    On Windows we query the OS by:
1440
1492
    - win32utils.get_console_size() decides,
1441
1493
    - returns None on error (provided default value)
1442
1494
    """
 
1495
    # Note to implementors: if changing the rules for determining the width,
 
1496
    # make sure you've considered the behaviour in these cases:
 
1497
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
 
1498
    #  - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
 
1499
    #    0,0.
 
1500
    #  - (add more interesting cases here, if you find any)
 
1501
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
 
1502
    # but we don't want to register a signal handler because it is impossible
 
1503
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
 
1504
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
 
1505
    # time so we can notice if the reported size has changed, which should have
 
1506
    # a similar effect.
1443
1507
 
1444
1508
    # If BZR_COLUMNS is set, take it, user is always right
 
1509
    # Except if they specified 0 in which case, impose no limit here
1445
1510
    try:
1446
 
        return int(os.environ['BZR_COLUMNS'])
 
1511
        width = int(os.environ['BZR_COLUMNS'])
1447
1512
    except (KeyError, ValueError):
1448
 
        pass
 
1513
        width = None
 
1514
    if width is not None:
 
1515
        if width > 0:
 
1516
            return width
 
1517
        else:
 
1518
            return None
1449
1519
 
1450
1520
    isatty = getattr(sys.stdout, 'isatty', None)
1451
 
    if  isatty is None or not isatty():
 
1521
    if isatty is None or not isatty():
1452
1522
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1453
1523
        return None
1454
1524
 
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))
 
1525
    # Query the OS
 
1526
    width, height = os_size = _terminal_size(None, None)
 
1527
    global _first_terminal_size, _terminal_size_state
 
1528
    if _terminal_size_state == 'no_data':
 
1529
        _first_terminal_size = os_size
 
1530
        _terminal_size_state = 'unchanged'
 
1531
    elif (_terminal_size_state == 'unchanged' and
 
1532
          _first_terminal_size != os_size):
 
1533
        _terminal_size_state = 'changed'
 
1534
 
 
1535
    # If the OS claims to know how wide the terminal is, and this value has
 
1536
    # ever changed, use that.
 
1537
    if _terminal_size_state == 'changed':
 
1538
        if width is not None and width > 0:
 
1539
            return width
 
1540
 
 
1541
    # If COLUMNS is set, use it.
1458
1542
    try:
1459
1543
        return int(os.environ['COLUMNS'])
1460
1544
    except (KeyError, ValueError):
1461
1545
        pass
1462
1546
 
1463
 
    width, height = _terminal_size(None, None)
1464
 
    if width <= 0:
1465
 
        # Consider invalid values as meaning no width
1466
 
        return None
 
1547
    # Finally, use an unchanged size from the OS, if we have one.
 
1548
    if _terminal_size_state == 'unchanged':
 
1549
        if width is not None and width > 0:
 
1550
            return width
1467
1551
 
1468
 
    return width
 
1552
    # The width could not be determined.
 
1553
    return None
1469
1554
 
1470
1555
 
1471
1556
def _win32_terminal_size(width, height):
1498
1583
    _terminal_size = _ioctl_terminal_size
1499
1584
 
1500
1585
 
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
1586
def supports_executable():
1527
1587
    return sys.platform != "win32"
1528
1588
 
1651
1711
        dirblock = []
1652
1712
        append = dirblock.append
1653
1713
        try:
1654
 
            names = sorted(_listdir(top))
 
1714
            names = sorted(map(decode_filename, _listdir(top)))
1655
1715
        except OSError, e:
1656
1716
            if not _is_error_enotdir(e):
1657
1717
                raise
1865
1925
        s = os.stat(src)
1866
1926
        chown(dst, s.st_uid, s.st_gid)
1867
1927
    except OSError, e:
1868
 
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
 
1928
        trace.warning(
 
1929
            'Unable to copy ownership from "%s" to "%s". '
 
1930
            'You may want to set it manually.', src, dst)
 
1931
        trace.log_exception_quietly()
1869
1932
 
1870
1933
 
1871
1934
def path_prefix_key(path):
1959
2022
    return user_encoding
1960
2023
 
1961
2024
 
 
2025
def get_diff_header_encoding():
 
2026
    return get_terminal_encoding()
 
2027
 
 
2028
 
 
2029
_message_encoding = None
 
2030
 
 
2031
 
 
2032
def get_message_encoding():
 
2033
    """Return the encoding used for messages
 
2034
 
 
2035
    While the message encoding is a general setting it should usually only be
 
2036
    needed for decoding system error strings such as from OSError instances.
 
2037
    """
 
2038
    global _message_encoding
 
2039
    if _message_encoding is None:
 
2040
        if os.name == "posix":
 
2041
            import locale
 
2042
            # This is a process-global setting that can change, but should in
 
2043
            # general just get set once at process startup then be constant.
 
2044
            _message_encoding = locale.getlocale(locale.LC_MESSAGES)[1]
 
2045
        else:
 
2046
            # On windows want the result of GetACP() which this boils down to.
 
2047
            _message_encoding = get_user_encoding()
 
2048
    return _message_encoding or "ascii"
 
2049
        
 
2050
 
1962
2051
def get_host_name():
1963
2052
    """Return the current unicode host name.
1964
2053
 
1979
2068
# data at once.
1980
2069
MAX_SOCKET_CHUNK = 64 * 1024
1981
2070
 
 
2071
_end_of_stream_errors = [errno.ECONNRESET]
 
2072
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
 
2073
    _eno = getattr(errno, _eno, None)
 
2074
    if _eno is not None:
 
2075
        _end_of_stream_errors.append(_eno)
 
2076
del _eno
 
2077
 
 
2078
 
1982
2079
def read_bytes_from_socket(sock, report_activity=None,
1983
2080
        max_read_size=MAX_SOCKET_CHUNK):
1984
2081
    """Read up to max_read_size of bytes from sock and notify of progress.
1992
2089
            bytes = sock.recv(max_read_size)
1993
2090
        except socket.error, e:
1994
2091
            eno = e.args[0]
1995
 
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
 
2092
            if eno in _end_of_stream_errors:
1996
2093
                # The connection was closed by the other side.  Callers expect
1997
2094
                # an empty string to signal end-of-stream.
1998
2095
                return ""
2027
2124
 
2028
2125
def send_all(sock, bytes, report_activity=None):
2029
2126
    """Send all bytes on a socket.
2030
 
 
 
2127
 
2031
2128
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2032
2129
    some platforms, and catches EINTR which may be thrown if the send is
2033
2130
    interrupted by a signal.
2034
2131
 
2035
2132
    This is preferred to socket.sendall(), because it avoids portability bugs
2036
2133
    and provides activity reporting.
2037
 
 
 
2134
 
2038
2135
    :param report_activity: Call this as bytes are read, see
2039
2136
        Transport._report_activity
2040
2137
    """
2051
2148
            report_activity(sent, 'write')
2052
2149
 
2053
2150
 
 
2151
def connect_socket(address):
 
2152
    # Slight variation of the socket.create_connection() function (provided by
 
2153
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
 
2154
    # provide it for previous python versions. Also, we don't use the timeout
 
2155
    # parameter (provided by the python implementation) so we don't implement
 
2156
    # it either).
 
2157
    err = socket.error('getaddrinfo returns an empty list')
 
2158
    host, port = address
 
2159
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
 
2160
        af, socktype, proto, canonname, sa = res
 
2161
        sock = None
 
2162
        try:
 
2163
            sock = socket.socket(af, socktype, proto)
 
2164
            sock.connect(sa)
 
2165
            return sock
 
2166
 
 
2167
        except socket.error, err:
 
2168
            # 'err' is now the most recent error
 
2169
            if sock is not None:
 
2170
                sock.close()
 
2171
    raise err
 
2172
 
 
2173
 
2054
2174
def dereference_path(path):
2055
2175
    """Determine the real path to a file.
2056
2176
 
2095
2215
    base = dirname(bzrlib.__file__)
2096
2216
    if getattr(sys, 'frozen', None):    # bzr.exe
2097
2217
        base = abspath(pathjoin(base, '..', '..'))
2098
 
    filename = pathjoin(base, resource_relpath)
2099
 
    return open(filename, 'rU').read()
2100
 
 
 
2218
    f = file(pathjoin(base, resource_relpath), "rU")
 
2219
    try:
 
2220
        return f.read()
 
2221
    finally:
 
2222
        f.close()
2101
2223
 
2102
2224
def file_kind_from_stat_mode_thunk(mode):
2103
2225
    global file_kind_from_stat_mode
2114
2236
    return file_kind_from_stat_mode(mode)
2115
2237
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2116
2238
 
2117
 
 
2118
 
def file_kind(f, _lstat=os.lstat):
 
2239
def file_stat(f, _lstat=os.lstat):
2119
2240
    try:
2120
 
        return file_kind_from_stat_mode(_lstat(f).st_mode)
 
2241
        # XXX cache?
 
2242
        return _lstat(f)
2121
2243
    except OSError, e:
2122
2244
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2123
2245
            raise errors.NoSuchFile(f)
2124
2246
        raise
2125
2247
 
 
2248
def file_kind(f, _lstat=os.lstat):
 
2249
    stat_value = file_stat(f, _lstat)
 
2250
    return file_kind_from_stat_mode(stat_value.st_mode)
2126
2251
 
2127
2252
def until_no_eintr(f, *a, **kw):
2128
2253
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2129
 
    
 
2254
 
2130
2255
    WARNING: you must be certain that it is safe to retry the call repeatedly
2131
2256
    if EINTR does occur.  This is typically only true for low-level operations
2132
2257
    like os.read.  If in any doubt, don't use this.
2147
2272
            raise
2148
2273
 
2149
2274
 
 
2275
@deprecated_function(deprecated_in((2, 2, 0)))
2150
2276
def re_compile_checked(re_string, flags=0, where=""):
2151
2277
    """Return a compiled re, or raise a sensible error.
2152
2278
 
2162
2288
        re_obj = re.compile(re_string, flags)
2163
2289
        re_obj.search("")
2164
2290
        return re_obj
2165
 
    except re.error, e:
 
2291
    except errors.InvalidPattern, e:
2166
2292
        if where:
2167
2293
            where = ' in ' + where
2168
2294
        # despite the name 'error' is a type
2169
 
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2170
 
            % (where, re_string, e))
 
2295
        raise errors.BzrCommandError('Invalid regular expression%s: %s'
 
2296
            % (where, e.msg))
2171
2297
 
2172
2298
 
2173
2299
if sys.platform == "win32":
2187
2313
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2188
2314
        return ch
2189
2315
 
2190
 
 
2191
 
if sys.platform == 'linux2':
 
2316
if sys.platform.startswith('linux'):
2192
2317
    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
 
2318
        try:
 
2319
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2320
        except (ValueError, OSError, AttributeError):
 
2321
            return None
2199
2322
elif sys.platform == 'darwin':
2200
2323
    def _local_concurrency():
2201
2324
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2202
2325
                                stdout=subprocess.PIPE).communicate()[0]
2203
 
elif sys.platform[0:7] == 'freebsd':
 
2326
elif "bsd" in sys.platform:
2204
2327
    def _local_concurrency():
2205
2328
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2206
2329
                                stdout=subprocess.PIPE).communicate()[0]
2234
2357
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2235
2358
    if concurrency is None:
2236
2359
        try:
2237
 
            concurrency = _local_concurrency()
2238
 
        except (OSError, IOError):
2239
 
            pass
 
2360
            import multiprocessing
 
2361
            concurrency = multiprocessing.cpu_count()
 
2362
        except (ImportError, NotImplementedError):
 
2363
            # multiprocessing is only available on Python >= 2.6
 
2364
            # and multiprocessing.cpu_count() isn't implemented on all
 
2365
            # platforms
 
2366
            try:
 
2367
                concurrency = _local_concurrency()
 
2368
            except (OSError, IOError):
 
2369
                pass
2240
2370
    try:
2241
2371
        concurrency = int(concurrency)
2242
2372
    except (TypeError, ValueError):
2263
2393
if sys.platform == 'win32':
2264
2394
    def open_file(filename, mode='r', bufsize=-1):
2265
2395
        """This function is used to override the ``open`` builtin.
2266
 
        
 
2396
 
2267
2397
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2268
2398
        child processes.  Deleting or renaming a closed file opened with this
2269
2399
        function is not blocking child processes.
2302
2432
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2303
2433
else:
2304
2434
    open_file = open
 
2435
 
 
2436
 
 
2437
def getuser_unicode():
 
2438
    """Return the username as unicode.
 
2439
    """
 
2440
    try:
 
2441
        user_encoding = get_user_encoding()
 
2442
        username = getpass.getuser().decode(user_encoding)
 
2443
    except UnicodeDecodeError:
 
2444
        raise errors.BzrError("Can't decode username as %s." % \
 
2445
                user_encoding)
 
2446
    except ImportError, e:
 
2447
        if sys.platform != 'win32':
 
2448
            raise
 
2449
        if str(e) != 'No module named pwd':
 
2450
            raise
 
2451
        # https://bugs.launchpad.net/bzr/+bug/660174
 
2452
        # getpass.getuser() is unable to return username on Windows
 
2453
        # if there is no USERNAME environment variable set.
 
2454
        # That could be true if bzr is running as a service,
 
2455
        # e.g. running `bzr serve` as a service on Windows.
 
2456
        # We should not fail with traceback in this case.
 
2457
        username = u'UNKNOWN'
 
2458
    return username
 
2459
 
 
2460
 
 
2461
def available_backup_name(base, exists):
 
2462
    """Find a non-existing backup file name.
 
2463
 
 
2464
    This will *not* create anything, this only return a 'free' entry.  This
 
2465
    should be used for checking names in a directory below a locked
 
2466
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
 
2467
    Leap) and generally discouraged.
 
2468
 
 
2469
    :param base: The base name.
 
2470
 
 
2471
    :param exists: A callable returning True if the path parameter exists.
 
2472
    """
 
2473
    counter = 1
 
2474
    name = "%s.~%d~" % (base, counter)
 
2475
    while exists(name):
 
2476
        counter += 1
 
2477
        name = "%s.~%d~" % (base, counter)
 
2478
    return name
 
2479
 
 
2480
 
 
2481
def set_fd_cloexec(fd):
 
2482
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
 
2483
    support for this is not available.
 
2484
    """
 
2485
    try:
 
2486
        import fcntl
 
2487
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
 
2488
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
 
2489
    except (ImportError, AttributeError):
 
2490
        # Either the fcntl module or specific constants are not present
 
2491
        pass
 
2492
 
 
2493
 
 
2494
def find_executable_on_path(name):
 
2495
    """Finds an executable on the PATH.
 
2496
    
 
2497
    On Windows, this will try to append each extension in the PATHEXT
 
2498
    environment variable to the name, if it cannot be found with the name
 
2499
    as given.
 
2500
    
 
2501
    :param name: The base name of the executable.
 
2502
    :return: The path to the executable found or None.
 
2503
    """
 
2504
    path = os.environ.get('PATH')
 
2505
    if path is None:
 
2506
        return None
 
2507
    path = path.split(os.pathsep)
 
2508
    if sys.platform == 'win32':
 
2509
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
 
2510
        exts = [ext.lower() for ext in exts]
 
2511
        base, ext = os.path.splitext(name)
 
2512
        if ext != '':
 
2513
            if ext.lower() not in exts:
 
2514
                return None
 
2515
            name = base
 
2516
            exts = [ext]
 
2517
    else:
 
2518
        exts = ['']
 
2519
    for ext in exts:
 
2520
        for d in path:
 
2521
            f = os.path.join(d, name) + ext
 
2522
            if os.access(f, os.X_OK):
 
2523
                return f
 
2524
    return None
 
2525
 
 
2526
 
 
2527
def _posix_is_local_pid_dead(pid):
 
2528
    """True if pid doesn't correspond to live process on this machine"""
 
2529
    try:
 
2530
        # Special meaning of unix kill: just check if it's there.
 
2531
        os.kill(pid, 0)
 
2532
    except OSError, e:
 
2533
        if e.errno == errno.ESRCH:
 
2534
            # On this machine, and really not found: as sure as we can be
 
2535
            # that it's dead.
 
2536
            return True
 
2537
        elif e.errno == errno.EPERM:
 
2538
            # exists, though not ours
 
2539
            return False
 
2540
        else:
 
2541
            mutter("os.kill(%d, 0) failed: %s" % (pid, e))
 
2542
            # Don't really know.
 
2543
            return False
 
2544
    else:
 
2545
        # Exists and our process: not dead.
 
2546
        return False
 
2547
 
 
2548
if sys.platform == "win32":
 
2549
    is_local_pid_dead = win32utils.is_local_pid_dead
 
2550
else:
 
2551
    is_local_pid_dead = _posix_is_local_pid_dead
 
2552
 
 
2553
 
 
2554
def fdatasync(fileno):
 
2555
    """Flush file contents to disk if possible.
 
2556
    
 
2557
    :param fileno: Integer OS file handle.
 
2558
    :raises TransportNotPossible: If flushing to disk is not possible.
 
2559
    """
 
2560
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
 
2561
    if fn is not None:
 
2562
        fn(fileno)
 
2563
 
 
2564
 
 
2565
def ensure_empty_directory_exists(path, exception_class):
 
2566
    """Make sure a local directory exists and is empty.
 
2567
    
 
2568
    If it does not exist, it is created.  If it exists and is not empty, an
 
2569
    instance of exception_class is raised.
 
2570
    """
 
2571
    try:
 
2572
        os.mkdir(path)
 
2573
    except OSError, e:
 
2574
        if e.errno != errno.EEXIST:
 
2575
            raise
 
2576
        if os.listdir(path) != []:
 
2577
            raise exception_class(path)
 
2578
 
 
2579
 
 
2580
def is_environment_error(evalue):
 
2581
    """True if exception instance is due to a process environment issue
 
2582
 
 
2583
    This includes OSError and IOError, but also other errors that come from
 
2584
    the operating system or core libraries but are not subclasses of those.
 
2585
    """
 
2586
    if isinstance(evalue, (EnvironmentError, select.error)):
 
2587
        return True
 
2588
    if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
 
2589
        return True
 
2590
    return False