/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 21:27:15 UTC
  • mfrom: (2328.1.1 jam-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20070309212715-07aacbc78b3e2dc0
(Dmitry Vasiliev) Improvements to osutils functions.

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'
92
 
 
93
 
 
 
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
 
146
 
 
147
 
 
148
_kind_marker_map = {
 
149
    "file": "",
 
150
    _directory_kind: "/",
 
151
    "symlink": "@",
 
152
}
94
153
def kind_marker(kind):
95
 
    if kind == 'file':
96
 
        return ''
97
 
    elif kind == 'directory':
98
 
        return '/'
99
 
    elif kind == 'symlink':
100
 
        return '@'
101
 
    else:
102
 
        raise BzrError('invalid file kind %r' % kind)
103
 
 
104
 
def lexists(f):
105
 
    if hasattr(os.path, 'lexists'):
106
 
        return os.path.lexists(f)
107
154
    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))
 
155
        return _kind_marker_map[kind]
 
156
    except KeyError:
 
157
        raise errors.BzrError('invalid file kind %r' % kind)
 
158
 
 
159
 
 
160
lexists = getattr(os.path, 'lexists', None)
 
161
if lexists is None:
 
162
    def lexists(f):
 
163
        try:
 
164
            stat = getattr(os, 'lstat', os.stat)
 
165
            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
322
518
    for dirname in dir_list:
323
519
        if is_inside(dirname, fname):
324
520
            return True
325
 
    else:
326
 
        return False
 
521
    return False
 
522
 
 
523
 
 
524
def is_inside_or_parent_of_any(dir_list, fname):
 
525
    """True if fname is a child or a parent of any of the given files."""
 
526
    for dirname in dir_list:
 
527
        if is_inside(dirname, fname) or is_inside(fname, dirname):
 
528
            return True
 
529
    return False
327
530
 
328
531
 
329
532
def pumpfile(fromfile, tofile):
345
548
 
346
549
 
347
550
def sha_file(f):
348
 
    if hasattr(f, 'tell'):
 
551
    if getattr(f, 'tell', None) is not None:
349
552
        assert f.tell() == 0
350
553
    s = sha.new()
351
554
    BUFSIZE = 128<<10
394
597
 
395
598
def local_time_offset(t=None):
396
599
    """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:
 
600
    if t is None:
399
601
        t = time.time()
400
 
        
401
 
    if time.localtime(t).tm_isdst and time.daylight:
402
 
        return -time.altzone
403
 
    else:
404
 
        return -time.timezone
 
602
    offset = datetime.fromtimestamp(t) - datetime.utcfromtimestamp(t)
 
603
    return offset.days * 86400 + offset.seconds
405
604
 
406
605
    
407
606
def format_date(t, offset=0, timezone='original', date_fmt=None, 
414
613
        tt = time.gmtime(t)
415
614
        offset = 0
416
615
    elif timezone == 'original':
417
 
        if offset == None:
 
616
        if offset is None:
418
617
            offset = 0
419
618
        tt = time.gmtime(t + offset)
420
619
    elif timezone == 'local':
421
620
        tt = time.localtime(t)
422
621
        offset = local_time_offset(t)
423
622
    else:
424
 
        raise BzrError("unsupported timezone format %r" % timezone,
425
 
                       ['options are "utc", "original", "local"'])
 
623
        raise errors.BzrError("unsupported timezone format %r" % timezone,
 
624
                              ['options are "utc", "original", "local"'])
426
625
    if date_fmt is None:
427
626
        date_fmt = "%a %Y-%m-%d %H:%M:%S"
428
627
    if show_offset:
436
635
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
437
636
    
438
637
 
 
638
def format_delta(delta):
 
639
    """Get a nice looking string for a time delta.
 
640
 
 
641
    :param delta: The time difference in seconds, can be positive or negative.
 
642
        positive indicates time in the past, negative indicates time in the
 
643
        future. (usually time.time() - stored_time)
 
644
    :return: String formatted to show approximate resolution
 
645
    """
 
646
    delta = int(delta)
 
647
    if delta >= 0:
 
648
        direction = 'ago'
 
649
    else:
 
650
        direction = 'in the future'
 
651
        delta = -delta
 
652
 
 
653
    seconds = delta
 
654
    if seconds < 90: # print seconds up to 90 seconds
 
655
        if seconds == 1:
 
656
            return '%d second %s' % (seconds, direction,)
 
657
        else:
 
658
            return '%d seconds %s' % (seconds, direction)
 
659
 
 
660
    minutes = int(seconds / 60)
 
661
    seconds -= 60 * minutes
 
662
    if seconds == 1:
 
663
        plural_seconds = ''
 
664
    else:
 
665
        plural_seconds = 's'
 
666
    if minutes < 90: # print minutes, seconds up to 90 minutes
 
667
        if minutes == 1:
 
668
            return '%d minute, %d second%s %s' % (
 
669
                    minutes, seconds, plural_seconds, direction)
 
670
        else:
 
671
            return '%d minutes, %d second%s %s' % (
 
672
                    minutes, seconds, plural_seconds, direction)
 
673
 
 
674
    hours = int(minutes / 60)
 
675
    minutes -= 60 * hours
 
676
    if minutes == 1:
 
677
        plural_minutes = ''
 
678
    else:
 
679
        plural_minutes = 's'
 
680
 
 
681
    if hours == 1:
 
682
        return '%d hour, %d minute%s %s' % (hours, minutes,
 
683
                                            plural_minutes, direction)
 
684
    return '%d hours, %d minute%s %s' % (hours, minutes,
 
685
                                         plural_minutes, direction)
439
686
 
440
687
def filesize(f):
441
688
    """Return size of given open file."""
451
698
except (NotImplementedError, AttributeError):
452
699
    # If python doesn't have os.urandom, or it doesn't work,
453
700
    # then try to first pull random data from /dev/urandom
454
 
    if os.path.exists("/dev/urandom"):
 
701
    try:
455
702
        rand_bytes = file('/dev/urandom', 'rb').read
456
703
    # Otherwise, use this hack as a last resort
457
 
    else:
 
704
    except (IOError, OSError):
458
705
        # not well seeded, but better than nothing
459
706
        def rand_bytes(n):
460
707
            import random
482
729
## decomposition (might be too tricksy though.)
483
730
 
484
731
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)
 
732
    """Turn string into list of parts."""
 
733
    assert isinstance(p, basestring)
501
734
 
502
735
    # split on either delimiter because people might use either on
503
736
    # Windows
506
739
    rps = []
507
740
    for f in ps:
508
741
        if f == '..':
509
 
            raise BzrError("sorry, %r not allowed in path" % f)
 
742
            raise errors.BzrError("sorry, %r not allowed in path" % f)
510
743
        elif (f == '.') or (f == ''):
511
744
            pass
512
745
        else:
514
747
    return rps
515
748
 
516
749
def joinpath(p):
517
 
    assert isinstance(p, list)
 
750
    assert isinstance(p, (list, tuple))
518
751
    for f in p:
519
 
        if (f == '..') or (f == None) or (f == ''):
520
 
            raise BzrError("sorry, %r not allowed in path" % f)
 
752
        if (f == '..') or (f is None) or (f == ''):
 
753
            raise errors.BzrError("sorry, %r not allowed in path" % f)
521
754
    return pathjoin(*p)
522
755
 
523
756
 
 
757
@deprecated_function(zero_nine)
524
758
def appendpath(p1, p2):
525
759
    if p1 == '':
526
760
        return p2
530
764
 
531
765
def split_lines(s):
532
766
    """Split s into lines, but without removing the newline characters."""
533
 
    return StringIO(s).readlines()
 
767
    lines = s.split('\n')
 
768
    result = [line + '\n' for line in lines[:-1]]
 
769
    if lines[-1]:
 
770
        result.append(lines[-1])
 
771
    return result
534
772
 
535
773
 
536
774
def hardlinks_good():
540
778
def link_or_copy(src, dest):
541
779
    """Hardlink a file, or copy it if it can't be hardlinked."""
542
780
    if not hardlinks_good():
543
 
        copyfile(src, dest)
 
781
        shutil.copyfile(src, dest)
544
782
        return
545
783
    try:
546
784
        os.link(src, dest)
547
785
    except (OSError, IOError), e:
548
786
        if e.errno != errno.EXDEV:
549
787
            raise
550
 
        copyfile(src, dest)
 
788
        shutil.copyfile(src, dest)
551
789
 
552
790
def delete_any(full_path):
553
791
    """Delete a file or directory."""
561
799
 
562
800
 
563
801
def has_symlinks():
564
 
    if hasattr(os, 'symlink'):
 
802
    if getattr(os, 'symlink', None) is not None:
565
803
        return True
566
804
    else:
567
805
        return False
569
807
 
570
808
def contains_whitespace(s):
571
809
    """True if there are any whitespace characters in s."""
572
 
    for ch in string.whitespace:
 
810
    # string.whitespace can include '\xa0' in certain locales, because it is
 
811
    # considered "non-breaking-space" as part of ISO-8859-1. But it
 
812
    # 1) Isn't a breaking whitespace
 
813
    # 2) Isn't one of ' \t\r\n' which are characters we sometimes use as
 
814
    #    separators
 
815
    # 3) '\xa0' isn't unicode safe since it is >128.
 
816
 
 
817
    # This should *not* be a unicode set of characters in case the source
 
818
    # string is not a Unicode string. We can auto-up-cast the characters since
 
819
    # they are ascii, but we don't want to auto-up-cast the string in case it
 
820
    # is utf-8
 
821
    for ch in ' \t\n\r\v\f':
573
822
        if ch in s:
574
823
            return True
575
824
    else:
595
844
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
596
845
    avoids that problem.
597
846
    """
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)
 
847
 
 
848
    assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
 
849
        ' exceed the platform minimum length (which is %d)' % 
 
850
        MIN_ABS_PATHLENGTH)
 
851
 
604
852
    rp = abspath(path)
605
853
 
606
854
    s = []
612
860
        if tail:
613
861
            s.insert(0, tail)
614
862
    else:
615
 
        # XXX This should raise a NotChildPath exception, as its not tied
616
 
        # to branch anymore.
617
 
        raise PathNotChild(rp, base)
 
863
        raise errors.PathNotChild(rp, base)
618
864
 
619
865
    if s:
620
866
        return pathjoin(*s)
635
881
    try:
636
882
        return unicode_or_utf8_string.decode('utf8')
637
883
    except UnicodeDecodeError:
638
 
        raise BzrBadParameterNotUnicode(unicode_or_utf8_string)
 
884
        raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
 
885
 
 
886
 
 
887
def safe_utf8(unicode_or_utf8_string):
 
888
    """Coerce unicode_or_utf8_string to a utf8 string.
 
889
 
 
890
    If it is a str, it is returned.
 
891
    If it is Unicode, it is encoded into a utf-8 string.
 
892
    """
 
893
    if isinstance(unicode_or_utf8_string, str):
 
894
        # TODO: jam 20070209 This is overkill, and probably has an impact on
 
895
        #       performance if we are dealing with lots of apis that want a
 
896
        #       utf-8 revision id
 
897
        try:
 
898
            # Make sure it is a valid utf-8 string
 
899
            unicode_or_utf8_string.decode('utf-8')
 
900
        except UnicodeDecodeError:
 
901
            raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
 
902
        return unicode_or_utf8_string
 
903
    return unicode_or_utf8_string.encode('utf-8')
 
904
 
 
905
 
 
906
_revision_id_warning = ('Unicode revision ids were deprecated in bzr 0.15.'
 
907
                        ' Revision id generators should be creating utf8'
 
908
                        ' revision ids.')
 
909
 
 
910
 
 
911
def safe_revision_id(unicode_or_utf8_string, warn=True):
 
912
    """Revision ids should now be utf8, but at one point they were unicode.
 
913
 
 
914
    :param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
 
915
        utf8 or None).
 
916
    :param warn: Functions that are sanitizing user data can set warn=False
 
917
    :return: None or a utf8 revision id.
 
918
    """
 
919
    if (unicode_or_utf8_string is None
 
920
        or unicode_or_utf8_string.__class__ == str):
 
921
        return unicode_or_utf8_string
 
922
    if warn:
 
923
        symbol_versioning.warn(_revision_id_warning, DeprecationWarning,
 
924
                               stacklevel=2)
 
925
    return cache_utf8.encode(unicode_or_utf8_string)
 
926
 
 
927
 
 
928
_file_id_warning = ('Unicode file ids were deprecated in bzr 0.15. File id'
 
929
                    ' generators should be creating utf8 file ids.')
 
930
 
 
931
 
 
932
def safe_file_id(unicode_or_utf8_string, warn=True):
 
933
    """File ids should now be utf8, but at one point they were unicode.
 
934
 
 
935
    This is the same as safe_utf8, except it uses the cached encode functions
 
936
    to save a little bit of performance.
 
937
 
 
938
    :param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
 
939
        utf8 or None).
 
940
    :param warn: Functions that are sanitizing user data can set warn=False
 
941
    :return: None or a utf8 file id.
 
942
    """
 
943
    if (unicode_or_utf8_string is None
 
944
        or unicode_or_utf8_string.__class__ == str):
 
945
        return unicode_or_utf8_string
 
946
    if warn:
 
947
        symbol_versioning.warn(_file_id_warning, DeprecationWarning,
 
948
                               stacklevel=2)
 
949
    return cache_utf8.encode(unicode_or_utf8_string)
 
950
 
 
951
 
 
952
_platform_normalizes_filenames = False
 
953
if sys.platform == 'darwin':
 
954
    _platform_normalizes_filenames = True
 
955
 
 
956
 
 
957
def normalizes_filenames():
 
958
    """Return True if this platform normalizes unicode filenames.
 
959
 
 
960
    Mac OSX does, Windows/Linux do not.
 
961
    """
 
962
    return _platform_normalizes_filenames
 
963
 
 
964
 
 
965
def _accessible_normalized_filename(path):
 
966
    """Get the unicode normalized path, and if you can access the file.
 
967
 
 
968
    On platforms where the system normalizes filenames (Mac OSX),
 
969
    you can access a file by any path which will normalize correctly.
 
970
    On platforms where the system does not normalize filenames 
 
971
    (Windows, Linux), you have to access a file by its exact path.
 
972
 
 
973
    Internally, bzr only supports NFC/NFKC normalization, since that is 
 
974
    the standard for XML documents.
 
975
 
 
976
    So return the normalized path, and a flag indicating if the file
 
977
    can be accessed by that path.
 
978
    """
 
979
 
 
980
    return unicodedata.normalize('NFKC', unicode(path)), True
 
981
 
 
982
 
 
983
def _inaccessible_normalized_filename(path):
 
984
    __doc__ = _accessible_normalized_filename.__doc__
 
985
 
 
986
    normalized = unicodedata.normalize('NFKC', unicode(path))
 
987
    return normalized, normalized == path
 
988
 
 
989
 
 
990
if _platform_normalizes_filenames:
 
991
    normalized_filename = _accessible_normalized_filename
 
992
else:
 
993
    normalized_filename = _inaccessible_normalized_filename
639
994
 
640
995
 
641
996
def terminal_width():
642
997
    """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.
 
998
    if sys.platform == 'win32':
 
999
        return win32utils.get_console_size()[0]
 
1000
    width = 0
649
1001
    try:
650
 
        return int(os.environ['COLUMNS'])
651
 
    except (IndexError, KeyError, ValueError):
652
 
        return 80
 
1002
        import struct, fcntl, termios
 
1003
        s = struct.pack('HHHH', 0, 0, 0, 0)
 
1004
        x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
 
1005
        width = struct.unpack('HHHH', x)[1]
 
1006
    except IOError:
 
1007
        pass
 
1008
    if width <= 0:
 
1009
        try:
 
1010
            width = int(os.environ['COLUMNS'])
 
1011
        except:
 
1012
            pass
 
1013
    if width <= 0:
 
1014
        width = 80
 
1015
 
 
1016
    return width
 
1017
 
653
1018
 
654
1019
def supports_executable():
655
1020
    return sys.platform != "win32"
 
1021
 
 
1022
 
 
1023
def supports_posix_readonly():
 
1024
    """Return True if 'readonly' has POSIX semantics, False otherwise.
 
1025
 
 
1026
    Notably, a win32 readonly file cannot be deleted, unlike POSIX where the
 
1027
    directory controls creation/deletion, etc.
 
1028
 
 
1029
    And under win32, readonly means that the directory itself cannot be
 
1030
    deleted.  The contents of a readonly directory can be changed, unlike POSIX
 
1031
    where files in readonly directories cannot be added, deleted or renamed.
 
1032
    """
 
1033
    return sys.platform != "win32"
 
1034
 
 
1035
 
 
1036
def set_or_unset_env(env_variable, value):
 
1037
    """Modify the environment, setting or removing the env_variable.
 
1038
 
 
1039
    :param env_variable: The environment variable in question
 
1040
    :param value: The value to set the environment to. If None, then
 
1041
        the variable will be removed.
 
1042
    :return: The original value of the environment variable.
 
1043
    """
 
1044
    orig_val = os.environ.get(env_variable)
 
1045
    if value is None:
 
1046
        if orig_val is not None:
 
1047
            del os.environ[env_variable]
 
1048
    else:
 
1049
        if isinstance(value, unicode):
 
1050
            value = value.encode(bzrlib.user_encoding)
 
1051
        os.environ[env_variable] = value
 
1052
    return orig_val
 
1053
 
 
1054
 
 
1055
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
 
1056
 
 
1057
 
 
1058
def check_legal_path(path):
 
1059
    """Check whether the supplied path is legal.  
 
1060
    This is only required on Windows, so we don't test on other platforms
 
1061
    right now.
 
1062
    """
 
1063
    if sys.platform != "win32":
 
1064
        return
 
1065
    if _validWin32PathRE.match(path) is None:
 
1066
        raise errors.IllegalPath(path)
 
1067
 
 
1068
 
 
1069
def walkdirs(top, prefix=""):
 
1070
    """Yield data about all the directories in a tree.
 
1071
    
 
1072
    This yields all the data about the contents of a directory at a time.
 
1073
    After each directory has been yielded, if the caller has mutated the list
 
1074
    to exclude some directories, they are then not descended into.
 
1075
    
 
1076
    The data yielded is of the form:
 
1077
    ((directory-relpath, directory-path-from-top),
 
1078
    [(directory-relpath, basename, kind, lstat, path-from-top), ...]),
 
1079
     - directory-relpath is the relative path of the directory being returned
 
1080
       with respect to top. prefix is prepended to this.
 
1081
     - directory-path-from-root is the path including top for this directory. 
 
1082
       It is suitable for use with os functions.
 
1083
     - relpath is the relative path within the subtree being walked.
 
1084
     - basename is the basename of the path
 
1085
     - kind is the kind of the file now. If unknown then the file is not
 
1086
       present within the tree - but it may be recorded as versioned. See
 
1087
       versioned_kind.
 
1088
     - lstat is the stat data *if* the file was statted.
 
1089
     - planned, not implemented: 
 
1090
       path_from_tree_root is the path from the root of the tree.
 
1091
 
 
1092
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This 
 
1093
        allows one to walk a subtree but get paths that are relative to a tree
 
1094
        rooted higher up.
 
1095
    :return: an iterator over the dirs.
 
1096
    """
 
1097
    #TODO there is a bit of a smell where the results of the directory-
 
1098
    # summary in this, and the path from the root, may not agree 
 
1099
    # depending on top and prefix - i.e. ./foo and foo as a pair leads to
 
1100
    # potentially confusing output. We should make this more robust - but
 
1101
    # not at a speed cost. RBC 20060731
 
1102
    _lstat = os.lstat
 
1103
    _directory = _directory_kind
 
1104
    _listdir = os.listdir
 
1105
    _kind_from_mode = _formats.get
 
1106
    pending = [(safe_unicode(prefix), "", _directory, None, safe_unicode(top))]
 
1107
    while pending:
 
1108
        # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
 
1109
        relroot, _, _, _, top = pending.pop()
 
1110
        if relroot:
 
1111
            relprefix = relroot + u'/'
 
1112
        else:
 
1113
            relprefix = ''
 
1114
        top_slash = top + u'/'
 
1115
 
 
1116
        dirblock = []
 
1117
        append = dirblock.append
 
1118
        for name in sorted(_listdir(top)):
 
1119
            abspath = top_slash + name
 
1120
            statvalue = _lstat(abspath)
 
1121
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
 
1122
            append((relprefix + name, name, kind, statvalue, abspath))
 
1123
        yield (relroot, top), dirblock
 
1124
 
 
1125
        # push the user specified dirs from dirblock
 
1126
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
 
1127
 
 
1128
 
 
1129
def _walkdirs_utf8(top, prefix=""):
 
1130
    """Yield data about all the directories in a tree.
 
1131
 
 
1132
    This yields the same information as walkdirs() only each entry is yielded
 
1133
    in utf-8. On platforms which have a filesystem encoding of utf8 the paths
 
1134
    are returned as exact byte-strings.
 
1135
 
 
1136
    :return: yields a tuple of (dir_info, [file_info])
 
1137
        dir_info is (utf8_relpath, path-from-top)
 
1138
        file_info is (utf8_relpath, utf8_name, kind, lstat, path-from-top)
 
1139
        if top is an absolute path, path-from-top is also an absolute path.
 
1140
        path-from-top might be unicode or utf8, but it is the correct path to
 
1141
        pass to os functions to affect the file in question. (such as os.lstat)
 
1142
    """
 
1143
    fs_encoding = sys.getfilesystemencoding()
 
1144
    if (sys.platform == 'win32' or
 
1145
        fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968')): # ascii
 
1146
        return _walkdirs_unicode_to_utf8(top, prefix=prefix)
 
1147
    else:
 
1148
        return _walkdirs_fs_utf8(top, prefix=prefix)
 
1149
 
 
1150
 
 
1151
def _walkdirs_fs_utf8(top, prefix=""):
 
1152
    """See _walkdirs_utf8.
 
1153
 
 
1154
    This sub-function is called when we know the filesystem is already in utf8
 
1155
    encoding. So we don't need to transcode filenames.
 
1156
    """
 
1157
    _lstat = os.lstat
 
1158
    _directory = _directory_kind
 
1159
    _listdir = os.listdir
 
1160
    _kind_from_mode = _formats.get
 
1161
 
 
1162
    # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
 
1163
    # But we don't actually uses 1-3 in pending, so set them to None
 
1164
    pending = [(safe_utf8(prefix), None, None, None, safe_utf8(top))]
 
1165
    while pending:
 
1166
        relroot, _, _, _, top = pending.pop()
 
1167
        if relroot:
 
1168
            relprefix = relroot + '/'
 
1169
        else:
 
1170
            relprefix = ''
 
1171
        top_slash = top + '/'
 
1172
 
 
1173
        dirblock = []
 
1174
        append = dirblock.append
 
1175
        for name in sorted(_listdir(top)):
 
1176
            abspath = top_slash + name
 
1177
            statvalue = _lstat(abspath)
 
1178
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
 
1179
            append((relprefix + name, name, kind, statvalue, abspath))
 
1180
        yield (relroot, top), dirblock
 
1181
 
 
1182
        # push the user specified dirs from dirblock
 
1183
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
 
1184
 
 
1185
 
 
1186
def _walkdirs_unicode_to_utf8(top, prefix=""):
 
1187
    """See _walkdirs_utf8
 
1188
 
 
1189
    Because Win32 has a Unicode api, all of the 'path-from-top' entries will be
 
1190
    Unicode paths.
 
1191
    This is currently the fallback code path when the filesystem encoding is
 
1192
    not UTF-8. It may be better to implement an alternative so that we can
 
1193
    safely handle paths that are not properly decodable in the current
 
1194
    encoding.
 
1195
    """
 
1196
    _utf8_encode = codecs.getencoder('utf8')
 
1197
    _lstat = os.lstat
 
1198
    _directory = _directory_kind
 
1199
    _listdir = os.listdir
 
1200
    _kind_from_mode = _formats.get
 
1201
 
 
1202
    pending = [(safe_utf8(prefix), None, None, None, safe_unicode(top))]
 
1203
    while pending:
 
1204
        relroot, _, _, _, top = pending.pop()
 
1205
        if relroot:
 
1206
            relprefix = relroot + '/'
 
1207
        else:
 
1208
            relprefix = ''
 
1209
        top_slash = top + u'/'
 
1210
 
 
1211
        dirblock = []
 
1212
        append = dirblock.append
 
1213
        for name in sorted(_listdir(top)):
 
1214
            name_utf8 = _utf8_encode(name)[0]
 
1215
            abspath = top_slash + name
 
1216
            statvalue = _lstat(abspath)
 
1217
            kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
 
1218
            append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
 
1219
        yield (relroot, top), dirblock
 
1220
 
 
1221
        # push the user specified dirs from dirblock
 
1222
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
 
1223
 
 
1224
 
 
1225
def copy_tree(from_path, to_path, handlers={}):
 
1226
    """Copy all of the entries in from_path into to_path.
 
1227
 
 
1228
    :param from_path: The base directory to copy. 
 
1229
    :param to_path: The target directory. If it does not exist, it will
 
1230
        be created.
 
1231
    :param handlers: A dictionary of functions, which takes a source and
 
1232
        destinations for files, directories, etc.
 
1233
        It is keyed on the file kind, such as 'directory', 'symlink', or 'file'
 
1234
        'file', 'directory', and 'symlink' should always exist.
 
1235
        If they are missing, they will be replaced with 'os.mkdir()',
 
1236
        'os.readlink() + os.symlink()', and 'shutil.copy2()', respectively.
 
1237
    """
 
1238
    # Now, just copy the existing cached tree to the new location
 
1239
    # We use a cheap trick here.
 
1240
    # Absolute paths are prefixed with the first parameter
 
1241
    # relative paths are prefixed with the second.
 
1242
    # So we can get both the source and target returned
 
1243
    # without any extra work.
 
1244
 
 
1245
    def copy_dir(source, dest):
 
1246
        os.mkdir(dest)
 
1247
 
 
1248
    def copy_link(source, dest):
 
1249
        """Copy the contents of a symlink"""
 
1250
        link_to = os.readlink(source)
 
1251
        os.symlink(link_to, dest)
 
1252
 
 
1253
    real_handlers = {'file':shutil.copy2,
 
1254
                     'symlink':copy_link,
 
1255
                     'directory':copy_dir,
 
1256
                    }
 
1257
    real_handlers.update(handlers)
 
1258
 
 
1259
    if not os.path.exists(to_path):
 
1260
        real_handlers['directory'](from_path, to_path)
 
1261
 
 
1262
    for dir_info, entries in walkdirs(from_path, prefix=to_path):
 
1263
        for relpath, name, kind, st, abspath in entries:
 
1264
            real_handlers[kind](abspath, relpath)
 
1265
 
 
1266
 
 
1267
def path_prefix_key(path):
 
1268
    """Generate a prefix-order path key for path.
 
1269
 
 
1270
    This can be used to sort paths in the same way that walkdirs does.
 
1271
    """
 
1272
    return (dirname(path) , path)
 
1273
 
 
1274
 
 
1275
def compare_paths_prefix_order(path_a, path_b):
 
1276
    """Compare path_a and path_b to generate the same order walkdirs uses."""
 
1277
    key_a = path_prefix_key(path_a)
 
1278
    key_b = path_prefix_key(path_b)
 
1279
    return cmp(key_a, key_b)
 
1280
 
 
1281
 
 
1282
_cached_user_encoding = None
 
1283
 
 
1284
 
 
1285
def get_user_encoding(use_cache=True):
 
1286
    """Find out what the preferred user encoding is.
 
1287
 
 
1288
    This is generally the encoding that is used for command line parameters
 
1289
    and file contents. This may be different from the terminal encoding
 
1290
    or the filesystem encoding.
 
1291
 
 
1292
    :param  use_cache:  Enable cache for detected encoding.
 
1293
                        (This parameter is turned on by default,
 
1294
                        and required only for selftesting)
 
1295
 
 
1296
    :return: A string defining the preferred user encoding
 
1297
    """
 
1298
    global _cached_user_encoding
 
1299
    if _cached_user_encoding is not None and use_cache:
 
1300
        return _cached_user_encoding
 
1301
 
 
1302
    if sys.platform == 'darwin':
 
1303
        # work around egregious python 2.4 bug
 
1304
        sys.platform = 'posix'
 
1305
        try:
 
1306
            import locale
 
1307
        finally:
 
1308
            sys.platform = 'darwin'
 
1309
    else:
 
1310
        import locale
 
1311
 
 
1312
    try:
 
1313
        user_encoding = locale.getpreferredencoding()
 
1314
    except locale.Error, e:
 
1315
        sys.stderr.write('bzr: warning: %s\n'
 
1316
                         '  Could not determine what text encoding to use.\n'
 
1317
                         '  This error usually means your Python interpreter\n'
 
1318
                         '  doesn\'t support the locale set by $LANG (%s)\n'
 
1319
                         "  Continuing with ascii encoding.\n"
 
1320
                         % (e, os.environ.get('LANG')))
 
1321
        user_encoding = 'ascii'
 
1322
 
 
1323
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
 
1324
    # treat that as ASCII, and not support printing unicode characters to the
 
1325
    # console.
 
1326
    if user_encoding in (None, 'cp0'):
 
1327
        user_encoding = 'ascii'
 
1328
    else:
 
1329
        # check encoding
 
1330
        try:
 
1331
            codecs.lookup(user_encoding)
 
1332
        except LookupError:
 
1333
            sys.stderr.write('bzr: warning:'
 
1334
                             ' unknown encoding %s.'
 
1335
                             ' Continuing with ascii encoding.\n'
 
1336
                             % user_encoding
 
1337
                            )
 
1338
            user_encoding = 'ascii'
 
1339
 
 
1340
    if use_cache:
 
1341
        _cached_user_encoding = user_encoding
 
1342
 
 
1343
    return user_encoding
 
1344
 
 
1345
 
 
1346
def recv_all(socket, bytes):
 
1347
    """Receive an exact number of bytes.
 
1348
 
 
1349
    Regular Socket.recv() may return less than the requested number of bytes,
 
1350
    dependning on what's in the OS buffer.  MSG_WAITALL is not available
 
1351
    on all platforms, but this should work everywhere.  This will return
 
1352
    less than the requested amount if the remote end closes.
 
1353
 
 
1354
    This isn't optimized and is intended mostly for use in testing.
 
1355
    """
 
1356
    b = ''
 
1357
    while len(b) < bytes:
 
1358
        new = socket.recv(bytes - len(b))
 
1359
        if new == '':
 
1360
            break # eof
 
1361
        b += new
 
1362
    return b
 
1363
 
 
1364
def dereference_path(path):
 
1365
    """Determine the real path to a file.
 
1366
 
 
1367
    All parent elements are dereferenced.  But the file itself is not
 
1368
    dereferenced.
 
1369
    :param path: The original path.  May be absolute or relative.
 
1370
    :return: the real path *to* the file
 
1371
    """
 
1372
    parent, base = os.path.split(path)
 
1373
    # The pathjoin for '.' is a workaround for Python bug #1213894.
 
1374
    # (initial path components aren't dereferenced)
 
1375
    return pathjoin(realpath(pathjoin('.', parent)), base)