/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: Canonical.com Patch Queue Manager
  • Date: 2007-03-09 02:08:38 UTC
  • mfrom: (2327.1.1 jam-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20070309020838-1dd7e652bc5c30ff
(Dmitry Vasiliev) Support for Putty SSH, and improved vendor support

Show diffs side-by-side

added added

removed removed

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