~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Ian Clatworthy
  • Date: 2007-08-13 14:16:53 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070813141653-3cbrp00xowq58zv1
Added mini tutorial

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2009 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
 
17
from cStringIO import StringIO
17
18
import os
18
19
import re
19
20
import stat
34
35
                    splitdrive as _nt_splitdrive,
35
36
                    )
36
37
import posixpath
 
38
import sha
37
39
import shutil
38
40
from shutil import (
39
41
    rmtree,
40
42
    )
41
 
import subprocess
42
43
import tempfile
43
44
from tempfile import (
44
45
    mkdtemp,
52
53
    )
53
54
""")
54
55
 
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
 
 
69
56
import bzrlib
70
57
from bzrlib import symbol_versioning
 
58
from bzrlib.symbol_versioning import (
 
59
    deprecated_function,
 
60
    zero_nine,
 
61
    )
 
62
from bzrlib.trace import mutter
71
63
 
72
64
 
73
65
# On win32, O_BINARY is used to indicate the file should
77
69
# OR with 0 on those platforms
78
70
O_BINARY = getattr(os, 'O_BINARY', 0)
79
71
 
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
 
 
 
72
# On posix, use lstat instead of stat so that we can
 
73
# operate on broken symlinks. On Windows revert to stat.
 
74
lstat = getattr(os, 'lstat', os.stat)
89
75
 
90
76
def make_readonly(filename):
91
77
    """Make a filename read-only."""
92
 
    mod = os.lstat(filename).st_mode
 
78
    mod = lstat(filename).st_mode
93
79
    if not stat.S_ISLNK(mod):
94
80
        mod = mod & 0777555
95
81
        os.chmod(filename, mod)
96
82
 
97
83
 
98
84
def make_writable(filename):
99
 
    mod = os.lstat(filename).st_mode
 
85
    mod = lstat(filename).st_mode
100
86
    if not stat.S_ISLNK(mod):
101
87
        mod = mod | 0200
102
88
        os.chmod(filename, mod)
103
89
 
104
90
 
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
 
 
128
91
_QUOTE_RE = None
129
92
 
130
93
 
137
100
    global _QUOTE_RE
138
101
    if _QUOTE_RE is None:
139
102
        _QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
140
 
 
 
103
        
141
104
    if _QUOTE_RE.search(f):
142
105
        return '"' + f + '"'
143
106
    else:
146
109
 
147
110
_directory_kind = 'directory'
148
111
 
 
112
_formats = {
 
113
    stat.S_IFDIR:_directory_kind,
 
114
    stat.S_IFCHR:'chardev',
 
115
    stat.S_IFBLK:'block',
 
116
    stat.S_IFREG:'file',
 
117
    stat.S_IFIFO:'fifo',
 
118
    stat.S_IFLNK:'symlink',
 
119
    stat.S_IFSOCK:'socket',
 
120
}
 
121
 
 
122
 
 
123
def file_kind_from_stat_mode(stat_mode, _formats=_formats, _unknown='unknown'):
 
124
    """Generate a file kind from a stat mode. This is used in walkdirs.
 
125
 
 
126
    Its performance is critical: Do not mutate without careful benchmarking.
 
127
    """
 
128
    try:
 
129
        return _formats[stat_mode & 0170000]
 
130
    except KeyError:
 
131
        return _unknown
 
132
 
 
133
 
 
134
def file_kind(f, _lstat=os.lstat, _mapper=file_kind_from_stat_mode):
 
135
    try:
 
136
        return _mapper(_lstat(f).st_mode)
 
137
    except OSError, e:
 
138
        if getattr(e, 'errno', None) == errno.ENOENT:
 
139
            raise errors.NoSuchFile(f)
 
140
        raise
 
141
 
 
142
 
149
143
def get_umask():
150
144
    """Return the current umask"""
151
145
    # Assume that people aren't messing with the umask while running
187
181
 
188
182
def fancy_rename(old, new, rename_func, unlink_func):
189
183
    """A fancy rename, when you don't have atomic rename.
190
 
 
 
184
    
191
185
    :param old: The old path, to rename from
192
186
    :param new: The new path, to rename to
193
187
    :param rename_func: The potentially non-atomic rename function
195
189
    """
196
190
 
197
191
    # sftp rename doesn't allow overwriting, so play tricks:
 
192
    import random
198
193
    base = os.path.basename(new)
199
194
    dirname = os.path.dirname(new)
200
195
    tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
225
220
 
226
221
    success = False
227
222
    try:
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
 
223
        # This may throw an exception, in which case success will
 
224
        # not be set.
 
225
        rename_func(old, new)
 
226
        success = True
239
227
    finally:
240
228
        if file_existed:
241
229
            # If the file used to exist, rename it back into place
307
295
        path = cwd + '\\' + path
308
296
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
309
297
 
 
298
if win32utils.winver == 'Windows 98':
 
299
    _win32_abspath = _win98_abspath
 
300
 
310
301
 
311
302
def _win32_realpath(path):
312
303
    # Real _nt_realpath doesn't have a problem with a unicode cwd
333
324
    """We expect to be able to atomically replace 'new' with old.
334
325
 
335
326
    On win32, if new exists, it must be moved out of the way first,
336
 
    and then deleted.
 
327
    and then deleted. 
337
328
    """
338
329
    try:
339
330
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
340
331
    except OSError, e:
341
332
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
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
 
333
            # If we try to rename a non-existant file onto cwd, we get 
 
334
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT 
344
335
            # if the old path doesn't exist, sometimes we get EACCES
345
336
            # On Linux, we seem to get EBUSY, on Mac we get EINVAL
346
337
            os.lstat(old)
348
339
 
349
340
 
350
341
def _mac_getcwd():
351
 
    return unicodedata.normalize('NFC', os.getcwdu())
 
342
    return unicodedata.normalize('NFKC', os.getcwdu())
352
343
 
353
344
 
354
345
# Default is to just use the python builtins, but these can be rebound on
371
362
 
372
363
 
373
364
if sys.platform == 'win32':
374
 
    if win32utils.winver == 'Windows 98':
375
 
        abspath = _win98_abspath
376
 
    else:
377
 
        abspath = _win32_abspath
 
365
    abspath = _win32_abspath
378
366
    realpath = _win32_realpath
379
367
    pathjoin = _win32_pathjoin
380
368
    normpath = _win32_normpath
400
388
    def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
401
389
        """Replacer for shutil.rmtree: could remove readonly dirs/files"""
402
390
        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
 
 
408
391
elif sys.platform == 'darwin':
409
392
    getcwd = _mac_getcwd
410
393
 
414
397
 
415
398
    This attempts to check both sys.stdout and sys.stdin to see
416
399
    what encoding they are in, and if that fails it falls back to
417
 
    osutils.get_user_encoding().
 
400
    bzrlib.user_encoding.
418
401
    The problem is that on Windows, locale.getpreferredencoding()
419
402
    is not the same encoding as that used by the console:
420
403
    http://mail.python.org/pipermail/python-list/2003-May/162357.html
422
405
    On my standard US Windows XP, the preferred encoding is
423
406
    cp1252, but the console is cp437
424
407
    """
425
 
    from bzrlib.trace import mutter
426
408
    output_encoding = getattr(sys.stdout, 'encoding', None)
427
409
    if not output_encoding:
428
410
        input_encoding = getattr(sys.stdin, 'encoding', None)
429
411
        if not input_encoding:
430
 
            output_encoding = get_user_encoding()
431
 
            mutter('encoding stdout as osutils.get_user_encoding() %r',
432
 
                   output_encoding)
 
412
            output_encoding = bzrlib.user_encoding
 
413
            mutter('encoding stdout as bzrlib.user_encoding %r', output_encoding)
433
414
        else:
434
415
            output_encoding = input_encoding
435
416
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
437
418
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
438
419
    if output_encoding == 'cp0':
439
420
        # invalid encoding (cp0 means 'no codepage' on Windows)
440
 
        output_encoding = get_user_encoding()
 
421
        output_encoding = bzrlib.user_encoding
441
422
        mutter('cp0 is invalid encoding.'
442
 
               ' encoding stdout as osutils.get_user_encoding() %r',
443
 
               output_encoding)
 
423
               ' encoding stdout as bzrlib.user_encoding %r', output_encoding)
444
424
    # check encoding
445
425
    try:
446
426
        codecs.lookup(output_encoding)
448
428
        sys.stderr.write('bzr: warning:'
449
429
                         ' unknown terminal encoding %s.\n'
450
430
                         '  Using encoding %s instead.\n'
451
 
                         % (output_encoding, get_user_encoding())
 
431
                         % (output_encoding, bzrlib.user_encoding)
452
432
                        )
453
 
        output_encoding = get_user_encoding()
 
433
        output_encoding = bzrlib.user_encoding
454
434
 
455
435
    return output_encoding
456
436
 
467
447
        return pathjoin(F(p), e)
468
448
 
469
449
 
 
450
def backup_file(fn):
 
451
    """Copy a file to a backup.
 
452
 
 
453
    Backups are named in GNU-style, with a ~ suffix.
 
454
 
 
455
    If the file is already a backup, it's not copied.
 
456
    """
 
457
    if fn[-1] == '~':
 
458
        return
 
459
    bfn = fn + '~'
 
460
 
 
461
    if has_symlinks() and os.path.islink(fn):
 
462
        target = os.readlink(fn)
 
463
        os.symlink(target, bfn)
 
464
        return
 
465
    inf = file(fn, 'rb')
 
466
    try:
 
467
        content = inf.read()
 
468
    finally:
 
469
        inf.close()
 
470
    
 
471
    outf = file(bfn, 'wb')
 
472
    try:
 
473
        outf.write(content)
 
474
    finally:
 
475
        outf.close()
 
476
 
 
477
 
470
478
def isdir(f):
471
479
    """True if f is an accessible directory."""
472
480
    try:
491
499
 
492
500
def is_inside(dir, fname):
493
501
    """True if fname is inside dir.
494
 
 
 
502
    
495
503
    The parameters should typically be passed to osutils.normpath first, so
496
504
    that . and .. and repeated slashes are eliminated, and the separators
497
505
    are canonical for the platform.
498
 
 
499
 
    The empty string as a dir name is taken as top-of-tree and matches
 
506
    
 
507
    The empty string as a dir name is taken as top-of-tree and matches 
500
508
    everything.
501
509
    """
502
 
    # XXX: Most callers of this can actually do something smarter by
 
510
    # XXX: Most callers of this can actually do something smarter by 
503
511
    # looking at the inventory
504
512
    if dir == fname:
505
513
        return True
506
 
 
 
514
    
507
515
    if dir == '':
508
516
        return True
509
517
 
529
537
    return False
530
538
 
531
539
 
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)
 
540
def pumpfile(fromfile, tofile):
 
541
    """Copy contents of one file to another."""
 
542
    BUFSIZE = 32768
 
543
    while True:
 
544
        b = fromfile.read(BUFSIZE)
 
545
        if not b:
 
546
            break
 
547
        tofile.write(b)
596
548
 
597
549
 
598
550
def file_iterator(input_file, readsize=32768):
604
556
 
605
557
 
606
558
def sha_file(f):
607
 
    """Calculate the hexdigest of an open file.
608
 
 
609
 
    The file cursor should be already at the start.
610
 
    """
611
 
    s = sha()
 
559
    if getattr(f, 'tell', None) is not None:
 
560
        assert f.tell() == 0
 
561
    s = sha.new()
612
562
    BUFSIZE = 128<<10
613
563
    while True:
614
564
        b = f.read(BUFSIZE)
618
568
    return s.hexdigest()
619
569
 
620
570
 
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):
 
571
 
 
572
def sha_strings(strings):
654
573
    """Return the sha-1 of concatenation of strings"""
655
 
    s = _factory()
 
574
    s = sha.new()
656
575
    map(s.update, strings)
657
576
    return s.hexdigest()
658
577
 
659
578
 
660
 
def sha_string(f, _factory=sha):
661
 
    return _factory(f).hexdigest()
 
579
def sha_string(f):
 
580
    s = sha.new()
 
581
    s.update(f)
 
582
    return s.hexdigest()
662
583
 
663
584
 
664
585
def fingerprint_file(f):
 
586
    s = sha.new()
665
587
    b = f.read()
666
 
    return {'size': len(b),
667
 
            'sha1': sha(b).hexdigest()}
 
588
    s.update(b)
 
589
    size = len(b)
 
590
    return {'size': size,
 
591
            'sha1': s.hexdigest()}
668
592
 
669
593
 
670
594
def compare_files(a, b):
686
610
    offset = datetime.fromtimestamp(t) - datetime.utcfromtimestamp(t)
687
611
    return offset.days * 86400 + offset.seconds
688
612
 
689
 
weekdays = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
690
 
 
 
613
    
691
614
def format_date(t, offset=0, timezone='original', date_fmt=None,
692
615
                show_offset=True):
693
616
    """Return a formatted date string.
697
620
    :param timezone: How to display the time: 'utc', 'original' for the
698
621
         timezone specified by offset, or 'local' for the process's current
699
622
         timezone.
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):
 
623
    :param show_offset: Whether to append the timezone.
 
624
    :param date_fmt: strftime format.
 
625
    """
729
626
    if timezone == 'utc':
730
627
        tt = time.gmtime(t)
731
628
        offset = 0
737
634
        tt = time.localtime(t)
738
635
        offset = local_time_offset(t)
739
636
    else:
740
 
        raise errors.UnsupportedTimezoneFormat(timezone)
 
637
        raise errors.BzrError("unsupported timezone format %r" % timezone,
 
638
                              ['options are "utc", "original", "local"'])
741
639
    if date_fmt is None:
742
640
        date_fmt = "%a %Y-%m-%d %H:%M:%S"
743
641
    if show_offset:
744
642
        offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
745
643
    else:
746
644
        offset_str = ''
747
 
    return (date_fmt, tt, offset_str)
 
645
    return (time.strftime(date_fmt, tt) +  offset_str)
748
646
 
749
647
 
750
648
def compact_date(when):
751
649
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
752
 
 
 
650
    
753
651
 
754
652
def format_delta(delta):
755
653
    """Get a nice looking string for a time delta.
831
729
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
832
730
def rand_chars(num):
833
731
    """Return a random string of num alphanumeric characters
834
 
 
835
 
    The result only contains lowercase chars because it may be used on
 
732
    
 
733
    The result only contains lowercase chars because it may be used on 
836
734
    case-insensitive filesystems.
837
735
    """
838
736
    s = ''
846
744
 
847
745
def splitpath(p):
848
746
    """Turn string into list of parts."""
 
747
    assert isinstance(p, basestring)
 
748
 
849
749
    # split on either delimiter because people might use either on
850
750
    # Windows
851
751
    ps = re.split(r'[\\/]', p)
860
760
            rps.append(f)
861
761
    return rps
862
762
 
863
 
 
864
763
def joinpath(p):
 
764
    assert isinstance(p, (list, tuple))
865
765
    for f in p:
866
766
        if (f == '..') or (f is None) or (f == ''):
867
767
            raise errors.BzrError("sorry, %r not allowed in path" % f)
868
768
    return pathjoin(*p)
869
769
 
870
770
 
871
 
def parent_directories(filename):
872
 
    """Return the list of parent directories, deepest first.
 
771
@deprecated_function(zero_nine)
 
772
def appendpath(p1, p2):
 
773
    if p1 == '':
 
774
        return p2
 
775
    else:
 
776
        return pathjoin(p1, p2)
873
777
    
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
778
 
890
779
def split_lines(s):
891
780
    """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
 
    """
906
781
    lines = s.split('\n')
907
782
    result = [line + '\n' for line in lines[:-1]]
908
783
    if lines[-1]:
926
801
            raise
927
802
        shutil.copyfile(src, dest)
928
803
 
929
 
 
930
 
def delete_any(path):
931
 
    """Delete a file, symlink or directory.  
932
 
    
933
 
    Will delete even if readonly.
934
 
    """
 
804
def delete_any(full_path):
 
805
    """Delete a file or directory."""
935
806
    try:
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:
 
807
        os.unlink(full_path)
 
808
    except OSError, e:
 
809
    # We may be renaming a dangling inventory id
 
810
        if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
946
811
            raise
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)
 
812
        os.rmdir(full_path)
959
813
 
960
814
 
961
815
def has_symlinks():
963
817
        return True
964
818
    else:
965
819
        return False
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
 
 
 
820
        
993
821
 
994
822
def contains_whitespace(s):
995
823
    """True if there are any whitespace characters in s."""
1031
859
    avoids that problem.
1032
860
    """
1033
861
 
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,))
 
862
    assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
 
863
        ' exceed the platform minimum length (which is %d)' % 
 
864
        MIN_ABS_PATHLENGTH)
1038
865
 
1039
866
    rp = abspath(path)
1040
867
 
1041
868
    s = []
1042
869
    head = rp
1043
 
    while True:
1044
 
        if len(head) <= len(base) and head != base:
1045
 
            raise errors.PathNotChild(rp, base)
 
870
    while len(head) >= len(base):
1046
871
        if head == base:
1047
872
            break
1048
 
        head, tail = split(head)
 
873
        head, tail = os.path.split(head)
1049
874
        if tail:
1050
 
            s.append(tail)
 
875
            s.insert(0, tail)
 
876
    else:
 
877
        raise errors.PathNotChild(rp, base)
1051
878
 
1052
879
    if s:
1053
 
        return pathjoin(*reversed(s))
 
880
        return pathjoin(*s)
1054
881
    else:
1055
882
        return ''
1056
883
 
1057
884
 
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
 
        for look in _listdir(current):
1087
 
            if lbit == look.lower():
1088
 
                current = pathjoin(current, look)
1089
 
                break
1090
 
        else:
1091
 
            # got to the end, nothing matched, so we just return the
1092
 
            # non-existing bits as they were specified (the filename may be
1093
 
            # the target of a move, for example).
1094
 
            current = pathjoin(current, bit, *list(bit_iter))
1095
 
            break
1096
 
    return current[len(abs_base)+1:]
1097
 
 
1098
 
# XXX - TODO - we need better detection/integration of case-insensitive
1099
 
# file-systems; Linux often sees FAT32 devices (or NFS-mounted OSX
1100
 
# filesystems), for example, so could probably benefit from the same basic
1101
 
# support there.  For now though, only Windows and OSX get that support, and
1102
 
# they get it for *all* file-systems!
1103
 
if sys.platform in ('win32', 'darwin'):
1104
 
    canonical_relpath = _cicp_canonical_relpath
1105
 
else:
1106
 
    canonical_relpath = relpath
1107
 
 
1108
 
def canonical_relpaths(base, paths):
1109
 
    """Create an iterable to canonicalize a sequence of relative paths.
1110
 
 
1111
 
    The intent is for this implementation to use a cache, vastly speeding
1112
 
    up multiple transformations in the same directory.
1113
 
    """
1114
 
    # but for now, we haven't optimized...
1115
 
    return [canonical_relpath(base, p) for p in paths]
1116
 
 
1117
885
def safe_unicode(unicode_or_utf8_string):
1118
886
    """Coerce unicode_or_utf8_string into unicode.
1119
887
 
1120
888
    If it is unicode, it is returned.
1121
 
    Otherwise it is decoded from utf-8. If decoding fails, the exception is
1122
 
    wrapped in a BzrBadParameterNotUnicode exception.
 
889
    Otherwise it is decoded from utf-8. If a decoding error
 
890
    occurs, it is wrapped as a If the decoding fails, the exception is wrapped 
 
891
    as a BzrBadParameter exception.
1123
892
    """
1124
893
    if isinstance(unicode_or_utf8_string, unicode):
1125
894
        return unicode_or_utf8_string
1212
981
 
1213
982
    On platforms where the system normalizes filenames (Mac OSX),
1214
983
    you can access a file by any path which will normalize correctly.
1215
 
    On platforms where the system does not normalize filenames
 
984
    On platforms where the system does not normalize filenames 
1216
985
    (Windows, Linux), you have to access a file by its exact path.
1217
986
 
1218
 
    Internally, bzr only supports NFC normalization, since that is
 
987
    Internally, bzr only supports NFC/NFKC normalization, since that is 
1219
988
    the standard for XML documents.
1220
989
 
1221
990
    So return the normalized path, and a flag indicating if the file
1222
991
    can be accessed by that path.
1223
992
    """
1224
993
 
1225
 
    return unicodedata.normalize('NFC', unicode(path)), True
 
994
    return unicodedata.normalize('NFKC', unicode(path)), True
1226
995
 
1227
996
 
1228
997
def _inaccessible_normalized_filename(path):
1229
998
    __doc__ = _accessible_normalized_filename.__doc__
1230
999
 
1231
 
    normalized = unicodedata.normalize('NFC', unicode(path))
 
1000
    normalized = unicodedata.normalize('NFKC', unicode(path))
1232
1001
    return normalized, normalized == path
1233
1002
 
1234
1003
 
1292
1061
            del os.environ[env_variable]
1293
1062
    else:
1294
1063
        if isinstance(value, unicode):
1295
 
            value = value.encode(get_user_encoding())
 
1064
            value = value.encode(bzrlib.user_encoding)
1296
1065
        os.environ[env_variable] = value
1297
1066
    return orig_val
1298
1067
 
1301
1070
 
1302
1071
 
1303
1072
def check_legal_path(path):
1304
 
    """Check whether the supplied path is legal.
 
1073
    """Check whether the supplied path is legal.  
1305
1074
    This is only required on Windows, so we don't test on other platforms
1306
1075
    right now.
1307
1076
    """
1311
1080
        raise errors.IllegalPath(path)
1312
1081
 
1313
1082
 
1314
 
_WIN32_ERROR_DIRECTORY = 267 # Similar to errno.ENOTDIR
1315
 
 
1316
 
def _is_error_enotdir(e):
1317
 
    """Check if this exception represents ENOTDIR.
1318
 
 
1319
 
    Unfortunately, python is very inconsistent about the exception
1320
 
    here. The cases are:
1321
 
      1) Linux, Mac OSX all versions seem to set errno == ENOTDIR
1322
 
      2) Windows, Python2.4, uses errno == ERROR_DIRECTORY (267)
1323
 
         which is the windows error code.
1324
 
      3) Windows, Python2.5 uses errno == EINVAL and
1325
 
         winerror == ERROR_DIRECTORY
1326
 
 
1327
 
    :param e: An Exception object (expected to be OSError with an errno
1328
 
        attribute, but we should be able to cope with anything)
1329
 
    :return: True if this represents an ENOTDIR error. False otherwise.
1330
 
    """
1331
 
    en = getattr(e, 'errno', None)
1332
 
    if (en == errno.ENOTDIR
1333
 
        or (sys.platform == 'win32'
1334
 
            and (en == _WIN32_ERROR_DIRECTORY
1335
 
                 or (en == errno.EINVAL
1336
 
                     and getattr(e, 'winerror', None) == _WIN32_ERROR_DIRECTORY)
1337
 
        ))):
1338
 
        return True
1339
 
    return False
1340
 
 
1341
 
 
1342
1083
def walkdirs(top, prefix=""):
1343
1084
    """Yield data about all the directories in a tree.
1344
 
 
 
1085
    
1345
1086
    This yields all the data about the contents of a directory at a time.
1346
1087
    After each directory has been yielded, if the caller has mutated the list
1347
1088
    to exclude some directories, they are then not descended into.
1348
 
 
 
1089
    
1349
1090
    The data yielded is of the form:
1350
1091
    ((directory-relpath, directory-path-from-top),
1351
 
    [(relpath, basename, kind, lstat, path-from-top), ...]),
 
1092
    [(directory-relpath, basename, kind, lstat, path-from-top), ...]),
1352
1093
     - directory-relpath is the relative path of the directory being returned
1353
1094
       with respect to top. prefix is prepended to this.
1354
 
     - directory-path-from-root is the path including top for this directory.
 
1095
     - directory-path-from-root is the path including top for this directory. 
1355
1096
       It is suitable for use with os functions.
1356
1097
     - relpath is the relative path within the subtree being walked.
1357
1098
     - basename is the basename of the path
1359
1100
       present within the tree - but it may be recorded as versioned. See
1360
1101
       versioned_kind.
1361
1102
     - lstat is the stat data *if* the file was statted.
1362
 
     - planned, not implemented:
 
1103
     - planned, not implemented: 
1363
1104
       path_from_tree_root is the path from the root of the tree.
1364
1105
 
1365
 
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This
 
1106
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This 
1366
1107
        allows one to walk a subtree but get paths that are relative to a tree
1367
1108
        rooted higher up.
1368
1109
    :return: an iterator over the dirs.
1369
1110
    """
1370
1111
    #TODO there is a bit of a smell where the results of the directory-
1371
 
    # summary in this, and the path from the root, may not agree
 
1112
    # summary in this, and the path from the root, may not agree 
1372
1113
    # depending on top and prefix - i.e. ./foo and foo as a pair leads to
1373
1114
    # potentially confusing output. We should make this more robust - but
1374
1115
    # not at a speed cost. RBC 20060731
1375
1116
    _lstat = os.lstat
1376
1117
    _directory = _directory_kind
1377
1118
    _listdir = os.listdir
1378
 
    _kind_from_mode = file_kind_from_stat_mode
 
1119
    _kind_from_mode = _formats.get
1379
1120
    pending = [(safe_unicode(prefix), "", _directory, None, safe_unicode(top))]
1380
1121
    while pending:
1381
1122
        # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1388
1129
 
1389
1130
        dirblock = []
1390
1131
        append = dirblock.append
1391
 
        try:
1392
 
            names = sorted(_listdir(top))
1393
 
        except OSError, e:
1394
 
            if not _is_error_enotdir(e):
1395
 
                raise
1396
 
        else:
1397
 
            for name in names:
1398
 
                abspath = top_slash + name
1399
 
                statvalue = _lstat(abspath)
1400
 
                kind = _kind_from_mode(statvalue.st_mode)
1401
 
                append((relprefix + name, name, kind, statvalue, abspath))
 
1132
        for name in sorted(_listdir(top)):
 
1133
            abspath = top_slash + name
 
1134
            statvalue = _lstat(abspath)
 
1135
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
 
1136
            append((relprefix + name, name, kind, statvalue, abspath))
1402
1137
        yield (relroot, top), dirblock
1403
1138
 
1404
1139
        # push the user specified dirs from dirblock
1405
1140
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1406
1141
 
1407
1142
 
1408
 
class DirReader(object):
1409
 
    """An interface for reading directories."""
1410
 
 
1411
 
    def top_prefix_to_starting_dir(self, top, prefix=""):
1412
 
        """Converts top and prefix to a starting dir entry
1413
 
 
1414
 
        :param top: A utf8 path
1415
 
        :param prefix: An optional utf8 path to prefix output relative paths
1416
 
            with.
1417
 
        :return: A tuple starting with prefix, and ending with the native
1418
 
            encoding of top.
1419
 
        """
1420
 
        raise NotImplementedError(self.top_prefix_to_starting_dir)
1421
 
 
1422
 
    def read_dir(self, prefix, top):
1423
 
        """Read a specific dir.
1424
 
 
1425
 
        :param prefix: A utf8 prefix to be preprended to the path basenames.
1426
 
        :param top: A natively encoded path to read.
1427
 
        :return: A list of the directories contents. Each item contains:
1428
 
            (utf8_relpath, utf8_name, kind, lstatvalue, native_abspath)
1429
 
        """
1430
 
        raise NotImplementedError(self.read_dir)
1431
 
 
1432
 
 
1433
 
_selected_dir_reader = None
1434
 
 
1435
 
 
1436
1143
def _walkdirs_utf8(top, prefix=""):
1437
1144
    """Yield data about all the directories in a tree.
1438
1145
 
1447
1154
        path-from-top might be unicode or utf8, but it is the correct path to
1448
1155
        pass to os functions to affect the file in question. (such as os.lstat)
1449
1156
    """
1450
 
    global _selected_dir_reader
1451
 
    if _selected_dir_reader is None:
1452
 
        fs_encoding = _fs_enc.upper()
1453
 
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1454
 
            # Win98 doesn't have unicode apis like FindFirstFileW
1455
 
            # TODO: We possibly could support Win98 by falling back to the
1456
 
            #       original FindFirstFile, and using TCHAR instead of WCHAR,
1457
 
            #       but that gets a bit tricky, and requires custom compiling
1458
 
            #       for win98 anyway.
1459
 
            try:
1460
 
                from bzrlib._walkdirs_win32 import Win32ReadDir
1461
 
                _selected_dir_reader = Win32ReadDir()
1462
 
            except ImportError:
1463
 
                pass
1464
 
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1465
 
            # ANSI_X3.4-1968 is a form of ASCII
1466
 
            try:
1467
 
                from bzrlib._readdir_pyx import UTF8DirReader
1468
 
                _selected_dir_reader = UTF8DirReader()
1469
 
            except ImportError:
1470
 
                pass
1471
 
 
1472
 
    if _selected_dir_reader is None:
1473
 
        # Fallback to the python version
1474
 
        _selected_dir_reader = UnicodeDirReader()
 
1157
    fs_encoding = _fs_enc.upper()
 
1158
    if (sys.platform == 'win32' or
 
1159
        fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968')): # ascii
 
1160
        return _walkdirs_unicode_to_utf8(top, prefix=prefix)
 
1161
    else:
 
1162
        return _walkdirs_fs_utf8(top, prefix=prefix)
 
1163
 
 
1164
 
 
1165
def _walkdirs_fs_utf8(top, prefix=""):
 
1166
    """See _walkdirs_utf8.
 
1167
 
 
1168
    This sub-function is called when we know the filesystem is already in utf8
 
1169
    encoding. So we don't need to transcode filenames.
 
1170
    """
 
1171
    _lstat = os.lstat
 
1172
    _directory = _directory_kind
 
1173
    _listdir = os.listdir
 
1174
    _kind_from_mode = _formats.get
1475
1175
 
1476
1176
    # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1477
1177
    # But we don't actually uses 1-3 in pending, so set them to None
1478
 
    pending = [[_selected_dir_reader.top_prefix_to_starting_dir(top, prefix)]]
1479
 
    read_dir = _selected_dir_reader.read_dir
1480
 
    _directory = _directory_kind
 
1178
    pending = [(safe_utf8(prefix), None, None, None, safe_utf8(top))]
1481
1179
    while pending:
1482
 
        relroot, _, _, _, top = pending[-1].pop()
1483
 
        if not pending[-1]:
1484
 
            pending.pop()
1485
 
        dirblock = sorted(read_dir(relroot, top))
 
1180
        relroot, _, _, _, top = pending.pop()
 
1181
        if relroot:
 
1182
            relprefix = relroot + '/'
 
1183
        else:
 
1184
            relprefix = ''
 
1185
        top_slash = top + '/'
 
1186
 
 
1187
        dirblock = []
 
1188
        append = dirblock.append
 
1189
        for name in sorted(_listdir(top)):
 
1190
            abspath = top_slash + name
 
1191
            statvalue = _lstat(abspath)
 
1192
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
 
1193
            append((relprefix + name, name, kind, statvalue, abspath))
1486
1194
        yield (relroot, top), dirblock
 
1195
 
1487
1196
        # push the user specified dirs from dirblock
1488
 
        next = [d for d in reversed(dirblock) if d[2] == _directory]
1489
 
        if next:
1490
 
            pending.append(next)
1491
 
 
1492
 
 
1493
 
class UnicodeDirReader(DirReader):
1494
 
    """A dir reader for non-utf8 file systems, which transcodes."""
1495
 
 
1496
 
    __slots__ = ['_utf8_encode']
1497
 
 
1498
 
    def __init__(self):
1499
 
        self._utf8_encode = codecs.getencoder('utf8')
1500
 
 
1501
 
    def top_prefix_to_starting_dir(self, top, prefix=""):
1502
 
        """See DirReader.top_prefix_to_starting_dir."""
1503
 
        return (safe_utf8(prefix), None, None, None, safe_unicode(top))
1504
 
 
1505
 
    def read_dir(self, prefix, top):
1506
 
        """Read a single directory from a non-utf8 file system.
1507
 
 
1508
 
        top, and the abspath element in the output are unicode, all other paths
1509
 
        are utf8. Local disk IO is done via unicode calls to listdir etc.
1510
 
 
1511
 
        This is currently the fallback code path when the filesystem encoding is
1512
 
        not UTF-8. It may be better to implement an alternative so that we can
1513
 
        safely handle paths that are not properly decodable in the current
1514
 
        encoding.
1515
 
 
1516
 
        See DirReader.read_dir for details.
1517
 
        """
1518
 
        _utf8_encode = self._utf8_encode
1519
 
        _lstat = os.lstat
1520
 
        _listdir = os.listdir
1521
 
        _kind_from_mode = file_kind_from_stat_mode
1522
 
 
1523
 
        if prefix:
1524
 
            relprefix = prefix + '/'
 
1197
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
 
1198
 
 
1199
 
 
1200
def _walkdirs_unicode_to_utf8(top, prefix=""):
 
1201
    """See _walkdirs_utf8
 
1202
 
 
1203
    Because Win32 has a Unicode api, all of the 'path-from-top' entries will be
 
1204
    Unicode paths.
 
1205
    This is currently the fallback code path when the filesystem encoding is
 
1206
    not UTF-8. It may be better to implement an alternative so that we can
 
1207
    safely handle paths that are not properly decodable in the current
 
1208
    encoding.
 
1209
    """
 
1210
    _utf8_encode = codecs.getencoder('utf8')
 
1211
    _lstat = os.lstat
 
1212
    _directory = _directory_kind
 
1213
    _listdir = os.listdir
 
1214
    _kind_from_mode = _formats.get
 
1215
 
 
1216
    pending = [(safe_utf8(prefix), None, None, None, safe_unicode(top))]
 
1217
    while pending:
 
1218
        relroot, _, _, _, top = pending.pop()
 
1219
        if relroot:
 
1220
            relprefix = relroot + '/'
1525
1221
        else:
1526
1222
            relprefix = ''
1527
1223
        top_slash = top + u'/'
1529
1225
        dirblock = []
1530
1226
        append = dirblock.append
1531
1227
        for name in sorted(_listdir(top)):
1532
 
            try:
1533
 
                name_utf8 = _utf8_encode(name)[0]
1534
 
            except UnicodeDecodeError:
1535
 
                raise errors.BadFilenameEncoding(
1536
 
                    _utf8_encode(relprefix)[0] + name, _fs_enc)
 
1228
            name_utf8 = _utf8_encode(name)[0]
1537
1229
            abspath = top_slash + name
1538
1230
            statvalue = _lstat(abspath)
1539
 
            kind = _kind_from_mode(statvalue.st_mode)
 
1231
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
1540
1232
            append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
1541
 
        return dirblock
 
1233
        yield (relroot, top), dirblock
 
1234
 
 
1235
        # push the user specified dirs from dirblock
 
1236
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1542
1237
 
1543
1238
 
1544
1239
def copy_tree(from_path, to_path, handlers={}):
1545
1240
    """Copy all of the entries in from_path into to_path.
1546
1241
 
1547
 
    :param from_path: The base directory to copy.
 
1242
    :param from_path: The base directory to copy. 
1548
1243
    :param to_path: The target directory. If it does not exist, it will
1549
1244
        be created.
1550
1245
    :param handlers: A dictionary of functions, which takes a source and
1619
1314
        return _cached_user_encoding
1620
1315
 
1621
1316
    if sys.platform == 'darwin':
1622
 
        # python locale.getpreferredencoding() always return
1623
 
        # 'mac-roman' on darwin. That's a lie.
 
1317
        # work around egregious python 2.4 bug
1624
1318
        sys.platform = 'posix'
1625
1319
        try:
1626
 
            if os.environ.get('LANG', None) is None:
1627
 
                # If LANG is not set, we end up with 'ascii', which is bad
1628
 
                # ('mac-roman' is more than ascii), so we set a default which
1629
 
                # will give us UTF-8 (which appears to work in all cases on
1630
 
                # OSX). Users are still free to override LANG of course, as
1631
 
                # long as it give us something meaningful. This work-around
1632
 
                # *may* not be needed with python 3k and/or OSX 10.5, but will
1633
 
                # work with them too -- vila 20080908
1634
 
                os.environ['LANG'] = 'en_US.UTF-8'
1635
1320
            import locale
1636
1321
        finally:
1637
1322
            sys.platform = 'darwin'
1652
1337
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
1653
1338
    # treat that as ASCII, and not support printing unicode characters to the
1654
1339
    # console.
1655
 
    #
1656
 
    # For python scripts run under vim, we get '', so also treat that as ASCII
1657
 
    if user_encoding in (None, 'cp0', ''):
 
1340
    if user_encoding in (None, 'cp0'):
1658
1341
        user_encoding = 'ascii'
1659
1342
    else:
1660
1343
        # check encoding
1674
1357
    return user_encoding
1675
1358
 
1676
1359
 
1677
 
def get_host_name():
1678
 
    """Return the current unicode host name.
1679
 
 
1680
 
    This is meant to be used in place of socket.gethostname() because that
1681
 
    behaves inconsistently on different platforms.
1682
 
    """
1683
 
    if sys.platform == "win32":
1684
 
        import win32utils
1685
 
        return win32utils.get_host_name()
1686
 
    else:
1687
 
        import socket
1688
 
        return socket.gethostname().decode(get_user_encoding())
1689
 
 
1690
 
 
1691
1360
def recv_all(socket, bytes):
1692
1361
    """Receive an exact number of bytes.
1693
1362
 
1700
1369
    """
1701
1370
    b = ''
1702
1371
    while len(b) < bytes:
1703
 
        new = until_no_eintr(socket.recv, bytes - len(b))
 
1372
        new = socket.recv(bytes - len(b))
1704
1373
        if new == '':
1705
1374
            break # eof
1706
1375
        b += new
1707
1376
    return b
1708
1377
 
1709
 
 
1710
 
def send_all(socket, bytes, report_activity=None):
1711
 
    """Send all bytes on a socket.
1712
 
 
1713
 
    Regular socket.sendall() can give socket error 10053 on Windows.  This
1714
 
    implementation sends no more than 64k at a time, which avoids this problem.
1715
 
 
1716
 
    :param report_activity: Call this as bytes are read, see
1717
 
        Transport._report_activity
1718
 
    """
1719
 
    chunk_size = 2**16
1720
 
    for pos in xrange(0, len(bytes), chunk_size):
1721
 
        block = bytes[pos:pos+chunk_size]
1722
 
        if report_activity is not None:
1723
 
            report_activity(len(block), 'write')
1724
 
        until_no_eintr(socket.sendall, block)
1725
 
 
1726
 
 
1727
1378
def dereference_path(path):
1728
1379
    """Determine the real path to a file.
1729
1380
 
1736
1387
    # The pathjoin for '.' is a workaround for Python bug #1213894.
1737
1388
    # (initial path components aren't dereferenced)
1738
1389
    return pathjoin(realpath(pathjoin('.', parent)), base)
1739
 
 
1740
 
 
1741
 
def supports_mapi():
1742
 
    """Return True if we can use MAPI to launch a mail client."""
1743
 
    return sys.platform == "win32"
1744
 
 
1745
 
 
1746
 
def resource_string(package, resource_name):
1747
 
    """Load a resource from a package and return it as a string.
1748
 
 
1749
 
    Note: Only packages that start with bzrlib are currently supported.
1750
 
 
1751
 
    This is designed to be a lightweight implementation of resource
1752
 
    loading in a way which is API compatible with the same API from
1753
 
    pkg_resources. See
1754
 
    http://peak.telecommunity.com/DevCenter/PkgResources#basic-resource-access.
1755
 
    If and when pkg_resources becomes a standard library, this routine
1756
 
    can delegate to it.
1757
 
    """
1758
 
    # Check package name is within bzrlib
1759
 
    if package == "bzrlib":
1760
 
        resource_relpath = resource_name
1761
 
    elif package.startswith("bzrlib."):
1762
 
        package = package[len("bzrlib."):].replace('.', os.sep)
1763
 
        resource_relpath = pathjoin(package, resource_name)
1764
 
    else:
1765
 
        raise errors.BzrError('resource package %s not in bzrlib' % package)
1766
 
 
1767
 
    # Map the resource to a file and read its contents
1768
 
    base = dirname(bzrlib.__file__)
1769
 
    if getattr(sys, 'frozen', None):    # bzr.exe
1770
 
        base = abspath(pathjoin(base, '..', '..'))
1771
 
    filename = pathjoin(base, resource_relpath)
1772
 
    return open(filename, 'rU').read()
1773
 
 
1774
 
 
1775
 
def file_kind_from_stat_mode_thunk(mode):
1776
 
    global file_kind_from_stat_mode
1777
 
    if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
1778
 
        try:
1779
 
            from bzrlib._readdir_pyx import UTF8DirReader
1780
 
            file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
1781
 
        except ImportError:
1782
 
            from bzrlib._readdir_py import (
1783
 
                _kind_from_mode as file_kind_from_stat_mode
1784
 
                )
1785
 
    return file_kind_from_stat_mode(mode)
1786
 
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
1787
 
 
1788
 
 
1789
 
def file_kind(f, _lstat=os.lstat):
1790
 
    try:
1791
 
        return file_kind_from_stat_mode(_lstat(f).st_mode)
1792
 
    except OSError, e:
1793
 
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
1794
 
            raise errors.NoSuchFile(f)
1795
 
        raise
1796
 
 
1797
 
 
1798
 
def until_no_eintr(f, *a, **kw):
1799
 
    """Run f(*a, **kw), retrying if an EINTR error occurs."""
1800
 
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
1801
 
    while True:
1802
 
        try:
1803
 
            return f(*a, **kw)
1804
 
        except (IOError, OSError), e:
1805
 
            if e.errno == errno.EINTR:
1806
 
                continue
1807
 
            raise
1808
 
 
1809
 
def re_compile_checked(re_string, flags=0, where=""):
1810
 
    """Return a compiled re, or raise a sensible error.
1811
 
 
1812
 
    This should only be used when compiling user-supplied REs.
1813
 
 
1814
 
    :param re_string: Text form of regular expression.
1815
 
    :param flags: eg re.IGNORECASE
1816
 
    :param where: Message explaining to the user the context where
1817
 
        it occurred, eg 'log search filter'.
1818
 
    """
1819
 
    # from https://bugs.launchpad.net/bzr/+bug/251352
1820
 
    try:
1821
 
        re_obj = re.compile(re_string, flags)
1822
 
        re_obj.search("")
1823
 
        return re_obj
1824
 
    except re.error, e:
1825
 
        if where:
1826
 
            where = ' in ' + where
1827
 
        # despite the name 'error' is a type
1828
 
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
1829
 
            % (where, re_string, e))
1830
 
 
1831
 
 
1832
 
if sys.platform == "win32":
1833
 
    import msvcrt
1834
 
    def getchar():
1835
 
        return msvcrt.getch()
1836
 
else:
1837
 
    import tty
1838
 
    import termios
1839
 
    def getchar():
1840
 
        fd = sys.stdin.fileno()
1841
 
        settings = termios.tcgetattr(fd)
1842
 
        try:
1843
 
            tty.setraw(fd)
1844
 
            ch = sys.stdin.read(1)
1845
 
        finally:
1846
 
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
1847
 
        return ch
1848
 
 
1849
 
 
1850
 
if sys.platform == 'linux2':
1851
 
    def _local_concurrency():
1852
 
        concurrency = None
1853
 
        prefix = 'processor'
1854
 
        for line in file('/proc/cpuinfo', 'rb'):
1855
 
            if line.startswith(prefix):
1856
 
                concurrency = int(line[line.find(':')+1:]) + 1
1857
 
        return concurrency
1858
 
elif sys.platform == 'darwin':
1859
 
    def _local_concurrency():
1860
 
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
1861
 
                                stdout=subprocess.PIPE).communicate()[0]
1862
 
elif sys.platform[0:7] == 'freebsd':
1863
 
    def _local_concurrency():
1864
 
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
1865
 
                                stdout=subprocess.PIPE).communicate()[0]
1866
 
elif sys.platform == 'sunos5':
1867
 
    def _local_concurrency():
1868
 
        return subprocess.Popen(['psrinfo', '-p',],
1869
 
                                stdout=subprocess.PIPE).communicate()[0]
1870
 
elif sys.platform == "win32":
1871
 
    def _local_concurrency():
1872
 
        # This appears to return the number of cores.
1873
 
        return os.environ.get('NUMBER_OF_PROCESSORS')
1874
 
else:
1875
 
    def _local_concurrency():
1876
 
        # Who knows ?
1877
 
        return None
1878
 
 
1879
 
 
1880
 
_cached_local_concurrency = None
1881
 
 
1882
 
def local_concurrency(use_cache=True):
1883
 
    """Return how many processes can be run concurrently.
1884
 
 
1885
 
    Rely on platform specific implementations and default to 1 (one) if
1886
 
    anything goes wrong.
1887
 
    """
1888
 
    global _cached_local_concurrency
1889
 
    if _cached_local_concurrency is not None and use_cache:
1890
 
        return _cached_local_concurrency
1891
 
 
1892
 
    try:
1893
 
        concurrency = _local_concurrency()
1894
 
    except (OSError, IOError):
1895
 
        concurrency = None
1896
 
    try:
1897
 
        concurrency = int(concurrency)
1898
 
    except (TypeError, ValueError):
1899
 
        concurrency = 1
1900
 
    if use_cache:
1901
 
        _cached_concurrency = concurrency
1902
 
    return concurrency