← 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-10-10 07:23:07 UTC
  • mfrom: (2067.1.1 urandom-56883)
  • Revision ID: pqm@pqm.ubuntu.com-20061010072307-037a6f63da8a1bdd
(John Arbash Meinel) Handle exceptions while opening /dev/urandom

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
 
69
60
# OR with 0 on those platforms
70
61
O_BINARY = getattr(os, 'O_BINARY', 0)
71
62
 
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)
75
63
 
76
64
def make_readonly(filename):
77
65
    """Make a filename read-only."""
78
 
    mod = lstat(filename).st_mode
79
 
    if not stat.S_ISLNK(mod):
80
 
        mod = mod & 0777555
81
 
        os.chmod(filename, mod)
 
66
    mod = os.stat(filename).st_mode
 
67
    mod = mod & 0777555
 
68
    os.chmod(filename, mod)
82
69
 
83
70
 
84
71
def make_writable(filename):
85
 
    mod = lstat(filename).st_mode
86
 
    if not stat.S_ISLNK(mod):
87
 
        mod = mod | 0200
88
 
        os.chmod(filename, mod)
 
72
    mod = os.stat(filename).st_mode
 
73
    mod = mod | 0200
 
74
    os.chmod(filename, mod)
89
75
 
90
76
 
91
77
_QUOTE_RE = None
136
122
        return _mapper(_lstat(f).st_mode)
137
123
    except OSError, e:
138
124
        if getattr(e, 'errno', None) == errno.ENOENT:
139
 
            raise errors.NoSuchFile(f)
 
125
            raise bzrlib.errors.NoSuchFile(f)
140
126
        raise
141
127
 
142
128
 
150
136
    return umask
151
137
 
152
138
 
153
 
_kind_marker_map = {
154
 
    "file": "",
155
 
    _directory_kind: "/",
156
 
    "symlink": "@",
157
 
    'tree-reference': '+',
158
 
}
159
 
 
160
 
 
161
139
def kind_marker(kind):
162
 
    try:
163
 
        return _kind_marker_map[kind]
164
 
    except KeyError:
165
 
        raise errors.BzrError('invalid file kind %r' % kind)
166
 
 
 
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)
167
148
 
168
149
lexists = getattr(os.path, 'lexists', None)
169
150
if lexists is None:
170
151
    def lexists(f):
171
152
        try:
172
 
            stat = getattr(os, 'lstat', os.stat)
173
 
            stat(f)
 
153
            if getattr(os, 'lstat') is not None:
 
154
                os.lstat(f)
 
155
            else:
 
156
                os.stat(f)
174
157
            return True
175
 
        except OSError, e:
 
158
        except OSError,e:
176
159
            if e.errno == errno.ENOENT:
177
160
                return False;
178
161
            else:
179
 
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
 
162
                raise BzrError("lstat/stat of (%r): %r" % (f, e))
180
163
 
181
164
 
182
165
def fancy_rename(old, new, rename_func, unlink_func):
203
186
    file_existed = False
204
187
    try:
205
188
        rename_func(new, tmp_name)
206
 
    except (errors.NoSuchFile,), e:
 
189
    except (NoSuchFile,), e:
207
190
        pass
208
191
    except IOError, e:
209
192
        # RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
238
221
# choke on a Unicode string containing a relative path if
239
222
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
240
223
# string.
241
 
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
 
224
_fs_enc = sys.getfilesystemencoding()
242
225
def _posix_abspath(path):
243
226
    # jam 20060426 rather than encoding to fsencoding
244
227
    # copy posixpath.abspath, but use os.getcwdu instead
269
252
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
270
253
 
271
254
 
272
 
def _win98_abspath(path):
273
 
    """Return the absolute version of a path.
274
 
    Windows 98 safe implementation (python reimplementation
275
 
    of Win32 API function GetFullPathNameW)
276
 
    """
277
 
    # Corner cases:
278
 
    #   C:\path     => C:/path
279
 
    #   C:/path     => C:/path
280
 
    #   \\HOST\path => //HOST/path
281
 
    #   //HOST/path => //HOST/path
282
 
    #   path        => C:/cwd/path
283
 
    #   /path       => C:/path
284
 
    path = unicode(path)
285
 
    # check for absolute path
286
 
    drive = _nt_splitdrive(path)[0]
287
 
    if drive == '' and path[:2] not in('//','\\\\'):
288
 
        cwd = os.getcwdu()
289
 
        # we cannot simply os.path.join cwd and path
290
 
        # because os.path.join('C:','/path') produce '/path'
291
 
        # and this is incorrect
292
 
        if path[:1] in ('/','\\'):
293
 
            cwd = _nt_splitdrive(cwd)[0]
294
 
            path = path[1:]
295
 
        path = cwd + '\\' + path
296
 
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
297
 
 
298
 
if win32utils.winver == 'Windows 98':
299
 
    _win32_abspath = _win98_abspath
300
 
 
301
 
 
302
255
def _win32_realpath(path):
303
256
    # Real _nt_realpath doesn't have a problem with a unicode cwd
304
257
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
349
302
pathjoin = os.path.join
350
303
normpath = os.path.normpath
351
304
getcwd = os.getcwdu
 
305
mkdtemp = tempfile.mkdtemp
352
306
rename = os.rename
353
307
dirname = os.path.dirname
354
308
basename = os.path.basename
355
 
split = os.path.split
356
 
splitext = os.path.splitext
357
 
# These were already imported into local scope
358
 
# mkdtemp = tempfile.mkdtemp
359
 
# rmtree = shutil.rmtree
 
309
rmtree = shutil.rmtree
360
310
 
361
311
MIN_ABS_PATHLENGTH = 1
362
312
 
376
326
        """Error handler for shutil.rmtree function [for win32]
377
327
        Helps to remove files and dirs marked as read-only.
378
328
        """
379
 
        exception = excinfo[1]
 
329
        type_, value = excinfo[:2]
380
330
        if function in (os.remove, os.rmdir) \
381
 
            and isinstance(exception, OSError) \
382
 
            and exception.errno == errno.EACCES:
383
 
            make_writable(path)
 
331
            and type_ == OSError \
 
332
            and value.errno == errno.EACCES:
 
333
            bzrlib.osutils.make_writable(path)
384
334
            function(path)
385
335
        else:
386
336
            raise
416
366
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
417
367
    else:
418
368
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
419
 
    if output_encoding == 'cp0':
420
 
        # invalid encoding (cp0 means 'no codepage' on Windows)
421
 
        output_encoding = bzrlib.user_encoding
422
 
        mutter('cp0 is invalid encoding.'
423
 
               ' encoding stdout as bzrlib.user_encoding %r', output_encoding)
424
 
    # check encoding
425
 
    try:
426
 
        codecs.lookup(output_encoding)
427
 
    except LookupError:
428
 
        sys.stderr.write('bzr: warning:'
429
 
                         ' unknown terminal encoding %s.\n'
430
 
                         '  Using encoding %s instead.\n'
431
 
                         % (output_encoding, bzrlib.user_encoding)
432
 
                        )
433
 
        output_encoding = bzrlib.user_encoding
434
 
 
435
369
    return output_encoding
436
370
 
437
371
 
506
440
    
507
441
    The empty string as a dir name is taken as top-of-tree and matches 
508
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
509
456
    """
510
457
    # XXX: Most callers of this can actually do something smarter by 
511
458
    # looking at the inventory
526
473
    for dirname in dir_list:
527
474
        if is_inside(dirname, fname):
528
475
            return True
529
 
    return False
 
476
    else:
 
477
        return False
530
478
 
531
479
 
532
480
def is_inside_or_parent_of_any(dir_list, fname):
534
482
    for dirname in dir_list:
535
483
        if is_inside(dirname, fname) or is_inside(fname, dirname):
536
484
            return True
537
 
    return False
 
485
    else:
 
486
        return False
538
487
 
539
488
 
540
489
def pumpfile(fromfile, tofile):
605
554
 
606
555
def local_time_offset(t=None):
607
556
    """Return offset of local zone from GMT, either at present or at time t."""
 
557
    # python2.3 localtime() can't take None
608
558
    if t is None:
609
559
        t = time.time()
610
 
    offset = datetime.fromtimestamp(t) - datetime.utcfromtimestamp(t)
611
 
    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
612
565
 
613
566
    
614
 
def format_date(t, offset=0, timezone='original', date_fmt=None,
 
567
def format_date(t, offset=0, timezone='original', date_fmt=None, 
615
568
                show_offset=True):
616
 
    """Return a formatted date string.
617
 
 
618
 
    :param t: Seconds since the epoch.
619
 
    :param offset: Timezone offset in seconds east of utc.
620
 
    :param timezone: How to display the time: 'utc', 'original' for the
621
 
         timezone specified by offset, or 'local' for the process's current
622
 
         timezone.
623
 
    :param show_offset: Whether to append the timezone.
624
 
    :param date_fmt: strftime format.
625
 
    """
 
569
    ## TODO: Perhaps a global option to use either universal or local time?
 
570
    ## Or perhaps just let people set $TZ?
 
571
    assert isinstance(t, float)
 
572
    
626
573
    if timezone == 'utc':
627
574
        tt = time.gmtime(t)
628
575
        offset = 0
634
581
        tt = time.localtime(t)
635
582
        offset = local_time_offset(t)
636
583
    else:
637
 
        raise errors.BzrError("unsupported timezone format %r" % timezone,
638
 
                              ['options are "utc", "original", "local"'])
 
584
        raise BzrError("unsupported timezone format %r" % timezone,
 
585
                       ['options are "utc", "original", "local"'])
639
586
    if date_fmt is None:
640
587
        date_fmt = "%a %Y-%m-%d %H:%M:%S"
641
588
    if show_offset:
743
690
## decomposition (might be too tricksy though.)
744
691
 
745
692
def splitpath(p):
746
 
    """Turn string into list of parts."""
747
 
    assert isinstance(p, basestring)
 
693
    """Turn string into list of parts.
 
694
 
 
695
    >>> splitpath('a')
 
696
    ['a']
 
697
    >>> splitpath('a/b')
 
698
    ['a', 'b']
 
699
    >>> splitpath('a/./b')
 
700
    ['a', 'b']
 
701
    >>> splitpath('a/.b')
 
702
    ['a', '.b']
 
703
    >>> splitpath('a/../b')
 
704
    Traceback (most recent call last):
 
705
    ...
 
706
    BzrError: sorry, '..' not allowed in path
 
707
    """
 
708
    assert isinstance(p, types.StringTypes)
748
709
 
749
710
    # split on either delimiter because people might use either on
750
711
    # Windows
753
714
    rps = []
754
715
    for f in ps:
755
716
        if f == '..':
756
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
717
            raise BzrError("sorry, %r not allowed in path" % f)
757
718
        elif (f == '.') or (f == ''):
758
719
            pass
759
720
        else:
761
722
    return rps
762
723
 
763
724
def joinpath(p):
764
 
    assert isinstance(p, (list, tuple))
 
725
    assert isinstance(p, list)
765
726
    for f in p:
766
727
        if (f == '..') or (f is None) or (f == ''):
767
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
728
            raise BzrError("sorry, %r not allowed in path" % f)
768
729
    return pathjoin(*p)
769
730
 
770
731
 
792
753
def link_or_copy(src, dest):
793
754
    """Hardlink a file, or copy it if it can't be hardlinked."""
794
755
    if not hardlinks_good():
795
 
        shutil.copyfile(src, dest)
 
756
        copyfile(src, dest)
796
757
        return
797
758
    try:
798
759
        os.link(src, dest)
799
760
    except (OSError, IOError), e:
800
761
        if e.errno != errno.EXDEV:
801
762
            raise
802
 
        shutil.copyfile(src, dest)
 
763
        copyfile(src, dest)
803
764
 
804
765
def delete_any(full_path):
805
766
    """Delete a file or directory."""
821
782
 
822
783
def contains_whitespace(s):
823
784
    """True if there are any whitespace characters in s."""
824
 
    # string.whitespace can include '\xa0' in certain locales, because it is
825
 
    # considered "non-breaking-space" as part of ISO-8859-1. But it
826
 
    # 1) Isn't a breaking whitespace
827
 
    # 2) Isn't one of ' \t\r\n' which are characters we sometimes use as
828
 
    #    separators
829
 
    # 3) '\xa0' isn't unicode safe since it is >128.
830
 
 
831
 
    # This should *not* be a unicode set of characters in case the source
832
 
    # string is not a Unicode string. We can auto-up-cast the characters since
833
 
    # they are ascii, but we don't want to auto-up-cast the string in case it
834
 
    # is utf-8
835
 
    for ch in ' \t\n\r\v\f':
 
785
    for ch in string.whitespace:
836
786
        if ch in s:
837
787
            return True
838
788
    else:
874
824
        if tail:
875
825
            s.insert(0, tail)
876
826
    else:
877
 
        raise errors.PathNotChild(rp, base)
 
827
        raise PathNotChild(rp, base)
878
828
 
879
829
    if s:
880
830
        return pathjoin(*s)
895
845
    try:
896
846
        return unicode_or_utf8_string.decode('utf8')
897
847
    except UnicodeDecodeError:
898
 
        raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
899
 
 
900
 
 
901
 
def safe_utf8(unicode_or_utf8_string):
902
 
    """Coerce unicode_or_utf8_string to a utf8 string.
903
 
 
904
 
    If it is a str, it is returned.
905
 
    If it is Unicode, it is encoded into a utf-8 string.
906
 
    """
907
 
    if isinstance(unicode_or_utf8_string, str):
908
 
        # TODO: jam 20070209 This is overkill, and probably has an impact on
909
 
        #       performance if we are dealing with lots of apis that want a
910
 
        #       utf-8 revision id
911
 
        try:
912
 
            # Make sure it is a valid utf-8 string
913
 
            unicode_or_utf8_string.decode('utf-8')
914
 
        except UnicodeDecodeError:
915
 
            raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
916
 
        return unicode_or_utf8_string
917
 
    return unicode_or_utf8_string.encode('utf-8')
918
 
 
919
 
 
920
 
_revision_id_warning = ('Unicode revision ids were deprecated in bzr 0.15.'
921
 
                        ' Revision id generators should be creating utf8'
922
 
                        ' revision ids.')
923
 
 
924
 
 
925
 
def safe_revision_id(unicode_or_utf8_string, warn=True):
926
 
    """Revision ids should now be utf8, but at one point they were unicode.
927
 
 
928
 
    :param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
929
 
        utf8 or None).
930
 
    :param warn: Functions that are sanitizing user data can set warn=False
931
 
    :return: None or a utf8 revision id.
932
 
    """
933
 
    if (unicode_or_utf8_string is None
934
 
        or unicode_or_utf8_string.__class__ == str):
935
 
        return unicode_or_utf8_string
936
 
    if warn:
937
 
        symbol_versioning.warn(_revision_id_warning, DeprecationWarning,
938
 
                               stacklevel=2)
939
 
    return cache_utf8.encode(unicode_or_utf8_string)
940
 
 
941
 
 
942
 
_file_id_warning = ('Unicode file ids were deprecated in bzr 0.15. File id'
943
 
                    ' generators should be creating utf8 file ids.')
944
 
 
945
 
 
946
 
def safe_file_id(unicode_or_utf8_string, warn=True):
947
 
    """File ids should now be utf8, but at one point they were unicode.
948
 
 
949
 
    This is the same as safe_utf8, except it uses the cached encode functions
950
 
    to save a little bit of performance.
951
 
 
952
 
    :param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
953
 
        utf8 or None).
954
 
    :param warn: Functions that are sanitizing user data can set warn=False
955
 
    :return: None or a utf8 file id.
956
 
    """
957
 
    if (unicode_or_utf8_string is None
958
 
        or unicode_or_utf8_string.__class__ == str):
959
 
        return unicode_or_utf8_string
960
 
    if warn:
961
 
        symbol_versioning.warn(_file_id_warning, DeprecationWarning,
962
 
                               stacklevel=2)
963
 
    return cache_utf8.encode(unicode_or_utf8_string)
 
848
        raise BzrBadParameterNotUnicode(unicode_or_utf8_string)
964
849
 
965
850
 
966
851
_platform_normalizes_filenames = False
1010
895
def terminal_width():
1011
896
    """Return estimated terminal width."""
1012
897
    if sys.platform == 'win32':
1013
 
        return win32utils.get_console_size()[0]
 
898
        import bzrlib.win32console
 
899
        return bzrlib.win32console.get_console_size()[0]
1014
900
    width = 0
1015
901
    try:
1016
902
        import struct, fcntl, termios
1034
920
    return sys.platform != "win32"
1035
921
 
1036
922
 
1037
 
def supports_posix_readonly():
1038
 
    """Return True if 'readonly' has POSIX semantics, False otherwise.
1039
 
 
1040
 
    Notably, a win32 readonly file cannot be deleted, unlike POSIX where the
1041
 
    directory controls creation/deletion, etc.
1042
 
 
1043
 
    And under win32, readonly means that the directory itself cannot be
1044
 
    deleted.  The contents of a readonly directory can be changed, unlike POSIX
1045
 
    where files in readonly directories cannot be added, deleted or renamed.
1046
 
    """
1047
 
    return sys.platform != "win32"
1048
 
 
1049
 
 
1050
923
def set_or_unset_env(env_variable, value):
1051
924
    """Modify the environment, setting or removing the env_variable.
1052
925
 
1077
950
    if sys.platform != "win32":
1078
951
        return
1079
952
    if _validWin32PathRE.match(path) is None:
1080
 
        raise errors.IllegalPath(path)
 
953
        raise IllegalPath(path)
1081
954
 
1082
955
 
1083
956
def walkdirs(top, prefix=""):
1089
962
    
1090
963
    The data yielded is of the form:
1091
964
    ((directory-relpath, directory-path-from-top),
1092
 
    [(directory-relpath, basename, kind, lstat, path-from-top), ...]),
 
965
    [(relpath, basename, kind, lstat), ...]),
1093
966
     - directory-relpath is the relative path of the directory being returned
1094
967
       with respect to top. prefix is prepended to this.
1095
968
     - directory-path-from-root is the path including top for this directory. 
1113
986
    # depending on top and prefix - i.e. ./foo and foo as a pair leads to
1114
987
    # potentially confusing output. We should make this more robust - but
1115
988
    # not at a speed cost. RBC 20060731
1116
 
    _lstat = os.lstat
 
989
    lstat = os.lstat
 
990
    pending = []
1117
991
    _directory = _directory_kind
1118
 
    _listdir = os.listdir
1119
 
    _kind_from_mode = _formats.get
1120
 
    pending = [(safe_unicode(prefix), "", _directory, None, safe_unicode(top))]
 
992
    _listdir = listdir
 
993
    pending = [(prefix, "", _directory, None, top)]
1121
994
    while pending:
 
995
        dirblock = []
 
996
        currentdir = pending.pop()
1122
997
        # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1123
 
        relroot, _, _, _, top = pending.pop()
1124
 
        if relroot:
1125
 
            relprefix = relroot + u'/'
1126
 
        else:
1127
 
            relprefix = ''
1128
 
        top_slash = top + u'/'
1129
 
 
1130
 
        dirblock = []
1131
 
        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))
1137
 
        yield (relroot, top), dirblock
1138
 
 
1139
 
        # push the user specified dirs from dirblock
1140
 
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1141
 
 
1142
 
 
1143
 
def _walkdirs_utf8(top, prefix=""):
1144
 
    """Yield data about all the directories in a tree.
1145
 
 
1146
 
    This yields the same information as walkdirs() only each entry is yielded
1147
 
    in utf-8. On platforms which have a filesystem encoding of utf8 the paths
1148
 
    are returned as exact byte-strings.
1149
 
 
1150
 
    :return: yields a tuple of (dir_info, [file_info])
1151
 
        dir_info is (utf8_relpath, path-from-top)
1152
 
        file_info is (utf8_relpath, utf8_name, kind, lstat, path-from-top)
1153
 
        if top is an absolute path, path-from-top is also an absolute path.
1154
 
        path-from-top might be unicode or utf8, but it is the correct path to
1155
 
        pass to os functions to affect the file in question. (such as os.lstat)
1156
 
    """
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
1175
 
 
1176
 
    # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1177
 
    # 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))]
1179
 
    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))
1194
 
        yield (relroot, top), dirblock
1195
 
 
1196
 
        # 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 + '/'
1221
 
        else:
1222
 
            relprefix = ''
1223
 
        top_slash = top + u'/'
1224
 
 
1225
 
        dirblock = []
1226
 
        append = dirblock.append
1227
 
        for name in sorted(_listdir(top)):
1228
 
            name_utf8 = _utf8_encode(name)[0]
1229
 
            abspath = top_slash + name
1230
 
            statvalue = _lstat(abspath)
1231
 
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
1232
 
            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)
 
998
        top = currentdir[4]
 
999
        if currentdir[0]:
 
1000
            relroot = currentdir[0] + '/'
 
1001
        else:
 
1002
            relroot = ""
 
1003
        for name in sorted(_listdir(top)):
 
1004
            abspath = top + '/' + name
 
1005
            statvalue = lstat(abspath)
 
1006
            dirblock.append((relroot + name, name,
 
1007
                file_kind_from_stat_mode(statvalue.st_mode),
 
1008
                statvalue, abspath))
 
1009
        yield (currentdir[0], top), dirblock
 
1010
        # push the user specified dirs from dirblock
 
1011
        for dir in reversed(dirblock):
 
1012
            if dir[2] == _directory:
 
1013
                pending.append(dir)
1237
1014
 
1238
1015
 
1239
1016
def copy_tree(from_path, to_path, handlers={}):
1296
1073
_cached_user_encoding = None
1297
1074
 
1298
1075
 
1299
 
def get_user_encoding(use_cache=True):
 
1076
def get_user_encoding():
1300
1077
    """Find out what the preferred user encoding is.
1301
1078
 
1302
1079
    This is generally the encoding that is used for command line parameters
1303
1080
    and file contents. This may be different from the terminal encoding
1304
1081
    or the filesystem encoding.
1305
1082
 
1306
 
    :param  use_cache:  Enable cache for detected encoding.
1307
 
                        (This parameter is turned on by default,
1308
 
                        and required only for selftesting)
1309
 
 
1310
1083
    :return: A string defining the preferred user encoding
1311
1084
    """
1312
1085
    global _cached_user_encoding
1313
 
    if _cached_user_encoding is not None and use_cache:
 
1086
    if _cached_user_encoding is not None:
1314
1087
        return _cached_user_encoding
1315
1088
 
1316
1089
    if sys.platform == 'darwin':
1324
1097
        import locale
1325
1098
 
1326
1099
    try:
1327
 
        user_encoding = locale.getpreferredencoding()
 
1100
        _cached_user_encoding = locale.getpreferredencoding()
1328
1101
    except locale.Error, e:
1329
1102
        sys.stderr.write('bzr: warning: %s\n'
1330
1103
                         '  Could not determine what text encoding to use.\n'
1332
1105
                         '  doesn\'t support the locale set by $LANG (%s)\n'
1333
1106
                         "  Continuing with ascii encoding.\n"
1334
1107
                         % (e, os.environ.get('LANG')))
1335
 
        user_encoding = 'ascii'
1336
 
 
1337
 
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
1338
 
    # treat that as ASCII, and not support printing unicode characters to the
1339
 
    # console.
1340
 
    if user_encoding in (None, 'cp0'):
1341
 
        user_encoding = 'ascii'
1342
 
    else:
1343
 
        # check encoding
1344
 
        try:
1345
 
            codecs.lookup(user_encoding)
1346
 
        except LookupError:
1347
 
            sys.stderr.write('bzr: warning:'
1348
 
                             ' unknown encoding %s.'
1349
 
                             ' Continuing with ascii encoding.\n'
1350
 
                             % user_encoding
1351
 
                            )
1352
 
            user_encoding = 'ascii'
1353
 
 
1354
 
    if use_cache:
1355
 
        _cached_user_encoding = user_encoding
1356
 
 
1357
 
    return user_encoding
1358
 
 
1359
 
 
1360
 
def recv_all(socket, bytes):
1361
 
    """Receive an exact number of bytes.
1362
 
 
1363
 
    Regular Socket.recv() may return less than the requested number of bytes,
1364
 
    dependning on what's in the OS buffer.  MSG_WAITALL is not available
1365
 
    on all platforms, but this should work everywhere.  This will return
1366
 
    less than the requested amount if the remote end closes.
1367
 
 
1368
 
    This isn't optimized and is intended mostly for use in testing.
1369
 
    """
1370
 
    b = ''
1371
 
    while len(b) < bytes:
1372
 
        new = socket.recv(bytes - len(b))
1373
 
        if new == '':
1374
 
            break # eof
1375
 
        b += new
1376
 
    return b
1377
 
 
1378
 
def dereference_path(path):
1379
 
    """Determine the real path to a file.
1380
 
 
1381
 
    All parent elements are dereferenced.  But the file itself is not
1382
 
    dereferenced.
1383
 
    :param path: The original path.  May be absolute or relative.
1384
 
    :return: the real path *to* the file
1385
 
    """
1386
 
    parent, base = os.path.split(path)
1387
 
    # The pathjoin for '.' is a workaround for Python bug #1213894.
1388
 
    # (initial path components aren't dereferenced)
1389
 
    return pathjoin(realpath(pathjoin('.', parent)), base)
 
1108
 
 
1109
    if _cached_user_encoding is None:
 
1110
        _cached_user_encoding = 'ascii'
 
1111
    return _cached_user_encoding