← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Jelmer Vernooij
  • Date: 2011-12-15 11:53:48 UTC
  • mto: This revision was merged to the branch mainline in revision 6375.
  • Revision ID: jelmer@samba.org-20111215115348-murs91ipn8jbw6y0
Add tests for default_email behaviour.

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
 
 
323
def _posix_path_from_environ(key):
 
324
    """Get unicode path from `key` in environment or None if not present
 
325
 
 
326
    Note that posix systems use arbitrary byte strings for filesystem objects,
 
327
    so a path that raises BadFilenameEncoding here may still be accessible.
 
328
    """
 
329
    val = os.environ.get(key, None)
 
330
    if val is None:
 
331
        return val
 
332
    try:
 
333
        return val.decode(_fs_enc)
 
334
    except UnicodeDecodeError:
 
335
        # GZ 2011-12-12:Ideally want to include `key` in the exception message
 
336
        raise errors.BadFilenameEncoding(val, _fs_enc)
 
337
 
 
338
 
 
339
def _posix_getuser_unicode():
 
340
    """Get username from environment or password database as unicode"""
 
341
    name = getpass.getuser()
 
342
    user_encoding = get_user_encoding()
 
343
    try:
 
344
        return name.decode(user_encoding)
 
345
    except UnicodeDecodeError:
 
346
        raise errors.BzrError("Encoding of username %r is unsupported by %s "
 
347
            "application locale." % (name, user_encoding))
 
348
 
 
349
 
297
350
def _win32_fixdrive(path):
298
351
    """Force drive letters to be consistent.
299
352
 
303
356
    running python.exe under cmd.exe return capital C:\\
304
357
    running win32 python inside a cygwin shell returns lowercase c:\\
305
358
    """
306
 
    drive, path = _nt_splitdrive(path)
 
359
    drive, path = ntpath.splitdrive(path)
307
360
    return drive.upper() + path
308
361
 
309
362
 
310
363
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('\\', '/'))
 
364
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
 
365
    return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
313
366
 
314
367
 
315
368
def _win98_abspath(path):
326
379
    #   /path       => C:/path
327
380
    path = unicode(path)
328
381
    # check for absolute path
329
 
    drive = _nt_splitdrive(path)[0]
 
382
    drive = ntpath.splitdrive(path)[0]
330
383
    if drive == '' and path[:2] not in('//','\\\\'):
331
384
        cwd = os.getcwdu()
332
385
        # we cannot simply os.path.join cwd and path
333
386
        # because os.path.join('C:','/path') produce '/path'
334
387
        # and this is incorrect
335
388
        if path[:1] in ('/','\\'):
336
 
            cwd = _nt_splitdrive(cwd)[0]
 
389
            cwd = ntpath.splitdrive(cwd)[0]
337
390
            path = path[1:]
338
391
        path = cwd + '\\' + path
339
 
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
 
392
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
340
393
 
341
394
 
342
395
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('\\', '/'))
 
396
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
 
397
    return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
345
398
 
346
399
 
347
400
def _win32_pathjoin(*args):
348
 
    return _nt_join(*args).replace('\\', '/')
 
401
    return ntpath.join(*args).replace('\\', '/')
349
402
 
350
403
 
351
404
def _win32_normpath(path):
352
 
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
405
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
353
406
 
354
407
 
355
408
def _win32_getcwd():
360
413
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
361
414
 
362
415
 
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
416
def _win32_rename(old, new):
372
417
    """We expect to be able to atomically replace 'new' with old.
373
418
 
375
420
    and then deleted.
376
421
    """
377
422
    try:
378
 
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
 
423
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
379
424
    except OSError, e:
380
425
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
381
426
            # If we try to rename a non-existant file onto cwd, we get
386
431
        raise
387
432
 
388
433
 
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
434
def _mac_getcwd():
400
435
    return unicodedata.normalize('NFC', os.getcwdu())
401
436
 
405
440
abspath = _posix_abspath
406
441
realpath = _posix_realpath
407
442
pathjoin = os.path.join
408
 
normpath = os.path.normpath
409
 
rename = _wrapped_rename # overridden below on win32
 
443
normpath = _posix_normpath
 
444
path_from_environ = _posix_path_from_environ
 
445
getuser_unicode = _posix_getuser_unicode
410
446
getcwd = os.getcwdu
 
447
rename = os.rename
411
448
dirname = os.path.dirname
412
449
basename = os.path.basename
413
450
split = os.path.split
414
451
splitext = os.path.splitext
415
 
# These were already imported into local scope
 
452
# These were already lazily imported into local scope
416
453
# mkdtemp = tempfile.mkdtemp
417
454
# rmtree = shutil.rmtree
 
455
lstat = os.lstat
 
456
fstat = os.fstat
 
457
 
 
458
def wrap_stat(st):
 
459
    return st
 
460
 
418
461
 
419
462
MIN_ABS_PATHLENGTH = 1
420
463
 
430
473
    getcwd = _win32_getcwd
431
474
    mkdtemp = _win32_mkdtemp
432
475
    rename = _win32_rename
 
476
    try:
 
477
        from bzrlib import _walkdirs_win32
 
478
    except ImportError:
 
479
        pass
 
480
    else:
 
481
        lstat = _walkdirs_win32.lstat
 
482
        fstat = _walkdirs_win32.fstat
 
483
        wrap_stat = _walkdirs_win32.wrap_stat
433
484
 
434
485
    MIN_ABS_PATHLENGTH = 3
435
486
 
453
504
    f = win32utils.get_unicode_argv     # special function or None
454
505
    if f is not None:
455
506
        get_unicode_argv = f
 
507
    path_from_environ = win32utils.get_environ_unicode
 
508
    getuser_unicode = win32utils.get_user_name
456
509
 
457
510
elif sys.platform == 'darwin':
458
511
    getcwd = _mac_getcwd
459
512
 
460
513
 
461
 
def get_terminal_encoding():
 
514
def get_terminal_encoding(trace=False):
462
515
    """Find the best encoding for printing to the screen.
463
516
 
464
517
    This attempts to check both sys.stdout and sys.stdin to see
470
523
 
471
524
    On my standard US Windows XP, the preferred encoding is
472
525
    cp1252, but the console is cp437
 
526
 
 
527
    :param trace: If True trace the selected encoding via mutter().
473
528
    """
474
529
    from bzrlib.trace import mutter
475
530
    output_encoding = getattr(sys.stdout, 'encoding', None)
477
532
        input_encoding = getattr(sys.stdin, 'encoding', None)
478
533
        if not input_encoding:
479
534
            output_encoding = get_user_encoding()
480
 
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
535
            if trace:
 
536
                mutter('encoding stdout as osutils.get_user_encoding() %r',
481
537
                   output_encoding)
482
538
        else:
483
539
            output_encoding = input_encoding
484
 
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
540
            if trace:
 
541
                mutter('encoding stdout as sys.stdin encoding %r',
 
542
                    output_encoding)
485
543
    else:
486
 
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
544
        if trace:
 
545
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
487
546
    if output_encoding == 'cp0':
488
547
        # invalid encoding (cp0 means 'no codepage' on Windows)
489
548
        output_encoding = get_user_encoding()
490
 
        mutter('cp0 is invalid encoding.'
 
549
        if trace:
 
550
            mutter('cp0 is invalid encoding.'
491
551
               ' encoding stdout as osutils.get_user_encoding() %r',
492
552
               output_encoding)
493
553
    # check encoding
519
579
def isdir(f):
520
580
    """True if f is an accessible directory."""
521
581
    try:
522
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
582
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
523
583
    except OSError:
524
584
        return False
525
585
 
527
587
def isfile(f):
528
588
    """True if f is a regular file."""
529
589
    try:
530
 
        return S_ISREG(os.lstat(f)[ST_MODE])
 
590
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
531
591
    except OSError:
532
592
        return False
533
593
 
534
594
def islink(f):
535
595
    """True if f is a symlink."""
536
596
    try:
537
 
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
597
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
538
598
    except OSError:
539
599
        return False
540
600
 
880
940
 
881
941
def filesize(f):
882
942
    """Return size of given open file."""
883
 
    return os.fstat(f.fileno())[ST_SIZE]
 
943
    return os.fstat(f.fileno())[stat.ST_SIZE]
884
944
 
885
945
 
886
946
# Define rand_bytes based on platform.
931
991
    rps = []
932
992
    for f in ps:
933
993
        if f == '..':
934
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
994
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
935
995
        elif (f == '.') or (f == ''):
936
996
            pass
937
997
        else:
942
1002
def joinpath(p):
943
1003
    for f in p:
944
1004
        if (f == '..') or (f is None) or (f == ''):
945
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1005
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
946
1006
    return pathjoin(*p)
947
1007
 
948
1008
 
949
1009
def parent_directories(filename):
950
1010
    """Return the list of parent directories, deepest first.
951
 
    
 
1011
 
952
1012
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
953
1013
    """
954
1014
    parents = []
978
1038
    # NB: This docstring is just an example, not a doctest, because doctest
979
1039
    # currently can't cope with the use of lazy imports in this namespace --
980
1040
    # mbp 20090729
981
 
    
 
1041
 
982
1042
    # This currently doesn't report the failure at the time it occurs, because
983
1043
    # they tend to happen very early in startup when we can't check config
984
1044
    # files etc, and also we want to report all failures but not spam the user
985
1045
    # with 10 warnings.
986
 
    from bzrlib import trace
987
1046
    exception_str = str(exception)
988
1047
    if exception_str not in _extension_load_failures:
989
1048
        trace.mutter("failed to load compiled extension: %s" % exception_str)
993
1052
def report_extension_load_failures():
994
1053
    if not _extension_load_failures:
995
1054
        return
996
 
    from bzrlib.config import GlobalConfig
997
 
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
 
1055
    if config.GlobalStack().get('ignore_missing_extensions'):
998
1056
        return
999
1057
    # the warnings framework should by default show this only once
1000
1058
    from bzrlib.trace import warning
1054
1112
 
1055
1113
 
1056
1114
def delete_any(path):
1057
 
    """Delete a file, symlink or directory.  
1058
 
    
 
1115
    """Delete a file, symlink or directory.
 
1116
 
1059
1117
    Will delete even if readonly.
1060
1118
    """
1061
1119
    try:
1162
1220
 
1163
1221
    if len(base) < MIN_ABS_PATHLENGTH:
1164
1222
        # must have space for e.g. a drive letter
1165
 
        raise ValueError('%r is too short to calculate a relative path'
 
1223
        raise ValueError(gettext('%r is too short to calculate a relative path')
1166
1224
            % (base,))
1167
1225
 
1168
1226
    rp = abspath(path)
1250
1308
    # but for now, we haven't optimized...
1251
1309
    return [canonical_relpath(base, p) for p in paths]
1252
1310
 
 
1311
 
 
1312
def decode_filename(filename):
 
1313
    """Decode the filename using the filesystem encoding
 
1314
 
 
1315
    If it is unicode, it is returned.
 
1316
    Otherwise it is decoded from the the filesystem's encoding. If decoding
 
1317
    fails, a errors.BadFilenameEncoding exception is raised.
 
1318
    """
 
1319
    if type(filename) is unicode:
 
1320
        return filename
 
1321
    try:
 
1322
        return filename.decode(_fs_enc)
 
1323
    except UnicodeDecodeError:
 
1324
        raise errors.BadFilenameEncoding(filename, _fs_enc)
 
1325
 
 
1326
 
1253
1327
def safe_unicode(unicode_or_utf8_string):
1254
1328
    """Coerce unicode_or_utf8_string into unicode.
1255
1329
 
1338
1412
def normalizes_filenames():
1339
1413
    """Return True if this platform normalizes unicode filenames.
1340
1414
 
1341
 
    Mac OSX does, Windows/Linux do not.
 
1415
    Only Mac OSX.
1342
1416
    """
1343
1417
    return _platform_normalizes_filenames
1344
1418
 
1349
1423
    On platforms where the system normalizes filenames (Mac OSX),
1350
1424
    you can access a file by any path which will normalize correctly.
1351
1425
    On platforms where the system does not normalize filenames
1352
 
    (Windows, Linux), you have to access a file by its exact path.
 
1426
    (everything else), you have to access a file by its exact path.
1353
1427
 
1354
1428
    Internally, bzr only supports NFC normalization, since that is
1355
1429
    the standard for XML documents.
1417
1491
terminal_width() returns None.
1418
1492
"""
1419
1493
 
 
1494
# Keep some state so that terminal_width can detect if _terminal_size has
 
1495
# returned a different size since the process started.  See docstring and
 
1496
# comments of terminal_width for details.
 
1497
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
 
1498
_terminal_size_state = 'no_data'
 
1499
_first_terminal_size = None
1420
1500
 
1421
1501
def terminal_width():
1422
1502
    """Return terminal width.
1426
1506
    The rules are:
1427
1507
    - if BZR_COLUMNS is set, returns its value
1428
1508
    - if there is no controlling terminal, returns None
 
1509
    - query the OS, if the queried size has changed since the last query,
 
1510
      return its value,
1429
1511
    - if COLUMNS is set, returns its value,
 
1512
    - if the OS has a value (even though it's never changed), return its value.
1430
1513
 
1431
1514
    From there, we need to query the OS to get the size of the controlling
1432
1515
    terminal.
1433
1516
 
1434
 
    Unices:
 
1517
    On Unices we query the OS by:
1435
1518
    - get termios.TIOCGWINSZ
1436
1519
    - if an error occurs or a negative value is obtained, returns None
1437
1520
 
1438
 
    Windows:
1439
 
    
 
1521
    On Windows we query the OS by:
1440
1522
    - win32utils.get_console_size() decides,
1441
1523
    - returns None on error (provided default value)
1442
1524
    """
 
1525
    # Note to implementors: if changing the rules for determining the width,
 
1526
    # make sure you've considered the behaviour in these cases:
 
1527
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
 
1528
    #  - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
 
1529
    #    0,0.
 
1530
    #  - (add more interesting cases here, if you find any)
 
1531
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
 
1532
    # but we don't want to register a signal handler because it is impossible
 
1533
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
 
1534
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
 
1535
    # time so we can notice if the reported size has changed, which should have
 
1536
    # a similar effect.
1443
1537
 
1444
1538
    # If BZR_COLUMNS is set, take it, user is always right
 
1539
    # Except if they specified 0 in which case, impose no limit here
1445
1540
    try:
1446
 
        return int(os.environ['BZR_COLUMNS'])
 
1541
        width = int(os.environ['BZR_COLUMNS'])
1447
1542
    except (KeyError, ValueError):
1448
 
        pass
 
1543
        width = None
 
1544
    if width is not None:
 
1545
        if width > 0:
 
1546
            return width
 
1547
        else:
 
1548
            return None
1449
1549
 
1450
1550
    isatty = getattr(sys.stdout, 'isatty', None)
1451
 
    if  isatty is None or not isatty():
 
1551
    if isatty is None or not isatty():
1452
1552
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1453
1553
        return None
1454
1554
 
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))
 
1555
    # Query the OS
 
1556
    width, height = os_size = _terminal_size(None, None)
 
1557
    global _first_terminal_size, _terminal_size_state
 
1558
    if _terminal_size_state == 'no_data':
 
1559
        _first_terminal_size = os_size
 
1560
        _terminal_size_state = 'unchanged'
 
1561
    elif (_terminal_size_state == 'unchanged' and
 
1562
          _first_terminal_size != os_size):
 
1563
        _terminal_size_state = 'changed'
 
1564
 
 
1565
    # If the OS claims to know how wide the terminal is, and this value has
 
1566
    # ever changed, use that.
 
1567
    if _terminal_size_state == 'changed':
 
1568
        if width is not None and width > 0:
 
1569
            return width
 
1570
 
 
1571
    # If COLUMNS is set, use it.
1458
1572
    try:
1459
1573
        return int(os.environ['COLUMNS'])
1460
1574
    except (KeyError, ValueError):
1461
1575
        pass
1462
1576
 
1463
 
    width, height = _terminal_size(None, None)
1464
 
    if width <= 0:
1465
 
        # Consider invalid values as meaning no width
1466
 
        return None
 
1577
    # Finally, use an unchanged size from the OS, if we have one.
 
1578
    if _terminal_size_state == 'unchanged':
 
1579
        if width is not None and width > 0:
 
1580
            return width
1467
1581
 
1468
 
    return width
 
1582
    # The width could not be determined.
 
1583
    return None
1469
1584
 
1470
1585
 
1471
1586
def _win32_terminal_size(width, height):
1498
1613
    _terminal_size = _ioctl_terminal_size
1499
1614
 
1500
1615
 
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
1616
def supports_executable():
1527
1617
    return sys.platform != "win32"
1528
1618
 
1651
1741
        dirblock = []
1652
1742
        append = dirblock.append
1653
1743
        try:
1654
 
            names = sorted(_listdir(top))
 
1744
            names = sorted(map(decode_filename, _listdir(top)))
1655
1745
        except OSError, e:
1656
1746
            if not _is_error_enotdir(e):
1657
1747
                raise
1711
1801
    """
1712
1802
    global _selected_dir_reader
1713
1803
    if _selected_dir_reader is None:
1714
 
        fs_encoding = _fs_enc.upper()
1715
1804
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1716
1805
            # Win98 doesn't have unicode apis like FindFirstFileW
1717
1806
            # TODO: We possibly could support Win98 by falling back to the
1723
1812
                _selected_dir_reader = Win32ReadDir()
1724
1813
            except ImportError:
1725
1814
                pass
1726
 
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1727
 
            # ANSI_X3.4-1968 is a form of ASCII
 
1815
        elif _fs_enc in ('utf-8', 'ascii'):
1728
1816
            try:
1729
1817
                from bzrlib._readdir_pyx import UTF8DirReader
1730
1818
                _selected_dir_reader = UTF8DirReader()
1865
1953
        s = os.stat(src)
1866
1954
        chown(dst, s.st_uid, s.st_gid)
1867
1955
    except OSError, e:
1868
 
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
 
1956
        trace.warning(
 
1957
            'Unable to copy ownership from "%s" to "%s". '
 
1958
            'You may want to set it manually.', src, dst)
 
1959
        trace.log_exception_quietly()
1869
1960
 
1870
1961
 
1871
1962
def path_prefix_key(path):
1959
2050
    return user_encoding
1960
2051
 
1961
2052
 
 
2053
def get_diff_header_encoding():
 
2054
    return get_terminal_encoding()
 
2055
 
 
2056
 
 
2057
_message_encoding = None
 
2058
 
 
2059
 
 
2060
def get_message_encoding():
 
2061
    """Return the encoding used for messages
 
2062
 
 
2063
    While the message encoding is a general setting it should usually only be
 
2064
    needed for decoding system error strings such as from OSError instances.
 
2065
    """
 
2066
    global _message_encoding
 
2067
    if _message_encoding is None:
 
2068
        if os.name == "posix":
 
2069
            import locale
 
2070
            # This is a process-global setting that can change, but should in
 
2071
            # general just get set once at process startup then be constant.
 
2072
            _message_encoding = locale.getlocale(locale.LC_MESSAGES)[1]
 
2073
        else:
 
2074
            # On windows want the result of GetACP() which this boils down to.
 
2075
            _message_encoding = get_user_encoding()
 
2076
    return _message_encoding or "ascii"
 
2077
        
 
2078
 
1962
2079
def get_host_name():
1963
2080
    """Return the current unicode host name.
1964
2081
 
1979
2096
# data at once.
1980
2097
MAX_SOCKET_CHUNK = 64 * 1024
1981
2098
 
 
2099
_end_of_stream_errors = [errno.ECONNRESET]
 
2100
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
 
2101
    _eno = getattr(errno, _eno, None)
 
2102
    if _eno is not None:
 
2103
        _end_of_stream_errors.append(_eno)
 
2104
del _eno
 
2105
 
 
2106
 
1982
2107
def read_bytes_from_socket(sock, report_activity=None,
1983
2108
        max_read_size=MAX_SOCKET_CHUNK):
1984
2109
    """Read up to max_read_size of bytes from sock and notify of progress.
1992
2117
            bytes = sock.recv(max_read_size)
1993
2118
        except socket.error, e:
1994
2119
            eno = e.args[0]
1995
 
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
 
2120
            if eno in _end_of_stream_errors:
1996
2121
                # The connection was closed by the other side.  Callers expect
1997
2122
                # an empty string to signal end-of-stream.
1998
2123
                return ""
2027
2152
 
2028
2153
def send_all(sock, bytes, report_activity=None):
2029
2154
    """Send all bytes on a socket.
2030
 
 
 
2155
 
2031
2156
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2032
2157
    some platforms, and catches EINTR which may be thrown if the send is
2033
2158
    interrupted by a signal.
2034
2159
 
2035
2160
    This is preferred to socket.sendall(), because it avoids portability bugs
2036
2161
    and provides activity reporting.
2037
 
 
 
2162
 
2038
2163
    :param report_activity: Call this as bytes are read, see
2039
2164
        Transport._report_activity
2040
2165
    """
2051
2176
            report_activity(sent, 'write')
2052
2177
 
2053
2178
 
 
2179
def connect_socket(address):
 
2180
    # Slight variation of the socket.create_connection() function (provided by
 
2181
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
 
2182
    # provide it for previous python versions. Also, we don't use the timeout
 
2183
    # parameter (provided by the python implementation) so we don't implement
 
2184
    # it either).
 
2185
    err = socket.error('getaddrinfo returns an empty list')
 
2186
    host, port = address
 
2187
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
 
2188
        af, socktype, proto, canonname, sa = res
 
2189
        sock = None
 
2190
        try:
 
2191
            sock = socket.socket(af, socktype, proto)
 
2192
            sock.connect(sa)
 
2193
            return sock
 
2194
 
 
2195
        except socket.error, err:
 
2196
            # 'err' is now the most recent error
 
2197
            if sock is not None:
 
2198
                sock.close()
 
2199
    raise err
 
2200
 
 
2201
 
2054
2202
def dereference_path(path):
2055
2203
    """Determine the real path to a file.
2056
2204
 
2095
2243
    base = dirname(bzrlib.__file__)
2096
2244
    if getattr(sys, 'frozen', None):    # bzr.exe
2097
2245
        base = abspath(pathjoin(base, '..', '..'))
2098
 
    filename = pathjoin(base, resource_relpath)
2099
 
    return open(filename, 'rU').read()
2100
 
 
 
2246
    f = file(pathjoin(base, resource_relpath), "rU")
 
2247
    try:
 
2248
        return f.read()
 
2249
    finally:
 
2250
        f.close()
2101
2251
 
2102
2252
def file_kind_from_stat_mode_thunk(mode):
2103
2253
    global file_kind_from_stat_mode
2114
2264
    return file_kind_from_stat_mode(mode)
2115
2265
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2116
2266
 
2117
 
 
2118
 
def file_kind(f, _lstat=os.lstat):
 
2267
def file_stat(f, _lstat=os.lstat):
2119
2268
    try:
2120
 
        return file_kind_from_stat_mode(_lstat(f).st_mode)
 
2269
        # XXX cache?
 
2270
        return _lstat(f)
2121
2271
    except OSError, e:
2122
2272
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2123
2273
            raise errors.NoSuchFile(f)
2124
2274
        raise
2125
2275
 
 
2276
def file_kind(f, _lstat=os.lstat):
 
2277
    stat_value = file_stat(f, _lstat)
 
2278
    return file_kind_from_stat_mode(stat_value.st_mode)
2126
2279
 
2127
2280
def until_no_eintr(f, *a, **kw):
2128
2281
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2129
 
    
 
2282
 
2130
2283
    WARNING: you must be certain that it is safe to retry the call repeatedly
2131
2284
    if EINTR does occur.  This is typically only true for low-level operations
2132
2285
    like os.read.  If in any doubt, don't use this.
2147
2300
            raise
2148
2301
 
2149
2302
 
 
2303
@deprecated_function(deprecated_in((2, 2, 0)))
2150
2304
def re_compile_checked(re_string, flags=0, where=""):
2151
2305
    """Return a compiled re, or raise a sensible error.
2152
2306
 
2162
2316
        re_obj = re.compile(re_string, flags)
2163
2317
        re_obj.search("")
2164
2318
        return re_obj
2165
 
    except re.error, e:
 
2319
    except errors.InvalidPattern, e:
2166
2320
        if where:
2167
2321
            where = ' in ' + where
2168
2322
        # despite the name 'error' is a type
2169
 
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2170
 
            % (where, re_string, e))
 
2323
        raise errors.BzrCommandError('Invalid regular expression%s: %s'
 
2324
            % (where, e.msg))
2171
2325
 
2172
2326
 
2173
2327
if sys.platform == "win32":
2187
2341
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2188
2342
        return ch
2189
2343
 
2190
 
 
2191
 
if sys.platform == 'linux2':
 
2344
if sys.platform.startswith('linux'):
2192
2345
    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
 
2346
        try:
 
2347
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2348
        except (ValueError, OSError, AttributeError):
 
2349
            return None
2199
2350
elif sys.platform == 'darwin':
2200
2351
    def _local_concurrency():
2201
2352
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2202
2353
                                stdout=subprocess.PIPE).communicate()[0]
2203
 
elif sys.platform[0:7] == 'freebsd':
 
2354
elif "bsd" in sys.platform:
2204
2355
    def _local_concurrency():
2205
2356
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2206
2357
                                stdout=subprocess.PIPE).communicate()[0]
2234
2385
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2235
2386
    if concurrency is None:
2236
2387
        try:
2237
 
            concurrency = _local_concurrency()
2238
 
        except (OSError, IOError):
2239
 
            pass
 
2388
            import multiprocessing
 
2389
            concurrency = multiprocessing.cpu_count()
 
2390
        except (ImportError, NotImplementedError):
 
2391
            # multiprocessing is only available on Python >= 2.6
 
2392
            # and multiprocessing.cpu_count() isn't implemented on all
 
2393
            # platforms
 
2394
            try:
 
2395
                concurrency = _local_concurrency()
 
2396
            except (OSError, IOError):
 
2397
                pass
2240
2398
    try:
2241
2399
        concurrency = int(concurrency)
2242
2400
    except (TypeError, ValueError):
2263
2421
if sys.platform == 'win32':
2264
2422
    def open_file(filename, mode='r', bufsize=-1):
2265
2423
        """This function is used to override the ``open`` builtin.
2266
 
        
 
2424
 
2267
2425
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2268
2426
        child processes.  Deleting or renaming a closed file opened with this
2269
2427
        function is not blocking child processes.
2302
2460
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2303
2461
else:
2304
2462
    open_file = open
 
2463
 
 
2464
 
 
2465
def available_backup_name(base, exists):
 
2466
    """Find a non-existing backup file name.
 
2467
 
 
2468
    This will *not* create anything, this only return a 'free' entry.  This
 
2469
    should be used for checking names in a directory below a locked
 
2470
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
 
2471
    Leap) and generally discouraged.
 
2472
 
 
2473
    :param base: The base name.
 
2474
 
 
2475
    :param exists: A callable returning True if the path parameter exists.
 
2476
    """
 
2477
    counter = 1
 
2478
    name = "%s.~%d~" % (base, counter)
 
2479
    while exists(name):
 
2480
        counter += 1
 
2481
        name = "%s.~%d~" % (base, counter)
 
2482
    return name
 
2483
 
 
2484
 
 
2485
def set_fd_cloexec(fd):
 
2486
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
 
2487
    support for this is not available.
 
2488
    """
 
2489
    try:
 
2490
        import fcntl
 
2491
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
 
2492
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
 
2493
    except (ImportError, AttributeError):
 
2494
        # Either the fcntl module or specific constants are not present
 
2495
        pass
 
2496
 
 
2497
 
 
2498
def find_executable_on_path(name):
 
2499
    """Finds an executable on the PATH.
 
2500
    
 
2501
    On Windows, this will try to append each extension in the PATHEXT
 
2502
    environment variable to the name, if it cannot be found with the name
 
2503
    as given.
 
2504
    
 
2505
    :param name: The base name of the executable.
 
2506
    :return: The path to the executable found or None.
 
2507
    """
 
2508
    path = os.environ.get('PATH')
 
2509
    if path is None:
 
2510
        return None
 
2511
    path = path.split(os.pathsep)
 
2512
    if sys.platform == 'win32':
 
2513
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
 
2514
        exts = [ext.lower() for ext in exts]
 
2515
        base, ext = os.path.splitext(name)
 
2516
        if ext != '':
 
2517
            if ext.lower() not in exts:
 
2518
                return None
 
2519
            name = base
 
2520
            exts = [ext]
 
2521
    else:
 
2522
        exts = ['']
 
2523
    for ext in exts:
 
2524
        for d in path:
 
2525
            f = os.path.join(d, name) + ext
 
2526
            if os.access(f, os.X_OK):
 
2527
                return f
 
2528
    return None
 
2529
 
 
2530
 
 
2531
def _posix_is_local_pid_dead(pid):
 
2532
    """True if pid doesn't correspond to live process on this machine"""
 
2533
    try:
 
2534
        # Special meaning of unix kill: just check if it's there.
 
2535
        os.kill(pid, 0)
 
2536
    except OSError, e:
 
2537
        if e.errno == errno.ESRCH:
 
2538
            # On this machine, and really not found: as sure as we can be
 
2539
            # that it's dead.
 
2540
            return True
 
2541
        elif e.errno == errno.EPERM:
 
2542
            # exists, though not ours
 
2543
            return False
 
2544
        else:
 
2545
            mutter("os.kill(%d, 0) failed: %s" % (pid, e))
 
2546
            # Don't really know.
 
2547
            return False
 
2548
    else:
 
2549
        # Exists and our process: not dead.
 
2550
        return False
 
2551
 
 
2552
if sys.platform == "win32":
 
2553
    is_local_pid_dead = win32utils.is_local_pid_dead
 
2554
else:
 
2555
    is_local_pid_dead = _posix_is_local_pid_dead
 
2556
 
 
2557
 
 
2558
def fdatasync(fileno):
 
2559
    """Flush file contents to disk if possible.
 
2560
    
 
2561
    :param fileno: Integer OS file handle.
 
2562
    :raises TransportNotPossible: If flushing to disk is not possible.
 
2563
    """
 
2564
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
 
2565
    if fn is not None:
 
2566
        fn(fileno)
 
2567
 
 
2568
 
 
2569
def ensure_empty_directory_exists(path, exception_class):
 
2570
    """Make sure a local directory exists and is empty.
 
2571
    
 
2572
    If it does not exist, it is created.  If it exists and is not empty, an
 
2573
    instance of exception_class is raised.
 
2574
    """
 
2575
    try:
 
2576
        os.mkdir(path)
 
2577
    except OSError, e:
 
2578
        if e.errno != errno.EEXIST:
 
2579
            raise
 
2580
        if os.listdir(path) != []:
 
2581
            raise exception_class(path)
 
2582
 
 
2583
 
 
2584
def is_environment_error(evalue):
 
2585
    """True if exception instance is due to a process environment issue
 
2586
 
 
2587
    This includes OSError and IOError, but also other errors that come from
 
2588
    the operating system or core libraries but are not subclasses of those.
 
2589
    """
 
2590
    if isinstance(evalue, (EnvironmentError, select.error)):
 
2591
        return True
 
2592
    if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
 
2593
        return True
 
2594
    return False