/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 breezy/osutils.py

  • Committer: Jelmer Vernooij
  • Date: 2018-08-18 22:45:58 UTC
  • mto: This revision was merged to the branch mainline in revision 7101.
  • Revision ID: jelmer@jelmer.uk-20180818224558-8ki0baw0ea5jmlqa
Some more walkdir fixes.

Show diffs side-by-side

added added

removed removed

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