← 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: 2007-11-09 19:50:36 UTC
  • mfrom: (2975.2.1 bug-161240)
  • Revision ID: pqm@pqm.ubuntu.com-20071109195036-5o5bwu0a01uniqwg
(robertc) Correct a missing import in the test support ftp server. (Robert Collins, #161240)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/osutils.py
1
 
# Bazaar-NG -- distributed version control
2
 
#
3
 
# Copyright (C) 2005 by Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
4
2
#
5
3
# This program is free software; you can redistribute it and/or modify
6
4
# it under the terms of the GNU General Public License as published by
16
14
# along with this program; if not, write to the Free Software
17
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18
16
 
19
 
from shutil import copyfile
20
 
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
21
 
                  S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
22
17
from cStringIO import StringIO
23
 
import errno
24
18
import os
25
19
import re
26
 
import sha
27
 
import string
 
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)
28
23
import sys
29
24
import time
30
 
import types
 
25
 
 
26
from bzrlib.lazy_import import lazy_import
 
27
lazy_import(globals(), """
 
28
import codecs
 
29
from datetime import datetime
 
30
import errno
 
31
from ntpath import (abspath as _nt_abspath,
 
32
                    join as _nt_join,
 
33
                    normpath as _nt_normpath,
 
34
                    realpath as _nt_realpath,
 
35
                    splitdrive as _nt_splitdrive,
 
36
                    )
 
37
import posixpath
 
38
import sha
 
39
import shutil
 
40
from shutil import (
 
41
    rmtree,
 
42
    )
31
43
import tempfile
 
44
from tempfile import (
 
45
    mkdtemp,
 
46
    )
 
47
import unicodedata
 
48
 
 
49
from bzrlib import (
 
50
    cache_utf8,
 
51
    errors,
 
52
    win32utils,
 
53
    )
 
54
""")
32
55
 
33
56
import bzrlib
34
 
from bzrlib.errors import (BzrError,
35
 
                           BzrBadParameter,
36
 
                           NoSuchFile,
37
 
                           PathNotChild,
38
 
                           )
 
57
from bzrlib import symbol_versioning
 
58
from bzrlib.symbol_versioning import (
 
59
    deprecated_function,
 
60
    zero_ninetythree,
 
61
    )
39
62
from bzrlib.trace import mutter
40
63
 
41
64
 
 
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
 
42
73
def make_readonly(filename):
43
74
    """Make a filename read-only."""
44
 
    mod = os.stat(filename).st_mode
45
 
    mod = mod & 0777555
46
 
    os.chmod(filename, mod)
 
75
    mod = os.lstat(filename).st_mode
 
76
    if not stat.S_ISLNK(mod):
 
77
        mod = mod & 0777555
 
78
        os.chmod(filename, mod)
47
79
 
48
80
 
49
81
def make_writable(filename):
50
 
    mod = os.stat(filename).st_mode
51
 
    mod = mod | 0200
52
 
    os.chmod(filename, mod)
 
82
    mod = os.lstat(filename).st_mode
 
83
    if not stat.S_ISLNK(mod):
 
84
        mod = mod | 0200
 
85
        os.chmod(filename, mod)
 
86
 
 
87
 
 
88
def minimum_path_selection(paths):
 
89
    """Return the smallset subset of paths which are outside paths.
 
90
 
 
91
    :param paths: A container (and hence not None) of paths.
 
92
    :return: A set of paths sufficient to include everything in paths via
 
93
        is_inside_any, drawn from the paths parameter.
 
94
    """
 
95
    search_paths = set()
 
96
    paths = set(paths)
 
97
    for path in paths:
 
98
        other_paths = paths.difference([path])
 
99
        if not is_inside_any(other_paths, path):
 
100
            # this is a top level path, we must check it.
 
101
            search_paths.add(path)
 
102
    return search_paths
53
103
 
54
104
 
55
105
_QUOTE_RE = None
62
112
    Windows."""
63
113
    # TODO: I'm not really sure this is the best format either.x
64
114
    global _QUOTE_RE
65
 
    if _QUOTE_RE == None:
 
115
    if _QUOTE_RE is None:
66
116
        _QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
67
117
        
68
118
    if _QUOTE_RE.search(f):
71
121
        return f
72
122
 
73
123
 
74
 
def file_kind(f):
75
 
    mode = os.lstat(f)[ST_MODE]
76
 
    if S_ISREG(mode):
77
 
        return 'file'
78
 
    elif S_ISDIR(mode):
79
 
        return 'directory'
80
 
    elif S_ISLNK(mode):
81
 
        return 'symlink'
82
 
    elif S_ISCHR(mode):
83
 
        return 'chardev'
84
 
    elif S_ISBLK(mode):
85
 
        return 'block'
86
 
    elif S_ISFIFO(mode):
87
 
        return 'fifo'
88
 
    elif S_ISSOCK(mode):
89
 
        return 'socket'
90
 
    else:
91
 
        return 'unknown'
 
124
_directory_kind = 'directory'
 
125
 
 
126
_formats = {
 
127
    stat.S_IFDIR:_directory_kind,
 
128
    stat.S_IFCHR:'chardev',
 
129
    stat.S_IFBLK:'block',
 
130
    stat.S_IFREG:'file',
 
131
    stat.S_IFIFO:'fifo',
 
132
    stat.S_IFLNK:'symlink',
 
133
    stat.S_IFSOCK:'socket',
 
134
}
 
135
 
 
136
 
 
137
def file_kind_from_stat_mode(stat_mode, _formats=_formats, _unknown='unknown'):
 
138
    """Generate a file kind from a stat mode. This is used in walkdirs.
 
139
 
 
140
    Its performance is critical: Do not mutate without careful benchmarking.
 
141
    """
 
142
    try:
 
143
        return _formats[stat_mode & 0170000]
 
144
    except KeyError:
 
145
        return _unknown
 
146
 
 
147
 
 
148
def file_kind(f, _lstat=os.lstat, _mapper=file_kind_from_stat_mode):
 
149
    try:
 
150
        return _mapper(_lstat(f).st_mode)
 
151
    except OSError, e:
 
152
        if getattr(e, 'errno', None) == errno.ENOENT:
 
153
            raise errors.NoSuchFile(f)
 
154
        raise
 
155
 
 
156
 
 
157
def get_umask():
 
158
    """Return the current umask"""
 
159
    # Assume that people aren't messing with the umask while running
 
160
    # XXX: This is not thread safe, but there is no way to get the
 
161
    #      umask without setting it
 
162
    umask = os.umask(0)
 
163
    os.umask(umask)
 
164
    return umask
 
165
 
 
166
 
 
167
_kind_marker_map = {
 
168
    "file": "",
 
169
    _directory_kind: "/",
 
170
    "symlink": "@",
 
171
    'tree-reference': '+',
 
172
}
92
173
 
93
174
 
94
175
def kind_marker(kind):
95
 
    if kind == 'file':
96
 
        return ''
97
 
    elif kind == 'directory':
98
 
        return '/'
99
 
    elif kind == 'symlink':
100
 
        return '@'
101
 
    else:
102
 
        raise BzrError('invalid file kind %r' % kind)
103
 
 
104
 
def lexists(f):
105
 
    if hasattr(os.path, 'lexists'):
106
 
        return os.path.lexists(f)
107
176
    try:
108
 
        if hasattr(os, 'lstat'):
109
 
            os.lstat(f)
110
 
        else:
111
 
            os.stat(f)
112
 
        return True
113
 
    except OSError,e:
114
 
        if e.errno == errno.ENOENT:
115
 
            return False;
116
 
        else:
117
 
            raise BzrError("lstat/stat of (%r): %r" % (f, e))
 
177
        return _kind_marker_map[kind]
 
178
    except KeyError:
 
179
        raise errors.BzrError('invalid file kind %r' % kind)
 
180
 
 
181
 
 
182
lexists = getattr(os.path, 'lexists', None)
 
183
if lexists is None:
 
184
    def lexists(f):
 
185
        try:
 
186
            stat = getattr(os, 'lstat', os.stat)
 
187
            stat(f)
 
188
            return True
 
189
        except OSError, e:
 
190
            if e.errno == errno.ENOENT:
 
191
                return False;
 
192
            else:
 
193
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
 
194
 
118
195
 
119
196
def fancy_rename(old, new, rename_func, unlink_func):
120
197
    """A fancy rename, when you don't have atomic rename.
129
206
    import random
130
207
    base = os.path.basename(new)
131
208
    dirname = os.path.dirname(new)
132
 
    tmp_name = u'tmp.%s.%.9f.%d.%d' % (base, time.time(), os.getpid(), random.randint(0, 0x7FFFFFFF))
 
209
    tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
133
210
    tmp_name = pathjoin(dirname, tmp_name)
134
211
 
135
212
    # Rename the file out of the way, but keep track if it didn't exist
140
217
    file_existed = False
141
218
    try:
142
219
        rename_func(new, tmp_name)
143
 
    except (NoSuchFile,), e:
 
220
    except (errors.NoSuchFile,), e:
144
221
        pass
145
222
    except IOError, e:
146
223
        # RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
147
 
        # function raises an IOError with errno == None when a rename fails.
 
224
        # function raises an IOError with errno is None when a rename fails.
148
225
        # This then gets caught here.
149
226
        if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
150
227
            raise
151
228
    except Exception, e:
152
 
        if (not hasattr(e, 'errno') 
 
229
        if (getattr(e, 'errno', None) is None
153
230
            or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
154
231
            raise
155
232
    else:
170
247
            else:
171
248
                rename_func(tmp_name, new)
172
249
 
173
 
# Default is to just use the python builtins
174
 
abspath = os.path.abspath
175
 
realpath = os.path.realpath
 
250
 
 
251
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
 
252
# choke on a Unicode string containing a relative path if
 
253
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
 
254
# string.
 
255
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
 
256
def _posix_abspath(path):
 
257
    # jam 20060426 rather than encoding to fsencoding
 
258
    # copy posixpath.abspath, but use os.getcwdu instead
 
259
    if not posixpath.isabs(path):
 
260
        path = posixpath.join(getcwd(), path)
 
261
    return posixpath.normpath(path)
 
262
 
 
263
 
 
264
def _posix_realpath(path):
 
265
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
 
266
 
 
267
 
 
268
def _win32_fixdrive(path):
 
269
    """Force drive letters to be consistent.
 
270
 
 
271
    win32 is inconsistent whether it returns lower or upper case
 
272
    and even if it was consistent the user might type the other
 
273
    so we force it to uppercase
 
274
    running python.exe under cmd.exe return capital C:\\
 
275
    running win32 python inside a cygwin shell returns lowercase c:\\
 
276
    """
 
277
    drive, path = _nt_splitdrive(path)
 
278
    return drive.upper() + path
 
279
 
 
280
 
 
281
def _win32_abspath(path):
 
282
    # Real _nt_abspath doesn't have a problem with a unicode cwd
 
283
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
 
284
 
 
285
 
 
286
def _win98_abspath(path):
 
287
    """Return the absolute version of a path.
 
288
    Windows 98 safe implementation (python reimplementation
 
289
    of Win32 API function GetFullPathNameW)
 
290
    """
 
291
    # Corner cases:
 
292
    #   C:\path     => C:/path
 
293
    #   C:/path     => C:/path
 
294
    #   \\HOST\path => //HOST/path
 
295
    #   //HOST/path => //HOST/path
 
296
    #   path        => C:/cwd/path
 
297
    #   /path       => C:/path
 
298
    path = unicode(path)
 
299
    # check for absolute path
 
300
    drive = _nt_splitdrive(path)[0]
 
301
    if drive == '' and path[:2] not in('//','\\\\'):
 
302
        cwd = os.getcwdu()
 
303
        # we cannot simply os.path.join cwd and path
 
304
        # because os.path.join('C:','/path') produce '/path'
 
305
        # and this is incorrect
 
306
        if path[:1] in ('/','\\'):
 
307
            cwd = _nt_splitdrive(cwd)[0]
 
308
            path = path[1:]
 
309
        path = cwd + '\\' + path
 
310
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
 
311
 
 
312
if win32utils.winver == 'Windows 98':
 
313
    _win32_abspath = _win98_abspath
 
314
 
 
315
 
 
316
def _win32_realpath(path):
 
317
    # Real _nt_realpath doesn't have a problem with a unicode cwd
 
318
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
 
319
 
 
320
 
 
321
def _win32_pathjoin(*args):
 
322
    return _nt_join(*args).replace('\\', '/')
 
323
 
 
324
 
 
325
def _win32_normpath(path):
 
326
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
327
 
 
328
 
 
329
def _win32_getcwd():
 
330
    return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
 
331
 
 
332
 
 
333
def _win32_mkdtemp(*args, **kwargs):
 
334
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
 
335
 
 
336
 
 
337
def _win32_rename(old, new):
 
338
    """We expect to be able to atomically replace 'new' with old.
 
339
 
 
340
    On win32, if new exists, it must be moved out of the way first,
 
341
    and then deleted. 
 
342
    """
 
343
    try:
 
344
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
 
345
    except OSError, e:
 
346
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
 
347
            # If we try to rename a non-existant file onto cwd, we get 
 
348
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT 
 
349
            # if the old path doesn't exist, sometimes we get EACCES
 
350
            # On Linux, we seem to get EBUSY, on Mac we get EINVAL
 
351
            os.lstat(old)
 
352
        raise
 
353
 
 
354
 
 
355
def _mac_getcwd():
 
356
    return unicodedata.normalize('NFKC', os.getcwdu())
 
357
 
 
358
 
 
359
# Default is to just use the python builtins, but these can be rebound on
 
360
# particular platforms.
 
361
abspath = _posix_abspath
 
362
realpath = _posix_realpath
176
363
pathjoin = os.path.join
177
364
normpath = os.path.normpath
178
365
getcwd = os.getcwdu
179
 
mkdtemp = tempfile.mkdtemp
180
366
rename = os.rename
181
367
dirname = os.path.dirname
182
368
basename = os.path.basename
183
 
 
184
 
if os.name == "posix":
185
 
    # In Python 2.4.2 and older, os.path.abspath and os.path.realpath
186
 
    # choke on a Unicode string containing a relative path if
187
 
    # os.getcwd() returns a non-sys.getdefaultencoding()-encoded
188
 
    # string.
189
 
    _fs_enc = sys.getfilesystemencoding()
190
 
    def abspath(path):
191
 
        return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
192
 
 
193
 
    def realpath(path):
194
 
        return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
 
369
split = os.path.split
 
370
splitext = os.path.splitext
 
371
# These were already imported into local scope
 
372
# mkdtemp = tempfile.mkdtemp
 
373
# rmtree = shutil.rmtree
 
374
 
 
375
MIN_ABS_PATHLENGTH = 1
 
376
 
195
377
 
196
378
if sys.platform == 'win32':
197
 
    # We need to use the Unicode-aware os.path.abspath and
198
 
    # os.path.realpath on Windows systems.
199
 
    def abspath(path):
200
 
        return os.path.abspath(path).replace('\\', '/')
201
 
 
202
 
    def realpath(path):
203
 
        return os.path.realpath(path).replace('\\', '/')
204
 
 
205
 
    def pathjoin(*args):
206
 
        return os.path.join(*args).replace('\\', '/')
207
 
 
208
 
    def normpath(path):
209
 
        return os.path.normpath(path).replace('\\', '/')
210
 
 
211
 
    def getcwd():
212
 
        return os.getcwdu().replace('\\', '/')
213
 
 
214
 
    def mkdtemp(*args, **kwargs):
215
 
        return tempfile.mkdtemp(*args, **kwargs).replace('\\', '/')
216
 
 
217
 
    def rename(old, new):
218
 
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
 
379
    abspath = _win32_abspath
 
380
    realpath = _win32_realpath
 
381
    pathjoin = _win32_pathjoin
 
382
    normpath = _win32_normpath
 
383
    getcwd = _win32_getcwd
 
384
    mkdtemp = _win32_mkdtemp
 
385
    rename = _win32_rename
 
386
 
 
387
    MIN_ABS_PATHLENGTH = 3
 
388
 
 
389
    def _win32_delete_readonly(function, path, excinfo):
 
390
        """Error handler for shutil.rmtree function [for win32]
 
391
        Helps to remove files and dirs marked as read-only.
 
392
        """
 
393
        exception = excinfo[1]
 
394
        if function in (os.remove, os.rmdir) \
 
395
            and isinstance(exception, OSError) \
 
396
            and exception.errno == errno.EACCES:
 
397
            make_writable(path)
 
398
            function(path)
 
399
        else:
 
400
            raise
 
401
 
 
402
    def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
 
403
        """Replacer for shutil.rmtree: could remove readonly dirs/files"""
 
404
        return shutil.rmtree(path, ignore_errors, onerror)
 
405
elif sys.platform == 'darwin':
 
406
    getcwd = _mac_getcwd
 
407
 
 
408
 
 
409
def get_terminal_encoding():
 
410
    """Find the best encoding for printing to the screen.
 
411
 
 
412
    This attempts to check both sys.stdout and sys.stdin to see
 
413
    what encoding they are in, and if that fails it falls back to
 
414
    bzrlib.user_encoding.
 
415
    The problem is that on Windows, locale.getpreferredencoding()
 
416
    is not the same encoding as that used by the console:
 
417
    http://mail.python.org/pipermail/python-list/2003-May/162357.html
 
418
 
 
419
    On my standard US Windows XP, the preferred encoding is
 
420
    cp1252, but the console is cp437
 
421
    """
 
422
    output_encoding = getattr(sys.stdout, 'encoding', None)
 
423
    if not output_encoding:
 
424
        input_encoding = getattr(sys.stdin, 'encoding', None)
 
425
        if not input_encoding:
 
426
            output_encoding = bzrlib.user_encoding
 
427
            mutter('encoding stdout as bzrlib.user_encoding %r', output_encoding)
 
428
        else:
 
429
            output_encoding = input_encoding
 
430
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
431
    else:
 
432
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
433
    if output_encoding == 'cp0':
 
434
        # invalid encoding (cp0 means 'no codepage' on Windows)
 
435
        output_encoding = bzrlib.user_encoding
 
436
        mutter('cp0 is invalid encoding.'
 
437
               ' encoding stdout as bzrlib.user_encoding %r', output_encoding)
 
438
    # check encoding
 
439
    try:
 
440
        codecs.lookup(output_encoding)
 
441
    except LookupError:
 
442
        sys.stderr.write('bzr: warning:'
 
443
                         ' unknown terminal encoding %s.\n'
 
444
                         '  Using encoding %s instead.\n'
 
445
                         % (output_encoding, bzrlib.user_encoding)
 
446
                        )
 
447
        output_encoding = bzrlib.user_encoding
 
448
 
 
449
    return output_encoding
219
450
 
220
451
 
221
452
def normalizepath(f):
222
 
    if hasattr(os.path, 'realpath'):
 
453
    if getattr(os.path, 'realpath', None) is not None:
223
454
        F = realpath
224
455
    else:
225
456
        F = abspath
230
461
        return pathjoin(F(p), e)
231
462
 
232
463
 
 
464
@deprecated_function(zero_ninetythree)
233
465
def backup_file(fn):
234
466
    """Copy a file to a backup.
235
467
 
289
521
    
290
522
    The empty string as a dir name is taken as top-of-tree and matches 
291
523
    everything.
292
 
    
293
 
    >>> is_inside('src', pathjoin('src', 'foo.c'))
294
 
    True
295
 
    >>> is_inside('src', 'srccontrol')
296
 
    False
297
 
    >>> is_inside('src', pathjoin('src', 'a', 'a', 'a', 'foo.c'))
298
 
    True
299
 
    >>> is_inside('foo.c', 'foo.c')
300
 
    True
301
 
    >>> is_inside('foo.c', '')
302
 
    False
303
 
    >>> is_inside('', 'foo.c')
304
 
    True
305
524
    """
306
525
    # XXX: Most callers of this can actually do something smarter by 
307
526
    # looking at the inventory
322
541
    for dirname in dir_list:
323
542
        if is_inside(dirname, fname):
324
543
            return True
325
 
    else:
326
 
        return False
 
544
    return False
 
545
 
 
546
 
 
547
def is_inside_or_parent_of_any(dir_list, fname):
 
548
    """True if fname is a child or a parent of any of the given files."""
 
549
    for dirname in dir_list:
 
550
        if is_inside(dirname, fname) or is_inside(fname, dirname):
 
551
            return True
 
552
    return False
327
553
 
328
554
 
329
555
def pumpfile(fromfile, tofile):
330
 
    """Copy contents of one file to another."""
 
556
    """Copy contents of one file to another.
 
557
    
 
558
    :return: The number of bytes copied.
 
559
    """
331
560
    BUFSIZE = 32768
 
561
    length = 0
332
562
    while True:
333
563
        b = fromfile.read(BUFSIZE)
334
564
        if not b:
335
565
            break
336
566
        tofile.write(b)
 
567
        length += len(b)
 
568
    return length
 
569
 
 
570
 
 
571
def file_iterator(input_file, readsize=32768):
 
572
    while True:
 
573
        b = input_file.read(readsize)
 
574
        if len(b) == 0:
 
575
            break
 
576
        yield b
337
577
 
338
578
 
339
579
def sha_file(f):
340
 
    if hasattr(f, 'tell'):
 
580
    if getattr(f, 'tell', None) is not None:
341
581
        assert f.tell() == 0
342
582
    s = sha.new()
343
583
    BUFSIZE = 128<<10
349
589
    return s.hexdigest()
350
590
 
351
591
 
352
 
 
353
 
def sha_strings(strings):
 
592
def sha_file_by_name(fname):
 
593
    """Calculate the SHA1 of a file by reading the full text"""
 
594
    s = sha.new()
 
595
    f = os.open(fname, os.O_RDONLY | O_BINARY)
 
596
    try:
 
597
        while True:
 
598
            b = os.read(f, 1<<16)
 
599
            if not b:
 
600
                return s.hexdigest()
 
601
            s.update(b)
 
602
    finally:
 
603
        os.close(f)
 
604
 
 
605
 
 
606
def sha_strings(strings, _factory=sha.new):
354
607
    """Return the sha-1 of concatenation of strings"""
355
 
    s = sha.new()
 
608
    s = _factory()
356
609
    map(s.update, strings)
357
610
    return s.hexdigest()
358
611
 
359
612
 
360
 
def sha_string(f):
361
 
    s = sha.new()
362
 
    s.update(f)
363
 
    return s.hexdigest()
 
613
def sha_string(f, _factory=sha.new):
 
614
    return _factory(f).hexdigest()
364
615
 
365
616
 
366
617
def fingerprint_file(f):
367
 
    s = sha.new()
368
618
    b = f.read()
369
 
    s.update(b)
370
 
    size = len(b)
371
 
    return {'size': size,
372
 
            'sha1': s.hexdigest()}
 
619
    return {'size': len(b),
 
620
            'sha1': sha.new(b).hexdigest()}
373
621
 
374
622
 
375
623
def compare_files(a, b):
386
634
 
387
635
def local_time_offset(t=None):
388
636
    """Return offset of local zone from GMT, either at present or at time t."""
389
 
    # python2.3 localtime() can't take None
390
 
    if t == None:
 
637
    if t is None:
391
638
        t = time.time()
392
 
        
393
 
    if time.localtime(t).tm_isdst and time.daylight:
394
 
        return -time.altzone
395
 
    else:
396
 
        return -time.timezone
 
639
    offset = datetime.fromtimestamp(t) - datetime.utcfromtimestamp(t)
 
640
    return offset.days * 86400 + offset.seconds
397
641
 
398
642
    
399
 
def format_date(t, offset=0, timezone='original', date_fmt=None, 
 
643
def format_date(t, offset=0, timezone='original', date_fmt=None,
400
644
                show_offset=True):
401
 
    ## TODO: Perhaps a global option to use either universal or local time?
402
 
    ## Or perhaps just let people set $TZ?
403
 
    assert isinstance(t, float)
404
 
    
 
645
    """Return a formatted date string.
 
646
 
 
647
    :param t: Seconds since the epoch.
 
648
    :param offset: Timezone offset in seconds east of utc.
 
649
    :param timezone: How to display the time: 'utc', 'original' for the
 
650
         timezone specified by offset, or 'local' for the process's current
 
651
         timezone.
 
652
    :param show_offset: Whether to append the timezone.
 
653
    :param date_fmt: strftime format.
 
654
    """
405
655
    if timezone == 'utc':
406
656
        tt = time.gmtime(t)
407
657
        offset = 0
408
658
    elif timezone == 'original':
409
 
        if offset == None:
 
659
        if offset is None:
410
660
            offset = 0
411
661
        tt = time.gmtime(t + offset)
412
662
    elif timezone == 'local':
413
663
        tt = time.localtime(t)
414
664
        offset = local_time_offset(t)
415
665
    else:
416
 
        raise BzrError("unsupported timezone format %r" % timezone,
417
 
                       ['options are "utc", "original", "local"'])
 
666
        raise errors.BzrError("unsupported timezone format %r" % timezone,
 
667
                              ['options are "utc", "original", "local"'])
418
668
    if date_fmt is None:
419
669
        date_fmt = "%a %Y-%m-%d %H:%M:%S"
420
670
    if show_offset:
428
678
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
429
679
    
430
680
 
 
681
def format_delta(delta):
 
682
    """Get a nice looking string for a time delta.
 
683
 
 
684
    :param delta: The time difference in seconds, can be positive or negative.
 
685
        positive indicates time in the past, negative indicates time in the
 
686
        future. (usually time.time() - stored_time)
 
687
    :return: String formatted to show approximate resolution
 
688
    """
 
689
    delta = int(delta)
 
690
    if delta >= 0:
 
691
        direction = 'ago'
 
692
    else:
 
693
        direction = 'in the future'
 
694
        delta = -delta
 
695
 
 
696
    seconds = delta
 
697
    if seconds < 90: # print seconds up to 90 seconds
 
698
        if seconds == 1:
 
699
            return '%d second %s' % (seconds, direction,)
 
700
        else:
 
701
            return '%d seconds %s' % (seconds, direction)
 
702
 
 
703
    minutes = int(seconds / 60)
 
704
    seconds -= 60 * minutes
 
705
    if seconds == 1:
 
706
        plural_seconds = ''
 
707
    else:
 
708
        plural_seconds = 's'
 
709
    if minutes < 90: # print minutes, seconds up to 90 minutes
 
710
        if minutes == 1:
 
711
            return '%d minute, %d second%s %s' % (
 
712
                    minutes, seconds, plural_seconds, direction)
 
713
        else:
 
714
            return '%d minutes, %d second%s %s' % (
 
715
                    minutes, seconds, plural_seconds, direction)
 
716
 
 
717
    hours = int(minutes / 60)
 
718
    minutes -= 60 * hours
 
719
    if minutes == 1:
 
720
        plural_minutes = ''
 
721
    else:
 
722
        plural_minutes = 's'
 
723
 
 
724
    if hours == 1:
 
725
        return '%d hour, %d minute%s %s' % (hours, minutes,
 
726
                                            plural_minutes, direction)
 
727
    return '%d hours, %d minute%s %s' % (hours, minutes,
 
728
                                         plural_minutes, direction)
431
729
 
432
730
def filesize(f):
433
731
    """Return size of given open file."""
434
732
    return os.fstat(f.fileno())[ST_SIZE]
435
733
 
 
734
 
436
735
# Define rand_bytes based on platform.
437
736
try:
438
737
    # Python 2.4 and later have os.urandom,
442
741
except (NotImplementedError, AttributeError):
443
742
    # If python doesn't have os.urandom, or it doesn't work,
444
743
    # then try to first pull random data from /dev/urandom
445
 
    if os.path.exists("/dev/urandom"):
 
744
    try:
446
745
        rand_bytes = file('/dev/urandom', 'rb').read
447
746
    # Otherwise, use this hack as a last resort
448
 
    else:
 
747
    except (IOError, OSError):
449
748
        # not well seeded, but better than nothing
450
749
        def rand_bytes(n):
451
750
            import random
455
754
                n -= 1
456
755
            return s
457
756
 
 
757
 
 
758
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
 
759
def rand_chars(num):
 
760
    """Return a random string of num alphanumeric characters
 
761
    
 
762
    The result only contains lowercase chars because it may be used on 
 
763
    case-insensitive filesystems.
 
764
    """
 
765
    s = ''
 
766
    for raw_byte in rand_bytes(num):
 
767
        s += ALNUM[ord(raw_byte) % 36]
 
768
    return s
 
769
 
 
770
 
458
771
## TODO: We could later have path objects that remember their list
459
772
## decomposition (might be too tricksy though.)
460
773
 
461
774
def splitpath(p):
462
 
    """Turn string into list of parts.
463
 
 
464
 
    >>> splitpath('a')
465
 
    ['a']
466
 
    >>> splitpath('a/b')
467
 
    ['a', 'b']
468
 
    >>> splitpath('a/./b')
469
 
    ['a', 'b']
470
 
    >>> splitpath('a/.b')
471
 
    ['a', '.b']
472
 
    >>> splitpath('a/../b')
473
 
    Traceback (most recent call last):
474
 
    ...
475
 
    BzrError: sorry, '..' not allowed in path
476
 
    """
477
 
    assert isinstance(p, types.StringTypes)
 
775
    """Turn string into list of parts."""
 
776
    assert isinstance(p, basestring)
478
777
 
479
778
    # split on either delimiter because people might use either on
480
779
    # Windows
483
782
    rps = []
484
783
    for f in ps:
485
784
        if f == '..':
486
 
            raise BzrError("sorry, %r not allowed in path" % f)
 
785
            raise errors.BzrError("sorry, %r not allowed in path" % f)
487
786
        elif (f == '.') or (f == ''):
488
787
            pass
489
788
        else:
491
790
    return rps
492
791
 
493
792
def joinpath(p):
494
 
    assert isinstance(p, list)
 
793
    assert isinstance(p, (list, tuple))
495
794
    for f in p:
496
 
        if (f == '..') or (f == None) or (f == ''):
497
 
            raise BzrError("sorry, %r not allowed in path" % f)
 
795
        if (f == '..') or (f is None) or (f == ''):
 
796
            raise errors.BzrError("sorry, %r not allowed in path" % f)
498
797
    return pathjoin(*p)
499
798
 
500
799
 
501
 
def appendpath(p1, p2):
502
 
    if p1 == '':
503
 
        return p2
504
 
    else:
505
 
        return pathjoin(p1, p2)
506
 
    
507
 
 
508
800
def split_lines(s):
509
801
    """Split s into lines, but without removing the newline characters."""
510
 
    return StringIO(s).readlines()
 
802
    lines = s.split('\n')
 
803
    result = [line + '\n' for line in lines[:-1]]
 
804
    if lines[-1]:
 
805
        result.append(lines[-1])
 
806
    return result
511
807
 
512
808
 
513
809
def hardlinks_good():
517
813
def link_or_copy(src, dest):
518
814
    """Hardlink a file, or copy it if it can't be hardlinked."""
519
815
    if not hardlinks_good():
520
 
        copyfile(src, dest)
 
816
        shutil.copyfile(src, dest)
521
817
        return
522
818
    try:
523
819
        os.link(src, dest)
524
820
    except (OSError, IOError), e:
525
821
        if e.errno != errno.EXDEV:
526
822
            raise
527
 
        copyfile(src, dest)
 
823
        shutil.copyfile(src, dest)
 
824
 
 
825
 
 
826
# Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
 
827
# Forgiveness than Permission (EAFP) because:
 
828
# - root can damage a solaris file system by using unlink,
 
829
# - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
 
830
#   EACCES, OSX: EPERM) when invoked on a directory.
 
831
def delete_any(path):
 
832
    """Delete a file or directory."""
 
833
    if isdir(path): # Takes care of symlinks
 
834
        os.rmdir(path)
 
835
    else:
 
836
        os.unlink(path)
528
837
 
529
838
 
530
839
def has_symlinks():
531
 
    if hasattr(os, 'symlink'):
 
840
    if getattr(os, 'symlink', None) is not None:
532
841
        return True
533
842
    else:
534
843
        return False
535
 
        
 
844
 
536
845
 
537
846
def contains_whitespace(s):
538
847
    """True if there are any whitespace characters in s."""
539
 
    for ch in string.whitespace:
 
848
    # string.whitespace can include '\xa0' in certain locales, because it is
 
849
    # considered "non-breaking-space" as part of ISO-8859-1. But it
 
850
    # 1) Isn't a breaking whitespace
 
851
    # 2) Isn't one of ' \t\r\n' which are characters we sometimes use as
 
852
    #    separators
 
853
    # 3) '\xa0' isn't unicode safe since it is >128.
 
854
 
 
855
    # This should *not* be a unicode set of characters in case the source
 
856
    # string is not a Unicode string. We can auto-up-cast the characters since
 
857
    # they are ascii, but we don't want to auto-up-cast the string in case it
 
858
    # is utf-8
 
859
    for ch in ' \t\n\r\v\f':
540
860
        if ch in s:
541
861
            return True
542
862
    else:
560
880
 
561
881
    os.path.commonprefix (python2.4) has a bad bug that it works just
562
882
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
563
 
    avoids that problem."""
 
883
    avoids that problem.
 
884
    """
 
885
 
 
886
    assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
 
887
        ' exceed the platform minimum length (which is %d)' % 
 
888
        MIN_ABS_PATHLENGTH)
 
889
 
564
890
    rp = abspath(path)
565
891
 
566
892
    s = []
572
898
        if tail:
573
899
            s.insert(0, tail)
574
900
    else:
575
 
        # XXX This should raise a NotChildPath exception, as its not tied
576
 
        # to branch anymore.
577
 
        raise PathNotChild(rp, base)
 
901
        raise errors.PathNotChild(rp, base)
578
902
 
579
903
    if s:
580
904
        return pathjoin(*s)
595
919
    try:
596
920
        return unicode_or_utf8_string.decode('utf8')
597
921
    except UnicodeDecodeError:
598
 
        raise BzrBadParameter(unicode_or_utf8_string)
 
922
        raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
 
923
 
 
924
 
 
925
def safe_utf8(unicode_or_utf8_string):
 
926
    """Coerce unicode_or_utf8_string to a utf8 string.
 
927
 
 
928
    If it is a str, it is returned.
 
929
    If it is Unicode, it is encoded into a utf-8 string.
 
930
    """
 
931
    if isinstance(unicode_or_utf8_string, str):
 
932
        # TODO: jam 20070209 This is overkill, and probably has an impact on
 
933
        #       performance if we are dealing with lots of apis that want a
 
934
        #       utf-8 revision id
 
935
        try:
 
936
            # Make sure it is a valid utf-8 string
 
937
            unicode_or_utf8_string.decode('utf-8')
 
938
        except UnicodeDecodeError:
 
939
            raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
 
940
        return unicode_or_utf8_string
 
941
    return unicode_or_utf8_string.encode('utf-8')
 
942
 
 
943
 
 
944
_revision_id_warning = ('Unicode revision ids were deprecated in bzr 0.15.'
 
945
                        ' Revision id generators should be creating utf8'
 
946
                        ' revision ids.')
 
947
 
 
948
 
 
949
def safe_revision_id(unicode_or_utf8_string, warn=True):
 
950
    """Revision ids should now be utf8, but at one point they were unicode.
 
951
 
 
952
    :param unicode_or_utf8_string: A possibly Unicode revision_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 revision 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(_revision_id_warning, DeprecationWarning,
 
962
                               stacklevel=2)
 
963
    return cache_utf8.encode(unicode_or_utf8_string)
 
964
 
 
965
 
 
966
_file_id_warning = ('Unicode file ids were deprecated in bzr 0.15. File id'
 
967
                    ' generators should be creating utf8 file ids.')
 
968
 
 
969
 
 
970
def safe_file_id(unicode_or_utf8_string, warn=True):
 
971
    """File ids should now be utf8, but at one point they were unicode.
 
972
 
 
973
    This is the same as safe_utf8, except it uses the cached encode functions
 
974
    to save a little bit of performance.
 
975
 
 
976
    :param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
 
977
        utf8 or None).
 
978
    :param warn: Functions that are sanitizing user data can set warn=False
 
979
    :return: None or a utf8 file id.
 
980
    """
 
981
    if (unicode_or_utf8_string is None
 
982
        or unicode_or_utf8_string.__class__ == str):
 
983
        return unicode_or_utf8_string
 
984
    if warn:
 
985
        symbol_versioning.warn(_file_id_warning, DeprecationWarning,
 
986
                               stacklevel=2)
 
987
    return cache_utf8.encode(unicode_or_utf8_string)
 
988
 
 
989
 
 
990
_platform_normalizes_filenames = False
 
991
if sys.platform == 'darwin':
 
992
    _platform_normalizes_filenames = True
 
993
 
 
994
 
 
995
def normalizes_filenames():
 
996
    """Return True if this platform normalizes unicode filenames.
 
997
 
 
998
    Mac OSX does, Windows/Linux do not.
 
999
    """
 
1000
    return _platform_normalizes_filenames
 
1001
 
 
1002
 
 
1003
def _accessible_normalized_filename(path):
 
1004
    """Get the unicode normalized path, and if you can access the file.
 
1005
 
 
1006
    On platforms where the system normalizes filenames (Mac OSX),
 
1007
    you can access a file by any path which will normalize correctly.
 
1008
    On platforms where the system does not normalize filenames 
 
1009
    (Windows, Linux), you have to access a file by its exact path.
 
1010
 
 
1011
    Internally, bzr only supports NFC/NFKC normalization, since that is 
 
1012
    the standard for XML documents.
 
1013
 
 
1014
    So return the normalized path, and a flag indicating if the file
 
1015
    can be accessed by that path.
 
1016
    """
 
1017
 
 
1018
    return unicodedata.normalize('NFKC', unicode(path)), True
 
1019
 
 
1020
 
 
1021
def _inaccessible_normalized_filename(path):
 
1022
    __doc__ = _accessible_normalized_filename.__doc__
 
1023
 
 
1024
    normalized = unicodedata.normalize('NFKC', unicode(path))
 
1025
    return normalized, normalized == path
 
1026
 
 
1027
 
 
1028
if _platform_normalizes_filenames:
 
1029
    normalized_filename = _accessible_normalized_filename
 
1030
else:
 
1031
    normalized_filename = _inaccessible_normalized_filename
599
1032
 
600
1033
 
601
1034
def terminal_width():
602
1035
    """Return estimated terminal width."""
603
 
 
604
 
    # TODO: Do something smart on Windows?
605
 
 
606
 
    # TODO: Is there anything that gets a better update when the window
607
 
    # is resized while the program is running? We could use the Python termcap
608
 
    # library.
609
 
    try:
610
 
        return int(os.environ['COLUMNS'])
611
 
    except (IndexError, KeyError, ValueError):
612
 
        return 80
 
1036
    if sys.platform == 'win32':
 
1037
        return win32utils.get_console_size()[0]
 
1038
    width = 0
 
1039
    try:
 
1040
        import struct, fcntl, termios
 
1041
        s = struct.pack('HHHH', 0, 0, 0, 0)
 
1042
        x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
 
1043
        width = struct.unpack('HHHH', x)[1]
 
1044
    except IOError:
 
1045
        pass
 
1046
    if width <= 0:
 
1047
        try:
 
1048
            width = int(os.environ['COLUMNS'])
 
1049
        except:
 
1050
            pass
 
1051
    if width <= 0:
 
1052
        width = 80
 
1053
 
 
1054
    return width
 
1055
 
 
1056
 
 
1057
def supports_executable():
 
1058
    return sys.platform != "win32"
 
1059
 
 
1060
 
 
1061
def supports_posix_readonly():
 
1062
    """Return True if 'readonly' has POSIX semantics, False otherwise.
 
1063
 
 
1064
    Notably, a win32 readonly file cannot be deleted, unlike POSIX where the
 
1065
    directory controls creation/deletion, etc.
 
1066
 
 
1067
    And under win32, readonly means that the directory itself cannot be
 
1068
    deleted.  The contents of a readonly directory can be changed, unlike POSIX
 
1069
    where files in readonly directories cannot be added, deleted or renamed.
 
1070
    """
 
1071
    return sys.platform != "win32"
 
1072
 
 
1073
 
 
1074
def set_or_unset_env(env_variable, value):
 
1075
    """Modify the environment, setting or removing the env_variable.
 
1076
 
 
1077
    :param env_variable: The environment variable in question
 
1078
    :param value: The value to set the environment to. If None, then
 
1079
        the variable will be removed.
 
1080
    :return: The original value of the environment variable.
 
1081
    """
 
1082
    orig_val = os.environ.get(env_variable)
 
1083
    if value is None:
 
1084
        if orig_val is not None:
 
1085
            del os.environ[env_variable]
 
1086
    else:
 
1087
        if isinstance(value, unicode):
 
1088
            value = value.encode(bzrlib.user_encoding)
 
1089
        os.environ[env_variable] = value
 
1090
    return orig_val
 
1091
 
 
1092
 
 
1093
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
 
1094
 
 
1095
 
 
1096
def check_legal_path(path):
 
1097
    """Check whether the supplied path is legal.  
 
1098
    This is only required on Windows, so we don't test on other platforms
 
1099
    right now.
 
1100
    """
 
1101
    if sys.platform != "win32":
 
1102
        return
 
1103
    if _validWin32PathRE.match(path) is None:
 
1104
        raise errors.IllegalPath(path)
 
1105
 
 
1106
 
 
1107
def walkdirs(top, prefix=""):
 
1108
    """Yield data about all the directories in a tree.
 
1109
    
 
1110
    This yields all the data about the contents of a directory at a time.
 
1111
    After each directory has been yielded, if the caller has mutated the list
 
1112
    to exclude some directories, they are then not descended into.
 
1113
    
 
1114
    The data yielded is of the form:
 
1115
    ((directory-relpath, directory-path-from-top),
 
1116
    [(relpath, basename, kind, lstat, path-from-top), ...]),
 
1117
     - directory-relpath is the relative path of the directory being returned
 
1118
       with respect to top. prefix is prepended to this.
 
1119
     - directory-path-from-root is the path including top for this directory. 
 
1120
       It is suitable for use with os functions.
 
1121
     - relpath is the relative path within the subtree being walked.
 
1122
     - basename is the basename of the path
 
1123
     - kind is the kind of the file now. If unknown then the file is not
 
1124
       present within the tree - but it may be recorded as versioned. See
 
1125
       versioned_kind.
 
1126
     - lstat is the stat data *if* the file was statted.
 
1127
     - planned, not implemented: 
 
1128
       path_from_tree_root is the path from the root of the tree.
 
1129
 
 
1130
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This 
 
1131
        allows one to walk a subtree but get paths that are relative to a tree
 
1132
        rooted higher up.
 
1133
    :return: an iterator over the dirs.
 
1134
    """
 
1135
    #TODO there is a bit of a smell where the results of the directory-
 
1136
    # summary in this, and the path from the root, may not agree 
 
1137
    # depending on top and prefix - i.e. ./foo and foo as a pair leads to
 
1138
    # potentially confusing output. We should make this more robust - but
 
1139
    # not at a speed cost. RBC 20060731
 
1140
    _lstat = os.lstat
 
1141
    _directory = _directory_kind
 
1142
    _listdir = os.listdir
 
1143
    _kind_from_mode = _formats.get
 
1144
    pending = [(safe_unicode(prefix), "", _directory, None, safe_unicode(top))]
 
1145
    while pending:
 
1146
        # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
 
1147
        relroot, _, _, _, top = pending.pop()
 
1148
        if relroot:
 
1149
            relprefix = relroot + u'/'
 
1150
        else:
 
1151
            relprefix = ''
 
1152
        top_slash = top + u'/'
 
1153
 
 
1154
        dirblock = []
 
1155
        append = dirblock.append
 
1156
        for name in sorted(_listdir(top)):
 
1157
            abspath = top_slash + name
 
1158
            statvalue = _lstat(abspath)
 
1159
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
 
1160
            append((relprefix + name, name, kind, statvalue, abspath))
 
1161
        yield (relroot, top), dirblock
 
1162
 
 
1163
        # push the user specified dirs from dirblock
 
1164
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
 
1165
 
 
1166
 
 
1167
def _walkdirs_utf8(top, prefix=""):
 
1168
    """Yield data about all the directories in a tree.
 
1169
 
 
1170
    This yields the same information as walkdirs() only each entry is yielded
 
1171
    in utf-8. On platforms which have a filesystem encoding of utf8 the paths
 
1172
    are returned as exact byte-strings.
 
1173
 
 
1174
    :return: yields a tuple of (dir_info, [file_info])
 
1175
        dir_info is (utf8_relpath, path-from-top)
 
1176
        file_info is (utf8_relpath, utf8_name, kind, lstat, path-from-top)
 
1177
        if top is an absolute path, path-from-top is also an absolute path.
 
1178
        path-from-top might be unicode or utf8, but it is the correct path to
 
1179
        pass to os functions to affect the file in question. (such as os.lstat)
 
1180
    """
 
1181
    fs_encoding = _fs_enc.upper()
 
1182
    if (sys.platform == 'win32' or
 
1183
        fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968')): # ascii
 
1184
        return _walkdirs_unicode_to_utf8(top, prefix=prefix)
 
1185
    else:
 
1186
        return _walkdirs_fs_utf8(top, prefix=prefix)
 
1187
 
 
1188
 
 
1189
def _walkdirs_fs_utf8(top, prefix=""):
 
1190
    """See _walkdirs_utf8.
 
1191
 
 
1192
    This sub-function is called when we know the filesystem is already in utf8
 
1193
    encoding. So we don't need to transcode filenames.
 
1194
    """
 
1195
    _lstat = os.lstat
 
1196
    _directory = _directory_kind
 
1197
    _listdir = os.listdir
 
1198
    _kind_from_mode = _formats.get
 
1199
 
 
1200
    # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
 
1201
    # But we don't actually uses 1-3 in pending, so set them to None
 
1202
    pending = [(safe_utf8(prefix), None, None, None, safe_utf8(top))]
 
1203
    while pending:
 
1204
        relroot, _, _, _, top = pending.pop()
 
1205
        if relroot:
 
1206
            relprefix = relroot + '/'
 
1207
        else:
 
1208
            relprefix = ''
 
1209
        top_slash = top + '/'
 
1210
 
 
1211
        dirblock = []
 
1212
        append = dirblock.append
 
1213
        for name in sorted(_listdir(top)):
 
1214
            abspath = top_slash + name
 
1215
            statvalue = _lstat(abspath)
 
1216
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
 
1217
            append((relprefix + name, name, kind, statvalue, abspath))
 
1218
        yield (relroot, top), dirblock
 
1219
 
 
1220
        # push the user specified dirs from dirblock
 
1221
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
 
1222
 
 
1223
 
 
1224
def _walkdirs_unicode_to_utf8(top, prefix=""):
 
1225
    """See _walkdirs_utf8
 
1226
 
 
1227
    Because Win32 has a Unicode api, all of the 'path-from-top' entries will be
 
1228
    Unicode paths.
 
1229
    This is currently the fallback code path when the filesystem encoding is
 
1230
    not UTF-8. It may be better to implement an alternative so that we can
 
1231
    safely handle paths that are not properly decodable in the current
 
1232
    encoding.
 
1233
    """
 
1234
    _utf8_encode = codecs.getencoder('utf8')
 
1235
    _lstat = os.lstat
 
1236
    _directory = _directory_kind
 
1237
    _listdir = os.listdir
 
1238
    _kind_from_mode = _formats.get
 
1239
 
 
1240
    pending = [(safe_utf8(prefix), None, None, None, safe_unicode(top))]
 
1241
    while pending:
 
1242
        relroot, _, _, _, top = pending.pop()
 
1243
        if relroot:
 
1244
            relprefix = relroot + '/'
 
1245
        else:
 
1246
            relprefix = ''
 
1247
        top_slash = top + u'/'
 
1248
 
 
1249
        dirblock = []
 
1250
        append = dirblock.append
 
1251
        for name in sorted(_listdir(top)):
 
1252
            name_utf8 = _utf8_encode(name)[0]
 
1253
            abspath = top_slash + name
 
1254
            statvalue = _lstat(abspath)
 
1255
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
 
1256
            append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
 
1257
        yield (relroot, top), dirblock
 
1258
 
 
1259
        # push the user specified dirs from dirblock
 
1260
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
 
1261
 
 
1262
 
 
1263
def copy_tree(from_path, to_path, handlers={}):
 
1264
    """Copy all of the entries in from_path into to_path.
 
1265
 
 
1266
    :param from_path: The base directory to copy. 
 
1267
    :param to_path: The target directory. If it does not exist, it will
 
1268
        be created.
 
1269
    :param handlers: A dictionary of functions, which takes a source and
 
1270
        destinations for files, directories, etc.
 
1271
        It is keyed on the file kind, such as 'directory', 'symlink', or 'file'
 
1272
        'file', 'directory', and 'symlink' should always exist.
 
1273
        If they are missing, they will be replaced with 'os.mkdir()',
 
1274
        'os.readlink() + os.symlink()', and 'shutil.copy2()', respectively.
 
1275
    """
 
1276
    # Now, just copy the existing cached tree to the new location
 
1277
    # We use a cheap trick here.
 
1278
    # Absolute paths are prefixed with the first parameter
 
1279
    # relative paths are prefixed with the second.
 
1280
    # So we can get both the source and target returned
 
1281
    # without any extra work.
 
1282
 
 
1283
    def copy_dir(source, dest):
 
1284
        os.mkdir(dest)
 
1285
 
 
1286
    def copy_link(source, dest):
 
1287
        """Copy the contents of a symlink"""
 
1288
        link_to = os.readlink(source)
 
1289
        os.symlink(link_to, dest)
 
1290
 
 
1291
    real_handlers = {'file':shutil.copy2,
 
1292
                     'symlink':copy_link,
 
1293
                     'directory':copy_dir,
 
1294
                    }
 
1295
    real_handlers.update(handlers)
 
1296
 
 
1297
    if not os.path.exists(to_path):
 
1298
        real_handlers['directory'](from_path, to_path)
 
1299
 
 
1300
    for dir_info, entries in walkdirs(from_path, prefix=to_path):
 
1301
        for relpath, name, kind, st, abspath in entries:
 
1302
            real_handlers[kind](abspath, relpath)
 
1303
 
 
1304
 
 
1305
def path_prefix_key(path):
 
1306
    """Generate a prefix-order path key for path.
 
1307
 
 
1308
    This can be used to sort paths in the same way that walkdirs does.
 
1309
    """
 
1310
    return (dirname(path) , path)
 
1311
 
 
1312
 
 
1313
def compare_paths_prefix_order(path_a, path_b):
 
1314
    """Compare path_a and path_b to generate the same order walkdirs uses."""
 
1315
    key_a = path_prefix_key(path_a)
 
1316
    key_b = path_prefix_key(path_b)
 
1317
    return cmp(key_a, key_b)
 
1318
 
 
1319
 
 
1320
_cached_user_encoding = None
 
1321
 
 
1322
 
 
1323
def get_user_encoding(use_cache=True):
 
1324
    """Find out what the preferred user encoding is.
 
1325
 
 
1326
    This is generally the encoding that is used for command line parameters
 
1327
    and file contents. This may be different from the terminal encoding
 
1328
    or the filesystem encoding.
 
1329
 
 
1330
    :param  use_cache:  Enable cache for detected encoding.
 
1331
                        (This parameter is turned on by default,
 
1332
                        and required only for selftesting)
 
1333
 
 
1334
    :return: A string defining the preferred user encoding
 
1335
    """
 
1336
    global _cached_user_encoding
 
1337
    if _cached_user_encoding is not None and use_cache:
 
1338
        return _cached_user_encoding
 
1339
 
 
1340
    if sys.platform == 'darwin':
 
1341
        # work around egregious python 2.4 bug
 
1342
        sys.platform = 'posix'
 
1343
        try:
 
1344
            import locale
 
1345
        finally:
 
1346
            sys.platform = 'darwin'
 
1347
    else:
 
1348
        import locale
 
1349
 
 
1350
    try:
 
1351
        user_encoding = locale.getpreferredencoding()
 
1352
    except locale.Error, e:
 
1353
        sys.stderr.write('bzr: warning: %s\n'
 
1354
                         '  Could not determine what text encoding to use.\n'
 
1355
                         '  This error usually means your Python interpreter\n'
 
1356
                         '  doesn\'t support the locale set by $LANG (%s)\n'
 
1357
                         "  Continuing with ascii encoding.\n"
 
1358
                         % (e, os.environ.get('LANG')))
 
1359
        user_encoding = 'ascii'
 
1360
 
 
1361
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
 
1362
    # treat that as ASCII, and not support printing unicode characters to the
 
1363
    # console.
 
1364
    if user_encoding in (None, 'cp0'):
 
1365
        user_encoding = 'ascii'
 
1366
    else:
 
1367
        # check encoding
 
1368
        try:
 
1369
            codecs.lookup(user_encoding)
 
1370
        except LookupError:
 
1371
            sys.stderr.write('bzr: warning:'
 
1372
                             ' unknown encoding %s.'
 
1373
                             ' Continuing with ascii encoding.\n'
 
1374
                             % user_encoding
 
1375
                            )
 
1376
            user_encoding = 'ascii'
 
1377
 
 
1378
    if use_cache:
 
1379
        _cached_user_encoding = user_encoding
 
1380
 
 
1381
    return user_encoding
 
1382
 
 
1383
 
 
1384
def recv_all(socket, bytes):
 
1385
    """Receive an exact number of bytes.
 
1386
 
 
1387
    Regular Socket.recv() may return less than the requested number of bytes,
 
1388
    dependning on what's in the OS buffer.  MSG_WAITALL is not available
 
1389
    on all platforms, but this should work everywhere.  This will return
 
1390
    less than the requested amount if the remote end closes.
 
1391
 
 
1392
    This isn't optimized and is intended mostly for use in testing.
 
1393
    """
 
1394
    b = ''
 
1395
    while len(b) < bytes:
 
1396
        new = socket.recv(bytes - len(b))
 
1397
        if new == '':
 
1398
            break # eof
 
1399
        b += new
 
1400
    return b
 
1401
 
 
1402
def dereference_path(path):
 
1403
    """Determine the real path to a file.
 
1404
 
 
1405
    All parent elements are dereferenced.  But the file itself is not
 
1406
    dereferenced.
 
1407
    :param path: The original path.  May be absolute or relative.
 
1408
    :return: the real path *to* the file
 
1409
    """
 
1410
    parent, base = os.path.split(path)
 
1411
    # The pathjoin for '.' is a workaround for Python bug #1213894.
 
1412
    # (initial path components aren't dereferenced)
 
1413
    return pathjoin(realpath(pathjoin('.', parent)), base)
 
1414
 
 
1415
 
 
1416
def supports_mapi():
 
1417
    """Return True if we can use MAPI to launch a mail client."""
 
1418
    return sys.platform == "win32"