/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: Martin Packman
  • Date: 2011-12-19 10:37:57 UTC
  • mto: This revision was merged to the branch mainline in revision 6394.
  • Revision ID: martin.packman@canonical.com-20111219103757-b85as9n9pb7e6qvn
Add tests for deprecated unicode wrapper functions in win32utils

Show diffs side-by-side

added added

removed removed

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