/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: Alexander Belchenko
  • Date: 2007-06-05 08:02:04 UTC
  • mto: This revision was merged to the branch mainline in revision 2512.
  • Revision ID: bialix@ukr.net-20070605080204-hvhqw69njlpxcscb
sanitize developers docs

Show diffs side-by-side

added added

removed removed

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