← 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: 2008-05-29 15:57:16 UTC
  • mfrom: (3427.5.9 dep_warnings)
  • Revision ID: pqm@pqm.ubuntu.com-20080529155716-0w3kic8lioa63231
(jam) Enable Deprecation Warnings when running -Werror and when
        running selftest

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