~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Danny van Heumen
  • Date: 2010-03-09 21:42:11 UTC
  • mto: (4634.139.5 2.0)
  • mto: This revision was merged to the branch mainline in revision 5160.
  • Revision ID: danny@dannyvanheumen.nl-20100309214211-iqh42x6qcikgd9p3
Reverted now-useless TODO list.

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
35
34
                    splitdrive as _nt_splitdrive,
36
35
                    )
37
36
import posixpath
38
 
import sha
39
37
import shutil
40
38
from shutil import (
41
39
    rmtree,
42
40
    )
 
41
import subprocess
43
42
import tempfile
44
43
from tempfile import (
45
44
    mkdtemp,
53
52
    )
54
53
""")
55
54
 
 
55
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
 
56
# of 2.5
 
57
if sys.version_info < (2, 5):
 
58
    import md5 as _mod_md5
 
59
    md5 = _mod_md5.new
 
60
    import sha as _mod_sha
 
61
    sha = _mod_sha.new
 
62
else:
 
63
    from hashlib import (
 
64
        md5,
 
65
        sha1 as sha,
 
66
        )
 
67
 
 
68
 
56
69
import bzrlib
57
70
from bzrlib import symbol_versioning
58
 
from bzrlib.symbol_versioning import (
59
 
    deprecated_function,
60
 
    )
61
 
from bzrlib.trace import mutter
62
71
 
63
72
 
64
73
# On win32, O_BINARY is used to indicate the file should
65
74
# be opened in binary mode, rather than text mode.
66
75
# On other platforms, O_BINARY doesn't exist, because
67
76
# they always open in binary mode, so it is okay to
68
 
# OR with 0 on those platforms
 
77
# OR with 0 on those platforms.
 
78
# O_NOINHERIT and O_TEXT exists only on win32 too.
69
79
O_BINARY = getattr(os, 'O_BINARY', 0)
 
80
O_TEXT = getattr(os, 'O_TEXT', 0)
 
81
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
 
82
 
 
83
 
 
84
def get_unicode_argv():
 
85
    try:
 
86
        user_encoding = get_user_encoding()
 
87
        return [a.decode(user_encoding) for a in sys.argv[1:]]
 
88
    except UnicodeDecodeError:
 
89
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
 
90
                                                            "encoding." % a))
70
91
 
71
92
 
72
93
def make_readonly(filename):
89
110
 
90
111
    :param paths: A container (and hence not None) of paths.
91
112
    :return: A set of paths sufficient to include everything in paths via
92
 
        is_inside_any, drawn from the paths parameter.
 
113
        is_inside, drawn from the paths parameter.
93
114
    """
94
 
    search_paths = set()
95
 
    paths = set(paths)
96
 
    for path in paths:
97
 
        other_paths = paths.difference([path])
98
 
        if not is_inside_any(other_paths, path):
99
 
            # this is a top level path, we must check it.
100
 
            search_paths.add(path)
101
 
    return search_paths
 
115
    if len(paths) < 2:
 
116
        return set(paths)
 
117
 
 
118
    def sort_key(path):
 
119
        return path.split('/')
 
120
    sorted_paths = sorted(list(paths), key=sort_key)
 
121
 
 
122
    search_paths = [sorted_paths[0]]
 
123
    for path in sorted_paths[1:]:
 
124
        if not is_inside(search_paths[-1], path):
 
125
            # This path is unique, add it
 
126
            search_paths.append(path)
 
127
 
 
128
    return set(search_paths)
102
129
 
103
130
 
104
131
_QUOTE_RE = None
113
140
    global _QUOTE_RE
114
141
    if _QUOTE_RE is None:
115
142
        _QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
116
 
        
 
143
 
117
144
    if _QUOTE_RE.search(f):
118
145
        return '"' + f + '"'
119
146
    else:
122
149
 
123
150
_directory_kind = 'directory'
124
151
 
125
 
_formats = {
126
 
    stat.S_IFDIR:_directory_kind,
127
 
    stat.S_IFCHR:'chardev',
128
 
    stat.S_IFBLK:'block',
129
 
    stat.S_IFREG:'file',
130
 
    stat.S_IFIFO:'fifo',
131
 
    stat.S_IFLNK:'symlink',
132
 
    stat.S_IFSOCK:'socket',
133
 
}
134
 
 
135
 
 
136
 
def file_kind_from_stat_mode(stat_mode, _formats=_formats, _unknown='unknown'):
137
 
    """Generate a file kind from a stat mode. This is used in walkdirs.
138
 
 
139
 
    Its performance is critical: Do not mutate without careful benchmarking.
140
 
    """
141
 
    try:
142
 
        return _formats[stat_mode & 0170000]
143
 
    except KeyError:
144
 
        return _unknown
145
 
 
146
 
 
147
 
def file_kind(f, _lstat=os.lstat, _mapper=file_kind_from_stat_mode):
148
 
    try:
149
 
        return _mapper(_lstat(f).st_mode)
150
 
    except OSError, e:
151
 
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
152
 
            raise errors.NoSuchFile(f)
153
 
        raise
154
 
 
155
 
 
156
152
def get_umask():
157
153
    """Return the current umask"""
158
154
    # Assume that people aren't messing with the umask while running
194
190
 
195
191
def fancy_rename(old, new, rename_func, unlink_func):
196
192
    """A fancy rename, when you don't have atomic rename.
197
 
    
 
193
 
198
194
    :param old: The old path, to rename from
199
195
    :param new: The new path, to rename to
200
196
    :param rename_func: The potentially non-atomic rename function
202
198
    """
203
199
 
204
200
    # sftp rename doesn't allow overwriting, so play tricks:
205
 
    import random
206
201
    base = os.path.basename(new)
207
202
    dirname = os.path.dirname(new)
208
203
    tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
315
310
        path = cwd + '\\' + path
316
311
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
317
312
 
318
 
if win32utils.winver == 'Windows 98':
319
 
    _win32_abspath = _win98_abspath
320
 
 
321
313
 
322
314
def _win32_realpath(path):
323
315
    # Real _nt_realpath doesn't have a problem with a unicode cwd
344
336
    """We expect to be able to atomically replace 'new' with old.
345
337
 
346
338
    On win32, if new exists, it must be moved out of the way first,
347
 
    and then deleted. 
 
339
    and then deleted.
348
340
    """
349
341
    try:
350
342
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
351
343
    except OSError, e:
352
344
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
353
 
            # If we try to rename a non-existant file onto cwd, we get 
354
 
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT 
 
345
            # If we try to rename a non-existant file onto cwd, we get
 
346
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT
355
347
            # if the old path doesn't exist, sometimes we get EACCES
356
348
            # On Linux, we seem to get EBUSY, on Mac we get EINVAL
357
349
            os.lstat(old)
382
374
 
383
375
 
384
376
if sys.platform == 'win32':
385
 
    abspath = _win32_abspath
 
377
    if win32utils.winver == 'Windows 98':
 
378
        abspath = _win98_abspath
 
379
    else:
 
380
        abspath = _win32_abspath
386
381
    realpath = _win32_realpath
387
382
    pathjoin = _win32_pathjoin
388
383
    normpath = _win32_normpath
408
403
    def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
409
404
        """Replacer for shutil.rmtree: could remove readonly dirs/files"""
410
405
        return shutil.rmtree(path, ignore_errors, onerror)
 
406
 
 
407
    f = win32utils.get_unicode_argv     # special function or None
 
408
    if f is not None:
 
409
        get_unicode_argv = f
 
410
 
411
411
elif sys.platform == 'darwin':
412
412
    getcwd = _mac_getcwd
413
413
 
417
417
 
418
418
    This attempts to check both sys.stdout and sys.stdin to see
419
419
    what encoding they are in, and if that fails it falls back to
420
 
    bzrlib.user_encoding.
 
420
    osutils.get_user_encoding().
421
421
    The problem is that on Windows, locale.getpreferredencoding()
422
422
    is not the same encoding as that used by the console:
423
423
    http://mail.python.org/pipermail/python-list/2003-May/162357.html
425
425
    On my standard US Windows XP, the preferred encoding is
426
426
    cp1252, but the console is cp437
427
427
    """
 
428
    from bzrlib.trace import mutter
428
429
    output_encoding = getattr(sys.stdout, 'encoding', None)
429
430
    if not output_encoding:
430
431
        input_encoding = getattr(sys.stdin, 'encoding', None)
431
432
        if not input_encoding:
432
 
            output_encoding = bzrlib.user_encoding
433
 
            mutter('encoding stdout as bzrlib.user_encoding %r', output_encoding)
 
433
            output_encoding = get_user_encoding()
 
434
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
435
                   output_encoding)
434
436
        else:
435
437
            output_encoding = input_encoding
436
438
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
438
440
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
439
441
    if output_encoding == 'cp0':
440
442
        # invalid encoding (cp0 means 'no codepage' on Windows)
441
 
        output_encoding = bzrlib.user_encoding
 
443
        output_encoding = get_user_encoding()
442
444
        mutter('cp0 is invalid encoding.'
443
 
               ' encoding stdout as bzrlib.user_encoding %r', output_encoding)
 
445
               ' encoding stdout as osutils.get_user_encoding() %r',
 
446
               output_encoding)
444
447
    # check encoding
445
448
    try:
446
449
        codecs.lookup(output_encoding)
448
451
        sys.stderr.write('bzr: warning:'
449
452
                         ' unknown terminal encoding %s.\n'
450
453
                         '  Using encoding %s instead.\n'
451
 
                         % (output_encoding, bzrlib.user_encoding)
 
454
                         % (output_encoding, get_user_encoding())
452
455
                        )
453
 
        output_encoding = bzrlib.user_encoding
 
456
        output_encoding = get_user_encoding()
454
457
 
455
458
    return output_encoding
456
459
 
491
494
 
492
495
def is_inside(dir, fname):
493
496
    """True if fname is inside dir.
494
 
    
 
497
 
495
498
    The parameters should typically be passed to osutils.normpath first, so
496
499
    that . and .. and repeated slashes are eliminated, and the separators
497
500
    are canonical for the platform.
498
 
    
499
 
    The empty string as a dir name is taken as top-of-tree and matches 
 
501
 
 
502
    The empty string as a dir name is taken as top-of-tree and matches
500
503
    everything.
501
504
    """
502
 
    # XXX: Most callers of this can actually do something smarter by 
 
505
    # XXX: Most callers of this can actually do something smarter by
503
506
    # looking at the inventory
504
507
    if dir == fname:
505
508
        return True
506
 
    
 
509
 
507
510
    if dir == '':
508
511
        return True
509
512
 
529
532
    return False
530
533
 
531
534
 
532
 
def pumpfile(from_file, to_file, read_length=-1, buff_size=32768):
 
535
def pumpfile(from_file, to_file, read_length=-1, buff_size=32768,
 
536
             report_activity=None, direction='read'):
533
537
    """Copy contents of one file to another.
534
538
 
535
539
    The read_length can either be -1 to read to end-of-file (EOF) or
538
542
    The buff_size represents the maximum size for each read operation
539
543
    performed on from_file.
540
544
 
 
545
    :param report_activity: Call this as bytes are read, see
 
546
        Transport._report_activity
 
547
    :param direction: Will be passed to report_activity
 
548
 
541
549
    :return: The number of bytes copied.
542
550
    """
543
551
    length = 0
551
559
            if not block:
552
560
                # EOF reached
553
561
                break
 
562
            if report_activity is not None:
 
563
                report_activity(len(block), direction)
554
564
            to_file.write(block)
555
565
 
556
566
            actual_bytes_read = len(block)
563
573
            if not block:
564
574
                # EOF reached
565
575
                break
 
576
            if report_activity is not None:
 
577
                report_activity(len(block), direction)
566
578
            to_file.write(block)
567
579
            length += len(block)
568
580
    return length
569
581
 
570
582
 
 
583
def pump_string_file(bytes, file_handle, segment_size=None):
 
584
    """Write bytes to file_handle in many smaller writes.
 
585
 
 
586
    :param bytes: The string to write.
 
587
    :param file_handle: The file to write to.
 
588
    """
 
589
    # Write data in chunks rather than all at once, because very large
 
590
    # writes fail on some platforms (e.g. Windows with SMB  mounted
 
591
    # drives).
 
592
    if not segment_size:
 
593
        segment_size = 5242880 # 5MB
 
594
    segments = range(len(bytes) / segment_size + 1)
 
595
    write = file_handle.write
 
596
    for segment_index in segments:
 
597
        segment = buffer(bytes, segment_index * segment_size, segment_size)
 
598
        write(segment)
 
599
 
 
600
 
571
601
def file_iterator(input_file, readsize=32768):
572
602
    while True:
573
603
        b = input_file.read(readsize)
581
611
 
582
612
    The file cursor should be already at the start.
583
613
    """
584
 
    s = sha.new()
 
614
    s = sha()
585
615
    BUFSIZE = 128<<10
586
616
    while True:
587
617
        b = f.read(BUFSIZE)
591
621
    return s.hexdigest()
592
622
 
593
623
 
 
624
def size_sha_file(f):
 
625
    """Calculate the size and hexdigest of an open file.
 
626
 
 
627
    The file cursor should be already at the start and
 
628
    the caller is responsible for closing the file afterwards.
 
629
    """
 
630
    size = 0
 
631
    s = sha()
 
632
    BUFSIZE = 128<<10
 
633
    while True:
 
634
        b = f.read(BUFSIZE)
 
635
        if not b:
 
636
            break
 
637
        size += len(b)
 
638
        s.update(b)
 
639
    return size, s.hexdigest()
 
640
 
 
641
 
594
642
def sha_file_by_name(fname):
595
643
    """Calculate the SHA1 of a file by reading the full text"""
596
 
    s = sha.new()
597
 
    f = os.open(fname, os.O_RDONLY | O_BINARY)
 
644
    s = sha()
 
645
    f = os.open(fname, os.O_RDONLY | O_BINARY | O_NOINHERIT)
598
646
    try:
599
647
        while True:
600
648
            b = os.read(f, 1<<16)
605
653
        os.close(f)
606
654
 
607
655
 
608
 
def sha_strings(strings, _factory=sha.new):
 
656
def sha_strings(strings, _factory=sha):
609
657
    """Return the sha-1 of concatenation of strings"""
610
658
    s = _factory()
611
659
    map(s.update, strings)
612
660
    return s.hexdigest()
613
661
 
614
662
 
615
 
def sha_string(f, _factory=sha.new):
 
663
def sha_string(f, _factory=sha):
616
664
    return _factory(f).hexdigest()
617
665
 
618
666
 
619
667
def fingerprint_file(f):
620
668
    b = f.read()
621
669
    return {'size': len(b),
622
 
            'sha1': sha.new(b).hexdigest()}
 
670
            'sha1': sha(b).hexdigest()}
623
671
 
624
672
 
625
673
def compare_files(a, b):
642
690
    return offset.days * 86400 + offset.seconds
643
691
 
644
692
weekdays = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
645
 
    
 
693
 
646
694
def format_date(t, offset=0, timezone='original', date_fmt=None,
647
695
                show_offset=True):
648
696
    """Return a formatted date string.
652
700
    :param timezone: How to display the time: 'utc', 'original' for the
653
701
         timezone specified by offset, or 'local' for the process's current
654
702
         timezone.
655
 
    :param show_offset: Whether to append the timezone.
656
 
    :param date_fmt: strftime format.
657
 
    """
 
703
    :param date_fmt: strftime format.
 
704
    :param show_offset: Whether to append the timezone.
 
705
    """
 
706
    (date_fmt, tt, offset_str) = \
 
707
               _format_date(t, offset, timezone, date_fmt, show_offset)
 
708
    date_fmt = date_fmt.replace('%a', weekdays[tt[6]])
 
709
    date_str = time.strftime(date_fmt, tt)
 
710
    return date_str + offset_str
 
711
 
 
712
def format_local_date(t, offset=0, timezone='original', date_fmt=None,
 
713
                      show_offset=True):
 
714
    """Return an unicode date string formatted according to the current locale.
 
715
 
 
716
    :param t: Seconds since the epoch.
 
717
    :param offset: Timezone offset in seconds east of utc.
 
718
    :param timezone: How to display the time: 'utc', 'original' for the
 
719
         timezone specified by offset, or 'local' for the process's current
 
720
         timezone.
 
721
    :param date_fmt: strftime format.
 
722
    :param show_offset: Whether to append the timezone.
 
723
    """
 
724
    (date_fmt, tt, offset_str) = \
 
725
               _format_date(t, offset, timezone, date_fmt, show_offset)
 
726
    date_str = time.strftime(date_fmt, tt)
 
727
    if not isinstance(date_str, unicode):
 
728
        date_str = date_str.decode(get_user_encoding(), 'replace')
 
729
    return date_str + offset_str
 
730
 
 
731
def _format_date(t, offset, timezone, date_fmt, show_offset):
658
732
    if timezone == 'utc':
659
733
        tt = time.gmtime(t)
660
734
        offset = 0
673
747
        offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
674
748
    else:
675
749
        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)
 
750
    return (date_fmt, tt, offset_str)
679
751
 
680
752
 
681
753
def compact_date(when):
682
754
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
683
 
    
 
755
 
684
756
 
685
757
def format_delta(delta):
686
758
    """Get a nice looking string for a time delta.
762
834
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
763
835
def rand_chars(num):
764
836
    """Return a random string of num alphanumeric characters
765
 
    
766
 
    The result only contains lowercase chars because it may be used on 
 
837
 
 
838
    The result only contains lowercase chars because it may be used on
767
839
    case-insensitive filesystems.
768
840
    """
769
841
    s = ''
791
863
            rps.append(f)
792
864
    return rps
793
865
 
 
866
 
794
867
def joinpath(p):
795
868
    for f in p:
796
869
        if (f == '..') or (f is None) or (f == ''):
798
871
    return pathjoin(*p)
799
872
 
800
873
 
 
874
def parent_directories(filename):
 
875
    """Return the list of parent directories, deepest first.
 
876
    
 
877
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
 
878
    """
 
879
    parents = []
 
880
    parts = splitpath(dirname(filename))
 
881
    while parts:
 
882
        parents.append(joinpath(parts))
 
883
        parts.pop()
 
884
    return parents
 
885
 
 
886
 
 
887
try:
 
888
    from bzrlib._chunks_to_lines_pyx import chunks_to_lines
 
889
except ImportError:
 
890
    from bzrlib._chunks_to_lines_py import chunks_to_lines
 
891
 
 
892
 
801
893
def split_lines(s):
802
894
    """Split s into lines, but without removing the newline characters."""
 
895
    # Trivially convert a fulltext into a 'chunked' representation, and let
 
896
    # chunks_to_lines do the heavy lifting.
 
897
    if isinstance(s, str):
 
898
        # chunks_to_lines only supports 8-bit strings
 
899
        return chunks_to_lines([s])
 
900
    else:
 
901
        return _split_lines(s)
 
902
 
 
903
 
 
904
def _split_lines(s):
 
905
    """Split s into lines, but without removing the newline characters.
 
906
 
 
907
    This supports Unicode or plain string objects.
 
908
    """
803
909
    lines = s.split('\n')
804
910
    result = [line + '\n' for line in lines[:-1]]
805
911
    if lines[-1]:
824
930
        shutil.copyfile(src, dest)
825
931
 
826
932
 
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
933
def delete_any(path):
833
 
    """Delete a file or directory."""
 
934
    """Delete a file, symlink or directory.  
 
935
    
 
936
    Will delete even if readonly.
 
937
    """
 
938
    try:
 
939
       _delete_file_or_dir(path)
 
940
    except (OSError, IOError), e:
 
941
        if e.errno in (errno.EPERM, errno.EACCES):
 
942
            # make writable and try again
 
943
            try:
 
944
                make_writable(path)
 
945
            except (OSError, IOError):
 
946
                pass
 
947
            _delete_file_or_dir(path)
 
948
        else:
 
949
            raise
 
950
 
 
951
 
 
952
def _delete_file_or_dir(path):
 
953
    # Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
 
954
    # Forgiveness than Permission (EAFP) because:
 
955
    # - root can damage a solaris file system by using unlink,
 
956
    # - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
 
957
    #   EACCES, OSX: EPERM) when invoked on a directory.
834
958
    if isdir(path): # Takes care of symlinks
835
959
        os.rmdir(path)
836
960
    else:
856
980
            and sys.platform not in ('cygwin', 'win32'))
857
981
 
858
982
 
 
983
def readlink(abspath):
 
984
    """Return a string representing the path to which the symbolic link points.
 
985
 
 
986
    :param abspath: The link absolute unicode path.
 
987
 
 
988
    This his guaranteed to return the symbolic link in unicode in all python
 
989
    versions.
 
990
    """
 
991
    link = abspath.encode(_fs_enc)
 
992
    target = os.readlink(link)
 
993
    target = target.decode(_fs_enc)
 
994
    return target
 
995
 
 
996
 
859
997
def contains_whitespace(s):
860
998
    """True if there are any whitespace characters in s."""
861
999
    # string.whitespace can include '\xa0' in certain locales, because it is
905
1043
 
906
1044
    s = []
907
1045
    head = rp
908
 
    while len(head) >= len(base):
 
1046
    while True:
 
1047
        if len(head) <= len(base) and head != base:
 
1048
            raise errors.PathNotChild(rp, base)
909
1049
        if head == base:
910
1050
            break
911
 
        head, tail = os.path.split(head)
 
1051
        head, tail = split(head)
912
1052
        if tail:
913
 
            s.insert(0, tail)
914
 
    else:
915
 
        raise errors.PathNotChild(rp, base)
 
1053
            s.append(tail)
916
1054
 
917
1055
    if s:
918
 
        return pathjoin(*s)
 
1056
        return pathjoin(*reversed(s))
919
1057
    else:
920
1058
        return ''
921
1059
 
922
1060
 
 
1061
def _cicp_canonical_relpath(base, path):
 
1062
    """Return the canonical path relative to base.
 
1063
 
 
1064
    Like relpath, but on case-insensitive-case-preserving file-systems, this
 
1065
    will return the relpath as stored on the file-system rather than in the
 
1066
    case specified in the input string, for all existing portions of the path.
 
1067
 
 
1068
    This will cause O(N) behaviour if called for every path in a tree; if you
 
1069
    have a number of paths to convert, you should use canonical_relpaths().
 
1070
    """
 
1071
    # TODO: it should be possible to optimize this for Windows by using the
 
1072
    # win32 API FindFiles function to look for the specified name - but using
 
1073
    # os.listdir() still gives us the correct, platform agnostic semantics in
 
1074
    # the short term.
 
1075
 
 
1076
    rel = relpath(base, path)
 
1077
    # '.' will have been turned into ''
 
1078
    if not rel:
 
1079
        return rel
 
1080
 
 
1081
    abs_base = abspath(base)
 
1082
    current = abs_base
 
1083
    _listdir = os.listdir
 
1084
 
 
1085
    # use an explicit iterator so we can easily consume the rest on early exit.
 
1086
    bit_iter = iter(rel.split('/'))
 
1087
    for bit in bit_iter:
 
1088
        lbit = bit.lower()
 
1089
        try:
 
1090
            next_entries = _listdir(current)
 
1091
        except OSError: # enoent, eperm, etc
 
1092
            # We can't find this in the filesystem, so just append the
 
1093
            # remaining bits.
 
1094
            current = pathjoin(current, bit, *list(bit_iter))
 
1095
            break
 
1096
        for look in next_entries:
 
1097
            if lbit == look.lower():
 
1098
                current = pathjoin(current, look)
 
1099
                break
 
1100
        else:
 
1101
            # got to the end, nothing matched, so we just return the
 
1102
            # non-existing bits as they were specified (the filename may be
 
1103
            # the target of a move, for example).
 
1104
            current = pathjoin(current, bit, *list(bit_iter))
 
1105
            break
 
1106
    return current[len(abs_base):].lstrip('/')
 
1107
 
 
1108
# XXX - TODO - we need better detection/integration of case-insensitive
 
1109
# file-systems; Linux often sees FAT32 devices (or NFS-mounted OSX
 
1110
# filesystems), for example, so could probably benefit from the same basic
 
1111
# support there.  For now though, only Windows and OSX get that support, and
 
1112
# they get it for *all* file-systems!
 
1113
if sys.platform in ('win32', 'darwin'):
 
1114
    canonical_relpath = _cicp_canonical_relpath
 
1115
else:
 
1116
    canonical_relpath = relpath
 
1117
 
 
1118
def canonical_relpaths(base, paths):
 
1119
    """Create an iterable to canonicalize a sequence of relative paths.
 
1120
 
 
1121
    The intent is for this implementation to use a cache, vastly speeding
 
1122
    up multiple transformations in the same directory.
 
1123
    """
 
1124
    # but for now, we haven't optimized...
 
1125
    return [canonical_relpath(base, p) for p in paths]
 
1126
 
923
1127
def safe_unicode(unicode_or_utf8_string):
924
1128
    """Coerce unicode_or_utf8_string into unicode.
925
1129
 
926
1130
    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.
 
1131
    Otherwise it is decoded from utf-8. If decoding fails, the exception is
 
1132
    wrapped in a BzrBadParameterNotUnicode exception.
930
1133
    """
931
1134
    if isinstance(unicode_or_utf8_string, unicode):
932
1135
        return unicode_or_utf8_string
1019
1222
 
1020
1223
    On platforms where the system normalizes filenames (Mac OSX),
1021
1224
    you can access a file by any path which will normalize correctly.
1022
 
    On platforms where the system does not normalize filenames 
 
1225
    On platforms where the system does not normalize filenames
1023
1226
    (Windows, Linux), you have to access a file by its exact path.
1024
1227
 
1025
 
    Internally, bzr only supports NFC normalization, since that is 
 
1228
    Internally, bzr only supports NFC normalization, since that is
1026
1229
    the standard for XML documents.
1027
1230
 
1028
1231
    So return the normalized path, and a flag indicating if the file
1099
1302
            del os.environ[env_variable]
1100
1303
    else:
1101
1304
        if isinstance(value, unicode):
1102
 
            value = value.encode(bzrlib.user_encoding)
 
1305
            value = value.encode(get_user_encoding())
1103
1306
        os.environ[env_variable] = value
1104
1307
    return orig_val
1105
1308
 
1108
1311
 
1109
1312
 
1110
1313
def check_legal_path(path):
1111
 
    """Check whether the supplied path is legal.  
 
1314
    """Check whether the supplied path is legal.
1112
1315
    This is only required on Windows, so we don't test on other platforms
1113
1316
    right now.
1114
1317
    """
1118
1321
        raise errors.IllegalPath(path)
1119
1322
 
1120
1323
 
 
1324
_WIN32_ERROR_DIRECTORY = 267 # Similar to errno.ENOTDIR
 
1325
 
 
1326
def _is_error_enotdir(e):
 
1327
    """Check if this exception represents ENOTDIR.
 
1328
 
 
1329
    Unfortunately, python is very inconsistent about the exception
 
1330
    here. The cases are:
 
1331
      1) Linux, Mac OSX all versions seem to set errno == ENOTDIR
 
1332
      2) Windows, Python2.4, uses errno == ERROR_DIRECTORY (267)
 
1333
         which is the windows error code.
 
1334
      3) Windows, Python2.5 uses errno == EINVAL and
 
1335
         winerror == ERROR_DIRECTORY
 
1336
 
 
1337
    :param e: An Exception object (expected to be OSError with an errno
 
1338
        attribute, but we should be able to cope with anything)
 
1339
    :return: True if this represents an ENOTDIR error. False otherwise.
 
1340
    """
 
1341
    en = getattr(e, 'errno', None)
 
1342
    if (en == errno.ENOTDIR
 
1343
        or (sys.platform == 'win32'
 
1344
            and (en == _WIN32_ERROR_DIRECTORY
 
1345
                 or (en == errno.EINVAL
 
1346
                     and getattr(e, 'winerror', None) == _WIN32_ERROR_DIRECTORY)
 
1347
        ))):
 
1348
        return True
 
1349
    return False
 
1350
 
 
1351
 
1121
1352
def walkdirs(top, prefix=""):
1122
1353
    """Yield data about all the directories in a tree.
1123
 
    
 
1354
 
1124
1355
    This yields all the data about the contents of a directory at a time.
1125
1356
    After each directory has been yielded, if the caller has mutated the list
1126
1357
    to exclude some directories, they are then not descended into.
1127
 
    
 
1358
 
1128
1359
    The data yielded is of the form:
1129
1360
    ((directory-relpath, directory-path-from-top),
1130
1361
    [(relpath, basename, kind, lstat, path-from-top), ...]),
1131
1362
     - directory-relpath is the relative path of the directory being returned
1132
1363
       with respect to top. prefix is prepended to this.
1133
 
     - directory-path-from-root is the path including top for this directory. 
 
1364
     - directory-path-from-root is the path including top for this directory.
1134
1365
       It is suitable for use with os functions.
1135
1366
     - relpath is the relative path within the subtree being walked.
1136
1367
     - basename is the basename of the path
1138
1369
       present within the tree - but it may be recorded as versioned. See
1139
1370
       versioned_kind.
1140
1371
     - lstat is the stat data *if* the file was statted.
1141
 
     - planned, not implemented: 
 
1372
     - planned, not implemented:
1142
1373
       path_from_tree_root is the path from the root of the tree.
1143
1374
 
1144
 
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This 
 
1375
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This
1145
1376
        allows one to walk a subtree but get paths that are relative to a tree
1146
1377
        rooted higher up.
1147
1378
    :return: an iterator over the dirs.
1148
1379
    """
1149
1380
    #TODO there is a bit of a smell where the results of the directory-
1150
 
    # summary in this, and the path from the root, may not agree 
 
1381
    # summary in this, and the path from the root, may not agree
1151
1382
    # depending on top and prefix - i.e. ./foo and foo as a pair leads to
1152
1383
    # potentially confusing output. We should make this more robust - but
1153
1384
    # not at a speed cost. RBC 20060731
1154
1385
    _lstat = os.lstat
1155
1386
    _directory = _directory_kind
1156
1387
    _listdir = os.listdir
1157
 
    _kind_from_mode = _formats.get
 
1388
    _kind_from_mode = file_kind_from_stat_mode
1158
1389
    pending = [(safe_unicode(prefix), "", _directory, None, safe_unicode(top))]
1159
1390
    while pending:
1160
1391
        # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1167
1398
 
1168
1399
        dirblock = []
1169
1400
        append = dirblock.append
1170
 
        for name in sorted(_listdir(top)):
1171
 
            abspath = top_slash + name
1172
 
            statvalue = _lstat(abspath)
1173
 
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
1174
 
            append((relprefix + name, name, kind, statvalue, abspath))
 
1401
        try:
 
1402
            names = sorted(_listdir(top))
 
1403
        except OSError, e:
 
1404
            if not _is_error_enotdir(e):
 
1405
                raise
 
1406
        else:
 
1407
            for name in names:
 
1408
                abspath = top_slash + name
 
1409
                statvalue = _lstat(abspath)
 
1410
                kind = _kind_from_mode(statvalue.st_mode)
 
1411
                append((relprefix + name, name, kind, statvalue, abspath))
1175
1412
        yield (relroot, top), dirblock
1176
1413
 
1177
1414
        # push the user specified dirs from dirblock
1178
1415
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1179
1416
 
1180
1417
 
 
1418
class DirReader(object):
 
1419
    """An interface for reading directories."""
 
1420
 
 
1421
    def top_prefix_to_starting_dir(self, top, prefix=""):
 
1422
        """Converts top and prefix to a starting dir entry
 
1423
 
 
1424
        :param top: A utf8 path
 
1425
        :param prefix: An optional utf8 path to prefix output relative paths
 
1426
            with.
 
1427
        :return: A tuple starting with prefix, and ending with the native
 
1428
            encoding of top.
 
1429
        """
 
1430
        raise NotImplementedError(self.top_prefix_to_starting_dir)
 
1431
 
 
1432
    def read_dir(self, prefix, top):
 
1433
        """Read a specific dir.
 
1434
 
 
1435
        :param prefix: A utf8 prefix to be preprended to the path basenames.
 
1436
        :param top: A natively encoded path to read.
 
1437
        :return: A list of the directories contents. Each item contains:
 
1438
            (utf8_relpath, utf8_name, kind, lstatvalue, native_abspath)
 
1439
        """
 
1440
        raise NotImplementedError(self.read_dir)
 
1441
 
 
1442
 
 
1443
_selected_dir_reader = None
 
1444
 
 
1445
 
1181
1446
def _walkdirs_utf8(top, prefix=""):
1182
1447
    """Yield data about all the directories in a tree.
1183
1448
 
1192
1457
        path-from-top might be unicode or utf8, but it is the correct path to
1193
1458
        pass to os functions to affect the file in question. (such as os.lstat)
1194
1459
    """
1195
 
    fs_encoding = _fs_enc.upper()
1196
 
    if (sys.platform == 'win32' or
1197
 
        fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968')): # ascii
1198
 
        return _walkdirs_unicode_to_utf8(top, prefix=prefix)
1199
 
    else:
1200
 
        return _walkdirs_fs_utf8(top, prefix=prefix)
1201
 
 
1202
 
 
1203
 
def _walkdirs_fs_utf8(top, prefix=""):
1204
 
    """See _walkdirs_utf8.
1205
 
 
1206
 
    This sub-function is called when we know the filesystem is already in utf8
1207
 
    encoding. So we don't need to transcode filenames.
1208
 
    """
1209
 
    _lstat = os.lstat
1210
 
    _directory = _directory_kind
1211
 
    _listdir = os.listdir
1212
 
    _kind_from_mode = _formats.get
 
1460
    global _selected_dir_reader
 
1461
    if _selected_dir_reader is None:
 
1462
        fs_encoding = _fs_enc.upper()
 
1463
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
 
1464
            # Win98 doesn't have unicode apis like FindFirstFileW
 
1465
            # TODO: We possibly could support Win98 by falling back to the
 
1466
            #       original FindFirstFile, and using TCHAR instead of WCHAR,
 
1467
            #       but that gets a bit tricky, and requires custom compiling
 
1468
            #       for win98 anyway.
 
1469
            try:
 
1470
                from bzrlib._walkdirs_win32 import Win32ReadDir
 
1471
                _selected_dir_reader = Win32ReadDir()
 
1472
            except ImportError:
 
1473
                pass
 
1474
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
 
1475
            # ANSI_X3.4-1968 is a form of ASCII
 
1476
            try:
 
1477
                from bzrlib._readdir_pyx import UTF8DirReader
 
1478
                _selected_dir_reader = UTF8DirReader()
 
1479
            except ImportError:
 
1480
                pass
 
1481
 
 
1482
    if _selected_dir_reader is None:
 
1483
        # Fallback to the python version
 
1484
        _selected_dir_reader = UnicodeDirReader()
1213
1485
 
1214
1486
    # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1215
1487
    # But we don't actually uses 1-3 in pending, so set them to None
1216
 
    pending = [(safe_utf8(prefix), None, None, None, safe_utf8(top))]
 
1488
    pending = [[_selected_dir_reader.top_prefix_to_starting_dir(top, prefix)]]
 
1489
    read_dir = _selected_dir_reader.read_dir
 
1490
    _directory = _directory_kind
1217
1491
    while pending:
1218
 
        relroot, _, _, _, top = pending.pop()
1219
 
        if relroot:
1220
 
            relprefix = relroot + '/'
1221
 
        else:
1222
 
            relprefix = ''
1223
 
        top_slash = top + '/'
1224
 
 
1225
 
        dirblock = []
1226
 
        append = dirblock.append
1227
 
        for name in sorted(_listdir(top)):
1228
 
            abspath = top_slash + name
1229
 
            statvalue = _lstat(abspath)
1230
 
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
1231
 
            append((relprefix + name, name, kind, statvalue, abspath))
 
1492
        relroot, _, _, _, top = pending[-1].pop()
 
1493
        if not pending[-1]:
 
1494
            pending.pop()
 
1495
        dirblock = sorted(read_dir(relroot, top))
1232
1496
        yield (relroot, top), dirblock
1233
 
 
1234
1497
        # push the user specified dirs from dirblock
1235
 
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1236
 
 
1237
 
 
1238
 
def _walkdirs_unicode_to_utf8(top, prefix=""):
1239
 
    """See _walkdirs_utf8
1240
 
 
1241
 
    Because Win32 has a Unicode api, all of the 'path-from-top' entries will be
1242
 
    Unicode paths.
1243
 
    This is currently the fallback code path when the filesystem encoding is
1244
 
    not UTF-8. It may be better to implement an alternative so that we can
1245
 
    safely handle paths that are not properly decodable in the current
1246
 
    encoding.
1247
 
    """
1248
 
    _utf8_encode = codecs.getencoder('utf8')
1249
 
    _lstat = os.lstat
1250
 
    _directory = _directory_kind
1251
 
    _listdir = os.listdir
1252
 
    _kind_from_mode = _formats.get
1253
 
 
1254
 
    pending = [(safe_utf8(prefix), None, None, None, safe_unicode(top))]
1255
 
    while pending:
1256
 
        relroot, _, _, _, top = pending.pop()
1257
 
        if relroot:
1258
 
            relprefix = relroot + '/'
 
1498
        next = [d for d in reversed(dirblock) if d[2] == _directory]
 
1499
        if next:
 
1500
            pending.append(next)
 
1501
 
 
1502
 
 
1503
class UnicodeDirReader(DirReader):
 
1504
    """A dir reader for non-utf8 file systems, which transcodes."""
 
1505
 
 
1506
    __slots__ = ['_utf8_encode']
 
1507
 
 
1508
    def __init__(self):
 
1509
        self._utf8_encode = codecs.getencoder('utf8')
 
1510
 
 
1511
    def top_prefix_to_starting_dir(self, top, prefix=""):
 
1512
        """See DirReader.top_prefix_to_starting_dir."""
 
1513
        return (safe_utf8(prefix), None, None, None, safe_unicode(top))
 
1514
 
 
1515
    def read_dir(self, prefix, top):
 
1516
        """Read a single directory from a non-utf8 file system.
 
1517
 
 
1518
        top, and the abspath element in the output are unicode, all other paths
 
1519
        are utf8. Local disk IO is done via unicode calls to listdir etc.
 
1520
 
 
1521
        This is currently the fallback code path when the filesystem encoding is
 
1522
        not UTF-8. It may be better to implement an alternative so that we can
 
1523
        safely handle paths that are not properly decodable in the current
 
1524
        encoding.
 
1525
 
 
1526
        See DirReader.read_dir for details.
 
1527
        """
 
1528
        _utf8_encode = self._utf8_encode
 
1529
        _lstat = os.lstat
 
1530
        _listdir = os.listdir
 
1531
        _kind_from_mode = file_kind_from_stat_mode
 
1532
 
 
1533
        if prefix:
 
1534
            relprefix = prefix + '/'
1259
1535
        else:
1260
1536
            relprefix = ''
1261
1537
        top_slash = top + u'/'
1263
1539
        dirblock = []
1264
1540
        append = dirblock.append
1265
1541
        for name in sorted(_listdir(top)):
1266
 
            name_utf8 = _utf8_encode(name)[0]
 
1542
            try:
 
1543
                name_utf8 = _utf8_encode(name)[0]
 
1544
            except UnicodeDecodeError:
 
1545
                raise errors.BadFilenameEncoding(
 
1546
                    _utf8_encode(relprefix)[0] + name, _fs_enc)
1267
1547
            abspath = top_slash + name
1268
1548
            statvalue = _lstat(abspath)
1269
 
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
 
1549
            kind = _kind_from_mode(statvalue.st_mode)
1270
1550
            append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
1271
 
        yield (relroot, top), dirblock
1272
 
 
1273
 
        # push the user specified dirs from dirblock
1274
 
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
 
1551
        return dirblock
1275
1552
 
1276
1553
 
1277
1554
def copy_tree(from_path, to_path, handlers={}):
1278
1555
    """Copy all of the entries in from_path into to_path.
1279
1556
 
1280
 
    :param from_path: The base directory to copy. 
 
1557
    :param from_path: The base directory to copy.
1281
1558
    :param to_path: The target directory. If it does not exist, it will
1282
1559
        be created.
1283
1560
    :param handlers: A dictionary of functions, which takes a source and
1352
1629
        return _cached_user_encoding
1353
1630
 
1354
1631
    if sys.platform == 'darwin':
1355
 
        # work around egregious python 2.4 bug
 
1632
        # python locale.getpreferredencoding() always return
 
1633
        # 'mac-roman' on darwin. That's a lie.
1356
1634
        sys.platform = 'posix'
1357
1635
        try:
 
1636
            if os.environ.get('LANG', None) is None:
 
1637
                # If LANG is not set, we end up with 'ascii', which is bad
 
1638
                # ('mac-roman' is more than ascii), so we set a default which
 
1639
                # will give us UTF-8 (which appears to work in all cases on
 
1640
                # OSX). Users are still free to override LANG of course, as
 
1641
                # long as it give us something meaningful. This work-around
 
1642
                # *may* not be needed with python 3k and/or OSX 10.5, but will
 
1643
                # work with them too -- vila 20080908
 
1644
                os.environ['LANG'] = 'en_US.UTF-8'
1358
1645
            import locale
1359
1646
        finally:
1360
1647
            sys.platform = 'darwin'
1397
1684
    return user_encoding
1398
1685
 
1399
1686
 
 
1687
def get_host_name():
 
1688
    """Return the current unicode host name.
 
1689
 
 
1690
    This is meant to be used in place of socket.gethostname() because that
 
1691
    behaves inconsistently on different platforms.
 
1692
    """
 
1693
    if sys.platform == "win32":
 
1694
        import win32utils
 
1695
        return win32utils.get_host_name()
 
1696
    else:
 
1697
        import socket
 
1698
        return socket.gethostname().decode(get_user_encoding())
 
1699
 
 
1700
 
1400
1701
def recv_all(socket, bytes):
1401
1702
    """Receive an exact number of bytes.
1402
1703
 
1409
1710
    """
1410
1711
    b = ''
1411
1712
    while len(b) < bytes:
1412
 
        new = socket.recv(bytes - len(b))
 
1713
        new = until_no_eintr(socket.recv, bytes - len(b))
1413
1714
        if new == '':
1414
1715
            break # eof
1415
1716
        b += new
1416
1717
    return b
1417
1718
 
1418
1719
 
1419
 
def send_all(socket, bytes):
 
1720
def send_all(socket, bytes, report_activity=None):
1420
1721
    """Send all bytes on a socket.
1421
1722
 
1422
1723
    Regular socket.sendall() can give socket error 10053 on Windows.  This
1423
1724
    implementation sends no more than 64k at a time, which avoids this problem.
 
1725
 
 
1726
    :param report_activity: Call this as bytes are read, see
 
1727
        Transport._report_activity
1424
1728
    """
1425
1729
    chunk_size = 2**16
1426
1730
    for pos in xrange(0, len(bytes), chunk_size):
1427
 
        socket.sendall(bytes[pos:pos+chunk_size])
 
1731
        block = bytes[pos:pos+chunk_size]
 
1732
        if report_activity is not None:
 
1733
            report_activity(len(block), 'write')
 
1734
        until_no_eintr(socket.sendall, block)
1428
1735
 
1429
1736
 
1430
1737
def dereference_path(path):
1473
1780
        base = abspath(pathjoin(base, '..', '..'))
1474
1781
    filename = pathjoin(base, resource_relpath)
1475
1782
    return open(filename, 'rU').read()
 
1783
 
 
1784
 
 
1785
def file_kind_from_stat_mode_thunk(mode):
 
1786
    global file_kind_from_stat_mode
 
1787
    if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
 
1788
        try:
 
1789
            from bzrlib._readdir_pyx import UTF8DirReader
 
1790
            file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
 
1791
        except ImportError:
 
1792
            from bzrlib._readdir_py import (
 
1793
                _kind_from_mode as file_kind_from_stat_mode
 
1794
                )
 
1795
    return file_kind_from_stat_mode(mode)
 
1796
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
 
1797
 
 
1798
 
 
1799
def file_kind(f, _lstat=os.lstat):
 
1800
    try:
 
1801
        return file_kind_from_stat_mode(_lstat(f).st_mode)
 
1802
    except OSError, e:
 
1803
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
 
1804
            raise errors.NoSuchFile(f)
 
1805
        raise
 
1806
 
 
1807
 
 
1808
def until_no_eintr(f, *a, **kw):
 
1809
    """Run f(*a, **kw), retrying if an EINTR error occurs."""
 
1810
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
 
1811
    while True:
 
1812
        try:
 
1813
            return f(*a, **kw)
 
1814
        except (IOError, OSError), e:
 
1815
            if e.errno == errno.EINTR:
 
1816
                continue
 
1817
            raise
 
1818
 
 
1819
def re_compile_checked(re_string, flags=0, where=""):
 
1820
    """Return a compiled re, or raise a sensible error.
 
1821
 
 
1822
    This should only be used when compiling user-supplied REs.
 
1823
 
 
1824
    :param re_string: Text form of regular expression.
 
1825
    :param flags: eg re.IGNORECASE
 
1826
    :param where: Message explaining to the user the context where
 
1827
        it occurred, eg 'log search filter'.
 
1828
    """
 
1829
    # from https://bugs.launchpad.net/bzr/+bug/251352
 
1830
    try:
 
1831
        re_obj = re.compile(re_string, flags)
 
1832
        re_obj.search("")
 
1833
        return re_obj
 
1834
    except re.error, e:
 
1835
        if where:
 
1836
            where = ' in ' + where
 
1837
        # despite the name 'error' is a type
 
1838
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
 
1839
            % (where, re_string, e))
 
1840
 
 
1841
 
 
1842
if sys.platform == "win32":
 
1843
    import msvcrt
 
1844
    def getchar():
 
1845
        return msvcrt.getch()
 
1846
else:
 
1847
    import tty
 
1848
    import termios
 
1849
    def getchar():
 
1850
        fd = sys.stdin.fileno()
 
1851
        settings = termios.tcgetattr(fd)
 
1852
        try:
 
1853
            tty.setraw(fd)
 
1854
            ch = sys.stdin.read(1)
 
1855
        finally:
 
1856
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
 
1857
        return ch
 
1858
 
 
1859
 
 
1860
if sys.platform == 'linux2':
 
1861
    def _local_concurrency():
 
1862
        concurrency = None
 
1863
        prefix = 'processor'
 
1864
        for line in file('/proc/cpuinfo', 'rb'):
 
1865
            if line.startswith(prefix):
 
1866
                concurrency = int(line[line.find(':')+1:]) + 1
 
1867
        return concurrency
 
1868
elif sys.platform == 'darwin':
 
1869
    def _local_concurrency():
 
1870
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
 
1871
                                stdout=subprocess.PIPE).communicate()[0]
 
1872
elif sys.platform[0:7] == 'freebsd':
 
1873
    def _local_concurrency():
 
1874
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
 
1875
                                stdout=subprocess.PIPE).communicate()[0]
 
1876
elif sys.platform == 'sunos5':
 
1877
    def _local_concurrency():
 
1878
        return subprocess.Popen(['psrinfo', '-p',],
 
1879
                                stdout=subprocess.PIPE).communicate()[0]
 
1880
elif sys.platform == "win32":
 
1881
    def _local_concurrency():
 
1882
        # This appears to return the number of cores.
 
1883
        return os.environ.get('NUMBER_OF_PROCESSORS')
 
1884
else:
 
1885
    def _local_concurrency():
 
1886
        # Who knows ?
 
1887
        return None
 
1888
 
 
1889
 
 
1890
_cached_local_concurrency = None
 
1891
 
 
1892
def local_concurrency(use_cache=True):
 
1893
    """Return how many processes can be run concurrently.
 
1894
 
 
1895
    Rely on platform specific implementations and default to 1 (one) if
 
1896
    anything goes wrong.
 
1897
    """
 
1898
    global _cached_local_concurrency
 
1899
    if _cached_local_concurrency is not None and use_cache:
 
1900
        return _cached_local_concurrency
 
1901
 
 
1902
    try:
 
1903
        concurrency = _local_concurrency()
 
1904
    except (OSError, IOError):
 
1905
        concurrency = None
 
1906
    try:
 
1907
        concurrency = int(concurrency)
 
1908
    except (TypeError, ValueError):
 
1909
        concurrency = 1
 
1910
    if use_cache:
 
1911
        _cached_concurrency = concurrency
 
1912
    return concurrency
 
1913
 
 
1914
if sys.platform == 'win32':
 
1915
    def open_file(filename, mode='r', bufsize=-1):
 
1916
        """This function is used to override the ``open`` builtin.
 
1917
        
 
1918
        But it uses O_NOINHERIT flag so the file handle is not inherited by
 
1919
        child processes.  Deleting or renaming a closed file opened with this
 
1920
        function is not blocking child processes.
 
1921
        """
 
1922
        writing = 'w' in mode
 
1923
        appending = 'a' in mode
 
1924
        updating = '+' in mode
 
1925
        binary = 'b' in mode
 
1926
 
 
1927
        flags = O_NOINHERIT
 
1928
        # see http://msdn.microsoft.com/en-us/library/yeby3zcb%28VS.71%29.aspx
 
1929
        # for flags for each modes.
 
1930
        if binary:
 
1931
            flags |= O_BINARY
 
1932
        else:
 
1933
            flags |= O_TEXT
 
1934
 
 
1935
        if writing:
 
1936
            if updating:
 
1937
                flags |= os.O_RDWR
 
1938
            else:
 
1939
                flags |= os.O_WRONLY
 
1940
            flags |= os.O_CREAT | os.O_TRUNC
 
1941
        elif appending:
 
1942
            if updating:
 
1943
                flags |= os.O_RDWR
 
1944
            else:
 
1945
                flags |= os.O_WRONLY
 
1946
            flags |= os.O_CREAT | os.O_APPEND
 
1947
        else: #reading
 
1948
            if updating:
 
1949
                flags |= os.O_RDWR
 
1950
            else:
 
1951
                flags |= os.O_RDONLY
 
1952
 
 
1953
        return os.fdopen(os.open(filename, flags), mode, bufsize)
 
1954
else:
 
1955
    open_file = open