/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Martin von Gagern
  • Date: 2010-04-20 08:47:38 UTC
  • mfrom: (5167 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5195.
  • Revision ID: martin.vgagern@gmx.net-20100420084738-ygymnqmdllzrhpfn
merge trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
from cStringIO import StringIO
18
17
import os
19
18
import re
20
19
import stat
22
21
                  S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
23
22
import sys
24
23
import time
 
24
import codecs
 
25
import warnings
25
26
 
26
27
from bzrlib.lazy_import import lazy_import
27
28
lazy_import(globals(), """
28
 
import codecs
29
29
from datetime import datetime
30
30
import errno
31
31
from ntpath import (abspath as _nt_abspath,
39
39
from shutil import (
40
40
    rmtree,
41
41
    )
 
42
import signal
 
43
import socket
 
44
import subprocess
42
45
import tempfile
43
46
from tempfile import (
44
47
    mkdtemp,
48
51
from bzrlib import (
49
52
    cache_utf8,
50
53
    errors,
 
54
    trace,
51
55
    win32utils,
52
56
    )
53
57
""")
54
58
 
 
59
from bzrlib.symbol_versioning import (
 
60
    deprecated_function,
 
61
    deprecated_in,
 
62
    )
 
63
 
55
64
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
56
65
# of 2.5
57
66
if sys.version_info < (2, 5):
68
77
 
69
78
import bzrlib
70
79
from bzrlib import symbol_versioning
71
 
from bzrlib.symbol_versioning import (
72
 
    deprecated_function,
73
 
    )
74
 
from bzrlib.trace import mutter
75
 
 
 
80
 
 
81
 
 
82
# Cross platform wall-clock time functionality with decent resolution.
 
83
# On Linux ``time.clock`` returns only CPU time. On Windows, ``time.time()``
 
84
# only has a resolution of ~15ms. Note that ``time.clock()`` is not
 
85
# synchronized with ``time.time()``, this is only meant to be used to find
 
86
# delta times by subtracting from another call to this function.
 
87
timer_func = time.time
 
88
if sys.platform == 'win32':
 
89
    timer_func = time.clock
76
90
 
77
91
# On win32, O_BINARY is used to indicate the file should
78
92
# be opened in binary mode, rather than text mode.
79
93
# On other platforms, O_BINARY doesn't exist, because
80
94
# they always open in binary mode, so it is okay to
81
 
# OR with 0 on those platforms
 
95
# OR with 0 on those platforms.
 
96
# O_NOINHERIT and O_TEXT exists only on win32 too.
82
97
O_BINARY = getattr(os, 'O_BINARY', 0)
 
98
O_TEXT = getattr(os, 'O_TEXT', 0)
 
99
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
 
100
 
 
101
 
 
102
def get_unicode_argv():
 
103
    try:
 
104
        user_encoding = get_user_encoding()
 
105
        return [a.decode(user_encoding) for a in sys.argv[1:]]
 
106
    except UnicodeDecodeError:
 
107
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
 
108
                                                            "encoding." % a))
83
109
 
84
110
 
85
111
def make_readonly(filename):
102
128
 
103
129
    :param paths: A container (and hence not None) of paths.
104
130
    :return: A set of paths sufficient to include everything in paths via
105
 
        is_inside_any, drawn from the paths parameter.
 
131
        is_inside, drawn from the paths parameter.
106
132
    """
107
 
    search_paths = set()
108
 
    paths = set(paths)
109
 
    for path in paths:
110
 
        other_paths = paths.difference([path])
111
 
        if not is_inside_any(other_paths, path):
112
 
            # this is a top level path, we must check it.
113
 
            search_paths.add(path)
114
 
    return search_paths
 
133
    if len(paths) < 2:
 
134
        return set(paths)
 
135
 
 
136
    def sort_key(path):
 
137
        return path.split('/')
 
138
    sorted_paths = sorted(list(paths), key=sort_key)
 
139
 
 
140
    search_paths = [sorted_paths[0]]
 
141
    for path in sorted_paths[1:]:
 
142
        if not is_inside(search_paths[-1], path):
 
143
            # This path is unique, add it
 
144
            search_paths.append(path)
 
145
 
 
146
    return set(search_paths)
115
147
 
116
148
 
117
149
_QUOTE_RE = None
126
158
    global _QUOTE_RE
127
159
    if _QUOTE_RE is None:
128
160
        _QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
129
 
        
 
161
 
130
162
    if _QUOTE_RE.search(f):
131
163
        return '"' + f + '"'
132
164
    else:
157
189
    try:
158
190
        return _kind_marker_map[kind]
159
191
    except KeyError:
160
 
        raise errors.BzrError('invalid file kind %r' % kind)
 
192
        # Slightly faster than using .get(, '') when the common case is that
 
193
        # kind will be found
 
194
        return ''
161
195
 
162
196
 
163
197
lexists = getattr(os.path, 'lexists', None)
176
210
 
177
211
def fancy_rename(old, new, rename_func, unlink_func):
178
212
    """A fancy rename, when you don't have atomic rename.
179
 
    
 
213
 
180
214
    :param old: The old path, to rename from
181
215
    :param new: The new path, to rename to
182
216
    :param rename_func: The potentially non-atomic rename function
183
 
    :param unlink_func: A way to delete the target file if the full rename succeeds
 
217
    :param unlink_func: A way to delete the target file if the full rename
 
218
        succeeds
184
219
    """
185
 
 
186
220
    # sftp rename doesn't allow overwriting, so play tricks:
187
 
    import random
188
221
    base = os.path.basename(new)
189
222
    dirname = os.path.dirname(new)
190
 
    tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
 
223
    # callers use different encodings for the paths so the following MUST
 
224
    # respect that. We rely on python upcasting to unicode if new is unicode
 
225
    # and keeping a str if not.
 
226
    tmp_name = 'tmp.%s.%.9f.%d.%s' % (base, time.time(),
 
227
                                      os.getpid(), rand_chars(10))
191
228
    tmp_name = pathjoin(dirname, tmp_name)
192
229
 
193
230
    # Rename the file out of the way, but keep track if it didn't exist
213
250
    else:
214
251
        file_existed = True
215
252
 
 
253
    failure_exc = None
216
254
    success = False
217
255
    try:
218
256
        try:
224
262
            # source and target may be aliases of each other (e.g. on a
225
263
            # case-insensitive filesystem), so we may have accidentally renamed
226
264
            # source by when we tried to rename target
227
 
            if not (file_existed and e.errno in (None, errno.ENOENT)):
228
 
                raise
 
265
            failure_exc = sys.exc_info()
 
266
            if (file_existed and e.errno in (None, errno.ENOENT)
 
267
                and old.lower() == new.lower()):
 
268
                # source and target are the same file on a case-insensitive
 
269
                # filesystem, so we don't generate an exception
 
270
                failure_exc = None
229
271
    finally:
230
272
        if file_existed:
231
273
            # If the file used to exist, rename it back into place
234
276
                unlink_func(tmp_name)
235
277
            else:
236
278
                rename_func(tmp_name, new)
 
279
    if failure_exc is not None:
 
280
        raise failure_exc[0], failure_exc[1], failure_exc[2]
237
281
 
238
282
 
239
283
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
297
341
        path = cwd + '\\' + path
298
342
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
299
343
 
300
 
if win32utils.winver == 'Windows 98':
301
 
    _win32_abspath = _win98_abspath
302
 
 
303
344
 
304
345
def _win32_realpath(path):
305
346
    # Real _nt_realpath doesn't have a problem with a unicode cwd
326
367
    """We expect to be able to atomically replace 'new' with old.
327
368
 
328
369
    On win32, if new exists, it must be moved out of the way first,
329
 
    and then deleted. 
 
370
    and then deleted.
330
371
    """
331
372
    try:
332
373
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
333
374
    except OSError, e:
334
375
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
335
 
            # If we try to rename a non-existant file onto cwd, we get 
336
 
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT 
 
376
            # If we try to rename a non-existant file onto cwd, we get
 
377
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT
337
378
            # if the old path doesn't exist, sometimes we get EACCES
338
379
            # On Linux, we seem to get EBUSY, on Mac we get EINVAL
339
380
            os.lstat(old)
364
405
 
365
406
 
366
407
if sys.platform == 'win32':
367
 
    abspath = _win32_abspath
 
408
    if win32utils.winver == 'Windows 98':
 
409
        abspath = _win98_abspath
 
410
    else:
 
411
        abspath = _win32_abspath
368
412
    realpath = _win32_realpath
369
413
    pathjoin = _win32_pathjoin
370
414
    normpath = _win32_normpath
390
434
    def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
391
435
        """Replacer for shutil.rmtree: could remove readonly dirs/files"""
392
436
        return shutil.rmtree(path, ignore_errors, onerror)
 
437
 
 
438
    f = win32utils.get_unicode_argv     # special function or None
 
439
    if f is not None:
 
440
        get_unicode_argv = f
 
441
 
393
442
elif sys.platform == 'darwin':
394
443
    getcwd = _mac_getcwd
395
444
 
399
448
 
400
449
    This attempts to check both sys.stdout and sys.stdin to see
401
450
    what encoding they are in, and if that fails it falls back to
402
 
    bzrlib.user_encoding.
 
451
    osutils.get_user_encoding().
403
452
    The problem is that on Windows, locale.getpreferredencoding()
404
453
    is not the same encoding as that used by the console:
405
454
    http://mail.python.org/pipermail/python-list/2003-May/162357.html
407
456
    On my standard US Windows XP, the preferred encoding is
408
457
    cp1252, but the console is cp437
409
458
    """
 
459
    from bzrlib.trace import mutter
410
460
    output_encoding = getattr(sys.stdout, 'encoding', None)
411
461
    if not output_encoding:
412
462
        input_encoding = getattr(sys.stdin, 'encoding', None)
413
463
        if not input_encoding:
414
 
            output_encoding = bzrlib.user_encoding
415
 
            mutter('encoding stdout as bzrlib.user_encoding %r', output_encoding)
 
464
            output_encoding = get_user_encoding()
 
465
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
466
                   output_encoding)
416
467
        else:
417
468
            output_encoding = input_encoding
418
469
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
420
471
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
421
472
    if output_encoding == 'cp0':
422
473
        # invalid encoding (cp0 means 'no codepage' on Windows)
423
 
        output_encoding = bzrlib.user_encoding
 
474
        output_encoding = get_user_encoding()
424
475
        mutter('cp0 is invalid encoding.'
425
 
               ' encoding stdout as bzrlib.user_encoding %r', output_encoding)
 
476
               ' encoding stdout as osutils.get_user_encoding() %r',
 
477
               output_encoding)
426
478
    # check encoding
427
479
    try:
428
480
        codecs.lookup(output_encoding)
430
482
        sys.stderr.write('bzr: warning:'
431
483
                         ' unknown terminal encoding %s.\n'
432
484
                         '  Using encoding %s instead.\n'
433
 
                         % (output_encoding, bzrlib.user_encoding)
 
485
                         % (output_encoding, get_user_encoding())
434
486
                        )
435
 
        output_encoding = bzrlib.user_encoding
 
487
        output_encoding = get_user_encoding()
436
488
 
437
489
    return output_encoding
438
490
 
473
525
 
474
526
def is_inside(dir, fname):
475
527
    """True if fname is inside dir.
476
 
    
 
528
 
477
529
    The parameters should typically be passed to osutils.normpath first, so
478
530
    that . and .. and repeated slashes are eliminated, and the separators
479
531
    are canonical for the platform.
480
 
    
481
 
    The empty string as a dir name is taken as top-of-tree and matches 
 
532
 
 
533
    The empty string as a dir name is taken as top-of-tree and matches
482
534
    everything.
483
535
    """
484
 
    # XXX: Most callers of this can actually do something smarter by 
 
536
    # XXX: Most callers of this can actually do something smarter by
485
537
    # looking at the inventory
486
538
    if dir == fname:
487
539
        return True
488
 
    
 
540
 
489
541
    if dir == '':
490
542
        return True
491
543
 
511
563
    return False
512
564
 
513
565
 
514
 
def pumpfile(from_file, to_file, read_length=-1, buff_size=32768):
 
566
def pumpfile(from_file, to_file, read_length=-1, buff_size=32768,
 
567
             report_activity=None, direction='read'):
515
568
    """Copy contents of one file to another.
516
569
 
517
570
    The read_length can either be -1 to read to end-of-file (EOF) or
520
573
    The buff_size represents the maximum size for each read operation
521
574
    performed on from_file.
522
575
 
 
576
    :param report_activity: Call this as bytes are read, see
 
577
        Transport._report_activity
 
578
    :param direction: Will be passed to report_activity
 
579
 
523
580
    :return: The number of bytes copied.
524
581
    """
525
582
    length = 0
533
590
            if not block:
534
591
                # EOF reached
535
592
                break
 
593
            if report_activity is not None:
 
594
                report_activity(len(block), direction)
536
595
            to_file.write(block)
537
596
 
538
597
            actual_bytes_read = len(block)
545
604
            if not block:
546
605
                # EOF reached
547
606
                break
 
607
            if report_activity is not None:
 
608
                report_activity(len(block), direction)
548
609
            to_file.write(block)
549
610
            length += len(block)
550
611
    return length
591
652
    return s.hexdigest()
592
653
 
593
654
 
 
655
def size_sha_file(f):
 
656
    """Calculate the size and hexdigest of an open file.
 
657
 
 
658
    The file cursor should be already at the start and
 
659
    the caller is responsible for closing the file afterwards.
 
660
    """
 
661
    size = 0
 
662
    s = sha()
 
663
    BUFSIZE = 128<<10
 
664
    while True:
 
665
        b = f.read(BUFSIZE)
 
666
        if not b:
 
667
            break
 
668
        size += len(b)
 
669
        s.update(b)
 
670
    return size, s.hexdigest()
 
671
 
 
672
 
594
673
def sha_file_by_name(fname):
595
674
    """Calculate the SHA1 of a file by reading the full text"""
596
675
    s = sha()
597
 
    f = os.open(fname, os.O_RDONLY | O_BINARY)
 
676
    f = os.open(fname, os.O_RDONLY | O_BINARY | O_NOINHERIT)
598
677
    try:
599
678
        while True:
600
679
            b = os.read(f, 1<<16)
642
721
    return offset.days * 86400 + offset.seconds
643
722
 
644
723
weekdays = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
645
 
    
 
724
_default_format_by_weekday_num = [wd + " %Y-%m-%d %H:%M:%S" for wd in weekdays]
 
725
 
 
726
 
646
727
def format_date(t, offset=0, timezone='original', date_fmt=None,
647
728
                show_offset=True):
648
729
    """Return a formatted date string.
652
733
    :param timezone: How to display the time: 'utc', 'original' for the
653
734
         timezone specified by offset, or 'local' for the process's current
654
735
         timezone.
655
 
    :param show_offset: Whether to append the timezone.
656
 
    :param date_fmt: strftime format.
657
 
    """
 
736
    :param date_fmt: strftime format.
 
737
    :param show_offset: Whether to append the timezone.
 
738
    """
 
739
    (date_fmt, tt, offset_str) = \
 
740
               _format_date(t, offset, timezone, date_fmt, show_offset)
 
741
    date_fmt = date_fmt.replace('%a', weekdays[tt[6]])
 
742
    date_str = time.strftime(date_fmt, tt)
 
743
    return date_str + offset_str
 
744
 
 
745
 
 
746
# Cache of formatted offset strings
 
747
_offset_cache = {}
 
748
 
 
749
 
 
750
def format_date_with_offset_in_original_timezone(t, offset=0,
 
751
    _cache=_offset_cache):
 
752
    """Return a formatted date string in the original timezone.
 
753
 
 
754
    This routine may be faster then format_date.
 
755
 
 
756
    :param t: Seconds since the epoch.
 
757
    :param offset: Timezone offset in seconds east of utc.
 
758
    """
 
759
    if offset is None:
 
760
        offset = 0
 
761
    tt = time.gmtime(t + offset)
 
762
    date_fmt = _default_format_by_weekday_num[tt[6]]
 
763
    date_str = time.strftime(date_fmt, tt)
 
764
    offset_str = _cache.get(offset, None)
 
765
    if offset_str is None:
 
766
        offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
 
767
        _cache[offset] = offset_str
 
768
    return date_str + offset_str
 
769
 
 
770
 
 
771
def format_local_date(t, offset=0, timezone='original', date_fmt=None,
 
772
                      show_offset=True):
 
773
    """Return an unicode date string formatted according to the current locale.
 
774
 
 
775
    :param t: Seconds since the epoch.
 
776
    :param offset: Timezone offset in seconds east of utc.
 
777
    :param timezone: How to display the time: 'utc', 'original' for the
 
778
         timezone specified by offset, or 'local' for the process's current
 
779
         timezone.
 
780
    :param date_fmt: strftime format.
 
781
    :param show_offset: Whether to append the timezone.
 
782
    """
 
783
    (date_fmt, tt, offset_str) = \
 
784
               _format_date(t, offset, timezone, date_fmt, show_offset)
 
785
    date_str = time.strftime(date_fmt, tt)
 
786
    if not isinstance(date_str, unicode):
 
787
        date_str = date_str.decode(get_user_encoding(), 'replace')
 
788
    return date_str + offset_str
 
789
 
 
790
 
 
791
def _format_date(t, offset, timezone, date_fmt, show_offset):
658
792
    if timezone == 'utc':
659
793
        tt = time.gmtime(t)
660
794
        offset = 0
673
807
        offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
674
808
    else:
675
809
        offset_str = ''
676
 
    # day of week depends on locale, so we do this ourself
677
 
    date_fmt = date_fmt.replace('%a', weekdays[tt[6]])
678
 
    return (time.strftime(date_fmt, tt) +  offset_str)
 
810
    return (date_fmt, tt, offset_str)
679
811
 
680
812
 
681
813
def compact_date(when):
682
814
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
683
 
    
 
815
 
684
816
 
685
817
def format_delta(delta):
686
818
    """Get a nice looking string for a time delta.
762
894
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
763
895
def rand_chars(num):
764
896
    """Return a random string of num alphanumeric characters
765
 
    
766
 
    The result only contains lowercase chars because it may be used on 
 
897
 
 
898
    The result only contains lowercase chars because it may be used on
767
899
    case-insensitive filesystems.
768
900
    """
769
901
    s = ''
791
923
            rps.append(f)
792
924
    return rps
793
925
 
 
926
 
794
927
def joinpath(p):
795
928
    for f in p:
796
929
        if (f == '..') or (f is None) or (f == ''):
798
931
    return pathjoin(*p)
799
932
 
800
933
 
 
934
def parent_directories(filename):
 
935
    """Return the list of parent directories, deepest first.
 
936
    
 
937
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
 
938
    """
 
939
    parents = []
 
940
    parts = splitpath(dirname(filename))
 
941
    while parts:
 
942
        parents.append(joinpath(parts))
 
943
        parts.pop()
 
944
    return parents
 
945
 
 
946
 
 
947
_extension_load_failures = []
 
948
 
 
949
 
 
950
def failed_to_load_extension(exception):
 
951
    """Handle failing to load a binary extension.
 
952
 
 
953
    This should be called from the ImportError block guarding the attempt to
 
954
    import the native extension.  If this function returns, the pure-Python
 
955
    implementation should be loaded instead::
 
956
 
 
957
    >>> try:
 
958
    >>>     import bzrlib._fictional_extension_pyx
 
959
    >>> except ImportError, e:
 
960
    >>>     bzrlib.osutils.failed_to_load_extension(e)
 
961
    >>>     import bzrlib._fictional_extension_py
 
962
    """
 
963
    # NB: This docstring is just an example, not a doctest, because doctest
 
964
    # currently can't cope with the use of lazy imports in this namespace --
 
965
    # mbp 20090729
 
966
    
 
967
    # This currently doesn't report the failure at the time it occurs, because
 
968
    # they tend to happen very early in startup when we can't check config
 
969
    # files etc, and also we want to report all failures but not spam the user
 
970
    # with 10 warnings.
 
971
    from bzrlib import trace
 
972
    exception_str = str(exception)
 
973
    if exception_str not in _extension_load_failures:
 
974
        trace.mutter("failed to load compiled extension: %s" % exception_str)
 
975
        _extension_load_failures.append(exception_str)
 
976
 
 
977
 
 
978
def report_extension_load_failures():
 
979
    if not _extension_load_failures:
 
980
        return
 
981
    from bzrlib.config import GlobalConfig
 
982
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
 
983
        return
 
984
    # the warnings framework should by default show this only once
 
985
    from bzrlib.trace import warning
 
986
    warning(
 
987
        "bzr: warning: some compiled extensions could not be loaded; "
 
988
        "see <https://answers.launchpad.net/bzr/+faq/703>")
 
989
    # we no longer show the specific missing extensions here, because it makes
 
990
    # the message too long and scary - see
 
991
    # https://bugs.launchpad.net/bzr/+bug/430529
 
992
 
 
993
 
 
994
try:
 
995
    from bzrlib._chunks_to_lines_pyx import chunks_to_lines
 
996
except ImportError, e:
 
997
    failed_to_load_extension(e)
 
998
    from bzrlib._chunks_to_lines_py import chunks_to_lines
 
999
 
 
1000
 
801
1001
def split_lines(s):
802
1002
    """Split s into lines, but without removing the newline characters."""
 
1003
    # Trivially convert a fulltext into a 'chunked' representation, and let
 
1004
    # chunks_to_lines do the heavy lifting.
 
1005
    if isinstance(s, str):
 
1006
        # chunks_to_lines only supports 8-bit strings
 
1007
        return chunks_to_lines([s])
 
1008
    else:
 
1009
        return _split_lines(s)
 
1010
 
 
1011
 
 
1012
def _split_lines(s):
 
1013
    """Split s into lines, but without removing the newline characters.
 
1014
 
 
1015
    This supports Unicode or plain string objects.
 
1016
    """
803
1017
    lines = s.split('\n')
804
1018
    result = [line + '\n' for line in lines[:-1]]
805
1019
    if lines[-1]:
824
1038
        shutil.copyfile(src, dest)
825
1039
 
826
1040
 
827
 
# Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
828
 
# Forgiveness than Permission (EAFP) because:
829
 
# - root can damage a solaris file system by using unlink,
830
 
# - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
831
 
#   EACCES, OSX: EPERM) when invoked on a directory.
832
1041
def delete_any(path):
833
 
    """Delete a file or directory."""
 
1042
    """Delete a file, symlink or directory.  
 
1043
    
 
1044
    Will delete even if readonly.
 
1045
    """
 
1046
    try:
 
1047
       _delete_file_or_dir(path)
 
1048
    except (OSError, IOError), e:
 
1049
        if e.errno in (errno.EPERM, errno.EACCES):
 
1050
            # make writable and try again
 
1051
            try:
 
1052
                make_writable(path)
 
1053
            except (OSError, IOError):
 
1054
                pass
 
1055
            _delete_file_or_dir(path)
 
1056
        else:
 
1057
            raise
 
1058
 
 
1059
 
 
1060
def _delete_file_or_dir(path):
 
1061
    # Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
 
1062
    # Forgiveness than Permission (EAFP) because:
 
1063
    # - root can damage a solaris file system by using unlink,
 
1064
    # - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
 
1065
    #   EACCES, OSX: EPERM) when invoked on a directory.
834
1066
    if isdir(path): # Takes care of symlinks
835
1067
        os.rmdir(path)
836
1068
    else:
856
1088
            and sys.platform not in ('cygwin', 'win32'))
857
1089
 
858
1090
 
 
1091
def readlink(abspath):
 
1092
    """Return a string representing the path to which the symbolic link points.
 
1093
 
 
1094
    :param abspath: The link absolute unicode path.
 
1095
 
 
1096
    This his guaranteed to return the symbolic link in unicode in all python
 
1097
    versions.
 
1098
    """
 
1099
    link = abspath.encode(_fs_enc)
 
1100
    target = os.readlink(link)
 
1101
    target = target.decode(_fs_enc)
 
1102
    return target
 
1103
 
 
1104
 
859
1105
def contains_whitespace(s):
860
1106
    """True if there are any whitespace characters in s."""
861
1107
    # string.whitespace can include '\xa0' in certain locales, because it is
905
1151
 
906
1152
    s = []
907
1153
    head = rp
908
 
    while len(head) >= len(base):
 
1154
    while True:
 
1155
        if len(head) <= len(base) and head != base:
 
1156
            raise errors.PathNotChild(rp, base)
909
1157
        if head == base:
910
1158
            break
911
 
        head, tail = os.path.split(head)
 
1159
        head, tail = split(head)
912
1160
        if tail:
913
 
            s.insert(0, tail)
914
 
    else:
915
 
        raise errors.PathNotChild(rp, base)
 
1161
            s.append(tail)
916
1162
 
917
1163
    if s:
918
 
        return pathjoin(*s)
 
1164
        return pathjoin(*reversed(s))
919
1165
    else:
920
1166
        return ''
921
1167
 
922
1168
 
 
1169
def _cicp_canonical_relpath(base, path):
 
1170
    """Return the canonical path relative to base.
 
1171
 
 
1172
    Like relpath, but on case-insensitive-case-preserving file-systems, this
 
1173
    will return the relpath as stored on the file-system rather than in the
 
1174
    case specified in the input string, for all existing portions of the path.
 
1175
 
 
1176
    This will cause O(N) behaviour if called for every path in a tree; if you
 
1177
    have a number of paths to convert, you should use canonical_relpaths().
 
1178
    """
 
1179
    # TODO: it should be possible to optimize this for Windows by using the
 
1180
    # win32 API FindFiles function to look for the specified name - but using
 
1181
    # os.listdir() still gives us the correct, platform agnostic semantics in
 
1182
    # the short term.
 
1183
 
 
1184
    rel = relpath(base, path)
 
1185
    # '.' will have been turned into ''
 
1186
    if not rel:
 
1187
        return rel
 
1188
 
 
1189
    abs_base = abspath(base)
 
1190
    current = abs_base
 
1191
    _listdir = os.listdir
 
1192
 
 
1193
    # use an explicit iterator so we can easily consume the rest on early exit.
 
1194
    bit_iter = iter(rel.split('/'))
 
1195
    for bit in bit_iter:
 
1196
        lbit = bit.lower()
 
1197
        try:
 
1198
            next_entries = _listdir(current)
 
1199
        except OSError: # enoent, eperm, etc
 
1200
            # We can't find this in the filesystem, so just append the
 
1201
            # remaining bits.
 
1202
            current = pathjoin(current, bit, *list(bit_iter))
 
1203
            break
 
1204
        for look in next_entries:
 
1205
            if lbit == look.lower():
 
1206
                current = pathjoin(current, look)
 
1207
                break
 
1208
        else:
 
1209
            # got to the end, nothing matched, so we just return the
 
1210
            # non-existing bits as they were specified (the filename may be
 
1211
            # the target of a move, for example).
 
1212
            current = pathjoin(current, bit, *list(bit_iter))
 
1213
            break
 
1214
    return current[len(abs_base):].lstrip('/')
 
1215
 
 
1216
# XXX - TODO - we need better detection/integration of case-insensitive
 
1217
# file-systems; Linux often sees FAT32 devices (or NFS-mounted OSX
 
1218
# filesystems), for example, so could probably benefit from the same basic
 
1219
# support there.  For now though, only Windows and OSX get that support, and
 
1220
# they get it for *all* file-systems!
 
1221
if sys.platform in ('win32', 'darwin'):
 
1222
    canonical_relpath = _cicp_canonical_relpath
 
1223
else:
 
1224
    canonical_relpath = relpath
 
1225
 
 
1226
def canonical_relpaths(base, paths):
 
1227
    """Create an iterable to canonicalize a sequence of relative paths.
 
1228
 
 
1229
    The intent is for this implementation to use a cache, vastly speeding
 
1230
    up multiple transformations in the same directory.
 
1231
    """
 
1232
    # but for now, we haven't optimized...
 
1233
    return [canonical_relpath(base, p) for p in paths]
 
1234
 
923
1235
def safe_unicode(unicode_or_utf8_string):
924
1236
    """Coerce unicode_or_utf8_string into unicode.
925
1237
 
926
1238
    If it is unicode, it is returned.
927
 
    Otherwise it is decoded from utf-8. If a decoding error
928
 
    occurs, it is wrapped as a If the decoding fails, the exception is wrapped 
929
 
    as a BzrBadParameter exception.
 
1239
    Otherwise it is decoded from utf-8. If decoding fails, the exception is
 
1240
    wrapped in a BzrBadParameterNotUnicode exception.
930
1241
    """
931
1242
    if isinstance(unicode_or_utf8_string, unicode):
932
1243
        return unicode_or_utf8_string
1019
1330
 
1020
1331
    On platforms where the system normalizes filenames (Mac OSX),
1021
1332
    you can access a file by any path which will normalize correctly.
1022
 
    On platforms where the system does not normalize filenames 
 
1333
    On platforms where the system does not normalize filenames
1023
1334
    (Windows, Linux), you have to access a file by its exact path.
1024
1335
 
1025
 
    Internally, bzr only supports NFC normalization, since that is 
 
1336
    Internally, bzr only supports NFC normalization, since that is
1026
1337
    the standard for XML documents.
1027
1338
 
1028
1339
    So return the normalized path, and a flag indicating if the file
1045
1356
    normalized_filename = _inaccessible_normalized_filename
1046
1357
 
1047
1358
 
 
1359
def set_signal_handler(signum, handler, restart_syscall=True):
 
1360
    """A wrapper for signal.signal that also calls siginterrupt(signum, False)
 
1361
    on platforms that support that.
 
1362
 
 
1363
    :param restart_syscall: if set, allow syscalls interrupted by a signal to
 
1364
        automatically restart (by calling `signal.siginterrupt(signum,
 
1365
        False)`).  May be ignored if the feature is not available on this
 
1366
        platform or Python version.
 
1367
    """
 
1368
    try:
 
1369
        siginterrupt = signal.siginterrupt
 
1370
    except AttributeError:
 
1371
        # siginterrupt doesn't exist on this platform, or for this version
 
1372
        # of Python.
 
1373
        siginterrupt = lambda signum, flag: None
 
1374
    if restart_syscall:
 
1375
        def sig_handler(*args):
 
1376
            # Python resets the siginterrupt flag when a signal is
 
1377
            # received.  <http://bugs.python.org/issue8354>
 
1378
            # As a workaround for some cases, set it back the way we want it.
 
1379
            siginterrupt(signum, False)
 
1380
            # Now run the handler function passed to set_signal_handler.
 
1381
            handler(*args)
 
1382
    else:
 
1383
        sig_handler = handler
 
1384
    old_handler = signal.signal(signum, sig_handler)
 
1385
    if restart_syscall:
 
1386
        siginterrupt(signum, False)
 
1387
    return old_handler
 
1388
 
 
1389
 
 
1390
default_terminal_width = 80
 
1391
"""The default terminal width for ttys.
 
1392
 
 
1393
This is defined so that higher levels can share a common fallback value when
 
1394
terminal_width() returns None.
 
1395
"""
 
1396
 
 
1397
 
1048
1398
def terminal_width():
1049
 
    """Return estimated terminal width."""
1050
 
    if sys.platform == 'win32':
1051
 
        return win32utils.get_console_size()[0]
1052
 
    width = 0
 
1399
    """Return terminal width.
 
1400
 
 
1401
    None is returned if the width can't established precisely.
 
1402
 
 
1403
    The rules are:
 
1404
    - if BZR_COLUMNS is set, returns its value
 
1405
    - if there is no controlling terminal, returns None
 
1406
    - if COLUMNS is set, returns its value,
 
1407
 
 
1408
    From there, we need to query the OS to get the size of the controlling
 
1409
    terminal.
 
1410
 
 
1411
    Unices:
 
1412
    - get termios.TIOCGWINSZ
 
1413
    - if an error occurs or a negative value is obtained, returns None
 
1414
 
 
1415
    Windows:
 
1416
    
 
1417
    - win32utils.get_console_size() decides,
 
1418
    - returns None on error (provided default value)
 
1419
    """
 
1420
 
 
1421
    # If BZR_COLUMNS is set, take it, user is always right
 
1422
    try:
 
1423
        return int(os.environ['BZR_COLUMNS'])
 
1424
    except (KeyError, ValueError):
 
1425
        pass
 
1426
 
 
1427
    isatty = getattr(sys.stdout, 'isatty', None)
 
1428
    if  isatty is None or not isatty():
 
1429
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
 
1430
        return None
 
1431
 
 
1432
    # If COLUMNS is set, take it, the terminal knows better (even inside a
 
1433
    # given terminal, the application can decide to set COLUMNS to a lower
 
1434
    # value (splitted screen) or a bigger value (scroll bars))
 
1435
    try:
 
1436
        return int(os.environ['COLUMNS'])
 
1437
    except (KeyError, ValueError):
 
1438
        pass
 
1439
 
 
1440
    width, height = _terminal_size(None, None)
 
1441
    if width <= 0:
 
1442
        # Consider invalid values as meaning no width
 
1443
        return None
 
1444
 
 
1445
    return width
 
1446
 
 
1447
 
 
1448
def _win32_terminal_size(width, height):
 
1449
    width, height = win32utils.get_console_size(defaultx=width, defaulty=height)
 
1450
    return width, height
 
1451
 
 
1452
 
 
1453
def _ioctl_terminal_size(width, height):
1053
1454
    try:
1054
1455
        import struct, fcntl, termios
1055
1456
        s = struct.pack('HHHH', 0, 0, 0, 0)
1056
1457
        x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1057
 
        width = struct.unpack('HHHH', x)[1]
1058
 
    except IOError:
 
1458
        height, width = struct.unpack('HHHH', x)[0:2]
 
1459
    except (IOError, AttributeError):
1059
1460
        pass
1060
 
    if width <= 0:
1061
 
        try:
1062
 
            width = int(os.environ['COLUMNS'])
1063
 
        except:
 
1461
    return width, height
 
1462
 
 
1463
_terminal_size = None
 
1464
"""Returns the terminal size as (width, height).
 
1465
 
 
1466
:param width: Default value for width.
 
1467
:param height: Default value for height.
 
1468
 
 
1469
This is defined specifically for each OS and query the size of the controlling
 
1470
terminal. If any error occurs, the provided default values should be returned.
 
1471
"""
 
1472
if sys.platform == 'win32':
 
1473
    _terminal_size = _win32_terminal_size
 
1474
else:
 
1475
    _terminal_size = _ioctl_terminal_size
 
1476
 
 
1477
 
 
1478
def _terminal_size_changed(signum, frame):
 
1479
    """Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
 
1480
    width, height = _terminal_size(None, None)
 
1481
    if width is not None:
 
1482
        os.environ['COLUMNS'] = str(width)
 
1483
 
 
1484
 
 
1485
_registered_sigwinch = False
 
1486
 
 
1487
def watch_sigwinch():
 
1488
    """Register for SIGWINCH, once and only once."""
 
1489
    global _registered_sigwinch
 
1490
    if not _registered_sigwinch:
 
1491
        if sys.platform == 'win32':
 
1492
            # Martin (gz) mentioned WINDOW_BUFFER_SIZE_RECORD from
 
1493
            # ReadConsoleInput but I've no idea how to plug that in
 
1494
            # the current design -- vila 20091216
1064
1495
            pass
1065
 
    if width <= 0:
1066
 
        width = 80
1067
 
 
1068
 
    return width
 
1496
        else:
 
1497
            set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
 
1498
        _registered_sigwinch = True
1069
1499
 
1070
1500
 
1071
1501
def supports_executable():
1099
1529
            del os.environ[env_variable]
1100
1530
    else:
1101
1531
        if isinstance(value, unicode):
1102
 
            value = value.encode(bzrlib.user_encoding)
 
1532
            value = value.encode(get_user_encoding())
1103
1533
        os.environ[env_variable] = value
1104
1534
    return orig_val
1105
1535
 
1108
1538
 
1109
1539
 
1110
1540
def check_legal_path(path):
1111
 
    """Check whether the supplied path is legal.  
 
1541
    """Check whether the supplied path is legal.
1112
1542
    This is only required on Windows, so we don't test on other platforms
1113
1543
    right now.
1114
1544
    """
1148
1578
 
1149
1579
def walkdirs(top, prefix=""):
1150
1580
    """Yield data about all the directories in a tree.
1151
 
    
 
1581
 
1152
1582
    This yields all the data about the contents of a directory at a time.
1153
1583
    After each directory has been yielded, if the caller has mutated the list
1154
1584
    to exclude some directories, they are then not descended into.
1155
 
    
 
1585
 
1156
1586
    The data yielded is of the form:
1157
1587
    ((directory-relpath, directory-path-from-top),
1158
1588
    [(relpath, basename, kind, lstat, path-from-top), ...]),
1159
1589
     - directory-relpath is the relative path of the directory being returned
1160
1590
       with respect to top. prefix is prepended to this.
1161
 
     - directory-path-from-root is the path including top for this directory. 
 
1591
     - directory-path-from-root is the path including top for this directory.
1162
1592
       It is suitable for use with os functions.
1163
1593
     - relpath is the relative path within the subtree being walked.
1164
1594
     - basename is the basename of the path
1166
1596
       present within the tree - but it may be recorded as versioned. See
1167
1597
       versioned_kind.
1168
1598
     - lstat is the stat data *if* the file was statted.
1169
 
     - planned, not implemented: 
 
1599
     - planned, not implemented:
1170
1600
       path_from_tree_root is the path from the root of the tree.
1171
1601
 
1172
 
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This 
 
1602
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This
1173
1603
        allows one to walk a subtree but get paths that are relative to a tree
1174
1604
        rooted higher up.
1175
1605
    :return: an iterator over the dirs.
1176
1606
    """
1177
1607
    #TODO there is a bit of a smell where the results of the directory-
1178
 
    # summary in this, and the path from the root, may not agree 
 
1608
    # summary in this, and the path from the root, may not agree
1179
1609
    # depending on top and prefix - i.e. ./foo and foo as a pair leads to
1180
1610
    # potentially confusing output. We should make this more robust - but
1181
1611
    # not at a speed cost. RBC 20060731
1257
1687
    global _selected_dir_reader
1258
1688
    if _selected_dir_reader is None:
1259
1689
        fs_encoding = _fs_enc.upper()
1260
 
        if win32utils.winver == 'Windows NT':
 
1690
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1261
1691
            # Win98 doesn't have unicode apis like FindFirstFileW
1262
1692
            # TODO: We possibly could support Win98 by falling back to the
1263
1693
            #       original FindFirstFile, and using TCHAR instead of WCHAR,
1265
1695
            #       for win98 anyway.
1266
1696
            try:
1267
1697
                from bzrlib._walkdirs_win32 import Win32ReadDir
1268
 
            except ImportError:
1269
 
                _selected_dir_reader = UnicodeDirReader()
1270
 
            else:
1271
1698
                _selected_dir_reader = Win32ReadDir()
1272
 
        elif fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
 
1699
            except ImportError:
 
1700
                pass
 
1701
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1273
1702
            # ANSI_X3.4-1968 is a form of ASCII
1274
 
            _selected_dir_reader = UnicodeDirReader()
1275
 
        else:
1276
1703
            try:
1277
1704
                from bzrlib._readdir_pyx import UTF8DirReader
1278
 
            except ImportError:
1279
 
                # No optimised code path
1280
 
                _selected_dir_reader = UnicodeDirReader()
1281
 
            else:
1282
1705
                _selected_dir_reader = UTF8DirReader()
 
1706
            except ImportError, e:
 
1707
                failed_to_load_extension(e)
 
1708
                pass
 
1709
 
 
1710
    if _selected_dir_reader is None:
 
1711
        # Fallback to the python version
 
1712
        _selected_dir_reader = UnicodeDirReader()
 
1713
 
1283
1714
    # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1284
1715
    # But we don't actually uses 1-3 in pending, so set them to None
1285
1716
    pending = [[_selected_dir_reader.top_prefix_to_starting_dir(top, prefix)]]
1351
1782
def copy_tree(from_path, to_path, handlers={}):
1352
1783
    """Copy all of the entries in from_path into to_path.
1353
1784
 
1354
 
    :param from_path: The base directory to copy. 
 
1785
    :param from_path: The base directory to copy.
1355
1786
    :param to_path: The target directory. If it does not exist, it will
1356
1787
        be created.
1357
1788
    :param handlers: A dictionary of functions, which takes a source and
1390
1821
            real_handlers[kind](abspath, relpath)
1391
1822
 
1392
1823
 
 
1824
def copy_ownership(dst, src=None):
 
1825
    """Copy usr/grp ownership from src file/dir to dst file/dir.
 
1826
 
 
1827
    If src is None, the containing directory is used as source. If chown
 
1828
    fails, the error is ignored and a warning is printed.
 
1829
    """
 
1830
    chown = getattr(os, 'chown', None)
 
1831
    if chown is None:
 
1832
        return
 
1833
 
 
1834
    if src == None:
 
1835
        src = os.path.dirname(dst)
 
1836
        if src == '':
 
1837
            src = '.'
 
1838
 
 
1839
    try:
 
1840
        s = os.stat(src)
 
1841
        chown(dst, s.st_uid, s.st_gid)
 
1842
    except OSError, e:
 
1843
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
 
1844
 
 
1845
 
 
1846
def mkdir_with_ownership(path, ownership_src=None):
 
1847
    """Create the directory 'path' with specified ownership.
 
1848
 
 
1849
    If ownership_src is given, copies (chown) usr/grp ownership
 
1850
    from 'ownership_src' to 'path'. If ownership_src is None, use the
 
1851
    containing dir ownership.
 
1852
    """
 
1853
    os.mkdir(path)
 
1854
    copy_ownership(path, ownership_src)
 
1855
 
 
1856
 
 
1857
def open_with_ownership(filename, mode='r', bufsize=-1, ownership_src=None):
 
1858
    """Open the file 'filename' with the specified ownership.
 
1859
 
 
1860
    If ownership_src is specified, copy usr/grp ownership from ownership_src
 
1861
    to filename. If ownership_src is None, copy ownership from containing
 
1862
    directory.
 
1863
    Returns the opened file object.
 
1864
    """
 
1865
    f = open(filename, mode, bufsize)
 
1866
    copy_ownership(filename, ownership_src)
 
1867
    return f
 
1868
 
 
1869
 
1393
1870
def path_prefix_key(path):
1394
1871
    """Generate a prefix-order path key for path.
1395
1872
 
1495
1972
        return socket.gethostname().decode(get_user_encoding())
1496
1973
 
1497
1974
 
1498
 
def recv_all(socket, bytes):
 
1975
# We must not read/write any more than 64k at a time from/to a socket so we
 
1976
# don't risk "no buffer space available" errors on some platforms.  Windows in
 
1977
# particular is likely to throw WSAECONNABORTED or WSAENOBUFS if given too much
 
1978
# data at once.
 
1979
MAX_SOCKET_CHUNK = 64 * 1024
 
1980
 
 
1981
def read_bytes_from_socket(sock, report_activity=None,
 
1982
        max_read_size=MAX_SOCKET_CHUNK):
 
1983
    """Read up to max_read_size of bytes from sock and notify of progress.
 
1984
 
 
1985
    Translates "Connection reset by peer" into file-like EOF (return an
 
1986
    empty string rather than raise an error), and repeats the recv if
 
1987
    interrupted by a signal.
 
1988
    """
 
1989
    while 1:
 
1990
        try:
 
1991
            bytes = sock.recv(max_read_size)
 
1992
        except socket.error, e:
 
1993
            eno = e.args[0]
 
1994
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
 
1995
                # The connection was closed by the other side.  Callers expect
 
1996
                # an empty string to signal end-of-stream.
 
1997
                return ""
 
1998
            elif eno == errno.EINTR:
 
1999
                # Retry the interrupted recv.
 
2000
                continue
 
2001
            raise
 
2002
        else:
 
2003
            if report_activity is not None:
 
2004
                report_activity(len(bytes), 'read')
 
2005
            return bytes
 
2006
 
 
2007
 
 
2008
def recv_all(socket, count):
1499
2009
    """Receive an exact number of bytes.
1500
2010
 
1501
2011
    Regular Socket.recv() may return less than the requested number of bytes,
1502
 
    dependning on what's in the OS buffer.  MSG_WAITALL is not available
 
2012
    depending on what's in the OS buffer.  MSG_WAITALL is not available
1503
2013
    on all platforms, but this should work everywhere.  This will return
1504
2014
    less than the requested amount if the remote end closes.
1505
2015
 
1506
2016
    This isn't optimized and is intended mostly for use in testing.
1507
2017
    """
1508
2018
    b = ''
1509
 
    while len(b) < bytes:
1510
 
        new = socket.recv(bytes - len(b))
 
2019
    while len(b) < count:
 
2020
        new = read_bytes_from_socket(socket, None, count - len(b))
1511
2021
        if new == '':
1512
2022
            break # eof
1513
2023
        b += new
1514
2024
    return b
1515
2025
 
1516
2026
 
1517
 
def send_all(socket, bytes):
 
2027
def send_all(sock, bytes, report_activity=None):
1518
2028
    """Send all bytes on a socket.
 
2029
 
 
2030
    Breaks large blocks in smaller chunks to avoid buffering limitations on
 
2031
    some platforms, and catches EINTR which may be thrown if the send is
 
2032
    interrupted by a signal.
1519
2033
 
1520
 
    Regular socket.sendall() can give socket error 10053 on Windows.  This
1521
 
    implementation sends no more than 64k at a time, which avoids this problem.
 
2034
    This is preferred to socket.sendall(), because it avoids portability bugs
 
2035
    and provides activity reporting.
 
2036
 
 
2037
    :param report_activity: Call this as bytes are read, see
 
2038
        Transport._report_activity
1522
2039
    """
1523
 
    chunk_size = 2**16
1524
 
    for pos in xrange(0, len(bytes), chunk_size):
1525
 
        socket.sendall(bytes[pos:pos+chunk_size])
 
2040
    sent_total = 0
 
2041
    byte_count = len(bytes)
 
2042
    while sent_total < byte_count:
 
2043
        try:
 
2044
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
 
2045
        except socket.error, e:
 
2046
            if e.args[0] != errno.EINTR:
 
2047
                raise
 
2048
        else:
 
2049
            sent_total += sent
 
2050
            report_activity(sent, 'write')
1526
2051
 
1527
2052
 
1528
2053
def dereference_path(path):
1579
2104
        try:
1580
2105
            from bzrlib._readdir_pyx import UTF8DirReader
1581
2106
            file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
1582
 
        except ImportError:
 
2107
        except ImportError, e:
 
2108
            # This is one time where we won't warn that an extension failed to
 
2109
            # load. The extension is never available on Windows anyway.
1583
2110
            from bzrlib._readdir_py import (
1584
2111
                _kind_from_mode as file_kind_from_stat_mode
1585
2112
                )
1596
2123
        raise
1597
2124
 
1598
2125
 
 
2126
def until_no_eintr(f, *a, **kw):
 
2127
    """Run f(*a, **kw), retrying if an EINTR error occurs.
 
2128
    
 
2129
    WARNING: you must be certain that it is safe to retry the call repeatedly
 
2130
    if EINTR does occur.  This is typically only true for low-level operations
 
2131
    like os.read.  If in any doubt, don't use this.
 
2132
 
 
2133
    Keep in mind that this is not a complete solution to EINTR.  There is
 
2134
    probably code in the Python standard library and other dependencies that
 
2135
    may encounter EINTR if a signal arrives (and there is signal handler for
 
2136
    that signal).  So this function can reduce the impact for IO that bzrlib
 
2137
    directly controls, but it is not a complete solution.
 
2138
    """
 
2139
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
 
2140
    while True:
 
2141
        try:
 
2142
            return f(*a, **kw)
 
2143
        except (IOError, OSError), e:
 
2144
            if e.errno == errno.EINTR:
 
2145
                continue
 
2146
            raise
 
2147
 
 
2148
 
 
2149
def re_compile_checked(re_string, flags=0, where=""):
 
2150
    """Return a compiled re, or raise a sensible error.
 
2151
 
 
2152
    This should only be used when compiling user-supplied REs.
 
2153
 
 
2154
    :param re_string: Text form of regular expression.
 
2155
    :param flags: eg re.IGNORECASE
 
2156
    :param where: Message explaining to the user the context where
 
2157
        it occurred, eg 'log search filter'.
 
2158
    """
 
2159
    # from https://bugs.launchpad.net/bzr/+bug/251352
 
2160
    try:
 
2161
        re_obj = re.compile(re_string, flags)
 
2162
        re_obj.search("")
 
2163
        return re_obj
 
2164
    except re.error, e:
 
2165
        if where:
 
2166
            where = ' in ' + where
 
2167
        # despite the name 'error' is a type
 
2168
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
 
2169
            % (where, re_string, e))
 
2170
 
 
2171
 
 
2172
if sys.platform == "win32":
 
2173
    import msvcrt
 
2174
    def getchar():
 
2175
        return msvcrt.getch()
 
2176
else:
 
2177
    import tty
 
2178
    import termios
 
2179
    def getchar():
 
2180
        fd = sys.stdin.fileno()
 
2181
        settings = termios.tcgetattr(fd)
 
2182
        try:
 
2183
            tty.setraw(fd)
 
2184
            ch = sys.stdin.read(1)
 
2185
        finally:
 
2186
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
 
2187
        return ch
 
2188
 
 
2189
 
 
2190
if sys.platform == 'linux2':
 
2191
    def _local_concurrency():
 
2192
        concurrency = None
 
2193
        prefix = 'processor'
 
2194
        for line in file('/proc/cpuinfo', 'rb'):
 
2195
            if line.startswith(prefix):
 
2196
                concurrency = int(line[line.find(':')+1:]) + 1
 
2197
        return concurrency
 
2198
elif sys.platform == 'darwin':
 
2199
    def _local_concurrency():
 
2200
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
 
2201
                                stdout=subprocess.PIPE).communicate()[0]
 
2202
elif sys.platform[0:7] == 'freebsd':
 
2203
    def _local_concurrency():
 
2204
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
 
2205
                                stdout=subprocess.PIPE).communicate()[0]
 
2206
elif sys.platform == 'sunos5':
 
2207
    def _local_concurrency():
 
2208
        return subprocess.Popen(['psrinfo', '-p',],
 
2209
                                stdout=subprocess.PIPE).communicate()[0]
 
2210
elif sys.platform == "win32":
 
2211
    def _local_concurrency():
 
2212
        # This appears to return the number of cores.
 
2213
        return os.environ.get('NUMBER_OF_PROCESSORS')
 
2214
else:
 
2215
    def _local_concurrency():
 
2216
        # Who knows ?
 
2217
        return None
 
2218
 
 
2219
 
 
2220
_cached_local_concurrency = None
 
2221
 
 
2222
def local_concurrency(use_cache=True):
 
2223
    """Return how many processes can be run concurrently.
 
2224
 
 
2225
    Rely on platform specific implementations and default to 1 (one) if
 
2226
    anything goes wrong.
 
2227
    """
 
2228
    global _cached_local_concurrency
 
2229
 
 
2230
    if _cached_local_concurrency is not None and use_cache:
 
2231
        return _cached_local_concurrency
 
2232
 
 
2233
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
 
2234
    if concurrency is None:
 
2235
        try:
 
2236
            concurrency = _local_concurrency()
 
2237
        except (OSError, IOError):
 
2238
            pass
 
2239
    try:
 
2240
        concurrency = int(concurrency)
 
2241
    except (TypeError, ValueError):
 
2242
        concurrency = 1
 
2243
    if use_cache:
 
2244
        _cached_concurrency = concurrency
 
2245
    return concurrency
 
2246
 
 
2247
 
 
2248
class UnicodeOrBytesToBytesWriter(codecs.StreamWriter):
 
2249
    """A stream writer that doesn't decode str arguments."""
 
2250
 
 
2251
    def __init__(self, encode, stream, errors='strict'):
 
2252
        codecs.StreamWriter.__init__(self, stream, errors)
 
2253
        self.encode = encode
 
2254
 
 
2255
    def write(self, object):
 
2256
        if type(object) is str:
 
2257
            self.stream.write(object)
 
2258
        else:
 
2259
            data, _ = self.encode(object, self.errors)
 
2260
            self.stream.write(data)
 
2261
 
 
2262
if sys.platform == 'win32':
 
2263
    def open_file(filename, mode='r', bufsize=-1):
 
2264
        """This function is used to override the ``open`` builtin.
 
2265
        
 
2266
        But it uses O_NOINHERIT flag so the file handle is not inherited by
 
2267
        child processes.  Deleting or renaming a closed file opened with this
 
2268
        function is not blocking child processes.
 
2269
        """
 
2270
        writing = 'w' in mode
 
2271
        appending = 'a' in mode
 
2272
        updating = '+' in mode
 
2273
        binary = 'b' in mode
 
2274
 
 
2275
        flags = O_NOINHERIT
 
2276
        # see http://msdn.microsoft.com/en-us/library/yeby3zcb%28VS.71%29.aspx
 
2277
        # for flags for each modes.
 
2278
        if binary:
 
2279
            flags |= O_BINARY
 
2280
        else:
 
2281
            flags |= O_TEXT
 
2282
 
 
2283
        if writing:
 
2284
            if updating:
 
2285
                flags |= os.O_RDWR
 
2286
            else:
 
2287
                flags |= os.O_WRONLY
 
2288
            flags |= os.O_CREAT | os.O_TRUNC
 
2289
        elif appending:
 
2290
            if updating:
 
2291
                flags |= os.O_RDWR
 
2292
            else:
 
2293
                flags |= os.O_WRONLY
 
2294
            flags |= os.O_CREAT | os.O_APPEND
 
2295
        else: #reading
 
2296
            if updating:
 
2297
                flags |= os.O_RDWR
 
2298
            else:
 
2299
                flags |= os.O_RDONLY
 
2300
 
 
2301
        return os.fdopen(os.open(filename, flags), mode, bufsize)
 
2302
else:
 
2303
    open_file = open