/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

Merge bzr.dev, update to use new hooks.

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