← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-09-25 18:42:17 UTC
  • mfrom: (2039.1.2 progress-cleanup)
  • Revision ID: pqm@pqm.ubuntu.com-20060925184217-fd144de117df49c3
cleanup progress properly when interrupted during fetch (#54000)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/osutils.py
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Bazaar -- distributed version control
 
2
#
 
3
# Copyright (C) 2005 by Canonical Ltd
2
4
#
3
5
# This program is free software; you can redistribute it and/or modify
4
6
# it under the terms of the GNU General Public License as published by
15
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
18
 
17
19
from cStringIO import StringIO
18
 
import os
19
 
import re
20
 
import stat
21
 
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
22
 
                  S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
23
 
import sys
24
 
import time
25
 
 
26
 
from bzrlib.lazy_import import lazy_import
27
 
lazy_import(globals(), """
28
 
import codecs
29
 
from datetime import datetime
30
20
import errno
31
21
from ntpath import (abspath as _nt_abspath,
32
22
                    join as _nt_join,
34
24
                    realpath as _nt_realpath,
35
25
                    splitdrive as _nt_splitdrive,
36
26
                    )
 
27
import os
 
28
from os import listdir
37
29
import posixpath
 
30
import re
38
31
import sha
39
32
import shutil
40
 
from shutil import (
41
 
    rmtree,
42
 
    )
 
33
from shutil import copyfile
 
34
import stat
 
35
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
 
36
                  S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
 
37
import string
 
38
import sys
 
39
import time
 
40
import types
43
41
import tempfile
44
 
from tempfile import (
45
 
    mkdtemp,
46
 
    )
47
42
import unicodedata
48
43
 
49
 
from bzrlib import (
50
 
    cache_utf8,
51
 
    errors,
52
 
    win32utils,
53
 
    )
54
 
""")
55
 
 
56
44
import bzrlib
57
 
from bzrlib.symbol_versioning import (
58
 
    deprecated_function,
59
 
    zero_nine,
60
 
    )
 
45
from bzrlib.errors import (BzrError,
 
46
                           BzrBadParameterNotUnicode,
 
47
                           NoSuchFile,
 
48
                           PathNotChild,
 
49
                           IllegalPath,
 
50
                           )
 
51
from bzrlib.symbol_versioning import (deprecated_function, 
 
52
        zero_nine)
61
53
from bzrlib.trace import mutter
62
54
 
63
55
 
130
122
        return _mapper(_lstat(f).st_mode)
131
123
    except OSError, e:
132
124
        if getattr(e, 'errno', None) == errno.ENOENT:
133
 
            raise errors.NoSuchFile(f)
 
125
            raise bzrlib.errors.NoSuchFile(f)
134
126
        raise
135
127
 
136
128
 
152
144
    elif kind == 'symlink':
153
145
        return '@'
154
146
    else:
155
 
        raise errors.BzrError('invalid file kind %r' % kind)
 
147
        raise BzrError('invalid file kind %r' % kind)
156
148
 
157
149
lexists = getattr(os.path, 'lexists', None)
158
150
if lexists is None:
167
159
            if e.errno == errno.ENOENT:
168
160
                return False;
169
161
            else:
170
 
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
 
162
                raise BzrError("lstat/stat of (%r): %r" % (f, e))
171
163
 
172
164
 
173
165
def fancy_rename(old, new, rename_func, unlink_func):
194
186
    file_existed = False
195
187
    try:
196
188
        rename_func(new, tmp_name)
197
 
    except (errors.NoSuchFile,), e:
 
189
    except (NoSuchFile,), e:
198
190
        pass
199
191
    except IOError, e:
200
192
        # RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
229
221
# choke on a Unicode string containing a relative path if
230
222
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
231
223
# string.
232
 
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
 
224
_fs_enc = sys.getfilesystemencoding()
233
225
def _posix_abspath(path):
234
226
    # jam 20060426 rather than encoding to fsencoding
235
227
    # copy posixpath.abspath, but use os.getcwdu instead
260
252
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
261
253
 
262
254
 
263
 
def _win98_abspath(path):
264
 
    """Return the absolute version of a path.
265
 
    Windows 98 safe implementation (python reimplementation
266
 
    of Win32 API function GetFullPathNameW)
267
 
    """
268
 
    # Corner cases:
269
 
    #   C:\path     => C:/path
270
 
    #   C:/path     => C:/path
271
 
    #   \\HOST\path => //HOST/path
272
 
    #   //HOST/path => //HOST/path
273
 
    #   path        => C:/cwd/path
274
 
    #   /path       => C:/path
275
 
    path = unicode(path)
276
 
    # check for absolute path
277
 
    drive = _nt_splitdrive(path)[0]
278
 
    if drive == '' and path[:2] not in('//','\\\\'):
279
 
        cwd = os.getcwdu()
280
 
        # we cannot simply os.path.join cwd and path
281
 
        # because os.path.join('C:','/path') produce '/path'
282
 
        # and this is incorrect
283
 
        if path[:1] in ('/','\\'):
284
 
            cwd = _nt_splitdrive(cwd)[0]
285
 
            path = path[1:]
286
 
        path = cwd + '\\' + path
287
 
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
288
 
 
289
 
if win32utils.winver == 'Windows 98':
290
 
    _win32_abspath = _win98_abspath
291
 
 
292
 
 
293
255
def _win32_realpath(path):
294
256
    # Real _nt_realpath doesn't have a problem with a unicode cwd
295
257
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
340
302
pathjoin = os.path.join
341
303
normpath = os.path.normpath
342
304
getcwd = os.getcwdu
 
305
mkdtemp = tempfile.mkdtemp
343
306
rename = os.rename
344
307
dirname = os.path.dirname
345
308
basename = os.path.basename
346
 
split = os.path.split
347
 
splitext = os.path.splitext
348
 
# These were already imported into local scope
349
 
# mkdtemp = tempfile.mkdtemp
350
 
# rmtree = shutil.rmtree
 
309
rmtree = shutil.rmtree
351
310
 
352
311
MIN_ABS_PATHLENGTH = 1
353
312
 
367
326
        """Error handler for shutil.rmtree function [for win32]
368
327
        Helps to remove files and dirs marked as read-only.
369
328
        """
370
 
        exception = excinfo[1]
 
329
        type_, value = excinfo[:2]
371
330
        if function in (os.remove, os.rmdir) \
372
 
            and isinstance(exception, OSError) \
373
 
            and exception.errno == errno.EACCES:
374
 
            make_writable(path)
 
331
            and type_ == OSError \
 
332
            and value.errno == errno.EACCES:
 
333
            bzrlib.osutils.make_writable(path)
375
334
            function(path)
376
335
        else:
377
336
            raise
407
366
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
408
367
    else:
409
368
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
410
 
    if output_encoding == 'cp0':
411
 
        # invalid encoding (cp0 means 'no codepage' on Windows)
412
 
        output_encoding = bzrlib.user_encoding
413
 
        mutter('cp0 is invalid encoding.'
414
 
               ' encoding stdout as bzrlib.user_encoding %r', output_encoding)
415
 
    # check encoding
416
 
    try:
417
 
        codecs.lookup(output_encoding)
418
 
    except LookupError:
419
 
        sys.stderr.write('bzr: warning:'
420
 
                         ' unknown terminal encoding %s.\n'
421
 
                         '  Using encoding %s instead.\n'
422
 
                         % (output_encoding, bzrlib.user_encoding)
423
 
                        )
424
 
        output_encoding = bzrlib.user_encoding
425
 
 
426
369
    return output_encoding
427
370
 
428
371
 
497
440
    
498
441
    The empty string as a dir name is taken as top-of-tree and matches 
499
442
    everything.
 
443
    
 
444
    >>> is_inside('src', pathjoin('src', 'foo.c'))
 
445
    True
 
446
    >>> is_inside('src', 'srccontrol')
 
447
    False
 
448
    >>> is_inside('src', pathjoin('src', 'a', 'a', 'a', 'foo.c'))
 
449
    True
 
450
    >>> is_inside('foo.c', 'foo.c')
 
451
    True
 
452
    >>> is_inside('foo.c', '')
 
453
    False
 
454
    >>> is_inside('', 'foo.c')
 
455
    True
500
456
    """
501
457
    # XXX: Most callers of this can actually do something smarter by 
502
458
    # looking at the inventory
598
554
 
599
555
def local_time_offset(t=None):
600
556
    """Return offset of local zone from GMT, either at present or at time t."""
 
557
    # python2.3 localtime() can't take None
601
558
    if t is None:
602
559
        t = time.time()
603
 
    offset = datetime.fromtimestamp(t) - datetime.utcfromtimestamp(t)
604
 
    return offset.days * 86400 + offset.seconds
 
560
        
 
561
    if time.localtime(t).tm_isdst and time.daylight:
 
562
        return -time.altzone
 
563
    else:
 
564
        return -time.timezone
605
565
 
606
566
    
607
567
def format_date(t, offset=0, timezone='original', date_fmt=None, 
621
581
        tt = time.localtime(t)
622
582
        offset = local_time_offset(t)
623
583
    else:
624
 
        raise errors.BzrError("unsupported timezone format %r" % timezone,
625
 
                              ['options are "utc", "original", "local"'])
 
584
        raise BzrError("unsupported timezone format %r" % timezone,
 
585
                       ['options are "utc", "original", "local"'])
626
586
    if date_fmt is None:
627
587
        date_fmt = "%a %Y-%m-%d %H:%M:%S"
628
588
    if show_offset:
636
596
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
637
597
    
638
598
 
639
 
def format_delta(delta):
640
 
    """Get a nice looking string for a time delta.
641
 
 
642
 
    :param delta: The time difference in seconds, can be positive or negative.
643
 
        positive indicates time in the past, negative indicates time in the
644
 
        future. (usually time.time() - stored_time)
645
 
    :return: String formatted to show approximate resolution
646
 
    """
647
 
    delta = int(delta)
648
 
    if delta >= 0:
649
 
        direction = 'ago'
650
 
    else:
651
 
        direction = 'in the future'
652
 
        delta = -delta
653
 
 
654
 
    seconds = delta
655
 
    if seconds < 90: # print seconds up to 90 seconds
656
 
        if seconds == 1:
657
 
            return '%d second %s' % (seconds, direction,)
658
 
        else:
659
 
            return '%d seconds %s' % (seconds, direction)
660
 
 
661
 
    minutes = int(seconds / 60)
662
 
    seconds -= 60 * minutes
663
 
    if seconds == 1:
664
 
        plural_seconds = ''
665
 
    else:
666
 
        plural_seconds = 's'
667
 
    if minutes < 90: # print minutes, seconds up to 90 minutes
668
 
        if minutes == 1:
669
 
            return '%d minute, %d second%s %s' % (
670
 
                    minutes, seconds, plural_seconds, direction)
671
 
        else:
672
 
            return '%d minutes, %d second%s %s' % (
673
 
                    minutes, seconds, plural_seconds, direction)
674
 
 
675
 
    hours = int(minutes / 60)
676
 
    minutes -= 60 * hours
677
 
    if minutes == 1:
678
 
        plural_minutes = ''
679
 
    else:
680
 
        plural_minutes = 's'
681
 
 
682
 
    if hours == 1:
683
 
        return '%d hour, %d minute%s %s' % (hours, minutes,
684
 
                                            plural_minutes, direction)
685
 
    return '%d hours, %d minute%s %s' % (hours, minutes,
686
 
                                         plural_minutes, direction)
687
599
 
688
600
def filesize(f):
689
601
    """Return size of given open file."""
699
611
except (NotImplementedError, AttributeError):
700
612
    # If python doesn't have os.urandom, or it doesn't work,
701
613
    # then try to first pull random data from /dev/urandom
702
 
    try:
 
614
    if os.path.exists("/dev/urandom"):
703
615
        rand_bytes = file('/dev/urandom', 'rb').read
704
616
    # Otherwise, use this hack as a last resort
705
 
    except (IOError, OSError):
 
617
    else:
706
618
        # not well seeded, but better than nothing
707
619
        def rand_bytes(n):
708
620
            import random
730
642
## decomposition (might be too tricksy though.)
731
643
 
732
644
def splitpath(p):
733
 
    """Turn string into list of parts."""
734
 
    assert isinstance(p, basestring)
 
645
    """Turn string into list of parts.
 
646
 
 
647
    >>> splitpath('a')
 
648
    ['a']
 
649
    >>> splitpath('a/b')
 
650
    ['a', 'b']
 
651
    >>> splitpath('a/./b')
 
652
    ['a', 'b']
 
653
    >>> splitpath('a/.b')
 
654
    ['a', '.b']
 
655
    >>> splitpath('a/../b')
 
656
    Traceback (most recent call last):
 
657
    ...
 
658
    BzrError: sorry, '..' not allowed in path
 
659
    """
 
660
    assert isinstance(p, types.StringTypes)
735
661
 
736
662
    # split on either delimiter because people might use either on
737
663
    # Windows
740
666
    rps = []
741
667
    for f in ps:
742
668
        if f == '..':
743
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
669
            raise BzrError("sorry, %r not allowed in path" % f)
744
670
        elif (f == '.') or (f == ''):
745
671
            pass
746
672
        else:
748
674
    return rps
749
675
 
750
676
def joinpath(p):
751
 
    assert isinstance(p, (list, tuple))
 
677
    assert isinstance(p, list)
752
678
    for f in p:
753
679
        if (f == '..') or (f is None) or (f == ''):
754
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
680
            raise BzrError("sorry, %r not allowed in path" % f)
755
681
    return pathjoin(*p)
756
682
 
757
683
 
779
705
def link_or_copy(src, dest):
780
706
    """Hardlink a file, or copy it if it can't be hardlinked."""
781
707
    if not hardlinks_good():
782
 
        shutil.copyfile(src, dest)
 
708
        copyfile(src, dest)
783
709
        return
784
710
    try:
785
711
        os.link(src, dest)
786
712
    except (OSError, IOError), e:
787
713
        if e.errno != errno.EXDEV:
788
714
            raise
789
 
        shutil.copyfile(src, dest)
 
715
        copyfile(src, dest)
790
716
 
791
717
def delete_any(full_path):
792
718
    """Delete a file or directory."""
808
734
 
809
735
def contains_whitespace(s):
810
736
    """True if there are any whitespace characters in s."""
811
 
    # string.whitespace can include '\xa0' in certain locales, because it is
812
 
    # considered "non-breaking-space" as part of ISO-8859-1. But it
813
 
    # 1) Isn't a breaking whitespace
814
 
    # 2) Isn't one of ' \t\r\n' which are characters we sometimes use as
815
 
    #    separators
816
 
    # 3) '\xa0' isn't unicode safe since it is >128.
817
 
 
818
 
    # This should *not* be a unicode set of characters in case the source
819
 
    # string is not a Unicode string. We can auto-up-cast the characters since
820
 
    # they are ascii, but we don't want to auto-up-cast the string in case it
821
 
    # is utf-8
822
 
    for ch in ' \t\n\r\v\f':
 
737
    for ch in string.whitespace:
823
738
        if ch in s:
824
739
            return True
825
740
    else:
861
776
        if tail:
862
777
            s.insert(0, tail)
863
778
    else:
864
 
        raise errors.PathNotChild(rp, base)
 
779
        raise PathNotChild(rp, base)
865
780
 
866
781
    if s:
867
782
        return pathjoin(*s)
882
797
    try:
883
798
        return unicode_or_utf8_string.decode('utf8')
884
799
    except UnicodeDecodeError:
885
 
        raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
886
 
 
887
 
 
888
 
def safe_utf8(unicode_or_utf8_string):
889
 
    """Coerce unicode_or_utf8_string to a utf8 string.
890
 
 
891
 
    If it is a str, it is returned.
892
 
    If it is Unicode, it is encoded into a utf-8 string.
893
 
    """
894
 
    if isinstance(unicode_or_utf8_string, str):
895
 
        # TODO: jam 20070209 This is overkill, and probably has an impact on
896
 
        #       performance if we are dealing with lots of apis that want a
897
 
        #       utf-8 revision id
898
 
        try:
899
 
            # Make sure it is a valid utf-8 string
900
 
            unicode_or_utf8_string.decode('utf-8')
901
 
        except UnicodeDecodeError:
902
 
            raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
903
 
        return unicode_or_utf8_string
904
 
    return unicode_or_utf8_string.encode('utf-8')
905
 
 
906
 
 
907
 
def safe_revision_id(unicode_or_utf8_string):
908
 
    """Revision ids should now be utf8, but at one point they were unicode.
909
 
 
910
 
    This is the same as safe_utf8, except it uses the cached encode functions
911
 
    to save a little bit of performance.
912
 
    """
913
 
    if unicode_or_utf8_string is None:
914
 
        return None
915
 
    if isinstance(unicode_or_utf8_string, str):
916
 
        # TODO: jam 20070209 Eventually just remove this check.
917
 
        try:
918
 
            utf8_str = cache_utf8.get_cached_utf8(unicode_or_utf8_string)
919
 
        except UnicodeDecodeError:
920
 
            raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
921
 
        return utf8_str
922
 
    return cache_utf8.encode(unicode_or_utf8_string)
923
 
 
924
 
 
925
 
# TODO: jam 20070217 We start by just re-using safe_revision_id, but ultimately
926
 
#       we want to use a different dictionary cache, because trapping file ids
927
 
#       and revision ids in the same dict seemed to have a noticable effect on
928
 
#       performance.
929
 
safe_file_id = safe_revision_id
 
800
        raise BzrBadParameterNotUnicode(unicode_or_utf8_string)
930
801
 
931
802
 
932
803
_platform_normalizes_filenames = False
976
847
def terminal_width():
977
848
    """Return estimated terminal width."""
978
849
    if sys.platform == 'win32':
979
 
        return win32utils.get_console_size()[0]
 
850
        import bzrlib.win32console
 
851
        return bzrlib.win32console.get_console_size()[0]
980
852
    width = 0
981
853
    try:
982
854
        import struct, fcntl, termios
1000
872
    return sys.platform != "win32"
1001
873
 
1002
874
 
1003
 
def supports_posix_readonly():
1004
 
    """Return True if 'readonly' has POSIX semantics, False otherwise.
1005
 
 
1006
 
    Notably, a win32 readonly file cannot be deleted, unlike POSIX where the
1007
 
    directory controls creation/deletion, etc.
1008
 
 
1009
 
    And under win32, readonly means that the directory itself cannot be
1010
 
    deleted.  The contents of a readonly directory can be changed, unlike POSIX
1011
 
    where files in readonly directories cannot be added, deleted or renamed.
1012
 
    """
1013
 
    return sys.platform != "win32"
1014
 
 
1015
 
 
1016
875
def set_or_unset_env(env_variable, value):
1017
876
    """Modify the environment, setting or removing the env_variable.
1018
877
 
1043
902
    if sys.platform != "win32":
1044
903
        return
1045
904
    if _validWin32PathRE.match(path) is None:
1046
 
        raise errors.IllegalPath(path)
 
905
        raise IllegalPath(path)
1047
906
 
1048
907
 
1049
908
def walkdirs(top, prefix=""):
1055
914
    
1056
915
    The data yielded is of the form:
1057
916
    ((directory-relpath, directory-path-from-top),
1058
 
    [(directory-relpath, basename, kind, lstat, path-from-top), ...]),
 
917
    [(relpath, basename, kind, lstat), ...]),
1059
918
     - directory-relpath is the relative path of the directory being returned
1060
919
       with respect to top. prefix is prepended to this.
1061
920
     - directory-path-from-root is the path including top for this directory. 
1079
938
    # depending on top and prefix - i.e. ./foo and foo as a pair leads to
1080
939
    # potentially confusing output. We should make this more robust - but
1081
940
    # not at a speed cost. RBC 20060731
1082
 
    _lstat = os.lstat
 
941
    lstat = os.lstat
 
942
    pending = []
1083
943
    _directory = _directory_kind
1084
 
    _listdir = os.listdir
1085
 
    _kind_from_mode = _formats.get
1086
 
    pending = [(safe_unicode(prefix), "", _directory, None, safe_unicode(top))]
 
944
    _listdir = listdir
 
945
    pending = [(prefix, "", _directory, None, top)]
1087
946
    while pending:
 
947
        dirblock = []
 
948
        currentdir = pending.pop()
1088
949
        # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1089
 
        relroot, _, _, _, top = pending.pop()
1090
 
        if relroot:
1091
 
            relprefix = relroot + u'/'
1092
 
        else:
1093
 
            relprefix = ''
1094
 
        top_slash = top + u'/'
1095
 
 
1096
 
        dirblock = []
1097
 
        append = dirblock.append
1098
 
        for name in sorted(_listdir(top)):
1099
 
            abspath = top_slash + name
1100
 
            statvalue = _lstat(abspath)
1101
 
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
1102
 
            append((relprefix + name, name, kind, statvalue, abspath))
1103
 
        yield (relroot, top), dirblock
1104
 
 
1105
 
        # push the user specified dirs from dirblock
1106
 
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1107
 
 
1108
 
 
1109
 
def _walkdirs_utf8(top, prefix=""):
1110
 
    """Yield data about all the directories in a tree.
1111
 
 
1112
 
    This yields the same information as walkdirs() only each entry is yielded
1113
 
    in utf-8. On platforms which have a filesystem encoding of utf8 the paths
1114
 
    are returned as exact byte-strings.
1115
 
 
1116
 
    :return: yields a tuple of (dir_info, [file_info])
1117
 
        dir_info is (utf8_relpath, path-from-top)
1118
 
        file_info is (utf8_relpath, utf8_name, kind, lstat, path-from-top)
1119
 
        if top is an absolute path, path-from-top is also an absolute path.
1120
 
        path-from-top might be unicode or utf8, but it is the correct path to
1121
 
        pass to os functions to affect the file in question. (such as os.lstat)
1122
 
    """
1123
 
    fs_encoding = sys.getfilesystemencoding()
1124
 
    if (sys.platform == 'win32' or
1125
 
        fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968')): # ascii
1126
 
        return _walkdirs_unicode_to_utf8(top, prefix=prefix)
1127
 
    else:
1128
 
        return _walkdirs_fs_utf8(top, prefix=prefix)
1129
 
 
1130
 
 
1131
 
def _walkdirs_fs_utf8(top, prefix=""):
1132
 
    """See _walkdirs_utf8.
1133
 
 
1134
 
    This sub-function is called when we know the filesystem is already in utf8
1135
 
    encoding. So we don't need to transcode filenames.
1136
 
    """
1137
 
    _lstat = os.lstat
1138
 
    _directory = _directory_kind
1139
 
    _listdir = os.listdir
1140
 
    _kind_from_mode = _formats.get
1141
 
 
1142
 
    # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1143
 
    # But we don't actually uses 1-3 in pending, so set them to None
1144
 
    pending = [(safe_utf8(prefix), None, None, None, safe_utf8(top))]
1145
 
    while pending:
1146
 
        relroot, _, _, _, top = pending.pop()
1147
 
        if relroot:
1148
 
            relprefix = relroot + '/'
1149
 
        else:
1150
 
            relprefix = ''
1151
 
        top_slash = top + '/'
1152
 
 
1153
 
        dirblock = []
1154
 
        append = dirblock.append
1155
 
        for name in sorted(_listdir(top)):
1156
 
            abspath = top_slash + name
1157
 
            statvalue = _lstat(abspath)
1158
 
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
1159
 
            append((relprefix + name, name, kind, statvalue, abspath))
1160
 
        yield (relroot, top), dirblock
1161
 
 
1162
 
        # push the user specified dirs from dirblock
1163
 
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1164
 
 
1165
 
 
1166
 
def _walkdirs_unicode_to_utf8(top, prefix=""):
1167
 
    """See _walkdirs_utf8
1168
 
 
1169
 
    Because Win32 has a Unicode api, all of the 'path-from-top' entries will be
1170
 
    Unicode paths.
1171
 
    This is currently the fallback code path when the filesystem encoding is
1172
 
    not UTF-8. It may be better to implement an alternative so that we can
1173
 
    safely handle paths that are not properly decodable in the current
1174
 
    encoding.
1175
 
    """
1176
 
    _utf8_encode = codecs.getencoder('utf8')
1177
 
    _lstat = os.lstat
1178
 
    _directory = _directory_kind
1179
 
    _listdir = os.listdir
1180
 
    _kind_from_mode = _formats.get
1181
 
 
1182
 
    pending = [(safe_utf8(prefix), None, None, None, safe_unicode(top))]
1183
 
    while pending:
1184
 
        relroot, _, _, _, top = pending.pop()
1185
 
        if relroot:
1186
 
            relprefix = relroot + '/'
1187
 
        else:
1188
 
            relprefix = ''
1189
 
        top_slash = top + u'/'
1190
 
 
1191
 
        dirblock = []
1192
 
        append = dirblock.append
1193
 
        for name in sorted(_listdir(top)):
1194
 
            name_utf8 = _utf8_encode(name)[0]
1195
 
            abspath = top_slash + name
1196
 
            statvalue = _lstat(abspath)
1197
 
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
1198
 
            append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
1199
 
        yield (relroot, top), dirblock
1200
 
 
1201
 
        # push the user specified dirs from dirblock
1202
 
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
 
950
        top = currentdir[4]
 
951
        if currentdir[0]:
 
952
            relroot = currentdir[0] + '/'
 
953
        else:
 
954
            relroot = ""
 
955
        for name in sorted(_listdir(top)):
 
956
            abspath = top + '/' + name
 
957
            statvalue = lstat(abspath)
 
958
            dirblock.append((relroot + name, name,
 
959
                file_kind_from_stat_mode(statvalue.st_mode),
 
960
                statvalue, abspath))
 
961
        yield (currentdir[0], top), dirblock
 
962
        # push the user specified dirs from dirblock
 
963
        for dir in reversed(dirblock):
 
964
            if dir[2] == _directory:
 
965
                pending.append(dir)
1203
966
 
1204
967
 
1205
968
def copy_tree(from_path, to_path, handlers={}):
1262
1025
_cached_user_encoding = None
1263
1026
 
1264
1027
 
1265
 
def get_user_encoding(use_cache=True):
 
1028
def get_user_encoding():
1266
1029
    """Find out what the preferred user encoding is.
1267
1030
 
1268
1031
    This is generally the encoding that is used for command line parameters
1269
1032
    and file contents. This may be different from the terminal encoding
1270
1033
    or the filesystem encoding.
1271
1034
 
1272
 
    :param  use_cache:  Enable cache for detected encoding.
1273
 
                        (This parameter is turned on by default,
1274
 
                        and required only for selftesting)
1275
 
 
1276
1035
    :return: A string defining the preferred user encoding
1277
1036
    """
1278
1037
    global _cached_user_encoding
1279
 
    if _cached_user_encoding is not None and use_cache:
 
1038
    if _cached_user_encoding is not None:
1280
1039
        return _cached_user_encoding
1281
1040
 
1282
1041
    if sys.platform == 'darwin':
1290
1049
        import locale
1291
1050
 
1292
1051
    try:
1293
 
        user_encoding = locale.getpreferredencoding()
 
1052
        _cached_user_encoding = locale.getpreferredencoding()
1294
1053
    except locale.Error, e:
1295
1054
        sys.stderr.write('bzr: warning: %s\n'
1296
1055
                         '  Could not determine what text encoding to use.\n'
1298
1057
                         '  doesn\'t support the locale set by $LANG (%s)\n'
1299
1058
                         "  Continuing with ascii encoding.\n"
1300
1059
                         % (e, os.environ.get('LANG')))
1301
 
        user_encoding = 'ascii'
1302
 
 
1303
 
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
1304
 
    # treat that as ASCII, and not support printing unicode characters to the
1305
 
    # console.
1306
 
    if user_encoding in (None, 'cp0'):
1307
 
        user_encoding = 'ascii'
1308
 
    else:
1309
 
        # check encoding
1310
 
        try:
1311
 
            codecs.lookup(user_encoding)
1312
 
        except LookupError:
1313
 
            sys.stderr.write('bzr: warning:'
1314
 
                             ' unknown encoding %s.'
1315
 
                             ' Continuing with ascii encoding.\n'
1316
 
                             % user_encoding
1317
 
                            )
1318
 
            user_encoding = 'ascii'
1319
 
 
1320
 
    if use_cache:
1321
 
        _cached_user_encoding = user_encoding
1322
 
 
1323
 
    return user_encoding
1324
 
 
1325
 
 
1326
 
def recv_all(socket, bytes):
1327
 
    """Receive an exact number of bytes.
1328
 
 
1329
 
    Regular Socket.recv() may return less than the requested number of bytes,
1330
 
    dependning on what's in the OS buffer.  MSG_WAITALL is not available
1331
 
    on all platforms, but this should work everywhere.  This will return
1332
 
    less than the requested amount if the remote end closes.
1333
 
 
1334
 
    This isn't optimized and is intended mostly for use in testing.
1335
 
    """
1336
 
    b = ''
1337
 
    while len(b) < bytes:
1338
 
        new = socket.recv(bytes - len(b))
1339
 
        if new == '':
1340
 
            break # eof
1341
 
        b += new
1342
 
    return b
1343
 
 
1344
 
def dereference_path(path):
1345
 
    """Determine the real path to a file.
1346
 
 
1347
 
    All parent elements are dereferenced.  But the file itself is not
1348
 
    dereferenced.
1349
 
    :param path: The original path.  May be absolute or relative.
1350
 
    :return: the real path *to* the file
1351
 
    """
1352
 
    parent, base = os.path.split(path)
1353
 
    # The pathjoin for '.' is a workaround for Python bug #1213894.
1354
 
    # (initial path components aren't dereferenced)
1355
 
    return pathjoin(realpath(pathjoin('.', parent)), base)
 
1060
 
 
1061
    if _cached_user_encoding is None:
 
1062
        _cached_user_encoding = 'ascii'
 
1063
    return _cached_user_encoding