← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

(jelmer) Add a post_connect hook for transports. (Bazaar Developers)

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