/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Alexander Belchenko
  • Date: 2007-01-03 00:23:45 UTC
  • mto: This revision was merged to the branch mainline in revision 2219.
  • Revision ID: bialix@ukr.net-20070103002345-7guxku60a0vwsoya
Don't use os.path.split and os.path.splitext directly, only from osutils.

Because only '/' is used as separator of pathname components inside zip archives,
bzrlib.plugin.load_from_zips() uses custom split algorithm for handling filenames 
to import from zip.

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