~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Martin Pool
  • Date: 2006-11-03 01:52:12 UTC
  • mto: This revision was merged to the branch mainline in revision 2119.
  • Revision ID: mbp@sourcefrog.net-20061103015212-1e5f881c2152d79f
Review comments

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Bazaar-NG -- distributed version control
2
 
 
3
 
# Copyright (C) 2005 by Canonical Ltd
4
 
 
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
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
7
5
# the Free Software Foundation; either version 2 of the License, or
8
6
# (at your option) any later version.
9
 
 
 
7
#
10
8
# This program is distributed in the hope that it will be useful,
11
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
11
# GNU General Public License for more details.
14
 
 
 
12
#
15
13
# You should have received a copy of the GNU General Public License
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
 
import os, types, re, time, errno, sys
20
 
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
21
 
 
22
 
from bzrlib.errors import BzrError
 
17
from cStringIO import StringIO
 
18
import os
 
19
import re
 
20
import stat
 
21
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
 
22
                  S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
 
23
import sys
 
24
import time
 
25
 
 
26
from bzrlib.lazy_import import lazy_import
 
27
lazy_import(globals(), """
 
28
import errno
 
29
from ntpath import (abspath as _nt_abspath,
 
30
                    join as _nt_join,
 
31
                    normpath as _nt_normpath,
 
32
                    realpath as _nt_realpath,
 
33
                    splitdrive as _nt_splitdrive,
 
34
                    )
 
35
import posixpath
 
36
import sha
 
37
import shutil
 
38
from shutil import (
 
39
    rmtree,
 
40
    )
 
41
import string
 
42
import tempfile
 
43
from tempfile import (
 
44
    mkdtemp,
 
45
    )
 
46
import unicodedata
 
47
 
 
48
from bzrlib import (
 
49
    errors,
 
50
    )
 
51
""")
 
52
 
 
53
import bzrlib
 
54
from bzrlib.symbol_versioning import (
 
55
    deprecated_function,
 
56
    zero_nine,
 
57
    )
23
58
from bzrlib.trace import mutter
24
 
import bzrlib
 
59
 
 
60
 
 
61
# On win32, O_BINARY is used to indicate the file should
 
62
# be opened in binary mode, rather than text mode.
 
63
# On other platforms, O_BINARY doesn't exist, because
 
64
# they always open in binary mode, so it is okay to
 
65
# OR with 0 on those platforms
 
66
O_BINARY = getattr(os, 'O_BINARY', 0)
 
67
 
25
68
 
26
69
def make_readonly(filename):
27
70
    """Make a filename read-only."""
28
 
    # TODO: probably needs to be fixed for windows
29
71
    mod = os.stat(filename).st_mode
30
72
    mod = mod & 0777555
31
73
    os.chmod(filename, mod)
47
89
    Windows."""
48
90
    # TODO: I'm not really sure this is the best format either.x
49
91
    global _QUOTE_RE
50
 
    if _QUOTE_RE == None:
51
 
        _QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
 
92
    if _QUOTE_RE is None:
 
93
        _QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
52
94
        
53
95
    if _QUOTE_RE.search(f):
54
96
        return '"' + f + '"'
56
98
        return f
57
99
 
58
100
 
59
 
def file_kind(f):
60
 
    mode = os.lstat(f)[ST_MODE]
61
 
    if S_ISREG(mode):
62
 
        return 'file'
63
 
    elif S_ISDIR(mode):
64
 
        return 'directory'
65
 
    elif S_ISLNK(mode):
66
 
        return 'symlink'
67
 
    else:
68
 
        raise BzrError("can't handle file kind with mode %o of %r" % (mode, f))
 
101
_directory_kind = 'directory'
 
102
 
 
103
_formats = {
 
104
    stat.S_IFDIR:_directory_kind,
 
105
    stat.S_IFCHR:'chardev',
 
106
    stat.S_IFBLK:'block',
 
107
    stat.S_IFREG:'file',
 
108
    stat.S_IFIFO:'fifo',
 
109
    stat.S_IFLNK:'symlink',
 
110
    stat.S_IFSOCK:'socket',
 
111
}
 
112
 
 
113
 
 
114
def file_kind_from_stat_mode(stat_mode, _formats=_formats, _unknown='unknown'):
 
115
    """Generate a file kind from a stat mode. This is used in walkdirs.
 
116
 
 
117
    Its performance is critical: Do not mutate without careful benchmarking.
 
118
    """
 
119
    try:
 
120
        return _formats[stat_mode & 0170000]
 
121
    except KeyError:
 
122
        return _unknown
 
123
 
 
124
 
 
125
def file_kind(f, _lstat=os.lstat, _mapper=file_kind_from_stat_mode):
 
126
    try:
 
127
        return _mapper(_lstat(f).st_mode)
 
128
    except OSError, e:
 
129
        if getattr(e, 'errno', None) == errno.ENOENT:
 
130
            raise errors.NoSuchFile(f)
 
131
        raise
 
132
 
 
133
 
 
134
def get_umask():
 
135
    """Return the current umask"""
 
136
    # Assume that people aren't messing with the umask while running
 
137
    # XXX: This is not thread safe, but there is no way to get the
 
138
    #      umask without setting it
 
139
    umask = os.umask(0)
 
140
    os.umask(umask)
 
141
    return umask
69
142
 
70
143
 
71
144
def kind_marker(kind):
72
145
    if kind == 'file':
73
146
        return ''
74
 
    elif kind == 'directory':
 
147
    elif kind == _directory_kind:
75
148
        return '/'
76
149
    elif kind == 'symlink':
77
150
        return '@'
78
151
    else:
79
 
        raise BzrError('invalid file kind %r' % kind)
80
 
 
 
152
        raise errors.BzrError('invalid file kind %r' % kind)
 
153
 
 
154
lexists = getattr(os.path, 'lexists', None)
 
155
if lexists is None:
 
156
    def lexists(f):
 
157
        try:
 
158
            if getattr(os, 'lstat') is not None:
 
159
                os.lstat(f)
 
160
            else:
 
161
                os.stat(f)
 
162
            return True
 
163
        except OSError,e:
 
164
            if e.errno == errno.ENOENT:
 
165
                return False;
 
166
            else:
 
167
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
 
168
 
 
169
 
 
170
def fancy_rename(old, new, rename_func, unlink_func):
 
171
    """A fancy rename, when you don't have atomic rename.
 
172
    
 
173
    :param old: The old path, to rename from
 
174
    :param new: The new path, to rename to
 
175
    :param rename_func: The potentially non-atomic rename function
 
176
    :param unlink_func: A way to delete the target file if the full rename succeeds
 
177
    """
 
178
 
 
179
    # sftp rename doesn't allow overwriting, so play tricks:
 
180
    import random
 
181
    base = os.path.basename(new)
 
182
    dirname = os.path.dirname(new)
 
183
    tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
 
184
    tmp_name = pathjoin(dirname, tmp_name)
 
185
 
 
186
    # Rename the file out of the way, but keep track if it didn't exist
 
187
    # We don't want to grab just any exception
 
188
    # something like EACCES should prevent us from continuing
 
189
    # The downside is that the rename_func has to throw an exception
 
190
    # with an errno = ENOENT, or NoSuchFile
 
191
    file_existed = False
 
192
    try:
 
193
        rename_func(new, tmp_name)
 
194
    except (errors.NoSuchFile,), e:
 
195
        pass
 
196
    except IOError, e:
 
197
        # RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
 
198
        # function raises an IOError with errno is None when a rename fails.
 
199
        # This then gets caught here.
 
200
        if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
 
201
            raise
 
202
    except Exception, e:
 
203
        if (getattr(e, 'errno', None) is None
 
204
            or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
 
205
            raise
 
206
    else:
 
207
        file_existed = True
 
208
 
 
209
    success = False
 
210
    try:
 
211
        # This may throw an exception, in which case success will
 
212
        # not be set.
 
213
        rename_func(old, new)
 
214
        success = True
 
215
    finally:
 
216
        if file_existed:
 
217
            # If the file used to exist, rename it back into place
 
218
            # otherwise just delete it from the tmp location
 
219
            if success:
 
220
                unlink_func(tmp_name)
 
221
            else:
 
222
                rename_func(tmp_name, new)
 
223
 
 
224
 
 
225
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
 
226
# choke on a Unicode string containing a relative path if
 
227
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
 
228
# string.
 
229
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
 
230
def _posix_abspath(path):
 
231
    # jam 20060426 rather than encoding to fsencoding
 
232
    # copy posixpath.abspath, but use os.getcwdu instead
 
233
    if not posixpath.isabs(path):
 
234
        path = posixpath.join(getcwd(), path)
 
235
    return posixpath.normpath(path)
 
236
 
 
237
 
 
238
def _posix_realpath(path):
 
239
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
 
240
 
 
241
 
 
242
def _win32_fixdrive(path):
 
243
    """Force drive letters to be consistent.
 
244
 
 
245
    win32 is inconsistent whether it returns lower or upper case
 
246
    and even if it was consistent the user might type the other
 
247
    so we force it to uppercase
 
248
    running python.exe under cmd.exe return capital C:\\
 
249
    running win32 python inside a cygwin shell returns lowercase c:\\
 
250
    """
 
251
    drive, path = _nt_splitdrive(path)
 
252
    return drive.upper() + path
 
253
 
 
254
 
 
255
def _win32_abspath(path):
 
256
    # Real _nt_abspath doesn't have a problem with a unicode cwd
 
257
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
 
258
 
 
259
 
 
260
def _win32_realpath(path):
 
261
    # Real _nt_realpath doesn't have a problem with a unicode cwd
 
262
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
 
263
 
 
264
 
 
265
def _win32_pathjoin(*args):
 
266
    return _nt_join(*args).replace('\\', '/')
 
267
 
 
268
 
 
269
def _win32_normpath(path):
 
270
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
271
 
 
272
 
 
273
def _win32_getcwd():
 
274
    return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
 
275
 
 
276
 
 
277
def _win32_mkdtemp(*args, **kwargs):
 
278
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
 
279
 
 
280
 
 
281
def _win32_rename(old, new):
 
282
    """We expect to be able to atomically replace 'new' with old.
 
283
 
 
284
    On win32, if new exists, it must be moved out of the way first,
 
285
    and then deleted. 
 
286
    """
 
287
    try:
 
288
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
 
289
    except OSError, e:
 
290
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
 
291
            # If we try to rename a non-existant file onto cwd, we get 
 
292
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT 
 
293
            # if the old path doesn't exist, sometimes we get EACCES
 
294
            # On Linux, we seem to get EBUSY, on Mac we get EINVAL
 
295
            os.lstat(old)
 
296
        raise
 
297
 
 
298
 
 
299
def _mac_getcwd():
 
300
    return unicodedata.normalize('NFKC', os.getcwdu())
 
301
 
 
302
 
 
303
# Default is to just use the python builtins, but these can be rebound on
 
304
# particular platforms.
 
305
abspath = _posix_abspath
 
306
realpath = _posix_realpath
 
307
pathjoin = os.path.join
 
308
normpath = os.path.normpath
 
309
getcwd = os.getcwdu
 
310
rename = os.rename
 
311
dirname = os.path.dirname
 
312
basename = os.path.basename
 
313
# These were already imported into local scope
 
314
# mkdtemp = tempfile.mkdtemp
 
315
# rmtree = shutil.rmtree
 
316
 
 
317
MIN_ABS_PATHLENGTH = 1
 
318
 
 
319
 
 
320
if sys.platform == 'win32':
 
321
    abspath = _win32_abspath
 
322
    realpath = _win32_realpath
 
323
    pathjoin = _win32_pathjoin
 
324
    normpath = _win32_normpath
 
325
    getcwd = _win32_getcwd
 
326
    mkdtemp = _win32_mkdtemp
 
327
    rename = _win32_rename
 
328
 
 
329
    MIN_ABS_PATHLENGTH = 3
 
330
 
 
331
    def _win32_delete_readonly(function, path, excinfo):
 
332
        """Error handler for shutil.rmtree function [for win32]
 
333
        Helps to remove files and dirs marked as read-only.
 
334
        """
 
335
        type_, value = excinfo[:2]
 
336
        if function in (os.remove, os.rmdir) \
 
337
            and type_ == OSError \
 
338
            and value.errno == errno.EACCES:
 
339
            make_writable(path)
 
340
            function(path)
 
341
        else:
 
342
            raise
 
343
 
 
344
    def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
 
345
        """Replacer for shutil.rmtree: could remove readonly dirs/files"""
 
346
        return shutil.rmtree(path, ignore_errors, onerror)
 
347
elif sys.platform == 'darwin':
 
348
    getcwd = _mac_getcwd
 
349
 
 
350
 
 
351
def get_terminal_encoding():
 
352
    """Find the best encoding for printing to the screen.
 
353
 
 
354
    This attempts to check both sys.stdout and sys.stdin to see
 
355
    what encoding they are in, and if that fails it falls back to
 
356
    bzrlib.user_encoding.
 
357
    The problem is that on Windows, locale.getpreferredencoding()
 
358
    is not the same encoding as that used by the console:
 
359
    http://mail.python.org/pipermail/python-list/2003-May/162357.html
 
360
 
 
361
    On my standard US Windows XP, the preferred encoding is
 
362
    cp1252, but the console is cp437
 
363
    """
 
364
    output_encoding = getattr(sys.stdout, 'encoding', None)
 
365
    if not output_encoding:
 
366
        input_encoding = getattr(sys.stdin, 'encoding', None)
 
367
        if not input_encoding:
 
368
            output_encoding = bzrlib.user_encoding
 
369
            mutter('encoding stdout as bzrlib.user_encoding %r', output_encoding)
 
370
        else:
 
371
            output_encoding = input_encoding
 
372
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
373
    else:
 
374
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
375
    return output_encoding
 
376
 
 
377
 
 
378
def normalizepath(f):
 
379
    if getattr(os.path, 'realpath', None) is not None:
 
380
        F = realpath
 
381
    else:
 
382
        F = abspath
 
383
    [p,e] = os.path.split(f)
 
384
    if e == "" or e == "." or e == "..":
 
385
        return F(f)
 
386
    else:
 
387
        return pathjoin(F(p), e)
81
388
 
82
389
 
83
390
def backup_file(fn):
87
394
 
88
395
    If the file is already a backup, it's not copied.
89
396
    """
90
 
    import os
91
397
    if fn[-1] == '~':
92
398
        return
93
399
    bfn = fn + '~'
94
400
 
 
401
    if has_symlinks() and os.path.islink(fn):
 
402
        target = os.readlink(fn)
 
403
        os.symlink(target, bfn)
 
404
        return
95
405
    inf = file(fn, 'rb')
96
406
    try:
97
407
        content = inf.read()
104
414
    finally:
105
415
        outf.close()
106
416
 
107
 
def rename(path_from, path_to):
108
 
    """Basically the same as os.rename() just special for win32"""
109
 
    if sys.platform == 'win32':
110
 
        try:
111
 
            os.remove(path_to)
112
 
        except OSError, e:
113
 
            if e.errno != e.ENOENT:
114
 
                raise
115
 
    os.rename(path_from, path_to)
116
 
 
117
 
 
118
 
 
119
 
 
120
417
 
121
418
def isdir(f):
122
419
    """True if f is an accessible directory."""
126
423
        return False
127
424
 
128
425
 
129
 
 
130
426
def isfile(f):
131
427
    """True if f is a regular file."""
132
428
    try:
134
430
    except OSError:
135
431
        return False
136
432
 
 
433
def islink(f):
 
434
    """True if f is a symlink."""
 
435
    try:
 
436
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
437
    except OSError:
 
438
        return False
137
439
 
138
440
def is_inside(dir, fname):
139
441
    """True if fname is inside dir.
140
442
    
141
 
    The parameters should typically be passed to os.path.normpath first, so
 
443
    The parameters should typically be passed to osutils.normpath first, so
142
444
    that . and .. and repeated slashes are eliminated, and the separators
143
445
    are canonical for the platform.
144
446
    
145
447
    The empty string as a dir name is taken as top-of-tree and matches 
146
448
    everything.
147
 
    
148
 
    >>> is_inside('src', 'src/foo.c')
149
 
    True
150
 
    >>> is_inside('src', 'srccontrol')
151
 
    False
152
 
    >>> is_inside('src', 'src/a/a/a/foo.c')
153
 
    True
154
 
    >>> is_inside('foo.c', 'foo.c')
155
 
    True
156
 
    >>> is_inside('foo.c', '')
157
 
    False
158
 
    >>> is_inside('', 'foo.c')
159
 
    True
160
449
    """
161
450
    # XXX: Most callers of this can actually do something smarter by 
162
451
    # looking at the inventory
165
454
    
166
455
    if dir == '':
167
456
        return True
168
 
    
169
 
    if dir[-1] != os.sep:
170
 
        dir += os.sep
171
 
    
 
457
 
 
458
    if dir[-1] != '/':
 
459
        dir += '/'
 
460
 
172
461
    return fname.startswith(dir)
173
462
 
174
463
 
181
470
        return False
182
471
 
183
472
 
 
473
def is_inside_or_parent_of_any(dir_list, fname):
 
474
    """True if fname is a child or a parent of any of the given files."""
 
475
    for dirname in dir_list:
 
476
        if is_inside(dirname, fname) or is_inside(fname, dirname):
 
477
            return True
 
478
    else:
 
479
        return False
 
480
 
 
481
 
184
482
def pumpfile(fromfile, tofile):
185
483
    """Copy contents of one file to another."""
186
 
    tofile.write(fromfile.read())
187
 
 
188
 
 
189
 
def uuid():
190
 
    """Return a new UUID"""
191
 
    try:
192
 
        return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
193
 
    except IOError:
194
 
        return chomp(os.popen('uuidgen').readline())
 
484
    BUFSIZE = 32768
 
485
    while True:
 
486
        b = fromfile.read(BUFSIZE)
 
487
        if not b:
 
488
            break
 
489
        tofile.write(b)
 
490
 
 
491
 
 
492
def file_iterator(input_file, readsize=32768):
 
493
    while True:
 
494
        b = input_file.read(readsize)
 
495
        if len(b) == 0:
 
496
            break
 
497
        yield b
195
498
 
196
499
 
197
500
def sha_file(f):
198
 
    import sha
199
 
    if hasattr(f, 'tell'):
 
501
    if getattr(f, 'tell', None) is not None:
200
502
        assert f.tell() == 0
201
503
    s = sha.new()
202
504
    BUFSIZE = 128<<10
208
510
    return s.hexdigest()
209
511
 
210
512
 
 
513
 
 
514
def sha_strings(strings):
 
515
    """Return the sha-1 of concatenation of strings"""
 
516
    s = sha.new()
 
517
    map(s.update, strings)
 
518
    return s.hexdigest()
 
519
 
 
520
 
211
521
def sha_string(f):
212
 
    import sha
213
522
    s = sha.new()
214
523
    s.update(f)
215
524
    return s.hexdigest()
216
525
 
217
526
 
218
 
 
219
527
def fingerprint_file(f):
220
 
    import sha
221
528
    s = sha.new()
222
529
    b = f.read()
223
530
    s.update(b)
226
533
            'sha1': s.hexdigest()}
227
534
 
228
535
 
229
 
def config_dir():
230
 
    """Return per-user configuration directory.
231
 
 
232
 
    By default this is ~/.bzr.conf/
233
 
    
234
 
    TODO: Global option --config-dir to override this.
235
 
    """
236
 
    return os.path.expanduser("~/.bzr.conf")
237
 
 
238
 
 
239
 
def _auto_user_id():
240
 
    """Calculate automatic user identification.
241
 
 
242
 
    Returns (realname, email).
243
 
 
244
 
    Only used when none is set in the environment or the id file.
245
 
 
246
 
    This previously used the FQDN as the default domain, but that can
247
 
    be very slow on machines where DNS is broken.  So now we simply
248
 
    use the hostname.
249
 
    """
250
 
    import socket
251
 
 
252
 
    # XXX: Any good way to get real user name on win32?
253
 
 
254
 
    try:
255
 
        import pwd
256
 
        uid = os.getuid()
257
 
        w = pwd.getpwuid(uid)
258
 
        gecos = w.pw_gecos.decode(bzrlib.user_encoding)
259
 
        username = w.pw_name.decode(bzrlib.user_encoding)
260
 
        comma = gecos.find(',')
261
 
        if comma == -1:
262
 
            realname = gecos
263
 
        else:
264
 
            realname = gecos[:comma]
265
 
        if not realname:
266
 
            realname = username
267
 
 
268
 
    except ImportError:
269
 
        import getpass
270
 
        realname = username = getpass.getuser().decode(bzrlib.user_encoding)
271
 
 
272
 
    return realname, (username + '@' + socket.gethostname())
273
 
 
274
 
 
275
 
def _get_user_id(branch):
276
 
    """Return the full user id from a file or environment variable.
277
 
 
278
 
    e.g. "John Hacker <jhacker@foo.org>"
279
 
 
280
 
    branch
281
 
        A branch to use for a per-branch configuration, or None.
282
 
 
283
 
    The following are searched in order:
284
 
 
285
 
    1. $BZREMAIL
286
 
    2. .bzr/email for this branch.
287
 
    3. ~/.bzr.conf/email
288
 
    4. $EMAIL
289
 
    """
290
 
    v = os.environ.get('BZREMAIL')
291
 
    if v:
292
 
        return v.decode(bzrlib.user_encoding)
293
 
 
294
 
    if branch:
295
 
        try:
296
 
            return (branch.controlfile("email", "r") 
297
 
                    .read()
298
 
                    .decode(bzrlib.user_encoding)
299
 
                    .rstrip("\r\n"))
300
 
        except IOError, e:
301
 
            if e.errno != errno.ENOENT:
302
 
                raise
303
 
        except BzrError, e:
304
 
            pass
305
 
    
306
 
    try:
307
 
        return (open(os.path.join(config_dir(), "email"))
308
 
                .read()
309
 
                .decode(bzrlib.user_encoding)
310
 
                .rstrip("\r\n"))
311
 
    except IOError, e:
312
 
        if e.errno != errno.ENOENT:
313
 
            raise e
314
 
 
315
 
    v = os.environ.get('EMAIL')
316
 
    if v:
317
 
        return v.decode(bzrlib.user_encoding)
318
 
    else:    
319
 
        return None
320
 
 
321
 
 
322
 
def username(branch):
323
 
    """Return email-style username.
324
 
 
325
 
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
326
 
 
327
 
    TODO: Check it's reasonably well-formed.
328
 
    """
329
 
    v = _get_user_id(branch)
330
 
    if v:
331
 
        return v
332
 
    
333
 
    name, email = _auto_user_id()
334
 
    if name:
335
 
        return '%s <%s>' % (name, email)
336
 
    else:
337
 
        return email
338
 
 
339
 
 
340
 
def user_email(branch):
341
 
    """Return just the email component of a username."""
342
 
    e = _get_user_id(branch)
343
 
    if e:
344
 
        m = re.search(r'[\w+.-]+@[\w+.-]+', e)
345
 
        if not m:
346
 
            raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
347
 
        return m.group(0)
348
 
 
349
 
    return _auto_user_id()[1]
350
 
    
351
 
 
352
 
 
353
536
def compare_files(a, b):
354
537
    """Returns true if equal in contents"""
355
538
    BUFSIZE = 4096
362
545
            return True
363
546
 
364
547
 
365
 
 
366
548
def local_time_offset(t=None):
367
549
    """Return offset of local zone from GMT, either at present or at time t."""
368
550
    # python2.3 localtime() can't take None
369
 
    if t == None:
 
551
    if t is None:
370
552
        t = time.time()
371
553
        
372
554
    if time.localtime(t).tm_isdst and time.daylight:
375
557
        return -time.timezone
376
558
 
377
559
    
378
 
def format_date(t, offset=0, timezone='original'):
 
560
def format_date(t, offset=0, timezone='original', date_fmt=None, 
 
561
                show_offset=True):
379
562
    ## TODO: Perhaps a global option to use either universal or local time?
380
563
    ## Or perhaps just let people set $TZ?
381
564
    assert isinstance(t, float)
384
567
        tt = time.gmtime(t)
385
568
        offset = 0
386
569
    elif timezone == 'original':
387
 
        if offset == None:
 
570
        if offset is None:
388
571
            offset = 0
389
572
        tt = time.gmtime(t + offset)
390
573
    elif timezone == 'local':
391
574
        tt = time.localtime(t)
392
575
        offset = local_time_offset(t)
393
576
    else:
394
 
        raise BzrError("unsupported timezone format %r" % timezone,
395
 
                       ['options are "utc", "original", "local"'])
396
 
 
397
 
    return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
398
 
            + ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
 
577
        raise errors.BzrError("unsupported timezone format %r" % timezone,
 
578
                              ['options are "utc", "original", "local"'])
 
579
    if date_fmt is None:
 
580
        date_fmt = "%a %Y-%m-%d %H:%M:%S"
 
581
    if show_offset:
 
582
        offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
 
583
    else:
 
584
        offset_str = ''
 
585
    return (time.strftime(date_fmt, tt) +  offset_str)
399
586
 
400
587
 
401
588
def compact_date(when):
402
589
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
403
590
    
404
591
 
 
592
def format_delta(delta):
 
593
    """Get a nice looking string for a time delta.
 
594
 
 
595
    :param delta: The time difference in seconds, can be positive or negative.
 
596
        positive indicates time in the past, negative indicates time in the
 
597
        future. (usually time.time() - stored_time)
 
598
    :return: String formatted to show approximate resolution
 
599
    """
 
600
    delta = int(delta)
 
601
    if delta >= 0:
 
602
        direction = 'ago'
 
603
    else:
 
604
        direction = 'in the future'
 
605
        delta = -delta
 
606
 
 
607
    seconds = delta
 
608
    if seconds < 90: # print seconds up to 90 seconds
 
609
        if seconds == 1:
 
610
            return '%d second %s' % (seconds, direction,)
 
611
        else:
 
612
            return '%d seconds %s' % (seconds, direction)
 
613
 
 
614
    minutes = int(seconds / 60)
 
615
    seconds -= 60 * minutes
 
616
    if seconds == 1:
 
617
        plural_seconds = ''
 
618
    else:
 
619
        plural_seconds = 's'
 
620
    if minutes < 90: # print minutes, seconds up to 90 minutes
 
621
        if minutes == 1:
 
622
            return '%d minute, %d second%s %s' % (
 
623
                    minutes, seconds, plural_seconds, direction)
 
624
        else:
 
625
            return '%d minutes, %d second%s %s' % (
 
626
                    minutes, seconds, plural_seconds, direction)
 
627
 
 
628
    hours = int(minutes / 60)
 
629
    minutes -= 60 * hours
 
630
    if minutes == 1:
 
631
        plural_minutes = ''
 
632
    else:
 
633
        plural_minutes = 's'
 
634
 
 
635
    if hours == 1:
 
636
        return '%d hour, %d minute%s %s' % (hours, minutes,
 
637
                                            plural_minutes, direction)
 
638
    return '%d hours, %d minute%s %s' % (hours, minutes,
 
639
                                         plural_minutes, direction)
405
640
 
406
641
def filesize(f):
407
642
    """Return size of given open file."""
408
643
    return os.fstat(f.fileno())[ST_SIZE]
409
644
 
410
645
 
411
 
if hasattr(os, 'urandom'): # python 2.4 and later
 
646
# Define rand_bytes based on platform.
 
647
try:
 
648
    # Python 2.4 and later have os.urandom,
 
649
    # but it doesn't work on some arches
 
650
    os.urandom(1)
412
651
    rand_bytes = os.urandom
413
 
elif sys.platform == 'linux2':
414
 
    rand_bytes = file('/dev/urandom', 'rb').read
415
 
else:
416
 
    # not well seeded, but better than nothing
417
 
    def rand_bytes(n):
418
 
        import random
419
 
        s = ''
420
 
        while n:
421
 
            s += chr(random.randint(0, 255))
422
 
            n -= 1
423
 
        return s
 
652
except (NotImplementedError, AttributeError):
 
653
    # If python doesn't have os.urandom, or it doesn't work,
 
654
    # then try to first pull random data from /dev/urandom
 
655
    try:
 
656
        rand_bytes = file('/dev/urandom', 'rb').read
 
657
    # Otherwise, use this hack as a last resort
 
658
    except (IOError, OSError):
 
659
        # not well seeded, but better than nothing
 
660
        def rand_bytes(n):
 
661
            import random
 
662
            s = ''
 
663
            while n:
 
664
                s += chr(random.randint(0, 255))
 
665
                n -= 1
 
666
            return s
 
667
 
 
668
 
 
669
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
 
670
def rand_chars(num):
 
671
    """Return a random string of num alphanumeric characters
 
672
    
 
673
    The result only contains lowercase chars because it may be used on 
 
674
    case-insensitive filesystems.
 
675
    """
 
676
    s = ''
 
677
    for raw_byte in rand_bytes(num):
 
678
        s += ALNUM[ord(raw_byte) % 36]
 
679
    return s
424
680
 
425
681
 
426
682
## TODO: We could later have path objects that remember their list
427
683
## decomposition (might be too tricksy though.)
428
684
 
429
685
def splitpath(p):
430
 
    """Turn string into list of parts.
431
 
 
432
 
    >>> splitpath('a')
433
 
    ['a']
434
 
    >>> splitpath('a/b')
435
 
    ['a', 'b']
436
 
    >>> splitpath('a/./b')
437
 
    ['a', 'b']
438
 
    >>> splitpath('a/.b')
439
 
    ['a', '.b']
440
 
    >>> splitpath('a/../b')
441
 
    Traceback (most recent call last):
442
 
    ...
443
 
    BzrError: sorry, '..' not allowed in path
444
 
    """
445
 
    assert isinstance(p, types.StringTypes)
 
686
    """Turn string into list of parts."""
 
687
    assert isinstance(p, basestring)
446
688
 
447
689
    # split on either delimiter because people might use either on
448
690
    # Windows
451
693
    rps = []
452
694
    for f in ps:
453
695
        if f == '..':
454
 
            raise BzrError("sorry, %r not allowed in path" % f)
 
696
            raise errors.BzrError("sorry, %r not allowed in path" % f)
455
697
        elif (f == '.') or (f == ''):
456
698
            pass
457
699
        else:
461
703
def joinpath(p):
462
704
    assert isinstance(p, list)
463
705
    for f in p:
464
 
        if (f == '..') or (f == None) or (f == ''):
465
 
            raise BzrError("sorry, %r not allowed in path" % f)
466
 
    return os.path.join(*p)
467
 
 
468
 
 
 
706
        if (f == '..') or (f is None) or (f == ''):
 
707
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
708
    return pathjoin(*p)
 
709
 
 
710
 
 
711
@deprecated_function(zero_nine)
469
712
def appendpath(p1, p2):
470
713
    if p1 == '':
471
714
        return p2
472
715
    else:
473
 
        return os.path.join(p1, p2)
 
716
        return pathjoin(p1, p2)
474
717
    
475
718
 
476
 
def extern_command(cmd, ignore_errors = False):
477
 
    mutter('external command: %s' % `cmd`)
478
 
    if os.system(cmd):
479
 
        if not ignore_errors:
480
 
            raise BzrError('command failed')
481
 
 
482
 
 
483
 
def _read_config_value(name):
484
 
    """Read a config value from the file ~/.bzr.conf/<name>
485
 
    Return None if the file does not exist"""
486
 
    try:
487
 
        f = file(os.path.join(config_dir(), name), "r")
488
 
        return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
489
 
    except IOError, e:
490
 
        if e.errno == errno.ENOENT:
491
 
            return None
492
 
        raise
493
 
 
494
 
 
495
 
def _get_editor():
496
 
    """Return a sequence of possible editor binaries for the current platform"""
497
 
    e = _read_config_value("editor")
498
 
    if e is not None:
499
 
        yield e
 
719
def split_lines(s):
 
720
    """Split s into lines, but without removing the newline characters."""
 
721
    lines = s.split('\n')
 
722
    result = [line + '\n' for line in lines[:-1]]
 
723
    if lines[-1]:
 
724
        result.append(lines[-1])
 
725
    return result
 
726
 
 
727
 
 
728
def hardlinks_good():
 
729
    return sys.platform not in ('win32', 'cygwin', 'darwin')
 
730
 
 
731
 
 
732
def link_or_copy(src, dest):
 
733
    """Hardlink a file, or copy it if it can't be hardlinked."""
 
734
    if not hardlinks_good():
 
735
        shutil.copyfile(src, dest)
 
736
        return
 
737
    try:
 
738
        os.link(src, dest)
 
739
    except (OSError, IOError), e:
 
740
        if e.errno != errno.EXDEV:
 
741
            raise
 
742
        shutil.copyfile(src, dest)
 
743
 
 
744
def delete_any(full_path):
 
745
    """Delete a file or directory."""
 
746
    try:
 
747
        os.unlink(full_path)
 
748
    except OSError, e:
 
749
    # We may be renaming a dangling inventory id
 
750
        if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
 
751
            raise
 
752
        os.rmdir(full_path)
 
753
 
 
754
 
 
755
def has_symlinks():
 
756
    if getattr(os, 'symlink', None) is not None:
 
757
        return True
 
758
    else:
 
759
        return False
500
760
        
501
 
    if os.name == "windows":
502
 
        yield "notepad.exe"
503
 
    elif os.name == "posix":
504
 
        try:
505
 
            yield os.environ["EDITOR"]
506
 
        except KeyError:
507
 
            yield "/usr/bin/vi"
508
 
 
509
 
 
510
 
def _run_editor(filename):
511
 
    """Try to execute an editor to edit the commit message. Returns True on success,
512
 
    False on failure"""
513
 
    for e in _get_editor():
514
 
        x = os.spawnvp(os.P_WAIT, e, (e, filename))
515
 
        if x == 0:
516
 
            return True
517
 
        elif x == 127:
518
 
            continue
519
 
        else:
 
761
 
 
762
def contains_whitespace(s):
 
763
    """True if there are any whitespace characters in s."""
 
764
    for ch in string.whitespace:
 
765
        if ch in s:
 
766
            return True
 
767
    else:
 
768
        return False
 
769
 
 
770
 
 
771
def contains_linebreaks(s):
 
772
    """True if there is any vertical whitespace in s."""
 
773
    for ch in '\f\n\r':
 
774
        if ch in s:
 
775
            return True
 
776
    else:
 
777
        return False
 
778
 
 
779
 
 
780
def relpath(base, path):
 
781
    """Return path relative to base, or raise exception.
 
782
 
 
783
    The path may be either an absolute path or a path relative to the
 
784
    current working directory.
 
785
 
 
786
    os.path.commonprefix (python2.4) has a bad bug that it works just
 
787
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
 
788
    avoids that problem.
 
789
    """
 
790
 
 
791
    assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
 
792
        ' exceed the platform minimum length (which is %d)' % 
 
793
        MIN_ABS_PATHLENGTH)
 
794
 
 
795
    rp = abspath(path)
 
796
 
 
797
    s = []
 
798
    head = rp
 
799
    while len(head) >= len(base):
 
800
        if head == base:
520
801
            break
521
 
    raise BzrError("Could not start any editor. Please specify $EDITOR or use ~/.bzr.conf/editor")
522
 
    return False
523
 
                          
524
 
 
525
 
def get_text_message(infotext, ignoreline = "default"):
526
 
    import tempfile
527
 
    
528
 
    if ignoreline == "default":
529
 
        ignoreline = "-- This line and the following will be ignored --"
530
 
        
531
 
    try:
532
 
        tmp_fileno, msgfilename = tempfile.mkstemp()
533
 
        msgfile = os.close(tmp_fileno)
534
 
        if infotext is not None and infotext != "":
535
 
            hasinfo = True
536
 
            msgfile = file(msgfilename, "w")
537
 
            msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
538
 
            msgfile.close()
539
 
        else:
540
 
            hasinfo = False
541
 
 
542
 
        if not _run_editor(msgfilename):
543
 
            return None
544
 
        
545
 
        started = False
546
 
        msg = []
547
 
        lastline, nlines = 0, 0
548
 
        for line in file(msgfilename, "r"):
549
 
            stripped_line = line.strip()
550
 
            # strip empty line before the log message starts
551
 
            if not started:
552
 
                if stripped_line != "":
553
 
                    started = True
554
 
                else:
555
 
                    continue
556
 
            # check for the ignore line only if there
557
 
            # is additional information at the end
558
 
            if hasinfo and stripped_line == ignoreline:
559
 
                break
560
 
            nlines += 1
561
 
            # keep track of the last line that had some content
562
 
            if stripped_line != "":
563
 
                lastline = nlines
564
 
            msg.append(line)
565
 
            
566
 
        if len(msg) == 0:
567
 
            return None
568
 
        # delete empty lines at the end
569
 
        del msg[lastline:]
570
 
        # add a newline at the end, if needed
571
 
        if not msg[-1].endswith("\n"):
572
 
            return "%s%s" % ("".join(msg), "\n")
573
 
        else:
574
 
            return "".join(msg)
575
 
    finally:
576
 
        # delete the msg file in any case
577
 
        try: os.unlink(msgfilename)
578
 
        except IOError: pass
 
802
        head, tail = os.path.split(head)
 
803
        if tail:
 
804
            s.insert(0, tail)
 
805
    else:
 
806
        raise errors.PathNotChild(rp, base)
 
807
 
 
808
    if s:
 
809
        return pathjoin(*s)
 
810
    else:
 
811
        return ''
 
812
 
 
813
 
 
814
def safe_unicode(unicode_or_utf8_string):
 
815
    """Coerce unicode_or_utf8_string into unicode.
 
816
 
 
817
    If it is unicode, it is returned.
 
818
    Otherwise it is decoded from utf-8. If a decoding error
 
819
    occurs, it is wrapped as a If the decoding fails, the exception is wrapped 
 
820
    as a BzrBadParameter exception.
 
821
    """
 
822
    if isinstance(unicode_or_utf8_string, unicode):
 
823
        return unicode_or_utf8_string
 
824
    try:
 
825
        return unicode_or_utf8_string.decode('utf8')
 
826
    except UnicodeDecodeError:
 
827
        raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
 
828
 
 
829
 
 
830
_platform_normalizes_filenames = False
 
831
if sys.platform == 'darwin':
 
832
    _platform_normalizes_filenames = True
 
833
 
 
834
 
 
835
def normalizes_filenames():
 
836
    """Return True if this platform normalizes unicode filenames.
 
837
 
 
838
    Mac OSX does, Windows/Linux do not.
 
839
    """
 
840
    return _platform_normalizes_filenames
 
841
 
 
842
 
 
843
def _accessible_normalized_filename(path):
 
844
    """Get the unicode normalized path, and if you can access the file.
 
845
 
 
846
    On platforms where the system normalizes filenames (Mac OSX),
 
847
    you can access a file by any path which will normalize correctly.
 
848
    On platforms where the system does not normalize filenames 
 
849
    (Windows, Linux), you have to access a file by its exact path.
 
850
 
 
851
    Internally, bzr only supports NFC/NFKC normalization, since that is 
 
852
    the standard for XML documents.
 
853
 
 
854
    So return the normalized path, and a flag indicating if the file
 
855
    can be accessed by that path.
 
856
    """
 
857
 
 
858
    return unicodedata.normalize('NFKC', unicode(path)), True
 
859
 
 
860
 
 
861
def _inaccessible_normalized_filename(path):
 
862
    __doc__ = _accessible_normalized_filename.__doc__
 
863
 
 
864
    normalized = unicodedata.normalize('NFKC', unicode(path))
 
865
    return normalized, normalized == path
 
866
 
 
867
 
 
868
if _platform_normalizes_filenames:
 
869
    normalized_filename = _accessible_normalized_filename
 
870
else:
 
871
    normalized_filename = _inaccessible_normalized_filename
 
872
 
 
873
 
 
874
def terminal_width():
 
875
    """Return estimated terminal width."""
 
876
    if sys.platform == 'win32':
 
877
        import bzrlib.win32console
 
878
        return bzrlib.win32console.get_console_size()[0]
 
879
    width = 0
 
880
    try:
 
881
        import struct, fcntl, termios
 
882
        s = struct.pack('HHHH', 0, 0, 0, 0)
 
883
        x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
 
884
        width = struct.unpack('HHHH', x)[1]
 
885
    except IOError:
 
886
        pass
 
887
    if width <= 0:
 
888
        try:
 
889
            width = int(os.environ['COLUMNS'])
 
890
        except:
 
891
            pass
 
892
    if width <= 0:
 
893
        width = 80
 
894
 
 
895
    return width
 
896
 
 
897
 
 
898
def supports_executable():
 
899
    return sys.platform != "win32"
 
900
 
 
901
 
 
902
def set_or_unset_env(env_variable, value):
 
903
    """Modify the environment, setting or removing the env_variable.
 
904
 
 
905
    :param env_variable: The environment variable in question
 
906
    :param value: The value to set the environment to. If None, then
 
907
        the variable will be removed.
 
908
    :return: The original value of the environment variable.
 
909
    """
 
910
    orig_val = os.environ.get(env_variable)
 
911
    if value is None:
 
912
        if orig_val is not None:
 
913
            del os.environ[env_variable]
 
914
    else:
 
915
        if isinstance(value, unicode):
 
916
            value = value.encode(bzrlib.user_encoding)
 
917
        os.environ[env_variable] = value
 
918
    return orig_val
 
919
 
 
920
 
 
921
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
 
922
 
 
923
 
 
924
def check_legal_path(path):
 
925
    """Check whether the supplied path is legal.  
 
926
    This is only required on Windows, so we don't test on other platforms
 
927
    right now.
 
928
    """
 
929
    if sys.platform != "win32":
 
930
        return
 
931
    if _validWin32PathRE.match(path) is None:
 
932
        raise errors.IllegalPath(path)
 
933
 
 
934
 
 
935
def walkdirs(top, prefix=""):
 
936
    """Yield data about all the directories in a tree.
 
937
    
 
938
    This yields all the data about the contents of a directory at a time.
 
939
    After each directory has been yielded, if the caller has mutated the list
 
940
    to exclude some directories, they are then not descended into.
 
941
    
 
942
    The data yielded is of the form:
 
943
    ((directory-relpath, directory-path-from-top),
 
944
    [(relpath, basename, kind, lstat), ...]),
 
945
     - directory-relpath is the relative path of the directory being returned
 
946
       with respect to top. prefix is prepended to this.
 
947
     - directory-path-from-root is the path including top for this directory. 
 
948
       It is suitable for use with os functions.
 
949
     - relpath is the relative path within the subtree being walked.
 
950
     - basename is the basename of the path
 
951
     - kind is the kind of the file now. If unknown then the file is not
 
952
       present within the tree - but it may be recorded as versioned. See
 
953
       versioned_kind.
 
954
     - lstat is the stat data *if* the file was statted.
 
955
     - planned, not implemented: 
 
956
       path_from_tree_root is the path from the root of the tree.
 
957
 
 
958
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This 
 
959
        allows one to walk a subtree but get paths that are relative to a tree
 
960
        rooted higher up.
 
961
    :return: an iterator over the dirs.
 
962
    """
 
963
    #TODO there is a bit of a smell where the results of the directory-
 
964
    # summary in this, and the path from the root, may not agree 
 
965
    # depending on top and prefix - i.e. ./foo and foo as a pair leads to
 
966
    # potentially confusing output. We should make this more robust - but
 
967
    # not at a speed cost. RBC 20060731
 
968
    lstat = os.lstat
 
969
    pending = []
 
970
    _directory = _directory_kind
 
971
    _listdir = os.listdir
 
972
    pending = [(prefix, "", _directory, None, top)]
 
973
    while pending:
 
974
        dirblock = []
 
975
        currentdir = pending.pop()
 
976
        # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
 
977
        top = currentdir[4]
 
978
        if currentdir[0]:
 
979
            relroot = currentdir[0] + '/'
 
980
        else:
 
981
            relroot = ""
 
982
        for name in sorted(_listdir(top)):
 
983
            abspath = top + '/' + name
 
984
            statvalue = lstat(abspath)
 
985
            dirblock.append((relroot + name, name,
 
986
                file_kind_from_stat_mode(statvalue.st_mode),
 
987
                statvalue, abspath))
 
988
        yield (currentdir[0], top), dirblock
 
989
        # push the user specified dirs from dirblock
 
990
        for dir in reversed(dirblock):
 
991
            if dir[2] == _directory:
 
992
                pending.append(dir)
 
993
 
 
994
 
 
995
def copy_tree(from_path, to_path, handlers={}):
 
996
    """Copy all of the entries in from_path into to_path.
 
997
 
 
998
    :param from_path: The base directory to copy. 
 
999
    :param to_path: The target directory. If it does not exist, it will
 
1000
        be created.
 
1001
    :param handlers: A dictionary of functions, which takes a source and
 
1002
        destinations for files, directories, etc.
 
1003
        It is keyed on the file kind, such as 'directory', 'symlink', or 'file'
 
1004
        'file', 'directory', and 'symlink' should always exist.
 
1005
        If they are missing, they will be replaced with 'os.mkdir()',
 
1006
        'os.readlink() + os.symlink()', and 'shutil.copy2()', respectively.
 
1007
    """
 
1008
    # Now, just copy the existing cached tree to the new location
 
1009
    # We use a cheap trick here.
 
1010
    # Absolute paths are prefixed with the first parameter
 
1011
    # relative paths are prefixed with the second.
 
1012
    # So we can get both the source and target returned
 
1013
    # without any extra work.
 
1014
 
 
1015
    def copy_dir(source, dest):
 
1016
        os.mkdir(dest)
 
1017
 
 
1018
    def copy_link(source, dest):
 
1019
        """Copy the contents of a symlink"""
 
1020
        link_to = os.readlink(source)
 
1021
        os.symlink(link_to, dest)
 
1022
 
 
1023
    real_handlers = {'file':shutil.copy2,
 
1024
                     'symlink':copy_link,
 
1025
                     'directory':copy_dir,
 
1026
                    }
 
1027
    real_handlers.update(handlers)
 
1028
 
 
1029
    if not os.path.exists(to_path):
 
1030
        real_handlers['directory'](from_path, to_path)
 
1031
 
 
1032
    for dir_info, entries in walkdirs(from_path, prefix=to_path):
 
1033
        for relpath, name, kind, st, abspath in entries:
 
1034
            real_handlers[kind](abspath, relpath)
 
1035
 
 
1036
 
 
1037
def path_prefix_key(path):
 
1038
    """Generate a prefix-order path key for path.
 
1039
 
 
1040
    This can be used to sort paths in the same way that walkdirs does.
 
1041
    """
 
1042
    return (dirname(path) , path)
 
1043
 
 
1044
 
 
1045
def compare_paths_prefix_order(path_a, path_b):
 
1046
    """Compare path_a and path_b to generate the same order walkdirs uses."""
 
1047
    key_a = path_prefix_key(path_a)
 
1048
    key_b = path_prefix_key(path_b)
 
1049
    return cmp(key_a, key_b)
 
1050
 
 
1051
 
 
1052
_cached_user_encoding = None
 
1053
 
 
1054
 
 
1055
def get_user_encoding():
 
1056
    """Find out what the preferred user encoding is.
 
1057
 
 
1058
    This is generally the encoding that is used for command line parameters
 
1059
    and file contents. This may be different from the terminal encoding
 
1060
    or the filesystem encoding.
 
1061
 
 
1062
    :return: A string defining the preferred user encoding
 
1063
    """
 
1064
    global _cached_user_encoding
 
1065
    if _cached_user_encoding is not None:
 
1066
        return _cached_user_encoding
 
1067
 
 
1068
    if sys.platform == 'darwin':
 
1069
        # work around egregious python 2.4 bug
 
1070
        sys.platform = 'posix'
 
1071
        try:
 
1072
            import locale
 
1073
        finally:
 
1074
            sys.platform = 'darwin'
 
1075
    else:
 
1076
        import locale
 
1077
 
 
1078
    try:
 
1079
        _cached_user_encoding = locale.getpreferredencoding()
 
1080
    except locale.Error, e:
 
1081
        sys.stderr.write('bzr: warning: %s\n'
 
1082
                         '  Could not determine what text encoding to use.\n'
 
1083
                         '  This error usually means your Python interpreter\n'
 
1084
                         '  doesn\'t support the locale set by $LANG (%s)\n'
 
1085
                         "  Continuing with ascii encoding.\n"
 
1086
                         % (e, os.environ.get('LANG')))
 
1087
 
 
1088
    if _cached_user_encoding is None:
 
1089
        _cached_user_encoding = 'ascii'
 
1090
    return _cached_user_encoding
 
1091
 
 
1092
 
 
1093
def recv_all(socket, bytes):
 
1094
    """Receive an exact number of bytes.
 
1095
 
 
1096
    Regular Socket.recv() may return less than the requested number of bytes,
 
1097
    dependning on what's in the OS buffer.  MSG_WAITALL is not available
 
1098
    on all platforms, but this should work everywhere.  This will return
 
1099
    less than the requested amount if the remote end closes.
 
1100
 
 
1101
    This isn't optimized and is intended mostly for use in testing.
 
1102
    """
 
1103
    b = ''
 
1104
    while len(b) < bytes:
 
1105
        new = socket.recv(bytes - len(b))
 
1106
        if new == '':
 
1107
            break # eof
 
1108
        b += new
 
1109
    return b
 
1110
 
 
1111
def dereference_path(path):
 
1112
    """Determine the real path to a file.
 
1113
 
 
1114
    All parent elements are dereferenced.  But the file itself is not
 
1115
    dereferenced.
 
1116
    :param path: The original path.  May be absolute or relative.
 
1117
    :return: the real path *to* the file
 
1118
    """
 
1119
    parent, base = os.path.split(path)
 
1120
    # The pathjoin for '.' is a workaround for Python bug #1213894.
 
1121
    # (initial path components aren't dereferenced)
 
1122
    return pathjoin(realpath(pathjoin('.', parent)), base)