/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: Andrew Bennetts
  • Date: 2008-10-30 01:05:59 UTC
  • mto: This revision was merged to the branch mainline in revision 3813.
  • Revision ID: andrew.bennetts@canonical.com-20081030010559-tumoefnsmhg4snxo
Add contrib/bzr_ssh_path_limiter.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
import os
18
18
import re
19
19
import stat
20
 
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
 
20
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
 
21
                  S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
21
22
import sys
22
23
import time
23
 
import codecs
24
24
 
25
25
from bzrlib.lazy_import import lazy_import
26
26
lazy_import(globals(), """
 
27
import codecs
27
28
from datetime import datetime
28
29
import errno
29
 
import getpass
30
30
from ntpath import (abspath as _nt_abspath,
31
31
                    join as _nt_join,
32
32
                    normpath as _nt_normpath,
38
38
from shutil import (
39
39
    rmtree,
40
40
    )
41
 
import socket
42
 
import subprocess
43
41
import tempfile
44
42
from tempfile import (
45
43
    mkdtemp,
49
47
from bzrlib import (
50
48
    cache_utf8,
51
49
    errors,
52
 
    trace,
53
50
    win32utils,
54
51
    )
55
52
""")
56
53
 
57
 
from bzrlib.symbol_versioning import (
58
 
    deprecated_function,
59
 
    deprecated_in,
60
 
    )
61
 
 
62
54
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
63
55
# of 2.5
64
56
if sys.version_info < (2, 5):
77
69
from bzrlib import symbol_versioning
78
70
 
79
71
 
80
 
# Cross platform wall-clock time functionality with decent resolution.
81
 
# On Linux ``time.clock`` returns only CPU time. On Windows, ``time.time()``
82
 
# only has a resolution of ~15ms. Note that ``time.clock()`` is not
83
 
# synchronized with ``time.time()``, this is only meant to be used to find
84
 
# delta times by subtracting from another call to this function.
85
 
timer_func = time.time
86
 
if sys.platform == 'win32':
87
 
    timer_func = time.clock
88
 
 
89
72
# On win32, O_BINARY is used to indicate the file should
90
73
# be opened in binary mode, rather than text mode.
91
74
# On other platforms, O_BINARY doesn't exist, because
92
75
# they always open in binary mode, so it is okay to
93
 
# OR with 0 on those platforms.
94
 
# O_NOINHERIT and O_TEXT exists only on win32 too.
 
76
# OR with 0 on those platforms
95
77
O_BINARY = getattr(os, 'O_BINARY', 0)
96
 
O_TEXT = getattr(os, 'O_TEXT', 0)
97
 
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
98
 
 
99
 
 
100
 
def get_unicode_argv():
101
 
    try:
102
 
        user_encoding = get_user_encoding()
103
 
        return [a.decode(user_encoding) for a in sys.argv[1:]]
104
 
    except UnicodeDecodeError:
105
 
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
106
 
                                                            "encoding." % a))
107
78
 
108
79
 
109
80
def make_readonly(filename):
126
97
 
127
98
    :param paths: A container (and hence not None) of paths.
128
99
    :return: A set of paths sufficient to include everything in paths via
129
 
        is_inside, drawn from the paths parameter.
 
100
        is_inside_any, drawn from the paths parameter.
130
101
    """
131
 
    if len(paths) < 2:
132
 
        return set(paths)
133
 
 
134
 
    def sort_key(path):
135
 
        return path.split('/')
136
 
    sorted_paths = sorted(list(paths), key=sort_key)
137
 
 
138
 
    search_paths = [sorted_paths[0]]
139
 
    for path in sorted_paths[1:]:
140
 
        if not is_inside(search_paths[-1], path):
141
 
            # This path is unique, add it
142
 
            search_paths.append(path)
143
 
 
144
 
    return set(search_paths)
 
102
    search_paths = set()
 
103
    paths = set(paths)
 
104
    for path in paths:
 
105
        other_paths = paths.difference([path])
 
106
        if not is_inside_any(other_paths, path):
 
107
            # this is a top level path, we must check it.
 
108
            search_paths.add(path)
 
109
    return search_paths
145
110
 
146
111
 
147
112
_QUOTE_RE = None
156
121
    global _QUOTE_RE
157
122
    if _QUOTE_RE is None:
158
123
        _QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
159
 
 
 
124
        
160
125
    if _QUOTE_RE.search(f):
161
126
        return '"' + f + '"'
162
127
    else:
187
152
    try:
188
153
        return _kind_marker_map[kind]
189
154
    except KeyError:
190
 
        # Slightly faster than using .get(, '') when the common case is that
191
 
        # kind will be found
192
 
        return ''
 
155
        raise errors.BzrError('invalid file kind %r' % kind)
193
156
 
194
157
 
195
158
lexists = getattr(os.path, 'lexists', None)
208
171
 
209
172
def fancy_rename(old, new, rename_func, unlink_func):
210
173
    """A fancy rename, when you don't have atomic rename.
211
 
 
 
174
    
212
175
    :param old: The old path, to rename from
213
176
    :param new: The new path, to rename to
214
177
    :param rename_func: The potentially non-atomic rename function
215
 
    :param unlink_func: A way to delete the target file if the full rename
216
 
        succeeds
 
178
    :param unlink_func: A way to delete the target file if the full rename succeeds
217
179
    """
 
180
 
218
181
    # sftp rename doesn't allow overwriting, so play tricks:
219
182
    base = os.path.basename(new)
220
183
    dirname = os.path.dirname(new)
221
 
    # callers use different encodings for the paths so the following MUST
222
 
    # respect that. We rely on python upcasting to unicode if new is unicode
223
 
    # and keeping a str if not.
224
 
    tmp_name = 'tmp.%s.%.9f.%d.%s' % (base, time.time(),
225
 
                                      os.getpid(), rand_chars(10))
 
184
    tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
226
185
    tmp_name = pathjoin(dirname, tmp_name)
227
186
 
228
187
    # Rename the file out of the way, but keep track if it didn't exist
248
207
    else:
249
208
        file_existed = True
250
209
 
251
 
    failure_exc = None
252
210
    success = False
253
211
    try:
254
212
        try:
260
218
            # source and target may be aliases of each other (e.g. on a
261
219
            # case-insensitive filesystem), so we may have accidentally renamed
262
220
            # source by when we tried to rename target
263
 
            failure_exc = sys.exc_info()
264
 
            if (file_existed and e.errno in (None, errno.ENOENT)
265
 
                and old.lower() == new.lower()):
266
 
                # source and target are the same file on a case-insensitive
267
 
                # filesystem, so we don't generate an exception
268
 
                failure_exc = None
 
221
            if not (file_existed and e.errno in (None, errno.ENOENT)):
 
222
                raise
269
223
    finally:
270
224
        if file_existed:
271
225
            # If the file used to exist, rename it back into place
274
228
                unlink_func(tmp_name)
275
229
            else:
276
230
                rename_func(tmp_name, new)
277
 
    if failure_exc is not None:
278
 
        raise failure_exc[0], failure_exc[1], failure_exc[2]
279
231
 
280
232
 
281
233
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
361
313
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
362
314
 
363
315
 
364
 
def _add_rename_error_details(e, old, new):
365
 
    new_e = OSError(e.errno, "failed to rename %s to %s: %s"
366
 
        % (old, new, e.strerror))
367
 
    new_e.filename = old
368
 
    new_e.to_filename = new
369
 
    return new_e
370
 
 
371
 
 
372
316
def _win32_rename(old, new):
373
317
    """We expect to be able to atomically replace 'new' with old.
374
318
 
375
319
    On win32, if new exists, it must be moved out of the way first,
376
 
    and then deleted.
 
320
    and then deleted. 
377
321
    """
378
322
    try:
379
 
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
 
323
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
380
324
    except OSError, e:
381
325
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
382
 
            # If we try to rename a non-existant file onto cwd, we get
383
 
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT
 
326
            # If we try to rename a non-existant file onto cwd, we get 
 
327
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT 
384
328
            # if the old path doesn't exist, sometimes we get EACCES
385
329
            # On Linux, we seem to get EBUSY, on Mac we get EINVAL
386
330
            os.lstat(old)
387
331
        raise
388
332
 
389
333
 
390
 
def _wrapped_rename(old, new):
391
 
    """Rename a file or directory"""
392
 
    try:
393
 
        os.rename(old, new)
394
 
    except (IOError, OSError), e:
395
 
        # this is eventually called by all rename-like functions, so should 
396
 
        # catch all of them
397
 
        raise _add_rename_error_details(e, old, new)
398
 
 
399
 
 
400
334
def _mac_getcwd():
401
335
    return unicodedata.normalize('NFC', os.getcwdu())
402
336
 
407
341
realpath = _posix_realpath
408
342
pathjoin = os.path.join
409
343
normpath = os.path.normpath
410
 
rename = _wrapped_rename # overridden below on win32
411
344
getcwd = os.getcwdu
 
345
rename = os.rename
412
346
dirname = os.path.dirname
413
347
basename = os.path.basename
414
348
split = os.path.split
450
384
    def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
451
385
        """Replacer for shutil.rmtree: could remove readonly dirs/files"""
452
386
        return shutil.rmtree(path, ignore_errors, onerror)
453
 
 
454
 
    f = win32utils.get_unicode_argv     # special function or None
455
 
    if f is not None:
456
 
        get_unicode_argv = f
457
 
 
458
387
elif sys.platform == 'darwin':
459
388
    getcwd = _mac_getcwd
460
389
 
541
470
 
542
471
def is_inside(dir, fname):
543
472
    """True if fname is inside dir.
544
 
 
 
473
    
545
474
    The parameters should typically be passed to osutils.normpath first, so
546
475
    that . and .. and repeated slashes are eliminated, and the separators
547
476
    are canonical for the platform.
548
 
 
549
 
    The empty string as a dir name is taken as top-of-tree and matches
 
477
    
 
478
    The empty string as a dir name is taken as top-of-tree and matches 
550
479
    everything.
551
480
    """
552
 
    # XXX: Most callers of this can actually do something smarter by
 
481
    # XXX: Most callers of this can actually do something smarter by 
553
482
    # looking at the inventory
554
483
    if dir == fname:
555
484
        return True
556
 
 
 
485
    
557
486
    if dir == '':
558
487
        return True
559
488
 
579
508
    return False
580
509
 
581
510
 
582
 
def pumpfile(from_file, to_file, read_length=-1, buff_size=32768,
583
 
             report_activity=None, direction='read'):
 
511
def pumpfile(from_file, to_file, read_length=-1, buff_size=32768):
584
512
    """Copy contents of one file to another.
585
513
 
586
514
    The read_length can either be -1 to read to end-of-file (EOF) or
589
517
    The buff_size represents the maximum size for each read operation
590
518
    performed on from_file.
591
519
 
592
 
    :param report_activity: Call this as bytes are read, see
593
 
        Transport._report_activity
594
 
    :param direction: Will be passed to report_activity
595
 
 
596
520
    :return: The number of bytes copied.
597
521
    """
598
522
    length = 0
606
530
            if not block:
607
531
                # EOF reached
608
532
                break
609
 
            if report_activity is not None:
610
 
                report_activity(len(block), direction)
611
533
            to_file.write(block)
612
534
 
613
535
            actual_bytes_read = len(block)
620
542
            if not block:
621
543
                # EOF reached
622
544
                break
623
 
            if report_activity is not None:
624
 
                report_activity(len(block), direction)
625
545
            to_file.write(block)
626
546
            length += len(block)
627
547
    return length
668
588
    return s.hexdigest()
669
589
 
670
590
 
671
 
def size_sha_file(f):
672
 
    """Calculate the size and hexdigest of an open file.
673
 
 
674
 
    The file cursor should be already at the start and
675
 
    the caller is responsible for closing the file afterwards.
676
 
    """
677
 
    size = 0
678
 
    s = sha()
679
 
    BUFSIZE = 128<<10
680
 
    while True:
681
 
        b = f.read(BUFSIZE)
682
 
        if not b:
683
 
            break
684
 
        size += len(b)
685
 
        s.update(b)
686
 
    return size, s.hexdigest()
687
 
 
688
 
 
689
591
def sha_file_by_name(fname):
690
592
    """Calculate the SHA1 of a file by reading the full text"""
691
593
    s = sha()
692
 
    f = os.open(fname, os.O_RDONLY | O_BINARY | O_NOINHERIT)
 
594
    f = os.open(fname, os.O_RDONLY | O_BINARY)
693
595
    try:
694
596
        while True:
695
597
            b = os.read(f, 1<<16)
737
639
    return offset.days * 86400 + offset.seconds
738
640
 
739
641
weekdays = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
740
 
_default_format_by_weekday_num = [wd + " %Y-%m-%d %H:%M:%S" for wd in weekdays]
741
 
 
742
 
 
 
642
    
743
643
def format_date(t, offset=0, timezone='original', date_fmt=None,
744
644
                show_offset=True):
745
645
    """Return a formatted date string.
758
658
    date_str = time.strftime(date_fmt, tt)
759
659
    return date_str + offset_str
760
660
 
761
 
 
762
 
# Cache of formatted offset strings
763
 
_offset_cache = {}
764
 
 
765
 
 
766
 
def format_date_with_offset_in_original_timezone(t, offset=0,
767
 
    _cache=_offset_cache):
768
 
    """Return a formatted date string in the original timezone.
769
 
 
770
 
    This routine may be faster then format_date.
771
 
 
772
 
    :param t: Seconds since the epoch.
773
 
    :param offset: Timezone offset in seconds east of utc.
774
 
    """
775
 
    if offset is None:
776
 
        offset = 0
777
 
    tt = time.gmtime(t + offset)
778
 
    date_fmt = _default_format_by_weekday_num[tt[6]]
779
 
    date_str = time.strftime(date_fmt, tt)
780
 
    offset_str = _cache.get(offset, None)
781
 
    if offset_str is None:
782
 
        offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
783
 
        _cache[offset] = offset_str
784
 
    return date_str + offset_str
785
 
 
786
 
 
787
661
def format_local_date(t, offset=0, timezone='original', date_fmt=None,
788
662
                      show_offset=True):
789
663
    """Return an unicode date string formatted according to the current locale.
800
674
               _format_date(t, offset, timezone, date_fmt, show_offset)
801
675
    date_str = time.strftime(date_fmt, tt)
802
676
    if not isinstance(date_str, unicode):
803
 
        date_str = date_str.decode(get_user_encoding(), 'replace')
 
677
        date_str = date_str.decode(bzrlib.user_encoding, 'replace')
804
678
    return date_str + offset_str
805
679
 
806
 
 
807
680
def _format_date(t, offset, timezone, date_fmt, show_offset):
808
681
    if timezone == 'utc':
809
682
        tt = time.gmtime(t)
828
701
 
829
702
def compact_date(when):
830
703
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
831
 
 
 
704
    
832
705
 
833
706
def format_delta(delta):
834
707
    """Get a nice looking string for a time delta.
910
783
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
911
784
def rand_chars(num):
912
785
    """Return a random string of num alphanumeric characters
913
 
 
914
 
    The result only contains lowercase chars because it may be used on
 
786
    
 
787
    The result only contains lowercase chars because it may be used on 
915
788
    case-insensitive filesystems.
916
789
    """
917
790
    s = ''
939
812
            rps.append(f)
940
813
    return rps
941
814
 
942
 
 
943
815
def joinpath(p):
944
816
    for f in p:
945
817
        if (f == '..') or (f is None) or (f == ''):
947
819
    return pathjoin(*p)
948
820
 
949
821
 
950
 
def parent_directories(filename):
951
 
    """Return the list of parent directories, deepest first.
952
 
    
953
 
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
954
 
    """
955
 
    parents = []
956
 
    parts = splitpath(dirname(filename))
957
 
    while parts:
958
 
        parents.append(joinpath(parts))
959
 
        parts.pop()
960
 
    return parents
961
 
 
962
 
 
963
 
_extension_load_failures = []
964
 
 
965
 
 
966
 
def failed_to_load_extension(exception):
967
 
    """Handle failing to load a binary extension.
968
 
 
969
 
    This should be called from the ImportError block guarding the attempt to
970
 
    import the native extension.  If this function returns, the pure-Python
971
 
    implementation should be loaded instead::
972
 
 
973
 
    >>> try:
974
 
    >>>     import bzrlib._fictional_extension_pyx
975
 
    >>> except ImportError, e:
976
 
    >>>     bzrlib.osutils.failed_to_load_extension(e)
977
 
    >>>     import bzrlib._fictional_extension_py
978
 
    """
979
 
    # NB: This docstring is just an example, not a doctest, because doctest
980
 
    # currently can't cope with the use of lazy imports in this namespace --
981
 
    # mbp 20090729
982
 
    
983
 
    # This currently doesn't report the failure at the time it occurs, because
984
 
    # they tend to happen very early in startup when we can't check config
985
 
    # files etc, and also we want to report all failures but not spam the user
986
 
    # with 10 warnings.
987
 
    from bzrlib import trace
988
 
    exception_str = str(exception)
989
 
    if exception_str not in _extension_load_failures:
990
 
        trace.mutter("failed to load compiled extension: %s" % exception_str)
991
 
        _extension_load_failures.append(exception_str)
992
 
 
993
 
 
994
 
def report_extension_load_failures():
995
 
    if not _extension_load_failures:
996
 
        return
997
 
    from bzrlib.config import GlobalConfig
998
 
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
999
 
        return
1000
 
    # the warnings framework should by default show this only once
1001
 
    from bzrlib.trace import warning
1002
 
    warning(
1003
 
        "bzr: warning: some compiled extensions could not be loaded; "
1004
 
        "see <https://answers.launchpad.net/bzr/+faq/703>")
1005
 
    # we no longer show the specific missing extensions here, because it makes
1006
 
    # the message too long and scary - see
1007
 
    # https://bugs.launchpad.net/bzr/+bug/430529
1008
 
 
1009
 
 
1010
 
try:
1011
 
    from bzrlib._chunks_to_lines_pyx import chunks_to_lines
1012
 
except ImportError, e:
1013
 
    failed_to_load_extension(e)
1014
 
    from bzrlib._chunks_to_lines_py import chunks_to_lines
1015
 
 
1016
 
 
1017
822
def split_lines(s):
1018
823
    """Split s into lines, but without removing the newline characters."""
1019
 
    # Trivially convert a fulltext into a 'chunked' representation, and let
1020
 
    # chunks_to_lines do the heavy lifting.
1021
 
    if isinstance(s, str):
1022
 
        # chunks_to_lines only supports 8-bit strings
1023
 
        return chunks_to_lines([s])
1024
 
    else:
1025
 
        return _split_lines(s)
1026
 
 
1027
 
 
1028
 
def _split_lines(s):
1029
 
    """Split s into lines, but without removing the newline characters.
1030
 
 
1031
 
    This supports Unicode or plain string objects.
1032
 
    """
1033
824
    lines = s.split('\n')
1034
825
    result = [line + '\n' for line in lines[:-1]]
1035
826
    if lines[-1]:
1054
845
        shutil.copyfile(src, dest)
1055
846
 
1056
847
 
 
848
# Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
 
849
# Forgiveness than Permission (EAFP) because:
 
850
# - root can damage a solaris file system by using unlink,
 
851
# - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
 
852
#   EACCES, OSX: EPERM) when invoked on a directory.
1057
853
def delete_any(path):
1058
 
    """Delete a file, symlink or directory.  
1059
 
    
1060
 
    Will delete even if readonly.
1061
 
    """
1062
 
    try:
1063
 
       _delete_file_or_dir(path)
1064
 
    except (OSError, IOError), e:
1065
 
        if e.errno in (errno.EPERM, errno.EACCES):
1066
 
            # make writable and try again
1067
 
            try:
1068
 
                make_writable(path)
1069
 
            except (OSError, IOError):
1070
 
                pass
1071
 
            _delete_file_or_dir(path)
1072
 
        else:
1073
 
            raise
1074
 
 
1075
 
 
1076
 
def _delete_file_or_dir(path):
1077
 
    # Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
1078
 
    # Forgiveness than Permission (EAFP) because:
1079
 
    # - root can damage a solaris file system by using unlink,
1080
 
    # - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
1081
 
    #   EACCES, OSX: EPERM) when invoked on a directory.
 
854
    """Delete a file or directory."""
1082
855
    if isdir(path): # Takes care of symlinks
1083
856
        os.rmdir(path)
1084
857
    else:
1104
877
            and sys.platform not in ('cygwin', 'win32'))
1105
878
 
1106
879
 
1107
 
def readlink(abspath):
1108
 
    """Return a string representing the path to which the symbolic link points.
1109
 
 
1110
 
    :param abspath: The link absolute unicode path.
1111
 
 
1112
 
    This his guaranteed to return the symbolic link in unicode in all python
1113
 
    versions.
1114
 
    """
1115
 
    link = abspath.encode(_fs_enc)
1116
 
    target = os.readlink(link)
1117
 
    target = target.decode(_fs_enc)
1118
 
    return target
1119
 
 
1120
 
 
1121
880
def contains_whitespace(s):
1122
881
    """True if there are any whitespace characters in s."""
1123
882
    # string.whitespace can include '\xa0' in certain locales, because it is
1148
907
 
1149
908
 
1150
909
def relpath(base, path):
1151
 
    """Return path relative to base, or raise PathNotChild exception.
 
910
    """Return path relative to base, or raise exception.
1152
911
 
1153
912
    The path may be either an absolute path or a path relative to the
1154
913
    current working directory.
1156
915
    os.path.commonprefix (python2.4) has a bad bug that it works just
1157
916
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
1158
917
    avoids that problem.
1159
 
 
1160
 
    NOTE: `base` should not have a trailing slash otherwise you'll get
1161
 
    PathNotChild exceptions regardless of `path`.
1162
918
    """
1163
919
 
1164
920
    if len(base) < MIN_ABS_PATHLENGTH:
1170
926
 
1171
927
    s = []
1172
928
    head = rp
1173
 
    while True:
1174
 
        if len(head) <= len(base) and head != base:
1175
 
            raise errors.PathNotChild(rp, base)
 
929
    while len(head) >= len(base):
1176
930
        if head == base:
1177
931
            break
1178
 
        head, tail = split(head)
 
932
        head, tail = os.path.split(head)
1179
933
        if tail:
1180
 
            s.append(tail)
 
934
            s.insert(0, tail)
 
935
    else:
 
936
        raise errors.PathNotChild(rp, base)
1181
937
 
1182
938
    if s:
1183
 
        return pathjoin(*reversed(s))
 
939
        return pathjoin(*s)
1184
940
    else:
1185
941
        return ''
1186
942
 
1187
943
 
1188
 
def _cicp_canonical_relpath(base, path):
1189
 
    """Return the canonical path relative to base.
1190
 
 
1191
 
    Like relpath, but on case-insensitive-case-preserving file-systems, this
1192
 
    will return the relpath as stored on the file-system rather than in the
1193
 
    case specified in the input string, for all existing portions of the path.
1194
 
 
1195
 
    This will cause O(N) behaviour if called for every path in a tree; if you
1196
 
    have a number of paths to convert, you should use canonical_relpaths().
1197
 
    """
1198
 
    # TODO: it should be possible to optimize this for Windows by using the
1199
 
    # win32 API FindFiles function to look for the specified name - but using
1200
 
    # os.listdir() still gives us the correct, platform agnostic semantics in
1201
 
    # the short term.
1202
 
 
1203
 
    rel = relpath(base, path)
1204
 
    # '.' will have been turned into ''
1205
 
    if not rel:
1206
 
        return rel
1207
 
 
1208
 
    abs_base = abspath(base)
1209
 
    current = abs_base
1210
 
    _listdir = os.listdir
1211
 
 
1212
 
    # use an explicit iterator so we can easily consume the rest on early exit.
1213
 
    bit_iter = iter(rel.split('/'))
1214
 
    for bit in bit_iter:
1215
 
        lbit = bit.lower()
1216
 
        try:
1217
 
            next_entries = _listdir(current)
1218
 
        except OSError: # enoent, eperm, etc
1219
 
            # We can't find this in the filesystem, so just append the
1220
 
            # remaining bits.
1221
 
            current = pathjoin(current, bit, *list(bit_iter))
1222
 
            break
1223
 
        for look in next_entries:
1224
 
            if lbit == look.lower():
1225
 
                current = pathjoin(current, look)
1226
 
                break
1227
 
        else:
1228
 
            # got to the end, nothing matched, so we just return the
1229
 
            # non-existing bits as they were specified (the filename may be
1230
 
            # the target of a move, for example).
1231
 
            current = pathjoin(current, bit, *list(bit_iter))
1232
 
            break
1233
 
    return current[len(abs_base):].lstrip('/')
1234
 
 
1235
 
# XXX - TODO - we need better detection/integration of case-insensitive
1236
 
# file-systems; Linux often sees FAT32 devices (or NFS-mounted OSX
1237
 
# filesystems), for example, so could probably benefit from the same basic
1238
 
# support there.  For now though, only Windows and OSX get that support, and
1239
 
# they get it for *all* file-systems!
1240
 
if sys.platform in ('win32', 'darwin'):
1241
 
    canonical_relpath = _cicp_canonical_relpath
1242
 
else:
1243
 
    canonical_relpath = relpath
1244
 
 
1245
 
def canonical_relpaths(base, paths):
1246
 
    """Create an iterable to canonicalize a sequence of relative paths.
1247
 
 
1248
 
    The intent is for this implementation to use a cache, vastly speeding
1249
 
    up multiple transformations in the same directory.
1250
 
    """
1251
 
    # but for now, we haven't optimized...
1252
 
    return [canonical_relpath(base, p) for p in paths]
1253
 
 
1254
944
def safe_unicode(unicode_or_utf8_string):
1255
945
    """Coerce unicode_or_utf8_string into unicode.
1256
946
 
1257
947
    If it is unicode, it is returned.
1258
 
    Otherwise it is decoded from utf-8. If decoding fails, the exception is
1259
 
    wrapped in a BzrBadParameterNotUnicode exception.
 
948
    Otherwise it is decoded from utf-8. If a decoding error
 
949
    occurs, it is wrapped as a If the decoding fails, the exception is wrapped 
 
950
    as a BzrBadParameter exception.
1260
951
    """
1261
952
    if isinstance(unicode_or_utf8_string, unicode):
1262
953
        return unicode_or_utf8_string
1349
1040
 
1350
1041
    On platforms where the system normalizes filenames (Mac OSX),
1351
1042
    you can access a file by any path which will normalize correctly.
1352
 
    On platforms where the system does not normalize filenames
 
1043
    On platforms where the system does not normalize filenames 
1353
1044
    (Windows, Linux), you have to access a file by its exact path.
1354
1045
 
1355
 
    Internally, bzr only supports NFC normalization, since that is
 
1046
    Internally, bzr only supports NFC normalization, since that is 
1356
1047
    the standard for XML documents.
1357
1048
 
1358
1049
    So return the normalized path, and a flag indicating if the file
1375
1066
    normalized_filename = _inaccessible_normalized_filename
1376
1067
 
1377
1068
 
1378
 
def set_signal_handler(signum, handler, restart_syscall=True):
1379
 
    """A wrapper for signal.signal that also calls siginterrupt(signum, False)
1380
 
    on platforms that support that.
1381
 
 
1382
 
    :param restart_syscall: if set, allow syscalls interrupted by a signal to
1383
 
        automatically restart (by calling `signal.siginterrupt(signum,
1384
 
        False)`).  May be ignored if the feature is not available on this
1385
 
        platform or Python version.
1386
 
    """
1387
 
    try:
1388
 
        import signal
1389
 
        siginterrupt = signal.siginterrupt
1390
 
    except ImportError:
1391
 
        # This python implementation doesn't provide signal support, hence no
1392
 
        # handler exists
1393
 
        return None
1394
 
    except AttributeError:
1395
 
        # siginterrupt doesn't exist on this platform, or for this version
1396
 
        # of Python.
1397
 
        siginterrupt = lambda signum, flag: None
1398
 
    if restart_syscall:
1399
 
        def sig_handler(*args):
1400
 
            # Python resets the siginterrupt flag when a signal is
1401
 
            # received.  <http://bugs.python.org/issue8354>
1402
 
            # As a workaround for some cases, set it back the way we want it.
1403
 
            siginterrupt(signum, False)
1404
 
            # Now run the handler function passed to set_signal_handler.
1405
 
            handler(*args)
1406
 
    else:
1407
 
        sig_handler = handler
1408
 
    old_handler = signal.signal(signum, sig_handler)
1409
 
    if restart_syscall:
1410
 
        siginterrupt(signum, False)
1411
 
    return old_handler
1412
 
 
1413
 
 
1414
 
default_terminal_width = 80
1415
 
"""The default terminal width for ttys.
1416
 
 
1417
 
This is defined so that higher levels can share a common fallback value when
1418
 
terminal_width() returns None.
1419
 
"""
1420
 
 
1421
 
 
1422
1069
def terminal_width():
1423
 
    """Return terminal width.
1424
 
 
1425
 
    None is returned if the width can't established precisely.
1426
 
 
1427
 
    The rules are:
1428
 
    - if BZR_COLUMNS is set, returns its value
1429
 
    - if there is no controlling terminal, returns None
1430
 
    - if COLUMNS is set, returns its value,
1431
 
 
1432
 
    From there, we need to query the OS to get the size of the controlling
1433
 
    terminal.
1434
 
 
1435
 
    Unices:
1436
 
    - get termios.TIOCGWINSZ
1437
 
    - if an error occurs or a negative value is obtained, returns None
1438
 
 
1439
 
    Windows:
1440
 
    
1441
 
    - win32utils.get_console_size() decides,
1442
 
    - returns None on error (provided default value)
1443
 
    """
1444
 
 
1445
 
    # If BZR_COLUMNS is set, take it, user is always right
1446
 
    try:
1447
 
        return int(os.environ['BZR_COLUMNS'])
1448
 
    except (KeyError, ValueError):
1449
 
        pass
1450
 
 
1451
 
    isatty = getattr(sys.stdout, 'isatty', None)
1452
 
    if  isatty is None or not isatty():
1453
 
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1454
 
        return None
1455
 
 
1456
 
    # If COLUMNS is set, take it, the terminal knows better (even inside a
1457
 
    # given terminal, the application can decide to set COLUMNS to a lower
1458
 
    # value (splitted screen) or a bigger value (scroll bars))
1459
 
    try:
1460
 
        return int(os.environ['COLUMNS'])
1461
 
    except (KeyError, ValueError):
1462
 
        pass
1463
 
 
1464
 
    width, height = _terminal_size(None, None)
1465
 
    if width <= 0:
1466
 
        # Consider invalid values as meaning no width
1467
 
        return None
1468
 
 
1469
 
    return width
1470
 
 
1471
 
 
1472
 
def _win32_terminal_size(width, height):
1473
 
    width, height = win32utils.get_console_size(defaultx=width, defaulty=height)
1474
 
    return width, height
1475
 
 
1476
 
 
1477
 
def _ioctl_terminal_size(width, height):
 
1070
    """Return estimated terminal width."""
 
1071
    if sys.platform == 'win32':
 
1072
        return win32utils.get_console_size()[0]
 
1073
    width = 0
1478
1074
    try:
1479
1075
        import struct, fcntl, termios
1480
1076
        s = struct.pack('HHHH', 0, 0, 0, 0)
1481
1077
        x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1482
 
        height, width = struct.unpack('HHHH', x)[0:2]
1483
 
    except (IOError, AttributeError):
 
1078
        width = struct.unpack('HHHH', x)[1]
 
1079
    except IOError:
1484
1080
        pass
1485
 
    return width, height
1486
 
 
1487
 
_terminal_size = None
1488
 
"""Returns the terminal size as (width, height).
1489
 
 
1490
 
:param width: Default value for width.
1491
 
:param height: Default value for height.
1492
 
 
1493
 
This is defined specifically for each OS and query the size of the controlling
1494
 
terminal. If any error occurs, the provided default values should be returned.
1495
 
"""
1496
 
if sys.platform == 'win32':
1497
 
    _terminal_size = _win32_terminal_size
1498
 
else:
1499
 
    _terminal_size = _ioctl_terminal_size
1500
 
 
1501
 
 
1502
 
def _terminal_size_changed(signum, frame):
1503
 
    """Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
1504
 
    width, height = _terminal_size(None, None)
1505
 
    if width is not None:
1506
 
        os.environ['COLUMNS'] = str(width)
1507
 
 
1508
 
 
1509
 
_registered_sigwinch = False
1510
 
def watch_sigwinch():
1511
 
    """Register for SIGWINCH, once and only once.
1512
 
 
1513
 
    Do nothing if the signal module is not available.
1514
 
    """
1515
 
    global _registered_sigwinch
1516
 
    if not _registered_sigwinch:
 
1081
    if width <= 0:
1517
1082
        try:
1518
 
            import signal
1519
 
            if getattr(signal, "SIGWINCH", None) is not None:
1520
 
                set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
1521
 
        except ImportError:
1522
 
            # python doesn't provide signal support, nothing we can do about it
 
1083
            width = int(os.environ['COLUMNS'])
 
1084
        except:
1523
1085
            pass
1524
 
        _registered_sigwinch = True
 
1086
    if width <= 0:
 
1087
        width = 80
 
1088
 
 
1089
    return width
1525
1090
 
1526
1091
 
1527
1092
def supports_executable():
1564
1129
 
1565
1130
 
1566
1131
def check_legal_path(path):
1567
 
    """Check whether the supplied path is legal.
 
1132
    """Check whether the supplied path is legal.  
1568
1133
    This is only required on Windows, so we don't test on other platforms
1569
1134
    right now.
1570
1135
    """
1604
1169
 
1605
1170
def walkdirs(top, prefix=""):
1606
1171
    """Yield data about all the directories in a tree.
1607
 
 
 
1172
    
1608
1173
    This yields all the data about the contents of a directory at a time.
1609
1174
    After each directory has been yielded, if the caller has mutated the list
1610
1175
    to exclude some directories, they are then not descended into.
1611
 
 
 
1176
    
1612
1177
    The data yielded is of the form:
1613
1178
    ((directory-relpath, directory-path-from-top),
1614
1179
    [(relpath, basename, kind, lstat, path-from-top), ...]),
1615
1180
     - directory-relpath is the relative path of the directory being returned
1616
1181
       with respect to top. prefix is prepended to this.
1617
 
     - directory-path-from-root is the path including top for this directory.
 
1182
     - directory-path-from-root is the path including top for this directory. 
1618
1183
       It is suitable for use with os functions.
1619
1184
     - relpath is the relative path within the subtree being walked.
1620
1185
     - basename is the basename of the path
1622
1187
       present within the tree - but it may be recorded as versioned. See
1623
1188
       versioned_kind.
1624
1189
     - lstat is the stat data *if* the file was statted.
1625
 
     - planned, not implemented:
 
1190
     - planned, not implemented: 
1626
1191
       path_from_tree_root is the path from the root of the tree.
1627
1192
 
1628
 
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This
 
1193
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This 
1629
1194
        allows one to walk a subtree but get paths that are relative to a tree
1630
1195
        rooted higher up.
1631
1196
    :return: an iterator over the dirs.
1632
1197
    """
1633
1198
    #TODO there is a bit of a smell where the results of the directory-
1634
 
    # summary in this, and the path from the root, may not agree
 
1199
    # summary in this, and the path from the root, may not agree 
1635
1200
    # depending on top and prefix - i.e. ./foo and foo as a pair leads to
1636
1201
    # potentially confusing output. We should make this more robust - but
1637
1202
    # not at a speed cost. RBC 20060731
1721
1286
            #       for win98 anyway.
1722
1287
            try:
1723
1288
                from bzrlib._walkdirs_win32 import Win32ReadDir
 
1289
            except ImportError:
 
1290
                _selected_dir_reader = UnicodeDirReader()
 
1291
            else:
1724
1292
                _selected_dir_reader = Win32ReadDir()
1725
 
            except ImportError:
1726
 
                pass
1727
 
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
 
1293
        elif fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1728
1294
            # ANSI_X3.4-1968 is a form of ASCII
 
1295
            _selected_dir_reader = UnicodeDirReader()
 
1296
        else:
1729
1297
            try:
1730
1298
                from bzrlib._readdir_pyx import UTF8DirReader
 
1299
            except ImportError:
 
1300
                # No optimised code path
 
1301
                _selected_dir_reader = UnicodeDirReader()
 
1302
            else:
1731
1303
                _selected_dir_reader = UTF8DirReader()
1732
 
            except ImportError, e:
1733
 
                failed_to_load_extension(e)
1734
 
                pass
1735
 
 
1736
 
    if _selected_dir_reader is None:
1737
 
        # Fallback to the python version
1738
 
        _selected_dir_reader = UnicodeDirReader()
1739
 
 
1740
1304
    # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1741
1305
    # But we don't actually uses 1-3 in pending, so set them to None
1742
1306
    pending = [[_selected_dir_reader.top_prefix_to_starting_dir(top, prefix)]]
1808
1372
def copy_tree(from_path, to_path, handlers={}):
1809
1373
    """Copy all of the entries in from_path into to_path.
1810
1374
 
1811
 
    :param from_path: The base directory to copy.
 
1375
    :param from_path: The base directory to copy. 
1812
1376
    :param to_path: The target directory. If it does not exist, it will
1813
1377
        be created.
1814
1378
    :param handlers: A dictionary of functions, which takes a source and
1847
1411
            real_handlers[kind](abspath, relpath)
1848
1412
 
1849
1413
 
1850
 
def copy_ownership_from_path(dst, src=None):
1851
 
    """Copy usr/grp ownership from src file/dir to dst file/dir.
1852
 
 
1853
 
    If src is None, the containing directory is used as source. If chown
1854
 
    fails, the error is ignored and a warning is printed.
1855
 
    """
1856
 
    chown = getattr(os, 'chown', None)
1857
 
    if chown is None:
1858
 
        return
1859
 
 
1860
 
    if src == None:
1861
 
        src = os.path.dirname(dst)
1862
 
        if src == '':
1863
 
            src = '.'
1864
 
 
1865
 
    try:
1866
 
        s = os.stat(src)
1867
 
        chown(dst, s.st_uid, s.st_gid)
1868
 
    except OSError, e:
1869
 
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
1870
 
 
1871
 
 
1872
1414
def path_prefix_key(path):
1873
1415
    """Generate a prefix-order path key for path.
1874
1416
 
1974
1516
        return socket.gethostname().decode(get_user_encoding())
1975
1517
 
1976
1518
 
1977
 
# We must not read/write any more than 64k at a time from/to a socket so we
1978
 
# don't risk "no buffer space available" errors on some platforms.  Windows in
1979
 
# particular is likely to throw WSAECONNABORTED or WSAENOBUFS if given too much
1980
 
# data at once.
1981
 
MAX_SOCKET_CHUNK = 64 * 1024
1982
 
 
1983
 
def read_bytes_from_socket(sock, report_activity=None,
1984
 
        max_read_size=MAX_SOCKET_CHUNK):
1985
 
    """Read up to max_read_size of bytes from sock and notify of progress.
1986
 
 
1987
 
    Translates "Connection reset by peer" into file-like EOF (return an
1988
 
    empty string rather than raise an error), and repeats the recv if
1989
 
    interrupted by a signal.
1990
 
    """
1991
 
    while 1:
1992
 
        try:
1993
 
            bytes = sock.recv(max_read_size)
1994
 
        except socket.error, e:
1995
 
            eno = e.args[0]
1996
 
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
1997
 
                # The connection was closed by the other side.  Callers expect
1998
 
                # an empty string to signal end-of-stream.
1999
 
                return ""
2000
 
            elif eno == errno.EINTR:
2001
 
                # Retry the interrupted recv.
2002
 
                continue
2003
 
            raise
2004
 
        else:
2005
 
            if report_activity is not None:
2006
 
                report_activity(len(bytes), 'read')
2007
 
            return bytes
2008
 
 
2009
 
 
2010
 
def recv_all(socket, count):
 
1519
def recv_all(socket, bytes):
2011
1520
    """Receive an exact number of bytes.
2012
1521
 
2013
1522
    Regular Socket.recv() may return less than the requested number of bytes,
2014
 
    depending on what's in the OS buffer.  MSG_WAITALL is not available
 
1523
    dependning on what's in the OS buffer.  MSG_WAITALL is not available
2015
1524
    on all platforms, but this should work everywhere.  This will return
2016
1525
    less than the requested amount if the remote end closes.
2017
1526
 
2018
1527
    This isn't optimized and is intended mostly for use in testing.
2019
1528
    """
2020
1529
    b = ''
2021
 
    while len(b) < count:
2022
 
        new = read_bytes_from_socket(socket, None, count - len(b))
 
1530
    while len(b) < bytes:
 
1531
        new = socket.recv(bytes - len(b))
2023
1532
        if new == '':
2024
1533
            break # eof
2025
1534
        b += new
2026
1535
    return b
2027
1536
 
2028
1537
 
2029
 
def send_all(sock, bytes, report_activity=None):
 
1538
def send_all(socket, bytes):
2030
1539
    """Send all bytes on a socket.
2031
 
 
2032
 
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2033
 
    some platforms, and catches EINTR which may be thrown if the send is
2034
 
    interrupted by a signal.
2035
1540
 
2036
 
    This is preferred to socket.sendall(), because it avoids portability bugs
2037
 
    and provides activity reporting.
2038
 
 
2039
 
    :param report_activity: Call this as bytes are read, see
2040
 
        Transport._report_activity
 
1541
    Regular socket.sendall() can give socket error 10053 on Windows.  This
 
1542
    implementation sends no more than 64k at a time, which avoids this problem.
2041
1543
    """
2042
 
    sent_total = 0
2043
 
    byte_count = len(bytes)
2044
 
    while sent_total < byte_count:
2045
 
        try:
2046
 
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2047
 
        except socket.error, e:
2048
 
            if e.args[0] != errno.EINTR:
2049
 
                raise
2050
 
        else:
2051
 
            sent_total += sent
2052
 
            report_activity(sent, 'write')
 
1544
    chunk_size = 2**16
 
1545
    for pos in xrange(0, len(bytes), chunk_size):
 
1546
        socket.sendall(bytes[pos:pos+chunk_size])
2053
1547
 
2054
1548
 
2055
1549
def dereference_path(path):
2106
1600
        try:
2107
1601
            from bzrlib._readdir_pyx import UTF8DirReader
2108
1602
            file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2109
 
        except ImportError, e:
2110
 
            # This is one time where we won't warn that an extension failed to
2111
 
            # load. The extension is never available on Windows anyway.
 
1603
        except ImportError:
2112
1604
            from bzrlib._readdir_py import (
2113
1605
                _kind_from_mode as file_kind_from_stat_mode
2114
1606
                )
2125
1617
        raise
2126
1618
 
2127
1619
 
2128
 
def until_no_eintr(f, *a, **kw):
2129
 
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2130
 
    
2131
 
    WARNING: you must be certain that it is safe to retry the call repeatedly
2132
 
    if EINTR does occur.  This is typically only true for low-level operations
2133
 
    like os.read.  If in any doubt, don't use this.
2134
 
 
2135
 
    Keep in mind that this is not a complete solution to EINTR.  There is
2136
 
    probably code in the Python standard library and other dependencies that
2137
 
    may encounter EINTR if a signal arrives (and there is signal handler for
2138
 
    that signal).  So this function can reduce the impact for IO that bzrlib
2139
 
    directly controls, but it is not a complete solution.
2140
 
    """
2141
 
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
2142
 
    while True:
2143
 
        try:
2144
 
            return f(*a, **kw)
2145
 
        except (IOError, OSError), e:
2146
 
            if e.errno == errno.EINTR:
2147
 
                continue
2148
 
            raise
2149
 
 
2150
 
 
2151
 
def re_compile_checked(re_string, flags=0, where=""):
2152
 
    """Return a compiled re, or raise a sensible error.
2153
 
 
2154
 
    This should only be used when compiling user-supplied REs.
2155
 
 
2156
 
    :param re_string: Text form of regular expression.
2157
 
    :param flags: eg re.IGNORECASE
2158
 
    :param where: Message explaining to the user the context where
2159
 
        it occurred, eg 'log search filter'.
2160
 
    """
2161
 
    # from https://bugs.launchpad.net/bzr/+bug/251352
2162
 
    try:
2163
 
        re_obj = re.compile(re_string, flags)
2164
 
        re_obj.search("")
2165
 
        return re_obj
2166
 
    except re.error, e:
2167
 
        if where:
2168
 
            where = ' in ' + where
2169
 
        # despite the name 'error' is a type
2170
 
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2171
 
            % (where, re_string, e))
2172
 
 
2173
 
 
2174
 
if sys.platform == "win32":
2175
 
    import msvcrt
2176
 
    def getchar():
2177
 
        return msvcrt.getch()
2178
 
else:
2179
 
    import tty
2180
 
    import termios
2181
 
    def getchar():
2182
 
        fd = sys.stdin.fileno()
2183
 
        settings = termios.tcgetattr(fd)
2184
 
        try:
2185
 
            tty.setraw(fd)
2186
 
            ch = sys.stdin.read(1)
2187
 
        finally:
2188
 
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2189
 
        return ch
2190
 
 
2191
 
 
2192
 
if sys.platform == 'linux2':
2193
 
    def _local_concurrency():
2194
 
        concurrency = None
2195
 
        prefix = 'processor'
2196
 
        for line in file('/proc/cpuinfo', 'rb'):
2197
 
            if line.startswith(prefix):
2198
 
                concurrency = int(line[line.find(':')+1:]) + 1
2199
 
        return concurrency
2200
 
elif sys.platform == 'darwin':
2201
 
    def _local_concurrency():
2202
 
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2203
 
                                stdout=subprocess.PIPE).communicate()[0]
2204
 
elif sys.platform[0:7] == 'freebsd':
2205
 
    def _local_concurrency():
2206
 
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2207
 
                                stdout=subprocess.PIPE).communicate()[0]
2208
 
elif sys.platform == 'sunos5':
2209
 
    def _local_concurrency():
2210
 
        return subprocess.Popen(['psrinfo', '-p',],
2211
 
                                stdout=subprocess.PIPE).communicate()[0]
2212
 
elif sys.platform == "win32":
2213
 
    def _local_concurrency():
2214
 
        # This appears to return the number of cores.
2215
 
        return os.environ.get('NUMBER_OF_PROCESSORS')
2216
 
else:
2217
 
    def _local_concurrency():
2218
 
        # Who knows ?
2219
 
        return None
2220
 
 
2221
 
 
2222
 
_cached_local_concurrency = None
2223
 
 
2224
 
def local_concurrency(use_cache=True):
2225
 
    """Return how many processes can be run concurrently.
2226
 
 
2227
 
    Rely on platform specific implementations and default to 1 (one) if
2228
 
    anything goes wrong.
2229
 
    """
2230
 
    global _cached_local_concurrency
2231
 
 
2232
 
    if _cached_local_concurrency is not None and use_cache:
2233
 
        return _cached_local_concurrency
2234
 
 
2235
 
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2236
 
    if concurrency is None:
2237
 
        try:
2238
 
            concurrency = _local_concurrency()
2239
 
        except (OSError, IOError):
2240
 
            pass
2241
 
    try:
2242
 
        concurrency = int(concurrency)
2243
 
    except (TypeError, ValueError):
2244
 
        concurrency = 1
2245
 
    if use_cache:
2246
 
        _cached_concurrency = concurrency
2247
 
    return concurrency
2248
 
 
2249
 
 
2250
 
class UnicodeOrBytesToBytesWriter(codecs.StreamWriter):
2251
 
    """A stream writer that doesn't decode str arguments."""
2252
 
 
2253
 
    def __init__(self, encode, stream, errors='strict'):
2254
 
        codecs.StreamWriter.__init__(self, stream, errors)
2255
 
        self.encode = encode
2256
 
 
2257
 
    def write(self, object):
2258
 
        if type(object) is str:
2259
 
            self.stream.write(object)
2260
 
        else:
2261
 
            data, _ = self.encode(object, self.errors)
2262
 
            self.stream.write(data)
2263
 
 
2264
 
if sys.platform == 'win32':
2265
 
    def open_file(filename, mode='r', bufsize=-1):
2266
 
        """This function is used to override the ``open`` builtin.
2267
 
        
2268
 
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2269
 
        child processes.  Deleting or renaming a closed file opened with this
2270
 
        function is not blocking child processes.
2271
 
        """
2272
 
        writing = 'w' in mode
2273
 
        appending = 'a' in mode
2274
 
        updating = '+' in mode
2275
 
        binary = 'b' in mode
2276
 
 
2277
 
        flags = O_NOINHERIT
2278
 
        # see http://msdn.microsoft.com/en-us/library/yeby3zcb%28VS.71%29.aspx
2279
 
        # for flags for each modes.
2280
 
        if binary:
2281
 
            flags |= O_BINARY
2282
 
        else:
2283
 
            flags |= O_TEXT
2284
 
 
2285
 
        if writing:
2286
 
            if updating:
2287
 
                flags |= os.O_RDWR
2288
 
            else:
2289
 
                flags |= os.O_WRONLY
2290
 
            flags |= os.O_CREAT | os.O_TRUNC
2291
 
        elif appending:
2292
 
            if updating:
2293
 
                flags |= os.O_RDWR
2294
 
            else:
2295
 
                flags |= os.O_WRONLY
2296
 
            flags |= os.O_CREAT | os.O_APPEND
2297
 
        else: #reading
2298
 
            if updating:
2299
 
                flags |= os.O_RDWR
2300
 
            else:
2301
 
                flags |= os.O_RDONLY
2302
 
 
2303
 
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2304
 
else:
2305
 
    open_file = open
2306
 
 
2307
 
 
2308
 
def getuser_unicode():
2309
 
    """Return the username as unicode.
2310
 
    """
2311
 
    try:
2312
 
        user_encoding = get_user_encoding()
2313
 
        username = getpass.getuser().decode(user_encoding)
2314
 
    except UnicodeDecodeError:
2315
 
        raise errors.BzrError("Can't decode username as %s." % \
2316
 
                user_encoding)
2317
 
    return username