← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: John Arbash Meinel
  • Date: 2009-06-19 19:26:32 UTC
  • mto: This revision was merged to the branch mainline in revision 4466.
  • Revision ID: john@arbash-meinel.com-20090619192632-1a4ntoq61fkhlp2x
Make a note of the 'worst case' for heads.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/osutils.py
1
 
# Bazaar -- distributed version control
2
 
#
3
 
# Copyright (C) 2005 by Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2009 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
14
12
#
15
13
# You should have received a copy of the GNU General Public License
16
14
# along with this program; if not, write to the Free Software
17
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18
 
 
19
 
from cStringIO import StringIO
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
import os
 
18
import re
 
19
import stat
 
20
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
 
21
                  S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
 
22
import sys
 
23
import time
 
24
 
 
25
from bzrlib.lazy_import import lazy_import
 
26
lazy_import(globals(), """
 
27
import codecs
 
28
from datetime import datetime
20
29
import errno
21
30
from ntpath import (abspath as _nt_abspath,
22
31
                    join as _nt_join,
24
33
                    realpath as _nt_realpath,
25
34
                    splitdrive as _nt_splitdrive,
26
35
                    )
27
 
import os
28
 
from os import listdir
29
36
import posixpath
30
 
import re
31
 
import sha
32
37
import shutil
33
 
from shutil import copyfile
34
 
import stat
35
 
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
36
 
                  S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
37
 
import string
38
 
import sys
39
 
import time
40
 
import types
 
38
from shutil import (
 
39
    rmtree,
 
40
    )
 
41
import subprocess
41
42
import tempfile
 
43
from tempfile import (
 
44
    mkdtemp,
 
45
    )
42
46
import unicodedata
43
47
 
 
48
from bzrlib import (
 
49
    cache_utf8,
 
50
    errors,
 
51
    win32utils,
 
52
    )
 
53
""")
 
54
 
 
55
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
 
56
# of 2.5
 
57
if sys.version_info < (2, 5):
 
58
    import md5 as _mod_md5
 
59
    md5 = _mod_md5.new
 
60
    import sha as _mod_sha
 
61
    sha = _mod_sha.new
 
62
else:
 
63
    from hashlib import (
 
64
        md5,
 
65
        sha1 as sha,
 
66
        )
 
67
 
 
68
 
44
69
import bzrlib
45
 
from bzrlib.errors import (BzrError,
46
 
                           BzrBadParameterNotUnicode,
47
 
                           NoSuchFile,
48
 
                           PathNotChild,
49
 
                           IllegalPath,
50
 
                           )
51
 
from bzrlib.symbol_versioning import (deprecated_function, 
52
 
        zero_nine)
53
 
from bzrlib.trace import mutter
 
70
from bzrlib import symbol_versioning
54
71
 
55
72
 
56
73
# On win32, O_BINARY is used to indicate the file should
61
78
O_BINARY = getattr(os, 'O_BINARY', 0)
62
79
 
63
80
 
 
81
def get_unicode_argv():
 
82
    try:
 
83
        user_encoding = get_user_encoding()
 
84
        return [a.decode(user_encoding) for a in sys.argv[1:]]
 
85
    except UnicodeDecodeError:
 
86
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
 
87
                                                            "encoding." % a))
 
88
 
 
89
 
64
90
def make_readonly(filename):
65
91
    """Make a filename read-only."""
66
 
    mod = os.stat(filename).st_mode
67
 
    mod = mod & 0777555
68
 
    os.chmod(filename, mod)
 
92
    mod = os.lstat(filename).st_mode
 
93
    if not stat.S_ISLNK(mod):
 
94
        mod = mod & 0777555
 
95
        os.chmod(filename, mod)
69
96
 
70
97
 
71
98
def make_writable(filename):
72
 
    mod = os.stat(filename).st_mode
73
 
    mod = mod | 0200
74
 
    os.chmod(filename, mod)
 
99
    mod = os.lstat(filename).st_mode
 
100
    if not stat.S_ISLNK(mod):
 
101
        mod = mod | 0200
 
102
        os.chmod(filename, mod)
 
103
 
 
104
 
 
105
def minimum_path_selection(paths):
 
106
    """Return the smallset subset of paths which are outside paths.
 
107
 
 
108
    :param paths: A container (and hence not None) of paths.
 
109
    :return: A set of paths sufficient to include everything in paths via
 
110
        is_inside, drawn from the paths parameter.
 
111
    """
 
112
    if len(paths) < 2:
 
113
        return set(paths)
 
114
 
 
115
    def sort_key(path):
 
116
        return path.split('/')
 
117
    sorted_paths = sorted(list(paths), key=sort_key)
 
118
 
 
119
    search_paths = [sorted_paths[0]]
 
120
    for path in sorted_paths[1:]:
 
121
        if not is_inside(search_paths[-1], path):
 
122
            # This path is unique, add it
 
123
            search_paths.append(path)
 
124
 
 
125
    return set(search_paths)
75
126
 
76
127
 
77
128
_QUOTE_RE = None
84
135
    Windows."""
85
136
    # TODO: I'm not really sure this is the best format either.x
86
137
    global _QUOTE_RE
87
 
    if _QUOTE_RE == None:
 
138
    if _QUOTE_RE is None:
88
139
        _QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
89
 
        
 
140
 
90
141
    if _QUOTE_RE.search(f):
91
142
        return '"' + f + '"'
92
143
    else:
95
146
 
96
147
_directory_kind = 'directory'
97
148
 
98
 
_formats = {
99
 
    stat.S_IFDIR:_directory_kind,
100
 
    stat.S_IFCHR:'chardev',
101
 
    stat.S_IFBLK:'block',
102
 
    stat.S_IFREG:'file',
103
 
    stat.S_IFIFO:'fifo',
104
 
    stat.S_IFLNK:'symlink',
105
 
    stat.S_IFSOCK:'socket',
106
 
}
107
 
 
108
 
 
109
 
def file_kind_from_stat_mode(stat_mode, _formats=_formats, _unknown='unknown'):
110
 
    """Generate a file kind from a stat mode. This is used in walkdirs.
111
 
 
112
 
    Its performance is critical: Do not mutate without careful benchmarking.
113
 
    """
114
 
    try:
115
 
        return _formats[stat_mode & 0170000]
116
 
    except KeyError:
117
 
        return _unknown
118
 
 
119
 
 
120
 
def file_kind(f, _lstat=os.lstat, _mapper=file_kind_from_stat_mode):
121
 
    try:
122
 
        return _mapper(_lstat(f).st_mode)
123
 
    except OSError, e:
124
 
        if getattr(e, 'errno', None) == errno.ENOENT:
125
 
            raise bzrlib.errors.NoSuchFile(f)
126
 
        raise
127
 
 
128
 
 
129
149
def get_umask():
130
150
    """Return the current umask"""
131
151
    # Assume that people aren't messing with the umask while running
136
156
    return umask
137
157
 
138
158
 
 
159
_kind_marker_map = {
 
160
    "file": "",
 
161
    _directory_kind: "/",
 
162
    "symlink": "@",
 
163
    'tree-reference': '+',
 
164
}
 
165
 
 
166
 
139
167
def kind_marker(kind):
140
 
    if kind == 'file':
141
 
        return ''
142
 
    elif kind == _directory_kind:
143
 
        return '/'
144
 
    elif kind == 'symlink':
145
 
        return '@'
146
 
    else:
147
 
        raise BzrError('invalid file kind %r' % kind)
 
168
    try:
 
169
        return _kind_marker_map[kind]
 
170
    except KeyError:
 
171
        raise errors.BzrError('invalid file kind %r' % kind)
 
172
 
148
173
 
149
174
lexists = getattr(os.path, 'lexists', None)
150
175
if lexists is None:
151
176
    def lexists(f):
152
177
        try:
153
 
            if hasattr(os, 'lstat'):
154
 
                os.lstat(f)
155
 
            else:
156
 
                os.stat(f)
 
178
            stat = getattr(os, 'lstat', os.stat)
 
179
            stat(f)
157
180
            return True
158
 
        except OSError,e:
 
181
        except OSError, e:
159
182
            if e.errno == errno.ENOENT:
160
183
                return False;
161
184
            else:
162
 
                raise BzrError("lstat/stat of (%r): %r" % (f, e))
 
185
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
163
186
 
164
187
 
165
188
def fancy_rename(old, new, rename_func, unlink_func):
166
189
    """A fancy rename, when you don't have atomic rename.
167
 
    
 
190
 
168
191
    :param old: The old path, to rename from
169
192
    :param new: The new path, to rename to
170
193
    :param rename_func: The potentially non-atomic rename function
172
195
    """
173
196
 
174
197
    # sftp rename doesn't allow overwriting, so play tricks:
175
 
    import random
176
198
    base = os.path.basename(new)
177
199
    dirname = os.path.dirname(new)
178
200
    tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
186
208
    file_existed = False
187
209
    try:
188
210
        rename_func(new, tmp_name)
189
 
    except (NoSuchFile,), e:
 
211
    except (errors.NoSuchFile,), e:
190
212
        pass
191
213
    except IOError, e:
192
214
        # RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
193
 
        # function raises an IOError with errno == None when a rename fails.
 
215
        # function raises an IOError with errno is None when a rename fails.
194
216
        # This then gets caught here.
195
217
        if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
196
218
            raise
197
219
    except Exception, e:
198
 
        if (not hasattr(e, 'errno') 
 
220
        if (getattr(e, 'errno', None) is None
199
221
            or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
200
222
            raise
201
223
    else:
203
225
 
204
226
    success = False
205
227
    try:
206
 
        # This may throw an exception, in which case success will
207
 
        # not be set.
208
 
        rename_func(old, new)
209
 
        success = True
 
228
        try:
 
229
            # This may throw an exception, in which case success will
 
230
            # not be set.
 
231
            rename_func(old, new)
 
232
            success = True
 
233
        except (IOError, OSError), e:
 
234
            # source and target may be aliases of each other (e.g. on a
 
235
            # case-insensitive filesystem), so we may have accidentally renamed
 
236
            # source by when we tried to rename target
 
237
            if not (file_existed and e.errno in (None, errno.ENOENT)):
 
238
                raise
210
239
    finally:
211
240
        if file_existed:
212
241
            # If the file used to exist, rename it back into place
221
250
# choke on a Unicode string containing a relative path if
222
251
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
223
252
# string.
224
 
_fs_enc = sys.getfilesystemencoding()
 
253
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
225
254
def _posix_abspath(path):
226
255
    # jam 20060426 rather than encoding to fsencoding
227
256
    # copy posixpath.abspath, but use os.getcwdu instead
252
281
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
253
282
 
254
283
 
 
284
def _win98_abspath(path):
 
285
    """Return the absolute version of a path.
 
286
    Windows 98 safe implementation (python reimplementation
 
287
    of Win32 API function GetFullPathNameW)
 
288
    """
 
289
    # Corner cases:
 
290
    #   C:\path     => C:/path
 
291
    #   C:/path     => C:/path
 
292
    #   \\HOST\path => //HOST/path
 
293
    #   //HOST/path => //HOST/path
 
294
    #   path        => C:/cwd/path
 
295
    #   /path       => C:/path
 
296
    path = unicode(path)
 
297
    # check for absolute path
 
298
    drive = _nt_splitdrive(path)[0]
 
299
    if drive == '' and path[:2] not in('//','\\\\'):
 
300
        cwd = os.getcwdu()
 
301
        # we cannot simply os.path.join cwd and path
 
302
        # because os.path.join('C:','/path') produce '/path'
 
303
        # and this is incorrect
 
304
        if path[:1] in ('/','\\'):
 
305
            cwd = _nt_splitdrive(cwd)[0]
 
306
            path = path[1:]
 
307
        path = cwd + '\\' + path
 
308
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
 
309
 
 
310
 
255
311
def _win32_realpath(path):
256
312
    # Real _nt_realpath doesn't have a problem with a unicode cwd
257
313
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
277
333
    """We expect to be able to atomically replace 'new' with old.
278
334
 
279
335
    On win32, if new exists, it must be moved out of the way first,
280
 
    and then deleted. 
 
336
    and then deleted.
281
337
    """
282
338
    try:
283
339
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
284
340
    except OSError, e:
285
341
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
286
 
            # If we try to rename a non-existant file onto cwd, we get 
287
 
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT 
 
342
            # If we try to rename a non-existant file onto cwd, we get
 
343
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT
288
344
            # if the old path doesn't exist, sometimes we get EACCES
289
345
            # On Linux, we seem to get EBUSY, on Mac we get EINVAL
290
346
            os.lstat(old)
292
348
 
293
349
 
294
350
def _mac_getcwd():
295
 
    return unicodedata.normalize('NFKC', os.getcwdu())
 
351
    return unicodedata.normalize('NFC', os.getcwdu())
296
352
 
297
353
 
298
354
# Default is to just use the python builtins, but these can be rebound on
302
358
pathjoin = os.path.join
303
359
normpath = os.path.normpath
304
360
getcwd = os.getcwdu
305
 
mkdtemp = tempfile.mkdtemp
306
361
rename = os.rename
307
362
dirname = os.path.dirname
308
363
basename = os.path.basename
309
 
rmtree = shutil.rmtree
 
364
split = os.path.split
 
365
splitext = os.path.splitext
 
366
# These were already imported into local scope
 
367
# mkdtemp = tempfile.mkdtemp
 
368
# rmtree = shutil.rmtree
310
369
 
311
370
MIN_ABS_PATHLENGTH = 1
312
371
 
313
372
 
314
373
if sys.platform == 'win32':
315
 
    abspath = _win32_abspath
 
374
    if win32utils.winver == 'Windows 98':
 
375
        abspath = _win98_abspath
 
376
    else:
 
377
        abspath = _win32_abspath
316
378
    realpath = _win32_realpath
317
379
    pathjoin = _win32_pathjoin
318
380
    normpath = _win32_normpath
326
388
        """Error handler for shutil.rmtree function [for win32]
327
389
        Helps to remove files and dirs marked as read-only.
328
390
        """
329
 
        type_, value = excinfo[:2]
 
391
        exception = excinfo[1]
330
392
        if function in (os.remove, os.rmdir) \
331
 
            and type_ == OSError \
332
 
            and value.errno == errno.EACCES:
333
 
            bzrlib.osutils.make_writable(path)
 
393
            and isinstance(exception, OSError) \
 
394
            and exception.errno == errno.EACCES:
 
395
            make_writable(path)
334
396
            function(path)
335
397
        else:
336
398
            raise
338
400
    def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
339
401
        """Replacer for shutil.rmtree: could remove readonly dirs/files"""
340
402
        return shutil.rmtree(path, ignore_errors, onerror)
 
403
 
 
404
    f = win32utils.get_unicode_argv     # special function or None
 
405
    if f is not None:
 
406
        get_unicode_argv = f
 
407
 
341
408
elif sys.platform == 'darwin':
342
409
    getcwd = _mac_getcwd
343
410
 
347
414
 
348
415
    This attempts to check both sys.stdout and sys.stdin to see
349
416
    what encoding they are in, and if that fails it falls back to
350
 
    bzrlib.user_encoding.
 
417
    osutils.get_user_encoding().
351
418
    The problem is that on Windows, locale.getpreferredencoding()
352
419
    is not the same encoding as that used by the console:
353
420
    http://mail.python.org/pipermail/python-list/2003-May/162357.html
355
422
    On my standard US Windows XP, the preferred encoding is
356
423
    cp1252, but the console is cp437
357
424
    """
 
425
    from bzrlib.trace import mutter
358
426
    output_encoding = getattr(sys.stdout, 'encoding', None)
359
427
    if not output_encoding:
360
428
        input_encoding = getattr(sys.stdin, 'encoding', None)
361
429
        if not input_encoding:
362
 
            output_encoding = bzrlib.user_encoding
363
 
            mutter('encoding stdout as bzrlib.user_encoding %r', output_encoding)
 
430
            output_encoding = get_user_encoding()
 
431
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
432
                   output_encoding)
364
433
        else:
365
434
            output_encoding = input_encoding
366
435
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
367
436
    else:
368
437
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
438
    if output_encoding == 'cp0':
 
439
        # invalid encoding (cp0 means 'no codepage' on Windows)
 
440
        output_encoding = get_user_encoding()
 
441
        mutter('cp0 is invalid encoding.'
 
442
               ' encoding stdout as osutils.get_user_encoding() %r',
 
443
               output_encoding)
 
444
    # check encoding
 
445
    try:
 
446
        codecs.lookup(output_encoding)
 
447
    except LookupError:
 
448
        sys.stderr.write('bzr: warning:'
 
449
                         ' unknown terminal encoding %s.\n'
 
450
                         '  Using encoding %s instead.\n'
 
451
                         % (output_encoding, get_user_encoding())
 
452
                        )
 
453
        output_encoding = get_user_encoding()
 
454
 
369
455
    return output_encoding
370
456
 
371
457
 
372
458
def normalizepath(f):
373
 
    if hasattr(os.path, 'realpath'):
 
459
    if getattr(os.path, 'realpath', None) is not None:
374
460
        F = realpath
375
461
    else:
376
462
        F = abspath
381
467
        return pathjoin(F(p), e)
382
468
 
383
469
 
384
 
def backup_file(fn):
385
 
    """Copy a file to a backup.
386
 
 
387
 
    Backups are named in GNU-style, with a ~ suffix.
388
 
 
389
 
    If the file is already a backup, it's not copied.
390
 
    """
391
 
    if fn[-1] == '~':
392
 
        return
393
 
    bfn = fn + '~'
394
 
 
395
 
    if has_symlinks() and os.path.islink(fn):
396
 
        target = os.readlink(fn)
397
 
        os.symlink(target, bfn)
398
 
        return
399
 
    inf = file(fn, 'rb')
400
 
    try:
401
 
        content = inf.read()
402
 
    finally:
403
 
        inf.close()
404
 
    
405
 
    outf = file(bfn, 'wb')
406
 
    try:
407
 
        outf.write(content)
408
 
    finally:
409
 
        outf.close()
410
 
 
411
 
 
412
470
def isdir(f):
413
471
    """True if f is an accessible directory."""
414
472
    try:
433
491
 
434
492
def is_inside(dir, fname):
435
493
    """True if fname is inside dir.
436
 
    
 
494
 
437
495
    The parameters should typically be passed to osutils.normpath first, so
438
496
    that . and .. and repeated slashes are eliminated, and the separators
439
497
    are canonical for the platform.
440
 
    
441
 
    The empty string as a dir name is taken as top-of-tree and matches 
 
498
 
 
499
    The empty string as a dir name is taken as top-of-tree and matches
442
500
    everything.
443
 
    
444
 
    >>> is_inside('src', pathjoin('src', 'foo.c'))
445
 
    True
446
 
    >>> is_inside('src', 'srccontrol')
447
 
    False
448
 
    >>> is_inside('src', pathjoin('src', 'a', 'a', 'a', 'foo.c'))
449
 
    True
450
 
    >>> is_inside('foo.c', 'foo.c')
451
 
    True
452
 
    >>> is_inside('foo.c', '')
453
 
    False
454
 
    >>> is_inside('', 'foo.c')
455
 
    True
456
501
    """
457
 
    # XXX: Most callers of this can actually do something smarter by 
 
502
    # XXX: Most callers of this can actually do something smarter by
458
503
    # looking at the inventory
459
504
    if dir == fname:
460
505
        return True
461
 
    
 
506
 
462
507
    if dir == '':
463
508
        return True
464
509
 
473
518
    for dirname in dir_list:
474
519
        if is_inside(dirname, fname):
475
520
            return True
476
 
    else:
477
 
        return False
 
521
    return False
478
522
 
479
523
 
480
524
def is_inside_or_parent_of_any(dir_list, fname):
482
526
    for dirname in dir_list:
483
527
        if is_inside(dirname, fname) or is_inside(fname, dirname):
484
528
            return True
 
529
    return False
 
530
 
 
531
 
 
532
def pumpfile(from_file, to_file, read_length=-1, buff_size=32768,
 
533
             report_activity=None, direction='read'):
 
534
    """Copy contents of one file to another.
 
535
 
 
536
    The read_length can either be -1 to read to end-of-file (EOF) or
 
537
    it can specify the maximum number of bytes to read.
 
538
 
 
539
    The buff_size represents the maximum size for each read operation
 
540
    performed on from_file.
 
541
 
 
542
    :param report_activity: Call this as bytes are read, see
 
543
        Transport._report_activity
 
544
    :param direction: Will be passed to report_activity
 
545
 
 
546
    :return: The number of bytes copied.
 
547
    """
 
548
    length = 0
 
549
    if read_length >= 0:
 
550
        # read specified number of bytes
 
551
 
 
552
        while read_length > 0:
 
553
            num_bytes_to_read = min(read_length, buff_size)
 
554
 
 
555
            block = from_file.read(num_bytes_to_read)
 
556
            if not block:
 
557
                # EOF reached
 
558
                break
 
559
            if report_activity is not None:
 
560
                report_activity(len(block), direction)
 
561
            to_file.write(block)
 
562
 
 
563
            actual_bytes_read = len(block)
 
564
            read_length -= actual_bytes_read
 
565
            length += actual_bytes_read
485
566
    else:
486
 
        return False
487
 
 
488
 
 
489
 
def pumpfile(fromfile, tofile):
490
 
    """Copy contents of one file to another."""
491
 
    BUFSIZE = 32768
492
 
    while True:
493
 
        b = fromfile.read(BUFSIZE)
494
 
        if not b:
495
 
            break
496
 
        tofile.write(b)
 
567
        # read to EOF
 
568
        while True:
 
569
            block = from_file.read(buff_size)
 
570
            if not block:
 
571
                # EOF reached
 
572
                break
 
573
            if report_activity is not None:
 
574
                report_activity(len(block), direction)
 
575
            to_file.write(block)
 
576
            length += len(block)
 
577
    return length
 
578
 
 
579
 
 
580
def pump_string_file(bytes, file_handle, segment_size=None):
 
581
    """Write bytes to file_handle in many smaller writes.
 
582
 
 
583
    :param bytes: The string to write.
 
584
    :param file_handle: The file to write to.
 
585
    """
 
586
    # Write data in chunks rather than all at once, because very large
 
587
    # writes fail on some platforms (e.g. Windows with SMB  mounted
 
588
    # drives).
 
589
    if not segment_size:
 
590
        segment_size = 5242880 # 5MB
 
591
    segments = range(len(bytes) / segment_size + 1)
 
592
    write = file_handle.write
 
593
    for segment_index in segments:
 
594
        segment = buffer(bytes, segment_index * segment_size, segment_size)
 
595
        write(segment)
497
596
 
498
597
 
499
598
def file_iterator(input_file, readsize=32768):
505
604
 
506
605
 
507
606
def sha_file(f):
508
 
    if hasattr(f, 'tell'):
509
 
        assert f.tell() == 0
510
 
    s = sha.new()
 
607
    """Calculate the hexdigest of an open file.
 
608
 
 
609
    The file cursor should be already at the start.
 
610
    """
 
611
    s = sha()
511
612
    BUFSIZE = 128<<10
512
613
    while True:
513
614
        b = f.read(BUFSIZE)
517
618
    return s.hexdigest()
518
619
 
519
620
 
520
 
 
521
 
def sha_strings(strings):
 
621
def size_sha_file(f):
 
622
    """Calculate the size and hexdigest of an open file.
 
623
 
 
624
    The file cursor should be already at the start and
 
625
    the caller is responsible for closing the file afterwards.
 
626
    """
 
627
    size = 0
 
628
    s = sha()
 
629
    BUFSIZE = 128<<10
 
630
    while True:
 
631
        b = f.read(BUFSIZE)
 
632
        if not b:
 
633
            break
 
634
        size += len(b)
 
635
        s.update(b)
 
636
    return size, s.hexdigest()
 
637
 
 
638
 
 
639
def sha_file_by_name(fname):
 
640
    """Calculate the SHA1 of a file by reading the full text"""
 
641
    s = sha()
 
642
    f = os.open(fname, os.O_RDONLY | O_BINARY)
 
643
    try:
 
644
        while True:
 
645
            b = os.read(f, 1<<16)
 
646
            if not b:
 
647
                return s.hexdigest()
 
648
            s.update(b)
 
649
    finally:
 
650
        os.close(f)
 
651
 
 
652
 
 
653
def sha_strings(strings, _factory=sha):
522
654
    """Return the sha-1 of concatenation of strings"""
523
 
    s = sha.new()
 
655
    s = _factory()
524
656
    map(s.update, strings)
525
657
    return s.hexdigest()
526
658
 
527
659
 
528
 
def sha_string(f):
529
 
    s = sha.new()
530
 
    s.update(f)
531
 
    return s.hexdigest()
 
660
def sha_string(f, _factory=sha):
 
661
    return _factory(f).hexdigest()
532
662
 
533
663
 
534
664
def fingerprint_file(f):
535
 
    s = sha.new()
536
665
    b = f.read()
537
 
    s.update(b)
538
 
    size = len(b)
539
 
    return {'size': size,
540
 
            'sha1': s.hexdigest()}
 
666
    return {'size': len(b),
 
667
            'sha1': sha(b).hexdigest()}
541
668
 
542
669
 
543
670
def compare_files(a, b):
554
681
 
555
682
def local_time_offset(t=None):
556
683
    """Return offset of local zone from GMT, either at present or at time t."""
557
 
    # python2.3 localtime() can't take None
558
 
    if t == None:
 
684
    if t is None:
559
685
        t = time.time()
560
 
        
561
 
    if time.localtime(t).tm_isdst and time.daylight:
562
 
        return -time.altzone
563
 
    else:
564
 
        return -time.timezone
565
 
 
566
 
    
567
 
def format_date(t, offset=0, timezone='original', date_fmt=None, 
 
686
    offset = datetime.fromtimestamp(t) - datetime.utcfromtimestamp(t)
 
687
    return offset.days * 86400 + offset.seconds
 
688
 
 
689
weekdays = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
 
690
 
 
691
def format_date(t, offset=0, timezone='original', date_fmt=None,
568
692
                show_offset=True):
569
 
    ## TODO: Perhaps a global option to use either universal or local time?
570
 
    ## Or perhaps just let people set $TZ?
571
 
    assert isinstance(t, float)
572
 
    
 
693
    """Return a formatted date string.
 
694
 
 
695
    :param t: Seconds since the epoch.
 
696
    :param offset: Timezone offset in seconds east of utc.
 
697
    :param timezone: How to display the time: 'utc', 'original' for the
 
698
         timezone specified by offset, or 'local' for the process's current
 
699
         timezone.
 
700
    :param date_fmt: strftime format.
 
701
    :param show_offset: Whether to append the timezone.
 
702
    """
 
703
    (date_fmt, tt, offset_str) = \
 
704
               _format_date(t, offset, timezone, date_fmt, show_offset)
 
705
    date_fmt = date_fmt.replace('%a', weekdays[tt[6]])
 
706
    date_str = time.strftime(date_fmt, tt)
 
707
    return date_str + offset_str
 
708
 
 
709
def format_local_date(t, offset=0, timezone='original', date_fmt=None,
 
710
                      show_offset=True):
 
711
    """Return an unicode date string formatted according to the current locale.
 
712
 
 
713
    :param t: Seconds since the epoch.
 
714
    :param offset: Timezone offset in seconds east of utc.
 
715
    :param timezone: How to display the time: 'utc', 'original' for the
 
716
         timezone specified by offset, or 'local' for the process's current
 
717
         timezone.
 
718
    :param date_fmt: strftime format.
 
719
    :param show_offset: Whether to append the timezone.
 
720
    """
 
721
    (date_fmt, tt, offset_str) = \
 
722
               _format_date(t, offset, timezone, date_fmt, show_offset)
 
723
    date_str = time.strftime(date_fmt, tt)
 
724
    if not isinstance(date_str, unicode):
 
725
        date_str = date_str.decode(get_user_encoding(), 'replace')
 
726
    return date_str + offset_str
 
727
 
 
728
def _format_date(t, offset, timezone, date_fmt, show_offset):
573
729
    if timezone == 'utc':
574
730
        tt = time.gmtime(t)
575
731
        offset = 0
576
732
    elif timezone == 'original':
577
 
        if offset == None:
 
733
        if offset is None:
578
734
            offset = 0
579
735
        tt = time.gmtime(t + offset)
580
736
    elif timezone == 'local':
581
737
        tt = time.localtime(t)
582
738
        offset = local_time_offset(t)
583
739
    else:
584
 
        raise BzrError("unsupported timezone format %r" % timezone,
585
 
                       ['options are "utc", "original", "local"'])
 
740
        raise errors.UnsupportedTimezoneFormat(timezone)
586
741
    if date_fmt is None:
587
742
        date_fmt = "%a %Y-%m-%d %H:%M:%S"
588
743
    if show_offset:
589
744
        offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
590
745
    else:
591
746
        offset_str = ''
592
 
    return (time.strftime(date_fmt, tt) +  offset_str)
 
747
    return (date_fmt, tt, offset_str)
593
748
 
594
749
 
595
750
def compact_date(when):
596
751
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
597
 
    
598
 
 
 
752
 
 
753
 
 
754
def format_delta(delta):
 
755
    """Get a nice looking string for a time delta.
 
756
 
 
757
    :param delta: The time difference in seconds, can be positive or negative.
 
758
        positive indicates time in the past, negative indicates time in the
 
759
        future. (usually time.time() - stored_time)
 
760
    :return: String formatted to show approximate resolution
 
761
    """
 
762
    delta = int(delta)
 
763
    if delta >= 0:
 
764
        direction = 'ago'
 
765
    else:
 
766
        direction = 'in the future'
 
767
        delta = -delta
 
768
 
 
769
    seconds = delta
 
770
    if seconds < 90: # print seconds up to 90 seconds
 
771
        if seconds == 1:
 
772
            return '%d second %s' % (seconds, direction,)
 
773
        else:
 
774
            return '%d seconds %s' % (seconds, direction)
 
775
 
 
776
    minutes = int(seconds / 60)
 
777
    seconds -= 60 * minutes
 
778
    if seconds == 1:
 
779
        plural_seconds = ''
 
780
    else:
 
781
        plural_seconds = 's'
 
782
    if minutes < 90: # print minutes, seconds up to 90 minutes
 
783
        if minutes == 1:
 
784
            return '%d minute, %d second%s %s' % (
 
785
                    minutes, seconds, plural_seconds, direction)
 
786
        else:
 
787
            return '%d minutes, %d second%s %s' % (
 
788
                    minutes, seconds, plural_seconds, direction)
 
789
 
 
790
    hours = int(minutes / 60)
 
791
    minutes -= 60 * hours
 
792
    if minutes == 1:
 
793
        plural_minutes = ''
 
794
    else:
 
795
        plural_minutes = 's'
 
796
 
 
797
    if hours == 1:
 
798
        return '%d hour, %d minute%s %s' % (hours, minutes,
 
799
                                            plural_minutes, direction)
 
800
    return '%d hours, %d minute%s %s' % (hours, minutes,
 
801
                                         plural_minutes, direction)
599
802
 
600
803
def filesize(f):
601
804
    """Return size of given open file."""
611
814
except (NotImplementedError, AttributeError):
612
815
    # If python doesn't have os.urandom, or it doesn't work,
613
816
    # then try to first pull random data from /dev/urandom
614
 
    if os.path.exists("/dev/urandom"):
 
817
    try:
615
818
        rand_bytes = file('/dev/urandom', 'rb').read
616
819
    # Otherwise, use this hack as a last resort
617
 
    else:
 
820
    except (IOError, OSError):
618
821
        # not well seeded, but better than nothing
619
822
        def rand_bytes(n):
620
823
            import random
628
831
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
629
832
def rand_chars(num):
630
833
    """Return a random string of num alphanumeric characters
631
 
    
632
 
    The result only contains lowercase chars because it may be used on 
 
834
 
 
835
    The result only contains lowercase chars because it may be used on
633
836
    case-insensitive filesystems.
634
837
    """
635
838
    s = ''
642
845
## decomposition (might be too tricksy though.)
643
846
 
644
847
def splitpath(p):
645
 
    """Turn string into list of parts.
646
 
 
647
 
    >>> splitpath('a')
648
 
    ['a']
649
 
    >>> splitpath('a/b')
650
 
    ['a', 'b']
651
 
    >>> splitpath('a/./b')
652
 
    ['a', 'b']
653
 
    >>> splitpath('a/.b')
654
 
    ['a', '.b']
655
 
    >>> splitpath('a/../b')
656
 
    Traceback (most recent call last):
657
 
    ...
658
 
    BzrError: sorry, '..' not allowed in path
659
 
    """
660
 
    assert isinstance(p, types.StringTypes)
661
 
 
 
848
    """Turn string into list of parts."""
662
849
    # split on either delimiter because people might use either on
663
850
    # Windows
664
851
    ps = re.split(r'[\\/]', p)
666
853
    rps = []
667
854
    for f in ps:
668
855
        if f == '..':
669
 
            raise BzrError("sorry, %r not allowed in path" % f)
 
856
            raise errors.BzrError("sorry, %r not allowed in path" % f)
670
857
        elif (f == '.') or (f == ''):
671
858
            pass
672
859
        else:
673
860
            rps.append(f)
674
861
    return rps
675
862
 
 
863
 
676
864
def joinpath(p):
677
 
    assert isinstance(p, list)
678
865
    for f in p:
679
 
        if (f == '..') or (f == None) or (f == ''):
680
 
            raise BzrError("sorry, %r not allowed in path" % f)
 
866
        if (f == '..') or (f is None) or (f == ''):
 
867
            raise errors.BzrError("sorry, %r not allowed in path" % f)
681
868
    return pathjoin(*p)
682
869
 
683
870
 
684
 
@deprecated_function(zero_nine)
685
 
def appendpath(p1, p2):
686
 
    if p1 == '':
687
 
        return p2
688
 
    else:
689
 
        return pathjoin(p1, p2)
 
871
def parent_directories(filename):
 
872
    """Return the list of parent directories, deepest first.
690
873
    
 
874
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
 
875
    """
 
876
    parents = []
 
877
    parts = splitpath(dirname(filename))
 
878
    while parts:
 
879
        parents.append(joinpath(parts))
 
880
        parts.pop()
 
881
    return parents
 
882
 
 
883
 
 
884
try:
 
885
    from bzrlib._chunks_to_lines_pyx import chunks_to_lines
 
886
except ImportError:
 
887
    from bzrlib._chunks_to_lines_py import chunks_to_lines
 
888
 
691
889
 
692
890
def split_lines(s):
693
891
    """Split s into lines, but without removing the newline characters."""
 
892
    # Trivially convert a fulltext into a 'chunked' representation, and let
 
893
    # chunks_to_lines do the heavy lifting.
 
894
    if isinstance(s, str):
 
895
        # chunks_to_lines only supports 8-bit strings
 
896
        return chunks_to_lines([s])
 
897
    else:
 
898
        return _split_lines(s)
 
899
 
 
900
 
 
901
def _split_lines(s):
 
902
    """Split s into lines, but without removing the newline characters.
 
903
 
 
904
    This supports Unicode or plain string objects.
 
905
    """
694
906
    lines = s.split('\n')
695
907
    result = [line + '\n' for line in lines[:-1]]
696
908
    if lines[-1]:
705
917
def link_or_copy(src, dest):
706
918
    """Hardlink a file, or copy it if it can't be hardlinked."""
707
919
    if not hardlinks_good():
708
 
        copyfile(src, dest)
 
920
        shutil.copyfile(src, dest)
709
921
        return
710
922
    try:
711
923
        os.link(src, dest)
712
924
    except (OSError, IOError), e:
713
925
        if e.errno != errno.EXDEV:
714
926
            raise
715
 
        copyfile(src, dest)
716
 
 
717
 
def delete_any(full_path):
 
927
        shutil.copyfile(src, dest)
 
928
 
 
929
 
 
930
# Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
 
931
# Forgiveness than Permission (EAFP) because:
 
932
# - root can damage a solaris file system by using unlink,
 
933
# - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
 
934
#   EACCES, OSX: EPERM) when invoked on a directory.
 
935
def delete_any(path):
718
936
    """Delete a file or directory."""
719
 
    try:
720
 
        os.unlink(full_path)
721
 
    except OSError, e:
722
 
    # We may be renaming a dangling inventory id
723
 
        if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
724
 
            raise
725
 
        os.rmdir(full_path)
 
937
    if isdir(path): # Takes care of symlinks
 
938
        os.rmdir(path)
 
939
    else:
 
940
        os.unlink(path)
726
941
 
727
942
 
728
943
def has_symlinks():
729
 
    if hasattr(os, 'symlink'):
730
 
        return True
731
 
    else:
732
 
        return False
733
 
        
 
944
    if getattr(os, 'symlink', None) is not None:
 
945
        return True
 
946
    else:
 
947
        return False
 
948
 
 
949
 
 
950
def has_hardlinks():
 
951
    if getattr(os, 'link', None) is not None:
 
952
        return True
 
953
    else:
 
954
        return False
 
955
 
 
956
 
 
957
def host_os_dereferences_symlinks():
 
958
    return (has_symlinks()
 
959
            and sys.platform not in ('cygwin', 'win32'))
 
960
 
 
961
 
 
962
def readlink(abspath):
 
963
    """Return a string representing the path to which the symbolic link points.
 
964
 
 
965
    :param abspath: The link absolute unicode path.
 
966
 
 
967
    This his guaranteed to return the symbolic link in unicode in all python
 
968
    versions.
 
969
    """
 
970
    link = abspath.encode(_fs_enc)
 
971
    target = os.readlink(link)
 
972
    target = target.decode(_fs_enc)
 
973
    return target
 
974
 
734
975
 
735
976
def contains_whitespace(s):
736
977
    """True if there are any whitespace characters in s."""
737
 
    for ch in string.whitespace:
 
978
    # string.whitespace can include '\xa0' in certain locales, because it is
 
979
    # considered "non-breaking-space" as part of ISO-8859-1. But it
 
980
    # 1) Isn't a breaking whitespace
 
981
    # 2) Isn't one of ' \t\r\n' which are characters we sometimes use as
 
982
    #    separators
 
983
    # 3) '\xa0' isn't unicode safe since it is >128.
 
984
 
 
985
    # This should *not* be a unicode set of characters in case the source
 
986
    # string is not a Unicode string. We can auto-up-cast the characters since
 
987
    # they are ascii, but we don't want to auto-up-cast the string in case it
 
988
    # is utf-8
 
989
    for ch in ' \t\n\r\v\f':
738
990
        if ch in s:
739
991
            return True
740
992
    else:
761
1013
    avoids that problem.
762
1014
    """
763
1015
 
764
 
    assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
765
 
        ' exceed the platform minimum length (which is %d)' % 
766
 
        MIN_ABS_PATHLENGTH)
 
1016
    if len(base) < MIN_ABS_PATHLENGTH:
 
1017
        # must have space for e.g. a drive letter
 
1018
        raise ValueError('%r is too short to calculate a relative path'
 
1019
            % (base,))
767
1020
 
768
1021
    rp = abspath(path)
769
1022
 
776
1029
        if tail:
777
1030
            s.insert(0, tail)
778
1031
    else:
779
 
        raise PathNotChild(rp, base)
 
1032
        raise errors.PathNotChild(rp, base)
780
1033
 
781
1034
    if s:
782
1035
        return pathjoin(*s)
784
1037
        return ''
785
1038
 
786
1039
 
 
1040
def _cicp_canonical_relpath(base, path):
 
1041
    """Return the canonical path relative to base.
 
1042
 
 
1043
    Like relpath, but on case-insensitive-case-preserving file-systems, this
 
1044
    will return the relpath as stored on the file-system rather than in the
 
1045
    case specified in the input string, for all existing portions of the path.
 
1046
 
 
1047
    This will cause O(N) behaviour if called for every path in a tree; if you
 
1048
    have a number of paths to convert, you should use canonical_relpaths().
 
1049
    """
 
1050
    # TODO: it should be possible to optimize this for Windows by using the
 
1051
    # win32 API FindFiles function to look for the specified name - but using
 
1052
    # os.listdir() still gives us the correct, platform agnostic semantics in
 
1053
    # the short term.
 
1054
 
 
1055
    rel = relpath(base, path)
 
1056
    # '.' will have been turned into ''
 
1057
    if not rel:
 
1058
        return rel
 
1059
 
 
1060
    abs_base = abspath(base)
 
1061
    current = abs_base
 
1062
    _listdir = os.listdir
 
1063
 
 
1064
    # use an explicit iterator so we can easily consume the rest on early exit.
 
1065
    bit_iter = iter(rel.split('/'))
 
1066
    for bit in bit_iter:
 
1067
        lbit = bit.lower()
 
1068
        for look in _listdir(current):
 
1069
            if lbit == look.lower():
 
1070
                current = pathjoin(current, look)
 
1071
                break
 
1072
        else:
 
1073
            # got to the end, nothing matched, so we just return the
 
1074
            # non-existing bits as they were specified (the filename may be
 
1075
            # the target of a move, for example).
 
1076
            current = pathjoin(current, bit, *list(bit_iter))
 
1077
            break
 
1078
    return current[len(abs_base)+1:]
 
1079
 
 
1080
# XXX - TODO - we need better detection/integration of case-insensitive
 
1081
# file-systems; Linux often sees FAT32 devices (or NFS-mounted OSX
 
1082
# filesystems), for example, so could probably benefit from the same basic
 
1083
# support there.  For now though, only Windows and OSX get that support, and
 
1084
# they get it for *all* file-systems!
 
1085
if sys.platform in ('win32', 'darwin'):
 
1086
    canonical_relpath = _cicp_canonical_relpath
 
1087
else:
 
1088
    canonical_relpath = relpath
 
1089
 
 
1090
def canonical_relpaths(base, paths):
 
1091
    """Create an iterable to canonicalize a sequence of relative paths.
 
1092
 
 
1093
    The intent is for this implementation to use a cache, vastly speeding
 
1094
    up multiple transformations in the same directory.
 
1095
    """
 
1096
    # but for now, we haven't optimized...
 
1097
    return [canonical_relpath(base, p) for p in paths]
 
1098
 
787
1099
def safe_unicode(unicode_or_utf8_string):
788
1100
    """Coerce unicode_or_utf8_string into unicode.
789
1101
 
790
1102
    If it is unicode, it is returned.
791
 
    Otherwise it is decoded from utf-8. If a decoding error
792
 
    occurs, it is wrapped as a If the decoding fails, the exception is wrapped 
793
 
    as a BzrBadParameter exception.
 
1103
    Otherwise it is decoded from utf-8. If decoding fails, the exception is
 
1104
    wrapped in a BzrBadParameterNotUnicode exception.
794
1105
    """
795
1106
    if isinstance(unicode_or_utf8_string, unicode):
796
1107
        return unicode_or_utf8_string
797
1108
    try:
798
1109
        return unicode_or_utf8_string.decode('utf8')
799
1110
    except UnicodeDecodeError:
800
 
        raise BzrBadParameterNotUnicode(unicode_or_utf8_string)
 
1111
        raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
 
1112
 
 
1113
 
 
1114
def safe_utf8(unicode_or_utf8_string):
 
1115
    """Coerce unicode_or_utf8_string to a utf8 string.
 
1116
 
 
1117
    If it is a str, it is returned.
 
1118
    If it is Unicode, it is encoded into a utf-8 string.
 
1119
    """
 
1120
    if isinstance(unicode_or_utf8_string, str):
 
1121
        # TODO: jam 20070209 This is overkill, and probably has an impact on
 
1122
        #       performance if we are dealing with lots of apis that want a
 
1123
        #       utf-8 revision id
 
1124
        try:
 
1125
            # Make sure it is a valid utf-8 string
 
1126
            unicode_or_utf8_string.decode('utf-8')
 
1127
        except UnicodeDecodeError:
 
1128
            raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
 
1129
        return unicode_or_utf8_string
 
1130
    return unicode_or_utf8_string.encode('utf-8')
 
1131
 
 
1132
 
 
1133
_revision_id_warning = ('Unicode revision ids were deprecated in bzr 0.15.'
 
1134
                        ' Revision id generators should be creating utf8'
 
1135
                        ' revision ids.')
 
1136
 
 
1137
 
 
1138
def safe_revision_id(unicode_or_utf8_string, warn=True):
 
1139
    """Revision ids should now be utf8, but at one point they were unicode.
 
1140
 
 
1141
    :param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
 
1142
        utf8 or None).
 
1143
    :param warn: Functions that are sanitizing user data can set warn=False
 
1144
    :return: None or a utf8 revision id.
 
1145
    """
 
1146
    if (unicode_or_utf8_string is None
 
1147
        or unicode_or_utf8_string.__class__ == str):
 
1148
        return unicode_or_utf8_string
 
1149
    if warn:
 
1150
        symbol_versioning.warn(_revision_id_warning, DeprecationWarning,
 
1151
                               stacklevel=2)
 
1152
    return cache_utf8.encode(unicode_or_utf8_string)
 
1153
 
 
1154
 
 
1155
_file_id_warning = ('Unicode file ids were deprecated in bzr 0.15. File id'
 
1156
                    ' generators should be creating utf8 file ids.')
 
1157
 
 
1158
 
 
1159
def safe_file_id(unicode_or_utf8_string, warn=True):
 
1160
    """File ids should now be utf8, but at one point they were unicode.
 
1161
 
 
1162
    This is the same as safe_utf8, except it uses the cached encode functions
 
1163
    to save a little bit of performance.
 
1164
 
 
1165
    :param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
 
1166
        utf8 or None).
 
1167
    :param warn: Functions that are sanitizing user data can set warn=False
 
1168
    :return: None or a utf8 file id.
 
1169
    """
 
1170
    if (unicode_or_utf8_string is None
 
1171
        or unicode_or_utf8_string.__class__ == str):
 
1172
        return unicode_or_utf8_string
 
1173
    if warn:
 
1174
        symbol_versioning.warn(_file_id_warning, DeprecationWarning,
 
1175
                               stacklevel=2)
 
1176
    return cache_utf8.encode(unicode_or_utf8_string)
801
1177
 
802
1178
 
803
1179
_platform_normalizes_filenames = False
818
1194
 
819
1195
    On platforms where the system normalizes filenames (Mac OSX),
820
1196
    you can access a file by any path which will normalize correctly.
821
 
    On platforms where the system does not normalize filenames 
 
1197
    On platforms where the system does not normalize filenames
822
1198
    (Windows, Linux), you have to access a file by its exact path.
823
1199
 
824
 
    Internally, bzr only supports NFC/NFKC normalization, since that is 
 
1200
    Internally, bzr only supports NFC normalization, since that is
825
1201
    the standard for XML documents.
826
1202
 
827
1203
    So return the normalized path, and a flag indicating if the file
828
1204
    can be accessed by that path.
829
1205
    """
830
1206
 
831
 
    return unicodedata.normalize('NFKC', unicode(path)), True
 
1207
    return unicodedata.normalize('NFC', unicode(path)), True
832
1208
 
833
1209
 
834
1210
def _inaccessible_normalized_filename(path):
835
1211
    __doc__ = _accessible_normalized_filename.__doc__
836
1212
 
837
 
    normalized = unicodedata.normalize('NFKC', unicode(path))
 
1213
    normalized = unicodedata.normalize('NFC', unicode(path))
838
1214
    return normalized, normalized == path
839
1215
 
840
1216
 
847
1223
def terminal_width():
848
1224
    """Return estimated terminal width."""
849
1225
    if sys.platform == 'win32':
850
 
        import bzrlib.win32console
851
 
        return bzrlib.win32console.get_console_size()[0]
 
1226
        return win32utils.get_console_size()[0]
852
1227
    width = 0
853
1228
    try:
854
1229
        import struct, fcntl, termios
867
1242
 
868
1243
    return width
869
1244
 
 
1245
 
870
1246
def supports_executable():
871
1247
    return sys.platform != "win32"
872
1248
 
873
1249
 
 
1250
def supports_posix_readonly():
 
1251
    """Return True if 'readonly' has POSIX semantics, False otherwise.
 
1252
 
 
1253
    Notably, a win32 readonly file cannot be deleted, unlike POSIX where the
 
1254
    directory controls creation/deletion, etc.
 
1255
 
 
1256
    And under win32, readonly means that the directory itself cannot be
 
1257
    deleted.  The contents of a readonly directory can be changed, unlike POSIX
 
1258
    where files in readonly directories cannot be added, deleted or renamed.
 
1259
    """
 
1260
    return sys.platform != "win32"
 
1261
 
 
1262
 
 
1263
def set_or_unset_env(env_variable, value):
 
1264
    """Modify the environment, setting or removing the env_variable.
 
1265
 
 
1266
    :param env_variable: The environment variable in question
 
1267
    :param value: The value to set the environment to. If None, then
 
1268
        the variable will be removed.
 
1269
    :return: The original value of the environment variable.
 
1270
    """
 
1271
    orig_val = os.environ.get(env_variable)
 
1272
    if value is None:
 
1273
        if orig_val is not None:
 
1274
            del os.environ[env_variable]
 
1275
    else:
 
1276
        if isinstance(value, unicode):
 
1277
            value = value.encode(get_user_encoding())
 
1278
        os.environ[env_variable] = value
 
1279
    return orig_val
 
1280
 
 
1281
 
874
1282
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
875
1283
 
876
1284
 
877
1285
def check_legal_path(path):
878
 
    """Check whether the supplied path is legal.  
 
1286
    """Check whether the supplied path is legal.
879
1287
    This is only required on Windows, so we don't test on other platforms
880
1288
    right now.
881
1289
    """
882
1290
    if sys.platform != "win32":
883
1291
        return
884
1292
    if _validWin32PathRE.match(path) is None:
885
 
        raise IllegalPath(path)
 
1293
        raise errors.IllegalPath(path)
 
1294
 
 
1295
 
 
1296
_WIN32_ERROR_DIRECTORY = 267 # Similar to errno.ENOTDIR
 
1297
 
 
1298
def _is_error_enotdir(e):
 
1299
    """Check if this exception represents ENOTDIR.
 
1300
 
 
1301
    Unfortunately, python is very inconsistent about the exception
 
1302
    here. The cases are:
 
1303
      1) Linux, Mac OSX all versions seem to set errno == ENOTDIR
 
1304
      2) Windows, Python2.4, uses errno == ERROR_DIRECTORY (267)
 
1305
         which is the windows error code.
 
1306
      3) Windows, Python2.5 uses errno == EINVAL and
 
1307
         winerror == ERROR_DIRECTORY
 
1308
 
 
1309
    :param e: An Exception object (expected to be OSError with an errno
 
1310
        attribute, but we should be able to cope with anything)
 
1311
    :return: True if this represents an ENOTDIR error. False otherwise.
 
1312
    """
 
1313
    en = getattr(e, 'errno', None)
 
1314
    if (en == errno.ENOTDIR
 
1315
        or (sys.platform == 'win32'
 
1316
            and (en == _WIN32_ERROR_DIRECTORY
 
1317
                 or (en == errno.EINVAL
 
1318
                     and getattr(e, 'winerror', None) == _WIN32_ERROR_DIRECTORY)
 
1319
        ))):
 
1320
        return True
 
1321
    return False
886
1322
 
887
1323
 
888
1324
def walkdirs(top, prefix=""):
889
1325
    """Yield data about all the directories in a tree.
890
 
    
 
1326
 
891
1327
    This yields all the data about the contents of a directory at a time.
892
1328
    After each directory has been yielded, if the caller has mutated the list
893
1329
    to exclude some directories, they are then not descended into.
894
 
    
 
1330
 
895
1331
    The data yielded is of the form:
896
1332
    ((directory-relpath, directory-path-from-top),
897
 
    [(relpath, basename, kind, lstat), ...]),
 
1333
    [(relpath, basename, kind, lstat, path-from-top), ...]),
898
1334
     - directory-relpath is the relative path of the directory being returned
899
1335
       with respect to top. prefix is prepended to this.
900
 
     - directory-path-from-root is the path including top for this directory. 
 
1336
     - directory-path-from-root is the path including top for this directory.
901
1337
       It is suitable for use with os functions.
902
1338
     - relpath is the relative path within the subtree being walked.
903
1339
     - basename is the basename of the path
905
1341
       present within the tree - but it may be recorded as versioned. See
906
1342
       versioned_kind.
907
1343
     - lstat is the stat data *if* the file was statted.
908
 
     - planned, not implemented: 
 
1344
     - planned, not implemented:
909
1345
       path_from_tree_root is the path from the root of the tree.
910
1346
 
911
 
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This 
 
1347
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This
912
1348
        allows one to walk a subtree but get paths that are relative to a tree
913
1349
        rooted higher up.
914
1350
    :return: an iterator over the dirs.
915
1351
    """
916
1352
    #TODO there is a bit of a smell where the results of the directory-
917
 
    # summary in this, and the path from the root, may not agree 
 
1353
    # summary in this, and the path from the root, may not agree
918
1354
    # depending on top and prefix - i.e. ./foo and foo as a pair leads to
919
1355
    # potentially confusing output. We should make this more robust - but
920
1356
    # not at a speed cost. RBC 20060731
921
 
    lstat = os.lstat
922
 
    pending = []
 
1357
    _lstat = os.lstat
923
1358
    _directory = _directory_kind
924
 
    _listdir = listdir
925
 
    pending = [(prefix, "", _directory, None, top)]
 
1359
    _listdir = os.listdir
 
1360
    _kind_from_mode = file_kind_from_stat_mode
 
1361
    pending = [(safe_unicode(prefix), "", _directory, None, safe_unicode(top))]
926
1362
    while pending:
927
 
        dirblock = []
928
 
        currentdir = pending.pop()
929
1363
        # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
930
 
        top = currentdir[4]
931
 
        if currentdir[0]:
932
 
            relroot = currentdir[0] + '/'
933
 
        else:
934
 
            relroot = ""
 
1364
        relroot, _, _, _, top = pending.pop()
 
1365
        if relroot:
 
1366
            relprefix = relroot + u'/'
 
1367
        else:
 
1368
            relprefix = ''
 
1369
        top_slash = top + u'/'
 
1370
 
 
1371
        dirblock = []
 
1372
        append = dirblock.append
 
1373
        try:
 
1374
            names = sorted(_listdir(top))
 
1375
        except OSError, e:
 
1376
            if not _is_error_enotdir(e):
 
1377
                raise
 
1378
        else:
 
1379
            for name in names:
 
1380
                abspath = top_slash + name
 
1381
                statvalue = _lstat(abspath)
 
1382
                kind = _kind_from_mode(statvalue.st_mode)
 
1383
                append((relprefix + name, name, kind, statvalue, abspath))
 
1384
        yield (relroot, top), dirblock
 
1385
 
 
1386
        # push the user specified dirs from dirblock
 
1387
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
 
1388
 
 
1389
 
 
1390
class DirReader(object):
 
1391
    """An interface for reading directories."""
 
1392
 
 
1393
    def top_prefix_to_starting_dir(self, top, prefix=""):
 
1394
        """Converts top and prefix to a starting dir entry
 
1395
 
 
1396
        :param top: A utf8 path
 
1397
        :param prefix: An optional utf8 path to prefix output relative paths
 
1398
            with.
 
1399
        :return: A tuple starting with prefix, and ending with the native
 
1400
            encoding of top.
 
1401
        """
 
1402
        raise NotImplementedError(self.top_prefix_to_starting_dir)
 
1403
 
 
1404
    def read_dir(self, prefix, top):
 
1405
        """Read a specific dir.
 
1406
 
 
1407
        :param prefix: A utf8 prefix to be preprended to the path basenames.
 
1408
        :param top: A natively encoded path to read.
 
1409
        :return: A list of the directories contents. Each item contains:
 
1410
            (utf8_relpath, utf8_name, kind, lstatvalue, native_abspath)
 
1411
        """
 
1412
        raise NotImplementedError(self.read_dir)
 
1413
 
 
1414
 
 
1415
_selected_dir_reader = None
 
1416
 
 
1417
 
 
1418
def _walkdirs_utf8(top, prefix=""):
 
1419
    """Yield data about all the directories in a tree.
 
1420
 
 
1421
    This yields the same information as walkdirs() only each entry is yielded
 
1422
    in utf-8. On platforms which have a filesystem encoding of utf8 the paths
 
1423
    are returned as exact byte-strings.
 
1424
 
 
1425
    :return: yields a tuple of (dir_info, [file_info])
 
1426
        dir_info is (utf8_relpath, path-from-top)
 
1427
        file_info is (utf8_relpath, utf8_name, kind, lstat, path-from-top)
 
1428
        if top is an absolute path, path-from-top is also an absolute path.
 
1429
        path-from-top might be unicode or utf8, but it is the correct path to
 
1430
        pass to os functions to affect the file in question. (such as os.lstat)
 
1431
    """
 
1432
    global _selected_dir_reader
 
1433
    if _selected_dir_reader is None:
 
1434
        fs_encoding = _fs_enc.upper()
 
1435
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
 
1436
            # Win98 doesn't have unicode apis like FindFirstFileW
 
1437
            # TODO: We possibly could support Win98 by falling back to the
 
1438
            #       original FindFirstFile, and using TCHAR instead of WCHAR,
 
1439
            #       but that gets a bit tricky, and requires custom compiling
 
1440
            #       for win98 anyway.
 
1441
            try:
 
1442
                from bzrlib._walkdirs_win32 import Win32ReadDir
 
1443
                _selected_dir_reader = Win32ReadDir()
 
1444
            except ImportError:
 
1445
                pass
 
1446
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
 
1447
            # ANSI_X3.4-1968 is a form of ASCII
 
1448
            try:
 
1449
                from bzrlib._readdir_pyx import UTF8DirReader
 
1450
                _selected_dir_reader = UTF8DirReader()
 
1451
            except ImportError:
 
1452
                pass
 
1453
 
 
1454
    if _selected_dir_reader is None:
 
1455
        # Fallback to the python version
 
1456
        _selected_dir_reader = UnicodeDirReader()
 
1457
 
 
1458
    # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
 
1459
    # But we don't actually uses 1-3 in pending, so set them to None
 
1460
    pending = [[_selected_dir_reader.top_prefix_to_starting_dir(top, prefix)]]
 
1461
    read_dir = _selected_dir_reader.read_dir
 
1462
    _directory = _directory_kind
 
1463
    while pending:
 
1464
        relroot, _, _, _, top = pending[-1].pop()
 
1465
        if not pending[-1]:
 
1466
            pending.pop()
 
1467
        dirblock = sorted(read_dir(relroot, top))
 
1468
        yield (relroot, top), dirblock
 
1469
        # push the user specified dirs from dirblock
 
1470
        next = [d for d in reversed(dirblock) if d[2] == _directory]
 
1471
        if next:
 
1472
            pending.append(next)
 
1473
 
 
1474
 
 
1475
class UnicodeDirReader(DirReader):
 
1476
    """A dir reader for non-utf8 file systems, which transcodes."""
 
1477
 
 
1478
    __slots__ = ['_utf8_encode']
 
1479
 
 
1480
    def __init__(self):
 
1481
        self._utf8_encode = codecs.getencoder('utf8')
 
1482
 
 
1483
    def top_prefix_to_starting_dir(self, top, prefix=""):
 
1484
        """See DirReader.top_prefix_to_starting_dir."""
 
1485
        return (safe_utf8(prefix), None, None, None, safe_unicode(top))
 
1486
 
 
1487
    def read_dir(self, prefix, top):
 
1488
        """Read a single directory from a non-utf8 file system.
 
1489
 
 
1490
        top, and the abspath element in the output are unicode, all other paths
 
1491
        are utf8. Local disk IO is done via unicode calls to listdir etc.
 
1492
 
 
1493
        This is currently the fallback code path when the filesystem encoding is
 
1494
        not UTF-8. It may be better to implement an alternative so that we can
 
1495
        safely handle paths that are not properly decodable in the current
 
1496
        encoding.
 
1497
 
 
1498
        See DirReader.read_dir for details.
 
1499
        """
 
1500
        _utf8_encode = self._utf8_encode
 
1501
        _lstat = os.lstat
 
1502
        _listdir = os.listdir
 
1503
        _kind_from_mode = file_kind_from_stat_mode
 
1504
 
 
1505
        if prefix:
 
1506
            relprefix = prefix + '/'
 
1507
        else:
 
1508
            relprefix = ''
 
1509
        top_slash = top + u'/'
 
1510
 
 
1511
        dirblock = []
 
1512
        append = dirblock.append
935
1513
        for name in sorted(_listdir(top)):
936
 
            abspath = top + '/' + name
937
 
            statvalue = lstat(abspath)
938
 
            dirblock.append((relroot + name, name,
939
 
                file_kind_from_stat_mode(statvalue.st_mode),
940
 
                statvalue, abspath))
941
 
        yield (currentdir[0], top), dirblock
942
 
        # push the user specified dirs from dirblock
943
 
        for dir in reversed(dirblock):
944
 
            if dir[2] == _directory:
945
 
                pending.append(dir)
 
1514
            try:
 
1515
                name_utf8 = _utf8_encode(name)[0]
 
1516
            except UnicodeDecodeError:
 
1517
                raise errors.BadFilenameEncoding(
 
1518
                    _utf8_encode(relprefix)[0] + name, _fs_enc)
 
1519
            abspath = top_slash + name
 
1520
            statvalue = _lstat(abspath)
 
1521
            kind = _kind_from_mode(statvalue.st_mode)
 
1522
            append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
 
1523
        return dirblock
 
1524
 
 
1525
 
 
1526
def copy_tree(from_path, to_path, handlers={}):
 
1527
    """Copy all of the entries in from_path into to_path.
 
1528
 
 
1529
    :param from_path: The base directory to copy.
 
1530
    :param to_path: The target directory. If it does not exist, it will
 
1531
        be created.
 
1532
    :param handlers: A dictionary of functions, which takes a source and
 
1533
        destinations for files, directories, etc.
 
1534
        It is keyed on the file kind, such as 'directory', 'symlink', or 'file'
 
1535
        'file', 'directory', and 'symlink' should always exist.
 
1536
        If they are missing, they will be replaced with 'os.mkdir()',
 
1537
        'os.readlink() + os.symlink()', and 'shutil.copy2()', respectively.
 
1538
    """
 
1539
    # Now, just copy the existing cached tree to the new location
 
1540
    # We use a cheap trick here.
 
1541
    # Absolute paths are prefixed with the first parameter
 
1542
    # relative paths are prefixed with the second.
 
1543
    # So we can get both the source and target returned
 
1544
    # without any extra work.
 
1545
 
 
1546
    def copy_dir(source, dest):
 
1547
        os.mkdir(dest)
 
1548
 
 
1549
    def copy_link(source, dest):
 
1550
        """Copy the contents of a symlink"""
 
1551
        link_to = os.readlink(source)
 
1552
        os.symlink(link_to, dest)
 
1553
 
 
1554
    real_handlers = {'file':shutil.copy2,
 
1555
                     'symlink':copy_link,
 
1556
                     'directory':copy_dir,
 
1557
                    }
 
1558
    real_handlers.update(handlers)
 
1559
 
 
1560
    if not os.path.exists(to_path):
 
1561
        real_handlers['directory'](from_path, to_path)
 
1562
 
 
1563
    for dir_info, entries in walkdirs(from_path, prefix=to_path):
 
1564
        for relpath, name, kind, st, abspath in entries:
 
1565
            real_handlers[kind](abspath, relpath)
946
1566
 
947
1567
 
948
1568
def path_prefix_key(path):
958
1578
    key_a = path_prefix_key(path_a)
959
1579
    key_b = path_prefix_key(path_b)
960
1580
    return cmp(key_a, key_b)
 
1581
 
 
1582
 
 
1583
_cached_user_encoding = None
 
1584
 
 
1585
 
 
1586
def get_user_encoding(use_cache=True):
 
1587
    """Find out what the preferred user encoding is.
 
1588
 
 
1589
    This is generally the encoding that is used for command line parameters
 
1590
    and file contents. This may be different from the terminal encoding
 
1591
    or the filesystem encoding.
 
1592
 
 
1593
    :param  use_cache:  Enable cache for detected encoding.
 
1594
                        (This parameter is turned on by default,
 
1595
                        and required only for selftesting)
 
1596
 
 
1597
    :return: A string defining the preferred user encoding
 
1598
    """
 
1599
    global _cached_user_encoding
 
1600
    if _cached_user_encoding is not None and use_cache:
 
1601
        return _cached_user_encoding
 
1602
 
 
1603
    if sys.platform == 'darwin':
 
1604
        # python locale.getpreferredencoding() always return
 
1605
        # 'mac-roman' on darwin. That's a lie.
 
1606
        sys.platform = 'posix'
 
1607
        try:
 
1608
            if os.environ.get('LANG', None) is None:
 
1609
                # If LANG is not set, we end up with 'ascii', which is bad
 
1610
                # ('mac-roman' is more than ascii), so we set a default which
 
1611
                # will give us UTF-8 (which appears to work in all cases on
 
1612
                # OSX). Users are still free to override LANG of course, as
 
1613
                # long as it give us something meaningful. This work-around
 
1614
                # *may* not be needed with python 3k and/or OSX 10.5, but will
 
1615
                # work with them too -- vila 20080908
 
1616
                os.environ['LANG'] = 'en_US.UTF-8'
 
1617
            import locale
 
1618
        finally:
 
1619
            sys.platform = 'darwin'
 
1620
    else:
 
1621
        import locale
 
1622
 
 
1623
    try:
 
1624
        user_encoding = locale.getpreferredencoding()
 
1625
    except locale.Error, e:
 
1626
        sys.stderr.write('bzr: warning: %s\n'
 
1627
                         '  Could not determine what text encoding to use.\n'
 
1628
                         '  This error usually means your Python interpreter\n'
 
1629
                         '  doesn\'t support the locale set by $LANG (%s)\n'
 
1630
                         "  Continuing with ascii encoding.\n"
 
1631
                         % (e, os.environ.get('LANG')))
 
1632
        user_encoding = 'ascii'
 
1633
 
 
1634
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
 
1635
    # treat that as ASCII, and not support printing unicode characters to the
 
1636
    # console.
 
1637
    #
 
1638
    # For python scripts run under vim, we get '', so also treat that as ASCII
 
1639
    if user_encoding in (None, 'cp0', ''):
 
1640
        user_encoding = 'ascii'
 
1641
    else:
 
1642
        # check encoding
 
1643
        try:
 
1644
            codecs.lookup(user_encoding)
 
1645
        except LookupError:
 
1646
            sys.stderr.write('bzr: warning:'
 
1647
                             ' unknown encoding %s.'
 
1648
                             ' Continuing with ascii encoding.\n'
 
1649
                             % user_encoding
 
1650
                            )
 
1651
            user_encoding = 'ascii'
 
1652
 
 
1653
    if use_cache:
 
1654
        _cached_user_encoding = user_encoding
 
1655
 
 
1656
    return user_encoding
 
1657
 
 
1658
 
 
1659
def get_host_name():
 
1660
    """Return the current unicode host name.
 
1661
 
 
1662
    This is meant to be used in place of socket.gethostname() because that
 
1663
    behaves inconsistently on different platforms.
 
1664
    """
 
1665
    if sys.platform == "win32":
 
1666
        import win32utils
 
1667
        return win32utils.get_host_name()
 
1668
    else:
 
1669
        import socket
 
1670
        return socket.gethostname().decode(get_user_encoding())
 
1671
 
 
1672
 
 
1673
def recv_all(socket, bytes):
 
1674
    """Receive an exact number of bytes.
 
1675
 
 
1676
    Regular Socket.recv() may return less than the requested number of bytes,
 
1677
    dependning on what's in the OS buffer.  MSG_WAITALL is not available
 
1678
    on all platforms, but this should work everywhere.  This will return
 
1679
    less than the requested amount if the remote end closes.
 
1680
 
 
1681
    This isn't optimized and is intended mostly for use in testing.
 
1682
    """
 
1683
    b = ''
 
1684
    while len(b) < bytes:
 
1685
        new = until_no_eintr(socket.recv, bytes - len(b))
 
1686
        if new == '':
 
1687
            break # eof
 
1688
        b += new
 
1689
    return b
 
1690
 
 
1691
 
 
1692
def send_all(socket, bytes, report_activity=None):
 
1693
    """Send all bytes on a socket.
 
1694
 
 
1695
    Regular socket.sendall() can give socket error 10053 on Windows.  This
 
1696
    implementation sends no more than 64k at a time, which avoids this problem.
 
1697
 
 
1698
    :param report_activity: Call this as bytes are read, see
 
1699
        Transport._report_activity
 
1700
    """
 
1701
    chunk_size = 2**16
 
1702
    for pos in xrange(0, len(bytes), chunk_size):
 
1703
        block = bytes[pos:pos+chunk_size]
 
1704
        if report_activity is not None:
 
1705
            report_activity(len(block), 'write')
 
1706
        until_no_eintr(socket.sendall, block)
 
1707
 
 
1708
 
 
1709
def dereference_path(path):
 
1710
    """Determine the real path to a file.
 
1711
 
 
1712
    All parent elements are dereferenced.  But the file itself is not
 
1713
    dereferenced.
 
1714
    :param path: The original path.  May be absolute or relative.
 
1715
    :return: the real path *to* the file
 
1716
    """
 
1717
    parent, base = os.path.split(path)
 
1718
    # The pathjoin for '.' is a workaround for Python bug #1213894.
 
1719
    # (initial path components aren't dereferenced)
 
1720
    return pathjoin(realpath(pathjoin('.', parent)), base)
 
1721
 
 
1722
 
 
1723
def supports_mapi():
 
1724
    """Return True if we can use MAPI to launch a mail client."""
 
1725
    return sys.platform == "win32"
 
1726
 
 
1727
 
 
1728
def resource_string(package, resource_name):
 
1729
    """Load a resource from a package and return it as a string.
 
1730
 
 
1731
    Note: Only packages that start with bzrlib are currently supported.
 
1732
 
 
1733
    This is designed to be a lightweight implementation of resource
 
1734
    loading in a way which is API compatible with the same API from
 
1735
    pkg_resources. See
 
1736
    http://peak.telecommunity.com/DevCenter/PkgResources#basic-resource-access.
 
1737
    If and when pkg_resources becomes a standard library, this routine
 
1738
    can delegate to it.
 
1739
    """
 
1740
    # Check package name is within bzrlib
 
1741
    if package == "bzrlib":
 
1742
        resource_relpath = resource_name
 
1743
    elif package.startswith("bzrlib."):
 
1744
        package = package[len("bzrlib."):].replace('.', os.sep)
 
1745
        resource_relpath = pathjoin(package, resource_name)
 
1746
    else:
 
1747
        raise errors.BzrError('resource package %s not in bzrlib' % package)
 
1748
 
 
1749
    # Map the resource to a file and read its contents
 
1750
    base = dirname(bzrlib.__file__)
 
1751
    if getattr(sys, 'frozen', None):    # bzr.exe
 
1752
        base = abspath(pathjoin(base, '..', '..'))
 
1753
    filename = pathjoin(base, resource_relpath)
 
1754
    return open(filename, 'rU').read()
 
1755
 
 
1756
 
 
1757
def file_kind_from_stat_mode_thunk(mode):
 
1758
    global file_kind_from_stat_mode
 
1759
    if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
 
1760
        try:
 
1761
            from bzrlib._readdir_pyx import UTF8DirReader
 
1762
            file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
 
1763
        except ImportError:
 
1764
            from bzrlib._readdir_py import (
 
1765
                _kind_from_mode as file_kind_from_stat_mode
 
1766
                )
 
1767
    return file_kind_from_stat_mode(mode)
 
1768
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
 
1769
 
 
1770
 
 
1771
def file_kind(f, _lstat=os.lstat):
 
1772
    try:
 
1773
        return file_kind_from_stat_mode(_lstat(f).st_mode)
 
1774
    except OSError, e:
 
1775
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
 
1776
            raise errors.NoSuchFile(f)
 
1777
        raise
 
1778
 
 
1779
 
 
1780
def until_no_eintr(f, *a, **kw):
 
1781
    """Run f(*a, **kw), retrying if an EINTR error occurs."""
 
1782
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
 
1783
    while True:
 
1784
        try:
 
1785
            return f(*a, **kw)
 
1786
        except (IOError, OSError), e:
 
1787
            if e.errno == errno.EINTR:
 
1788
                continue
 
1789
            raise
 
1790
 
 
1791
def re_compile_checked(re_string, flags=0, where=""):
 
1792
    """Return a compiled re, or raise a sensible error.
 
1793
 
 
1794
    This should only be used when compiling user-supplied REs.
 
1795
 
 
1796
    :param re_string: Text form of regular expression.
 
1797
    :param flags: eg re.IGNORECASE
 
1798
    :param where: Message explaining to the user the context where
 
1799
        it occurred, eg 'log search filter'.
 
1800
    """
 
1801
    # from https://bugs.launchpad.net/bzr/+bug/251352
 
1802
    try:
 
1803
        re_obj = re.compile(re_string, flags)
 
1804
        re_obj.search("")
 
1805
        return re_obj
 
1806
    except re.error, e:
 
1807
        if where:
 
1808
            where = ' in ' + where
 
1809
        # despite the name 'error' is a type
 
1810
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
 
1811
            % (where, re_string, e))
 
1812
 
 
1813
 
 
1814
if sys.platform == "win32":
 
1815
    import msvcrt
 
1816
    def getchar():
 
1817
        return msvcrt.getch()
 
1818
else:
 
1819
    import tty
 
1820
    import termios
 
1821
    def getchar():
 
1822
        fd = sys.stdin.fileno()
 
1823
        settings = termios.tcgetattr(fd)
 
1824
        try:
 
1825
            tty.setraw(fd)
 
1826
            ch = sys.stdin.read(1)
 
1827
        finally:
 
1828
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
 
1829
        return ch
 
1830
 
 
1831
 
 
1832
if sys.platform == 'linux2':
 
1833
    def _local_concurrency():
 
1834
        concurrency = None
 
1835
        prefix = 'processor'
 
1836
        for line in file('/proc/cpuinfo', 'rb'):
 
1837
            if line.startswith(prefix):
 
1838
                concurrency = int(line[line.find(':')+1:]) + 1
 
1839
        return concurrency
 
1840
elif sys.platform == 'darwin':
 
1841
    def _local_concurrency():
 
1842
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
 
1843
                                stdout=subprocess.PIPE).communicate()[0]
 
1844
elif sys.platform[0:7] == 'freebsd':
 
1845
    def _local_concurrency():
 
1846
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
 
1847
                                stdout=subprocess.PIPE).communicate()[0]
 
1848
elif sys.platform == 'sunos5':
 
1849
    def _local_concurrency():
 
1850
        return subprocess.Popen(['psrinfo', '-p',],
 
1851
                                stdout=subprocess.PIPE).communicate()[0]
 
1852
elif sys.platform == "win32":
 
1853
    def _local_concurrency():
 
1854
        # This appears to return the number of cores.
 
1855
        return os.environ.get('NUMBER_OF_PROCESSORS')
 
1856
else:
 
1857
    def _local_concurrency():
 
1858
        # Who knows ?
 
1859
        return None
 
1860
 
 
1861
 
 
1862
_cached_local_concurrency = None
 
1863
 
 
1864
def local_concurrency(use_cache=True):
 
1865
    """Return how many processes can be run concurrently.
 
1866
 
 
1867
    Rely on platform specific implementations and default to 1 (one) if
 
1868
    anything goes wrong.
 
1869
    """
 
1870
    global _cached_local_concurrency
 
1871
    if _cached_local_concurrency is not None and use_cache:
 
1872
        return _cached_local_concurrency
 
1873
 
 
1874
    try:
 
1875
        concurrency = _local_concurrency()
 
1876
    except (OSError, IOError):
 
1877
        concurrency = None
 
1878
    try:
 
1879
        concurrency = int(concurrency)
 
1880
    except (TypeError, ValueError):
 
1881
        concurrency = 1
 
1882
    if use_cache:
 
1883
        _cached_concurrency = concurrency
 
1884
    return concurrency