← 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-07-06 03:15:29 UTC
  • mfrom: (1711.2.78 jam-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20060706031529-e189d8c3f42076be
(jam) allow plugins to include benchmarks

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-NG -- 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
 
65
 
# On win32, O_BINARY is used to indicate the file should
66
 
# be opened in binary mode, rather than text mode.
67
 
# On other platforms, O_BINARY doesn't exist, because
68
 
# they always open in binary mode, so it is okay to
69
 
# OR with 0 on those platforms
70
 
O_BINARY = getattr(os, 'O_BINARY', 0)
71
 
 
72
 
# On posix, use lstat instead of stat so that we can
73
 
# operate on broken symlinks. On Windows revert to stat.
74
 
lstat = getattr(os, 'lstat', os.stat)
75
 
 
76
56
def make_readonly(filename):
77
57
    """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)
 
58
    mod = os.stat(filename).st_mode
 
59
    mod = mod & 0777555
 
60
    os.chmod(filename, mod)
82
61
 
83
62
 
84
63
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)
 
64
    mod = os.stat(filename).st_mode
 
65
    mod = mod | 0200
 
66
    os.chmod(filename, mod)
89
67
 
90
68
 
91
69
_QUOTE_RE = None
98
76
    Windows."""
99
77
    # TODO: I'm not really sure this is the best format either.x
100
78
    global _QUOTE_RE
101
 
    if _QUOTE_RE is None:
 
79
    if _QUOTE_RE == None:
102
80
        _QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
103
81
        
104
82
    if _QUOTE_RE.search(f):
136
114
        return _mapper(_lstat(f).st_mode)
137
115
    except OSError, e:
138
116
        if getattr(e, 'errno', None) == errno.ENOENT:
139
 
            raise errors.NoSuchFile(f)
 
117
            raise bzrlib.errors.NoSuchFile(f)
140
118
        raise
141
119
 
142
120
 
143
 
def get_umask():
144
 
    """Return the current umask"""
145
 
    # Assume that people aren't messing with the umask while running
146
 
    # XXX: This is not thread safe, but there is no way to get the
147
 
    #      umask without setting it
148
 
    umask = os.umask(0)
149
 
    os.umask(umask)
150
 
    return umask
151
 
 
152
 
 
153
 
_kind_marker_map = {
154
 
    "file": "",
155
 
    _directory_kind: "/",
156
 
    "symlink": "@",
157
 
    'tree-reference': '+',
158
 
}
159
 
 
160
 
 
161
121
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
 
 
 
122
    if kind == 'file':
 
123
        return ''
 
124
    elif kind == _directory_kind:
 
125
        return '/'
 
126
    elif kind == 'symlink':
 
127
        return '@'
 
128
    else:
 
129
        raise BzrError('invalid file kind %r' % kind)
167
130
 
168
131
lexists = getattr(os.path, 'lexists', None)
169
132
if lexists is None:
170
133
    def lexists(f):
171
134
        try:
172
 
            stat = getattr(os, 'lstat', os.stat)
173
 
            stat(f)
 
135
            if hasattr(os, 'lstat'):
 
136
                os.lstat(f)
 
137
            else:
 
138
                os.stat(f)
174
139
            return True
175
 
        except OSError, e:
 
140
        except OSError,e:
176
141
            if e.errno == errno.ENOENT:
177
142
                return False;
178
143
            else:
179
 
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
 
144
                raise BzrError("lstat/stat of (%r): %r" % (f, e))
180
145
 
181
146
 
182
147
def fancy_rename(old, new, rename_func, unlink_func):
203
168
    file_existed = False
204
169
    try:
205
170
        rename_func(new, tmp_name)
206
 
    except (errors.NoSuchFile,), e:
 
171
    except (NoSuchFile,), e:
207
172
        pass
208
173
    except IOError, e:
209
174
        # RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
210
 
        # function raises an IOError with errno is None when a rename fails.
 
175
        # function raises an IOError with errno == None when a rename fails.
211
176
        # This then gets caught here.
212
177
        if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
213
178
            raise
214
179
    except Exception, e:
215
 
        if (getattr(e, 'errno', None) is None
 
180
        if (not hasattr(e, 'errno') 
216
181
            or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
217
182
            raise
218
183
    else:
238
203
# choke on a Unicode string containing a relative path if
239
204
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
240
205
# string.
241
 
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
 
206
_fs_enc = sys.getfilesystemencoding()
242
207
def _posix_abspath(path):
243
208
    # jam 20060426 rather than encoding to fsencoding
244
209
    # copy posixpath.abspath, but use os.getcwdu instead
269
234
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
270
235
 
271
236
 
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
237
def _win32_realpath(path):
303
238
    # Real _nt_realpath doesn't have a problem with a unicode cwd
304
239
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
329
264
    try:
330
265
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
331
266
    except OSError, e:
332
 
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
333
 
            # If we try to rename a non-existant file onto cwd, we get 
334
 
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT 
335
 
            # if the old path doesn't exist, sometimes we get EACCES
336
 
            # On Linux, we seem to get EBUSY, on Mac we get EINVAL
 
267
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY):
 
268
            # If we try to rename a non-existant file onto cwd, we get EPERM
 
269
            # instead of ENOENT, this will raise ENOENT if the old path
 
270
            # doesn't exist
337
271
            os.lstat(old)
338
272
        raise
339
273
 
340
274
 
341
 
def _mac_getcwd():
342
 
    return unicodedata.normalize('NFKC', os.getcwdu())
343
 
 
344
 
 
345
275
# Default is to just use the python builtins, but these can be rebound on
346
276
# particular platforms.
347
277
abspath = _posix_abspath
349
279
pathjoin = os.path.join
350
280
normpath = os.path.normpath
351
281
getcwd = os.getcwdu
 
282
mkdtemp = tempfile.mkdtemp
352
283
rename = os.rename
353
284
dirname = os.path.dirname
354
285
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
 
286
rmtree = shutil.rmtree
360
287
 
361
288
MIN_ABS_PATHLENGTH = 1
362
289
 
376
303
        """Error handler for shutil.rmtree function [for win32]
377
304
        Helps to remove files and dirs marked as read-only.
378
305
        """
379
 
        exception = excinfo[1]
 
306
        type_, value = excinfo[:2]
380
307
        if function in (os.remove, os.rmdir) \
381
 
            and isinstance(exception, OSError) \
382
 
            and exception.errno == errno.EACCES:
383
 
            make_writable(path)
 
308
            and type_ == OSError \
 
309
            and value.errno == errno.EACCES:
 
310
            bzrlib.osutils.make_writable(path)
384
311
            function(path)
385
312
        else:
386
313
            raise
388
315
    def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
389
316
        """Replacer for shutil.rmtree: could remove readonly dirs/files"""
390
317
        return shutil.rmtree(path, ignore_errors, onerror)
391
 
elif sys.platform == 'darwin':
392
 
    getcwd = _mac_getcwd
393
318
 
394
319
 
395
320
def get_terminal_encoding():
416
341
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
417
342
    else:
418
343
        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
344
    return output_encoding
436
345
 
437
346
 
438
347
def normalizepath(f):
439
 
    if getattr(os.path, 'realpath', None) is not None:
 
348
    if hasattr(os.path, 'realpath'):
440
349
        F = realpath
441
350
    else:
442
351
        F = abspath
506
415
    
507
416
    The empty string as a dir name is taken as top-of-tree and matches 
508
417
    everything.
 
418
    
 
419
    >>> is_inside('src', pathjoin('src', 'foo.c'))
 
420
    True
 
421
    >>> is_inside('src', 'srccontrol')
 
422
    False
 
423
    >>> is_inside('src', pathjoin('src', 'a', 'a', 'a', 'foo.c'))
 
424
    True
 
425
    >>> is_inside('foo.c', 'foo.c')
 
426
    True
 
427
    >>> is_inside('foo.c', '')
 
428
    False
 
429
    >>> is_inside('', 'foo.c')
 
430
    True
509
431
    """
510
432
    # XXX: Most callers of this can actually do something smarter by 
511
433
    # looking at the inventory
526
448
    for dirname in dir_list:
527
449
        if is_inside(dirname, fname):
528
450
            return True
529
 
    return False
 
451
    else:
 
452
        return False
530
453
 
531
454
 
532
455
def is_inside_or_parent_of_any(dir_list, fname):
534
457
    for dirname in dir_list:
535
458
        if is_inside(dirname, fname) or is_inside(fname, dirname):
536
459
            return True
537
 
    return False
 
460
    else:
 
461
        return False
538
462
 
539
463
 
540
464
def pumpfile(fromfile, tofile):
556
480
 
557
481
 
558
482
def sha_file(f):
559
 
    if getattr(f, 'tell', None) is not None:
 
483
    if hasattr(f, 'tell'):
560
484
        assert f.tell() == 0
561
485
    s = sha.new()
562
486
    BUFSIZE = 128<<10
605
529
 
606
530
def local_time_offset(t=None):
607
531
    """Return offset of local zone from GMT, either at present or at time t."""
608
 
    if t is None:
 
532
    # python2.3 localtime() can't take None
 
533
    if t == None:
609
534
        t = time.time()
610
 
    offset = datetime.fromtimestamp(t) - datetime.utcfromtimestamp(t)
611
 
    return offset.days * 86400 + offset.seconds
 
535
        
 
536
    if time.localtime(t).tm_isdst and time.daylight:
 
537
        return -time.altzone
 
538
    else:
 
539
        return -time.timezone
612
540
 
613
541
    
614
 
def format_date(t, offset=0, timezone='original', date_fmt=None,
 
542
def format_date(t, offset=0, timezone='original', date_fmt=None, 
615
543
                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
 
    """
 
544
    ## TODO: Perhaps a global option to use either universal or local time?
 
545
    ## Or perhaps just let people set $TZ?
 
546
    assert isinstance(t, float)
 
547
    
626
548
    if timezone == 'utc':
627
549
        tt = time.gmtime(t)
628
550
        offset = 0
629
551
    elif timezone == 'original':
630
 
        if offset is None:
 
552
        if offset == None:
631
553
            offset = 0
632
554
        tt = time.gmtime(t + offset)
633
555
    elif timezone == 'local':
634
556
        tt = time.localtime(t)
635
557
        offset = local_time_offset(t)
636
558
    else:
637
 
        raise errors.BzrError("unsupported timezone format %r" % timezone,
638
 
                              ['options are "utc", "original", "local"'])
 
559
        raise BzrError("unsupported timezone format %r" % timezone,
 
560
                       ['options are "utc", "original", "local"'])
639
561
    if date_fmt is None:
640
562
        date_fmt = "%a %Y-%m-%d %H:%M:%S"
641
563
    if show_offset:
649
571
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
650
572
    
651
573
 
652
 
def format_delta(delta):
653
 
    """Get a nice looking string for a time delta.
654
 
 
655
 
    :param delta: The time difference in seconds, can be positive or negative.
656
 
        positive indicates time in the past, negative indicates time in the
657
 
        future. (usually time.time() - stored_time)
658
 
    :return: String formatted to show approximate resolution
659
 
    """
660
 
    delta = int(delta)
661
 
    if delta >= 0:
662
 
        direction = 'ago'
663
 
    else:
664
 
        direction = 'in the future'
665
 
        delta = -delta
666
 
 
667
 
    seconds = delta
668
 
    if seconds < 90: # print seconds up to 90 seconds
669
 
        if seconds == 1:
670
 
            return '%d second %s' % (seconds, direction,)
671
 
        else:
672
 
            return '%d seconds %s' % (seconds, direction)
673
 
 
674
 
    minutes = int(seconds / 60)
675
 
    seconds -= 60 * minutes
676
 
    if seconds == 1:
677
 
        plural_seconds = ''
678
 
    else:
679
 
        plural_seconds = 's'
680
 
    if minutes < 90: # print minutes, seconds up to 90 minutes
681
 
        if minutes == 1:
682
 
            return '%d minute, %d second%s %s' % (
683
 
                    minutes, seconds, plural_seconds, direction)
684
 
        else:
685
 
            return '%d minutes, %d second%s %s' % (
686
 
                    minutes, seconds, plural_seconds, direction)
687
 
 
688
 
    hours = int(minutes / 60)
689
 
    minutes -= 60 * hours
690
 
    if minutes == 1:
691
 
        plural_minutes = ''
692
 
    else:
693
 
        plural_minutes = 's'
694
 
 
695
 
    if hours == 1:
696
 
        return '%d hour, %d minute%s %s' % (hours, minutes,
697
 
                                            plural_minutes, direction)
698
 
    return '%d hours, %d minute%s %s' % (hours, minutes,
699
 
                                         plural_minutes, direction)
700
574
 
701
575
def filesize(f):
702
576
    """Return size of given open file."""
712
586
except (NotImplementedError, AttributeError):
713
587
    # If python doesn't have os.urandom, or it doesn't work,
714
588
    # then try to first pull random data from /dev/urandom
715
 
    try:
 
589
    if os.path.exists("/dev/urandom"):
716
590
        rand_bytes = file('/dev/urandom', 'rb').read
717
591
    # Otherwise, use this hack as a last resort
718
 
    except (IOError, OSError):
 
592
    else:
719
593
        # not well seeded, but better than nothing
720
594
        def rand_bytes(n):
721
595
            import random
743
617
## decomposition (might be too tricksy though.)
744
618
 
745
619
def splitpath(p):
746
 
    """Turn string into list of parts."""
747
 
    assert isinstance(p, basestring)
 
620
    """Turn string into list of parts.
 
621
 
 
622
    >>> splitpath('a')
 
623
    ['a']
 
624
    >>> splitpath('a/b')
 
625
    ['a', 'b']
 
626
    >>> splitpath('a/./b')
 
627
    ['a', 'b']
 
628
    >>> splitpath('a/.b')
 
629
    ['a', '.b']
 
630
    >>> splitpath('a/../b')
 
631
    Traceback (most recent call last):
 
632
    ...
 
633
    BzrError: sorry, '..' not allowed in path
 
634
    """
 
635
    assert isinstance(p, types.StringTypes)
748
636
 
749
637
    # split on either delimiter because people might use either on
750
638
    # Windows
753
641
    rps = []
754
642
    for f in ps:
755
643
        if f == '..':
756
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
644
            raise BzrError("sorry, %r not allowed in path" % f)
757
645
        elif (f == '.') or (f == ''):
758
646
            pass
759
647
        else:
761
649
    return rps
762
650
 
763
651
def joinpath(p):
764
 
    assert isinstance(p, (list, tuple))
 
652
    assert isinstance(p, list)
765
653
    for f in p:
766
 
        if (f == '..') or (f is None) or (f == ''):
767
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
654
        if (f == '..') or (f == None) or (f == ''):
 
655
            raise BzrError("sorry, %r not allowed in path" % f)
768
656
    return pathjoin(*p)
769
657
 
770
658
 
792
680
def link_or_copy(src, dest):
793
681
    """Hardlink a file, or copy it if it can't be hardlinked."""
794
682
    if not hardlinks_good():
795
 
        shutil.copyfile(src, dest)
 
683
        copyfile(src, dest)
796
684
        return
797
685
    try:
798
686
        os.link(src, dest)
799
687
    except (OSError, IOError), e:
800
688
        if e.errno != errno.EXDEV:
801
689
            raise
802
 
        shutil.copyfile(src, dest)
 
690
        copyfile(src, dest)
803
691
 
804
692
def delete_any(full_path):
805
693
    """Delete a file or directory."""
813
701
 
814
702
 
815
703
def has_symlinks():
816
 
    if getattr(os, 'symlink', None) is not None:
 
704
    if hasattr(os, 'symlink'):
817
705
        return True
818
706
    else:
819
707
        return False
821
709
 
822
710
def contains_whitespace(s):
823
711
    """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':
 
712
    for ch in string.whitespace:
836
713
        if ch in s:
837
714
            return True
838
715
    else:
874
751
        if tail:
875
752
            s.insert(0, tail)
876
753
    else:
877
 
        raise errors.PathNotChild(rp, base)
 
754
        raise PathNotChild(rp, base)
878
755
 
879
756
    if s:
880
757
        return pathjoin(*s)
895
772
    try:
896
773
        return unicode_or_utf8_string.decode('utf8')
897
774
    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)
 
775
        raise BzrBadParameterNotUnicode(unicode_or_utf8_string)
964
776
 
965
777
 
966
778
_platform_normalizes_filenames = False
976
788
    return _platform_normalizes_filenames
977
789
 
978
790
 
979
 
def _accessible_normalized_filename(path):
980
 
    """Get the unicode normalized path, and if you can access the file.
981
 
 
982
 
    On platforms where the system normalizes filenames (Mac OSX),
983
 
    you can access a file by any path which will normalize correctly.
984
 
    On platforms where the system does not normalize filenames 
985
 
    (Windows, Linux), you have to access a file by its exact path.
986
 
 
987
 
    Internally, bzr only supports NFC/NFKC normalization, since that is 
988
 
    the standard for XML documents.
989
 
 
990
 
    So return the normalized path, and a flag indicating if the file
991
 
    can be accessed by that path.
992
 
    """
993
 
 
994
 
    return unicodedata.normalize('NFKC', unicode(path)), True
995
 
 
996
 
 
997
 
def _inaccessible_normalized_filename(path):
998
 
    __doc__ = _accessible_normalized_filename.__doc__
999
 
 
1000
 
    normalized = unicodedata.normalize('NFKC', unicode(path))
1001
 
    return normalized, normalized == path
1002
 
 
1003
 
 
1004
791
if _platform_normalizes_filenames:
1005
 
    normalized_filename = _accessible_normalized_filename
 
792
    def unicode_filename(path):
 
793
        """Make sure 'path' is a properly normalized filename.
 
794
 
 
795
        On platforms where the system normalizes filenames (Mac OSX),
 
796
        you can access a file by any path which will normalize
 
797
        correctly.
 
798
        Internally, bzr only supports NFC/NFKC normalization, since
 
799
        that is the standard for XML documents.
 
800
        So we return an normalized path, and indicate this has been
 
801
        properly normalized.
 
802
 
 
803
        :return: (path, is_normalized) Return a path which can
 
804
                access the file, and whether or not this path is
 
805
                normalized.
 
806
        """
 
807
        return unicodedata.normalize('NFKC', path), True
1006
808
else:
1007
 
    normalized_filename = _inaccessible_normalized_filename
 
809
    def unicode_filename(path):
 
810
        """Make sure 'path' is a properly normalized filename.
 
811
 
 
812
        On platforms where the system does not normalize filenames 
 
813
        (Windows, Linux), you have to access a file by its exact path.
 
814
        Internally, bzr only supports NFC/NFKC normalization, since
 
815
        that is the standard for XML documents.
 
816
        So we return the original path, and indicate if this is
 
817
        properly normalized.
 
818
 
 
819
        :return: (path, is_normalized) Return a path which can
 
820
                access the file, and whether or not this path is
 
821
                normalized.
 
822
        """
 
823
        return path, unicodedata.normalize('NFKC', path) == path
1008
824
 
1009
825
 
1010
826
def terminal_width():
1011
827
    """Return estimated terminal width."""
1012
828
    if sys.platform == 'win32':
1013
 
        return win32utils.get_console_size()[0]
 
829
        import bzrlib.win32console
 
830
        return bzrlib.win32console.get_console_size()[0]
1014
831
    width = 0
1015
832
    try:
1016
833
        import struct, fcntl, termios
1029
846
 
1030
847
    return width
1031
848
 
1032
 
 
1033
849
def supports_executable():
1034
850
    return sys.platform != "win32"
1035
851
 
1036
852
 
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
 
def set_or_unset_env(env_variable, value):
1051
 
    """Modify the environment, setting or removing the env_variable.
1052
 
 
1053
 
    :param env_variable: The environment variable in question
1054
 
    :param value: The value to set the environment to. If None, then
1055
 
        the variable will be removed.
1056
 
    :return: The original value of the environment variable.
1057
 
    """
1058
 
    orig_val = os.environ.get(env_variable)
1059
 
    if value is None:
1060
 
        if orig_val is not None:
1061
 
            del os.environ[env_variable]
1062
 
    else:
1063
 
        if isinstance(value, unicode):
1064
 
            value = value.encode(bzrlib.user_encoding)
1065
 
        os.environ[env_variable] = value
1066
 
    return orig_val
1067
 
 
1068
 
 
1069
853
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
1070
854
 
1071
855
 
1077
861
    if sys.platform != "win32":
1078
862
        return
1079
863
    if _validWin32PathRE.match(path) is None:
1080
 
        raise errors.IllegalPath(path)
 
864
        raise IllegalPath(path)
1081
865
 
1082
866
 
1083
867
def walkdirs(top, prefix=""):
1088
872
    to exclude some directories, they are then not descended into.
1089
873
    
1090
874
    The data yielded is of the form:
1091
 
    ((directory-relpath, directory-path-from-top),
1092
 
    [(directory-relpath, basename, kind, lstat, path-from-top), ...]),
1093
 
     - directory-relpath is the relative path of the directory being returned
1094
 
       with respect to top. prefix is prepended to this.
1095
 
     - directory-path-from-root is the path including top for this directory. 
1096
 
       It is suitable for use with os functions.
1097
 
     - relpath is the relative path within the subtree being walked.
1098
 
     - basename is the basename of the path
1099
 
     - kind is the kind of the file now. If unknown then the file is not
1100
 
       present within the tree - but it may be recorded as versioned. See
1101
 
       versioned_kind.
1102
 
     - lstat is the stat data *if* the file was statted.
1103
 
     - planned, not implemented: 
1104
 
       path_from_tree_root is the path from the root of the tree.
 
875
    [(relpath, basename, kind, lstat, path_from_top), ...]
1105
876
 
1106
877
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This 
1107
878
        allows one to walk a subtree but get paths that are relative to a tree
1108
879
        rooted higher up.
1109
880
    :return: an iterator over the dirs.
1110
881
    """
1111
 
    #TODO there is a bit of a smell where the results of the directory-
1112
 
    # summary in this, and the path from the root, may not agree 
1113
 
    # depending on top and prefix - i.e. ./foo and foo as a pair leads to
1114
 
    # potentially confusing output. We should make this more robust - but
1115
 
    # not at a speed cost. RBC 20060731
1116
 
    _lstat = os.lstat
 
882
    lstat = os.lstat
 
883
    pending = []
1117
884
    _directory = _directory_kind
1118
 
    _listdir = os.listdir
1119
 
    _kind_from_mode = _formats.get
1120
 
    pending = [(safe_unicode(prefix), "", _directory, None, safe_unicode(top))]
 
885
    _listdir = listdir
 
886
    pending = [(prefix, "", _directory, None, top)]
1121
887
    while pending:
 
888
        dirblock = []
 
889
        currentdir = pending.pop()
1122
890
        # 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)
1237
 
 
1238
 
 
1239
 
def copy_tree(from_path, to_path, handlers={}):
1240
 
    """Copy all of the entries in from_path into to_path.
1241
 
 
1242
 
    :param from_path: The base directory to copy. 
1243
 
    :param to_path: The target directory. If it does not exist, it will
1244
 
        be created.
1245
 
    :param handlers: A dictionary of functions, which takes a source and
1246
 
        destinations for files, directories, etc.
1247
 
        It is keyed on the file kind, such as 'directory', 'symlink', or 'file'
1248
 
        'file', 'directory', and 'symlink' should always exist.
1249
 
        If they are missing, they will be replaced with 'os.mkdir()',
1250
 
        'os.readlink() + os.symlink()', and 'shutil.copy2()', respectively.
1251
 
    """
1252
 
    # Now, just copy the existing cached tree to the new location
1253
 
    # We use a cheap trick here.
1254
 
    # Absolute paths are prefixed with the first parameter
1255
 
    # relative paths are prefixed with the second.
1256
 
    # So we can get both the source and target returned
1257
 
    # without any extra work.
1258
 
 
1259
 
    def copy_dir(source, dest):
1260
 
        os.mkdir(dest)
1261
 
 
1262
 
    def copy_link(source, dest):
1263
 
        """Copy the contents of a symlink"""
1264
 
        link_to = os.readlink(source)
1265
 
        os.symlink(link_to, dest)
1266
 
 
1267
 
    real_handlers = {'file':shutil.copy2,
1268
 
                     'symlink':copy_link,
1269
 
                     'directory':copy_dir,
1270
 
                    }
1271
 
    real_handlers.update(handlers)
1272
 
 
1273
 
    if not os.path.exists(to_path):
1274
 
        real_handlers['directory'](from_path, to_path)
1275
 
 
1276
 
    for dir_info, entries in walkdirs(from_path, prefix=to_path):
1277
 
        for relpath, name, kind, st, abspath in entries:
1278
 
            real_handlers[kind](abspath, relpath)
 
891
        top = currentdir[4]
 
892
        if currentdir[0]:
 
893
            relroot = currentdir[0] + '/'
 
894
        else:
 
895
            relroot = ""
 
896
        for name in sorted(_listdir(top)):
 
897
            abspath = top + '/' + name
 
898
            statvalue = lstat(abspath)
 
899
            dirblock.append ((relroot + name, name, file_kind_from_stat_mode(statvalue.st_mode), statvalue, abspath))
 
900
        yield dirblock
 
901
        # push the user specified dirs from dirblock
 
902
        for dir in reversed(dirblock):
 
903
            if dir[2] == _directory:
 
904
                pending.append(dir)
1279
905
 
1280
906
 
1281
907
def path_prefix_key(path):
1291
917
    key_a = path_prefix_key(path_a)
1292
918
    key_b = path_prefix_key(path_b)
1293
919
    return cmp(key_a, key_b)
1294
 
 
1295
 
 
1296
 
_cached_user_encoding = None
1297
 
 
1298
 
 
1299
 
def get_user_encoding(use_cache=True):
1300
 
    """Find out what the preferred user encoding is.
1301
 
 
1302
 
    This is generally the encoding that is used for command line parameters
1303
 
    and file contents. This may be different from the terminal encoding
1304
 
    or the filesystem encoding.
1305
 
 
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
 
    :return: A string defining the preferred user encoding
1311
 
    """
1312
 
    global _cached_user_encoding
1313
 
    if _cached_user_encoding is not None and use_cache:
1314
 
        return _cached_user_encoding
1315
 
 
1316
 
    if sys.platform == 'darwin':
1317
 
        # work around egregious python 2.4 bug
1318
 
        sys.platform = 'posix'
1319
 
        try:
1320
 
            import locale
1321
 
        finally:
1322
 
            sys.platform = 'darwin'
1323
 
    else:
1324
 
        import locale
1325
 
 
1326
 
    try:
1327
 
        user_encoding = locale.getpreferredencoding()
1328
 
    except locale.Error, e:
1329
 
        sys.stderr.write('bzr: warning: %s\n'
1330
 
                         '  Could not determine what text encoding to use.\n'
1331
 
                         '  This error usually means your Python interpreter\n'
1332
 
                         '  doesn\'t support the locale set by $LANG (%s)\n'
1333
 
                         "  Continuing with ascii encoding.\n"
1334
 
                         % (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)