/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: Johan Walles
  • Date: 2009-05-06 19:32:56 UTC
  • mto: This revision was merged to the branch mainline in revision 4343.
  • Revision ID: johan.walles@gmail.com-20090506193256-ome7hfbulo2jth47
Move note about bzr rm * fix from Bugs to Improvements.

Show diffs side-by-side

added added

removed removed

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