~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

NEWS section template into a separate file

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2009 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
68
77
# OR with 0 on those platforms
69
78
O_BINARY = getattr(os, 'O_BINARY', 0)
70
79
 
71
 
# On posix, use lstat instead of stat so that we can
72
 
# operate on broken symlinks. On Windows revert to stat.
73
 
lstat = getattr(os, 'lstat', os.stat)
 
80
 
 
81
def get_unicode_argv():
 
82
    try:
 
83
        user_encoding = get_user_encoding()
 
84
        return [a.decode(user_encoding) for a in sys.argv[1:]]
 
85
    except UnicodeDecodeError:
 
86
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
 
87
                                                            "encoding." % a))
 
88
 
74
89
 
75
90
def make_readonly(filename):
76
91
    """Make a filename read-only."""
77
 
    mod = lstat(filename).st_mode
 
92
    mod = os.lstat(filename).st_mode
78
93
    if not stat.S_ISLNK(mod):
79
94
        mod = mod & 0777555
80
95
        os.chmod(filename, mod)
81
96
 
82
97
 
83
98
def make_writable(filename):
84
 
    mod = lstat(filename).st_mode
 
99
    mod = os.lstat(filename).st_mode
85
100
    if not stat.S_ISLNK(mod):
86
101
        mod = mod | 0200
87
102
        os.chmod(filename, mod)
88
103
 
89
104
 
 
105
def minimum_path_selection(paths):
 
106
    """Return the smallset subset of paths which are outside paths.
 
107
 
 
108
    :param paths: A container (and hence not None) of paths.
 
109
    :return: A set of paths sufficient to include everything in paths via
 
110
        is_inside, drawn from the paths parameter.
 
111
    """
 
112
    if len(paths) < 2:
 
113
        return set(paths)
 
114
 
 
115
    def sort_key(path):
 
116
        return path.split('/')
 
117
    sorted_paths = sorted(list(paths), key=sort_key)
 
118
 
 
119
    search_paths = [sorted_paths[0]]
 
120
    for path in sorted_paths[1:]:
 
121
        if not is_inside(search_paths[-1], path):
 
122
            # This path is unique, add it
 
123
            search_paths.append(path)
 
124
 
 
125
    return set(search_paths)
 
126
 
 
127
 
90
128
_QUOTE_RE = None
91
129
 
92
130
 
99
137
    global _QUOTE_RE
100
138
    if _QUOTE_RE is None:
101
139
        _QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
102
 
        
 
140
 
103
141
    if _QUOTE_RE.search(f):
104
142
        return '"' + f + '"'
105
143
    else:
108
146
 
109
147
_directory_kind = 'directory'
110
148
 
111
 
_formats = {
112
 
    stat.S_IFDIR:_directory_kind,
113
 
    stat.S_IFCHR:'chardev',
114
 
    stat.S_IFBLK:'block',
115
 
    stat.S_IFREG:'file',
116
 
    stat.S_IFIFO:'fifo',
117
 
    stat.S_IFLNK:'symlink',
118
 
    stat.S_IFSOCK:'socket',
119
 
}
120
 
 
121
 
 
122
 
def file_kind_from_stat_mode(stat_mode, _formats=_formats, _unknown='unknown'):
123
 
    """Generate a file kind from a stat mode. This is used in walkdirs.
124
 
 
125
 
    Its performance is critical: Do not mutate without careful benchmarking.
126
 
    """
127
 
    try:
128
 
        return _formats[stat_mode & 0170000]
129
 
    except KeyError:
130
 
        return _unknown
131
 
 
132
 
 
133
 
def file_kind(f, _lstat=os.lstat, _mapper=file_kind_from_stat_mode):
134
 
    try:
135
 
        return _mapper(_lstat(f).st_mode)
136
 
    except OSError, e:
137
 
        if getattr(e, 'errno', None) == errno.ENOENT:
138
 
            raise errors.NoSuchFile(f)
139
 
        raise
140
 
 
141
 
 
142
149
def get_umask():
143
150
    """Return the current umask"""
144
151
    # Assume that people aren't messing with the umask while running
180
187
 
181
188
def fancy_rename(old, new, rename_func, unlink_func):
182
189
    """A fancy rename, when you don't have atomic rename.
183
 
    
 
190
 
184
191
    :param old: The old path, to rename from
185
192
    :param new: The new path, to rename to
186
193
    :param rename_func: The potentially non-atomic rename function
188
195
    """
189
196
 
190
197
    # sftp rename doesn't allow overwriting, so play tricks:
191
 
    import random
192
198
    base = os.path.basename(new)
193
199
    dirname = os.path.dirname(new)
194
200
    tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
219
225
 
220
226
    success = False
221
227
    try:
222
 
        # This may throw an exception, in which case success will
223
 
        # not be set.
224
 
        rename_func(old, new)
225
 
        success = True
 
228
        try:
 
229
            # This may throw an exception, in which case success will
 
230
            # not be set.
 
231
            rename_func(old, new)
 
232
            success = True
 
233
        except (IOError, OSError), e:
 
234
            # source and target may be aliases of each other (e.g. on a
 
235
            # case-insensitive filesystem), so we may have accidentally renamed
 
236
            # source by when we tried to rename target
 
237
            if not (file_existed and e.errno in (None, errno.ENOENT)):
 
238
                raise
226
239
    finally:
227
240
        if file_existed:
228
241
            # If the file used to exist, rename it back into place
294
307
        path = cwd + '\\' + path
295
308
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
296
309
 
297
 
if win32utils.winver == 'Windows 98':
298
 
    _win32_abspath = _win98_abspath
299
 
 
300
310
 
301
311
def _win32_realpath(path):
302
312
    # Real _nt_realpath doesn't have a problem with a unicode cwd
323
333
    """We expect to be able to atomically replace 'new' with old.
324
334
 
325
335
    On win32, if new exists, it must be moved out of the way first,
326
 
    and then deleted. 
 
336
    and then deleted.
327
337
    """
328
338
    try:
329
339
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
330
340
    except OSError, e:
331
341
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
332
 
            # If we try to rename a non-existant file onto cwd, we get 
333
 
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT 
 
342
            # If we try to rename a non-existant file onto cwd, we get
 
343
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT
334
344
            # if the old path doesn't exist, sometimes we get EACCES
335
345
            # On Linux, we seem to get EBUSY, on Mac we get EINVAL
336
346
            os.lstat(old)
338
348
 
339
349
 
340
350
def _mac_getcwd():
341
 
    return unicodedata.normalize('NFKC', os.getcwdu())
 
351
    return unicodedata.normalize('NFC', os.getcwdu())
342
352
 
343
353
 
344
354
# Default is to just use the python builtins, but these can be rebound on
361
371
 
362
372
 
363
373
if sys.platform == 'win32':
364
 
    abspath = _win32_abspath
 
374
    if win32utils.winver == 'Windows 98':
 
375
        abspath = _win98_abspath
 
376
    else:
 
377
        abspath = _win32_abspath
365
378
    realpath = _win32_realpath
366
379
    pathjoin = _win32_pathjoin
367
380
    normpath = _win32_normpath
387
400
    def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
388
401
        """Replacer for shutil.rmtree: could remove readonly dirs/files"""
389
402
        return shutil.rmtree(path, ignore_errors, onerror)
 
403
 
 
404
    f = win32utils.get_unicode_argv     # special function or None
 
405
    if f is not None:
 
406
        get_unicode_argv = f
 
407
 
390
408
elif sys.platform == 'darwin':
391
409
    getcwd = _mac_getcwd
392
410
 
396
414
 
397
415
    This attempts to check both sys.stdout and sys.stdin to see
398
416
    what encoding they are in, and if that fails it falls back to
399
 
    bzrlib.user_encoding.
 
417
    osutils.get_user_encoding().
400
418
    The problem is that on Windows, locale.getpreferredencoding()
401
419
    is not the same encoding as that used by the console:
402
420
    http://mail.python.org/pipermail/python-list/2003-May/162357.html
404
422
    On my standard US Windows XP, the preferred encoding is
405
423
    cp1252, but the console is cp437
406
424
    """
 
425
    from bzrlib.trace import mutter
407
426
    output_encoding = getattr(sys.stdout, 'encoding', None)
408
427
    if not output_encoding:
409
428
        input_encoding = getattr(sys.stdin, 'encoding', None)
410
429
        if not input_encoding:
411
 
            output_encoding = bzrlib.user_encoding
412
 
            mutter('encoding stdout as bzrlib.user_encoding %r', output_encoding)
 
430
            output_encoding = get_user_encoding()
 
431
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
432
                   output_encoding)
413
433
        else:
414
434
            output_encoding = input_encoding
415
435
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
417
437
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
418
438
    if output_encoding == 'cp0':
419
439
        # invalid encoding (cp0 means 'no codepage' on Windows)
420
 
        output_encoding = bzrlib.user_encoding
 
440
        output_encoding = get_user_encoding()
421
441
        mutter('cp0 is invalid encoding.'
422
 
               ' encoding stdout as bzrlib.user_encoding %r', output_encoding)
 
442
               ' encoding stdout as osutils.get_user_encoding() %r',
 
443
               output_encoding)
423
444
    # check encoding
424
445
    try:
425
446
        codecs.lookup(output_encoding)
427
448
        sys.stderr.write('bzr: warning:'
428
449
                         ' unknown terminal encoding %s.\n'
429
450
                         '  Using encoding %s instead.\n'
430
 
                         % (output_encoding, bzrlib.user_encoding)
 
451
                         % (output_encoding, get_user_encoding())
431
452
                        )
432
 
        output_encoding = bzrlib.user_encoding
 
453
        output_encoding = get_user_encoding()
433
454
 
434
455
    return output_encoding
435
456
 
446
467
        return pathjoin(F(p), e)
447
468
 
448
469
 
449
 
def backup_file(fn):
450
 
    """Copy a file to a backup.
451
 
 
452
 
    Backups are named in GNU-style, with a ~ suffix.
453
 
 
454
 
    If the file is already a backup, it's not copied.
455
 
    """
456
 
    if fn[-1] == '~':
457
 
        return
458
 
    bfn = fn + '~'
459
 
 
460
 
    if has_symlinks() and os.path.islink(fn):
461
 
        target = os.readlink(fn)
462
 
        os.symlink(target, bfn)
463
 
        return
464
 
    inf = file(fn, 'rb')
465
 
    try:
466
 
        content = inf.read()
467
 
    finally:
468
 
        inf.close()
469
 
    
470
 
    outf = file(bfn, 'wb')
471
 
    try:
472
 
        outf.write(content)
473
 
    finally:
474
 
        outf.close()
475
 
 
476
 
 
477
470
def isdir(f):
478
471
    """True if f is an accessible directory."""
479
472
    try:
498
491
 
499
492
def is_inside(dir, fname):
500
493
    """True if fname is inside dir.
501
 
    
 
494
 
502
495
    The parameters should typically be passed to osutils.normpath first, so
503
496
    that . and .. and repeated slashes are eliminated, and the separators
504
497
    are canonical for the platform.
505
 
    
506
 
    The empty string as a dir name is taken as top-of-tree and matches 
 
498
 
 
499
    The empty string as a dir name is taken as top-of-tree and matches
507
500
    everything.
508
501
    """
509
 
    # XXX: Most callers of this can actually do something smarter by 
 
502
    # XXX: Most callers of this can actually do something smarter by
510
503
    # looking at the inventory
511
504
    if dir == fname:
512
505
        return True
513
 
    
 
506
 
514
507
    if dir == '':
515
508
        return True
516
509
 
536
529
    return False
537
530
 
538
531
 
539
 
def pumpfile(fromfile, tofile):
540
 
    """Copy contents of one file to another."""
541
 
    BUFSIZE = 32768
542
 
    while True:
543
 
        b = fromfile.read(BUFSIZE)
544
 
        if not b:
545
 
            break
546
 
        tofile.write(b)
 
532
def pumpfile(from_file, to_file, read_length=-1, buff_size=32768,
 
533
             report_activity=None, direction='read'):
 
534
    """Copy contents of one file to another.
 
535
 
 
536
    The read_length can either be -1 to read to end-of-file (EOF) or
 
537
    it can specify the maximum number of bytes to read.
 
538
 
 
539
    The buff_size represents the maximum size for each read operation
 
540
    performed on from_file.
 
541
 
 
542
    :param report_activity: Call this as bytes are read, see
 
543
        Transport._report_activity
 
544
    :param direction: Will be passed to report_activity
 
545
 
 
546
    :return: The number of bytes copied.
 
547
    """
 
548
    length = 0
 
549
    if read_length >= 0:
 
550
        # read specified number of bytes
 
551
 
 
552
        while read_length > 0:
 
553
            num_bytes_to_read = min(read_length, buff_size)
 
554
 
 
555
            block = from_file.read(num_bytes_to_read)
 
556
            if not block:
 
557
                # EOF reached
 
558
                break
 
559
            if report_activity is not None:
 
560
                report_activity(len(block), direction)
 
561
            to_file.write(block)
 
562
 
 
563
            actual_bytes_read = len(block)
 
564
            read_length -= actual_bytes_read
 
565
            length += actual_bytes_read
 
566
    else:
 
567
        # read to EOF
 
568
        while True:
 
569
            block = from_file.read(buff_size)
 
570
            if not block:
 
571
                # EOF reached
 
572
                break
 
573
            if report_activity is not None:
 
574
                report_activity(len(block), direction)
 
575
            to_file.write(block)
 
576
            length += len(block)
 
577
    return length
 
578
 
 
579
 
 
580
def pump_string_file(bytes, file_handle, segment_size=None):
 
581
    """Write bytes to file_handle in many smaller writes.
 
582
 
 
583
    :param bytes: The string to write.
 
584
    :param file_handle: The file to write to.
 
585
    """
 
586
    # Write data in chunks rather than all at once, because very large
 
587
    # writes fail on some platforms (e.g. Windows with SMB  mounted
 
588
    # drives).
 
589
    if not segment_size:
 
590
        segment_size = 5242880 # 5MB
 
591
    segments = range(len(bytes) / segment_size + 1)
 
592
    write = file_handle.write
 
593
    for segment_index in segments:
 
594
        segment = buffer(bytes, segment_index * segment_size, segment_size)
 
595
        write(segment)
547
596
 
548
597
 
549
598
def file_iterator(input_file, readsize=32768):
555
604
 
556
605
 
557
606
def sha_file(f):
558
 
    if getattr(f, 'tell', None) is not None:
559
 
        assert f.tell() == 0
560
 
    s = sha.new()
 
607
    """Calculate the hexdigest of an open file.
 
608
 
 
609
    The file cursor should be already at the start.
 
610
    """
 
611
    s = sha()
561
612
    BUFSIZE = 128<<10
562
613
    while True:
563
614
        b = f.read(BUFSIZE)
567
618
    return s.hexdigest()
568
619
 
569
620
 
570
 
 
571
 
def sha_strings(strings):
 
621
def size_sha_file(f):
 
622
    """Calculate the size and hexdigest of an open file.
 
623
 
 
624
    The file cursor should be already at the start and
 
625
    the caller is responsible for closing the file afterwards.
 
626
    """
 
627
    size = 0
 
628
    s = sha()
 
629
    BUFSIZE = 128<<10
 
630
    while True:
 
631
        b = f.read(BUFSIZE)
 
632
        if not b:
 
633
            break
 
634
        size += len(b)
 
635
        s.update(b)
 
636
    return size, s.hexdigest()
 
637
 
 
638
 
 
639
def sha_file_by_name(fname):
 
640
    """Calculate the SHA1 of a file by reading the full text"""
 
641
    s = sha()
 
642
    f = os.open(fname, os.O_RDONLY | O_BINARY)
 
643
    try:
 
644
        while True:
 
645
            b = os.read(f, 1<<16)
 
646
            if not b:
 
647
                return s.hexdigest()
 
648
            s.update(b)
 
649
    finally:
 
650
        os.close(f)
 
651
 
 
652
 
 
653
def sha_strings(strings, _factory=sha):
572
654
    """Return the sha-1 of concatenation of strings"""
573
 
    s = sha.new()
 
655
    s = _factory()
574
656
    map(s.update, strings)
575
657
    return s.hexdigest()
576
658
 
577
659
 
578
 
def sha_string(f):
579
 
    s = sha.new()
580
 
    s.update(f)
581
 
    return s.hexdigest()
 
660
def sha_string(f, _factory=sha):
 
661
    return _factory(f).hexdigest()
582
662
 
583
663
 
584
664
def fingerprint_file(f):
585
 
    s = sha.new()
586
665
    b = f.read()
587
 
    s.update(b)
588
 
    size = len(b)
589
 
    return {'size': size,
590
 
            'sha1': s.hexdigest()}
 
666
    return {'size': len(b),
 
667
            'sha1': sha(b).hexdigest()}
591
668
 
592
669
 
593
670
def compare_files(a, b):
609
686
    offset = datetime.fromtimestamp(t) - datetime.utcfromtimestamp(t)
610
687
    return offset.days * 86400 + offset.seconds
611
688
 
612
 
    
 
689
weekdays = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
 
690
 
613
691
def format_date(t, offset=0, timezone='original', date_fmt=None,
614
692
                show_offset=True):
615
693
    """Return a formatted date string.
619
697
    :param timezone: How to display the time: 'utc', 'original' for the
620
698
         timezone specified by offset, or 'local' for the process's current
621
699
         timezone.
622
 
    :param show_offset: Whether to append the timezone.
623
 
    :param date_fmt: strftime format.
624
 
    """
 
700
    :param date_fmt: strftime format.
 
701
    :param show_offset: Whether to append the timezone.
 
702
    """
 
703
    (date_fmt, tt, offset_str) = \
 
704
               _format_date(t, offset, timezone, date_fmt, show_offset)
 
705
    date_fmt = date_fmt.replace('%a', weekdays[tt[6]])
 
706
    date_str = time.strftime(date_fmt, tt)
 
707
    return date_str + offset_str
 
708
 
 
709
def format_local_date(t, offset=0, timezone='original', date_fmt=None,
 
710
                      show_offset=True):
 
711
    """Return an unicode date string formatted according to the current locale.
 
712
 
 
713
    :param t: Seconds since the epoch.
 
714
    :param offset: Timezone offset in seconds east of utc.
 
715
    :param timezone: How to display the time: 'utc', 'original' for the
 
716
         timezone specified by offset, or 'local' for the process's current
 
717
         timezone.
 
718
    :param date_fmt: strftime format.
 
719
    :param show_offset: Whether to append the timezone.
 
720
    """
 
721
    (date_fmt, tt, offset_str) = \
 
722
               _format_date(t, offset, timezone, date_fmt, show_offset)
 
723
    date_str = time.strftime(date_fmt, tt)
 
724
    if not isinstance(date_str, unicode):
 
725
        date_str = date_str.decode(get_user_encoding(), 'replace')
 
726
    return date_str + offset_str
 
727
 
 
728
def _format_date(t, offset, timezone, date_fmt, show_offset):
625
729
    if timezone == 'utc':
626
730
        tt = time.gmtime(t)
627
731
        offset = 0
633
737
        tt = time.localtime(t)
634
738
        offset = local_time_offset(t)
635
739
    else:
636
 
        raise errors.BzrError("unsupported timezone format %r" % timezone,
637
 
                              ['options are "utc", "original", "local"'])
 
740
        raise errors.UnsupportedTimezoneFormat(timezone)
638
741
    if date_fmt is None:
639
742
        date_fmt = "%a %Y-%m-%d %H:%M:%S"
640
743
    if show_offset:
641
744
        offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
642
745
    else:
643
746
        offset_str = ''
644
 
    return (time.strftime(date_fmt, tt) +  offset_str)
 
747
    return (date_fmt, tt, offset_str)
645
748
 
646
749
 
647
750
def compact_date(when):
648
751
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
649
 
    
 
752
 
650
753
 
651
754
def format_delta(delta):
652
755
    """Get a nice looking string for a time delta.
728
831
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
729
832
def rand_chars(num):
730
833
    """Return a random string of num alphanumeric characters
731
 
    
732
 
    The result only contains lowercase chars because it may be used on 
 
834
 
 
835
    The result only contains lowercase chars because it may be used on
733
836
    case-insensitive filesystems.
734
837
    """
735
838
    s = ''
743
846
 
744
847
def splitpath(p):
745
848
    """Turn string into list of parts."""
746
 
    assert isinstance(p, basestring)
747
 
 
748
849
    # split on either delimiter because people might use either on
749
850
    # Windows
750
851
    ps = re.split(r'[\\/]', p)
759
860
            rps.append(f)
760
861
    return rps
761
862
 
 
863
 
762
864
def joinpath(p):
763
 
    assert isinstance(p, (list, tuple))
764
865
    for f in p:
765
866
        if (f == '..') or (f is None) or (f == ''):
766
867
            raise errors.BzrError("sorry, %r not allowed in path" % f)
767
868
    return pathjoin(*p)
768
869
 
769
870
 
 
871
def parent_directories(filename):
 
872
    """Return the list of parent directories, deepest first.
 
873
    
 
874
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
 
875
    """
 
876
    parents = []
 
877
    parts = splitpath(dirname(filename))
 
878
    while parts:
 
879
        parents.append(joinpath(parts))
 
880
        parts.pop()
 
881
    return parents
 
882
 
 
883
 
 
884
try:
 
885
    from bzrlib._chunks_to_lines_pyx import chunks_to_lines
 
886
except ImportError:
 
887
    from bzrlib._chunks_to_lines_py import chunks_to_lines
 
888
 
 
889
 
770
890
def split_lines(s):
771
891
    """Split s into lines, but without removing the newline characters."""
 
892
    # Trivially convert a fulltext into a 'chunked' representation, and let
 
893
    # chunks_to_lines do the heavy lifting.
 
894
    if isinstance(s, str):
 
895
        # chunks_to_lines only supports 8-bit strings
 
896
        return chunks_to_lines([s])
 
897
    else:
 
898
        return _split_lines(s)
 
899
 
 
900
 
 
901
def _split_lines(s):
 
902
    """Split s into lines, but without removing the newline characters.
 
903
 
 
904
    This supports Unicode or plain string objects.
 
905
    """
772
906
    lines = s.split('\n')
773
907
    result = [line + '\n' for line in lines[:-1]]
774
908
    if lines[-1]:
792
926
            raise
793
927
        shutil.copyfile(src, dest)
794
928
 
795
 
def delete_any(full_path):
796
 
    """Delete a file or directory."""
 
929
 
 
930
def delete_any(path):
 
931
    """Delete a file, symlink or directory.  
 
932
    
 
933
    Will delete even if readonly.
 
934
    """
797
935
    try:
798
 
        os.unlink(full_path)
799
 
    except OSError, e:
800
 
    # We may be renaming a dangling inventory id
801
 
        if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
 
936
       _delete_file_or_dir(path)
 
937
    except (OSError, IOError), e:
 
938
        if e.errno in (errno.EPERM, errno.EACCES):
 
939
            # make writable and try again
 
940
            try:
 
941
                make_writable(path)
 
942
            except (OSError, IOError):
 
943
                pass
 
944
            _delete_file_or_dir(path)
 
945
        else:
802
946
            raise
803
 
        os.rmdir(full_path)
 
947
 
 
948
 
 
949
def _delete_file_or_dir(path):
 
950
    # Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
 
951
    # Forgiveness than Permission (EAFP) because:
 
952
    # - root can damage a solaris file system by using unlink,
 
953
    # - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
 
954
    #   EACCES, OSX: EPERM) when invoked on a directory.
 
955
    if isdir(path): # Takes care of symlinks
 
956
        os.rmdir(path)
 
957
    else:
 
958
        os.unlink(path)
804
959
 
805
960
 
806
961
def has_symlinks():
808
963
        return True
809
964
    else:
810
965
        return False
811
 
        
 
966
 
 
967
 
 
968
def has_hardlinks():
 
969
    if getattr(os, 'link', None) is not None:
 
970
        return True
 
971
    else:
 
972
        return False
 
973
 
 
974
 
 
975
def host_os_dereferences_symlinks():
 
976
    return (has_symlinks()
 
977
            and sys.platform not in ('cygwin', 'win32'))
 
978
 
 
979
 
 
980
def readlink(abspath):
 
981
    """Return a string representing the path to which the symbolic link points.
 
982
 
 
983
    :param abspath: The link absolute unicode path.
 
984
 
 
985
    This his guaranteed to return the symbolic link in unicode in all python
 
986
    versions.
 
987
    """
 
988
    link = abspath.encode(_fs_enc)
 
989
    target = os.readlink(link)
 
990
    target = target.decode(_fs_enc)
 
991
    return target
 
992
 
812
993
 
813
994
def contains_whitespace(s):
814
995
    """True if there are any whitespace characters in s."""
850
1031
    avoids that problem.
851
1032
    """
852
1033
 
853
 
    assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
854
 
        ' exceed the platform minimum length (which is %d)' % 
855
 
        MIN_ABS_PATHLENGTH)
 
1034
    if len(base) < MIN_ABS_PATHLENGTH:
 
1035
        # must have space for e.g. a drive letter
 
1036
        raise ValueError('%r is too short to calculate a relative path'
 
1037
            % (base,))
856
1038
 
857
1039
    rp = abspath(path)
858
1040
 
859
1041
    s = []
860
1042
    head = rp
861
 
    while len(head) >= len(base):
 
1043
    while True:
 
1044
        if len(head) <= len(base) and head != base:
 
1045
            raise errors.PathNotChild(rp, base)
862
1046
        if head == base:
863
1047
            break
864
 
        head, tail = os.path.split(head)
 
1048
        head, tail = split(head)
865
1049
        if tail:
866
 
            s.insert(0, tail)
867
 
    else:
868
 
        raise errors.PathNotChild(rp, base)
 
1050
            s.append(tail)
869
1051
 
870
1052
    if s:
871
 
        return pathjoin(*s)
 
1053
        return pathjoin(*reversed(s))
872
1054
    else:
873
1055
        return ''
874
1056
 
875
1057
 
 
1058
def _cicp_canonical_relpath(base, path):
 
1059
    """Return the canonical path relative to base.
 
1060
 
 
1061
    Like relpath, but on case-insensitive-case-preserving file-systems, this
 
1062
    will return the relpath as stored on the file-system rather than in the
 
1063
    case specified in the input string, for all existing portions of the path.
 
1064
 
 
1065
    This will cause O(N) behaviour if called for every path in a tree; if you
 
1066
    have a number of paths to convert, you should use canonical_relpaths().
 
1067
    """
 
1068
    # TODO: it should be possible to optimize this for Windows by using the
 
1069
    # win32 API FindFiles function to look for the specified name - but using
 
1070
    # os.listdir() still gives us the correct, platform agnostic semantics in
 
1071
    # the short term.
 
1072
 
 
1073
    rel = relpath(base, path)
 
1074
    # '.' will have been turned into ''
 
1075
    if not rel:
 
1076
        return rel
 
1077
 
 
1078
    abs_base = abspath(base)
 
1079
    current = abs_base
 
1080
    _listdir = os.listdir
 
1081
 
 
1082
    # use an explicit iterator so we can easily consume the rest on early exit.
 
1083
    bit_iter = iter(rel.split('/'))
 
1084
    for bit in bit_iter:
 
1085
        lbit = bit.lower()
 
1086
        try:
 
1087
            next_entries = _listdir(current)
 
1088
        except OSError: # enoent, eperm, etc
 
1089
            # We can't find this in the filesystem, so just append the
 
1090
            # remaining bits.
 
1091
            current = pathjoin(current, bit, *list(bit_iter))
 
1092
            break
 
1093
        for look in next_entries:
 
1094
            if lbit == look.lower():
 
1095
                current = pathjoin(current, look)
 
1096
                break
 
1097
        else:
 
1098
            # got to the end, nothing matched, so we just return the
 
1099
            # non-existing bits as they were specified (the filename may be
 
1100
            # the target of a move, for example).
 
1101
            current = pathjoin(current, bit, *list(bit_iter))
 
1102
            break
 
1103
    return current[len(abs_base):].lstrip('/')
 
1104
 
 
1105
# XXX - TODO - we need better detection/integration of case-insensitive
 
1106
# file-systems; Linux often sees FAT32 devices (or NFS-mounted OSX
 
1107
# filesystems), for example, so could probably benefit from the same basic
 
1108
# support there.  For now though, only Windows and OSX get that support, and
 
1109
# they get it for *all* file-systems!
 
1110
if sys.platform in ('win32', 'darwin'):
 
1111
    canonical_relpath = _cicp_canonical_relpath
 
1112
else:
 
1113
    canonical_relpath = relpath
 
1114
 
 
1115
def canonical_relpaths(base, paths):
 
1116
    """Create an iterable to canonicalize a sequence of relative paths.
 
1117
 
 
1118
    The intent is for this implementation to use a cache, vastly speeding
 
1119
    up multiple transformations in the same directory.
 
1120
    """
 
1121
    # but for now, we haven't optimized...
 
1122
    return [canonical_relpath(base, p) for p in paths]
 
1123
 
876
1124
def safe_unicode(unicode_or_utf8_string):
877
1125
    """Coerce unicode_or_utf8_string into unicode.
878
1126
 
879
1127
    If it is unicode, it is returned.
880
 
    Otherwise it is decoded from utf-8. If a decoding error
881
 
    occurs, it is wrapped as a If the decoding fails, the exception is wrapped 
882
 
    as a BzrBadParameter exception.
 
1128
    Otherwise it is decoded from utf-8. If decoding fails, the exception is
 
1129
    wrapped in a BzrBadParameterNotUnicode exception.
883
1130
    """
884
1131
    if isinstance(unicode_or_utf8_string, unicode):
885
1132
        return unicode_or_utf8_string
972
1219
 
973
1220
    On platforms where the system normalizes filenames (Mac OSX),
974
1221
    you can access a file by any path which will normalize correctly.
975
 
    On platforms where the system does not normalize filenames 
 
1222
    On platforms where the system does not normalize filenames
976
1223
    (Windows, Linux), you have to access a file by its exact path.
977
1224
 
978
 
    Internally, bzr only supports NFC/NFKC normalization, since that is 
 
1225
    Internally, bzr only supports NFC normalization, since that is
979
1226
    the standard for XML documents.
980
1227
 
981
1228
    So return the normalized path, and a flag indicating if the file
982
1229
    can be accessed by that path.
983
1230
    """
984
1231
 
985
 
    return unicodedata.normalize('NFKC', unicode(path)), True
 
1232
    return unicodedata.normalize('NFC', unicode(path)), True
986
1233
 
987
1234
 
988
1235
def _inaccessible_normalized_filename(path):
989
1236
    __doc__ = _accessible_normalized_filename.__doc__
990
1237
 
991
 
    normalized = unicodedata.normalize('NFKC', unicode(path))
 
1238
    normalized = unicodedata.normalize('NFC', unicode(path))
992
1239
    return normalized, normalized == path
993
1240
 
994
1241
 
1052
1299
            del os.environ[env_variable]
1053
1300
    else:
1054
1301
        if isinstance(value, unicode):
1055
 
            value = value.encode(bzrlib.user_encoding)
 
1302
            value = value.encode(get_user_encoding())
1056
1303
        os.environ[env_variable] = value
1057
1304
    return orig_val
1058
1305
 
1061
1308
 
1062
1309
 
1063
1310
def check_legal_path(path):
1064
 
    """Check whether the supplied path is legal.  
 
1311
    """Check whether the supplied path is legal.
1065
1312
    This is only required on Windows, so we don't test on other platforms
1066
1313
    right now.
1067
1314
    """
1071
1318
        raise errors.IllegalPath(path)
1072
1319
 
1073
1320
 
 
1321
_WIN32_ERROR_DIRECTORY = 267 # Similar to errno.ENOTDIR
 
1322
 
 
1323
def _is_error_enotdir(e):
 
1324
    """Check if this exception represents ENOTDIR.
 
1325
 
 
1326
    Unfortunately, python is very inconsistent about the exception
 
1327
    here. The cases are:
 
1328
      1) Linux, Mac OSX all versions seem to set errno == ENOTDIR
 
1329
      2) Windows, Python2.4, uses errno == ERROR_DIRECTORY (267)
 
1330
         which is the windows error code.
 
1331
      3) Windows, Python2.5 uses errno == EINVAL and
 
1332
         winerror == ERROR_DIRECTORY
 
1333
 
 
1334
    :param e: An Exception object (expected to be OSError with an errno
 
1335
        attribute, but we should be able to cope with anything)
 
1336
    :return: True if this represents an ENOTDIR error. False otherwise.
 
1337
    """
 
1338
    en = getattr(e, 'errno', None)
 
1339
    if (en == errno.ENOTDIR
 
1340
        or (sys.platform == 'win32'
 
1341
            and (en == _WIN32_ERROR_DIRECTORY
 
1342
                 or (en == errno.EINVAL
 
1343
                     and getattr(e, 'winerror', None) == _WIN32_ERROR_DIRECTORY)
 
1344
        ))):
 
1345
        return True
 
1346
    return False
 
1347
 
 
1348
 
1074
1349
def walkdirs(top, prefix=""):
1075
1350
    """Yield data about all the directories in a tree.
1076
 
    
 
1351
 
1077
1352
    This yields all the data about the contents of a directory at a time.
1078
1353
    After each directory has been yielded, if the caller has mutated the list
1079
1354
    to exclude some directories, they are then not descended into.
1080
 
    
 
1355
 
1081
1356
    The data yielded is of the form:
1082
1357
    ((directory-relpath, directory-path-from-top),
1083
1358
    [(relpath, basename, kind, lstat, path-from-top), ...]),
1084
1359
     - directory-relpath is the relative path of the directory being returned
1085
1360
       with respect to top. prefix is prepended to this.
1086
 
     - directory-path-from-root is the path including top for this directory. 
 
1361
     - directory-path-from-root is the path including top for this directory.
1087
1362
       It is suitable for use with os functions.
1088
1363
     - relpath is the relative path within the subtree being walked.
1089
1364
     - basename is the basename of the path
1091
1366
       present within the tree - but it may be recorded as versioned. See
1092
1367
       versioned_kind.
1093
1368
     - lstat is the stat data *if* the file was statted.
1094
 
     - planned, not implemented: 
 
1369
     - planned, not implemented:
1095
1370
       path_from_tree_root is the path from the root of the tree.
1096
1371
 
1097
 
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This 
 
1372
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This
1098
1373
        allows one to walk a subtree but get paths that are relative to a tree
1099
1374
        rooted higher up.
1100
1375
    :return: an iterator over the dirs.
1101
1376
    """
1102
1377
    #TODO there is a bit of a smell where the results of the directory-
1103
 
    # summary in this, and the path from the root, may not agree 
 
1378
    # summary in this, and the path from the root, may not agree
1104
1379
    # depending on top and prefix - i.e. ./foo and foo as a pair leads to
1105
1380
    # potentially confusing output. We should make this more robust - but
1106
1381
    # not at a speed cost. RBC 20060731
1107
1382
    _lstat = os.lstat
1108
1383
    _directory = _directory_kind
1109
1384
    _listdir = os.listdir
1110
 
    _kind_from_mode = _formats.get
 
1385
    _kind_from_mode = file_kind_from_stat_mode
1111
1386
    pending = [(safe_unicode(prefix), "", _directory, None, safe_unicode(top))]
1112
1387
    while pending:
1113
1388
        # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1120
1395
 
1121
1396
        dirblock = []
1122
1397
        append = dirblock.append
1123
 
        for name in sorted(_listdir(top)):
1124
 
            abspath = top_slash + name
1125
 
            statvalue = _lstat(abspath)
1126
 
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
1127
 
            append((relprefix + name, name, kind, statvalue, abspath))
 
1398
        try:
 
1399
            names = sorted(_listdir(top))
 
1400
        except OSError, e:
 
1401
            if not _is_error_enotdir(e):
 
1402
                raise
 
1403
        else:
 
1404
            for name in names:
 
1405
                abspath = top_slash + name
 
1406
                statvalue = _lstat(abspath)
 
1407
                kind = _kind_from_mode(statvalue.st_mode)
 
1408
                append((relprefix + name, name, kind, statvalue, abspath))
1128
1409
        yield (relroot, top), dirblock
1129
1410
 
1130
1411
        # push the user specified dirs from dirblock
1131
1412
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1132
1413
 
1133
1414
 
 
1415
class DirReader(object):
 
1416
    """An interface for reading directories."""
 
1417
 
 
1418
    def top_prefix_to_starting_dir(self, top, prefix=""):
 
1419
        """Converts top and prefix to a starting dir entry
 
1420
 
 
1421
        :param top: A utf8 path
 
1422
        :param prefix: An optional utf8 path to prefix output relative paths
 
1423
            with.
 
1424
        :return: A tuple starting with prefix, and ending with the native
 
1425
            encoding of top.
 
1426
        """
 
1427
        raise NotImplementedError(self.top_prefix_to_starting_dir)
 
1428
 
 
1429
    def read_dir(self, prefix, top):
 
1430
        """Read a specific dir.
 
1431
 
 
1432
        :param prefix: A utf8 prefix to be preprended to the path basenames.
 
1433
        :param top: A natively encoded path to read.
 
1434
        :return: A list of the directories contents. Each item contains:
 
1435
            (utf8_relpath, utf8_name, kind, lstatvalue, native_abspath)
 
1436
        """
 
1437
        raise NotImplementedError(self.read_dir)
 
1438
 
 
1439
 
 
1440
_selected_dir_reader = None
 
1441
 
 
1442
 
1134
1443
def _walkdirs_utf8(top, prefix=""):
1135
1444
    """Yield data about all the directories in a tree.
1136
1445
 
1145
1454
        path-from-top might be unicode or utf8, but it is the correct path to
1146
1455
        pass to os functions to affect the file in question. (such as os.lstat)
1147
1456
    """
1148
 
    fs_encoding = _fs_enc.upper()
1149
 
    if (sys.platform == 'win32' or
1150
 
        fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968')): # ascii
1151
 
        return _walkdirs_unicode_to_utf8(top, prefix=prefix)
1152
 
    else:
1153
 
        return _walkdirs_fs_utf8(top, prefix=prefix)
1154
 
 
1155
 
 
1156
 
def _walkdirs_fs_utf8(top, prefix=""):
1157
 
    """See _walkdirs_utf8.
1158
 
 
1159
 
    This sub-function is called when we know the filesystem is already in utf8
1160
 
    encoding. So we don't need to transcode filenames.
1161
 
    """
1162
 
    _lstat = os.lstat
1163
 
    _directory = _directory_kind
1164
 
    _listdir = os.listdir
1165
 
    _kind_from_mode = _formats.get
 
1457
    global _selected_dir_reader
 
1458
    if _selected_dir_reader is None:
 
1459
        fs_encoding = _fs_enc.upper()
 
1460
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
 
1461
            # Win98 doesn't have unicode apis like FindFirstFileW
 
1462
            # TODO: We possibly could support Win98 by falling back to the
 
1463
            #       original FindFirstFile, and using TCHAR instead of WCHAR,
 
1464
            #       but that gets a bit tricky, and requires custom compiling
 
1465
            #       for win98 anyway.
 
1466
            try:
 
1467
                from bzrlib._walkdirs_win32 import Win32ReadDir
 
1468
                _selected_dir_reader = Win32ReadDir()
 
1469
            except ImportError:
 
1470
                pass
 
1471
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
 
1472
            # ANSI_X3.4-1968 is a form of ASCII
 
1473
            try:
 
1474
                from bzrlib._readdir_pyx import UTF8DirReader
 
1475
                _selected_dir_reader = UTF8DirReader()
 
1476
            except ImportError:
 
1477
                pass
 
1478
 
 
1479
    if _selected_dir_reader is None:
 
1480
        # Fallback to the python version
 
1481
        _selected_dir_reader = UnicodeDirReader()
1166
1482
 
1167
1483
    # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1168
1484
    # But we don't actually uses 1-3 in pending, so set them to None
1169
 
    pending = [(safe_utf8(prefix), None, None, None, safe_utf8(top))]
 
1485
    pending = [[_selected_dir_reader.top_prefix_to_starting_dir(top, prefix)]]
 
1486
    read_dir = _selected_dir_reader.read_dir
 
1487
    _directory = _directory_kind
1170
1488
    while pending:
1171
 
        relroot, _, _, _, top = pending.pop()
1172
 
        if relroot:
1173
 
            relprefix = relroot + '/'
1174
 
        else:
1175
 
            relprefix = ''
1176
 
        top_slash = top + '/'
1177
 
 
1178
 
        dirblock = []
1179
 
        append = dirblock.append
1180
 
        for name in sorted(_listdir(top)):
1181
 
            abspath = top_slash + name
1182
 
            statvalue = _lstat(abspath)
1183
 
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
1184
 
            append((relprefix + name, name, kind, statvalue, abspath))
 
1489
        relroot, _, _, _, top = pending[-1].pop()
 
1490
        if not pending[-1]:
 
1491
            pending.pop()
 
1492
        dirblock = sorted(read_dir(relroot, top))
1185
1493
        yield (relroot, top), dirblock
1186
 
 
1187
1494
        # push the user specified dirs from dirblock
1188
 
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1189
 
 
1190
 
 
1191
 
def _walkdirs_unicode_to_utf8(top, prefix=""):
1192
 
    """See _walkdirs_utf8
1193
 
 
1194
 
    Because Win32 has a Unicode api, all of the 'path-from-top' entries will be
1195
 
    Unicode paths.
1196
 
    This is currently the fallback code path when the filesystem encoding is
1197
 
    not UTF-8. It may be better to implement an alternative so that we can
1198
 
    safely handle paths that are not properly decodable in the current
1199
 
    encoding.
1200
 
    """
1201
 
    _utf8_encode = codecs.getencoder('utf8')
1202
 
    _lstat = os.lstat
1203
 
    _directory = _directory_kind
1204
 
    _listdir = os.listdir
1205
 
    _kind_from_mode = _formats.get
1206
 
 
1207
 
    pending = [(safe_utf8(prefix), None, None, None, safe_unicode(top))]
1208
 
    while pending:
1209
 
        relroot, _, _, _, top = pending.pop()
1210
 
        if relroot:
1211
 
            relprefix = relroot + '/'
 
1495
        next = [d for d in reversed(dirblock) if d[2] == _directory]
 
1496
        if next:
 
1497
            pending.append(next)
 
1498
 
 
1499
 
 
1500
class UnicodeDirReader(DirReader):
 
1501
    """A dir reader for non-utf8 file systems, which transcodes."""
 
1502
 
 
1503
    __slots__ = ['_utf8_encode']
 
1504
 
 
1505
    def __init__(self):
 
1506
        self._utf8_encode = codecs.getencoder('utf8')
 
1507
 
 
1508
    def top_prefix_to_starting_dir(self, top, prefix=""):
 
1509
        """See DirReader.top_prefix_to_starting_dir."""
 
1510
        return (safe_utf8(prefix), None, None, None, safe_unicode(top))
 
1511
 
 
1512
    def read_dir(self, prefix, top):
 
1513
        """Read a single directory from a non-utf8 file system.
 
1514
 
 
1515
        top, and the abspath element in the output are unicode, all other paths
 
1516
        are utf8. Local disk IO is done via unicode calls to listdir etc.
 
1517
 
 
1518
        This is currently the fallback code path when the filesystem encoding is
 
1519
        not UTF-8. It may be better to implement an alternative so that we can
 
1520
        safely handle paths that are not properly decodable in the current
 
1521
        encoding.
 
1522
 
 
1523
        See DirReader.read_dir for details.
 
1524
        """
 
1525
        _utf8_encode = self._utf8_encode
 
1526
        _lstat = os.lstat
 
1527
        _listdir = os.listdir
 
1528
        _kind_from_mode = file_kind_from_stat_mode
 
1529
 
 
1530
        if prefix:
 
1531
            relprefix = prefix + '/'
1212
1532
        else:
1213
1533
            relprefix = ''
1214
1534
        top_slash = top + u'/'
1216
1536
        dirblock = []
1217
1537
        append = dirblock.append
1218
1538
        for name in sorted(_listdir(top)):
1219
 
            name_utf8 = _utf8_encode(name)[0]
 
1539
            try:
 
1540
                name_utf8 = _utf8_encode(name)[0]
 
1541
            except UnicodeDecodeError:
 
1542
                raise errors.BadFilenameEncoding(
 
1543
                    _utf8_encode(relprefix)[0] + name, _fs_enc)
1220
1544
            abspath = top_slash + name
1221
1545
            statvalue = _lstat(abspath)
1222
 
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
 
1546
            kind = _kind_from_mode(statvalue.st_mode)
1223
1547
            append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
1224
 
        yield (relroot, top), dirblock
1225
 
 
1226
 
        # push the user specified dirs from dirblock
1227
 
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
 
1548
        return dirblock
1228
1549
 
1229
1550
 
1230
1551
def copy_tree(from_path, to_path, handlers={}):
1231
1552
    """Copy all of the entries in from_path into to_path.
1232
1553
 
1233
 
    :param from_path: The base directory to copy. 
 
1554
    :param from_path: The base directory to copy.
1234
1555
    :param to_path: The target directory. If it does not exist, it will
1235
1556
        be created.
1236
1557
    :param handlers: A dictionary of functions, which takes a source and
1305
1626
        return _cached_user_encoding
1306
1627
 
1307
1628
    if sys.platform == 'darwin':
1308
 
        # work around egregious python 2.4 bug
 
1629
        # python locale.getpreferredencoding() always return
 
1630
        # 'mac-roman' on darwin. That's a lie.
1309
1631
        sys.platform = 'posix'
1310
1632
        try:
 
1633
            if os.environ.get('LANG', None) is None:
 
1634
                # If LANG is not set, we end up with 'ascii', which is bad
 
1635
                # ('mac-roman' is more than ascii), so we set a default which
 
1636
                # will give us UTF-8 (which appears to work in all cases on
 
1637
                # OSX). Users are still free to override LANG of course, as
 
1638
                # long as it give us something meaningful. This work-around
 
1639
                # *may* not be needed with python 3k and/or OSX 10.5, but will
 
1640
                # work with them too -- vila 20080908
 
1641
                os.environ['LANG'] = 'en_US.UTF-8'
1311
1642
            import locale
1312
1643
        finally:
1313
1644
            sys.platform = 'darwin'
1328
1659
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
1329
1660
    # treat that as ASCII, and not support printing unicode characters to the
1330
1661
    # console.
1331
 
    if user_encoding in (None, 'cp0'):
 
1662
    #
 
1663
    # For python scripts run under vim, we get '', so also treat that as ASCII
 
1664
    if user_encoding in (None, 'cp0', ''):
1332
1665
        user_encoding = 'ascii'
1333
1666
    else:
1334
1667
        # check encoding
1348
1681
    return user_encoding
1349
1682
 
1350
1683
 
 
1684
def get_host_name():
 
1685
    """Return the current unicode host name.
 
1686
 
 
1687
    This is meant to be used in place of socket.gethostname() because that
 
1688
    behaves inconsistently on different platforms.
 
1689
    """
 
1690
    if sys.platform == "win32":
 
1691
        import win32utils
 
1692
        return win32utils.get_host_name()
 
1693
    else:
 
1694
        import socket
 
1695
        return socket.gethostname().decode(get_user_encoding())
 
1696
 
 
1697
 
1351
1698
def recv_all(socket, bytes):
1352
1699
    """Receive an exact number of bytes.
1353
1700
 
1360
1707
    """
1361
1708
    b = ''
1362
1709
    while len(b) < bytes:
1363
 
        new = socket.recv(bytes - len(b))
 
1710
        new = until_no_eintr(socket.recv, bytes - len(b))
1364
1711
        if new == '':
1365
1712
            break # eof
1366
1713
        b += new
1367
1714
    return b
1368
1715
 
 
1716
 
 
1717
def send_all(socket, bytes, report_activity=None):
 
1718
    """Send all bytes on a socket.
 
1719
 
 
1720
    Regular socket.sendall() can give socket error 10053 on Windows.  This
 
1721
    implementation sends no more than 64k at a time, which avoids this problem.
 
1722
 
 
1723
    :param report_activity: Call this as bytes are read, see
 
1724
        Transport._report_activity
 
1725
    """
 
1726
    chunk_size = 2**16
 
1727
    for pos in xrange(0, len(bytes), chunk_size):
 
1728
        block = bytes[pos:pos+chunk_size]
 
1729
        if report_activity is not None:
 
1730
            report_activity(len(block), 'write')
 
1731
        until_no_eintr(socket.sendall, block)
 
1732
 
 
1733
 
1369
1734
def dereference_path(path):
1370
1735
    """Determine the real path to a file.
1371
1736
 
1383
1748
def supports_mapi():
1384
1749
    """Return True if we can use MAPI to launch a mail client."""
1385
1750
    return sys.platform == "win32"
 
1751
 
 
1752
 
 
1753
def resource_string(package, resource_name):
 
1754
    """Load a resource from a package and return it as a string.
 
1755
 
 
1756
    Note: Only packages that start with bzrlib are currently supported.
 
1757
 
 
1758
    This is designed to be a lightweight implementation of resource
 
1759
    loading in a way which is API compatible with the same API from
 
1760
    pkg_resources. See
 
1761
    http://peak.telecommunity.com/DevCenter/PkgResources#basic-resource-access.
 
1762
    If and when pkg_resources becomes a standard library, this routine
 
1763
    can delegate to it.
 
1764
    """
 
1765
    # Check package name is within bzrlib
 
1766
    if package == "bzrlib":
 
1767
        resource_relpath = resource_name
 
1768
    elif package.startswith("bzrlib."):
 
1769
        package = package[len("bzrlib."):].replace('.', os.sep)
 
1770
        resource_relpath = pathjoin(package, resource_name)
 
1771
    else:
 
1772
        raise errors.BzrError('resource package %s not in bzrlib' % package)
 
1773
 
 
1774
    # Map the resource to a file and read its contents
 
1775
    base = dirname(bzrlib.__file__)
 
1776
    if getattr(sys, 'frozen', None):    # bzr.exe
 
1777
        base = abspath(pathjoin(base, '..', '..'))
 
1778
    filename = pathjoin(base, resource_relpath)
 
1779
    return open(filename, 'rU').read()
 
1780
 
 
1781
 
 
1782
def file_kind_from_stat_mode_thunk(mode):
 
1783
    global file_kind_from_stat_mode
 
1784
    if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
 
1785
        try:
 
1786
            from bzrlib._readdir_pyx import UTF8DirReader
 
1787
            file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
 
1788
        except ImportError:
 
1789
            from bzrlib._readdir_py import (
 
1790
                _kind_from_mode as file_kind_from_stat_mode
 
1791
                )
 
1792
    return file_kind_from_stat_mode(mode)
 
1793
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
 
1794
 
 
1795
 
 
1796
def file_kind(f, _lstat=os.lstat):
 
1797
    try:
 
1798
        return file_kind_from_stat_mode(_lstat(f).st_mode)
 
1799
    except OSError, e:
 
1800
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
 
1801
            raise errors.NoSuchFile(f)
 
1802
        raise
 
1803
 
 
1804
 
 
1805
def until_no_eintr(f, *a, **kw):
 
1806
    """Run f(*a, **kw), retrying if an EINTR error occurs."""
 
1807
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
 
1808
    while True:
 
1809
        try:
 
1810
            return f(*a, **kw)
 
1811
        except (IOError, OSError), e:
 
1812
            if e.errno == errno.EINTR:
 
1813
                continue
 
1814
            raise
 
1815
 
 
1816
def re_compile_checked(re_string, flags=0, where=""):
 
1817
    """Return a compiled re, or raise a sensible error.
 
1818
 
 
1819
    This should only be used when compiling user-supplied REs.
 
1820
 
 
1821
    :param re_string: Text form of regular expression.
 
1822
    :param flags: eg re.IGNORECASE
 
1823
    :param where: Message explaining to the user the context where
 
1824
        it occurred, eg 'log search filter'.
 
1825
    """
 
1826
    # from https://bugs.launchpad.net/bzr/+bug/251352
 
1827
    try:
 
1828
        re_obj = re.compile(re_string, flags)
 
1829
        re_obj.search("")
 
1830
        return re_obj
 
1831
    except re.error, e:
 
1832
        if where:
 
1833
            where = ' in ' + where
 
1834
        # despite the name 'error' is a type
 
1835
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
 
1836
            % (where, re_string, e))
 
1837
 
 
1838
 
 
1839
if sys.platform == "win32":
 
1840
    import msvcrt
 
1841
    def getchar():
 
1842
        return msvcrt.getch()
 
1843
else:
 
1844
    import tty
 
1845
    import termios
 
1846
    def getchar():
 
1847
        fd = sys.stdin.fileno()
 
1848
        settings = termios.tcgetattr(fd)
 
1849
        try:
 
1850
            tty.setraw(fd)
 
1851
            ch = sys.stdin.read(1)
 
1852
        finally:
 
1853
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
 
1854
        return ch
 
1855
 
 
1856
 
 
1857
if sys.platform == 'linux2':
 
1858
    def _local_concurrency():
 
1859
        concurrency = None
 
1860
        prefix = 'processor'
 
1861
        for line in file('/proc/cpuinfo', 'rb'):
 
1862
            if line.startswith(prefix):
 
1863
                concurrency = int(line[line.find(':')+1:]) + 1
 
1864
        return concurrency
 
1865
elif sys.platform == 'darwin':
 
1866
    def _local_concurrency():
 
1867
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
 
1868
                                stdout=subprocess.PIPE).communicate()[0]
 
1869
elif sys.platform[0:7] == 'freebsd':
 
1870
    def _local_concurrency():
 
1871
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
 
1872
                                stdout=subprocess.PIPE).communicate()[0]
 
1873
elif sys.platform == 'sunos5':
 
1874
    def _local_concurrency():
 
1875
        return subprocess.Popen(['psrinfo', '-p',],
 
1876
                                stdout=subprocess.PIPE).communicate()[0]
 
1877
elif sys.platform == "win32":
 
1878
    def _local_concurrency():
 
1879
        # This appears to return the number of cores.
 
1880
        return os.environ.get('NUMBER_OF_PROCESSORS')
 
1881
else:
 
1882
    def _local_concurrency():
 
1883
        # Who knows ?
 
1884
        return None
 
1885
 
 
1886
 
 
1887
_cached_local_concurrency = None
 
1888
 
 
1889
def local_concurrency(use_cache=True):
 
1890
    """Return how many processes can be run concurrently.
 
1891
 
 
1892
    Rely on platform specific implementations and default to 1 (one) if
 
1893
    anything goes wrong.
 
1894
    """
 
1895
    global _cached_local_concurrency
 
1896
    if _cached_local_concurrency is not None and use_cache:
 
1897
        return _cached_local_concurrency
 
1898
 
 
1899
    try:
 
1900
        concurrency = _local_concurrency()
 
1901
    except (OSError, IOError):
 
1902
        concurrency = None
 
1903
    try:
 
1904
        concurrency = int(concurrency)
 
1905
    except (TypeError, ValueError):
 
1906
        concurrency = 1
 
1907
    if use_cache:
 
1908
        _cached_concurrency = concurrency
 
1909
    return concurrency