/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Andrew Bennetts
  • Date: 2008-09-14 10:23:29 UTC
  • mto: This revision was merged to the branch mainline in revision 3756.
  • Revision ID: andrew.bennetts@canonical.com-20080914102329-2nvv40h7fljpvcxt
Tidy imports in bzrlib/msgeditor.py as suggested by John's review.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
import os
18
18
import re
19
19
import stat
20
 
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
 
20
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
 
21
                  S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
21
22
import sys
22
23
import time
23
 
import codecs
24
24
 
25
25
from bzrlib.lazy_import import lazy_import
26
26
lazy_import(globals(), """
 
27
import codecs
27
28
from datetime import datetime
28
29
import errno
29
30
from ntpath import (abspath as _nt_abspath,
33
34
                    splitdrive as _nt_splitdrive,
34
35
                    )
35
36
import posixpath
 
37
import sha
36
38
import shutil
37
39
from shutil import (
38
40
    rmtree,
39
41
    )
40
 
import socket
41
 
import subprocess
42
42
import tempfile
43
43
from tempfile import (
44
44
    mkdtemp,
48
48
from bzrlib import (
49
49
    cache_utf8,
50
50
    errors,
51
 
    trace,
52
51
    win32utils,
53
52
    )
54
53
""")
55
54
 
56
 
from bzrlib.symbol_versioning import (
57
 
    deprecated_function,
58
 
    deprecated_in,
59
 
    )
60
 
 
61
 
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
62
 
# of 2.5
63
 
if sys.version_info < (2, 5):
64
 
    import md5 as _mod_md5
65
 
    md5 = _mod_md5.new
66
 
    import sha as _mod_sha
67
 
    sha = _mod_sha.new
68
 
else:
69
 
    from hashlib import (
70
 
        md5,
71
 
        sha1 as sha,
72
 
        )
73
 
 
74
55
 
75
56
import bzrlib
76
57
from bzrlib import symbol_versioning
77
58
 
78
59
 
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
87
 
 
88
60
# On win32, O_BINARY is used to indicate the file should
89
61
# be opened in binary mode, rather than text mode.
90
62
# On other platforms, O_BINARY doesn't exist, because
91
63
# 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.
 
64
# OR with 0 on those platforms
94
65
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
66
 
107
67
 
108
68
def make_readonly(filename):
125
85
 
126
86
    :param paths: A container (and hence not None) of paths.
127
87
    :return: A set of paths sufficient to include everything in paths via
128
 
        is_inside, drawn from the paths parameter.
 
88
        is_inside_any, drawn from the paths parameter.
129
89
    """
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)
 
90
    search_paths = set()
 
91
    paths = set(paths)
 
92
    for path in paths:
 
93
        other_paths = paths.difference([path])
 
94
        if not is_inside_any(other_paths, path):
 
95
            # this is a top level path, we must check it.
 
96
            search_paths.add(path)
 
97
    return search_paths
144
98
 
145
99
 
146
100
_QUOTE_RE = None
155
109
    global _QUOTE_RE
156
110
    if _QUOTE_RE is None:
157
111
        _QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
158
 
 
 
112
        
159
113
    if _QUOTE_RE.search(f):
160
114
        return '"' + f + '"'
161
115
    else:
164
118
 
165
119
_directory_kind = 'directory'
166
120
 
 
121
_formats = {
 
122
    stat.S_IFDIR:_directory_kind,
 
123
    stat.S_IFCHR:'chardev',
 
124
    stat.S_IFBLK:'block',
 
125
    stat.S_IFREG:'file',
 
126
    stat.S_IFIFO:'fifo',
 
127
    stat.S_IFLNK:'symlink',
 
128
    stat.S_IFSOCK:'socket',
 
129
}
 
130
 
 
131
 
 
132
def file_kind_from_stat_mode(stat_mode, _formats=_formats, _unknown='unknown'):
 
133
    """Generate a file kind from a stat mode. This is used in walkdirs.
 
134
 
 
135
    Its performance is critical: Do not mutate without careful benchmarking.
 
136
    """
 
137
    try:
 
138
        return _formats[stat_mode & 0170000]
 
139
    except KeyError:
 
140
        return _unknown
 
141
 
 
142
 
 
143
def file_kind(f, _lstat=os.lstat, _mapper=file_kind_from_stat_mode):
 
144
    try:
 
145
        return _mapper(_lstat(f).st_mode)
 
146
    except OSError, e:
 
147
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
 
148
            raise errors.NoSuchFile(f)
 
149
        raise
 
150
 
 
151
 
167
152
def get_umask():
168
153
    """Return the current umask"""
169
154
    # Assume that people aren't messing with the umask while running
186
171
    try:
187
172
        return _kind_marker_map[kind]
188
173
    except KeyError:
189
 
        # Slightly faster than using .get(, '') when the common case is that
190
 
        # kind will be found
191
 
        return ''
 
174
        raise errors.BzrError('invalid file kind %r' % kind)
192
175
 
193
176
 
194
177
lexists = getattr(os.path, 'lexists', None)
207
190
 
208
191
def fancy_rename(old, new, rename_func, unlink_func):
209
192
    """A fancy rename, when you don't have atomic rename.
210
 
 
 
193
    
211
194
    :param old: The old path, to rename from
212
195
    :param new: The new path, to rename to
213
196
    :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
 
197
    :param unlink_func: A way to delete the target file if the full rename succeeds
216
198
    """
 
199
 
217
200
    # sftp rename doesn't allow overwriting, so play tricks:
218
201
    base = os.path.basename(new)
219
202
    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))
 
203
    tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
225
204
    tmp_name = pathjoin(dirname, tmp_name)
226
205
 
227
206
    # Rename the file out of the way, but keep track if it didn't exist
247
226
    else:
248
227
        file_existed = True
249
228
 
250
 
    failure_exc = None
251
229
    success = False
252
230
    try:
253
231
        try:
259
237
            # source and target may be aliases of each other (e.g. on a
260
238
            # case-insensitive filesystem), so we may have accidentally renamed
261
239
            # 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
 
240
            if not (file_existed and e.errno in (None, errno.ENOENT)):
 
241
                raise
268
242
    finally:
269
243
        if file_existed:
270
244
            # If the file used to exist, rename it back into place
273
247
                unlink_func(tmp_name)
274
248
            else:
275
249
                rename_func(tmp_name, new)
276
 
    if failure_exc is not None:
277
 
        raise failure_exc[0], failure_exc[1], failure_exc[2]
278
250
 
279
251
 
280
252
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
308
280
 
309
281
 
310
282
def _win32_abspath(path):
 
283
    global _win32_abspath
 
284
    if win32utils.winver == 'Windows 98':
 
285
        _win32_abspath = _win98_abspath
 
286
    else:
 
287
        _win32_abspath = _real_win32_abspath
 
288
    return _win32_abspath(path)
 
289
 
 
290
 
 
291
def _real_win32_abspath(path):
311
292
    # Real _nt_abspath doesn't have a problem with a unicode cwd
312
293
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
313
294
 
360
341
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
361
342
 
362
343
 
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
344
def _win32_rename(old, new):
372
345
    """We expect to be able to atomically replace 'new' with old.
373
346
 
374
347
    On win32, if new exists, it must be moved out of the way first,
375
 
    and then deleted.
 
348
    and then deleted. 
376
349
    """
377
350
    try:
378
 
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
 
351
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
379
352
    except OSError, e:
380
353
        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
 
354
            # If we try to rename a non-existant file onto cwd, we get 
 
355
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT 
383
356
            # if the old path doesn't exist, sometimes we get EACCES
384
357
            # On Linux, we seem to get EBUSY, on Mac we get EINVAL
385
358
            os.lstat(old)
386
359
        raise
387
360
 
388
361
 
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
362
def _mac_getcwd():
400
363
    return unicodedata.normalize('NFC', os.getcwdu())
401
364
 
406
369
realpath = _posix_realpath
407
370
pathjoin = os.path.join
408
371
normpath = os.path.normpath
409
 
rename = _wrapped_rename # overridden below on win32
410
372
getcwd = os.getcwdu
 
373
rename = os.rename
411
374
dirname = os.path.dirname
412
375
basename = os.path.basename
413
376
split = os.path.split
420
383
 
421
384
 
422
385
if sys.platform == 'win32':
423
 
    if win32utils.winver == 'Windows 98':
424
 
        abspath = _win98_abspath
425
 
    else:
426
 
        abspath = _win32_abspath
 
386
    abspath = _win32_abspath
427
387
    realpath = _win32_realpath
428
388
    pathjoin = _win32_pathjoin
429
389
    normpath = _win32_normpath
449
409
    def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
450
410
        """Replacer for shutil.rmtree: could remove readonly dirs/files"""
451
411
        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
412
elif sys.platform == 'darwin':
458
413
    getcwd = _mac_getcwd
459
414
 
540
495
 
541
496
def is_inside(dir, fname):
542
497
    """True if fname is inside dir.
543
 
 
 
498
    
544
499
    The parameters should typically be passed to osutils.normpath first, so
545
500
    that . and .. and repeated slashes are eliminated, and the separators
546
501
    are canonical for the platform.
547
 
 
548
 
    The empty string as a dir name is taken as top-of-tree and matches
 
502
    
 
503
    The empty string as a dir name is taken as top-of-tree and matches 
549
504
    everything.
550
505
    """
551
 
    # XXX: Most callers of this can actually do something smarter by
 
506
    # XXX: Most callers of this can actually do something smarter by 
552
507
    # looking at the inventory
553
508
    if dir == fname:
554
509
        return True
555
 
 
 
510
    
556
511
    if dir == '':
557
512
        return True
558
513
 
578
533
    return False
579
534
 
580
535
 
581
 
def pumpfile(from_file, to_file, read_length=-1, buff_size=32768,
582
 
             report_activity=None, direction='read'):
 
536
def pumpfile(from_file, to_file, read_length=-1, buff_size=32768):
583
537
    """Copy contents of one file to another.
584
538
 
585
539
    The read_length can either be -1 to read to end-of-file (EOF) or
588
542
    The buff_size represents the maximum size for each read operation
589
543
    performed on from_file.
590
544
 
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
545
    :return: The number of bytes copied.
596
546
    """
597
547
    length = 0
605
555
            if not block:
606
556
                # EOF reached
607
557
                break
608
 
            if report_activity is not None:
609
 
                report_activity(len(block), direction)
610
558
            to_file.write(block)
611
559
 
612
560
            actual_bytes_read = len(block)
619
567
            if not block:
620
568
                # EOF reached
621
569
                break
622
 
            if report_activity is not None:
623
 
                report_activity(len(block), direction)
624
570
            to_file.write(block)
625
571
            length += len(block)
626
572
    return length
657
603
 
658
604
    The file cursor should be already at the start.
659
605
    """
660
 
    s = sha()
 
606
    s = sha.new()
661
607
    BUFSIZE = 128<<10
662
608
    while True:
663
609
        b = f.read(BUFSIZE)
667
613
    return s.hexdigest()
668
614
 
669
615
 
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
616
def sha_file_by_name(fname):
689
617
    """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)
 
618
    s = sha.new()
 
619
    f = os.open(fname, os.O_RDONLY | O_BINARY)
692
620
    try:
693
621
        while True:
694
622
            b = os.read(f, 1<<16)
699
627
        os.close(f)
700
628
 
701
629
 
702
 
def sha_strings(strings, _factory=sha):
 
630
def sha_strings(strings):
703
631
    """Return the sha-1 of concatenation of strings"""
704
 
    s = _factory()
705
 
    map(s.update, strings)
706
 
    return s.hexdigest()
707
 
 
708
 
 
709
 
def sha_string(f, _factory=sha):
710
 
    return _factory(f).hexdigest()
 
632
    # Do some hackery here to install an optimised version of this function on
 
633
    # the first invocation of this function.  (We don't define it like this
 
634
    # initially so that we can avoid loading the sha module, which takes up to
 
635
    # 2ms, unless we need to.)
 
636
    global sha_strings
 
637
    def sha_strings(strings, _factory=sha.new):
 
638
        """Return the sha-1 of concatenation of strings"""
 
639
        s = _factory()
 
640
        map(s.update, strings)
 
641
        return s.hexdigest()
 
642
    # Now that we've installed the real version, call it.
 
643
    return sha_strings(strings)
 
644
 
 
645
 
 
646
def sha_string(f):
 
647
    global sha_string
 
648
    def sha_string(f, _factory=sha.new):
 
649
        return _factory(f).hexdigest()
 
650
    return sha_string(f)
 
651
 
711
652
 
712
653
 
713
654
def fingerprint_file(f):
714
655
    b = f.read()
715
656
    return {'size': len(b),
716
 
            'sha1': sha(b).hexdigest()}
 
657
            'sha1': sha.new(b).hexdigest()}
717
658
 
718
659
 
719
660
def compare_files(a, b):
736
677
    return offset.days * 86400 + offset.seconds
737
678
 
738
679
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
 
 
 
680
    
742
681
def format_date(t, offset=0, timezone='original', date_fmt=None,
743
682
                show_offset=True):
744
683
    """Return a formatted date string.
748
687
    :param timezone: How to display the time: 'utc', 'original' for the
749
688
         timezone specified by offset, or 'local' for the process's current
750
689
         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):
 
690
    :param show_offset: Whether to append the timezone.
 
691
    :param date_fmt: strftime format.
 
692
    """
807
693
    if timezone == 'utc':
808
694
        tt = time.gmtime(t)
809
695
        offset = 0
822
708
        offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
823
709
    else:
824
710
        offset_str = ''
825
 
    return (date_fmt, tt, offset_str)
 
711
    # day of week depends on locale, so we do this ourself
 
712
    date_fmt = date_fmt.replace('%a', weekdays[tt[6]])
 
713
    return (time.strftime(date_fmt, tt) +  offset_str)
826
714
 
827
715
 
828
716
def compact_date(when):
829
717
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
830
 
 
 
718
    
831
719
 
832
720
def format_delta(delta):
833
721
    """Get a nice looking string for a time delta.
909
797
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
910
798
def rand_chars(num):
911
799
    """Return a random string of num alphanumeric characters
912
 
 
913
 
    The result only contains lowercase chars because it may be used on
 
800
    
 
801
    The result only contains lowercase chars because it may be used on 
914
802
    case-insensitive filesystems.
915
803
    """
916
804
    s = ''
938
826
            rps.append(f)
939
827
    return rps
940
828
 
941
 
 
942
829
def joinpath(p):
943
830
    for f in p:
944
831
        if (f == '..') or (f is None) or (f == ''):
946
833
    return pathjoin(*p)
947
834
 
948
835
 
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
836
def split_lines(s):
1017
837
    """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
838
    lines = s.split('\n')
1033
839
    result = [line + '\n' for line in lines[:-1]]
1034
840
    if lines[-1]:
1053
859
        shutil.copyfile(src, dest)
1054
860
 
1055
861
 
 
862
# Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
 
863
# Forgiveness than Permission (EAFP) because:
 
864
# - root can damage a solaris file system by using unlink,
 
865
# - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
 
866
#   EACCES, OSX: EPERM) when invoked on a directory.
1056
867
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.
 
868
    """Delete a file or directory."""
1081
869
    if isdir(path): # Takes care of symlinks
1082
870
        os.rmdir(path)
1083
871
    else:
1103
891
            and sys.platform not in ('cygwin', 'win32'))
1104
892
 
1105
893
 
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
894
def contains_whitespace(s):
1121
895
    """True if there are any whitespace characters in s."""
1122
896
    # string.whitespace can include '\xa0' in certain locales, because it is
1147
921
 
1148
922
 
1149
923
def relpath(base, path):
1150
 
    """Return path relative to base, or raise PathNotChild exception.
 
924
    """Return path relative to base, or raise exception.
1151
925
 
1152
926
    The path may be either an absolute path or a path relative to the
1153
927
    current working directory.
1155
929
    os.path.commonprefix (python2.4) has a bad bug that it works just
1156
930
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
1157
931
    avoids that problem.
1158
 
 
1159
 
    NOTE: `base` should not have a trailing slash otherwise you'll get
1160
 
    PathNotChild exceptions regardless of `path`.
1161
932
    """
1162
933
 
1163
934
    if len(base) < MIN_ABS_PATHLENGTH:
1169
940
 
1170
941
    s = []
1171
942
    head = rp
1172
 
    while True:
1173
 
        if len(head) <= len(base) and head != base:
1174
 
            raise errors.PathNotChild(rp, base)
 
943
    while len(head) >= len(base):
1175
944
        if head == base:
1176
945
            break
1177
 
        head, tail = split(head)
 
946
        head, tail = os.path.split(head)
1178
947
        if tail:
1179
 
            s.append(tail)
 
948
            s.insert(0, tail)
 
949
    else:
 
950
        raise errors.PathNotChild(rp, base)
1180
951
 
1181
952
    if s:
1182
 
        return pathjoin(*reversed(s))
 
953
        return pathjoin(*s)
1183
954
    else:
1184
955
        return ''
1185
956
 
1186
957
 
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
958
def safe_unicode(unicode_or_utf8_string):
1254
959
    """Coerce unicode_or_utf8_string into unicode.
1255
960
 
1256
961
    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.
 
962
    Otherwise it is decoded from utf-8. If a decoding error
 
963
    occurs, it is wrapped as a If the decoding fails, the exception is wrapped 
 
964
    as a BzrBadParameter exception.
1259
965
    """
1260
966
    if isinstance(unicode_or_utf8_string, unicode):
1261
967
        return unicode_or_utf8_string
1348
1054
 
1349
1055
    On platforms where the system normalizes filenames (Mac OSX),
1350
1056
    you can access a file by any path which will normalize correctly.
1351
 
    On platforms where the system does not normalize filenames
 
1057
    On platforms where the system does not normalize filenames 
1352
1058
    (Windows, Linux), you have to access a file by its exact path.
1353
1059
 
1354
 
    Internally, bzr only supports NFC normalization, since that is
 
1060
    Internally, bzr only supports NFC normalization, since that is 
1355
1061
    the standard for XML documents.
1356
1062
 
1357
1063
    So return the normalized path, and a flag indicating if the file
1374
1080
    normalized_filename = _inaccessible_normalized_filename
1375
1081
 
1376
1082
 
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
1083
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):
 
1084
    """Return estimated terminal width."""
 
1085
    if sys.platform == 'win32':
 
1086
        return win32utils.get_console_size()[0]
 
1087
    width = 0
1477
1088
    try:
1478
1089
        import struct, fcntl, termios
1479
1090
        s = struct.pack('HHHH', 0, 0, 0, 0)
1480
1091
        x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1481
 
        height, width = struct.unpack('HHHH', x)[0:2]
1482
 
    except (IOError, AttributeError):
 
1092
        width = struct.unpack('HHHH', x)[1]
 
1093
    except IOError:
1483
1094
        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:
 
1095
    if width <= 0:
1516
1096
        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
 
1097
            width = int(os.environ['COLUMNS'])
 
1098
        except:
1522
1099
            pass
1523
 
        _registered_sigwinch = True
 
1100
    if width <= 0:
 
1101
        width = 80
 
1102
 
 
1103
    return width
1524
1104
 
1525
1105
 
1526
1106
def supports_executable():
1563
1143
 
1564
1144
 
1565
1145
def check_legal_path(path):
1566
 
    """Check whether the supplied path is legal.
 
1146
    """Check whether the supplied path is legal.  
1567
1147
    This is only required on Windows, so we don't test on other platforms
1568
1148
    right now.
1569
1149
    """
1603
1183
 
1604
1184
def walkdirs(top, prefix=""):
1605
1185
    """Yield data about all the directories in a tree.
1606
 
 
 
1186
    
1607
1187
    This yields all the data about the contents of a directory at a time.
1608
1188
    After each directory has been yielded, if the caller has mutated the list
1609
1189
    to exclude some directories, they are then not descended into.
1610
 
 
 
1190
    
1611
1191
    The data yielded is of the form:
1612
1192
    ((directory-relpath, directory-path-from-top),
1613
1193
    [(relpath, basename, kind, lstat, path-from-top), ...]),
1614
1194
     - directory-relpath is the relative path of the directory being returned
1615
1195
       with respect to top. prefix is prepended to this.
1616
 
     - directory-path-from-root is the path including top for this directory.
 
1196
     - directory-path-from-root is the path including top for this directory. 
1617
1197
       It is suitable for use with os functions.
1618
1198
     - relpath is the relative path within the subtree being walked.
1619
1199
     - basename is the basename of the path
1621
1201
       present within the tree - but it may be recorded as versioned. See
1622
1202
       versioned_kind.
1623
1203
     - lstat is the stat data *if* the file was statted.
1624
 
     - planned, not implemented:
 
1204
     - planned, not implemented: 
1625
1205
       path_from_tree_root is the path from the root of the tree.
1626
1206
 
1627
 
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This
 
1207
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This 
1628
1208
        allows one to walk a subtree but get paths that are relative to a tree
1629
1209
        rooted higher up.
1630
1210
    :return: an iterator over the dirs.
1631
1211
    """
1632
1212
    #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
 
1213
    # summary in this, and the path from the root, may not agree 
1634
1214
    # depending on top and prefix - i.e. ./foo and foo as a pair leads to
1635
1215
    # potentially confusing output. We should make this more robust - but
1636
1216
    # not at a speed cost. RBC 20060731
1637
1217
    _lstat = os.lstat
1638
1218
    _directory = _directory_kind
1639
1219
    _listdir = os.listdir
1640
 
    _kind_from_mode = file_kind_from_stat_mode
 
1220
    _kind_from_mode = _formats.get
1641
1221
    pending = [(safe_unicode(prefix), "", _directory, None, safe_unicode(top))]
1642
1222
    while pending:
1643
1223
        # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1659
1239
            for name in names:
1660
1240
                abspath = top_slash + name
1661
1241
                statvalue = _lstat(abspath)
1662
 
                kind = _kind_from_mode(statvalue.st_mode)
 
1242
                kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
1663
1243
                append((relprefix + name, name, kind, statvalue, abspath))
1664
1244
        yield (relroot, top), dirblock
1665
1245
 
1667
1247
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1668
1248
 
1669
1249
 
1670
 
class DirReader(object):
1671
 
    """An interface for reading directories."""
1672
 
 
1673
 
    def top_prefix_to_starting_dir(self, top, prefix=""):
1674
 
        """Converts top and prefix to a starting dir entry
1675
 
 
1676
 
        :param top: A utf8 path
1677
 
        :param prefix: An optional utf8 path to prefix output relative paths
1678
 
            with.
1679
 
        :return: A tuple starting with prefix, and ending with the native
1680
 
            encoding of top.
1681
 
        """
1682
 
        raise NotImplementedError(self.top_prefix_to_starting_dir)
1683
 
 
1684
 
    def read_dir(self, prefix, top):
1685
 
        """Read a specific dir.
1686
 
 
1687
 
        :param prefix: A utf8 prefix to be preprended to the path basenames.
1688
 
        :param top: A natively encoded path to read.
1689
 
        :return: A list of the directories contents. Each item contains:
1690
 
            (utf8_relpath, utf8_name, kind, lstatvalue, native_abspath)
1691
 
        """
1692
 
        raise NotImplementedError(self.read_dir)
1693
 
 
1694
 
 
1695
 
_selected_dir_reader = None
1696
 
 
 
1250
_real_walkdirs_utf8 = None
1697
1251
 
1698
1252
def _walkdirs_utf8(top, prefix=""):
1699
1253
    """Yield data about all the directories in a tree.
1709
1263
        path-from-top might be unicode or utf8, but it is the correct path to
1710
1264
        pass to os functions to affect the file in question. (such as os.lstat)
1711
1265
    """
1712
 
    global _selected_dir_reader
1713
 
    if _selected_dir_reader is None:
 
1266
    global _real_walkdirs_utf8
 
1267
    if _real_walkdirs_utf8 is None:
1714
1268
        fs_encoding = _fs_enc.upper()
1715
1269
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1716
1270
            # Win98 doesn't have unicode apis like FindFirstFileW
1719
1273
            #       but that gets a bit tricky, and requires custom compiling
1720
1274
            #       for win98 anyway.
1721
1275
            try:
1722
 
                from bzrlib._walkdirs_win32 import Win32ReadDir
1723
 
                _selected_dir_reader = Win32ReadDir()
 
1276
                from bzrlib._walkdirs_win32 import _walkdirs_utf8_win32_find_file
1724
1277
            except ImportError:
1725
 
                pass
1726
 
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
 
1278
                _real_walkdirs_utf8 = _walkdirs_unicode_to_utf8
 
1279
            else:
 
1280
                _real_walkdirs_utf8 = _walkdirs_utf8_win32_find_file
 
1281
        elif fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1727
1282
            # ANSI_X3.4-1968 is a form of ASCII
1728
 
            try:
1729
 
                from bzrlib._readdir_pyx import UTF8DirReader
1730
 
                _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()
 
1283
            _real_walkdirs_utf8 = _walkdirs_unicode_to_utf8
 
1284
        else:
 
1285
            _real_walkdirs_utf8 = _walkdirs_fs_utf8
 
1286
    return _real_walkdirs_utf8(top, prefix=prefix)
 
1287
 
 
1288
 
 
1289
def _walkdirs_fs_utf8(top, prefix=""):
 
1290
    """See _walkdirs_utf8.
 
1291
 
 
1292
    This sub-function is called when we know the filesystem is already in utf8
 
1293
    encoding. So we don't need to transcode filenames.
 
1294
    """
 
1295
    _lstat = os.lstat
 
1296
    _directory = _directory_kind
 
1297
    # Use C accelerated directory listing.
 
1298
    _listdir = _read_dir
 
1299
    _kind_from_mode = _formats.get
1738
1300
 
1739
1301
    # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1740
1302
    # But we don't actually uses 1-3 in pending, so set them to None
1741
 
    pending = [[_selected_dir_reader.top_prefix_to_starting_dir(top, prefix)]]
1742
 
    read_dir = _selected_dir_reader.read_dir
1743
 
    _directory = _directory_kind
 
1303
    pending = [(safe_utf8(prefix), None, None, None, safe_utf8(top))]
1744
1304
    while pending:
1745
 
        relroot, _, _, _, top = pending[-1].pop()
1746
 
        if not pending[-1]:
1747
 
            pending.pop()
1748
 
        dirblock = sorted(read_dir(relroot, top))
 
1305
        relroot, _, _, _, top = pending.pop()
 
1306
        if relroot:
 
1307
            relprefix = relroot + '/'
 
1308
        else:
 
1309
            relprefix = ''
 
1310
        top_slash = top + '/'
 
1311
 
 
1312
        dirblock = []
 
1313
        append = dirblock.append
 
1314
        # read_dir supplies in should-stat order.
 
1315
        for _, name in sorted(_listdir(top)):
 
1316
            abspath = top_slash + name
 
1317
            statvalue = _lstat(abspath)
 
1318
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
 
1319
            append((relprefix + name, name, kind, statvalue, abspath))
 
1320
        dirblock.sort()
1749
1321
        yield (relroot, top), dirblock
 
1322
 
1750
1323
        # push the user specified dirs from dirblock
1751
 
        next = [d for d in reversed(dirblock) if d[2] == _directory]
1752
 
        if next:
1753
 
            pending.append(next)
1754
 
 
1755
 
 
1756
 
class UnicodeDirReader(DirReader):
1757
 
    """A dir reader for non-utf8 file systems, which transcodes."""
1758
 
 
1759
 
    __slots__ = ['_utf8_encode']
1760
 
 
1761
 
    def __init__(self):
1762
 
        self._utf8_encode = codecs.getencoder('utf8')
1763
 
 
1764
 
    def top_prefix_to_starting_dir(self, top, prefix=""):
1765
 
        """See DirReader.top_prefix_to_starting_dir."""
1766
 
        return (safe_utf8(prefix), None, None, None, safe_unicode(top))
1767
 
 
1768
 
    def read_dir(self, prefix, top):
1769
 
        """Read a single directory from a non-utf8 file system.
1770
 
 
1771
 
        top, and the abspath element in the output are unicode, all other paths
1772
 
        are utf8. Local disk IO is done via unicode calls to listdir etc.
1773
 
 
1774
 
        This is currently the fallback code path when the filesystem encoding is
1775
 
        not UTF-8. It may be better to implement an alternative so that we can
1776
 
        safely handle paths that are not properly decodable in the current
1777
 
        encoding.
1778
 
 
1779
 
        See DirReader.read_dir for details.
1780
 
        """
1781
 
        _utf8_encode = self._utf8_encode
1782
 
        _lstat = os.lstat
1783
 
        _listdir = os.listdir
1784
 
        _kind_from_mode = file_kind_from_stat_mode
1785
 
 
1786
 
        if prefix:
1787
 
            relprefix = prefix + '/'
 
1324
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
 
1325
 
 
1326
 
 
1327
def _walkdirs_unicode_to_utf8(top, prefix=""):
 
1328
    """See _walkdirs_utf8
 
1329
 
 
1330
    Because Win32 has a Unicode api, all of the 'path-from-top' entries will be
 
1331
    Unicode paths.
 
1332
    This is currently the fallback code path when the filesystem encoding is
 
1333
    not UTF-8. It may be better to implement an alternative so that we can
 
1334
    safely handle paths that are not properly decodable in the current
 
1335
    encoding.
 
1336
    """
 
1337
    _utf8_encode = codecs.getencoder('utf8')
 
1338
    _lstat = os.lstat
 
1339
    _directory = _directory_kind
 
1340
    _listdir = os.listdir
 
1341
    _kind_from_mode = _formats.get
 
1342
 
 
1343
    pending = [(safe_utf8(prefix), None, None, None, safe_unicode(top))]
 
1344
    while pending:
 
1345
        relroot, _, _, _, top = pending.pop()
 
1346
        if relroot:
 
1347
            relprefix = relroot + '/'
1788
1348
        else:
1789
1349
            relprefix = ''
1790
1350
        top_slash = top + u'/'
1792
1352
        dirblock = []
1793
1353
        append = dirblock.append
1794
1354
        for name in sorted(_listdir(top)):
1795
 
            try:
1796
 
                name_utf8 = _utf8_encode(name)[0]
1797
 
            except UnicodeDecodeError:
1798
 
                raise errors.BadFilenameEncoding(
1799
 
                    _utf8_encode(relprefix)[0] + name, _fs_enc)
 
1355
            name_utf8 = _utf8_encode(name)[0]
1800
1356
            abspath = top_slash + name
1801
1357
            statvalue = _lstat(abspath)
1802
 
            kind = _kind_from_mode(statvalue.st_mode)
 
1358
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
1803
1359
            append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
1804
 
        return dirblock
 
1360
        yield (relroot, top), dirblock
 
1361
 
 
1362
        # push the user specified dirs from dirblock
 
1363
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1805
1364
 
1806
1365
 
1807
1366
def copy_tree(from_path, to_path, handlers={}):
1808
1367
    """Copy all of the entries in from_path into to_path.
1809
1368
 
1810
 
    :param from_path: The base directory to copy.
 
1369
    :param from_path: The base directory to copy. 
1811
1370
    :param to_path: The target directory. If it does not exist, it will
1812
1371
        be created.
1813
1372
    :param handlers: A dictionary of functions, which takes a source and
1846
1405
            real_handlers[kind](abspath, relpath)
1847
1406
 
1848
1407
 
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
1408
def path_prefix_key(path):
1872
1409
    """Generate a prefix-order path key for path.
1873
1410
 
1904
1441
        return _cached_user_encoding
1905
1442
 
1906
1443
    if sys.platform == 'darwin':
1907
 
        # python locale.getpreferredencoding() always return
1908
 
        # 'mac-roman' on darwin. That's a lie.
 
1444
        # work around egregious python 2.4 bug
1909
1445
        sys.platform = 'posix'
1910
1446
        try:
1911
 
            if os.environ.get('LANG', None) is None:
1912
 
                # If LANG is not set, we end up with 'ascii', which is bad
1913
 
                # ('mac-roman' is more than ascii), so we set a default which
1914
 
                # will give us UTF-8 (which appears to work in all cases on
1915
 
                # OSX). Users are still free to override LANG of course, as
1916
 
                # long as it give us something meaningful. This work-around
1917
 
                # *may* not be needed with python 3k and/or OSX 10.5, but will
1918
 
                # work with them too -- vila 20080908
1919
 
                os.environ['LANG'] = 'en_US.UTF-8'
1920
1447
            import locale
1921
1448
        finally:
1922
1449
            sys.platform = 'darwin'
1973
1500
        return socket.gethostname().decode(get_user_encoding())
1974
1501
 
1975
1502
 
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):
 
1503
def recv_all(socket, bytes):
2010
1504
    """Receive an exact number of bytes.
2011
1505
 
2012
1506
    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
 
1507
    dependning on what's in the OS buffer.  MSG_WAITALL is not available
2014
1508
    on all platforms, but this should work everywhere.  This will return
2015
1509
    less than the requested amount if the remote end closes.
2016
1510
 
2017
1511
    This isn't optimized and is intended mostly for use in testing.
2018
1512
    """
2019
1513
    b = ''
2020
 
    while len(b) < count:
2021
 
        new = read_bytes_from_socket(socket, None, count - len(b))
 
1514
    while len(b) < bytes:
 
1515
        new = socket.recv(bytes - len(b))
2022
1516
        if new == '':
2023
1517
            break # eof
2024
1518
        b += new
2025
1519
    return b
2026
1520
 
2027
1521
 
2028
 
def send_all(sock, bytes, report_activity=None):
 
1522
def send_all(socket, bytes):
2029
1523
    """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
1524
 
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
 
1525
    Regular socket.sendall() can give socket error 10053 on Windows.  This
 
1526
    implementation sends no more than 64k at a time, which avoids this problem.
2040
1527
    """
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')
 
1528
    chunk_size = 2**16
 
1529
    for pos in xrange(0, len(bytes), chunk_size):
 
1530
        socket.sendall(bytes[pos:pos+chunk_size])
2052
1531
 
2053
1532
 
2054
1533
def dereference_path(path):
2099
1578
    return open(filename, 'rU').read()
2100
1579
 
2101
1580
 
2102
 
def file_kind_from_stat_mode_thunk(mode):
2103
 
    global file_kind_from_stat_mode
2104
 
    if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
2105
 
        try:
2106
 
            from bzrlib._readdir_pyx import UTF8DirReader
2107
 
            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.
2111
 
            from bzrlib._readdir_py import (
2112
 
                _kind_from_mode as file_kind_from_stat_mode
2113
 
                )
2114
 
    return file_kind_from_stat_mode(mode)
2115
 
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2116
 
 
2117
 
 
2118
 
def file_kind(f, _lstat=os.lstat):
2119
 
    try:
2120
 
        return file_kind_from_stat_mode(_lstat(f).st_mode)
2121
 
    except OSError, e:
2122
 
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2123
 
            raise errors.NoSuchFile(f)
2124
 
        raise
2125
 
 
2126
 
 
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
 
1581
try:
 
1582
    from bzrlib._readdir_pyx import read_dir as _read_dir
 
1583
except ImportError:
 
1584
    from bzrlib._readdir_py import read_dir as _read_dir