/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

Return mapping in revision_id_bzr_to_foreign() as required by the interface.

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