/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 brzlib/osutils.py

  • Committer: Jelmer Vernooij
  • Date: 2017-05-21 12:41:27 UTC
  • mto: This revision was merged to the branch mainline in revision 6623.
  • Revision ID: jelmer@jelmer.uk-20170521124127-iv8etg0vwymyai6y
s/bzr/brz/ in apport config.

Show diffs side-by-side

added added

removed removed

Lines of Context:
brzlib/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
24
26
 
25
 
from bzrlib.lazy_import import lazy_import
 
27
from brzlib.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
from datetime import timedelta
 
31
import getpass
 
32
import locale
 
33
import ntpath
35
34
import posixpath
 
35
import select
 
36
# We need to import both shutil and rmtree as we export the later on posix
 
37
# and need the former on windows
36
38
import shutil
37
 
from shutil import (
38
 
    rmtree,
39
 
    )
 
39
from shutil import rmtree
40
40
import socket
41
41
import subprocess
 
42
# We need to import both tempfile and mkdtemp as we export the later on posix
 
43
# and need the former on windows
42
44
import tempfile
43
 
from tempfile import (
44
 
    mkdtemp,
45
 
    )
 
45
from tempfile import mkdtemp
46
46
import unicodedata
47
47
 
48
 
from bzrlib import (
 
48
from brzlib import (
49
49
    cache_utf8,
 
50
    config,
50
51
    errors,
51
52
    trace,
52
53
    win32utils,
53
54
    )
 
55
from brzlib.i18n import gettext
54
56
""")
55
57
 
56
 
from bzrlib.symbol_versioning import (
 
58
from brzlib.symbol_versioning import (
 
59
    DEPRECATED_PARAMETER,
57
60
    deprecated_function,
58
61
    deprecated_in,
59
 
    )
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
 
        )
73
 
 
74
 
 
75
 
import bzrlib
76
 
from bzrlib import symbol_versioning
 
62
    deprecated_passed,
 
63
    warn as warn_deprecated,
 
64
    )
 
65
 
 
66
from hashlib import (
 
67
    md5,
 
68
    sha1 as sha,
 
69
    )
 
70
 
 
71
 
 
72
import brzlib
 
73
from brzlib import symbol_versioning, _fs_enc
77
74
 
78
75
 
79
76
# Cross platform wall-clock time functionality with decent resolution.
101
98
        user_encoding = get_user_encoding()
102
99
        return [a.decode(user_encoding) for a in sys.argv[1:]]
103
100
    except UnicodeDecodeError:
104
 
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
105
 
                                                            "encoding." % a))
 
101
        raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
 
102
            "application locale.").format(a, user_encoding))
106
103
 
107
104
 
108
105
def make_readonly(filename):
110
107
    mod = os.lstat(filename).st_mode
111
108
    if not stat.S_ISLNK(mod):
112
109
        mod = mod & 0777555
113
 
        os.chmod(filename, mod)
 
110
        chmod_if_possible(filename, mod)
114
111
 
115
112
 
116
113
def make_writable(filename):
117
114
    mod = os.lstat(filename).st_mode
118
115
    if not stat.S_ISLNK(mod):
119
116
        mod = mod | 0200
120
 
        os.chmod(filename, mod)
 
117
        chmod_if_possible(filename, mod)
 
118
 
 
119
 
 
120
def chmod_if_possible(filename, mode):
 
121
    # Set file mode if that can be safely done.
 
122
    # Sometimes even on unix the filesystem won't allow it - see
 
123
    # https://bugs.launchpad.net/bzr/+bug/606537
 
124
    try:
 
125
        # It is probably faster to just do the chmod, rather than
 
126
        # doing a stat, and then trying to compare
 
127
        os.chmod(filename, mode)
 
128
    except (IOError, OSError),e:
 
129
        # Permission/access denied seems to commonly happen on smbfs; there's
 
130
        # probably no point warning about it.
 
131
        # <https://bugs.launchpad.net/bzr/+bug/606537>
 
132
        if getattr(e, 'errno') in (errno.EPERM, errno.EACCES):
 
133
            trace.mutter("ignore error on chmod of %r: %r" % (
 
134
                filename, e))
 
135
            return
 
136
        raise
121
137
 
122
138
 
123
139
def minimum_path_selection(paths):
202
218
            if e.errno == errno.ENOENT:
203
219
                return False;
204
220
            else:
205
 
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
 
221
                raise errors.BzrError(gettext("lstat/stat of ({0!r}): {1!r}").format(f, e))
206
222
 
207
223
 
208
224
def fancy_rename(old, new, rename_func, unlink_func):
274
290
            else:
275
291
                rename_func(tmp_name, new)
276
292
    if failure_exc is not None:
277
 
        raise failure_exc[0], failure_exc[1], failure_exc[2]
 
293
        try:
 
294
            raise failure_exc[0], failure_exc[1], failure_exc[2]
 
295
        finally:
 
296
            del failure_exc
278
297
 
279
298
 
280
299
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
281
300
# choke on a Unicode string containing a relative path if
282
301
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
283
302
# string.
284
 
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
285
303
def _posix_abspath(path):
286
304
    # jam 20060426 rather than encoding to fsencoding
287
305
    # copy posixpath.abspath, but use os.getcwdu instead
288
306
    if not posixpath.isabs(path):
289
307
        path = posixpath.join(getcwd(), path)
290
 
    return posixpath.normpath(path)
 
308
    return _posix_normpath(path)
291
309
 
292
310
 
293
311
def _posix_realpath(path):
294
312
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
295
313
 
296
314
 
 
315
def _posix_normpath(path):
 
316
    path = posixpath.normpath(path)
 
317
    # Bug 861008: posixpath.normpath() returns a path normalized according to
 
318
    # the POSIX standard, which stipulates (for compatibility reasons) that two
 
319
    # leading slashes must not be simplified to one, and only if there are 3 or
 
320
    # more should they be simplified as one. So we treat the leading 2 slashes
 
321
    # as a special case here by simply removing the first slash, as we consider
 
322
    # that breaking POSIX compatibility for this obscure feature is acceptable.
 
323
    # This is not a paranoid precaution, as we notably get paths like this when
 
324
    # the repo is hosted at the root of the filesystem, i.e. in "/".    
 
325
    if path.startswith('//'):
 
326
        path = path[1:]
 
327
    return path
 
328
 
 
329
 
 
330
def _posix_path_from_environ(key):
 
331
    """Get unicode path from `key` in environment or None if not present
 
332
 
 
333
    Note that posix systems use arbitrary byte strings for filesystem objects,
 
334
    so a path that raises BadFilenameEncoding here may still be accessible.
 
335
    """
 
336
    val = os.environ.get(key, None)
 
337
    if val is None:
 
338
        return val
 
339
    try:
 
340
        return val.decode(_fs_enc)
 
341
    except UnicodeDecodeError:
 
342
        # GZ 2011-12-12:Ideally want to include `key` in the exception message
 
343
        raise errors.BadFilenameEncoding(val, _fs_enc)
 
344
 
 
345
 
 
346
def _posix_get_home_dir():
 
347
    """Get the home directory of the current user as a unicode path"""
 
348
    path = posixpath.expanduser("~")
 
349
    try:
 
350
        return path.decode(_fs_enc)
 
351
    except UnicodeDecodeError:
 
352
        raise errors.BadFilenameEncoding(path, _fs_enc)
 
353
 
 
354
 
 
355
def _posix_getuser_unicode():
 
356
    """Get username from environment or password database as unicode"""
 
357
    name = getpass.getuser()
 
358
    user_encoding = get_user_encoding()
 
359
    try:
 
360
        return name.decode(user_encoding)
 
361
    except UnicodeDecodeError:
 
362
        raise errors.BzrError("Encoding of username %r is unsupported by %s "
 
363
            "application locale." % (name, user_encoding))
 
364
 
 
365
 
297
366
def _win32_fixdrive(path):
298
367
    """Force drive letters to be consistent.
299
368
 
303
372
    running python.exe under cmd.exe return capital C:\\
304
373
    running win32 python inside a cygwin shell returns lowercase c:\\
305
374
    """
306
 
    drive, path = _nt_splitdrive(path)
 
375
    drive, path = ntpath.splitdrive(path)
307
376
    return drive.upper() + path
308
377
 
309
378
 
310
379
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('\\', '/'))
 
380
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
 
381
    return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
313
382
 
314
383
 
315
384
def _win98_abspath(path):
326
395
    #   /path       => C:/path
327
396
    path = unicode(path)
328
397
    # check for absolute path
329
 
    drive = _nt_splitdrive(path)[0]
 
398
    drive = ntpath.splitdrive(path)[0]
330
399
    if drive == '' and path[:2] not in('//','\\\\'):
331
400
        cwd = os.getcwdu()
332
401
        # we cannot simply os.path.join cwd and path
333
402
        # because os.path.join('C:','/path') produce '/path'
334
403
        # and this is incorrect
335
404
        if path[:1] in ('/','\\'):
336
 
            cwd = _nt_splitdrive(cwd)[0]
 
405
            cwd = ntpath.splitdrive(cwd)[0]
337
406
            path = path[1:]
338
407
        path = cwd + '\\' + path
339
 
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
 
408
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
340
409
 
341
410
 
342
411
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('\\', '/'))
 
412
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
 
413
    return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
345
414
 
346
415
 
347
416
def _win32_pathjoin(*args):
348
 
    return _nt_join(*args).replace('\\', '/')
 
417
    return ntpath.join(*args).replace('\\', '/')
349
418
 
350
419
 
351
420
def _win32_normpath(path):
352
 
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
421
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
353
422
 
354
423
 
355
424
def _win32_getcwd():
360
429
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
361
430
 
362
431
 
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
432
def _win32_rename(old, new):
372
433
    """We expect to be able to atomically replace 'new' with old.
373
434
 
375
436
    and then deleted.
376
437
    """
377
438
    try:
378
 
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
 
439
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
379
440
    except OSError, e:
380
441
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
381
442
            # If we try to rename a non-existant file onto cwd, we get
386
447
        raise
387
448
 
388
449
 
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
450
def _mac_getcwd():
400
451
    return unicodedata.normalize('NFC', os.getcwdu())
401
452
 
402
453
 
 
454
def _rename_wrap_exception(rename_func):
 
455
    """Adds extra information to any exceptions that come from rename().
 
456
 
 
457
    The exception has an updated message and 'old_filename' and 'new_filename'
 
458
    attributes.
 
459
    """
 
460
 
 
461
    def _rename_wrapper(old, new):
 
462
        try:
 
463
            rename_func(old, new)
 
464
        except OSError, e:
 
465
            detailed_error = OSError(e.errno, e.strerror +
 
466
                                " [occurred when renaming '%s' to '%s']" %
 
467
                                (old, new))
 
468
            detailed_error.old_filename = old
 
469
            detailed_error.new_filename = new
 
470
            raise detailed_error
 
471
 
 
472
    return _rename_wrapper
 
473
 
 
474
# Default rename wraps os.rename()
 
475
rename = _rename_wrap_exception(os.rename)
 
476
 
403
477
# Default is to just use the python builtins, but these can be rebound on
404
478
# particular platforms.
405
479
abspath = _posix_abspath
406
480
realpath = _posix_realpath
407
481
pathjoin = os.path.join
408
 
normpath = os.path.normpath
409
 
rename = _wrapped_rename # overridden below on win32
 
482
normpath = _posix_normpath
 
483
path_from_environ = _posix_path_from_environ
 
484
_get_home_dir = _posix_get_home_dir
 
485
getuser_unicode = _posix_getuser_unicode
410
486
getcwd = os.getcwdu
411
487
dirname = os.path.dirname
412
488
basename = os.path.basename
413
489
split = os.path.split
414
490
splitext = os.path.splitext
415
 
# These were already imported into local scope
 
491
# These were already lazily imported into local scope
416
492
# mkdtemp = tempfile.mkdtemp
417
493
# rmtree = shutil.rmtree
 
494
lstat = os.lstat
 
495
fstat = os.fstat
 
496
 
 
497
def wrap_stat(st):
 
498
    return st
 
499
 
418
500
 
419
501
MIN_ABS_PATHLENGTH = 1
420
502
 
429
511
    normpath = _win32_normpath
430
512
    getcwd = _win32_getcwd
431
513
    mkdtemp = _win32_mkdtemp
432
 
    rename = _win32_rename
 
514
    rename = _rename_wrap_exception(_win32_rename)
 
515
    try:
 
516
        from brzlib import _walkdirs_win32
 
517
    except ImportError:
 
518
        pass
 
519
    else:
 
520
        lstat = _walkdirs_win32.lstat
 
521
        fstat = _walkdirs_win32.fstat
 
522
        wrap_stat = _walkdirs_win32.wrap_stat
433
523
 
434
524
    MIN_ABS_PATHLENGTH = 3
435
525
 
453
543
    f = win32utils.get_unicode_argv     # special function or None
454
544
    if f is not None:
455
545
        get_unicode_argv = f
 
546
    path_from_environ = win32utils.get_environ_unicode
 
547
    _get_home_dir = win32utils.get_home_location
 
548
    getuser_unicode = win32utils.get_user_name
456
549
 
457
550
elif sys.platform == 'darwin':
458
551
    getcwd = _mac_getcwd
459
552
 
460
553
 
461
 
def get_terminal_encoding():
 
554
def get_terminal_encoding(trace=False):
462
555
    """Find the best encoding for printing to the screen.
463
556
 
464
557
    This attempts to check both sys.stdout and sys.stdin to see
470
563
 
471
564
    On my standard US Windows XP, the preferred encoding is
472
565
    cp1252, but the console is cp437
 
566
 
 
567
    :param trace: If True trace the selected encoding via mutter().
473
568
    """
474
 
    from bzrlib.trace import mutter
 
569
    from brzlib.trace import mutter
475
570
    output_encoding = getattr(sys.stdout, 'encoding', None)
476
571
    if not output_encoding:
477
572
        input_encoding = getattr(sys.stdin, 'encoding', None)
478
573
        if not input_encoding:
479
574
            output_encoding = get_user_encoding()
480
 
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
575
            if trace:
 
576
                mutter('encoding stdout as osutils.get_user_encoding() %r',
481
577
                   output_encoding)
482
578
        else:
483
579
            output_encoding = input_encoding
484
 
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
580
            if trace:
 
581
                mutter('encoding stdout as sys.stdin encoding %r',
 
582
                    output_encoding)
485
583
    else:
486
 
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
584
        if trace:
 
585
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
487
586
    if output_encoding == 'cp0':
488
587
        # invalid encoding (cp0 means 'no codepage' on Windows)
489
588
        output_encoding = get_user_encoding()
490
 
        mutter('cp0 is invalid encoding.'
 
589
        if trace:
 
590
            mutter('cp0 is invalid encoding.'
491
591
               ' encoding stdout as osutils.get_user_encoding() %r',
492
592
               output_encoding)
493
593
    # check encoding
494
594
    try:
495
595
        codecs.lookup(output_encoding)
496
596
    except LookupError:
497
 
        sys.stderr.write('bzr: warning:'
 
597
        sys.stderr.write('brz: warning:'
498
598
                         ' unknown terminal encoding %s.\n'
499
599
                         '  Using encoding %s instead.\n'
500
600
                         % (output_encoding, get_user_encoding())
519
619
def isdir(f):
520
620
    """True if f is an accessible directory."""
521
621
    try:
522
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
622
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
523
623
    except OSError:
524
624
        return False
525
625
 
527
627
def isfile(f):
528
628
    """True if f is a regular file."""
529
629
    try:
530
 
        return S_ISREG(os.lstat(f)[ST_MODE])
 
630
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
531
631
    except OSError:
532
632
        return False
533
633
 
534
634
def islink(f):
535
635
    """True if f is a symlink."""
536
636
    try:
537
 
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
637
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
538
638
    except OSError:
539
639
        return False
540
640
 
728
828
            return True
729
829
 
730
830
 
 
831
def gmtime(seconds=None):
 
832
    """Convert seconds since the Epoch to a time tuple expressing UTC (a.k.a.
 
833
    GMT). When 'seconds' is not passed in, convert the current time instead.
 
834
    Handy replacement for time.gmtime() buggy on Windows and 32-bit platforms.
 
835
    """
 
836
    if seconds is None:
 
837
        seconds = time.time()
 
838
    return (datetime(1970, 1, 1) + timedelta(seconds=seconds)).timetuple()
 
839
 
 
840
 
731
841
def local_time_offset(t=None):
732
842
    """Return offset of local zone from GMT, either at present or at time t."""
733
843
    if t is None:
773
883
    """
774
884
    if offset is None:
775
885
        offset = 0
776
 
    tt = time.gmtime(t + offset)
 
886
    tt = gmtime(t + offset)
777
887
    date_fmt = _default_format_by_weekday_num[tt[6]]
778
888
    date_str = time.strftime(date_fmt, tt)
779
889
    offset_str = _cache.get(offset, None)
805
915
 
806
916
def _format_date(t, offset, timezone, date_fmt, show_offset):
807
917
    if timezone == 'utc':
808
 
        tt = time.gmtime(t)
 
918
        tt = gmtime(t)
809
919
        offset = 0
810
920
    elif timezone == 'original':
811
921
        if offset is None:
812
922
            offset = 0
813
 
        tt = time.gmtime(t + offset)
 
923
        tt = gmtime(t + offset)
814
924
    elif timezone == 'local':
815
925
        tt = time.localtime(t)
816
926
        offset = local_time_offset(t)
826
936
 
827
937
 
828
938
def compact_date(when):
829
 
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
 
939
    return time.strftime('%Y%m%d%H%M%S', gmtime(when))
830
940
 
831
941
 
832
942
def format_delta(delta):
880
990
 
881
991
def filesize(f):
882
992
    """Return size of given open file."""
883
 
    return os.fstat(f.fileno())[ST_SIZE]
884
 
 
885
 
 
886
 
# Define rand_bytes based on platform.
887
 
try:
888
 
    # Python 2.4 and later have os.urandom,
889
 
    # but it doesn't work on some arches
890
 
    os.urandom(1)
891
 
    rand_bytes = os.urandom
892
 
except (NotImplementedError, AttributeError):
893
 
    # If python doesn't have os.urandom, or it doesn't work,
894
 
    # then try to first pull random data from /dev/urandom
 
993
    return os.fstat(f.fileno())[stat.ST_SIZE]
 
994
 
 
995
 
 
996
# Alias os.urandom to support platforms (which?) without /dev/urandom and 
 
997
# override if it doesn't work. Avoid checking on windows where there is
 
998
# significant initialisation cost that can be avoided for some bzr calls.
 
999
 
 
1000
rand_bytes = os.urandom
 
1001
 
 
1002
if rand_bytes.__module__ != "nt":
895
1003
    try:
896
 
        rand_bytes = file('/dev/urandom', 'rb').read
897
 
    # Otherwise, use this hack as a last resort
898
 
    except (IOError, OSError):
 
1004
        rand_bytes(1)
 
1005
    except NotImplementedError:
899
1006
        # not well seeded, but better than nothing
900
1007
        def rand_bytes(n):
901
1008
            import random
931
1038
    rps = []
932
1039
    for f in ps:
933
1040
        if f == '..':
934
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1041
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
935
1042
        elif (f == '.') or (f == ''):
936
1043
            pass
937
1044
        else:
942
1049
def joinpath(p):
943
1050
    for f in p:
944
1051
        if (f == '..') or (f is None) or (f == ''):
945
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1052
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
946
1053
    return pathjoin(*p)
947
1054
 
948
1055
 
949
1056
def parent_directories(filename):
950
1057
    """Return the list of parent directories, deepest first.
951
 
    
 
1058
 
952
1059
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
953
1060
    """
954
1061
    parents = []
970
1077
    implementation should be loaded instead::
971
1078
 
972
1079
    >>> try:
973
 
    >>>     import bzrlib._fictional_extension_pyx
 
1080
    >>>     import brzlib._fictional_extension_pyx
974
1081
    >>> except ImportError, e:
975
 
    >>>     bzrlib.osutils.failed_to_load_extension(e)
976
 
    >>>     import bzrlib._fictional_extension_py
 
1082
    >>>     brzlib.osutils.failed_to_load_extension(e)
 
1083
    >>>     import brzlib._fictional_extension_py
977
1084
    """
978
1085
    # NB: This docstring is just an example, not a doctest, because doctest
979
1086
    # currently can't cope with the use of lazy imports in this namespace --
980
1087
    # mbp 20090729
981
 
    
 
1088
 
982
1089
    # This currently doesn't report the failure at the time it occurs, because
983
1090
    # they tend to happen very early in startup when we can't check config
984
1091
    # files etc, and also we want to report all failures but not spam the user
985
1092
    # with 10 warnings.
986
 
    from bzrlib import trace
987
1093
    exception_str = str(exception)
988
1094
    if exception_str not in _extension_load_failures:
989
1095
        trace.mutter("failed to load compiled extension: %s" % exception_str)
993
1099
def report_extension_load_failures():
994
1100
    if not _extension_load_failures:
995
1101
        return
996
 
    from bzrlib.config import GlobalConfig
997
 
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
 
1102
    if config.GlobalStack().get('ignore_missing_extensions'):
998
1103
        return
999
1104
    # the warnings framework should by default show this only once
1000
 
    from bzrlib.trace import warning
 
1105
    from brzlib.trace import warning
1001
1106
    warning(
1002
 
        "bzr: warning: some compiled extensions could not be loaded; "
 
1107
        "brz: warning: some compiled extensions could not be loaded; "
1003
1108
        "see <https://answers.launchpad.net/bzr/+faq/703>")
1004
1109
    # we no longer show the specific missing extensions here, because it makes
1005
1110
    # the message too long and scary - see
1007
1112
 
1008
1113
 
1009
1114
try:
1010
 
    from bzrlib._chunks_to_lines_pyx import chunks_to_lines
 
1115
    from brzlib._chunks_to_lines_pyx import chunks_to_lines
1011
1116
except ImportError, e:
1012
1117
    failed_to_load_extension(e)
1013
 
    from bzrlib._chunks_to_lines_py import chunks_to_lines
 
1118
    from brzlib._chunks_to_lines_py import chunks_to_lines
1014
1119
 
1015
1120
 
1016
1121
def split_lines(s):
1054
1159
 
1055
1160
 
1056
1161
def delete_any(path):
1057
 
    """Delete a file, symlink or directory.  
1058
 
    
 
1162
    """Delete a file, symlink or directory.
 
1163
 
1059
1164
    Will delete even if readonly.
1060
1165
    """
1061
1166
    try:
1162
1267
 
1163
1268
    if len(base) < MIN_ABS_PATHLENGTH:
1164
1269
        # must have space for e.g. a drive letter
1165
 
        raise ValueError('%r is too short to calculate a relative path'
 
1270
        raise ValueError(gettext('%r is too short to calculate a relative path')
1166
1271
            % (base,))
1167
1272
 
1168
1273
    rp = abspath(path)
1250
1355
    # but for now, we haven't optimized...
1251
1356
    return [canonical_relpath(base, p) for p in paths]
1252
1357
 
 
1358
 
 
1359
def decode_filename(filename):
 
1360
    """Decode the filename using the filesystem encoding
 
1361
 
 
1362
    If it is unicode, it is returned.
 
1363
    Otherwise it is decoded from the the filesystem's encoding. If decoding
 
1364
    fails, a errors.BadFilenameEncoding exception is raised.
 
1365
    """
 
1366
    if type(filename) is unicode:
 
1367
        return filename
 
1368
    try:
 
1369
        return filename.decode(_fs_enc)
 
1370
    except UnicodeDecodeError:
 
1371
        raise errors.BadFilenameEncoding(filename, _fs_enc)
 
1372
 
 
1373
 
1253
1374
def safe_unicode(unicode_or_utf8_string):
1254
1375
    """Coerce unicode_or_utf8_string into unicode.
1255
1376
 
1338
1459
def normalizes_filenames():
1339
1460
    """Return True if this platform normalizes unicode filenames.
1340
1461
 
1341
 
    Mac OSX does, Windows/Linux do not.
 
1462
    Only Mac OSX.
1342
1463
    """
1343
1464
    return _platform_normalizes_filenames
1344
1465
 
1349
1470
    On platforms where the system normalizes filenames (Mac OSX),
1350
1471
    you can access a file by any path which will normalize correctly.
1351
1472
    On platforms where the system does not normalize filenames
1352
 
    (Windows, Linux), you have to access a file by its exact path.
 
1473
    (everything else), you have to access a file by its exact path.
1353
1474
 
1354
1475
    Internally, bzr only supports NFC normalization, since that is
1355
1476
    the standard for XML documents.
1417
1538
terminal_width() returns None.
1418
1539
"""
1419
1540
 
 
1541
# Keep some state so that terminal_width can detect if _terminal_size has
 
1542
# returned a different size since the process started.  See docstring and
 
1543
# comments of terminal_width for details.
 
1544
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
 
1545
_terminal_size_state = 'no_data'
 
1546
_first_terminal_size = None
1420
1547
 
1421
1548
def terminal_width():
1422
1549
    """Return terminal width.
1426
1553
    The rules are:
1427
1554
    - if BZR_COLUMNS is set, returns its value
1428
1555
    - if there is no controlling terminal, returns None
 
1556
    - query the OS, if the queried size has changed since the last query,
 
1557
      return its value,
1429
1558
    - if COLUMNS is set, returns its value,
 
1559
    - if the OS has a value (even though it's never changed), return its value.
1430
1560
 
1431
1561
    From there, we need to query the OS to get the size of the controlling
1432
1562
    terminal.
1433
1563
 
1434
 
    Unices:
 
1564
    On Unices we query the OS by:
1435
1565
    - get termios.TIOCGWINSZ
1436
1566
    - if an error occurs or a negative value is obtained, returns None
1437
1567
 
1438
 
    Windows:
1439
 
    
 
1568
    On Windows we query the OS by:
1440
1569
    - win32utils.get_console_size() decides,
1441
1570
    - returns None on error (provided default value)
1442
1571
    """
 
1572
    # Note to implementors: if changing the rules for determining the width,
 
1573
    # make sure you've considered the behaviour in these cases:
 
1574
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
 
1575
    #  - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
 
1576
    #    0,0.
 
1577
    #  - (add more interesting cases here, if you find any)
 
1578
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
 
1579
    # but we don't want to register a signal handler because it is impossible
 
1580
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
 
1581
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
 
1582
    # time so we can notice if the reported size has changed, which should have
 
1583
    # a similar effect.
1443
1584
 
1444
1585
    # If BZR_COLUMNS is set, take it, user is always right
 
1586
    # Except if they specified 0 in which case, impose no limit here
1445
1587
    try:
1446
 
        return int(os.environ['BZR_COLUMNS'])
 
1588
        width = int(os.environ['BZR_COLUMNS'])
1447
1589
    except (KeyError, ValueError):
1448
 
        pass
 
1590
        width = None
 
1591
    if width is not None:
 
1592
        if width > 0:
 
1593
            return width
 
1594
        else:
 
1595
            return None
1449
1596
 
1450
1597
    isatty = getattr(sys.stdout, 'isatty', None)
1451
 
    if  isatty is None or not isatty():
 
1598
    if isatty is None or not isatty():
1452
1599
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1453
1600
        return None
1454
1601
 
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))
 
1602
    # Query the OS
 
1603
    width, height = os_size = _terminal_size(None, None)
 
1604
    global _first_terminal_size, _terminal_size_state
 
1605
    if _terminal_size_state == 'no_data':
 
1606
        _first_terminal_size = os_size
 
1607
        _terminal_size_state = 'unchanged'
 
1608
    elif (_terminal_size_state == 'unchanged' and
 
1609
          _first_terminal_size != os_size):
 
1610
        _terminal_size_state = 'changed'
 
1611
 
 
1612
    # If the OS claims to know how wide the terminal is, and this value has
 
1613
    # ever changed, use that.
 
1614
    if _terminal_size_state == 'changed':
 
1615
        if width is not None and width > 0:
 
1616
            return width
 
1617
 
 
1618
    # If COLUMNS is set, use it.
1458
1619
    try:
1459
1620
        return int(os.environ['COLUMNS'])
1460
1621
    except (KeyError, ValueError):
1461
1622
        pass
1462
1623
 
1463
 
    width, height = _terminal_size(None, None)
1464
 
    if width <= 0:
1465
 
        # Consider invalid values as meaning no width
1466
 
        return None
 
1624
    # Finally, use an unchanged size from the OS, if we have one.
 
1625
    if _terminal_size_state == 'unchanged':
 
1626
        if width is not None and width > 0:
 
1627
            return width
1467
1628
 
1468
 
    return width
 
1629
    # The width could not be determined.
 
1630
    return None
1469
1631
 
1470
1632
 
1471
1633
def _win32_terminal_size(width, height):
1498
1660
    _terminal_size = _ioctl_terminal_size
1499
1661
 
1500
1662
 
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
1663
def supports_executable():
1527
1664
    return sys.platform != "win32"
1528
1665
 
1651
1788
        dirblock = []
1652
1789
        append = dirblock.append
1653
1790
        try:
1654
 
            names = sorted(_listdir(top))
 
1791
            names = sorted(map(decode_filename, _listdir(top)))
1655
1792
        except OSError, e:
1656
1793
            if not _is_error_enotdir(e):
1657
1794
                raise
1711
1848
    """
1712
1849
    global _selected_dir_reader
1713
1850
    if _selected_dir_reader is None:
1714
 
        fs_encoding = _fs_enc.upper()
1715
1851
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1716
1852
            # Win98 doesn't have unicode apis like FindFirstFileW
1717
1853
            # TODO: We possibly could support Win98 by falling back to the
1719
1855
            #       but that gets a bit tricky, and requires custom compiling
1720
1856
            #       for win98 anyway.
1721
1857
            try:
1722
 
                from bzrlib._walkdirs_win32 import Win32ReadDir
 
1858
                from brzlib._walkdirs_win32 import Win32ReadDir
1723
1859
                _selected_dir_reader = Win32ReadDir()
1724
1860
            except ImportError:
1725
1861
                pass
1726
 
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1727
 
            # ANSI_X3.4-1968 is a form of ASCII
 
1862
        elif _fs_enc in ('utf-8', 'ascii'):
1728
1863
            try:
1729
 
                from bzrlib._readdir_pyx import UTF8DirReader
 
1864
                from brzlib._readdir_pyx import UTF8DirReader
1730
1865
                _selected_dir_reader = UTF8DirReader()
1731
1866
            except ImportError, e:
1732
1867
                failed_to_load_extension(e)
1865
2000
        s = os.stat(src)
1866
2001
        chown(dst, s.st_uid, s.st_gid)
1867
2002
    except OSError, e:
1868
 
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
 
2003
        trace.warning(
 
2004
            'Unable to copy ownership from "%s" to "%s". '
 
2005
            'You may want to set it manually.', src, dst)
 
2006
        trace.log_exception_quietly()
1869
2007
 
1870
2008
 
1871
2009
def path_prefix_key(path):
1886
2024
_cached_user_encoding = None
1887
2025
 
1888
2026
 
1889
 
def get_user_encoding(use_cache=True):
 
2027
def get_user_encoding(use_cache=DEPRECATED_PARAMETER):
1890
2028
    """Find out what the preferred user encoding is.
1891
2029
 
1892
2030
    This is generally the encoding that is used for command line parameters
1893
2031
    and file contents. This may be different from the terminal encoding
1894
2032
    or the filesystem encoding.
1895
2033
 
1896
 
    :param  use_cache:  Enable cache for detected encoding.
1897
 
                        (This parameter is turned on by default,
1898
 
                        and required only for selftesting)
1899
 
 
1900
2034
    :return: A string defining the preferred user encoding
1901
2035
    """
1902
2036
    global _cached_user_encoding
1903
 
    if _cached_user_encoding is not None and use_cache:
 
2037
    if deprecated_passed(use_cache):
 
2038
        warn_deprecated("use_cache should only have been used for tests",
 
2039
            DeprecationWarning, stacklevel=2) 
 
2040
    if _cached_user_encoding is not None:
1904
2041
        return _cached_user_encoding
1905
2042
 
1906
 
    if sys.platform == 'darwin':
1907
 
        # python locale.getpreferredencoding() always return
1908
 
        # 'mac-roman' on darwin. That's a lie.
1909
 
        sys.platform = 'posix'
1910
 
        try:
1911
 
            if os.environ.get('LANG', None) is None:
1912
 
                # If LANG is not set, we end up with 'ascii', which is bad
1913
 
                # ('mac-roman' is more than ascii), so we set a default which
1914
 
                # will give us UTF-8 (which appears to work in all cases on
1915
 
                # OSX). Users are still free to override LANG of course, as
1916
 
                # long as it give us something meaningful. This work-around
1917
 
                # *may* not be needed with python 3k and/or OSX 10.5, but will
1918
 
                # work with them too -- vila 20080908
1919
 
                os.environ['LANG'] = 'en_US.UTF-8'
1920
 
            import locale
1921
 
        finally:
1922
 
            sys.platform = 'darwin'
 
2043
    if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
 
2044
        # Use the existing locale settings and call nl_langinfo directly
 
2045
        # rather than going through getpreferredencoding. This avoids
 
2046
        # <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
 
2047
        # possibility of the setlocale call throwing an error.
 
2048
        user_encoding = locale.nl_langinfo(locale.CODESET)
1923
2049
    else:
1924
 
        import locale
 
2050
        # GZ 2011-12-19: On windows could call GetACP directly instead.
 
2051
        user_encoding = locale.getpreferredencoding(False)
1925
2052
 
1926
2053
    try:
1927
 
        user_encoding = locale.getpreferredencoding()
1928
 
    except locale.Error, e:
1929
 
        sys.stderr.write('bzr: warning: %s\n'
1930
 
                         '  Could not determine what text encoding to use.\n'
1931
 
                         '  This error usually means your Python interpreter\n'
1932
 
                         '  doesn\'t support the locale set by $LANG (%s)\n'
1933
 
                         "  Continuing with ascii encoding.\n"
1934
 
                         % (e, os.environ.get('LANG')))
1935
 
        user_encoding = 'ascii'
1936
 
 
1937
 
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
1938
 
    # treat that as ASCII, and not support printing unicode characters to the
1939
 
    # console.
1940
 
    #
1941
 
    # For python scripts run under vim, we get '', so also treat that as ASCII
1942
 
    if user_encoding in (None, 'cp0', ''):
1943
 
        user_encoding = 'ascii'
1944
 
    else:
1945
 
        # check encoding
1946
 
        try:
1947
 
            codecs.lookup(user_encoding)
1948
 
        except LookupError:
1949
 
            sys.stderr.write('bzr: warning:'
 
2054
        user_encoding = codecs.lookup(user_encoding).name
 
2055
    except LookupError:
 
2056
        if user_encoding not in ("", "cp0"):
 
2057
            sys.stderr.write('brz: warning:'
1950
2058
                             ' unknown encoding %s.'
1951
2059
                             ' Continuing with ascii encoding.\n'
1952
2060
                             % user_encoding
1953
2061
                            )
1954
 
            user_encoding = 'ascii'
1955
 
 
1956
 
    if use_cache:
1957
 
        _cached_user_encoding = user_encoding
1958
 
 
 
2062
        user_encoding = 'ascii'
 
2063
    else:
 
2064
        # Get 'ascii' when setlocale has not been called or LANG=C or unset.
 
2065
        if user_encoding == 'ascii':
 
2066
            if sys.platform == 'darwin':
 
2067
                # OSX is special-cased in Python to have a UTF-8 filesystem
 
2068
                # encoding and previously had LANG set here if not present.
 
2069
                user_encoding = 'utf-8'
 
2070
            # GZ 2011-12-19: Maybe UTF-8 should be the default in this case
 
2071
            #                for some other posix platforms as well.
 
2072
 
 
2073
    _cached_user_encoding = user_encoding
1959
2074
    return user_encoding
1960
2075
 
1961
2076
 
 
2077
def get_diff_header_encoding():
 
2078
    return get_terminal_encoding()
 
2079
 
 
2080
 
1962
2081
def get_host_name():
1963
2082
    """Return the current unicode host name.
1964
2083
 
1966
2085
    behaves inconsistently on different platforms.
1967
2086
    """
1968
2087
    if sys.platform == "win32":
1969
 
        import win32utils
1970
2088
        return win32utils.get_host_name()
1971
2089
    else:
1972
2090
        import socket
1979
2097
# data at once.
1980
2098
MAX_SOCKET_CHUNK = 64 * 1024
1981
2099
 
 
2100
_end_of_stream_errors = [errno.ECONNRESET, errno.EPIPE, errno.EINVAL]
 
2101
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
 
2102
    _eno = getattr(errno, _eno, None)
 
2103
    if _eno is not None:
 
2104
        _end_of_stream_errors.append(_eno)
 
2105
del _eno
 
2106
 
 
2107
 
1982
2108
def read_bytes_from_socket(sock, report_activity=None,
1983
2109
        max_read_size=MAX_SOCKET_CHUNK):
1984
2110
    """Read up to max_read_size of bytes from sock and notify of progress.
1992
2118
            bytes = sock.recv(max_read_size)
1993
2119
        except socket.error, e:
1994
2120
            eno = e.args[0]
1995
 
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
 
2121
            if eno in _end_of_stream_errors:
1996
2122
                # The connection was closed by the other side.  Callers expect
1997
2123
                # an empty string to signal end-of-stream.
1998
2124
                return ""
2027
2153
 
2028
2154
def send_all(sock, bytes, report_activity=None):
2029
2155
    """Send all bytes on a socket.
2030
 
 
 
2156
 
2031
2157
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2032
2158
    some platforms, and catches EINTR which may be thrown if the send is
2033
2159
    interrupted by a signal.
2034
2160
 
2035
2161
    This is preferred to socket.sendall(), because it avoids portability bugs
2036
2162
    and provides activity reporting.
2037
 
 
 
2163
 
2038
2164
    :param report_activity: Call this as bytes are read, see
2039
2165
        Transport._report_activity
2040
2166
    """
2043
2169
    while sent_total < byte_count:
2044
2170
        try:
2045
2171
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2046
 
        except socket.error, e:
 
2172
        except (socket.error, IOError), e:
 
2173
            if e.args[0] in _end_of_stream_errors:
 
2174
                raise errors.ConnectionReset(
 
2175
                    "Error trying to write to socket", e)
2047
2176
            if e.args[0] != errno.EINTR:
2048
2177
                raise
2049
2178
        else:
 
2179
            if sent == 0:
 
2180
                raise errors.ConnectionReset('Sending to %s returned 0 bytes'
 
2181
                                             % (sock,))
2050
2182
            sent_total += sent
2051
 
            report_activity(sent, 'write')
 
2183
            if report_activity is not None:
 
2184
                report_activity(sent, 'write')
 
2185
 
 
2186
 
 
2187
def connect_socket(address):
 
2188
    # Slight variation of the socket.create_connection() function (provided by
 
2189
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
 
2190
    # provide it for previous python versions. Also, we don't use the timeout
 
2191
    # parameter (provided by the python implementation) so we don't implement
 
2192
    # it either).
 
2193
    err = socket.error('getaddrinfo returns an empty list')
 
2194
    host, port = address
 
2195
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
 
2196
        af, socktype, proto, canonname, sa = res
 
2197
        sock = None
 
2198
        try:
 
2199
            sock = socket.socket(af, socktype, proto)
 
2200
            sock.connect(sa)
 
2201
            return sock
 
2202
 
 
2203
        except socket.error, err:
 
2204
            # 'err' is now the most recent error
 
2205
            if sock is not None:
 
2206
                sock.close()
 
2207
    raise err
2052
2208
 
2053
2209
 
2054
2210
def dereference_path(path):
2073
2229
def resource_string(package, resource_name):
2074
2230
    """Load a resource from a package and return it as a string.
2075
2231
 
2076
 
    Note: Only packages that start with bzrlib are currently supported.
 
2232
    Note: Only packages that start with brzlib are currently supported.
2077
2233
 
2078
2234
    This is designed to be a lightweight implementation of resource
2079
2235
    loading in a way which is API compatible with the same API from
2082
2238
    If and when pkg_resources becomes a standard library, this routine
2083
2239
    can delegate to it.
2084
2240
    """
2085
 
    # Check package name is within bzrlib
2086
 
    if package == "bzrlib":
 
2241
    # Check package name is within brzlib
 
2242
    if package == "brzlib":
2087
2243
        resource_relpath = resource_name
2088
 
    elif package.startswith("bzrlib."):
2089
 
        package = package[len("bzrlib."):].replace('.', os.sep)
 
2244
    elif package.startswith("brzlib."):
 
2245
        package = package[len("brzlib."):].replace('.', os.sep)
2090
2246
        resource_relpath = pathjoin(package, resource_name)
2091
2247
    else:
2092
 
        raise errors.BzrError('resource package %s not in bzrlib' % package)
 
2248
        raise errors.BzrError('resource package %s not in brzlib' % package)
2093
2249
 
2094
2250
    # Map the resource to a file and read its contents
2095
 
    base = dirname(bzrlib.__file__)
 
2251
    base = dirname(brzlib.__file__)
2096
2252
    if getattr(sys, 'frozen', None):    # bzr.exe
2097
2253
        base = abspath(pathjoin(base, '..', '..'))
2098
 
    filename = pathjoin(base, resource_relpath)
2099
 
    return open(filename, 'rU').read()
2100
 
 
 
2254
    f = file(pathjoin(base, resource_relpath), "rU")
 
2255
    try:
 
2256
        return f.read()
 
2257
    finally:
 
2258
        f.close()
2101
2259
 
2102
2260
def file_kind_from_stat_mode_thunk(mode):
2103
2261
    global file_kind_from_stat_mode
2104
2262
    if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
2105
2263
        try:
2106
 
            from bzrlib._readdir_pyx import UTF8DirReader
 
2264
            from brzlib._readdir_pyx import UTF8DirReader
2107
2265
            file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2108
2266
        except ImportError, e:
2109
2267
            # This is one time where we won't warn that an extension failed to
2110
2268
            # load. The extension is never available on Windows anyway.
2111
 
            from bzrlib._readdir_py import (
 
2269
            from brzlib._readdir_py import (
2112
2270
                _kind_from_mode as file_kind_from_stat_mode
2113
2271
                )
2114
2272
    return file_kind_from_stat_mode(mode)
2115
2273
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2116
2274
 
2117
 
 
2118
 
def file_kind(f, _lstat=os.lstat):
 
2275
def file_stat(f, _lstat=os.lstat):
2119
2276
    try:
2120
 
        return file_kind_from_stat_mode(_lstat(f).st_mode)
 
2277
        # XXX cache?
 
2278
        return _lstat(f)
2121
2279
    except OSError, e:
2122
2280
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2123
2281
            raise errors.NoSuchFile(f)
2124
2282
        raise
2125
2283
 
 
2284
def file_kind(f, _lstat=os.lstat):
 
2285
    stat_value = file_stat(f, _lstat)
 
2286
    return file_kind_from_stat_mode(stat_value.st_mode)
2126
2287
 
2127
2288
def until_no_eintr(f, *a, **kw):
2128
2289
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2129
 
    
 
2290
 
2130
2291
    WARNING: you must be certain that it is safe to retry the call repeatedly
2131
2292
    if EINTR does occur.  This is typically only true for low-level operations
2132
2293
    like os.read.  If in any doubt, don't use this.
2134
2295
    Keep in mind that this is not a complete solution to EINTR.  There is
2135
2296
    probably code in the Python standard library and other dependencies that
2136
2297
    may encounter EINTR if a signal arrives (and there is signal handler for
2137
 
    that signal).  So this function can reduce the impact for IO that bzrlib
 
2298
    that signal).  So this function can reduce the impact for IO that brzlib
2138
2299
    directly controls, but it is not a complete solution.
2139
2300
    """
2140
2301
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
2147
2308
            raise
2148
2309
 
2149
2310
 
 
2311
@deprecated_function(deprecated_in((2, 2, 0)))
2150
2312
def re_compile_checked(re_string, flags=0, where=""):
2151
2313
    """Return a compiled re, or raise a sensible error.
2152
2314
 
2162
2324
        re_obj = re.compile(re_string, flags)
2163
2325
        re_obj.search("")
2164
2326
        return re_obj
2165
 
    except re.error, e:
 
2327
    except errors.InvalidPattern, e:
2166
2328
        if where:
2167
2329
            where = ' in ' + where
2168
2330
        # despite the name 'error' is a type
2169
 
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2170
 
            % (where, re_string, e))
 
2331
        raise errors.BzrCommandError('Invalid regular expression%s: %s'
 
2332
            % (where, e.msg))
2171
2333
 
2172
2334
 
2173
2335
if sys.platform == "win32":
2174
 
    import msvcrt
2175
2336
    def getchar():
 
2337
        import msvcrt
2176
2338
        return msvcrt.getch()
2177
2339
else:
2178
 
    import tty
2179
 
    import termios
2180
2340
    def getchar():
 
2341
        import tty
 
2342
        import termios
2181
2343
        fd = sys.stdin.fileno()
2182
2344
        settings = termios.tcgetattr(fd)
2183
2345
        try:
2187
2349
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2188
2350
        return ch
2189
2351
 
2190
 
 
2191
 
if sys.platform == 'linux2':
 
2352
if sys.platform.startswith('linux'):
2192
2353
    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
 
2354
        try:
 
2355
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2356
        except (ValueError, OSError, AttributeError):
 
2357
            return None
2199
2358
elif sys.platform == 'darwin':
2200
2359
    def _local_concurrency():
2201
2360
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2202
2361
                                stdout=subprocess.PIPE).communicate()[0]
2203
 
elif sys.platform[0:7] == 'freebsd':
 
2362
elif "bsd" in sys.platform:
2204
2363
    def _local_concurrency():
2205
2364
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2206
2365
                                stdout=subprocess.PIPE).communicate()[0]
2234
2393
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2235
2394
    if concurrency is None:
2236
2395
        try:
2237
 
            concurrency = _local_concurrency()
2238
 
        except (OSError, IOError):
2239
 
            pass
 
2396
            import multiprocessing
 
2397
            concurrency = multiprocessing.cpu_count()
 
2398
        except (ImportError, NotImplementedError):
 
2399
            # multiprocessing is only available on Python >= 2.6
 
2400
            # and multiprocessing.cpu_count() isn't implemented on all
 
2401
            # platforms
 
2402
            try:
 
2403
                concurrency = _local_concurrency()
 
2404
            except (OSError, IOError):
 
2405
                pass
2240
2406
    try:
2241
2407
        concurrency = int(concurrency)
2242
2408
    except (TypeError, ValueError):
2263
2429
if sys.platform == 'win32':
2264
2430
    def open_file(filename, mode='r', bufsize=-1):
2265
2431
        """This function is used to override the ``open`` builtin.
2266
 
        
 
2432
 
2267
2433
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2268
2434
        child processes.  Deleting or renaming a closed file opened with this
2269
2435
        function is not blocking child processes.
2302
2468
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2303
2469
else:
2304
2470
    open_file = open
 
2471
 
 
2472
 
 
2473
def available_backup_name(base, exists):
 
2474
    """Find a non-existing backup file name.
 
2475
 
 
2476
    This will *not* create anything, this only return a 'free' entry.  This
 
2477
    should be used for checking names in a directory below a locked
 
2478
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
 
2479
    Leap) and generally discouraged.
 
2480
 
 
2481
    :param base: The base name.
 
2482
 
 
2483
    :param exists: A callable returning True if the path parameter exists.
 
2484
    """
 
2485
    counter = 1
 
2486
    name = "%s.~%d~" % (base, counter)
 
2487
    while exists(name):
 
2488
        counter += 1
 
2489
        name = "%s.~%d~" % (base, counter)
 
2490
    return name
 
2491
 
 
2492
 
 
2493
def set_fd_cloexec(fd):
 
2494
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
 
2495
    support for this is not available.
 
2496
    """
 
2497
    try:
 
2498
        import fcntl
 
2499
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
 
2500
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
 
2501
    except (ImportError, AttributeError):
 
2502
        # Either the fcntl module or specific constants are not present
 
2503
        pass
 
2504
 
 
2505
 
 
2506
def find_executable_on_path(name):
 
2507
    """Finds an executable on the PATH.
 
2508
    
 
2509
    On Windows, this will try to append each extension in the PATHEXT
 
2510
    environment variable to the name, if it cannot be found with the name
 
2511
    as given.
 
2512
    
 
2513
    :param name: The base name of the executable.
 
2514
    :return: The path to the executable found or None.
 
2515
    """
 
2516
    if sys.platform == 'win32':
 
2517
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
 
2518
        exts = [ext.lower() for ext in exts]
 
2519
        base, ext = os.path.splitext(name)
 
2520
        if ext != '':
 
2521
            if ext.lower() not in exts:
 
2522
                return None
 
2523
            name = base
 
2524
            exts = [ext]
 
2525
    else:
 
2526
        exts = ['']
 
2527
    path = os.environ.get('PATH')
 
2528
    if path is not None:
 
2529
        path = path.split(os.pathsep)
 
2530
        for ext in exts:
 
2531
            for d in path:
 
2532
                f = os.path.join(d, name) + ext
 
2533
                if os.access(f, os.X_OK):
 
2534
                    return f
 
2535
    if sys.platform == 'win32':
 
2536
        app_path = win32utils.get_app_path(name)
 
2537
        if app_path != name:
 
2538
            return app_path
 
2539
    return None
 
2540
 
 
2541
 
 
2542
def _posix_is_local_pid_dead(pid):
 
2543
    """True if pid doesn't correspond to live process on this machine"""
 
2544
    try:
 
2545
        # Special meaning of unix kill: just check if it's there.
 
2546
        os.kill(pid, 0)
 
2547
    except OSError, e:
 
2548
        if e.errno == errno.ESRCH:
 
2549
            # On this machine, and really not found: as sure as we can be
 
2550
            # that it's dead.
 
2551
            return True
 
2552
        elif e.errno == errno.EPERM:
 
2553
            # exists, though not ours
 
2554
            return False
 
2555
        else:
 
2556
            mutter("os.kill(%d, 0) failed: %s" % (pid, e))
 
2557
            # Don't really know.
 
2558
            return False
 
2559
    else:
 
2560
        # Exists and our process: not dead.
 
2561
        return False
 
2562
 
 
2563
if sys.platform == "win32":
 
2564
    is_local_pid_dead = win32utils.is_local_pid_dead
 
2565
else:
 
2566
    is_local_pid_dead = _posix_is_local_pid_dead
 
2567
 
 
2568
_maybe_ignored = ['EAGAIN', 'EINTR', 'ENOTSUP', 'EOPNOTSUPP', 'EACCES']
 
2569
_fdatasync_ignored = [getattr(errno, name) for name in _maybe_ignored
 
2570
                      if getattr(errno, name, None) is not None]
 
2571
 
 
2572
 
 
2573
def fdatasync(fileno):
 
2574
    """Flush file contents to disk if possible.
 
2575
    
 
2576
    :param fileno: Integer OS file handle.
 
2577
    :raises TransportNotPossible: If flushing to disk is not possible.
 
2578
    """
 
2579
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
 
2580
    if fn is not None:
 
2581
        try:
 
2582
            fn(fileno)
 
2583
        except IOError, e:
 
2584
            # See bug #1075108, on some platforms fdatasync exists, but can
 
2585
            # raise ENOTSUP. However, we are calling fdatasync to be helpful
 
2586
            # and reduce the chance of corruption-on-powerloss situations. It
 
2587
            # is not a mandatory call, so it is ok to suppress failures.
 
2588
            trace.mutter("ignoring error calling fdatasync: %s" % (e,))
 
2589
            if getattr(e, 'errno', None) not in _fdatasync_ignored:
 
2590
                raise
 
2591
 
 
2592
 
 
2593
def ensure_empty_directory_exists(path, exception_class):
 
2594
    """Make sure a local directory exists and is empty.
 
2595
    
 
2596
    If it does not exist, it is created.  If it exists and is not empty, an
 
2597
    instance of exception_class is raised.
 
2598
    """
 
2599
    try:
 
2600
        os.mkdir(path)
 
2601
    except OSError, e:
 
2602
        if e.errno != errno.EEXIST:
 
2603
            raise
 
2604
        if os.listdir(path) != []:
 
2605
            raise exception_class(path)
 
2606
 
 
2607
 
 
2608
def is_environment_error(evalue):
 
2609
    """True if exception instance is due to a process environment issue
 
2610
 
 
2611
    This includes OSError and IOError, but also other errors that come from
 
2612
    the operating system or core libraries but are not subclasses of those.
 
2613
    """
 
2614
    if isinstance(evalue, (EnvironmentError, select.error)):
 
2615
        return True
 
2616
    if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
 
2617
        return True
 
2618
    return False