/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/osutils.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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
18
17
import os
19
18
import re
20
19
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 getpass
29
 
import ntpath
 
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
35
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
34
36
import shutil
35
 
from shutil import rmtree
 
37
from shutil import (
 
38
    rmtree,
 
39
    )
36
40
import socket
37
41
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
40
42
import tempfile
41
 
from tempfile import mkdtemp
 
43
from tempfile import (
 
44
    mkdtemp,
 
45
    )
42
46
import unicodedata
43
47
 
44
48
from bzrlib import (
45
49
    cache_utf8,
46
 
    config,
47
50
    errors,
48
51
    trace,
49
52
    win32utils,
50
53
    )
51
 
from bzrlib.i18n import gettext
52
54
""")
53
55
 
54
56
from bzrlib.symbol_versioning import (
56
58
    deprecated_in,
57
59
    )
58
60
 
59
 
from hashlib import (
60
 
    md5,
61
 
    sha1 as sha,
62
 
    )
 
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
        )
63
73
 
64
74
 
65
75
import bzrlib
66
 
from bzrlib import symbol_versioning, _fs_enc
 
76
from bzrlib import symbol_versioning
67
77
 
68
78
 
69
79
# Cross platform wall-clock time functionality with decent resolution.
91
101
        user_encoding = get_user_encoding()
92
102
        return [a.decode(user_encoding) for a in sys.argv[1:]]
93
103
    except UnicodeDecodeError:
94
 
        raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
95
 
            "application locale.").format(a, user_encoding))
 
104
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
 
105
                                                            "encoding." % a))
96
106
 
97
107
 
98
108
def make_readonly(filename):
100
110
    mod = os.lstat(filename).st_mode
101
111
    if not stat.S_ISLNK(mod):
102
112
        mod = mod & 0777555
103
 
        chmod_if_possible(filename, mod)
 
113
        os.chmod(filename, mod)
104
114
 
105
115
 
106
116
def make_writable(filename):
107
117
    mod = os.lstat(filename).st_mode
108
118
    if not stat.S_ISLNK(mod):
109
119
        mod = mod | 0200
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
 
120
        os.chmod(filename, mod)
130
121
 
131
122
 
132
123
def minimum_path_selection(paths):
211
202
            if e.errno == errno.ENOENT:
212
203
                return False;
213
204
            else:
214
 
                raise errors.BzrError(gettext("lstat/stat of ({0!r}): {1!r}").format(f, e))
 
205
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
215
206
 
216
207
 
217
208
def fancy_rename(old, new, rename_func, unlink_func):
283
274
            else:
284
275
                rename_func(tmp_name, new)
285
276
    if failure_exc is not None:
286
 
        try:
287
 
            raise failure_exc[0], failure_exc[1], failure_exc[2]
288
 
        finally:
289
 
            del failure_exc
 
277
        raise failure_exc[0], failure_exc[1], failure_exc[2]
290
278
 
291
279
 
292
280
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
293
281
# choke on a Unicode string containing a relative path if
294
282
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
295
283
# string.
 
284
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
296
285
def _posix_abspath(path):
297
286
    # jam 20060426 rather than encoding to fsencoding
298
287
    # copy posixpath.abspath, but use os.getcwdu instead
299
288
    if not posixpath.isabs(path):
300
289
        path = posixpath.join(getcwd(), path)
301
 
    return _posix_normpath(path)
 
290
    return posixpath.normpath(path)
302
291
 
303
292
 
304
293
def _posix_realpath(path):
305
294
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
306
295
 
307
296
 
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
 
 
350
297
def _win32_fixdrive(path):
351
298
    """Force drive letters to be consistent.
352
299
 
356
303
    running python.exe under cmd.exe return capital C:\\
357
304
    running win32 python inside a cygwin shell returns lowercase c:\\
358
305
    """
359
 
    drive, path = ntpath.splitdrive(path)
 
306
    drive, path = _nt_splitdrive(path)
360
307
    return drive.upper() + path
361
308
 
362
309
 
363
310
def _win32_abspath(path):
364
 
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
365
 
    return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
 
311
    # Real _nt_abspath doesn't have a problem with a unicode cwd
 
312
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
366
313
 
367
314
 
368
315
def _win98_abspath(path):
379
326
    #   /path       => C:/path
380
327
    path = unicode(path)
381
328
    # check for absolute path
382
 
    drive = ntpath.splitdrive(path)[0]
 
329
    drive = _nt_splitdrive(path)[0]
383
330
    if drive == '' and path[:2] not in('//','\\\\'):
384
331
        cwd = os.getcwdu()
385
332
        # we cannot simply os.path.join cwd and path
386
333
        # because os.path.join('C:','/path') produce '/path'
387
334
        # and this is incorrect
388
335
        if path[:1] in ('/','\\'):
389
 
            cwd = ntpath.splitdrive(cwd)[0]
 
336
            cwd = _nt_splitdrive(cwd)[0]
390
337
            path = path[1:]
391
338
        path = cwd + '\\' + path
392
 
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
 
339
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
393
340
 
394
341
 
395
342
def _win32_realpath(path):
396
 
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
397
 
    return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
 
343
    # Real _nt_realpath doesn't have a problem with a unicode cwd
 
344
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
398
345
 
399
346
 
400
347
def _win32_pathjoin(*args):
401
 
    return ntpath.join(*args).replace('\\', '/')
 
348
    return _nt_join(*args).replace('\\', '/')
402
349
 
403
350
 
404
351
def _win32_normpath(path):
405
 
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
 
352
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
406
353
 
407
354
 
408
355
def _win32_getcwd():
413
360
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
414
361
 
415
362
 
 
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
 
416
371
def _win32_rename(old, new):
417
372
    """We expect to be able to atomically replace 'new' with old.
418
373
 
420
375
    and then deleted.
421
376
    """
422
377
    try:
423
 
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
 
378
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
424
379
    except OSError, e:
425
380
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
426
381
            # If we try to rename a non-existant file onto cwd, we get
431
386
        raise
432
387
 
433
388
 
 
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
 
434
399
def _mac_getcwd():
435
400
    return unicodedata.normalize('NFC', os.getcwdu())
436
401
 
440
405
abspath = _posix_abspath
441
406
realpath = _posix_realpath
442
407
pathjoin = os.path.join
443
 
normpath = _posix_normpath
444
 
path_from_environ = _posix_path_from_environ
445
 
getuser_unicode = _posix_getuser_unicode
 
408
normpath = os.path.normpath
 
409
rename = _wrapped_rename # overridden below on win32
446
410
getcwd = os.getcwdu
447
 
rename = os.rename
448
411
dirname = os.path.dirname
449
412
basename = os.path.basename
450
413
split = os.path.split
451
414
splitext = os.path.splitext
452
 
# These were already lazily imported into local scope
 
415
# These were already imported into local scope
453
416
# mkdtemp = tempfile.mkdtemp
454
417
# rmtree = shutil.rmtree
455
 
lstat = os.lstat
456
 
fstat = os.fstat
457
 
 
458
 
def wrap_stat(st):
459
 
    return st
460
 
 
461
418
 
462
419
MIN_ABS_PATHLENGTH = 1
463
420
 
473
430
    getcwd = _win32_getcwd
474
431
    mkdtemp = _win32_mkdtemp
475
432
    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
484
433
 
485
434
    MIN_ABS_PATHLENGTH = 3
486
435
 
504
453
    f = win32utils.get_unicode_argv     # special function or None
505
454
    if f is not None:
506
455
        get_unicode_argv = f
507
 
    path_from_environ = win32utils.get_environ_unicode
508
 
    getuser_unicode = win32utils.get_user_name
509
456
 
510
457
elif sys.platform == 'darwin':
511
458
    getcwd = _mac_getcwd
512
459
 
513
460
 
514
 
def get_terminal_encoding(trace=False):
 
461
def get_terminal_encoding():
515
462
    """Find the best encoding for printing to the screen.
516
463
 
517
464
    This attempts to check both sys.stdout and sys.stdin to see
523
470
 
524
471
    On my standard US Windows XP, the preferred encoding is
525
472
    cp1252, but the console is cp437
526
 
 
527
 
    :param trace: If True trace the selected encoding via mutter().
528
473
    """
529
474
    from bzrlib.trace import mutter
530
475
    output_encoding = getattr(sys.stdout, 'encoding', None)
532
477
        input_encoding = getattr(sys.stdin, 'encoding', None)
533
478
        if not input_encoding:
534
479
            output_encoding = get_user_encoding()
535
 
            if trace:
536
 
                mutter('encoding stdout as osutils.get_user_encoding() %r',
 
480
            mutter('encoding stdout as osutils.get_user_encoding() %r',
537
481
                   output_encoding)
538
482
        else:
539
483
            output_encoding = input_encoding
540
 
            if trace:
541
 
                mutter('encoding stdout as sys.stdin encoding %r',
542
 
                    output_encoding)
 
484
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
543
485
    else:
544
 
        if trace:
545
 
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
486
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
546
487
    if output_encoding == 'cp0':
547
488
        # invalid encoding (cp0 means 'no codepage' on Windows)
548
489
        output_encoding = get_user_encoding()
549
 
        if trace:
550
 
            mutter('cp0 is invalid encoding.'
 
490
        mutter('cp0 is invalid encoding.'
551
491
               ' encoding stdout as osutils.get_user_encoding() %r',
552
492
               output_encoding)
553
493
    # check encoding
579
519
def isdir(f):
580
520
    """True if f is an accessible directory."""
581
521
    try:
582
 
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
 
522
        return S_ISDIR(os.lstat(f)[ST_MODE])
583
523
    except OSError:
584
524
        return False
585
525
 
587
527
def isfile(f):
588
528
    """True if f is a regular file."""
589
529
    try:
590
 
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
 
530
        return S_ISREG(os.lstat(f)[ST_MODE])
591
531
    except OSError:
592
532
        return False
593
533
 
594
534
def islink(f):
595
535
    """True if f is a symlink."""
596
536
    try:
597
 
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
 
537
        return S_ISLNK(os.lstat(f)[ST_MODE])
598
538
    except OSError:
599
539
        return False
600
540
 
940
880
 
941
881
def filesize(f):
942
882
    """Return size of given open file."""
943
 
    return os.fstat(f.fileno())[stat.ST_SIZE]
 
883
    return os.fstat(f.fileno())[ST_SIZE]
944
884
 
945
885
 
946
886
# Define rand_bytes based on platform.
991
931
    rps = []
992
932
    for f in ps:
993
933
        if f == '..':
994
 
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
 
934
            raise errors.BzrError("sorry, %r not allowed in path" % f)
995
935
        elif (f == '.') or (f == ''):
996
936
            pass
997
937
        else:
1002
942
def joinpath(p):
1003
943
    for f in p:
1004
944
        if (f == '..') or (f is None) or (f == ''):
1005
 
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
 
945
            raise errors.BzrError("sorry, %r not allowed in path" % f)
1006
946
    return pathjoin(*p)
1007
947
 
1008
948
 
1009
949
def parent_directories(filename):
1010
950
    """Return the list of parent directories, deepest first.
1011
 
 
 
951
    
1012
952
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
1013
953
    """
1014
954
    parents = []
1038
978
    # NB: This docstring is just an example, not a doctest, because doctest
1039
979
    # currently can't cope with the use of lazy imports in this namespace --
1040
980
    # mbp 20090729
1041
 
 
 
981
    
1042
982
    # This currently doesn't report the failure at the time it occurs, because
1043
983
    # they tend to happen very early in startup when we can't check config
1044
984
    # files etc, and also we want to report all failures but not spam the user
1045
985
    # with 10 warnings.
 
986
    from bzrlib import trace
1046
987
    exception_str = str(exception)
1047
988
    if exception_str not in _extension_load_failures:
1048
989
        trace.mutter("failed to load compiled extension: %s" % exception_str)
1052
993
def report_extension_load_failures():
1053
994
    if not _extension_load_failures:
1054
995
        return
1055
 
    if config.GlobalStack().get('ignore_missing_extensions'):
 
996
    from bzrlib.config import GlobalConfig
 
997
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
1056
998
        return
1057
999
    # the warnings framework should by default show this only once
1058
1000
    from bzrlib.trace import warning
1112
1054
 
1113
1055
 
1114
1056
def delete_any(path):
1115
 
    """Delete a file, symlink or directory.
1116
 
 
 
1057
    """Delete a file, symlink or directory.  
 
1058
    
1117
1059
    Will delete even if readonly.
1118
1060
    """
1119
1061
    try:
1220
1162
 
1221
1163
    if len(base) < MIN_ABS_PATHLENGTH:
1222
1164
        # must have space for e.g. a drive letter
1223
 
        raise ValueError(gettext('%r is too short to calculate a relative path')
 
1165
        raise ValueError('%r is too short to calculate a relative path'
1224
1166
            % (base,))
1225
1167
 
1226
1168
    rp = abspath(path)
1308
1250
    # but for now, we haven't optimized...
1309
1251
    return [canonical_relpath(base, p) for p in paths]
1310
1252
 
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
 
 
1327
1253
def safe_unicode(unicode_or_utf8_string):
1328
1254
    """Coerce unicode_or_utf8_string into unicode.
1329
1255
 
1412
1338
def normalizes_filenames():
1413
1339
    """Return True if this platform normalizes unicode filenames.
1414
1340
 
1415
 
    Only Mac OSX.
 
1341
    Mac OSX does, Windows/Linux do not.
1416
1342
    """
1417
1343
    return _platform_normalizes_filenames
1418
1344
 
1423
1349
    On platforms where the system normalizes filenames (Mac OSX),
1424
1350
    you can access a file by any path which will normalize correctly.
1425
1351
    On platforms where the system does not normalize filenames
1426
 
    (everything else), you have to access a file by its exact path.
 
1352
    (Windows, Linux), you have to access a file by its exact path.
1427
1353
 
1428
1354
    Internally, bzr only supports NFC normalization, since that is
1429
1355
    the standard for XML documents.
1491
1417
terminal_width() returns None.
1492
1418
"""
1493
1419
 
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
1500
1420
 
1501
1421
def terminal_width():
1502
1422
    """Return terminal width.
1506
1426
    The rules are:
1507
1427
    - if BZR_COLUMNS is set, returns its value
1508
1428
    - 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,
1511
1429
    - if COLUMNS is set, returns its value,
1512
 
    - if the OS has a value (even though it's never changed), return its value.
1513
1430
 
1514
1431
    From there, we need to query the OS to get the size of the controlling
1515
1432
    terminal.
1516
1433
 
1517
 
    On Unices we query the OS by:
 
1434
    Unices:
1518
1435
    - get termios.TIOCGWINSZ
1519
1436
    - if an error occurs or a negative value is obtained, returns None
1520
1437
 
1521
 
    On Windows we query the OS by:
 
1438
    Windows:
 
1439
    
1522
1440
    - win32utils.get_console_size() decides,
1523
1441
    - returns None on error (provided default value)
1524
1442
    """
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.
1537
1443
 
1538
1444
    # If BZR_COLUMNS is set, take it, user is always right
1539
 
    # Except if they specified 0 in which case, impose no limit here
1540
1445
    try:
1541
 
        width = int(os.environ['BZR_COLUMNS'])
 
1446
        return int(os.environ['BZR_COLUMNS'])
1542
1447
    except (KeyError, ValueError):
1543
 
        width = None
1544
 
    if width is not None:
1545
 
        if width > 0:
1546
 
            return width
1547
 
        else:
1548
 
            return None
 
1448
        pass
1549
1449
 
1550
1450
    isatty = getattr(sys.stdout, 'isatty', None)
1551
 
    if isatty is None or not isatty():
 
1451
    if  isatty is None or not isatty():
1552
1452
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1553
1453
        return None
1554
1454
 
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.
 
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))
1572
1458
    try:
1573
1459
        return int(os.environ['COLUMNS'])
1574
1460
    except (KeyError, ValueError):
1575
1461
        pass
1576
1462
 
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
 
1463
    width, height = _terminal_size(None, None)
 
1464
    if width <= 0:
 
1465
        # Consider invalid values as meaning no width
 
1466
        return None
1581
1467
 
1582
 
    # The width could not be determined.
1583
 
    return None
 
1468
    return width
1584
1469
 
1585
1470
 
1586
1471
def _win32_terminal_size(width, height):
1613
1498
    _terminal_size = _ioctl_terminal_size
1614
1499
 
1615
1500
 
 
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
 
1616
1526
def supports_executable():
1617
1527
    return sys.platform != "win32"
1618
1528
 
1741
1651
        dirblock = []
1742
1652
        append = dirblock.append
1743
1653
        try:
1744
 
            names = sorted(map(decode_filename, _listdir(top)))
 
1654
            names = sorted(_listdir(top))
1745
1655
        except OSError, e:
1746
1656
            if not _is_error_enotdir(e):
1747
1657
                raise
1801
1711
    """
1802
1712
    global _selected_dir_reader
1803
1713
    if _selected_dir_reader is None:
 
1714
        fs_encoding = _fs_enc.upper()
1804
1715
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1805
1716
            # Win98 doesn't have unicode apis like FindFirstFileW
1806
1717
            # TODO: We possibly could support Win98 by falling back to the
1812
1723
                _selected_dir_reader = Win32ReadDir()
1813
1724
            except ImportError:
1814
1725
                pass
1815
 
        elif _fs_enc in ('utf-8', 'ascii'):
 
1726
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
 
1727
            # ANSI_X3.4-1968 is a form of ASCII
1816
1728
            try:
1817
1729
                from bzrlib._readdir_pyx import UTF8DirReader
1818
1730
                _selected_dir_reader = UTF8DirReader()
1953
1865
        s = os.stat(src)
1954
1866
        chown(dst, s.st_uid, s.st_gid)
1955
1867
    except OSError, 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()
 
1868
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
1960
1869
 
1961
1870
 
1962
1871
def path_prefix_key(path):
2050
1959
    return user_encoding
2051
1960
 
2052
1961
 
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
 
 
2079
1962
def get_host_name():
2080
1963
    """Return the current unicode host name.
2081
1964
 
2096
1979
# data at once.
2097
1980
MAX_SOCKET_CHUNK = 64 * 1024
2098
1981
 
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
 
 
2107
1982
def read_bytes_from_socket(sock, report_activity=None,
2108
1983
        max_read_size=MAX_SOCKET_CHUNK):
2109
1984
    """Read up to max_read_size of bytes from sock and notify of progress.
2117
1992
            bytes = sock.recv(max_read_size)
2118
1993
        except socket.error, e:
2119
1994
            eno = e.args[0]
2120
 
            if eno in _end_of_stream_errors:
 
1995
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
2121
1996
                # The connection was closed by the other side.  Callers expect
2122
1997
                # an empty string to signal end-of-stream.
2123
1998
                return ""
2152
2027
 
2153
2028
def send_all(sock, bytes, report_activity=None):
2154
2029
    """Send all bytes on a socket.
2155
 
 
 
2030
 
2156
2031
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2157
2032
    some platforms, and catches EINTR which may be thrown if the send is
2158
2033
    interrupted by a signal.
2159
2034
 
2160
2035
    This is preferred to socket.sendall(), because it avoids portability bugs
2161
2036
    and provides activity reporting.
2162
 
 
 
2037
 
2163
2038
    :param report_activity: Call this as bytes are read, see
2164
2039
        Transport._report_activity
2165
2040
    """
2176
2051
            report_activity(sent, 'write')
2177
2052
 
2178
2053
 
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
 
 
2202
2054
def dereference_path(path):
2203
2055
    """Determine the real path to a file.
2204
2056
 
2243
2095
    base = dirname(bzrlib.__file__)
2244
2096
    if getattr(sys, 'frozen', None):    # bzr.exe
2245
2097
        base = abspath(pathjoin(base, '..', '..'))
2246
 
    f = file(pathjoin(base, resource_relpath), "rU")
2247
 
    try:
2248
 
        return f.read()
2249
 
    finally:
2250
 
        f.close()
 
2098
    filename = pathjoin(base, resource_relpath)
 
2099
    return open(filename, 'rU').read()
 
2100
 
2251
2101
 
2252
2102
def file_kind_from_stat_mode_thunk(mode):
2253
2103
    global file_kind_from_stat_mode
2264
2114
    return file_kind_from_stat_mode(mode)
2265
2115
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2266
2116
 
2267
 
def file_stat(f, _lstat=os.lstat):
 
2117
 
 
2118
def file_kind(f, _lstat=os.lstat):
2268
2119
    try:
2269
 
        # XXX cache?
2270
 
        return _lstat(f)
 
2120
        return file_kind_from_stat_mode(_lstat(f).st_mode)
2271
2121
    except OSError, e:
2272
2122
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2273
2123
            raise errors.NoSuchFile(f)
2274
2124
        raise
2275
2125
 
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)
2279
2126
 
2280
2127
def until_no_eintr(f, *a, **kw):
2281
2128
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2282
 
 
 
2129
    
2283
2130
    WARNING: you must be certain that it is safe to retry the call repeatedly
2284
2131
    if EINTR does occur.  This is typically only true for low-level operations
2285
2132
    like os.read.  If in any doubt, don't use this.
2300
2147
            raise
2301
2148
 
2302
2149
 
2303
 
@deprecated_function(deprecated_in((2, 2, 0)))
2304
2150
def re_compile_checked(re_string, flags=0, where=""):
2305
2151
    """Return a compiled re, or raise a sensible error.
2306
2152
 
2316
2162
        re_obj = re.compile(re_string, flags)
2317
2163
        re_obj.search("")
2318
2164
        return re_obj
2319
 
    except errors.InvalidPattern, e:
 
2165
    except re.error, e:
2320
2166
        if where:
2321
2167
            where = ' in ' + where
2322
2168
        # despite the name 'error' is a type
2323
 
        raise errors.BzrCommandError('Invalid regular expression%s: %s'
2324
 
            % (where, e.msg))
 
2169
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
 
2170
            % (where, re_string, e))
2325
2171
 
2326
2172
 
2327
2173
if sys.platform == "win32":
2341
2187
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2342
2188
        return ch
2343
2189
 
2344
 
if sys.platform.startswith('linux'):
 
2190
 
 
2191
if sys.platform == 'linux2':
2345
2192
    def _local_concurrency():
2346
 
        try:
2347
 
            return os.sysconf('SC_NPROCESSORS_ONLN')
2348
 
        except (ValueError, OSError, AttributeError):
2349
 
            return None
 
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
2350
2199
elif sys.platform == 'darwin':
2351
2200
    def _local_concurrency():
2352
2201
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2353
2202
                                stdout=subprocess.PIPE).communicate()[0]
2354
 
elif "bsd" in sys.platform:
 
2203
elif sys.platform[0:7] == 'freebsd':
2355
2204
    def _local_concurrency():
2356
2205
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2357
2206
                                stdout=subprocess.PIPE).communicate()[0]
2385
2234
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2386
2235
    if concurrency is None:
2387
2236
        try:
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
 
2237
            concurrency = _local_concurrency()
 
2238
        except (OSError, IOError):
 
2239
            pass
2398
2240
    try:
2399
2241
        concurrency = int(concurrency)
2400
2242
    except (TypeError, ValueError):
2421
2263
if sys.platform == 'win32':
2422
2264
    def open_file(filename, mode='r', bufsize=-1):
2423
2265
        """This function is used to override the ``open`` builtin.
2424
 
 
 
2266
        
2425
2267
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2426
2268
        child processes.  Deleting or renaming a closed file opened with this
2427
2269
        function is not blocking child processes.
2460
2302
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2461
2303
else:
2462
2304
    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