/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: John Arbash Meinel
  • Date: 2006-09-13 02:09:37 UTC
  • mto: This revision was merged to the branch mainline in revision 2004.
  • Revision ID: john@arbash-meinel.com-20060913020937-2df2f49f9a28ec43
Update HACKING and docstrings

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 import symbol_versioning
58
 
from bzrlib.symbol_versioning import (
59
 
    deprecated_function,
60
 
    zero_nine,
61
 
    )
 
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)
62
53
from bzrlib.trace import mutter
63
54
 
64
55
 
131
122
        return _mapper(_lstat(f).st_mode)
132
123
    except OSError, e:
133
124
        if getattr(e, 'errno', None) == errno.ENOENT:
134
 
            raise errors.NoSuchFile(f)
 
125
            raise bzrlib.errors.NoSuchFile(f)
135
126
        raise
136
127
 
137
128
 
145
136
    return umask
146
137
 
147
138
 
148
 
_kind_marker_map = {
149
 
    "file": "",
150
 
    _directory_kind: "/",
151
 
    "symlink": "@",
152
 
    'tree-reference': '+',
153
 
}
154
 
 
155
 
 
156
139
def kind_marker(kind):
157
 
    try:
158
 
        return _kind_marker_map[kind]
159
 
    except KeyError:
160
 
        raise errors.BzrError('invalid file kind %r' % kind)
161
 
 
 
140
    if kind == 'file':
 
141
        return ''
 
142
    elif kind == _directory_kind:
 
143
        return '/'
 
144
    elif kind == 'symlink':
 
145
        return '@'
 
146
    else:
 
147
        raise BzrError('invalid file kind %r' % kind)
162
148
 
163
149
lexists = getattr(os.path, 'lexists', None)
164
150
if lexists is None:
165
151
    def lexists(f):
166
152
        try:
167
 
            stat = getattr(os, 'lstat', os.stat)
168
 
            stat(f)
 
153
            if getattr(os, 'lstat') is not None:
 
154
                os.lstat(f)
 
155
            else:
 
156
                os.stat(f)
169
157
            return True
170
 
        except OSError, e:
 
158
        except OSError,e:
171
159
            if e.errno == errno.ENOENT:
172
160
                return False;
173
161
            else:
174
 
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
 
162
                raise BzrError("lstat/stat of (%r): %r" % (f, e))
175
163
 
176
164
 
177
165
def fancy_rename(old, new, rename_func, unlink_func):
198
186
    file_existed = False
199
187
    try:
200
188
        rename_func(new, tmp_name)
201
 
    except (errors.NoSuchFile,), e:
 
189
    except (NoSuchFile,), e:
202
190
        pass
203
191
    except IOError, e:
204
192
        # RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
233
221
# choke on a Unicode string containing a relative path if
234
222
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
235
223
# string.
236
 
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
 
224
_fs_enc = sys.getfilesystemencoding()
237
225
def _posix_abspath(path):
238
226
    # jam 20060426 rather than encoding to fsencoding
239
227
    # copy posixpath.abspath, but use os.getcwdu instead
264
252
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
265
253
 
266
254
 
267
 
def _win98_abspath(path):
268
 
    """Return the absolute version of a path.
269
 
    Windows 98 safe implementation (python reimplementation
270
 
    of Win32 API function GetFullPathNameW)
271
 
    """
272
 
    # Corner cases:
273
 
    #   C:\path     => C:/path
274
 
    #   C:/path     => C:/path
275
 
    #   \\HOST\path => //HOST/path
276
 
    #   //HOST/path => //HOST/path
277
 
    #   path        => C:/cwd/path
278
 
    #   /path       => C:/path
279
 
    path = unicode(path)
280
 
    # check for absolute path
281
 
    drive = _nt_splitdrive(path)[0]
282
 
    if drive == '' and path[:2] not in('//','\\\\'):
283
 
        cwd = os.getcwdu()
284
 
        # we cannot simply os.path.join cwd and path
285
 
        # because os.path.join('C:','/path') produce '/path'
286
 
        # and this is incorrect
287
 
        if path[:1] in ('/','\\'):
288
 
            cwd = _nt_splitdrive(cwd)[0]
289
 
            path = path[1:]
290
 
        path = cwd + '\\' + path
291
 
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
292
 
 
293
 
if win32utils.winver == 'Windows 98':
294
 
    _win32_abspath = _win98_abspath
295
 
 
296
 
 
297
255
def _win32_realpath(path):
298
256
    # Real _nt_realpath doesn't have a problem with a unicode cwd
299
257
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
344
302
pathjoin = os.path.join
345
303
normpath = os.path.normpath
346
304
getcwd = os.getcwdu
 
305
mkdtemp = tempfile.mkdtemp
347
306
rename = os.rename
348
307
dirname = os.path.dirname
349
308
basename = os.path.basename
350
 
split = os.path.split
351
 
splitext = os.path.splitext
352
 
# These were already imported into local scope
353
 
# mkdtemp = tempfile.mkdtemp
354
 
# rmtree = shutil.rmtree
 
309
rmtree = shutil.rmtree
355
310
 
356
311
MIN_ABS_PATHLENGTH = 1
357
312
 
371
326
        """Error handler for shutil.rmtree function [for win32]
372
327
        Helps to remove files and dirs marked as read-only.
373
328
        """
374
 
        exception = excinfo[1]
 
329
        type_, value = excinfo[:2]
375
330
        if function in (os.remove, os.rmdir) \
376
 
            and isinstance(exception, OSError) \
377
 
            and exception.errno == errno.EACCES:
378
 
            make_writable(path)
 
331
            and type_ == OSError \
 
332
            and value.errno == errno.EACCES:
 
333
            bzrlib.osutils.make_writable(path)
379
334
            function(path)
380
335
        else:
381
336
            raise
411
366
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
412
367
    else:
413
368
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
414
 
    if output_encoding == 'cp0':
415
 
        # invalid encoding (cp0 means 'no codepage' on Windows)
416
 
        output_encoding = bzrlib.user_encoding
417
 
        mutter('cp0 is invalid encoding.'
418
 
               ' encoding stdout as bzrlib.user_encoding %r', output_encoding)
419
 
    # check encoding
420
 
    try:
421
 
        codecs.lookup(output_encoding)
422
 
    except LookupError:
423
 
        sys.stderr.write('bzr: warning:'
424
 
                         ' unknown terminal encoding %s.\n'
425
 
                         '  Using encoding %s instead.\n'
426
 
                         % (output_encoding, bzrlib.user_encoding)
427
 
                        )
428
 
        output_encoding = bzrlib.user_encoding
429
 
 
430
369
    return output_encoding
431
370
 
432
371
 
501
440
    
502
441
    The empty string as a dir name is taken as top-of-tree and matches 
503
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
504
456
    """
505
457
    # XXX: Most callers of this can actually do something smarter by 
506
458
    # looking at the inventory
521
473
    for dirname in dir_list:
522
474
        if is_inside(dirname, fname):
523
475
            return True
524
 
    return False
 
476
    else:
 
477
        return False
525
478
 
526
479
 
527
480
def is_inside_or_parent_of_any(dir_list, fname):
529
482
    for dirname in dir_list:
530
483
        if is_inside(dirname, fname) or is_inside(fname, dirname):
531
484
            return True
532
 
    return False
 
485
    else:
 
486
        return False
533
487
 
534
488
 
535
489
def pumpfile(fromfile, tofile):
600
554
 
601
555
def local_time_offset(t=None):
602
556
    """Return offset of local zone from GMT, either at present or at time t."""
 
557
    # python2.3 localtime() can't take None
603
558
    if t is None:
604
559
        t = time.time()
605
 
    offset = datetime.fromtimestamp(t) - datetime.utcfromtimestamp(t)
606
 
    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
607
565
 
608
566
    
609
567
def format_date(t, offset=0, timezone='original', date_fmt=None, 
623
581
        tt = time.localtime(t)
624
582
        offset = local_time_offset(t)
625
583
    else:
626
 
        raise errors.BzrError("unsupported timezone format %r" % timezone,
627
 
                              ['options are "utc", "original", "local"'])
 
584
        raise BzrError("unsupported timezone format %r" % timezone,
 
585
                       ['options are "utc", "original", "local"'])
628
586
    if date_fmt is None:
629
587
        date_fmt = "%a %Y-%m-%d %H:%M:%S"
630
588
    if show_offset:
638
596
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
639
597
    
640
598
 
641
 
def format_delta(delta):
642
 
    """Get a nice looking string for a time delta.
643
 
 
644
 
    :param delta: The time difference in seconds, can be positive or negative.
645
 
        positive indicates time in the past, negative indicates time in the
646
 
        future. (usually time.time() - stored_time)
647
 
    :return: String formatted to show approximate resolution
648
 
    """
649
 
    delta = int(delta)
650
 
    if delta >= 0:
651
 
        direction = 'ago'
652
 
    else:
653
 
        direction = 'in the future'
654
 
        delta = -delta
655
 
 
656
 
    seconds = delta
657
 
    if seconds < 90: # print seconds up to 90 seconds
658
 
        if seconds == 1:
659
 
            return '%d second %s' % (seconds, direction,)
660
 
        else:
661
 
            return '%d seconds %s' % (seconds, direction)
662
 
 
663
 
    minutes = int(seconds / 60)
664
 
    seconds -= 60 * minutes
665
 
    if seconds == 1:
666
 
        plural_seconds = ''
667
 
    else:
668
 
        plural_seconds = 's'
669
 
    if minutes < 90: # print minutes, seconds up to 90 minutes
670
 
        if minutes == 1:
671
 
            return '%d minute, %d second%s %s' % (
672
 
                    minutes, seconds, plural_seconds, direction)
673
 
        else:
674
 
            return '%d minutes, %d second%s %s' % (
675
 
                    minutes, seconds, plural_seconds, direction)
676
 
 
677
 
    hours = int(minutes / 60)
678
 
    minutes -= 60 * hours
679
 
    if minutes == 1:
680
 
        plural_minutes = ''
681
 
    else:
682
 
        plural_minutes = 's'
683
 
 
684
 
    if hours == 1:
685
 
        return '%d hour, %d minute%s %s' % (hours, minutes,
686
 
                                            plural_minutes, direction)
687
 
    return '%d hours, %d minute%s %s' % (hours, minutes,
688
 
                                         plural_minutes, direction)
689
599
 
690
600
def filesize(f):
691
601
    """Return size of given open file."""
701
611
except (NotImplementedError, AttributeError):
702
612
    # If python doesn't have os.urandom, or it doesn't work,
703
613
    # then try to first pull random data from /dev/urandom
704
 
    try:
 
614
    if os.path.exists("/dev/urandom"):
705
615
        rand_bytes = file('/dev/urandom', 'rb').read
706
616
    # Otherwise, use this hack as a last resort
707
 
    except (IOError, OSError):
 
617
    else:
708
618
        # not well seeded, but better than nothing
709
619
        def rand_bytes(n):
710
620
            import random
732
642
## decomposition (might be too tricksy though.)
733
643
 
734
644
def splitpath(p):
735
 
    """Turn string into list of parts."""
736
 
    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)
737
661
 
738
662
    # split on either delimiter because people might use either on
739
663
    # Windows
742
666
    rps = []
743
667
    for f in ps:
744
668
        if f == '..':
745
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
669
            raise BzrError("sorry, %r not allowed in path" % f)
746
670
        elif (f == '.') or (f == ''):
747
671
            pass
748
672
        else:
750
674
    return rps
751
675
 
752
676
def joinpath(p):
753
 
    assert isinstance(p, (list, tuple))
 
677
    assert isinstance(p, list)
754
678
    for f in p:
755
679
        if (f == '..') or (f is None) or (f == ''):
756
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
680
            raise BzrError("sorry, %r not allowed in path" % f)
757
681
    return pathjoin(*p)
758
682
 
759
683
 
781
705
def link_or_copy(src, dest):
782
706
    """Hardlink a file, or copy it if it can't be hardlinked."""
783
707
    if not hardlinks_good():
784
 
        shutil.copyfile(src, dest)
 
708
        copyfile(src, dest)
785
709
        return
786
710
    try:
787
711
        os.link(src, dest)
788
712
    except (OSError, IOError), e:
789
713
        if e.errno != errno.EXDEV:
790
714
            raise
791
 
        shutil.copyfile(src, dest)
 
715
        copyfile(src, dest)
792
716
 
793
717
def delete_any(full_path):
794
718
    """Delete a file or directory."""
810
734
 
811
735
def contains_whitespace(s):
812
736
    """True if there are any whitespace characters in s."""
813
 
    # string.whitespace can include '\xa0' in certain locales, because it is
814
 
    # considered "non-breaking-space" as part of ISO-8859-1. But it
815
 
    # 1) Isn't a breaking whitespace
816
 
    # 2) Isn't one of ' \t\r\n' which are characters we sometimes use as
817
 
    #    separators
818
 
    # 3) '\xa0' isn't unicode safe since it is >128.
819
 
 
820
 
    # This should *not* be a unicode set of characters in case the source
821
 
    # string is not a Unicode string. We can auto-up-cast the characters since
822
 
    # they are ascii, but we don't want to auto-up-cast the string in case it
823
 
    # is utf-8
824
 
    for ch in ' \t\n\r\v\f':
 
737
    for ch in string.whitespace:
825
738
        if ch in s:
826
739
            return True
827
740
    else:
863
776
        if tail:
864
777
            s.insert(0, tail)
865
778
    else:
866
 
        raise errors.PathNotChild(rp, base)
 
779
        raise PathNotChild(rp, base)
867
780
 
868
781
    if s:
869
782
        return pathjoin(*s)
884
797
    try:
885
798
        return unicode_or_utf8_string.decode('utf8')
886
799
    except UnicodeDecodeError:
887
 
        raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
888
 
 
889
 
 
890
 
def safe_utf8(unicode_or_utf8_string):
891
 
    """Coerce unicode_or_utf8_string to a utf8 string.
892
 
 
893
 
    If it is a str, it is returned.
894
 
    If it is Unicode, it is encoded into a utf-8 string.
895
 
    """
896
 
    if isinstance(unicode_or_utf8_string, str):
897
 
        # TODO: jam 20070209 This is overkill, and probably has an impact on
898
 
        #       performance if we are dealing with lots of apis that want a
899
 
        #       utf-8 revision id
900
 
        try:
901
 
            # Make sure it is a valid utf-8 string
902
 
            unicode_or_utf8_string.decode('utf-8')
903
 
        except UnicodeDecodeError:
904
 
            raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
905
 
        return unicode_or_utf8_string
906
 
    return unicode_or_utf8_string.encode('utf-8')
907
 
 
908
 
 
909
 
_revision_id_warning = ('Unicode revision ids were deprecated in bzr 0.15.'
910
 
                        ' Revision id generators should be creating utf8'
911
 
                        ' revision ids.')
912
 
 
913
 
 
914
 
def safe_revision_id(unicode_or_utf8_string, warn=True):
915
 
    """Revision ids should now be utf8, but at one point they were unicode.
916
 
 
917
 
    :param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
918
 
        utf8 or None).
919
 
    :param warn: Functions that are sanitizing user data can set warn=False
920
 
    :return: None or a utf8 revision id.
921
 
    """
922
 
    if (unicode_or_utf8_string is None
923
 
        or unicode_or_utf8_string.__class__ == str):
924
 
        return unicode_or_utf8_string
925
 
    if warn:
926
 
        symbol_versioning.warn(_revision_id_warning, DeprecationWarning,
927
 
                               stacklevel=2)
928
 
    return cache_utf8.encode(unicode_or_utf8_string)
929
 
 
930
 
 
931
 
_file_id_warning = ('Unicode file ids were deprecated in bzr 0.15. File id'
932
 
                    ' generators should be creating utf8 file ids.')
933
 
 
934
 
 
935
 
def safe_file_id(unicode_or_utf8_string, warn=True):
936
 
    """File ids should now be utf8, but at one point they were unicode.
937
 
 
938
 
    This is the same as safe_utf8, except it uses the cached encode functions
939
 
    to save a little bit of performance.
940
 
 
941
 
    :param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
942
 
        utf8 or None).
943
 
    :param warn: Functions that are sanitizing user data can set warn=False
944
 
    :return: None or a utf8 file id.
945
 
    """
946
 
    if (unicode_or_utf8_string is None
947
 
        or unicode_or_utf8_string.__class__ == str):
948
 
        return unicode_or_utf8_string
949
 
    if warn:
950
 
        symbol_versioning.warn(_file_id_warning, DeprecationWarning,
951
 
                               stacklevel=2)
952
 
    return cache_utf8.encode(unicode_or_utf8_string)
 
800
        raise BzrBadParameterNotUnicode(unicode_or_utf8_string)
953
801
 
954
802
 
955
803
_platform_normalizes_filenames = False
999
847
def terminal_width():
1000
848
    """Return estimated terminal width."""
1001
849
    if sys.platform == 'win32':
1002
 
        return win32utils.get_console_size()[0]
 
850
        import bzrlib.win32console
 
851
        return bzrlib.win32console.get_console_size()[0]
1003
852
    width = 0
1004
853
    try:
1005
854
        import struct, fcntl, termios
1023
872
    return sys.platform != "win32"
1024
873
 
1025
874
 
1026
 
def supports_posix_readonly():
1027
 
    """Return True if 'readonly' has POSIX semantics, False otherwise.
1028
 
 
1029
 
    Notably, a win32 readonly file cannot be deleted, unlike POSIX where the
1030
 
    directory controls creation/deletion, etc.
1031
 
 
1032
 
    And under win32, readonly means that the directory itself cannot be
1033
 
    deleted.  The contents of a readonly directory can be changed, unlike POSIX
1034
 
    where files in readonly directories cannot be added, deleted or renamed.
1035
 
    """
1036
 
    return sys.platform != "win32"
1037
 
 
1038
 
 
1039
875
def set_or_unset_env(env_variable, value):
1040
876
    """Modify the environment, setting or removing the env_variable.
1041
877
 
1066
902
    if sys.platform != "win32":
1067
903
        return
1068
904
    if _validWin32PathRE.match(path) is None:
1069
 
        raise errors.IllegalPath(path)
 
905
        raise IllegalPath(path)
1070
906
 
1071
907
 
1072
908
def walkdirs(top, prefix=""):
1078
914
    
1079
915
    The data yielded is of the form:
1080
916
    ((directory-relpath, directory-path-from-top),
1081
 
    [(directory-relpath, basename, kind, lstat, path-from-top), ...]),
 
917
    [(relpath, basename, kind, lstat), ...]),
1082
918
     - directory-relpath is the relative path of the directory being returned
1083
919
       with respect to top. prefix is prepended to this.
1084
920
     - directory-path-from-root is the path including top for this directory. 
1102
938
    # depending on top and prefix - i.e. ./foo and foo as a pair leads to
1103
939
    # potentially confusing output. We should make this more robust - but
1104
940
    # not at a speed cost. RBC 20060731
1105
 
    _lstat = os.lstat
 
941
    lstat = os.lstat
 
942
    pending = []
1106
943
    _directory = _directory_kind
1107
 
    _listdir = os.listdir
1108
 
    _kind_from_mode = _formats.get
1109
 
    pending = [(safe_unicode(prefix), "", _directory, None, safe_unicode(top))]
 
944
    _listdir = listdir
 
945
    pending = [(prefix, "", _directory, None, top)]
1110
946
    while pending:
 
947
        dirblock = []
 
948
        currentdir = pending.pop()
1111
949
        # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1112
 
        relroot, _, _, _, top = pending.pop()
1113
 
        if relroot:
1114
 
            relprefix = relroot + u'/'
1115
 
        else:
1116
 
            relprefix = ''
1117
 
        top_slash = top + u'/'
1118
 
 
1119
 
        dirblock = []
1120
 
        append = dirblock.append
1121
 
        for name in sorted(_listdir(top)):
1122
 
            abspath = top_slash + name
1123
 
            statvalue = _lstat(abspath)
1124
 
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
1125
 
            append((relprefix + name, name, kind, statvalue, abspath))
1126
 
        yield (relroot, top), dirblock
1127
 
 
1128
 
        # push the user specified dirs from dirblock
1129
 
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1130
 
 
1131
 
 
1132
 
def _walkdirs_utf8(top, prefix=""):
1133
 
    """Yield data about all the directories in a tree.
1134
 
 
1135
 
    This yields the same information as walkdirs() only each entry is yielded
1136
 
    in utf-8. On platforms which have a filesystem encoding of utf8 the paths
1137
 
    are returned as exact byte-strings.
1138
 
 
1139
 
    :return: yields a tuple of (dir_info, [file_info])
1140
 
        dir_info is (utf8_relpath, path-from-top)
1141
 
        file_info is (utf8_relpath, utf8_name, kind, lstat, path-from-top)
1142
 
        if top is an absolute path, path-from-top is also an absolute path.
1143
 
        path-from-top might be unicode or utf8, but it is the correct path to
1144
 
        pass to os functions to affect the file in question. (such as os.lstat)
1145
 
    """
1146
 
    fs_encoding = sys.getfilesystemencoding()
1147
 
    if (sys.platform == 'win32' or
1148
 
        fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968')): # ascii
1149
 
        return _walkdirs_unicode_to_utf8(top, prefix=prefix)
1150
 
    else:
1151
 
        return _walkdirs_fs_utf8(top, prefix=prefix)
1152
 
 
1153
 
 
1154
 
def _walkdirs_fs_utf8(top, prefix=""):
1155
 
    """See _walkdirs_utf8.
1156
 
 
1157
 
    This sub-function is called when we know the filesystem is already in utf8
1158
 
    encoding. So we don't need to transcode filenames.
1159
 
    """
1160
 
    _lstat = os.lstat
1161
 
    _directory = _directory_kind
1162
 
    _listdir = os.listdir
1163
 
    _kind_from_mode = _formats.get
1164
 
 
1165
 
    # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1166
 
    # But we don't actually uses 1-3 in pending, so set them to None
1167
 
    pending = [(safe_utf8(prefix), None, None, None, safe_utf8(top))]
1168
 
    while pending:
1169
 
        relroot, _, _, _, top = pending.pop()
1170
 
        if relroot:
1171
 
            relprefix = relroot + '/'
1172
 
        else:
1173
 
            relprefix = ''
1174
 
        top_slash = top + '/'
1175
 
 
1176
 
        dirblock = []
1177
 
        append = dirblock.append
1178
 
        for name in sorted(_listdir(top)):
1179
 
            abspath = top_slash + name
1180
 
            statvalue = _lstat(abspath)
1181
 
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
1182
 
            append((relprefix + name, name, kind, statvalue, abspath))
1183
 
        yield (relroot, top), dirblock
1184
 
 
1185
 
        # push the user specified dirs from dirblock
1186
 
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1187
 
 
1188
 
 
1189
 
def _walkdirs_unicode_to_utf8(top, prefix=""):
1190
 
    """See _walkdirs_utf8
1191
 
 
1192
 
    Because Win32 has a Unicode api, all of the 'path-from-top' entries will be
1193
 
    Unicode paths.
1194
 
    This is currently the fallback code path when the filesystem encoding is
1195
 
    not UTF-8. It may be better to implement an alternative so that we can
1196
 
    safely handle paths that are not properly decodable in the current
1197
 
    encoding.
1198
 
    """
1199
 
    _utf8_encode = codecs.getencoder('utf8')
1200
 
    _lstat = os.lstat
1201
 
    _directory = _directory_kind
1202
 
    _listdir = os.listdir
1203
 
    _kind_from_mode = _formats.get
1204
 
 
1205
 
    pending = [(safe_utf8(prefix), None, None, None, safe_unicode(top))]
1206
 
    while pending:
1207
 
        relroot, _, _, _, top = pending.pop()
1208
 
        if relroot:
1209
 
            relprefix = relroot + '/'
1210
 
        else:
1211
 
            relprefix = ''
1212
 
        top_slash = top + u'/'
1213
 
 
1214
 
        dirblock = []
1215
 
        append = dirblock.append
1216
 
        for name in sorted(_listdir(top)):
1217
 
            name_utf8 = _utf8_encode(name)[0]
1218
 
            abspath = top_slash + name
1219
 
            statvalue = _lstat(abspath)
1220
 
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
1221
 
            append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
1222
 
        yield (relroot, top), dirblock
1223
 
 
1224
 
        # push the user specified dirs from dirblock
1225
 
        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)
1226
966
 
1227
967
 
1228
968
def copy_tree(from_path, to_path, handlers={}):
1285
1025
_cached_user_encoding = None
1286
1026
 
1287
1027
 
1288
 
def get_user_encoding(use_cache=True):
 
1028
def get_user_encoding():
1289
1029
    """Find out what the preferred user encoding is.
1290
1030
 
1291
1031
    This is generally the encoding that is used for command line parameters
1292
1032
    and file contents. This may be different from the terminal encoding
1293
1033
    or the filesystem encoding.
1294
1034
 
1295
 
    :param  use_cache:  Enable cache for detected encoding.
1296
 
                        (This parameter is turned on by default,
1297
 
                        and required only for selftesting)
1298
 
 
1299
1035
    :return: A string defining the preferred user encoding
1300
1036
    """
1301
1037
    global _cached_user_encoding
1302
 
    if _cached_user_encoding is not None and use_cache:
 
1038
    if _cached_user_encoding is not None:
1303
1039
        return _cached_user_encoding
1304
1040
 
1305
1041
    if sys.platform == 'darwin':
1313
1049
        import locale
1314
1050
 
1315
1051
    try:
1316
 
        user_encoding = locale.getpreferredencoding()
 
1052
        _cached_user_encoding = locale.getpreferredencoding()
1317
1053
    except locale.Error, e:
1318
1054
        sys.stderr.write('bzr: warning: %s\n'
1319
1055
                         '  Could not determine what text encoding to use.\n'
1321
1057
                         '  doesn\'t support the locale set by $LANG (%s)\n'
1322
1058
                         "  Continuing with ascii encoding.\n"
1323
1059
                         % (e, os.environ.get('LANG')))
1324
 
        user_encoding = 'ascii'
1325
 
 
1326
 
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
1327
 
    # treat that as ASCII, and not support printing unicode characters to the
1328
 
    # console.
1329
 
    if user_encoding in (None, 'cp0'):
1330
 
        user_encoding = 'ascii'
1331
 
    else:
1332
 
        # check encoding
1333
 
        try:
1334
 
            codecs.lookup(user_encoding)
1335
 
        except LookupError:
1336
 
            sys.stderr.write('bzr: warning:'
1337
 
                             ' unknown encoding %s.'
1338
 
                             ' Continuing with ascii encoding.\n'
1339
 
                             % user_encoding
1340
 
                            )
1341
 
            user_encoding = 'ascii'
1342
 
 
1343
 
    if use_cache:
1344
 
        _cached_user_encoding = user_encoding
1345
 
 
1346
 
    return user_encoding
1347
 
 
1348
 
 
1349
 
def recv_all(socket, bytes):
1350
 
    """Receive an exact number of bytes.
1351
 
 
1352
 
    Regular Socket.recv() may return less than the requested number of bytes,
1353
 
    dependning on what's in the OS buffer.  MSG_WAITALL is not available
1354
 
    on all platforms, but this should work everywhere.  This will return
1355
 
    less than the requested amount if the remote end closes.
1356
 
 
1357
 
    This isn't optimized and is intended mostly for use in testing.
1358
 
    """
1359
 
    b = ''
1360
 
    while len(b) < bytes:
1361
 
        new = socket.recv(bytes - len(b))
1362
 
        if new == '':
1363
 
            break # eof
1364
 
        b += new
1365
 
    return b
1366
 
 
1367
 
def dereference_path(path):
1368
 
    """Determine the real path to a file.
1369
 
 
1370
 
    All parent elements are dereferenced.  But the file itself is not
1371
 
    dereferenced.
1372
 
    :param path: The original path.  May be absolute or relative.
1373
 
    :return: the real path *to* the file
1374
 
    """
1375
 
    parent, base = os.path.split(path)
1376
 
    # The pathjoin for '.' is a workaround for Python bug #1213894.
1377
 
    # (initial path components aren't dereferenced)
1378
 
    return pathjoin(realpath(pathjoin('.', parent)), base)
 
1060
 
 
1061
    if _cached_user_encoding is None:
 
1062
        _cached_user_encoding = 'ascii'
 
1063
    return _cached_user_encoding