← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Alexander Belchenko
  • Date: 2006-12-22 08:52:28 UTC
  • mto: This revision was merged to the branch mainline in revision 2215.
  • Revision ID: bialix@ukr.net-20061222085228-fe80nuencvxluh6v
Don't formats unicode strings in test error messages with '%s': it's unsafe

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/osutils.py
1
 
# Copyright (C) 2005, 2006, 2007, 2009 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
 
17
from cStringIO import StringIO
17
18
import os
18
19
import re
19
20
import stat
24
25
 
25
26
from bzrlib.lazy_import import lazy_import
26
27
lazy_import(globals(), """
27
 
import codecs
28
 
from datetime import datetime
29
28
import errno
30
29
from ntpath import (abspath as _nt_abspath,
31
30
                    join as _nt_join,
34
33
                    splitdrive as _nt_splitdrive,
35
34
                    )
36
35
import posixpath
 
36
import sha
37
37
import shutil
38
38
from shutil import (
39
39
    rmtree,
40
40
    )
 
41
import string
41
42
import tempfile
42
43
from tempfile import (
43
44
    mkdtemp,
45
46
import unicodedata
46
47
 
47
48
from bzrlib import (
48
 
    cache_utf8,
49
49
    errors,
50
 
    win32utils,
51
50
    )
52
51
""")
53
52
 
54
 
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
55
 
# of 2.5
56
 
if sys.version_info < (2, 5):
57
 
    import md5 as _mod_md5
58
 
    md5 = _mod_md5.new
59
 
    import sha as _mod_sha
60
 
    sha = _mod_sha.new
61
 
else:
62
 
    from hashlib import (
63
 
        md5,
64
 
        sha1 as sha,
65
 
        )
66
 
 
67
 
 
68
53
import bzrlib
69
 
from bzrlib import symbol_versioning
 
54
from bzrlib.symbol_versioning import (
 
55
    deprecated_function,
 
56
    zero_nine,
 
57
    )
 
58
from bzrlib.trace import mutter
70
59
 
71
60
 
72
61
# On win32, O_BINARY is used to indicate the file should
79
68
 
80
69
def make_readonly(filename):
81
70
    """Make a filename read-only."""
82
 
    mod = os.lstat(filename).st_mode
83
 
    if not stat.S_ISLNK(mod):
84
 
        mod = mod & 0777555
85
 
        os.chmod(filename, mod)
 
71
    mod = os.stat(filename).st_mode
 
72
    mod = mod & 0777555
 
73
    os.chmod(filename, mod)
86
74
 
87
75
 
88
76
def make_writable(filename):
89
 
    mod = os.lstat(filename).st_mode
90
 
    if not stat.S_ISLNK(mod):
91
 
        mod = mod | 0200
92
 
        os.chmod(filename, mod)
93
 
 
94
 
 
95
 
def minimum_path_selection(paths):
96
 
    """Return the smallset subset of paths which are outside paths.
97
 
 
98
 
    :param paths: A container (and hence not None) of paths.
99
 
    :return: A set of paths sufficient to include everything in paths via
100
 
        is_inside_any, drawn from the paths parameter.
101
 
    """
102
 
    search_paths = set()
103
 
    paths = set(paths)
104
 
    for path in paths:
105
 
        other_paths = paths.difference([path])
106
 
        if not is_inside_any(other_paths, path):
107
 
            # this is a top level path, we must check it.
108
 
            search_paths.add(path)
109
 
    return search_paths
 
77
    mod = os.stat(filename).st_mode
 
78
    mod = mod | 0200
 
79
    os.chmod(filename, mod)
110
80
 
111
81
 
112
82
_QUOTE_RE = None
121
91
    global _QUOTE_RE
122
92
    if _QUOTE_RE is None:
123
93
        _QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
124
 
 
 
94
        
125
95
    if _QUOTE_RE.search(f):
126
96
        return '"' + f + '"'
127
97
    else:
130
100
 
131
101
_directory_kind = 'directory'
132
102
 
 
103
_formats = {
 
104
    stat.S_IFDIR:_directory_kind,
 
105
    stat.S_IFCHR:'chardev',
 
106
    stat.S_IFBLK:'block',
 
107
    stat.S_IFREG:'file',
 
108
    stat.S_IFIFO:'fifo',
 
109
    stat.S_IFLNK:'symlink',
 
110
    stat.S_IFSOCK:'socket',
 
111
}
 
112
 
 
113
 
 
114
def file_kind_from_stat_mode(stat_mode, _formats=_formats, _unknown='unknown'):
 
115
    """Generate a file kind from a stat mode. This is used in walkdirs.
 
116
 
 
117
    Its performance is critical: Do not mutate without careful benchmarking.
 
118
    """
 
119
    try:
 
120
        return _formats[stat_mode & 0170000]
 
121
    except KeyError:
 
122
        return _unknown
 
123
 
 
124
 
 
125
def file_kind(f, _lstat=os.lstat, _mapper=file_kind_from_stat_mode):
 
126
    try:
 
127
        return _mapper(_lstat(f).st_mode)
 
128
    except OSError, e:
 
129
        if getattr(e, 'errno', None) == errno.ENOENT:
 
130
            raise errors.NoSuchFile(f)
 
131
        raise
 
132
 
 
133
 
133
134
def get_umask():
134
135
    """Return the current umask"""
135
136
    # Assume that people aren't messing with the umask while running
140
141
    return umask
141
142
 
142
143
 
143
 
_kind_marker_map = {
144
 
    "file": "",
145
 
    _directory_kind: "/",
146
 
    "symlink": "@",
147
 
    'tree-reference': '+',
148
 
}
149
 
 
150
 
 
151
144
def kind_marker(kind):
152
 
    try:
153
 
        return _kind_marker_map[kind]
154
 
    except KeyError:
 
145
    if kind == 'file':
 
146
        return ''
 
147
    elif kind == _directory_kind:
 
148
        return '/'
 
149
    elif kind == 'symlink':
 
150
        return '@'
 
151
    else:
155
152
        raise errors.BzrError('invalid file kind %r' % kind)
156
153
 
157
 
 
158
154
lexists = getattr(os.path, 'lexists', None)
159
155
if lexists is None:
160
156
    def lexists(f):
161
157
        try:
162
 
            stat = getattr(os, 'lstat', os.stat)
163
 
            stat(f)
 
158
            if getattr(os, 'lstat') is not None:
 
159
                os.lstat(f)
 
160
            else:
 
161
                os.stat(f)
164
162
            return True
165
 
        except OSError, e:
 
163
        except OSError,e:
166
164
            if e.errno == errno.ENOENT:
167
165
                return False;
168
166
            else:
171
169
 
172
170
def fancy_rename(old, new, rename_func, unlink_func):
173
171
    """A fancy rename, when you don't have atomic rename.
174
 
 
 
172
    
175
173
    :param old: The old path, to rename from
176
174
    :param new: The new path, to rename to
177
175
    :param rename_func: The potentially non-atomic rename function
179
177
    """
180
178
 
181
179
    # sftp rename doesn't allow overwriting, so play tricks:
 
180
    import random
182
181
    base = os.path.basename(new)
183
182
    dirname = os.path.dirname(new)
184
183
    tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
209
208
 
210
209
    success = False
211
210
    try:
212
 
        try:
213
 
            # This may throw an exception, in which case success will
214
 
            # not be set.
215
 
            rename_func(old, new)
216
 
            success = True
217
 
        except (IOError, OSError), e:
218
 
            # source and target may be aliases of each other (e.g. on a
219
 
            # case-insensitive filesystem), so we may have accidentally renamed
220
 
            # source by when we tried to rename target
221
 
            if not (file_existed and e.errno in (None, errno.ENOENT)):
222
 
                raise
 
211
        # This may throw an exception, in which case success will
 
212
        # not be set.
 
213
        rename_func(old, new)
 
214
        success = True
223
215
    finally:
224
216
        if file_existed:
225
217
            # If the file used to exist, rename it back into place
265
257
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
266
258
 
267
259
 
268
 
def _win98_abspath(path):
269
 
    """Return the absolute version of a path.
270
 
    Windows 98 safe implementation (python reimplementation
271
 
    of Win32 API function GetFullPathNameW)
272
 
    """
273
 
    # Corner cases:
274
 
    #   C:\path     => C:/path
275
 
    #   C:/path     => C:/path
276
 
    #   \\HOST\path => //HOST/path
277
 
    #   //HOST/path => //HOST/path
278
 
    #   path        => C:/cwd/path
279
 
    #   /path       => C:/path
280
 
    path = unicode(path)
281
 
    # check for absolute path
282
 
    drive = _nt_splitdrive(path)[0]
283
 
    if drive == '' and path[:2] not in('//','\\\\'):
284
 
        cwd = os.getcwdu()
285
 
        # we cannot simply os.path.join cwd and path
286
 
        # because os.path.join('C:','/path') produce '/path'
287
 
        # and this is incorrect
288
 
        if path[:1] in ('/','\\'):
289
 
            cwd = _nt_splitdrive(cwd)[0]
290
 
            path = path[1:]
291
 
        path = cwd + '\\' + path
292
 
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
293
 
 
294
 
 
295
260
def _win32_realpath(path):
296
261
    # Real _nt_realpath doesn't have a problem with a unicode cwd
297
262
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
317
282
    """We expect to be able to atomically replace 'new' with old.
318
283
 
319
284
    On win32, if new exists, it must be moved out of the way first,
320
 
    and then deleted.
 
285
    and then deleted. 
321
286
    """
322
287
    try:
323
288
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
324
289
    except OSError, e:
325
290
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
326
 
            # If we try to rename a non-existant file onto cwd, we get
327
 
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT
 
291
            # If we try to rename a non-existant file onto cwd, we get 
 
292
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT 
328
293
            # if the old path doesn't exist, sometimes we get EACCES
329
294
            # On Linux, we seem to get EBUSY, on Mac we get EINVAL
330
295
            os.lstat(old)
332
297
 
333
298
 
334
299
def _mac_getcwd():
335
 
    return unicodedata.normalize('NFC', os.getcwdu())
 
300
    return unicodedata.normalize('NFKC', os.getcwdu())
336
301
 
337
302
 
338
303
# Default is to just use the python builtins, but these can be rebound on
345
310
rename = os.rename
346
311
dirname = os.path.dirname
347
312
basename = os.path.basename
348
 
split = os.path.split
349
 
splitext = os.path.splitext
350
313
# These were already imported into local scope
351
314
# mkdtemp = tempfile.mkdtemp
352
315
# rmtree = shutil.rmtree
355
318
 
356
319
 
357
320
if sys.platform == 'win32':
358
 
    if win32utils.winver == 'Windows 98':
359
 
        abspath = _win98_abspath
360
 
    else:
361
 
        abspath = _win32_abspath
 
321
    abspath = _win32_abspath
362
322
    realpath = _win32_realpath
363
323
    pathjoin = _win32_pathjoin
364
324
    normpath = _win32_normpath
393
353
 
394
354
    This attempts to check both sys.stdout and sys.stdin to see
395
355
    what encoding they are in, and if that fails it falls back to
396
 
    osutils.get_user_encoding().
 
356
    bzrlib.user_encoding.
397
357
    The problem is that on Windows, locale.getpreferredencoding()
398
358
    is not the same encoding as that used by the console:
399
359
    http://mail.python.org/pipermail/python-list/2003-May/162357.html
401
361
    On my standard US Windows XP, the preferred encoding is
402
362
    cp1252, but the console is cp437
403
363
    """
404
 
    from bzrlib.trace import mutter
405
364
    output_encoding = getattr(sys.stdout, 'encoding', None)
406
365
    if not output_encoding:
407
366
        input_encoding = getattr(sys.stdin, 'encoding', None)
408
367
        if not input_encoding:
409
 
            output_encoding = get_user_encoding()
410
 
            mutter('encoding stdout as osutils.get_user_encoding() %r',
411
 
                   output_encoding)
 
368
            output_encoding = bzrlib.user_encoding
 
369
            mutter('encoding stdout as bzrlib.user_encoding %r', output_encoding)
412
370
        else:
413
371
            output_encoding = input_encoding
414
372
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
416
374
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
417
375
    if output_encoding == 'cp0':
418
376
        # invalid encoding (cp0 means 'no codepage' on Windows)
419
 
        output_encoding = get_user_encoding()
 
377
        output_encoding = bzrlib.user_encoding
420
378
        mutter('cp0 is invalid encoding.'
421
 
               ' encoding stdout as osutils.get_user_encoding() %r',
422
 
               output_encoding)
423
 
    # check encoding
424
 
    try:
425
 
        codecs.lookup(output_encoding)
426
 
    except LookupError:
427
 
        sys.stderr.write('bzr: warning:'
428
 
                         ' unknown terminal encoding %s.\n'
429
 
                         '  Using encoding %s instead.\n'
430
 
                         % (output_encoding, get_user_encoding())
431
 
                        )
432
 
        output_encoding = get_user_encoding()
433
 
 
 
379
               ' encoding stdout as bzrlib.user_encoding %r', output_encoding)
434
380
    return output_encoding
435
381
 
436
382
 
446
392
        return pathjoin(F(p), e)
447
393
 
448
394
 
 
395
def backup_file(fn):
 
396
    """Copy a file to a backup.
 
397
 
 
398
    Backups are named in GNU-style, with a ~ suffix.
 
399
 
 
400
    If the file is already a backup, it's not copied.
 
401
    """
 
402
    if fn[-1] == '~':
 
403
        return
 
404
    bfn = fn + '~'
 
405
 
 
406
    if has_symlinks() and os.path.islink(fn):
 
407
        target = os.readlink(fn)
 
408
        os.symlink(target, bfn)
 
409
        return
 
410
    inf = file(fn, 'rb')
 
411
    try:
 
412
        content = inf.read()
 
413
    finally:
 
414
        inf.close()
 
415
    
 
416
    outf = file(bfn, 'wb')
 
417
    try:
 
418
        outf.write(content)
 
419
    finally:
 
420
        outf.close()
 
421
 
 
422
 
449
423
def isdir(f):
450
424
    """True if f is an accessible directory."""
451
425
    try:
470
444
 
471
445
def is_inside(dir, fname):
472
446
    """True if fname is inside dir.
473
 
 
 
447
    
474
448
    The parameters should typically be passed to osutils.normpath first, so
475
449
    that . and .. and repeated slashes are eliminated, and the separators
476
450
    are canonical for the platform.
477
 
 
478
 
    The empty string as a dir name is taken as top-of-tree and matches
 
451
    
 
452
    The empty string as a dir name is taken as top-of-tree and matches 
479
453
    everything.
480
454
    """
481
 
    # XXX: Most callers of this can actually do something smarter by
 
455
    # XXX: Most callers of this can actually do something smarter by 
482
456
    # looking at the inventory
483
457
    if dir == fname:
484
458
        return True
485
 
 
 
459
    
486
460
    if dir == '':
487
461
        return True
488
462
 
497
471
    for dirname in dir_list:
498
472
        if is_inside(dirname, fname):
499
473
            return True
500
 
    return False
 
474
    else:
 
475
        return False
501
476
 
502
477
 
503
478
def is_inside_or_parent_of_any(dir_list, fname):
505
480
    for dirname in dir_list:
506
481
        if is_inside(dirname, fname) or is_inside(fname, dirname):
507
482
            return True
508
 
    return False
509
 
 
510
 
 
511
 
def pumpfile(from_file, to_file, read_length=-1, buff_size=32768,
512
 
             report_activity=None, direction='read'):
513
 
    """Copy contents of one file to another.
514
 
 
515
 
    The read_length can either be -1 to read to end-of-file (EOF) or
516
 
    it can specify the maximum number of bytes to read.
517
 
 
518
 
    The buff_size represents the maximum size for each read operation
519
 
    performed on from_file.
520
 
 
521
 
    :param report_activity: Call this as bytes are read, see
522
 
        Transport._report_activity
523
 
    :param direction: Will be passed to report_activity
524
 
 
525
 
    :return: The number of bytes copied.
526
 
    """
527
 
    length = 0
528
 
    if read_length >= 0:
529
 
        # read specified number of bytes
530
 
 
531
 
        while read_length > 0:
532
 
            num_bytes_to_read = min(read_length, buff_size)
533
 
 
534
 
            block = from_file.read(num_bytes_to_read)
535
 
            if not block:
536
 
                # EOF reached
537
 
                break
538
 
            if report_activity is not None:
539
 
                report_activity(len(block), direction)
540
 
            to_file.write(block)
541
 
 
542
 
            actual_bytes_read = len(block)
543
 
            read_length -= actual_bytes_read
544
 
            length += actual_bytes_read
545
483
    else:
546
 
        # read to EOF
547
 
        while True:
548
 
            block = from_file.read(buff_size)
549
 
            if not block:
550
 
                # EOF reached
551
 
                break
552
 
            if report_activity is not None:
553
 
                report_activity(len(block), direction)
554
 
            to_file.write(block)
555
 
            length += len(block)
556
 
    return length
557
 
 
558
 
 
559
 
def pump_string_file(bytes, file_handle, segment_size=None):
560
 
    """Write bytes to file_handle in many smaller writes.
561
 
 
562
 
    :param bytes: The string to write.
563
 
    :param file_handle: The file to write to.
564
 
    """
565
 
    # Write data in chunks rather than all at once, because very large
566
 
    # writes fail on some platforms (e.g. Windows with SMB  mounted
567
 
    # drives).
568
 
    if not segment_size:
569
 
        segment_size = 5242880 # 5MB
570
 
    segments = range(len(bytes) / segment_size + 1)
571
 
    write = file_handle.write
572
 
    for segment_index in segments:
573
 
        segment = buffer(bytes, segment_index * segment_size, segment_size)
574
 
        write(segment)
 
484
        return False
 
485
 
 
486
 
 
487
def pumpfile(fromfile, tofile):
 
488
    """Copy contents of one file to another."""
 
489
    BUFSIZE = 32768
 
490
    while True:
 
491
        b = fromfile.read(BUFSIZE)
 
492
        if not b:
 
493
            break
 
494
        tofile.write(b)
575
495
 
576
496
 
577
497
def file_iterator(input_file, readsize=32768):
583
503
 
584
504
 
585
505
def sha_file(f):
586
 
    """Calculate the hexdigest of an open file.
587
 
 
588
 
    The file cursor should be already at the start.
589
 
    """
590
 
    s = sha()
 
506
    if getattr(f, 'tell', None) is not None:
 
507
        assert f.tell() == 0
 
508
    s = sha.new()
591
509
    BUFSIZE = 128<<10
592
510
    while True:
593
511
        b = f.read(BUFSIZE)
597
515
    return s.hexdigest()
598
516
 
599
517
 
600
 
def size_sha_file(f):
601
 
    """Calculate the size and hexdigest of an open file.
602
 
 
603
 
    The file cursor should be already at the start and
604
 
    the caller is responsible for closing the file afterwards.
605
 
    """
606
 
    size = 0
607
 
    s = sha()
608
 
    BUFSIZE = 128<<10
609
 
    while True:
610
 
        b = f.read(BUFSIZE)
611
 
        if not b:
612
 
            break
613
 
        size += len(b)
614
 
        s.update(b)
615
 
    return size, s.hexdigest()
616
 
 
617
 
 
618
 
def sha_file_by_name(fname):
619
 
    """Calculate the SHA1 of a file by reading the full text"""
620
 
    s = sha()
621
 
    f = os.open(fname, os.O_RDONLY | O_BINARY)
622
 
    try:
623
 
        while True:
624
 
            b = os.read(f, 1<<16)
625
 
            if not b:
626
 
                return s.hexdigest()
627
 
            s.update(b)
628
 
    finally:
629
 
        os.close(f)
630
 
 
631
 
 
632
 
def sha_strings(strings, _factory=sha):
 
518
 
 
519
def sha_strings(strings):
633
520
    """Return the sha-1 of concatenation of strings"""
634
 
    s = _factory()
 
521
    s = sha.new()
635
522
    map(s.update, strings)
636
523
    return s.hexdigest()
637
524
 
638
525
 
639
 
def sha_string(f, _factory=sha):
640
 
    return _factory(f).hexdigest()
 
526
def sha_string(f):
 
527
    s = sha.new()
 
528
    s.update(f)
 
529
    return s.hexdigest()
641
530
 
642
531
 
643
532
def fingerprint_file(f):
 
533
    s = sha.new()
644
534
    b = f.read()
645
 
    return {'size': len(b),
646
 
            'sha1': sha(b).hexdigest()}
 
535
    s.update(b)
 
536
    size = len(b)
 
537
    return {'size': size,
 
538
            'sha1': s.hexdigest()}
647
539
 
648
540
 
649
541
def compare_files(a, b):
660
552
 
661
553
def local_time_offset(t=None):
662
554
    """Return offset of local zone from GMT, either at present or at time t."""
 
555
    # python2.3 localtime() can't take None
663
556
    if t is None:
664
557
        t = time.time()
665
 
    offset = datetime.fromtimestamp(t) - datetime.utcfromtimestamp(t)
666
 
    return offset.days * 86400 + offset.seconds
667
 
 
668
 
weekdays = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
669
 
 
670
 
def format_date(t, offset=0, timezone='original', date_fmt=None,
 
558
        
 
559
    if time.localtime(t).tm_isdst and time.daylight:
 
560
        return -time.altzone
 
561
    else:
 
562
        return -time.timezone
 
563
 
 
564
    
 
565
def format_date(t, offset=0, timezone='original', date_fmt=None, 
671
566
                show_offset=True):
672
 
    """Return a formatted date string.
673
 
 
674
 
    :param t: Seconds since the epoch.
675
 
    :param offset: Timezone offset in seconds east of utc.
676
 
    :param timezone: How to display the time: 'utc', 'original' for the
677
 
         timezone specified by offset, or 'local' for the process's current
678
 
         timezone.
679
 
    :param date_fmt: strftime format.
680
 
    :param show_offset: Whether to append the timezone.
681
 
    """
682
 
    (date_fmt, tt, offset_str) = \
683
 
               _format_date(t, offset, timezone, date_fmt, show_offset)
684
 
    date_fmt = date_fmt.replace('%a', weekdays[tt[6]])
685
 
    date_str = time.strftime(date_fmt, tt)
686
 
    return date_str + offset_str
687
 
 
688
 
def format_local_date(t, offset=0, timezone='original', date_fmt=None,
689
 
                      show_offset=True):
690
 
    """Return an unicode date string formatted according to the current locale.
691
 
 
692
 
    :param t: Seconds since the epoch.
693
 
    :param offset: Timezone offset in seconds east of utc.
694
 
    :param timezone: How to display the time: 'utc', 'original' for the
695
 
         timezone specified by offset, or 'local' for the process's current
696
 
         timezone.
697
 
    :param date_fmt: strftime format.
698
 
    :param show_offset: Whether to append the timezone.
699
 
    """
700
 
    (date_fmt, tt, offset_str) = \
701
 
               _format_date(t, offset, timezone, date_fmt, show_offset)
702
 
    date_str = time.strftime(date_fmt, tt)
703
 
    if not isinstance(date_str, unicode):
704
 
        date_str = date_str.decode(bzrlib.user_encoding, 'replace')
705
 
    return date_str + offset_str
706
 
 
707
 
def _format_date(t, offset, timezone, date_fmt, show_offset):
 
567
    ## TODO: Perhaps a global option to use either universal or local time?
 
568
    ## Or perhaps just let people set $TZ?
 
569
    assert isinstance(t, float)
 
570
    
708
571
    if timezone == 'utc':
709
572
        tt = time.gmtime(t)
710
573
        offset = 0
716
579
        tt = time.localtime(t)
717
580
        offset = local_time_offset(t)
718
581
    else:
719
 
        raise errors.UnsupportedTimezoneFormat(timezone)
 
582
        raise errors.BzrError("unsupported timezone format %r" % timezone,
 
583
                              ['options are "utc", "original", "local"'])
720
584
    if date_fmt is None:
721
585
        date_fmt = "%a %Y-%m-%d %H:%M:%S"
722
586
    if show_offset:
723
587
        offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
724
588
    else:
725
589
        offset_str = ''
726
 
    return (date_fmt, tt, offset_str)
 
590
    return (time.strftime(date_fmt, tt) +  offset_str)
727
591
 
728
592
 
729
593
def compact_date(when):
730
594
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
731
 
 
 
595
    
732
596
 
733
597
def format_delta(delta):
734
598
    """Get a nice looking string for a time delta.
810
674
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
811
675
def rand_chars(num):
812
676
    """Return a random string of num alphanumeric characters
813
 
 
814
 
    The result only contains lowercase chars because it may be used on
 
677
    
 
678
    The result only contains lowercase chars because it may be used on 
815
679
    case-insensitive filesystems.
816
680
    """
817
681
    s = ''
825
689
 
826
690
def splitpath(p):
827
691
    """Turn string into list of parts."""
 
692
    assert isinstance(p, basestring)
 
693
 
828
694
    # split on either delimiter because people might use either on
829
695
    # Windows
830
696
    ps = re.split(r'[\\/]', p)
839
705
            rps.append(f)
840
706
    return rps
841
707
 
842
 
 
843
708
def joinpath(p):
 
709
    assert isinstance(p, list)
844
710
    for f in p:
845
711
        if (f == '..') or (f is None) or (f == ''):
846
712
            raise errors.BzrError("sorry, %r not allowed in path" % f)
847
713
    return pathjoin(*p)
848
714
 
849
715
 
850
 
try:
851
 
    from bzrlib._chunks_to_lines_pyx import chunks_to_lines
852
 
except ImportError:
853
 
    from bzrlib._chunks_to_lines_py import chunks_to_lines
854
 
 
 
716
@deprecated_function(zero_nine)
 
717
def appendpath(p1, p2):
 
718
    if p1 == '':
 
719
        return p2
 
720
    else:
 
721
        return pathjoin(p1, p2)
 
722
    
855
723
 
856
724
def split_lines(s):
857
725
    """Split s into lines, but without removing the newline characters."""
858
 
    # Trivially convert a fulltext into a 'chunked' representation, and let
859
 
    # chunks_to_lines do the heavy lifting.
860
 
    if isinstance(s, str):
861
 
        # chunks_to_lines only supports 8-bit strings
862
 
        return chunks_to_lines([s])
863
 
    else:
864
 
        return _split_lines(s)
865
 
 
866
 
 
867
 
def _split_lines(s):
868
 
    """Split s into lines, but without removing the newline characters.
869
 
 
870
 
    This supports Unicode or plain string objects.
871
 
    """
872
726
    lines = s.split('\n')
873
727
    result = [line + '\n' for line in lines[:-1]]
874
728
    if lines[-1]:
892
746
            raise
893
747
        shutil.copyfile(src, dest)
894
748
 
895
 
 
896
 
# Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
897
 
# Forgiveness than Permission (EAFP) because:
898
 
# - root can damage a solaris file system by using unlink,
899
 
# - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
900
 
#   EACCES, OSX: EPERM) when invoked on a directory.
901
 
def delete_any(path):
 
749
def delete_any(full_path):
902
750
    """Delete a file or directory."""
903
 
    if isdir(path): # Takes care of symlinks
904
 
        os.rmdir(path)
905
 
    else:
906
 
        os.unlink(path)
 
751
    try:
 
752
        os.unlink(full_path)
 
753
    except OSError, e:
 
754
    # We may be renaming a dangling inventory id
 
755
        if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
 
756
            raise
 
757
        os.rmdir(full_path)
907
758
 
908
759
 
909
760
def has_symlinks():
911
762
        return True
912
763
    else:
913
764
        return False
914
 
 
915
 
 
916
 
def has_hardlinks():
917
 
    if getattr(os, 'link', None) is not None:
918
 
        return True
919
 
    else:
920
 
        return False
921
 
 
922
 
 
923
 
def host_os_dereferences_symlinks():
924
 
    return (has_symlinks()
925
 
            and sys.platform not in ('cygwin', 'win32'))
926
 
 
 
765
        
927
766
 
928
767
def contains_whitespace(s):
929
768
    """True if there are any whitespace characters in s."""
930
 
    # string.whitespace can include '\xa0' in certain locales, because it is
931
 
    # considered "non-breaking-space" as part of ISO-8859-1. But it
932
 
    # 1) Isn't a breaking whitespace
933
 
    # 2) Isn't one of ' \t\r\n' which are characters we sometimes use as
934
 
    #    separators
935
 
    # 3) '\xa0' isn't unicode safe since it is >128.
936
 
 
937
 
    # This should *not* be a unicode set of characters in case the source
938
 
    # string is not a Unicode string. We can auto-up-cast the characters since
939
 
    # they are ascii, but we don't want to auto-up-cast the string in case it
940
 
    # is utf-8
941
 
    for ch in ' \t\n\r\v\f':
 
769
    for ch in string.whitespace:
942
770
        if ch in s:
943
771
            return True
944
772
    else:
965
793
    avoids that problem.
966
794
    """
967
795
 
968
 
    if len(base) < MIN_ABS_PATHLENGTH:
969
 
        # must have space for e.g. a drive letter
970
 
        raise ValueError('%r is too short to calculate a relative path'
971
 
            % (base,))
 
796
    assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
 
797
        ' exceed the platform minimum length (which is %d)' % 
 
798
        MIN_ABS_PATHLENGTH)
972
799
 
973
800
    rp = abspath(path)
974
801
 
989
816
        return ''
990
817
 
991
818
 
992
 
def _cicp_canonical_relpath(base, path):
993
 
    """Return the canonical path relative to base.
994
 
 
995
 
    Like relpath, but on case-insensitive-case-preserving file-systems, this
996
 
    will return the relpath as stored on the file-system rather than in the
997
 
    case specified in the input string, for all existing portions of the path.
998
 
 
999
 
    This will cause O(N) behaviour if called for every path in a tree; if you
1000
 
    have a number of paths to convert, you should use canonical_relpaths().
1001
 
    """
1002
 
    # TODO: it should be possible to optimize this for Windows by using the
1003
 
    # win32 API FindFiles function to look for the specified name - but using
1004
 
    # os.listdir() still gives us the correct, platform agnostic semantics in
1005
 
    # the short term.
1006
 
 
1007
 
    rel = relpath(base, path)
1008
 
    # '.' will have been turned into ''
1009
 
    if not rel:
1010
 
        return rel
1011
 
 
1012
 
    abs_base = abspath(base)
1013
 
    current = abs_base
1014
 
    _listdir = os.listdir
1015
 
 
1016
 
    # use an explicit iterator so we can easily consume the rest on early exit.
1017
 
    bit_iter = iter(rel.split('/'))
1018
 
    for bit in bit_iter:
1019
 
        lbit = bit.lower()
1020
 
        for look in _listdir(current):
1021
 
            if lbit == look.lower():
1022
 
                current = pathjoin(current, look)
1023
 
                break
1024
 
        else:
1025
 
            # got to the end, nothing matched, so we just return the
1026
 
            # non-existing bits as they were specified (the filename may be
1027
 
            # the target of a move, for example).
1028
 
            current = pathjoin(current, bit, *list(bit_iter))
1029
 
            break
1030
 
    return current[len(abs_base)+1:]
1031
 
 
1032
 
# XXX - TODO - we need better detection/integration of case-insensitive
1033
 
# file-systems; Linux often sees FAT32 devices, for example, so could
1034
 
# probably benefit from the same basic support there.  For now though, only
1035
 
# Windows gets that support, and it gets it for *all* file-systems!
1036
 
if sys.platform == "win32":
1037
 
    canonical_relpath = _cicp_canonical_relpath
1038
 
else:
1039
 
    canonical_relpath = relpath
1040
 
 
1041
 
def canonical_relpaths(base, paths):
1042
 
    """Create an iterable to canonicalize a sequence of relative paths.
1043
 
 
1044
 
    The intent is for this implementation to use a cache, vastly speeding
1045
 
    up multiple transformations in the same directory.
1046
 
    """
1047
 
    # but for now, we haven't optimized...
1048
 
    return [canonical_relpath(base, p) for p in paths]
1049
 
 
1050
819
def safe_unicode(unicode_or_utf8_string):
1051
820
    """Coerce unicode_or_utf8_string into unicode.
1052
821
 
1053
822
    If it is unicode, it is returned.
1054
 
    Otherwise it is decoded from utf-8. If decoding fails, the exception is
1055
 
    wrapped in a BzrBadParameterNotUnicode exception.
 
823
    Otherwise it is decoded from utf-8. If a decoding error
 
824
    occurs, it is wrapped as a If the decoding fails, the exception is wrapped 
 
825
    as a BzrBadParameter exception.
1056
826
    """
1057
827
    if isinstance(unicode_or_utf8_string, unicode):
1058
828
        return unicode_or_utf8_string
1062
832
        raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
1063
833
 
1064
834
 
1065
 
def safe_utf8(unicode_or_utf8_string):
1066
 
    """Coerce unicode_or_utf8_string to a utf8 string.
1067
 
 
1068
 
    If it is a str, it is returned.
1069
 
    If it is Unicode, it is encoded into a utf-8 string.
1070
 
    """
1071
 
    if isinstance(unicode_or_utf8_string, str):
1072
 
        # TODO: jam 20070209 This is overkill, and probably has an impact on
1073
 
        #       performance if we are dealing with lots of apis that want a
1074
 
        #       utf-8 revision id
1075
 
        try:
1076
 
            # Make sure it is a valid utf-8 string
1077
 
            unicode_or_utf8_string.decode('utf-8')
1078
 
        except UnicodeDecodeError:
1079
 
            raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
1080
 
        return unicode_or_utf8_string
1081
 
    return unicode_or_utf8_string.encode('utf-8')
1082
 
 
1083
 
 
1084
 
_revision_id_warning = ('Unicode revision ids were deprecated in bzr 0.15.'
1085
 
                        ' Revision id generators should be creating utf8'
1086
 
                        ' revision ids.')
1087
 
 
1088
 
 
1089
 
def safe_revision_id(unicode_or_utf8_string, warn=True):
1090
 
    """Revision ids should now be utf8, but at one point they were unicode.
1091
 
 
1092
 
    :param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
1093
 
        utf8 or None).
1094
 
    :param warn: Functions that are sanitizing user data can set warn=False
1095
 
    :return: None or a utf8 revision id.
1096
 
    """
1097
 
    if (unicode_or_utf8_string is None
1098
 
        or unicode_or_utf8_string.__class__ == str):
1099
 
        return unicode_or_utf8_string
1100
 
    if warn:
1101
 
        symbol_versioning.warn(_revision_id_warning, DeprecationWarning,
1102
 
                               stacklevel=2)
1103
 
    return cache_utf8.encode(unicode_or_utf8_string)
1104
 
 
1105
 
 
1106
 
_file_id_warning = ('Unicode file ids were deprecated in bzr 0.15. File id'
1107
 
                    ' generators should be creating utf8 file ids.')
1108
 
 
1109
 
 
1110
 
def safe_file_id(unicode_or_utf8_string, warn=True):
1111
 
    """File ids should now be utf8, but at one point they were unicode.
1112
 
 
1113
 
    This is the same as safe_utf8, except it uses the cached encode functions
1114
 
    to save a little bit of performance.
1115
 
 
1116
 
    :param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
1117
 
        utf8 or None).
1118
 
    :param warn: Functions that are sanitizing user data can set warn=False
1119
 
    :return: None or a utf8 file id.
1120
 
    """
1121
 
    if (unicode_or_utf8_string is None
1122
 
        or unicode_or_utf8_string.__class__ == str):
1123
 
        return unicode_or_utf8_string
1124
 
    if warn:
1125
 
        symbol_versioning.warn(_file_id_warning, DeprecationWarning,
1126
 
                               stacklevel=2)
1127
 
    return cache_utf8.encode(unicode_or_utf8_string)
1128
 
 
1129
 
 
1130
835
_platform_normalizes_filenames = False
1131
836
if sys.platform == 'darwin':
1132
837
    _platform_normalizes_filenames = True
1145
850
 
1146
851
    On platforms where the system normalizes filenames (Mac OSX),
1147
852
    you can access a file by any path which will normalize correctly.
1148
 
    On platforms where the system does not normalize filenames
 
853
    On platforms where the system does not normalize filenames 
1149
854
    (Windows, Linux), you have to access a file by its exact path.
1150
855
 
1151
 
    Internally, bzr only supports NFC normalization, since that is
 
856
    Internally, bzr only supports NFC/NFKC normalization, since that is 
1152
857
    the standard for XML documents.
1153
858
 
1154
859
    So return the normalized path, and a flag indicating if the file
1155
860
    can be accessed by that path.
1156
861
    """
1157
862
 
1158
 
    return unicodedata.normalize('NFC', unicode(path)), True
 
863
    return unicodedata.normalize('NFKC', unicode(path)), True
1159
864
 
1160
865
 
1161
866
def _inaccessible_normalized_filename(path):
1162
867
    __doc__ = _accessible_normalized_filename.__doc__
1163
868
 
1164
 
    normalized = unicodedata.normalize('NFC', unicode(path))
 
869
    normalized = unicodedata.normalize('NFKC', unicode(path))
1165
870
    return normalized, normalized == path
1166
871
 
1167
872
 
1174
879
def terminal_width():
1175
880
    """Return estimated terminal width."""
1176
881
    if sys.platform == 'win32':
1177
 
        return win32utils.get_console_size()[0]
 
882
        import bzrlib.win32console
 
883
        return bzrlib.win32console.get_console_size()[0]
1178
884
    width = 0
1179
885
    try:
1180
886
        import struct, fcntl, termios
1198
904
    return sys.platform != "win32"
1199
905
 
1200
906
 
1201
 
def supports_posix_readonly():
1202
 
    """Return True if 'readonly' has POSIX semantics, False otherwise.
1203
 
 
1204
 
    Notably, a win32 readonly file cannot be deleted, unlike POSIX where the
1205
 
    directory controls creation/deletion, etc.
1206
 
 
1207
 
    And under win32, readonly means that the directory itself cannot be
1208
 
    deleted.  The contents of a readonly directory can be changed, unlike POSIX
1209
 
    where files in readonly directories cannot be added, deleted or renamed.
1210
 
    """
1211
 
    return sys.platform != "win32"
1212
 
 
1213
 
 
1214
907
def set_or_unset_env(env_variable, value):
1215
908
    """Modify the environment, setting or removing the env_variable.
1216
909
 
1225
918
            del os.environ[env_variable]
1226
919
    else:
1227
920
        if isinstance(value, unicode):
1228
 
            value = value.encode(get_user_encoding())
 
921
            value = value.encode(bzrlib.user_encoding)
1229
922
        os.environ[env_variable] = value
1230
923
    return orig_val
1231
924
 
1234
927
 
1235
928
 
1236
929
def check_legal_path(path):
1237
 
    """Check whether the supplied path is legal.
 
930
    """Check whether the supplied path is legal.  
1238
931
    This is only required on Windows, so we don't test on other platforms
1239
932
    right now.
1240
933
    """
1244
937
        raise errors.IllegalPath(path)
1245
938
 
1246
939
 
1247
 
_WIN32_ERROR_DIRECTORY = 267 # Similar to errno.ENOTDIR
1248
 
 
1249
 
def _is_error_enotdir(e):
1250
 
    """Check if this exception represents ENOTDIR.
1251
 
 
1252
 
    Unfortunately, python is very inconsistent about the exception
1253
 
    here. The cases are:
1254
 
      1) Linux, Mac OSX all versions seem to set errno == ENOTDIR
1255
 
      2) Windows, Python2.4, uses errno == ERROR_DIRECTORY (267)
1256
 
         which is the windows error code.
1257
 
      3) Windows, Python2.5 uses errno == EINVAL and
1258
 
         winerror == ERROR_DIRECTORY
1259
 
 
1260
 
    :param e: An Exception object (expected to be OSError with an errno
1261
 
        attribute, but we should be able to cope with anything)
1262
 
    :return: True if this represents an ENOTDIR error. False otherwise.
1263
 
    """
1264
 
    en = getattr(e, 'errno', None)
1265
 
    if (en == errno.ENOTDIR
1266
 
        or (sys.platform == 'win32'
1267
 
            and (en == _WIN32_ERROR_DIRECTORY
1268
 
                 or (en == errno.EINVAL
1269
 
                     and getattr(e, 'winerror', None) == _WIN32_ERROR_DIRECTORY)
1270
 
        ))):
1271
 
        return True
1272
 
    return False
1273
 
 
1274
 
 
1275
940
def walkdirs(top, prefix=""):
1276
941
    """Yield data about all the directories in a tree.
1277
 
 
 
942
    
1278
943
    This yields all the data about the contents of a directory at a time.
1279
944
    After each directory has been yielded, if the caller has mutated the list
1280
945
    to exclude some directories, they are then not descended into.
1281
 
 
 
946
    
1282
947
    The data yielded is of the form:
1283
948
    ((directory-relpath, directory-path-from-top),
1284
 
    [(relpath, basename, kind, lstat, path-from-top), ...]),
 
949
    [(relpath, basename, kind, lstat), ...]),
1285
950
     - directory-relpath is the relative path of the directory being returned
1286
951
       with respect to top. prefix is prepended to this.
1287
 
     - directory-path-from-root is the path including top for this directory.
 
952
     - directory-path-from-root is the path including top for this directory. 
1288
953
       It is suitable for use with os functions.
1289
954
     - relpath is the relative path within the subtree being walked.
1290
955
     - basename is the basename of the path
1292
957
       present within the tree - but it may be recorded as versioned. See
1293
958
       versioned_kind.
1294
959
     - lstat is the stat data *if* the file was statted.
1295
 
     - planned, not implemented:
 
960
     - planned, not implemented: 
1296
961
       path_from_tree_root is the path from the root of the tree.
1297
962
 
1298
 
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This
 
963
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This 
1299
964
        allows one to walk a subtree but get paths that are relative to a tree
1300
965
        rooted higher up.
1301
966
    :return: an iterator over the dirs.
1302
967
    """
1303
968
    #TODO there is a bit of a smell where the results of the directory-
1304
 
    # summary in this, and the path from the root, may not agree
 
969
    # summary in this, and the path from the root, may not agree 
1305
970
    # depending on top and prefix - i.e. ./foo and foo as a pair leads to
1306
971
    # potentially confusing output. We should make this more robust - but
1307
972
    # not at a speed cost. RBC 20060731
1308
 
    _lstat = os.lstat
 
973
    lstat = os.lstat
 
974
    pending = []
1309
975
    _directory = _directory_kind
1310
976
    _listdir = os.listdir
1311
 
    _kind_from_mode = file_kind_from_stat_mode
1312
 
    pending = [(safe_unicode(prefix), "", _directory, None, safe_unicode(top))]
 
977
    pending = [(prefix, "", _directory, None, top)]
1313
978
    while pending:
 
979
        dirblock = []
 
980
        currentdir = pending.pop()
1314
981
        # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1315
 
        relroot, _, _, _, top = pending.pop()
1316
 
        if relroot:
1317
 
            relprefix = relroot + u'/'
1318
 
        else:
1319
 
            relprefix = ''
1320
 
        top_slash = top + u'/'
1321
 
 
1322
 
        dirblock = []
1323
 
        append = dirblock.append
1324
 
        try:
1325
 
            names = sorted(_listdir(top))
1326
 
        except OSError, e:
1327
 
            if not _is_error_enotdir(e):
1328
 
                raise
1329
 
        else:
1330
 
            for name in names:
1331
 
                abspath = top_slash + name
1332
 
                statvalue = _lstat(abspath)
1333
 
                kind = _kind_from_mode(statvalue.st_mode)
1334
 
                append((relprefix + name, name, kind, statvalue, abspath))
1335
 
        yield (relroot, top), dirblock
1336
 
 
1337
 
        # push the user specified dirs from dirblock
1338
 
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1339
 
 
1340
 
 
1341
 
class DirReader(object):
1342
 
    """An interface for reading directories."""
1343
 
 
1344
 
    def top_prefix_to_starting_dir(self, top, prefix=""):
1345
 
        """Converts top and prefix to a starting dir entry
1346
 
 
1347
 
        :param top: A utf8 path
1348
 
        :param prefix: An optional utf8 path to prefix output relative paths
1349
 
            with.
1350
 
        :return: A tuple starting with prefix, and ending with the native
1351
 
            encoding of top.
1352
 
        """
1353
 
        raise NotImplementedError(self.top_prefix_to_starting_dir)
1354
 
 
1355
 
    def read_dir(self, prefix, top):
1356
 
        """Read a specific dir.
1357
 
 
1358
 
        :param prefix: A utf8 prefix to be preprended to the path basenames.
1359
 
        :param top: A natively encoded path to read.
1360
 
        :return: A list of the directories contents. Each item contains:
1361
 
            (utf8_relpath, utf8_name, kind, lstatvalue, native_abspath)
1362
 
        """
1363
 
        raise NotImplementedError(self.read_dir)
1364
 
 
1365
 
 
1366
 
_selected_dir_reader = None
1367
 
 
1368
 
 
1369
 
def _walkdirs_utf8(top, prefix=""):
1370
 
    """Yield data about all the directories in a tree.
1371
 
 
1372
 
    This yields the same information as walkdirs() only each entry is yielded
1373
 
    in utf-8. On platforms which have a filesystem encoding of utf8 the paths
1374
 
    are returned as exact byte-strings.
1375
 
 
1376
 
    :return: yields a tuple of (dir_info, [file_info])
1377
 
        dir_info is (utf8_relpath, path-from-top)
1378
 
        file_info is (utf8_relpath, utf8_name, kind, lstat, path-from-top)
1379
 
        if top is an absolute path, path-from-top is also an absolute path.
1380
 
        path-from-top might be unicode or utf8, but it is the correct path to
1381
 
        pass to os functions to affect the file in question. (such as os.lstat)
1382
 
    """
1383
 
    global _selected_dir_reader
1384
 
    if _selected_dir_reader is None:
1385
 
        fs_encoding = _fs_enc.upper()
1386
 
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1387
 
            # Win98 doesn't have unicode apis like FindFirstFileW
1388
 
            # TODO: We possibly could support Win98 by falling back to the
1389
 
            #       original FindFirstFile, and using TCHAR instead of WCHAR,
1390
 
            #       but that gets a bit tricky, and requires custom compiling
1391
 
            #       for win98 anyway.
1392
 
            try:
1393
 
                from bzrlib._walkdirs_win32 import Win32ReadDir
1394
 
            except ImportError:
1395
 
                _selected_dir_reader = UnicodeDirReader()
1396
 
            else:
1397
 
                _selected_dir_reader = Win32ReadDir()
1398
 
        elif fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1399
 
            # ANSI_X3.4-1968 is a form of ASCII
1400
 
            _selected_dir_reader = UnicodeDirReader()
1401
 
        else:
1402
 
            try:
1403
 
                from bzrlib._readdir_pyx import UTF8DirReader
1404
 
            except ImportError:
1405
 
                # No optimised code path
1406
 
                _selected_dir_reader = UnicodeDirReader()
1407
 
            else:
1408
 
                _selected_dir_reader = UTF8DirReader()
1409
 
    # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1410
 
    # But we don't actually uses 1-3 in pending, so set them to None
1411
 
    pending = [[_selected_dir_reader.top_prefix_to_starting_dir(top, prefix)]]
1412
 
    read_dir = _selected_dir_reader.read_dir
1413
 
    _directory = _directory_kind
1414
 
    while pending:
1415
 
        relroot, _, _, _, top = pending[-1].pop()
1416
 
        if not pending[-1]:
1417
 
            pending.pop()
1418
 
        dirblock = sorted(read_dir(relroot, top))
1419
 
        yield (relroot, top), dirblock
1420
 
        # push the user specified dirs from dirblock
1421
 
        next = [d for d in reversed(dirblock) if d[2] == _directory]
1422
 
        if next:
1423
 
            pending.append(next)
1424
 
 
1425
 
 
1426
 
class UnicodeDirReader(DirReader):
1427
 
    """A dir reader for non-utf8 file systems, which transcodes."""
1428
 
 
1429
 
    __slots__ = ['_utf8_encode']
1430
 
 
1431
 
    def __init__(self):
1432
 
        self._utf8_encode = codecs.getencoder('utf8')
1433
 
 
1434
 
    def top_prefix_to_starting_dir(self, top, prefix=""):
1435
 
        """See DirReader.top_prefix_to_starting_dir."""
1436
 
        return (safe_utf8(prefix), None, None, None, safe_unicode(top))
1437
 
 
1438
 
    def read_dir(self, prefix, top):
1439
 
        """Read a single directory from a non-utf8 file system.
1440
 
 
1441
 
        top, and the abspath element in the output are unicode, all other paths
1442
 
        are utf8. Local disk IO is done via unicode calls to listdir etc.
1443
 
 
1444
 
        This is currently the fallback code path when the filesystem encoding is
1445
 
        not UTF-8. It may be better to implement an alternative so that we can
1446
 
        safely handle paths that are not properly decodable in the current
1447
 
        encoding.
1448
 
 
1449
 
        See DirReader.read_dir for details.
1450
 
        """
1451
 
        _utf8_encode = self._utf8_encode
1452
 
        _lstat = os.lstat
1453
 
        _listdir = os.listdir
1454
 
        _kind_from_mode = file_kind_from_stat_mode
1455
 
 
1456
 
        if prefix:
1457
 
            relprefix = prefix + '/'
1458
 
        else:
1459
 
            relprefix = ''
1460
 
        top_slash = top + u'/'
1461
 
 
1462
 
        dirblock = []
1463
 
        append = dirblock.append
 
982
        top = currentdir[4]
 
983
        if currentdir[0]:
 
984
            relroot = currentdir[0] + '/'
 
985
        else:
 
986
            relroot = ""
1464
987
        for name in sorted(_listdir(top)):
1465
 
            try:
1466
 
                name_utf8 = _utf8_encode(name)[0]
1467
 
            except UnicodeDecodeError:
1468
 
                raise errors.BadFilenameEncoding(
1469
 
                    _utf8_encode(relprefix)[0] + name, _fs_enc)
1470
 
            abspath = top_slash + name
1471
 
            statvalue = _lstat(abspath)
1472
 
            kind = _kind_from_mode(statvalue.st_mode)
1473
 
            append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
1474
 
        return dirblock
 
988
            abspath = top + '/' + name
 
989
            statvalue = lstat(abspath)
 
990
            dirblock.append((relroot + name, name,
 
991
                file_kind_from_stat_mode(statvalue.st_mode),
 
992
                statvalue, abspath))
 
993
        yield (currentdir[0], top), dirblock
 
994
        # push the user specified dirs from dirblock
 
995
        for dir in reversed(dirblock):
 
996
            if dir[2] == _directory:
 
997
                pending.append(dir)
1475
998
 
1476
999
 
1477
1000
def copy_tree(from_path, to_path, handlers={}):
1478
1001
    """Copy all of the entries in from_path into to_path.
1479
1002
 
1480
 
    :param from_path: The base directory to copy.
 
1003
    :param from_path: The base directory to copy. 
1481
1004
    :param to_path: The target directory. If it does not exist, it will
1482
1005
        be created.
1483
1006
    :param handlers: A dictionary of functions, which takes a source and
1534
1057
_cached_user_encoding = None
1535
1058
 
1536
1059
 
1537
 
def get_user_encoding(use_cache=True):
 
1060
def get_user_encoding():
1538
1061
    """Find out what the preferred user encoding is.
1539
1062
 
1540
1063
    This is generally the encoding that is used for command line parameters
1541
1064
    and file contents. This may be different from the terminal encoding
1542
1065
    or the filesystem encoding.
1543
1066
 
1544
 
    :param  use_cache:  Enable cache for detected encoding.
1545
 
                        (This parameter is turned on by default,
1546
 
                        and required only for selftesting)
1547
 
 
1548
1067
    :return: A string defining the preferred user encoding
1549
1068
    """
1550
1069
    global _cached_user_encoding
1551
 
    if _cached_user_encoding is not None and use_cache:
 
1070
    if _cached_user_encoding is not None:
1552
1071
        return _cached_user_encoding
1553
1072
 
1554
1073
    if sys.platform == 'darwin':
1555
 
        # python locale.getpreferredencoding() always return
1556
 
        # 'mac-roman' on darwin. That's a lie.
 
1074
        # work around egregious python 2.4 bug
1557
1075
        sys.platform = 'posix'
1558
1076
        try:
1559
 
            if os.environ.get('LANG', None) is None:
1560
 
                # If LANG is not set, we end up with 'ascii', which is bad
1561
 
                # ('mac-roman' is more than ascii), so we set a default which
1562
 
                # will give us UTF-8 (which appears to work in all cases on
1563
 
                # OSX). Users are still free to override LANG of course, as
1564
 
                # long as it give us something meaningful. This work-around
1565
 
                # *may* not be needed with python 3k and/or OSX 10.5, but will
1566
 
                # work with them too -- vila 20080908
1567
 
                os.environ['LANG'] = 'en_US.UTF-8'
1568
1077
            import locale
1569
1078
        finally:
1570
1079
            sys.platform = 'darwin'
1572
1081
        import locale
1573
1082
 
1574
1083
    try:
1575
 
        user_encoding = locale.getpreferredencoding()
 
1084
        _cached_user_encoding = locale.getpreferredencoding()
1576
1085
    except locale.Error, e:
1577
1086
        sys.stderr.write('bzr: warning: %s\n'
1578
1087
                         '  Could not determine what text encoding to use.\n'
1580
1089
                         '  doesn\'t support the locale set by $LANG (%s)\n'
1581
1090
                         "  Continuing with ascii encoding.\n"
1582
1091
                         % (e, os.environ.get('LANG')))
1583
 
        user_encoding = 'ascii'
1584
1092
 
1585
1093
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
1586
1094
    # treat that as ASCII, and not support printing unicode characters to the
1587
1095
    # console.
1588
 
    #
1589
 
    # For python scripts run under vim, we get '', so also treat that as ASCII
1590
 
    if user_encoding in (None, 'cp0', ''):
1591
 
        user_encoding = 'ascii'
1592
 
    else:
1593
 
        # check encoding
1594
 
        try:
1595
 
            codecs.lookup(user_encoding)
1596
 
        except LookupError:
1597
 
            sys.stderr.write('bzr: warning:'
1598
 
                             ' unknown encoding %s.'
1599
 
                             ' Continuing with ascii encoding.\n'
1600
 
                             % user_encoding
1601
 
                            )
1602
 
            user_encoding = 'ascii'
1603
 
 
1604
 
    if use_cache:
1605
 
        _cached_user_encoding = user_encoding
1606
 
 
1607
 
    return user_encoding
1608
 
 
1609
 
 
1610
 
def get_host_name():
1611
 
    """Return the current unicode host name.
1612
 
 
1613
 
    This is meant to be used in place of socket.gethostname() because that
1614
 
    behaves inconsistently on different platforms.
1615
 
    """
1616
 
    if sys.platform == "win32":
1617
 
        import win32utils
1618
 
        return win32utils.get_host_name()
1619
 
    else:
1620
 
        import socket
1621
 
        return socket.gethostname().decode(get_user_encoding())
 
1096
    if _cached_user_encoding in (None, 'cp0'):
 
1097
        _cached_user_encoding = 'ascii'
 
1098
    return _cached_user_encoding
1622
1099
 
1623
1100
 
1624
1101
def recv_all(socket, bytes):
1633
1110
    """
1634
1111
    b = ''
1635
1112
    while len(b) < bytes:
1636
 
        new = until_no_eintr(socket.recv, bytes - len(b))
 
1113
        new = socket.recv(bytes - len(b))
1637
1114
        if new == '':
1638
1115
            break # eof
1639
1116
        b += new
1640
1117
    return b
1641
1118
 
1642
 
 
1643
 
def send_all(socket, bytes, report_activity=None):
1644
 
    """Send all bytes on a socket.
1645
 
 
1646
 
    Regular socket.sendall() can give socket error 10053 on Windows.  This
1647
 
    implementation sends no more than 64k at a time, which avoids this problem.
1648
 
 
1649
 
    :param report_activity: Call this as bytes are read, see
1650
 
        Transport._report_activity
1651
 
    """
1652
 
    chunk_size = 2**16
1653
 
    for pos in xrange(0, len(bytes), chunk_size):
1654
 
        block = bytes[pos:pos+chunk_size]
1655
 
        if report_activity is not None:
1656
 
            report_activity(len(block), 'write')
1657
 
        until_no_eintr(socket.sendall, block)
1658
 
 
1659
 
 
1660
1119
def dereference_path(path):
1661
1120
    """Determine the real path to a file.
1662
1121
 
1669
1128
    # The pathjoin for '.' is a workaround for Python bug #1213894.
1670
1129
    # (initial path components aren't dereferenced)
1671
1130
    return pathjoin(realpath(pathjoin('.', parent)), base)
1672
 
 
1673
 
 
1674
 
def supports_mapi():
1675
 
    """Return True if we can use MAPI to launch a mail client."""
1676
 
    return sys.platform == "win32"
1677
 
 
1678
 
 
1679
 
def resource_string(package, resource_name):
1680
 
    """Load a resource from a package and return it as a string.
1681
 
 
1682
 
    Note: Only packages that start with bzrlib are currently supported.
1683
 
 
1684
 
    This is designed to be a lightweight implementation of resource
1685
 
    loading in a way which is API compatible with the same API from
1686
 
    pkg_resources. See
1687
 
    http://peak.telecommunity.com/DevCenter/PkgResources#basic-resource-access.
1688
 
    If and when pkg_resources becomes a standard library, this routine
1689
 
    can delegate to it.
1690
 
    """
1691
 
    # Check package name is within bzrlib
1692
 
    if package == "bzrlib":
1693
 
        resource_relpath = resource_name
1694
 
    elif package.startswith("bzrlib."):
1695
 
        package = package[len("bzrlib."):].replace('.', os.sep)
1696
 
        resource_relpath = pathjoin(package, resource_name)
1697
 
    else:
1698
 
        raise errors.BzrError('resource package %s not in bzrlib' % package)
1699
 
 
1700
 
    # Map the resource to a file and read its contents
1701
 
    base = dirname(bzrlib.__file__)
1702
 
    if getattr(sys, 'frozen', None):    # bzr.exe
1703
 
        base = abspath(pathjoin(base, '..', '..'))
1704
 
    filename = pathjoin(base, resource_relpath)
1705
 
    return open(filename, 'rU').read()
1706
 
 
1707
 
 
1708
 
def file_kind_from_stat_mode_thunk(mode):
1709
 
    global file_kind_from_stat_mode
1710
 
    if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
1711
 
        try:
1712
 
            from bzrlib._readdir_pyx import UTF8DirReader
1713
 
            file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
1714
 
        except ImportError:
1715
 
            from bzrlib._readdir_py import (
1716
 
                _kind_from_mode as file_kind_from_stat_mode
1717
 
                )
1718
 
    return file_kind_from_stat_mode(mode)
1719
 
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
1720
 
 
1721
 
 
1722
 
def file_kind(f, _lstat=os.lstat):
1723
 
    try:
1724
 
        return file_kind_from_stat_mode(_lstat(f).st_mode)
1725
 
    except OSError, e:
1726
 
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
1727
 
            raise errors.NoSuchFile(f)
1728
 
        raise
1729
 
 
1730
 
 
1731
 
def until_no_eintr(f, *a, **kw):
1732
 
    """Run f(*a, **kw), retrying if an EINTR error occurs."""
1733
 
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
1734
 
    while True:
1735
 
        try:
1736
 
            return f(*a, **kw)
1737
 
        except (IOError, OSError), e:
1738
 
            if e.errno == errno.EINTR:
1739
 
                continue
1740
 
            raise
1741
 
 
1742
 
def re_compile_checked(re_string, flags=0, where=""):
1743
 
    """Return a compiled re, or raise a sensible error.
1744
 
    
1745
 
    This should only be used when compiling user-supplied REs.
1746
 
 
1747
 
    :param re_string: Text form of regular expression.
1748
 
    :param flags: eg re.IGNORECASE
1749
 
    :param where: Message explaining to the user the context where 
1750
 
        it occurred, eg 'log search filter'.
1751
 
    """
1752
 
    # from https://bugs.launchpad.net/bzr/+bug/251352
1753
 
    try:
1754
 
        re_obj = re.compile(re_string, flags)
1755
 
        re_obj.search("")
1756
 
        return re_obj
1757
 
    except re.error, e:
1758
 
        if where:
1759
 
            where = ' in ' + where
1760
 
        # despite the name 'error' is a type
1761
 
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
1762
 
            % (where, re_string, e))
1763
 
 
1764
 
 
1765
 
if sys.platform == "win32":
1766
 
    import msvcrt
1767
 
    def getchar():
1768
 
        return msvcrt.getch()
1769
 
else:
1770
 
    import tty
1771
 
    import termios
1772
 
    def getchar():
1773
 
        fd = sys.stdin.fileno()
1774
 
        settings = termios.tcgetattr(fd)
1775
 
        try:
1776
 
            tty.setraw(fd)
1777
 
            ch = sys.stdin.read(1)
1778
 
        finally:
1779
 
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
1780
 
        return ch