~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

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

Show diffs side-by-side

added added

removed removed

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