/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Robert Collins
  • Date: 2008-09-24 07:33:56 UTC
  • mto: This revision was merged to the branch mainline in revision 3734.
  • Revision ID: robertc@robertcollins.net-20080924073356-dfg5qqbd7f74mwmt
Work around ReST FAIL.

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