/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: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/osutils.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
from __future__ import absolute_import
18
 
 
19
 
import errno
20
17
import os
21
18
import re
22
19
import stat
 
20
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
23
21
import sys
24
22
import time
25
23
import codecs
26
24
 
27
 
from .lazy_import import lazy_import
 
25
from bzrlib.lazy_import import lazy_import
28
26
lazy_import(globals(), """
29
27
from datetime import datetime
30
 
import getpass
31
 
import locale
32
 
import ntpath
 
28
import errno
 
29
from ntpath import (abspath as _nt_abspath,
 
30
                    join as _nt_join,
 
31
                    normpath as _nt_normpath,
 
32
                    realpath as _nt_realpath,
 
33
                    splitdrive as _nt_splitdrive,
 
34
                    )
33
35
import posixpath
34
 
import select
35
 
# We need to import both shutil and rmtree as we export the later on posix
36
 
# and need the former on windows
37
36
import shutil
38
 
from shutil import rmtree
 
37
from shutil import (
 
38
    rmtree,
 
39
    )
39
40
import socket
40
41
import subprocess
41
 
# We need to import both tempfile and mkdtemp as we export the later on posix
42
 
# and need the former on windows
43
42
import tempfile
44
 
from tempfile import mkdtemp
 
43
from tempfile import (
 
44
    mkdtemp,
 
45
    )
45
46
import unicodedata
46
47
 
47
 
from breezy import (
48
 
    config,
 
48
from bzrlib import (
 
49
    cache_utf8,
 
50
    errors,
49
51
    trace,
50
52
    win32utils,
51
53
    )
52
 
from breezy.i18n import gettext
53
54
""")
54
55
 
55
 
from .sixish import (
56
 
    PY3,
57
 
    text_type,
58
 
    )
59
 
 
60
 
from hashlib import (
61
 
    md5,
62
 
    sha1 as sha,
63
 
    )
64
 
 
65
 
 
66
 
import breezy
67
 
from . import (
68
 
    _fs_enc,
69
 
    errors,
70
 
    )
 
56
from bzrlib.symbol_versioning import (
 
57
    deprecated_function,
 
58
    deprecated_in,
 
59
    )
 
60
 
 
61
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
 
62
# of 2.5
 
63
if sys.version_info < (2, 5):
 
64
    import md5 as _mod_md5
 
65
    md5 = _mod_md5.new
 
66
    import sha as _mod_sha
 
67
    sha = _mod_sha.new
 
68
else:
 
69
    from hashlib import (
 
70
        md5,
 
71
        sha1 as sha,
 
72
        )
 
73
 
 
74
 
 
75
import bzrlib
 
76
from bzrlib import symbol_versioning
71
77
 
72
78
 
73
79
# Cross platform wall-clock time functionality with decent resolution.
90
96
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
91
97
 
92
98
 
93
 
class UnsupportedTimezoneFormat(errors.BzrError):
94
 
 
95
 
    _fmt = ('Unsupported timezone format "%(timezone)s", '
96
 
            'options are "utc", "original", "local".')
97
 
 
98
 
    def __init__(self, timezone):
99
 
        self.timezone = timezone
100
 
 
101
 
 
102
99
def get_unicode_argv():
103
 
    if PY3:
104
 
        return sys.argv[1:]
105
100
    try:
106
101
        user_encoding = get_user_encoding()
107
102
        return [a.decode(user_encoding) for a in sys.argv[1:]]
108
103
    except UnicodeDecodeError:
109
 
        raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
110
 
            "application locale.").format(a, user_encoding))
 
104
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
 
105
                                                            "encoding." % a))
111
106
 
112
107
 
113
108
def make_readonly(filename):
114
109
    """Make a filename read-only."""
115
110
    mod = os.lstat(filename).st_mode
116
111
    if not stat.S_ISLNK(mod):
117
 
        mod = mod & 0o777555
118
 
        chmod_if_possible(filename, mod)
 
112
        mod = mod & 0777555
 
113
        os.chmod(filename, mod)
119
114
 
120
115
 
121
116
def make_writable(filename):
122
117
    mod = os.lstat(filename).st_mode
123
118
    if not stat.S_ISLNK(mod):
124
 
        mod = mod | 0o200
125
 
        chmod_if_possible(filename, mod)
126
 
 
127
 
 
128
 
def chmod_if_possible(filename, mode):
129
 
    # Set file mode if that can be safely done.
130
 
    # Sometimes even on unix the filesystem won't allow it - see
131
 
    # https://bugs.launchpad.net/bzr/+bug/606537
132
 
    try:
133
 
        # It is probably faster to just do the chmod, rather than
134
 
        # doing a stat, and then trying to compare
135
 
        os.chmod(filename, mode)
136
 
    except (IOError, OSError) as e:
137
 
        # Permission/access denied seems to commonly happen on smbfs; there's
138
 
        # probably no point warning about it.
139
 
        # <https://bugs.launchpad.net/bzr/+bug/606537>
140
 
        if getattr(e, 'errno') in (errno.EPERM, errno.EACCES):
141
 
            trace.mutter("ignore error on chmod of %r: %r" % (
142
 
                filename, e))
143
 
            return
144
 
        raise
 
119
        mod = mod | 0200
 
120
        os.chmod(filename, mod)
145
121
 
146
122
 
147
123
def minimum_path_selection(paths):
155
131
        return set(paths)
156
132
 
157
133
    def sort_key(path):
158
 
        if isinstance(path, bytes):
159
 
            return path.split(b'/')
160
 
        else:
161
 
            return path.split('/')
 
134
        return path.split('/')
162
135
    sorted_paths = sorted(list(paths), key=sort_key)
163
136
 
164
137
    search_paths = [sorted_paths[0]]
225
198
            stat = getattr(os, 'lstat', os.stat)
226
199
            stat(f)
227
200
            return True
228
 
        except OSError as e:
 
201
        except OSError, e:
229
202
            if e.errno == errno.ENOENT:
230
203
                return False;
231
204
            else:
232
 
                raise errors.BzrError(gettext("lstat/stat of ({0!r}): {1!r}").format(f, e))
 
205
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
233
206
 
234
207
 
235
208
def fancy_rename(old, new, rename_func, unlink_func):
259
232
    file_existed = False
260
233
    try:
261
234
        rename_func(new, tmp_name)
262
 
    except (errors.NoSuchFile,) as e:
 
235
    except (errors.NoSuchFile,), e:
263
236
        pass
264
 
    except IOError as e:
 
237
    except IOError, e:
265
238
        # RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
266
239
        # function raises an IOError with errno is None when a rename fails.
267
240
        # This then gets caught here.
268
241
        if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
269
242
            raise
270
 
    except Exception as e:
 
243
    except Exception, e:
271
244
        if (getattr(e, 'errno', None) is None
272
245
            or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
273
246
            raise
274
247
    else:
275
248
        file_existed = True
276
249
 
 
250
    failure_exc = None
277
251
    success = False
278
252
    try:
279
 
        # This may throw an exception, in which case success will
280
 
        # not be set.
281
 
        rename_func(old, new)
282
 
        success = True
283
 
    except (IOError, OSError) as e:
284
 
        # source and target may be aliases of each other (e.g. on a
285
 
        # case-insensitive filesystem), so we may have accidentally renamed
286
 
        # source by when we tried to rename target
287
 
        if (file_existed and e.errno in (None, errno.ENOENT)
288
 
            and old.lower() == new.lower()):
289
 
            # source and target are the same file on a case-insensitive
290
 
            # filesystem, so we don't generate an exception
291
 
            pass
292
 
        else:
293
 
            raise
 
253
        try:
 
254
            # This may throw an exception, in which case success will
 
255
            # not be set.
 
256
            rename_func(old, new)
 
257
            success = True
 
258
        except (IOError, OSError), e:
 
259
            # source and target may be aliases of each other (e.g. on a
 
260
            # case-insensitive filesystem), so we may have accidentally renamed
 
261
            # source by when we tried to rename target
 
262
            failure_exc = sys.exc_info()
 
263
            if (file_existed and e.errno in (None, errno.ENOENT)
 
264
                and old.lower() == new.lower()):
 
265
                # source and target are the same file on a case-insensitive
 
266
                # filesystem, so we don't generate an exception
 
267
                failure_exc = None
294
268
    finally:
295
269
        if file_existed:
296
270
            # If the file used to exist, rename it back into place
299
273
                unlink_func(tmp_name)
300
274
            else:
301
275
                rename_func(tmp_name, new)
 
276
    if failure_exc is not None:
 
277
        raise failure_exc[0], failure_exc[1], failure_exc[2]
302
278
 
303
279
 
304
280
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
305
281
# choke on a Unicode string containing a relative path if
306
282
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
307
283
# string.
 
284
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
308
285
def _posix_abspath(path):
309
286
    # jam 20060426 rather than encoding to fsencoding
310
287
    # copy posixpath.abspath, but use os.getcwdu instead
311
288
    if not posixpath.isabs(path):
312
289
        path = posixpath.join(getcwd(), path)
313
 
    return _posix_normpath(path)
 
290
    return posixpath.normpath(path)
314
291
 
315
292
 
316
293
def _posix_realpath(path):
317
294
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
318
295
 
319
296
 
320
 
def _posix_normpath(path):
321
 
    path = posixpath.normpath(path)
322
 
    # Bug 861008: posixpath.normpath() returns a path normalized according to
323
 
    # the POSIX standard, which stipulates (for compatibility reasons) that two
324
 
    # leading slashes must not be simplified to one, and only if there are 3 or
325
 
    # more should they be simplified as one. So we treat the leading 2 slashes
326
 
    # as a special case here by simply removing the first slash, as we consider
327
 
    # that breaking POSIX compatibility for this obscure feature is acceptable.
328
 
    # This is not a paranoid precaution, as we notably get paths like this when
329
 
    # the repo is hosted at the root of the filesystem, i.e. in "/".    
330
 
    if path.startswith('//'):
331
 
        path = path[1:]
332
 
    return path
333
 
 
334
 
 
335
 
def _posix_path_from_environ(key):
336
 
    """Get unicode path from `key` in environment or None if not present
337
 
 
338
 
    Note that posix systems use arbitrary byte strings for filesystem objects,
339
 
    so a path that raises BadFilenameEncoding here may still be accessible.
340
 
    """
341
 
    val = os.environ.get(key, None)
342
 
    if PY3 or val is None:
343
 
        return val
344
 
    try:
345
 
        return val.decode(_fs_enc)
346
 
    except UnicodeDecodeError:
347
 
        # GZ 2011-12-12:Ideally want to include `key` in the exception message
348
 
        raise errors.BadFilenameEncoding(val, _fs_enc)
349
 
 
350
 
 
351
 
def _posix_get_home_dir():
352
 
    """Get the home directory of the current user as a unicode path"""
353
 
    path = posixpath.expanduser("~")
354
 
    try:
355
 
        return path.decode(_fs_enc)
356
 
    except AttributeError:
357
 
        return path
358
 
    except UnicodeDecodeError:
359
 
        raise errors.BadFilenameEncoding(path, _fs_enc)
360
 
 
361
 
 
362
 
def _posix_getuser_unicode():
363
 
    """Get username from environment or password database as unicode"""
364
 
    name = getpass.getuser()
365
 
    if PY3:
366
 
        return name
367
 
    user_encoding = get_user_encoding()
368
 
    try:
369
 
        return name.decode(user_encoding)
370
 
    except UnicodeDecodeError:
371
 
        raise errors.BzrError("Encoding of username %r is unsupported by %s "
372
 
            "application locale." % (name, user_encoding))
373
 
 
374
 
 
375
297
def _win32_fixdrive(path):
376
298
    """Force drive letters to be consistent.
377
299
 
381
303
    running python.exe under cmd.exe return capital C:\\
382
304
    running win32 python inside a cygwin shell returns lowercase c:\\
383
305
    """
384
 
    drive, path = ntpath.splitdrive(path)
 
306
    drive, path = _nt_splitdrive(path)
385
307
    return drive.upper() + path
386
308
 
387
309
 
388
310
def _win32_abspath(path):
389
 
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
390
 
    return _win32_fixdrive(ntpath.abspath(path).replace('\\', '/'))
 
311
    # Real _nt_abspath doesn't have a problem with a unicode cwd
 
312
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
 
313
 
 
314
 
 
315
def _win98_abspath(path):
 
316
    """Return the absolute version of a path.
 
317
    Windows 98 safe implementation (python reimplementation
 
318
    of Win32 API function GetFullPathNameW)
 
319
    """
 
320
    # Corner cases:
 
321
    #   C:\path     => C:/path
 
322
    #   C:/path     => C:/path
 
323
    #   \\HOST\path => //HOST/path
 
324
    #   //HOST/path => //HOST/path
 
325
    #   path        => C:/cwd/path
 
326
    #   /path       => C:/path
 
327
    path = unicode(path)
 
328
    # check for absolute path
 
329
    drive = _nt_splitdrive(path)[0]
 
330
    if drive == '' and path[:2] not in('//','\\\\'):
 
331
        cwd = os.getcwdu()
 
332
        # we cannot simply os.path.join cwd and path
 
333
        # because os.path.join('C:','/path') produce '/path'
 
334
        # and this is incorrect
 
335
        if path[:1] in ('/','\\'):
 
336
            cwd = _nt_splitdrive(cwd)[0]
 
337
            path = path[1:]
 
338
        path = cwd + '\\' + path
 
339
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
391
340
 
392
341
 
393
342
def _win32_realpath(path):
394
 
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
395
 
    return _win32_fixdrive(ntpath.realpath(path).replace('\\', '/'))
 
343
    # Real _nt_realpath doesn't have a problem with a unicode cwd
 
344
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
396
345
 
397
346
 
398
347
def _win32_pathjoin(*args):
399
 
    return ntpath.join(*args).replace('\\', '/')
 
348
    return _nt_join(*args).replace('\\', '/')
400
349
 
401
350
 
402
351
def _win32_normpath(path):
403
 
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
 
352
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
404
353
 
405
354
 
406
355
def _win32_getcwd():
407
 
    return _win32_fixdrive(_getcwd().replace('\\', '/'))
 
356
    return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
408
357
 
409
358
 
410
359
def _win32_mkdtemp(*args, **kwargs):
411
360
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
412
361
 
413
362
 
 
363
def _add_rename_error_details(e, old, new):
 
364
    new_e = OSError(e.errno, "failed to rename %s to %s: %s"
 
365
        % (old, new, e.strerror))
 
366
    new_e.filename = old
 
367
    new_e.to_filename = new
 
368
    return new_e
 
369
 
 
370
 
414
371
def _win32_rename(old, new):
415
372
    """We expect to be able to atomically replace 'new' with old.
416
373
 
418
375
    and then deleted.
419
376
    """
420
377
    try:
421
 
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
422
 
    except OSError as e:
 
378
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
 
379
    except OSError, e:
423
380
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
424
381
            # If we try to rename a non-existant file onto cwd, we get
425
382
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT
429
386
        raise
430
387
 
431
388
 
 
389
def _wrapped_rename(old, new):
 
390
    """Rename a file or directory"""
 
391
    try:
 
392
        os.rename(old, new)
 
393
    except (IOError, OSError), e:
 
394
        # this is eventually called by all rename-like functions, so should 
 
395
        # catch all of them
 
396
        raise _add_rename_error_details(e, old, new)
 
397
 
 
398
 
432
399
def _mac_getcwd():
433
 
    return unicodedata.normalize('NFC', _getcwd())
434
 
 
435
 
 
436
 
def _rename_wrap_exception(rename_func):
437
 
    """Adds extra information to any exceptions that come from rename().
438
 
 
439
 
    The exception has an updated message and 'old_filename' and 'new_filename'
440
 
    attributes.
441
 
    """
442
 
 
443
 
    def _rename_wrapper(old, new):
444
 
        try:
445
 
            rename_func(old, new)
446
 
        except OSError as e:
447
 
            detailed_error = OSError(e.errno, e.strerror +
448
 
                                " [occurred when renaming '%s' to '%s']" %
449
 
                                (old, new))
450
 
            detailed_error.old_filename = old
451
 
            detailed_error.new_filename = new
452
 
            raise detailed_error
453
 
 
454
 
    return _rename_wrapper
455
 
 
456
 
 
457
 
if sys.version_info > (3,):
458
 
    _getcwd = os.getcwd
459
 
else:
460
 
    _getcwd = os.getcwdu
461
 
 
462
 
 
463
 
# Default rename wraps os.rename()
464
 
rename = _rename_wrap_exception(os.rename)
 
400
    return unicodedata.normalize('NFC', os.getcwdu())
 
401
 
465
402
 
466
403
# Default is to just use the python builtins, but these can be rebound on
467
404
# particular platforms.
468
405
abspath = _posix_abspath
469
406
realpath = _posix_realpath
470
407
pathjoin = os.path.join
471
 
normpath = _posix_normpath
472
 
path_from_environ = _posix_path_from_environ
473
 
_get_home_dir = _posix_get_home_dir
474
 
getuser_unicode = _posix_getuser_unicode
475
 
getcwd = _getcwd
 
408
normpath = os.path.normpath
 
409
rename = _wrapped_rename # overridden below on win32
 
410
getcwd = os.getcwdu
476
411
dirname = os.path.dirname
477
412
basename = os.path.basename
478
413
split = os.path.split
479
414
splitext = os.path.splitext
480
 
# These were already lazily imported into local scope
 
415
# These were already imported into local scope
481
416
# mkdtemp = tempfile.mkdtemp
482
417
# rmtree = shutil.rmtree
483
 
lstat = os.lstat
484
 
fstat = os.fstat
485
 
 
486
 
def wrap_stat(st):
487
 
    return st
488
 
 
489
418
 
490
419
MIN_ABS_PATHLENGTH = 1
491
420
 
492
421
 
493
422
if sys.platform == 'win32':
494
 
    abspath = _win32_abspath
 
423
    if win32utils.winver == 'Windows 98':
 
424
        abspath = _win98_abspath
 
425
    else:
 
426
        abspath = _win32_abspath
495
427
    realpath = _win32_realpath
496
428
    pathjoin = _win32_pathjoin
497
429
    normpath = _win32_normpath
498
430
    getcwd = _win32_getcwd
499
431
    mkdtemp = _win32_mkdtemp
500
 
    rename = _rename_wrap_exception(_win32_rename)
501
 
    try:
502
 
        from . import _walkdirs_win32
503
 
    except ImportError:
504
 
        pass
505
 
    else:
506
 
        lstat = _walkdirs_win32.lstat
507
 
        fstat = _walkdirs_win32.fstat
508
 
        wrap_stat = _walkdirs_win32.wrap_stat
 
432
    rename = _win32_rename
509
433
 
510
434
    MIN_ABS_PATHLENGTH = 3
511
435
 
529
453
    f = win32utils.get_unicode_argv     # special function or None
530
454
    if f is not None:
531
455
        get_unicode_argv = f
532
 
    path_from_environ = win32utils.get_environ_unicode
533
 
    _get_home_dir = win32utils.get_home_location
534
 
    getuser_unicode = win32utils.get_user_name
535
456
 
536
457
elif sys.platform == 'darwin':
537
458
    getcwd = _mac_getcwd
538
459
 
539
460
 
540
 
def get_terminal_encoding(trace=False):
 
461
def get_terminal_encoding():
541
462
    """Find the best encoding for printing to the screen.
542
463
 
543
464
    This attempts to check both sys.stdout and sys.stdin to see
549
470
 
550
471
    On my standard US Windows XP, the preferred encoding is
551
472
    cp1252, but the console is cp437
552
 
 
553
 
    :param trace: If True trace the selected encoding via mutter().
554
473
    """
555
 
    from .trace import mutter
 
474
    from bzrlib.trace import mutter
556
475
    output_encoding = getattr(sys.stdout, 'encoding', None)
557
476
    if not output_encoding:
558
477
        input_encoding = getattr(sys.stdin, 'encoding', None)
559
478
        if not input_encoding:
560
479
            output_encoding = get_user_encoding()
561
 
            if trace:
562
 
                mutter('encoding stdout as osutils.get_user_encoding() %r',
 
480
            mutter('encoding stdout as osutils.get_user_encoding() %r',
563
481
                   output_encoding)
564
482
        else:
565
483
            output_encoding = input_encoding
566
 
            if trace:
567
 
                mutter('encoding stdout as sys.stdin encoding %r',
568
 
                    output_encoding)
 
484
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
569
485
    else:
570
 
        if trace:
571
 
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
486
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
572
487
    if output_encoding == 'cp0':
573
488
        # invalid encoding (cp0 means 'no codepage' on Windows)
574
489
        output_encoding = get_user_encoding()
575
 
        if trace:
576
 
            mutter('cp0 is invalid encoding.'
 
490
        mutter('cp0 is invalid encoding.'
577
491
               ' encoding stdout as osutils.get_user_encoding() %r',
578
492
               output_encoding)
579
493
    # check encoding
580
494
    try:
581
495
        codecs.lookup(output_encoding)
582
496
    except LookupError:
583
 
        sys.stderr.write('brz: warning:'
 
497
        sys.stderr.write('bzr: warning:'
584
498
                         ' unknown terminal encoding %s.\n'
585
499
                         '  Using encoding %s instead.\n'
586
500
                         % (output_encoding, get_user_encoding())
595
509
        F = realpath
596
510
    else:
597
511
        F = abspath
598
 
    [p, e] = os.path.split(f)
 
512
    [p,e] = os.path.split(f)
599
513
    if e == "" or e == "." or e == "..":
600
514
        return F(f)
601
515
    else:
605
519
def isdir(f):
606
520
    """True if f is an accessible directory."""
607
521
    try:
608
 
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
 
522
        return S_ISDIR(os.lstat(f)[ST_MODE])
609
523
    except OSError:
610
524
        return False
611
525
 
613
527
def isfile(f):
614
528
    """True if f is a regular file."""
615
529
    try:
616
 
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
 
530
        return S_ISREG(os.lstat(f)[ST_MODE])
617
531
    except OSError:
618
532
        return False
619
533
 
620
534
def islink(f):
621
535
    """True if f is a symlink."""
622
536
    try:
623
 
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
 
537
        return S_ISLNK(os.lstat(f)[ST_MODE])
624
538
    except OSError:
625
539
        return False
626
540
 
639
553
    if dir == fname:
640
554
        return True
641
555
 
642
 
    if dir in ('', b''):
 
556
    if dir == '':
643
557
        return True
644
558
 
645
 
    if isinstance(dir, bytes):
646
 
        if not dir.endswith(b'/'):
647
 
            dir += b'/'
648
 
    else:
649
 
        if not dir.endswith('/'):
650
 
            dir += '/'
 
559
    if dir[-1] != '/':
 
560
        dir += '/'
651
561
 
652
562
    return fname.startswith(dir)
653
563
 
727
637
    # drives).
728
638
    if not segment_size:
729
639
        segment_size = 5242880 # 5MB
730
 
    offsets = range(0, len(bytes), segment_size)
731
 
    view = memoryview(bytes)
 
640
    segments = range(len(bytes) / segment_size + 1)
732
641
    write = file_handle.write
733
 
    for offset in offsets:
734
 
        write(view[offset:offset+segment_size])
 
642
    for segment_index in segments:
 
643
        segment = buffer(bytes, segment_index * segment_size, segment_size)
 
644
        write(segment)
735
645
 
736
646
 
737
647
def file_iterator(input_file, readsize=32768):
742
652
        yield b
743
653
 
744
654
 
745
 
# GZ 2017-09-16: Makes sense in general for hexdigest() result to be text, but
746
 
# used as bytes through most interfaces so encode with this wrapper.
747
 
if PY3:
748
 
    def _hexdigest(hashobj):
749
 
        return hashobj.hexdigest().encode()
750
 
else:
751
 
    def _hexdigest(hashobj):
752
 
        return hashobj.hexdigest()
753
 
 
754
 
 
755
655
def sha_file(f):
756
656
    """Calculate the hexdigest of an open file.
757
657
 
764
664
        if not b:
765
665
            break
766
666
        s.update(b)
767
 
    return _hexdigest(s)
 
667
    return s.hexdigest()
768
668
 
769
669
 
770
670
def size_sha_file(f):
782
682
            break
783
683
        size += len(b)
784
684
        s.update(b)
785
 
    return size, _hexdigest(s)
 
685
    return size, s.hexdigest()
786
686
 
787
687
 
788
688
def sha_file_by_name(fname):
793
693
        while True:
794
694
            b = os.read(f, 1<<16)
795
695
            if not b:
796
 
                return _hexdigest(s)
 
696
                return s.hexdigest()
797
697
            s.update(b)
798
698
    finally:
799
699
        os.close(f)
802
702
def sha_strings(strings, _factory=sha):
803
703
    """Return the sha-1 of concatenation of strings"""
804
704
    s = _factory()
805
 
    for string in strings:
806
 
        s.update(string)
807
 
    return _hexdigest(s)
 
705
    map(s.update, strings)
 
706
    return s.hexdigest()
808
707
 
809
708
 
810
709
def sha_string(f, _factory=sha):
811
 
    # GZ 2017-09-16: Dodgy if factory is ever not sha, probably shouldn't be.
812
 
    return _hexdigest(_factory(f))
 
710
    return _factory(f).hexdigest()
813
711
 
814
712
 
815
713
def fingerprint_file(f):
816
714
    b = f.read()
817
715
    return {'size': len(b),
818
 
            'sha1': _hexdigest(sha(b))}
 
716
            'sha1': sha(b).hexdigest()}
819
717
 
820
718
 
821
719
def compare_files(a, b):
826
724
        bi = b.read(BUFSIZE)
827
725
        if ai != bi:
828
726
            return False
829
 
        if not ai:
 
727
        if ai == '':
830
728
            return True
831
729
 
832
730
 
900
798
    (date_fmt, tt, offset_str) = \
901
799
               _format_date(t, offset, timezone, date_fmt, show_offset)
902
800
    date_str = time.strftime(date_fmt, tt)
903
 
    if not isinstance(date_str, text_type):
 
801
    if not isinstance(date_str, unicode):
904
802
        date_str = date_str.decode(get_user_encoding(), 'replace')
905
803
    return date_str + offset_str
906
804
 
917
815
        tt = time.localtime(t)
918
816
        offset = local_time_offset(t)
919
817
    else:
920
 
        raise UnsupportedTimezoneFormat(timezone)
 
818
        raise errors.UnsupportedTimezoneFormat(timezone)
921
819
    if date_fmt is None:
922
820
        date_fmt = "%a %Y-%m-%d %H:%M:%S"
923
821
    if show_offset:
982
880
 
983
881
def filesize(f):
984
882
    """Return size of given open file."""
985
 
    return os.fstat(f.fileno())[stat.ST_SIZE]
986
 
 
987
 
 
988
 
# Alias os.urandom to support platforms (which?) without /dev/urandom and 
989
 
# override if it doesn't work. Avoid checking on windows where there is
990
 
# significant initialisation cost that can be avoided for some bzr calls.
991
 
 
992
 
rand_bytes = os.urandom
993
 
 
994
 
if rand_bytes.__module__ != "nt":
 
883
    return os.fstat(f.fileno())[ST_SIZE]
 
884
 
 
885
 
 
886
# Define rand_bytes based on platform.
 
887
try:
 
888
    # Python 2.4 and later have os.urandom,
 
889
    # but it doesn't work on some arches
 
890
    os.urandom(1)
 
891
    rand_bytes = os.urandom
 
892
except (NotImplementedError, AttributeError):
 
893
    # If python doesn't have os.urandom, or it doesn't work,
 
894
    # then try to first pull random data from /dev/urandom
995
895
    try:
996
 
        rand_bytes(1)
997
 
    except NotImplementedError:
 
896
        rand_bytes = file('/dev/urandom', 'rb').read
 
897
    # Otherwise, use this hack as a last resort
 
898
    except (IOError, OSError):
998
899
        # not well seeded, but better than nothing
999
900
        def rand_bytes(n):
1000
901
            import random
1014
915
    """
1015
916
    s = ''
1016
917
    for raw_byte in rand_bytes(num):
1017
 
        if not PY3:
1018
 
            s += ALNUM[ord(raw_byte) % 36]
1019
 
        else:
1020
 
            s += ALNUM[raw_byte % 36]
 
918
        s += ALNUM[ord(raw_byte) % 36]
1021
919
    return s
1022
920
 
1023
921
 
1028
926
    """Turn string into list of parts."""
1029
927
    # split on either delimiter because people might use either on
1030
928
    # Windows
1031
 
    if isinstance(p, bytes):
1032
 
        ps = re.split(b'[\\\\/]', p)
1033
 
    else:
1034
 
        ps = re.split(r'[\\/]', p)
 
929
    ps = re.split(r'[\\/]', p)
1035
930
 
1036
931
    rps = []
1037
932
    for f in ps:
1038
 
        if f in ('..', b'..'):
1039
 
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
1040
 
        elif f in ('.', '', b'.', b''):
 
933
        if f == '..':
 
934
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
935
        elif (f == '.') or (f == ''):
1041
936
            pass
1042
937
        else:
1043
938
            rps.append(f)
1047
942
def joinpath(p):
1048
943
    for f in p:
1049
944
        if (f == '..') or (f is None) or (f == ''):
1050
 
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
 
945
            raise errors.BzrError("sorry, %r not allowed in path" % f)
1051
946
    return pathjoin(*p)
1052
947
 
1053
948
 
1054
949
def parent_directories(filename):
1055
950
    """Return the list of parent directories, deepest first.
1056
 
 
 
951
    
1057
952
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
1058
953
    """
1059
954
    parents = []
1075
970
    implementation should be loaded instead::
1076
971
 
1077
972
    >>> try:
1078
 
    >>>     import breezy._fictional_extension_pyx
 
973
    >>>     import bzrlib._fictional_extension_pyx
1079
974
    >>> except ImportError, e:
1080
 
    >>>     breezy.osutils.failed_to_load_extension(e)
1081
 
    >>>     import breezy._fictional_extension_py
 
975
    >>>     bzrlib.osutils.failed_to_load_extension(e)
 
976
    >>>     import bzrlib._fictional_extension_py
1082
977
    """
1083
978
    # NB: This docstring is just an example, not a doctest, because doctest
1084
979
    # currently can't cope with the use of lazy imports in this namespace --
1085
980
    # mbp 20090729
1086
 
 
 
981
    
1087
982
    # This currently doesn't report the failure at the time it occurs, because
1088
983
    # they tend to happen very early in startup when we can't check config
1089
984
    # files etc, and also we want to report all failures but not spam the user
1090
985
    # with 10 warnings.
 
986
    from bzrlib import trace
1091
987
    exception_str = str(exception)
1092
988
    if exception_str not in _extension_load_failures:
1093
989
        trace.mutter("failed to load compiled extension: %s" % exception_str)
1097
993
def report_extension_load_failures():
1098
994
    if not _extension_load_failures:
1099
995
        return
1100
 
    if config.GlobalConfig().suppress_warning('missing_extensions'):
 
996
    from bzrlib.config import GlobalConfig
 
997
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
1101
998
        return
1102
999
    # the warnings framework should by default show this only once
1103
 
    from .trace import warning
 
1000
    from bzrlib.trace import warning
1104
1001
    warning(
1105
 
        "brz: warning: some compiled extensions could not be loaded; "
1106
 
        "see ``brz help missing-extensions``")
 
1002
        "bzr: warning: some compiled extensions could not be loaded; "
 
1003
        "see <https://answers.launchpad.net/bzr/+faq/703>")
1107
1004
    # we no longer show the specific missing extensions here, because it makes
1108
1005
    # the message too long and scary - see
1109
1006
    # https://bugs.launchpad.net/bzr/+bug/430529
1110
1007
 
1111
1008
 
1112
1009
try:
1113
 
    from ._chunks_to_lines_pyx import chunks_to_lines
1114
 
except ImportError as e:
 
1010
    from bzrlib._chunks_to_lines_pyx import chunks_to_lines
 
1011
except ImportError, e:
1115
1012
    failed_to_load_extension(e)
1116
 
    from ._chunks_to_lines_py import chunks_to_lines
 
1013
    from bzrlib._chunks_to_lines_py import chunks_to_lines
1117
1014
 
1118
1015
 
1119
1016
def split_lines(s):
1120
1017
    """Split s into lines, but without removing the newline characters."""
1121
1018
    # Trivially convert a fulltext into a 'chunked' representation, and let
1122
1019
    # chunks_to_lines do the heavy lifting.
1123
 
    if isinstance(s, bytes):
 
1020
    if isinstance(s, str):
1124
1021
        # chunks_to_lines only supports 8-bit strings
1125
1022
        return chunks_to_lines([s])
1126
1023
    else:
1132
1029
 
1133
1030
    This supports Unicode or plain string objects.
1134
1031
    """
1135
 
    nl = b'\n' if isinstance(s, bytes) else u'\n'
1136
 
    lines = s.split(nl)
1137
 
    result = [line + nl for line in lines[:-1]]
 
1032
    lines = s.split('\n')
 
1033
    result = [line + '\n' for line in lines[:-1]]
1138
1034
    if lines[-1]:
1139
1035
        result.append(lines[-1])
1140
1036
    return result
1151
1047
        return
1152
1048
    try:
1153
1049
        os.link(src, dest)
1154
 
    except (OSError, IOError) as e:
 
1050
    except (OSError, IOError), e:
1155
1051
        if e.errno != errno.EXDEV:
1156
1052
            raise
1157
1053
        shutil.copyfile(src, dest)
1158
1054
 
1159
1055
 
1160
1056
def delete_any(path):
1161
 
    """Delete a file, symlink or directory.
1162
 
 
 
1057
    """Delete a file, symlink or directory.  
 
1058
    
1163
1059
    Will delete even if readonly.
1164
1060
    """
1165
1061
    try:
1166
1062
       _delete_file_or_dir(path)
1167
 
    except (OSError, IOError) as e:
 
1063
    except (OSError, IOError), e:
1168
1064
        if e.errno in (errno.EPERM, errno.EACCES):
1169
1065
            # make writable and try again
1170
1066
            try:
1230
1126
    #    separators
1231
1127
    # 3) '\xa0' isn't unicode safe since it is >128.
1232
1128
 
1233
 
    if isinstance(s, str):
1234
 
        ws = ' \t\n\r\v\f'
1235
 
    else:
1236
 
        ws = (b' ', b'\t', b'\n', b'\r', b'\v', b'\f')
1237
 
    for ch in ws:
 
1129
    # This should *not* be a unicode set of characters in case the source
 
1130
    # string is not a Unicode string. We can auto-up-cast the characters since
 
1131
    # they are ascii, but we don't want to auto-up-cast the string in case it
 
1132
    # is utf-8
 
1133
    for ch in ' \t\n\r\v\f':
1238
1134
        if ch in s:
1239
1135
            return True
1240
1136
    else:
1266
1162
 
1267
1163
    if len(base) < MIN_ABS_PATHLENGTH:
1268
1164
        # must have space for e.g. a drive letter
1269
 
        raise ValueError(gettext('%r is too short to calculate a relative path')
 
1165
        raise ValueError('%r is too short to calculate a relative path'
1270
1166
            % (base,))
1271
1167
 
1272
1168
    rp = abspath(path)
1354
1250
    # but for now, we haven't optimized...
1355
1251
    return [canonical_relpath(base, p) for p in paths]
1356
1252
 
1357
 
 
1358
 
def decode_filename(filename):
1359
 
    """Decode the filename using the filesystem encoding
1360
 
 
1361
 
    If it is unicode, it is returned.
1362
 
    Otherwise it is decoded from the the filesystem's encoding. If decoding
1363
 
    fails, a errors.BadFilenameEncoding exception is raised.
1364
 
    """
1365
 
    if isinstance(filename, text_type):
1366
 
        return filename
1367
 
    try:
1368
 
        return filename.decode(_fs_enc)
1369
 
    except UnicodeDecodeError:
1370
 
        raise errors.BadFilenameEncoding(filename, _fs_enc)
1371
 
 
1372
 
 
1373
1253
def safe_unicode(unicode_or_utf8_string):
1374
1254
    """Coerce unicode_or_utf8_string into unicode.
1375
1255
 
1377
1257
    Otherwise it is decoded from utf-8. If decoding fails, the exception is
1378
1258
    wrapped in a BzrBadParameterNotUnicode exception.
1379
1259
    """
1380
 
    if isinstance(unicode_or_utf8_string, text_type):
 
1260
    if isinstance(unicode_or_utf8_string, unicode):
1381
1261
        return unicode_or_utf8_string
1382
1262
    try:
1383
1263
        return unicode_or_utf8_string.decode('utf8')
1391
1271
    If it is a str, it is returned.
1392
1272
    If it is Unicode, it is encoded into a utf-8 string.
1393
1273
    """
1394
 
    if isinstance(unicode_or_utf8_string, bytes):
 
1274
    if isinstance(unicode_or_utf8_string, str):
1395
1275
        # TODO: jam 20070209 This is overkill, and probably has an impact on
1396
1276
        #       performance if we are dealing with lots of apis that want a
1397
1277
        #       utf-8 revision id
1404
1284
    return unicode_or_utf8_string.encode('utf-8')
1405
1285
 
1406
1286
 
1407
 
def safe_revision_id(unicode_or_utf8_string):
 
1287
_revision_id_warning = ('Unicode revision ids were deprecated in bzr 0.15.'
 
1288
                        ' Revision id generators should be creating utf8'
 
1289
                        ' revision ids.')
 
1290
 
 
1291
 
 
1292
def safe_revision_id(unicode_or_utf8_string, warn=True):
1408
1293
    """Revision ids should now be utf8, but at one point they were unicode.
1409
1294
 
1410
1295
    :param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
1411
1296
        utf8 or None).
 
1297
    :param warn: Functions that are sanitizing user data can set warn=False
1412
1298
    :return: None or a utf8 revision id.
1413
1299
    """
1414
1300
    if (unicode_or_utf8_string is None
1415
 
        or unicode_or_utf8_string.__class__ == bytes):
 
1301
        or unicode_or_utf8_string.__class__ == str):
1416
1302
        return unicode_or_utf8_string
1417
 
    raise TypeError('Unicode revision ids are no longer supported. '
1418
 
                    'Revision id generators should be creating utf8 revision '
1419
 
                    'ids.')
1420
 
 
1421
 
 
1422
 
def safe_file_id(unicode_or_utf8_string):
 
1303
    if warn:
 
1304
        symbol_versioning.warn(_revision_id_warning, DeprecationWarning,
 
1305
                               stacklevel=2)
 
1306
    return cache_utf8.encode(unicode_or_utf8_string)
 
1307
 
 
1308
 
 
1309
_file_id_warning = ('Unicode file ids were deprecated in bzr 0.15. File id'
 
1310
                    ' generators should be creating utf8 file ids.')
 
1311
 
 
1312
 
 
1313
def safe_file_id(unicode_or_utf8_string, warn=True):
1423
1314
    """File ids should now be utf8, but at one point they were unicode.
1424
1315
 
1425
1316
    This is the same as safe_utf8, except it uses the cached encode functions
1427
1318
 
1428
1319
    :param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
1429
1320
        utf8 or None).
 
1321
    :param warn: Functions that are sanitizing user data can set warn=False
1430
1322
    :return: None or a utf8 file id.
1431
1323
    """
1432
1324
    if (unicode_or_utf8_string is None
1433
 
        or unicode_or_utf8_string.__class__ == bytes):
 
1325
        or unicode_or_utf8_string.__class__ == str):
1434
1326
        return unicode_or_utf8_string
1435
 
    raise TypeError('Unicode file ids are no longer supported. '
1436
 
                    'File id generators should be creating utf8 file ids.')
 
1327
    if warn:
 
1328
        symbol_versioning.warn(_file_id_warning, DeprecationWarning,
 
1329
                               stacklevel=2)
 
1330
    return cache_utf8.encode(unicode_or_utf8_string)
1437
1331
 
1438
1332
 
1439
1333
_platform_normalizes_filenames = False
1444
1338
def normalizes_filenames():
1445
1339
    """Return True if this platform normalizes unicode filenames.
1446
1340
 
1447
 
    Only Mac OSX.
 
1341
    Mac OSX does, Windows/Linux do not.
1448
1342
    """
1449
1343
    return _platform_normalizes_filenames
1450
1344
 
1455
1349
    On platforms where the system normalizes filenames (Mac OSX),
1456
1350
    you can access a file by any path which will normalize correctly.
1457
1351
    On platforms where the system does not normalize filenames
1458
 
    (everything else), you have to access a file by its exact path.
 
1352
    (Windows, Linux), you have to access a file by its exact path.
1459
1353
 
1460
1354
    Internally, bzr only supports NFC normalization, since that is
1461
1355
    the standard for XML documents.
1464
1358
    can be accessed by that path.
1465
1359
    """
1466
1360
 
1467
 
    if isinstance(path, bytes):
1468
 
        path = path.decode(sys.getfilesystemencoding())
1469
 
    return unicodedata.normalize('NFC', path), True
 
1361
    return unicodedata.normalize('NFC', unicode(path)), True
1470
1362
 
1471
1363
 
1472
1364
def _inaccessible_normalized_filename(path):
1473
1365
    __doc__ = _accessible_normalized_filename.__doc__
1474
1366
 
1475
 
    if isinstance(path, bytes):
1476
 
        path = path.decode(sys.getfilesystemencoding())
1477
 
    normalized = unicodedata.normalize('NFC', path)
 
1367
    normalized = unicodedata.normalize('NFC', unicode(path))
1478
1368
    return normalized, normalized == path
1479
1369
 
1480
1370
 
1527
1417
terminal_width() returns None.
1528
1418
"""
1529
1419
 
1530
 
# Keep some state so that terminal_width can detect if _terminal_size has
1531
 
# returned a different size since the process started.  See docstring and
1532
 
# comments of terminal_width for details.
1533
 
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
1534
 
_terminal_size_state = 'no_data'
1535
 
_first_terminal_size = None
1536
1420
 
1537
1421
def terminal_width():
1538
1422
    """Return terminal width.
1540
1424
    None is returned if the width can't established precisely.
1541
1425
 
1542
1426
    The rules are:
1543
 
    - if BRZ_COLUMNS is set, returns its value
 
1427
    - if BZR_COLUMNS is set, returns its value
1544
1428
    - if there is no controlling terminal, returns None
1545
 
    - query the OS, if the queried size has changed since the last query,
1546
 
      return its value,
1547
1429
    - if COLUMNS is set, returns its value,
1548
 
    - if the OS has a value (even though it's never changed), return its value.
1549
1430
 
1550
1431
    From there, we need to query the OS to get the size of the controlling
1551
1432
    terminal.
1552
1433
 
1553
 
    On Unices we query the OS by:
 
1434
    Unices:
1554
1435
    - get termios.TIOCGWINSZ
1555
1436
    - if an error occurs or a negative value is obtained, returns None
1556
1437
 
1557
 
    On Windows we query the OS by:
 
1438
    Windows:
 
1439
    
1558
1440
    - win32utils.get_console_size() decides,
1559
1441
    - returns None on error (provided default value)
1560
1442
    """
1561
 
    # Note to implementors: if changing the rules for determining the width,
1562
 
    # make sure you've considered the behaviour in these cases:
1563
 
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1564
 
    #  - brz log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1565
 
    #    0,0.
1566
 
    #  - (add more interesting cases here, if you find any)
1567
 
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1568
 
    # but we don't want to register a signal handler because it is impossible
1569
 
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
1570
 
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
1571
 
    # time so we can notice if the reported size has changed, which should have
1572
 
    # a similar effect.
1573
1443
 
1574
 
    # If BRZ_COLUMNS is set, take it, user is always right
1575
 
    # Except if they specified 0 in which case, impose no limit here
 
1444
    # If BZR_COLUMNS is set, take it, user is always right
1576
1445
    try:
1577
 
        width = int(os.environ['BRZ_COLUMNS'])
 
1446
        return int(os.environ['BZR_COLUMNS'])
1578
1447
    except (KeyError, ValueError):
1579
 
        width = None
1580
 
    if width is not None:
1581
 
        if width > 0:
1582
 
            return width
1583
 
        else:
1584
 
            return None
 
1448
        pass
1585
1449
 
1586
1450
    isatty = getattr(sys.stdout, 'isatty', None)
1587
 
    if isatty is None or not isatty():
1588
 
        # Don't guess, setting BRZ_COLUMNS is the recommended way to override.
 
1451
    if  isatty is None or not isatty():
 
1452
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1589
1453
        return None
1590
1454
 
1591
 
    # Query the OS
1592
 
    width, height = os_size = _terminal_size(None, None)
1593
 
    global _first_terminal_size, _terminal_size_state
1594
 
    if _terminal_size_state == 'no_data':
1595
 
        _first_terminal_size = os_size
1596
 
        _terminal_size_state = 'unchanged'
1597
 
    elif (_terminal_size_state == 'unchanged' and
1598
 
          _first_terminal_size != os_size):
1599
 
        _terminal_size_state = 'changed'
1600
 
 
1601
 
    # If the OS claims to know how wide the terminal is, and this value has
1602
 
    # ever changed, use that.
1603
 
    if _terminal_size_state == 'changed':
1604
 
        if width is not None and width > 0:
1605
 
            return width
1606
 
 
1607
 
    # If COLUMNS is set, use it.
 
1455
    # If COLUMNS is set, take it, the terminal knows better (even inside a
 
1456
    # given terminal, the application can decide to set COLUMNS to a lower
 
1457
    # value (splitted screen) or a bigger value (scroll bars))
1608
1458
    try:
1609
1459
        return int(os.environ['COLUMNS'])
1610
1460
    except (KeyError, ValueError):
1611
1461
        pass
1612
1462
 
1613
 
    # Finally, use an unchanged size from the OS, if we have one.
1614
 
    if _terminal_size_state == 'unchanged':
1615
 
        if width is not None and width > 0:
1616
 
            return width
 
1463
    width, height = _terminal_size(None, None)
 
1464
    if width <= 0:
 
1465
        # Consider invalid values as meaning no width
 
1466
        return None
1617
1467
 
1618
 
    # The width could not be determined.
1619
 
    return None
 
1468
    return width
1620
1469
 
1621
1470
 
1622
1471
def _win32_terminal_size(width, height):
1649
1498
    _terminal_size = _ioctl_terminal_size
1650
1499
 
1651
1500
 
 
1501
def _terminal_size_changed(signum, frame):
 
1502
    """Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
 
1503
    width, height = _terminal_size(None, None)
 
1504
    if width is not None:
 
1505
        os.environ['COLUMNS'] = str(width)
 
1506
 
 
1507
 
 
1508
_registered_sigwinch = False
 
1509
def watch_sigwinch():
 
1510
    """Register for SIGWINCH, once and only once.
 
1511
 
 
1512
    Do nothing if the signal module is not available.
 
1513
    """
 
1514
    global _registered_sigwinch
 
1515
    if not _registered_sigwinch:
 
1516
        try:
 
1517
            import signal
 
1518
            if getattr(signal, "SIGWINCH", None) is not None:
 
1519
                set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
 
1520
        except ImportError:
 
1521
            # python doesn't provide signal support, nothing we can do about it
 
1522
            pass
 
1523
        _registered_sigwinch = True
 
1524
 
 
1525
 
1652
1526
def supports_executable():
1653
1527
    return sys.platform != "win32"
1654
1528
 
1679
1553
        if orig_val is not None:
1680
1554
            del os.environ[env_variable]
1681
1555
    else:
1682
 
        if not PY3 and isinstance(value, text_type):
 
1556
        if isinstance(value, unicode):
1683
1557
            value = value.encode(get_user_encoding())
1684
1558
        os.environ[env_variable] = value
1685
1559
    return orig_val
1777
1651
        dirblock = []
1778
1652
        append = dirblock.append
1779
1653
        try:
1780
 
            names = sorted(map(decode_filename, _listdir(top)))
1781
 
        except OSError as e:
 
1654
            names = sorted(_listdir(top))
 
1655
        except OSError, e:
1782
1656
            if not _is_error_enotdir(e):
1783
1657
                raise
1784
1658
        else:
1837
1711
    """
1838
1712
    global _selected_dir_reader
1839
1713
    if _selected_dir_reader is None:
1840
 
        if sys.platform == "win32":
 
1714
        fs_encoding = _fs_enc.upper()
 
1715
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
 
1716
            # Win98 doesn't have unicode apis like FindFirstFileW
 
1717
            # TODO: We possibly could support Win98 by falling back to the
 
1718
            #       original FindFirstFile, and using TCHAR instead of WCHAR,
 
1719
            #       but that gets a bit tricky, and requires custom compiling
 
1720
            #       for win98 anyway.
1841
1721
            try:
1842
 
                from ._walkdirs_win32 import Win32ReadDir
 
1722
                from bzrlib._walkdirs_win32 import Win32ReadDir
1843
1723
                _selected_dir_reader = Win32ReadDir()
1844
1724
            except ImportError:
1845
1725
                pass
1846
 
        elif _fs_enc in ('utf-8', 'ascii'):
 
1726
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
 
1727
            # ANSI_X3.4-1968 is a form of ASCII
1847
1728
            try:
1848
 
                from ._readdir_pyx import UTF8DirReader
 
1729
                from bzrlib._readdir_pyx import UTF8DirReader
1849
1730
                _selected_dir_reader = UTF8DirReader()
1850
 
            except ImportError as e:
 
1731
            except ImportError, e:
1851
1732
                failed_to_load_extension(e)
1852
1733
                pass
1853
1734
 
1898
1779
        See DirReader.read_dir for details.
1899
1780
        """
1900
1781
        _utf8_encode = self._utf8_encode
1901
 
        _fs_decode = lambda s: s.decode(_fs_enc)
1902
 
        _fs_encode = lambda s: s.encode(_fs_enc)
1903
1782
        _lstat = os.lstat
1904
1783
        _listdir = os.listdir
1905
1784
        _kind_from_mode = file_kind_from_stat_mode
1906
1785
 
1907
1786
        if prefix:
1908
 
            relprefix = prefix + b'/'
 
1787
            relprefix = prefix + '/'
1909
1788
        else:
1910
 
            relprefix = b''
1911
 
        top_slash = top + '/'
 
1789
            relprefix = ''
 
1790
        top_slash = top + u'/'
1912
1791
 
1913
1792
        dirblock = []
1914
1793
        append = dirblock.append
1915
 
        for name_native in _listdir(top.encode('utf-8')):
 
1794
        for name in sorted(_listdir(top)):
1916
1795
            try:
1917
 
                name = _fs_decode(name_native)
 
1796
                name_utf8 = _utf8_encode(name)[0]
1918
1797
            except UnicodeDecodeError:
1919
1798
                raise errors.BadFilenameEncoding(
1920
 
                    relprefix + name_native, _fs_enc)
1921
 
            name_utf8 = _utf8_encode(name)[0]
 
1799
                    _utf8_encode(relprefix)[0] + name, _fs_enc)
1922
1800
            abspath = top_slash + name
1923
1801
            statvalue = _lstat(abspath)
1924
1802
            kind = _kind_from_mode(statvalue.st_mode)
1925
1803
            append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
1926
 
        return sorted(dirblock)
 
1804
        return dirblock
1927
1805
 
1928
1806
 
1929
1807
def copy_tree(from_path, to_path, handlers={}):
1954
1832
        link_to = os.readlink(source)
1955
1833
        os.symlink(link_to, dest)
1956
1834
 
1957
 
    real_handlers = {'file': shutil.copy2,
1958
 
                     'symlink': copy_link,
1959
 
                     'directory': copy_dir,
 
1835
    real_handlers = {'file':shutil.copy2,
 
1836
                     'symlink':copy_link,
 
1837
                     'directory':copy_dir,
1960
1838
                    }
1961
1839
    real_handlers.update(handlers)
1962
1840
 
1986
1864
    try:
1987
1865
        s = os.stat(src)
1988
1866
        chown(dst, s.st_uid, s.st_gid)
1989
 
    except OSError as e:
1990
 
        trace.warning(
1991
 
            'Unable to copy ownership from "%s" to "%s". '
1992
 
            'You may want to set it manually.', src, dst)
1993
 
        trace.log_exception_quietly()
 
1867
    except OSError, e:
 
1868
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
1994
1869
 
1995
1870
 
1996
1871
def path_prefix_key(path):
1998
1873
 
1999
1874
    This can be used to sort paths in the same way that walkdirs does.
2000
1875
    """
2001
 
    return (dirname(path), path)
 
1876
    return (dirname(path) , path)
2002
1877
 
2003
1878
 
2004
1879
def compare_paths_prefix_order(path_a, path_b):
2005
1880
    """Compare path_a and path_b to generate the same order walkdirs uses."""
2006
1881
    key_a = path_prefix_key(path_a)
2007
1882
    key_b = path_prefix_key(path_b)
2008
 
    return (key_a > key_b) - (key_a < key_b)
 
1883
    return cmp(key_a, key_b)
2009
1884
 
2010
1885
 
2011
1886
_cached_user_encoding = None
2012
1887
 
2013
1888
 
2014
 
def get_user_encoding():
 
1889
def get_user_encoding(use_cache=True):
2015
1890
    """Find out what the preferred user encoding is.
2016
1891
 
2017
1892
    This is generally the encoding that is used for command line parameters
2018
1893
    and file contents. This may be different from the terminal encoding
2019
1894
    or the filesystem encoding.
2020
1895
 
 
1896
    :param  use_cache:  Enable cache for detected encoding.
 
1897
                        (This parameter is turned on by default,
 
1898
                        and required only for selftesting)
 
1899
 
2021
1900
    :return: A string defining the preferred user encoding
2022
1901
    """
2023
1902
    global _cached_user_encoding
2024
 
    if _cached_user_encoding is not None:
 
1903
    if _cached_user_encoding is not None and use_cache:
2025
1904
        return _cached_user_encoding
2026
1905
 
2027
 
    if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
2028
 
        # Use the existing locale settings and call nl_langinfo directly
2029
 
        # rather than going through getpreferredencoding. This avoids
2030
 
        # <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
2031
 
        # possibility of the setlocale call throwing an error.
2032
 
        user_encoding = locale.nl_langinfo(locale.CODESET)
 
1906
    if sys.platform == 'darwin':
 
1907
        # python locale.getpreferredencoding() always return
 
1908
        # 'mac-roman' on darwin. That's a lie.
 
1909
        sys.platform = 'posix'
 
1910
        try:
 
1911
            if os.environ.get('LANG', None) is None:
 
1912
                # If LANG is not set, we end up with 'ascii', which is bad
 
1913
                # ('mac-roman' is more than ascii), so we set a default which
 
1914
                # will give us UTF-8 (which appears to work in all cases on
 
1915
                # OSX). Users are still free to override LANG of course, as
 
1916
                # long as it give us something meaningful. This work-around
 
1917
                # *may* not be needed with python 3k and/or OSX 10.5, but will
 
1918
                # work with them too -- vila 20080908
 
1919
                os.environ['LANG'] = 'en_US.UTF-8'
 
1920
            import locale
 
1921
        finally:
 
1922
            sys.platform = 'darwin'
2033
1923
    else:
2034
 
        # GZ 2011-12-19: On windows could call GetACP directly instead.
2035
 
        user_encoding = locale.getpreferredencoding(False)
 
1924
        import locale
2036
1925
 
2037
1926
    try:
2038
 
        user_encoding = codecs.lookup(user_encoding).name
2039
 
    except LookupError:
2040
 
        if user_encoding not in ("", "cp0"):
2041
 
            sys.stderr.write('brz: warning:'
 
1927
        user_encoding = locale.getpreferredencoding()
 
1928
    except locale.Error, e:
 
1929
        sys.stderr.write('bzr: warning: %s\n'
 
1930
                         '  Could not determine what text encoding to use.\n'
 
1931
                         '  This error usually means your Python interpreter\n'
 
1932
                         '  doesn\'t support the locale set by $LANG (%s)\n'
 
1933
                         "  Continuing with ascii encoding.\n"
 
1934
                         % (e, os.environ.get('LANG')))
 
1935
        user_encoding = 'ascii'
 
1936
 
 
1937
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
 
1938
    # treat that as ASCII, and not support printing unicode characters to the
 
1939
    # console.
 
1940
    #
 
1941
    # For python scripts run under vim, we get '', so also treat that as ASCII
 
1942
    if user_encoding in (None, 'cp0', ''):
 
1943
        user_encoding = 'ascii'
 
1944
    else:
 
1945
        # check encoding
 
1946
        try:
 
1947
            codecs.lookup(user_encoding)
 
1948
        except LookupError:
 
1949
            sys.stderr.write('bzr: warning:'
2042
1950
                             ' unknown encoding %s.'
2043
1951
                             ' Continuing with ascii encoding.\n'
2044
1952
                             % user_encoding
2045
1953
                            )
2046
 
        user_encoding = 'ascii'
2047
 
    else:
2048
 
        # Get 'ascii' when setlocale has not been called or LANG=C or unset.
2049
 
        if user_encoding == 'ascii':
2050
 
            if sys.platform == 'darwin':
2051
 
                # OSX is special-cased in Python to have a UTF-8 filesystem
2052
 
                # encoding and previously had LANG set here if not present.
2053
 
                user_encoding = 'utf-8'
2054
 
            # GZ 2011-12-19: Maybe UTF-8 should be the default in this case
2055
 
            #                for some other posix platforms as well.
2056
 
 
2057
 
    _cached_user_encoding = user_encoding
 
1954
            user_encoding = 'ascii'
 
1955
 
 
1956
    if use_cache:
 
1957
        _cached_user_encoding = user_encoding
 
1958
 
2058
1959
    return user_encoding
2059
1960
 
2060
1961
 
2061
 
def get_diff_header_encoding():
2062
 
    return get_terminal_encoding()
2063
 
 
2064
 
 
2065
1962
def get_host_name():
2066
1963
    """Return the current unicode host name.
2067
1964
 
2069
1966
    behaves inconsistently on different platforms.
2070
1967
    """
2071
1968
    if sys.platform == "win32":
 
1969
        import win32utils
2072
1970
        return win32utils.get_host_name()
2073
1971
    else:
2074
1972
        import socket
2075
 
        if PY3:
2076
 
            return socket.gethostname()
2077
1973
        return socket.gethostname().decode(get_user_encoding())
2078
1974
 
2079
1975
 
2083
1979
# data at once.
2084
1980
MAX_SOCKET_CHUNK = 64 * 1024
2085
1981
 
2086
 
_end_of_stream_errors = [errno.ECONNRESET, errno.EPIPE, errno.EINVAL]
2087
 
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
2088
 
    _eno = getattr(errno, _eno, None)
2089
 
    if _eno is not None:
2090
 
        _end_of_stream_errors.append(_eno)
2091
 
del _eno
2092
 
 
2093
 
 
2094
1982
def read_bytes_from_socket(sock, report_activity=None,
2095
1983
        max_read_size=MAX_SOCKET_CHUNK):
2096
1984
    """Read up to max_read_size of bytes from sock and notify of progress.
2099
1987
    empty string rather than raise an error), and repeats the recv if
2100
1988
    interrupted by a signal.
2101
1989
    """
2102
 
    while True:
 
1990
    while 1:
2103
1991
        try:
2104
 
            data = sock.recv(max_read_size)
2105
 
        except socket.error as e:
 
1992
            bytes = sock.recv(max_read_size)
 
1993
        except socket.error, e:
2106
1994
            eno = e.args[0]
2107
 
            if eno in _end_of_stream_errors:
 
1995
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
2108
1996
                # The connection was closed by the other side.  Callers expect
2109
1997
                # an empty string to signal end-of-stream.
2110
 
                return b""
 
1998
                return ""
2111
1999
            elif eno == errno.EINTR:
2112
2000
                # Retry the interrupted recv.
2113
2001
                continue
2114
2002
            raise
2115
2003
        else:
2116
2004
            if report_activity is not None:
2117
 
                report_activity(len(data), 'read')
2118
 
            return data
 
2005
                report_activity(len(bytes), 'read')
 
2006
            return bytes
2119
2007
 
2120
2008
 
2121
2009
def recv_all(socket, count):
2128
2016
 
2129
2017
    This isn't optimized and is intended mostly for use in testing.
2130
2018
    """
2131
 
    b = b''
 
2019
    b = ''
2132
2020
    while len(b) < count:
2133
2021
        new = read_bytes_from_socket(socket, None, count - len(b))
2134
 
        if new == b'':
 
2022
        if new == '':
2135
2023
            break # eof
2136
2024
        b += new
2137
2025
    return b
2139
2027
 
2140
2028
def send_all(sock, bytes, report_activity=None):
2141
2029
    """Send all bytes on a socket.
2142
 
 
 
2030
 
2143
2031
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2144
2032
    some platforms, and catches EINTR which may be thrown if the send is
2145
2033
    interrupted by a signal.
2146
2034
 
2147
2035
    This is preferred to socket.sendall(), because it avoids portability bugs
2148
2036
    and provides activity reporting.
2149
 
 
 
2037
 
2150
2038
    :param report_activity: Call this as bytes are read, see
2151
2039
        Transport._report_activity
2152
2040
    """
2153
2041
    sent_total = 0
2154
2042
    byte_count = len(bytes)
2155
 
    view = memoryview(bytes)
2156
2043
    while sent_total < byte_count:
2157
2044
        try:
2158
 
            sent = sock.send(view[sent_total:sent_total+MAX_SOCKET_CHUNK])
2159
 
        except (socket.error, IOError) as e:
2160
 
            if e.args[0] in _end_of_stream_errors:
2161
 
                raise errors.ConnectionReset(
2162
 
                    "Error trying to write to socket", e)
 
2045
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
 
2046
        except socket.error, e:
2163
2047
            if e.args[0] != errno.EINTR:
2164
2048
                raise
2165
2049
        else:
2166
 
            if sent == 0:
2167
 
                raise errors.ConnectionReset('Sending to %s returned 0 bytes'
2168
 
                                             % (sock,))
2169
2050
            sent_total += sent
2170
 
            if report_activity is not None:
2171
 
                report_activity(sent, 'write')
2172
 
 
2173
 
 
2174
 
def connect_socket(address):
2175
 
    # Slight variation of the socket.create_connection() function (provided by
2176
 
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
2177
 
    # provide it for previous python versions. Also, we don't use the timeout
2178
 
    # parameter (provided by the python implementation) so we don't implement
2179
 
    # it either).
2180
 
    err = socket.error('getaddrinfo returns an empty list')
2181
 
    host, port = address
2182
 
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
2183
 
        af, socktype, proto, canonname, sa = res
2184
 
        sock = None
2185
 
        try:
2186
 
            sock = socket.socket(af, socktype, proto)
2187
 
            sock.connect(sa)
2188
 
            return sock
2189
 
 
2190
 
        except socket.error as e:
2191
 
            err = e
2192
 
            # 'err' is now the most recent error
2193
 
            if sock is not None:
2194
 
                sock.close()
2195
 
    raise err
 
2051
            report_activity(sent, 'write')
2196
2052
 
2197
2053
 
2198
2054
def dereference_path(path):
2217
2073
def resource_string(package, resource_name):
2218
2074
    """Load a resource from a package and return it as a string.
2219
2075
 
2220
 
    Note: Only packages that start with breezy are currently supported.
 
2076
    Note: Only packages that start with bzrlib are currently supported.
2221
2077
 
2222
2078
    This is designed to be a lightweight implementation of resource
2223
2079
    loading in a way which is API compatible with the same API from
2226
2082
    If and when pkg_resources becomes a standard library, this routine
2227
2083
    can delegate to it.
2228
2084
    """
2229
 
    # Check package name is within breezy
2230
 
    if package == "breezy":
 
2085
    # Check package name is within bzrlib
 
2086
    if package == "bzrlib":
2231
2087
        resource_relpath = resource_name
2232
 
    elif package.startswith("breezy."):
2233
 
        package = package[len("breezy."):].replace('.', os.sep)
 
2088
    elif package.startswith("bzrlib."):
 
2089
        package = package[len("bzrlib."):].replace('.', os.sep)
2234
2090
        resource_relpath = pathjoin(package, resource_name)
2235
2091
    else:
2236
 
        raise errors.BzrError('resource package %s not in breezy' % package)
 
2092
        raise errors.BzrError('resource package %s not in bzrlib' % package)
2237
2093
 
2238
2094
    # Map the resource to a file and read its contents
2239
 
    base = dirname(breezy.__file__)
 
2095
    base = dirname(bzrlib.__file__)
2240
2096
    if getattr(sys, 'frozen', None):    # bzr.exe
2241
2097
        base = abspath(pathjoin(base, '..', '..'))
2242
 
    with open(pathjoin(base, resource_relpath), "rt") as f:
2243
 
        return f.read()
 
2098
    filename = pathjoin(base, resource_relpath)
 
2099
    return open(filename, 'rU').read()
 
2100
 
2244
2101
 
2245
2102
def file_kind_from_stat_mode_thunk(mode):
2246
2103
    global file_kind_from_stat_mode
2247
2104
    if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
2248
2105
        try:
2249
 
            from ._readdir_pyx import UTF8DirReader
 
2106
            from bzrlib._readdir_pyx import UTF8DirReader
2250
2107
            file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2251
 
        except ImportError as e:
 
2108
        except ImportError, e:
2252
2109
            # This is one time where we won't warn that an extension failed to
2253
2110
            # load. The extension is never available on Windows anyway.
2254
 
            from ._readdir_py import (
 
2111
            from bzrlib._readdir_py import (
2255
2112
                _kind_from_mode as file_kind_from_stat_mode
2256
2113
                )
2257
2114
    return file_kind_from_stat_mode(mode)
2258
2115
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2259
2116
 
2260
 
def file_stat(f, _lstat=os.lstat):
 
2117
 
 
2118
def file_kind(f, _lstat=os.lstat):
2261
2119
    try:
2262
 
        # XXX cache?
2263
 
        return _lstat(f)
2264
 
    except OSError as e:
 
2120
        return file_kind_from_stat_mode(_lstat(f).st_mode)
 
2121
    except OSError, e:
2265
2122
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2266
2123
            raise errors.NoSuchFile(f)
2267
2124
        raise
2268
2125
 
2269
 
def file_kind(f, _lstat=os.lstat):
2270
 
    stat_value = file_stat(f, _lstat)
2271
 
    return file_kind_from_stat_mode(stat_value.st_mode)
2272
2126
 
2273
2127
def until_no_eintr(f, *a, **kw):
2274
2128
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2275
 
 
 
2129
    
2276
2130
    WARNING: you must be certain that it is safe to retry the call repeatedly
2277
2131
    if EINTR does occur.  This is typically only true for low-level operations
2278
2132
    like os.read.  If in any doubt, don't use this.
2280
2134
    Keep in mind that this is not a complete solution to EINTR.  There is
2281
2135
    probably code in the Python standard library and other dependencies that
2282
2136
    may encounter EINTR if a signal arrives (and there is signal handler for
2283
 
    that signal).  So this function can reduce the impact for IO that breezy
 
2137
    that signal).  So this function can reduce the impact for IO that bzrlib
2284
2138
    directly controls, but it is not a complete solution.
2285
2139
    """
2286
2140
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
2287
2141
    while True:
2288
2142
        try:
2289
2143
            return f(*a, **kw)
2290
 
        except (IOError, OSError) as e:
 
2144
        except (IOError, OSError), e:
2291
2145
            if e.errno == errno.EINTR:
2292
2146
                continue
2293
2147
            raise
2294
2148
 
2295
2149
 
 
2150
def re_compile_checked(re_string, flags=0, where=""):
 
2151
    """Return a compiled re, or raise a sensible error.
 
2152
 
 
2153
    This should only be used when compiling user-supplied REs.
 
2154
 
 
2155
    :param re_string: Text form of regular expression.
 
2156
    :param flags: eg re.IGNORECASE
 
2157
    :param where: Message explaining to the user the context where
 
2158
        it occurred, eg 'log search filter'.
 
2159
    """
 
2160
    # from https://bugs.launchpad.net/bzr/+bug/251352
 
2161
    try:
 
2162
        re_obj = re.compile(re_string, flags)
 
2163
        re_obj.search("")
 
2164
        return re_obj
 
2165
    except re.error, e:
 
2166
        if where:
 
2167
            where = ' in ' + where
 
2168
        # despite the name 'error' is a type
 
2169
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
 
2170
            % (where, re_string, e))
 
2171
 
 
2172
 
2296
2173
if sys.platform == "win32":
 
2174
    import msvcrt
2297
2175
    def getchar():
2298
 
        import msvcrt
2299
2176
        return msvcrt.getch()
2300
2177
else:
 
2178
    import tty
 
2179
    import termios
2301
2180
    def getchar():
2302
 
        import tty
2303
 
        import termios
2304
2181
        fd = sys.stdin.fileno()
2305
2182
        settings = termios.tcgetattr(fd)
2306
2183
        try:
2310
2187
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2311
2188
        return ch
2312
2189
 
2313
 
if sys.platform.startswith('linux'):
 
2190
 
 
2191
if sys.platform == 'linux2':
2314
2192
    def _local_concurrency():
2315
 
        try:
2316
 
            return os.sysconf('SC_NPROCESSORS_ONLN')
2317
 
        except (ValueError, OSError, AttributeError):
2318
 
            return None
 
2193
        concurrency = None
 
2194
        prefix = 'processor'
 
2195
        for line in file('/proc/cpuinfo', 'rb'):
 
2196
            if line.startswith(prefix):
 
2197
                concurrency = int(line[line.find(':')+1:]) + 1
 
2198
        return concurrency
2319
2199
elif sys.platform == 'darwin':
2320
2200
    def _local_concurrency():
2321
2201
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2322
2202
                                stdout=subprocess.PIPE).communicate()[0]
2323
 
elif "bsd" in sys.platform:
 
2203
elif sys.platform[0:7] == 'freebsd':
2324
2204
    def _local_concurrency():
2325
2205
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2326
2206
                                stdout=subprocess.PIPE).communicate()[0]
2351
2231
    if _cached_local_concurrency is not None and use_cache:
2352
2232
        return _cached_local_concurrency
2353
2233
 
2354
 
    concurrency = os.environ.get('BRZ_CONCURRENCY', None)
 
2234
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2355
2235
    if concurrency is None:
2356
 
        import multiprocessing
2357
2236
        try:
2358
 
            concurrency = multiprocessing.cpu_count()
2359
 
        except NotImplementedError:
2360
 
            # multiprocessing.cpu_count() isn't implemented on all platforms
2361
 
            try:
2362
 
                concurrency = _local_concurrency()
2363
 
            except (OSError, IOError):
2364
 
                pass
 
2237
            concurrency = _local_concurrency()
 
2238
        except (OSError, IOError):
 
2239
            pass
2365
2240
    try:
2366
2241
        concurrency = int(concurrency)
2367
2242
    except (TypeError, ValueError):
2379
2254
        self.encode = encode
2380
2255
 
2381
2256
    def write(self, object):
2382
 
        if isinstance(object, str):
 
2257
        if type(object) is str:
2383
2258
            self.stream.write(object)
2384
2259
        else:
2385
2260
            data, _ = self.encode(object, self.errors)
2386
2261
            self.stream.write(data)
2387
2262
 
2388
 
 
2389
2263
if sys.platform == 'win32':
2390
2264
    def open_file(filename, mode='r', bufsize=-1):
2391
2265
        """This function is used to override the ``open`` builtin.
2392
 
 
 
2266
        
2393
2267
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2394
2268
        child processes.  Deleting or renaming a closed file opened with this
2395
2269
        function is not blocking child processes.
2428
2302
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2429
2303
else:
2430
2304
    open_file = open
2431
 
 
2432
 
 
2433
 
def available_backup_name(base, exists):
2434
 
    """Find a non-existing backup file name.
2435
 
 
2436
 
    This will *not* create anything, this only return a 'free' entry.  This
2437
 
    should be used for checking names in a directory below a locked
2438
 
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
2439
 
    Leap) and generally discouraged.
2440
 
 
2441
 
    :param base: The base name.
2442
 
 
2443
 
    :param exists: A callable returning True if the path parameter exists.
2444
 
    """
2445
 
    counter = 1
2446
 
    name = "%s.~%d~" % (base, counter)
2447
 
    while exists(name):
2448
 
        counter += 1
2449
 
        name = "%s.~%d~" % (base, counter)
2450
 
    return name
2451
 
 
2452
 
 
2453
 
def set_fd_cloexec(fd):
2454
 
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
2455
 
    support for this is not available.
2456
 
    """
2457
 
    try:
2458
 
        import fcntl
2459
 
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
2460
 
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
2461
 
    except (ImportError, AttributeError):
2462
 
        # Either the fcntl module or specific constants are not present
2463
 
        pass
2464
 
 
2465
 
 
2466
 
def find_executable_on_path(name):
2467
 
    """Finds an executable on the PATH.
2468
 
    
2469
 
    On Windows, this will try to append each extension in the PATHEXT
2470
 
    environment variable to the name, if it cannot be found with the name
2471
 
    as given.
2472
 
    
2473
 
    :param name: The base name of the executable.
2474
 
    :return: The path to the executable found or None.
2475
 
    """
2476
 
    if sys.platform == 'win32':
2477
 
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
2478
 
        exts = [ext.lower() for ext in exts]
2479
 
        base, ext = os.path.splitext(name)
2480
 
        if ext != '':
2481
 
            if ext.lower() not in exts:
2482
 
                return None
2483
 
            name = base
2484
 
            exts = [ext]
2485
 
    else:
2486
 
        exts = ['']
2487
 
    path = os.environ.get('PATH')
2488
 
    if path is not None:
2489
 
        path = path.split(os.pathsep)
2490
 
        for ext in exts:
2491
 
            for d in path:
2492
 
                f = os.path.join(d, name) + ext
2493
 
                if os.access(f, os.X_OK):
2494
 
                    return f
2495
 
    if sys.platform == 'win32':
2496
 
        app_path = win32utils.get_app_path(name)
2497
 
        if app_path != name:
2498
 
            return app_path
2499
 
    return None
2500
 
 
2501
 
 
2502
 
def _posix_is_local_pid_dead(pid):
2503
 
    """True if pid doesn't correspond to live process on this machine"""
2504
 
    try:
2505
 
        # Special meaning of unix kill: just check if it's there.
2506
 
        os.kill(pid, 0)
2507
 
    except OSError as e:
2508
 
        if e.errno == errno.ESRCH:
2509
 
            # On this machine, and really not found: as sure as we can be
2510
 
            # that it's dead.
2511
 
            return True
2512
 
        elif e.errno == errno.EPERM:
2513
 
            # exists, though not ours
2514
 
            return False
2515
 
        else:
2516
 
            mutter("os.kill(%d, 0) failed: %s" % (pid, e))
2517
 
            # Don't really know.
2518
 
            return False
2519
 
    else:
2520
 
        # Exists and our process: not dead.
2521
 
        return False
2522
 
 
2523
 
if sys.platform == "win32":
2524
 
    is_local_pid_dead = win32utils.is_local_pid_dead
2525
 
else:
2526
 
    is_local_pid_dead = _posix_is_local_pid_dead
2527
 
 
2528
 
_maybe_ignored = ['EAGAIN', 'EINTR', 'ENOTSUP', 'EOPNOTSUPP', 'EACCES']
2529
 
_fdatasync_ignored = [getattr(errno, name) for name in _maybe_ignored
2530
 
                      if getattr(errno, name, None) is not None]
2531
 
 
2532
 
 
2533
 
def fdatasync(fileno):
2534
 
    """Flush file contents to disk if possible.
2535
 
    
2536
 
    :param fileno: Integer OS file handle.
2537
 
    :raises TransportNotPossible: If flushing to disk is not possible.
2538
 
    """
2539
 
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
2540
 
    if fn is not None:
2541
 
        try:
2542
 
            fn(fileno)
2543
 
        except IOError as e:
2544
 
            # See bug #1075108, on some platforms fdatasync exists, but can
2545
 
            # raise ENOTSUP. However, we are calling fdatasync to be helpful
2546
 
            # and reduce the chance of corruption-on-powerloss situations. It
2547
 
            # is not a mandatory call, so it is ok to suppress failures.
2548
 
            trace.mutter("ignoring error calling fdatasync: %s" % (e,))
2549
 
            if getattr(e, 'errno', None) not in _fdatasync_ignored:
2550
 
                raise
2551
 
 
2552
 
 
2553
 
def ensure_empty_directory_exists(path, exception_class):
2554
 
    """Make sure a local directory exists and is empty.
2555
 
    
2556
 
    If it does not exist, it is created.  If it exists and is not empty, an
2557
 
    instance of exception_class is raised.
2558
 
    """
2559
 
    try:
2560
 
        os.mkdir(path)
2561
 
    except OSError as e:
2562
 
        if e.errno != errno.EEXIST:
2563
 
            raise
2564
 
        if os.listdir(path) != []:
2565
 
            raise exception_class(path)
2566
 
 
2567
 
 
2568
 
def is_environment_error(evalue):
2569
 
    """True if exception instance is due to a process environment issue
2570
 
 
2571
 
    This includes OSError and IOError, but also other errors that come from
2572
 
    the operating system or core libraries but are not subclasses of those.
2573
 
    """
2574
 
    if isinstance(evalue, (EnvironmentError, select.error)):
2575
 
        return True
2576
 
    if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
2577
 
        return True
2578
 
    return False