/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: Vincent Ladeuil
  • Date: 2019-11-19 17:16:42 UTC
  • mto: (7290.1.43 work)
  • mto: This revision was merged to the branch mainline in revision 7414.
  • Revision ID: v.ladeuil+brz@free.fr-20191119171642-2hn0o07eq32l4sfs
Open 3.0.3 for bugfixes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
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
 
                    )
 
30
import getpass
 
31
import locale
 
32
import ntpath
35
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
36
37
import shutil
37
 
from shutil import (
38
 
    rmtree,
39
 
    )
 
38
from shutil import rmtree
40
39
import socket
41
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
42
43
import tempfile
43
 
from tempfile import (
44
 
    mkdtemp,
45
 
    )
 
44
from tempfile import mkdtemp
46
45
import unicodedata
47
46
 
48
 
from bzrlib import (
49
 
    cache_utf8,
50
 
    errors,
 
47
from breezy import (
 
48
    config,
51
49
    trace,
52
50
    win32utils,
53
51
    )
 
52
from breezy.i18n import gettext
54
53
""")
55
54
 
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
77
 
 
78
 
 
79
 
# Cross platform wall-clock time functionality with decent resolution.
80
 
# On Linux ``time.clock`` returns only CPU time. On Windows, ``time.time()``
81
 
# only has a resolution of ~15ms. Note that ``time.clock()`` is not
82
 
# synchronized with ``time.time()``, this is only meant to be used to find
83
 
# delta times by subtracting from another call to this function.
84
 
timer_func = time.time
85
 
if sys.platform == 'win32':
86
 
    timer_func = time.clock
 
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
    )
 
71
 
87
72
 
88
73
# On win32, O_BINARY is used to indicate the file should
89
74
# be opened in binary mode, rather than text mode.
96
81
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
97
82
 
98
83
 
 
84
class UnsupportedTimezoneFormat(errors.BzrError):
 
85
 
 
86
    _fmt = ('Unsupported timezone format "%(timezone)s", '
 
87
            'options are "utc", "original", "local".')
 
88
 
 
89
    def __init__(self, timezone):
 
90
        self.timezone = timezone
 
91
 
 
92
 
99
93
def get_unicode_argv():
 
94
    if PY3:
 
95
        return sys.argv[1:]
100
96
    try:
101
97
        user_encoding = get_user_encoding()
102
98
        return [a.decode(user_encoding) for a in sys.argv[1:]]
103
99
    except UnicodeDecodeError:
104
 
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
105
 
                                                            "encoding." % a))
 
100
        raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
 
101
                                      "application locale.").format(a, user_encoding))
106
102
 
107
103
 
108
104
def make_readonly(filename):
109
105
    """Make a filename read-only."""
110
106
    mod = os.lstat(filename).st_mode
111
107
    if not stat.S_ISLNK(mod):
112
 
        mod = mod & 0777555
113
 
        os.chmod(filename, mod)
 
108
        mod = mod & 0o777555
 
109
        chmod_if_possible(filename, mod)
114
110
 
115
111
 
116
112
def make_writable(filename):
117
113
    mod = os.lstat(filename).st_mode
118
114
    if not stat.S_ISLNK(mod):
119
 
        mod = mod | 0200
120
 
        os.chmod(filename, mod)
 
115
        mod = mod | 0o200
 
116
        chmod_if_possible(filename, mod)
 
117
 
 
118
 
 
119
def chmod_if_possible(filename, mode):
 
120
    # Set file mode if that can be safely done.
 
121
    # Sometimes even on unix the filesystem won't allow it - see
 
122
    # https://bugs.launchpad.net/bzr/+bug/606537
 
123
    try:
 
124
        # It is probably faster to just do the chmod, rather than
 
125
        # doing a stat, and then trying to compare
 
126
        os.chmod(filename, mode)
 
127
    except (IOError, OSError) as e:
 
128
        # Permission/access denied seems to commonly happen on smbfs; there's
 
129
        # probably no point warning about it.
 
130
        # <https://bugs.launchpad.net/bzr/+bug/606537>
 
131
        if getattr(e, 'errno') in (errno.EPERM, errno.EACCES):
 
132
            trace.mutter("ignore error on chmod of %r: %r" % (
 
133
                filename, e))
 
134
            return
 
135
        raise
121
136
 
122
137
 
123
138
def minimum_path_selection(paths):
131
146
        return set(paths)
132
147
 
133
148
    def sort_key(path):
134
 
        return path.split('/')
 
149
        if isinstance(path, bytes):
 
150
            return path.split(b'/')
 
151
        else:
 
152
            return path.split('/')
135
153
    sorted_paths = sorted(list(paths), key=sort_key)
136
154
 
137
155
    search_paths = [sorted_paths[0]]
164
182
 
165
183
_directory_kind = 'directory'
166
184
 
 
185
 
167
186
def get_umask():
168
187
    """Return the current umask"""
169
188
    # Assume that people aren't messing with the umask while running
198
217
            stat = getattr(os, 'lstat', os.stat)
199
218
            stat(f)
200
219
            return True
201
 
        except OSError, e:
 
220
        except OSError as e:
202
221
            if e.errno == errno.ENOENT:
203
 
                return False;
 
222
                return False
204
223
            else:
205
 
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
 
224
                raise errors.BzrError(
 
225
                    gettext("lstat/stat of ({0!r}): {1!r}").format(f, e))
206
226
 
207
227
 
208
228
def fancy_rename(old, new, rename_func, unlink_func):
232
252
    file_existed = False
233
253
    try:
234
254
        rename_func(new, tmp_name)
235
 
    except (errors.NoSuchFile,), e:
 
255
    except (errors.NoSuchFile,):
236
256
        pass
237
 
    except IOError, e:
 
257
    except IOError as e:
238
258
        # RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
239
259
        # function raises an IOError with errno is None when a rename fails.
240
260
        # This then gets caught here.
241
261
        if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
242
262
            raise
243
 
    except Exception, e:
 
263
    except Exception as e:
244
264
        if (getattr(e, 'errno', None) is None
245
 
            or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
 
265
                or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
246
266
            raise
247
267
    else:
248
268
        file_existed = True
249
269
 
250
 
    failure_exc = None
251
270
    success = False
252
271
    try:
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)
 
272
        # This may throw an exception, in which case success will
 
273
        # not be set.
 
274
        rename_func(old, new)
 
275
        success = True
 
276
    except (IOError, OSError) as e:
 
277
        # source and target may be aliases of each other (e.g. on a
 
278
        # case-insensitive filesystem), so we may have accidentally renamed
 
279
        # source by when we tried to rename target
 
280
        if (file_existed and e.errno in (None, errno.ENOENT)
264
281
                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
 
282
            # source and target are the same file on a case-insensitive
 
283
            # filesystem, so we don't generate an exception
 
284
            pass
 
285
        else:
 
286
            raise
268
287
    finally:
269
288
        if file_existed:
270
289
            # If the file used to exist, rename it back into place
273
292
                unlink_func(tmp_name)
274
293
            else:
275
294
                rename_func(tmp_name, new)
276
 
    if failure_exc is not None:
277
 
        raise failure_exc[0], failure_exc[1], failure_exc[2]
278
295
 
279
296
 
280
297
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
281
298
# choke on a Unicode string containing a relative path if
282
299
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
283
300
# string.
284
 
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
285
301
def _posix_abspath(path):
286
302
    # jam 20060426 rather than encoding to fsencoding
287
303
    # copy posixpath.abspath, but use os.getcwdu instead
288
304
    if not posixpath.isabs(path):
289
305
        path = posixpath.join(getcwd(), path)
290
 
    return posixpath.normpath(path)
 
306
    return _posix_normpath(path)
291
307
 
292
308
 
293
309
def _posix_realpath(path):
294
310
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
295
311
 
296
312
 
 
313
def _posix_normpath(path):
 
314
    path = posixpath.normpath(path)
 
315
    # Bug 861008: posixpath.normpath() returns a path normalized according to
 
316
    # the POSIX standard, which stipulates (for compatibility reasons) that two
 
317
    # leading slashes must not be simplified to one, and only if there are 3 or
 
318
    # more should they be simplified as one. So we treat the leading 2 slashes
 
319
    # as a special case here by simply removing the first slash, as we consider
 
320
    # that breaking POSIX compatibility for this obscure feature is acceptable.
 
321
    # This is not a paranoid precaution, as we notably get paths like this when
 
322
    # the repo is hosted at the root of the filesystem, i.e. in "/".
 
323
    if path.startswith('//'):
 
324
        path = path[1:]
 
325
    return path
 
326
 
 
327
 
 
328
def _posix_path_from_environ(key):
 
329
    """Get unicode path from `key` in environment or None if not present
 
330
 
 
331
    Note that posix systems use arbitrary byte strings for filesystem objects,
 
332
    so a path that raises BadFilenameEncoding here may still be accessible.
 
333
    """
 
334
    val = os.environ.get(key, None)
 
335
    if PY3 or val is None:
 
336
        return val
 
337
    try:
 
338
        return val.decode(_fs_enc)
 
339
    except UnicodeDecodeError:
 
340
        # GZ 2011-12-12:Ideally want to include `key` in the exception message
 
341
        raise errors.BadFilenameEncoding(val, _fs_enc)
 
342
 
 
343
 
 
344
def _posix_get_home_dir():
 
345
    """Get the home directory of the current user as a unicode path"""
 
346
    path = posixpath.expanduser("~")
 
347
    try:
 
348
        return path.decode(_fs_enc)
 
349
    except AttributeError:
 
350
        return path
 
351
    except UnicodeDecodeError:
 
352
        raise errors.BadFilenameEncoding(path, _fs_enc)
 
353
 
 
354
 
 
355
def _posix_getuser_unicode():
 
356
    """Get username from environment or password database as unicode"""
 
357
    name = getpass.getuser()
 
358
    if PY3:
 
359
        return name
 
360
    user_encoding = get_user_encoding()
 
361
    try:
 
362
        return name.decode(user_encoding)
 
363
    except UnicodeDecodeError:
 
364
        raise errors.BzrError("Encoding of username %r is unsupported by %s "
 
365
                              "application locale." % (name, user_encoding))
 
366
 
 
367
 
297
368
def _win32_fixdrive(path):
298
369
    """Force drive letters to be consistent.
299
370
 
303
374
    running python.exe under cmd.exe return capital C:\\
304
375
    running win32 python inside a cygwin shell returns lowercase c:\\
305
376
    """
306
 
    drive, path = _nt_splitdrive(path)
 
377
    drive, path = ntpath.splitdrive(path)
307
378
    return drive.upper() + path
308
379
 
309
380
 
310
381
def _win32_abspath(path):
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('\\', '/'))
 
382
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
 
383
    return _win32_fixdrive(ntpath.abspath(path).replace('\\', '/'))
340
384
 
341
385
 
342
386
def _win32_realpath(path):
343
 
    # Real _nt_realpath doesn't have a problem with a unicode cwd
344
 
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
 
387
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
 
388
    return _win32_fixdrive(ntpath.realpath(path).replace('\\', '/'))
345
389
 
346
390
 
347
391
def _win32_pathjoin(*args):
348
 
    return _nt_join(*args).replace('\\', '/')
 
392
    return ntpath.join(*args).replace('\\', '/')
349
393
 
350
394
 
351
395
def _win32_normpath(path):
352
 
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
396
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
353
397
 
354
398
 
355
399
def _win32_getcwd():
356
 
    return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
 
400
    return _win32_fixdrive(_getcwd().replace('\\', '/'))
357
401
 
358
402
 
359
403
def _win32_mkdtemp(*args, **kwargs):
360
404
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
361
405
 
362
406
 
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
 
 
371
407
def _win32_rename(old, new):
372
408
    """We expect to be able to atomically replace 'new' with old.
373
409
 
375
411
    and then deleted.
376
412
    """
377
413
    try:
378
 
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
379
 
    except OSError, e:
 
414
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
 
415
    except OSError as e:
380
416
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
381
417
            # If we try to rename a non-existant file onto cwd, we get
382
418
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT
386
422
        raise
387
423
 
388
424
 
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
 
 
399
425
def _mac_getcwd():
400
 
    return unicodedata.normalize('NFC', os.getcwdu())
401
 
 
 
426
    return unicodedata.normalize('NFC', _getcwd())
 
427
 
 
428
 
 
429
def _rename_wrap_exception(rename_func):
 
430
    """Adds extra information to any exceptions that come from rename().
 
431
 
 
432
    The exception has an updated message and 'old_filename' and 'new_filename'
 
433
    attributes.
 
434
    """
 
435
 
 
436
    def _rename_wrapper(old, new):
 
437
        try:
 
438
            rename_func(old, new)
 
439
        except OSError as e:
 
440
            detailed_error = OSError(e.errno, e.strerror +
 
441
                                     " [occurred when renaming '%s' to '%s']" %
 
442
                                     (old, new))
 
443
            detailed_error.old_filename = old
 
444
            detailed_error.new_filename = new
 
445
            raise detailed_error
 
446
 
 
447
    return _rename_wrapper
 
448
 
 
449
 
 
450
if sys.version_info > (3,):
 
451
    _getcwd = os.getcwd
 
452
else:
 
453
    _getcwd = os.getcwdu
 
454
 
 
455
 
 
456
# Default rename wraps os.rename()
 
457
rename = _rename_wrap_exception(os.rename)
402
458
 
403
459
# Default is to just use the python builtins, but these can be rebound on
404
460
# particular platforms.
405
461
abspath = _posix_abspath
406
462
realpath = _posix_realpath
407
463
pathjoin = os.path.join
408
 
normpath = os.path.normpath
409
 
rename = _wrapped_rename # overridden below on win32
410
 
getcwd = os.getcwdu
 
464
normpath = _posix_normpath
 
465
path_from_environ = _posix_path_from_environ
 
466
_get_home_dir = _posix_get_home_dir
 
467
getuser_unicode = _posix_getuser_unicode
 
468
getcwd = _getcwd
411
469
dirname = os.path.dirname
412
470
basename = os.path.basename
413
471
split = os.path.split
414
472
splitext = os.path.splitext
415
 
# These were already imported into local scope
 
473
# These were already lazily imported into local scope
416
474
# mkdtemp = tempfile.mkdtemp
417
475
# rmtree = shutil.rmtree
 
476
lstat = os.lstat
 
477
fstat = os.fstat
 
478
 
 
479
 
 
480
def wrap_stat(st):
 
481
    return st
 
482
 
418
483
 
419
484
MIN_ABS_PATHLENGTH = 1
420
485
 
421
486
 
422
487
if sys.platform == 'win32':
423
 
    if win32utils.winver == 'Windows 98':
424
 
        abspath = _win98_abspath
425
 
    else:
426
 
        abspath = _win32_abspath
 
488
    abspath = _win32_abspath
427
489
    realpath = _win32_realpath
428
490
    pathjoin = _win32_pathjoin
429
491
    normpath = _win32_normpath
430
492
    getcwd = _win32_getcwd
431
493
    mkdtemp = _win32_mkdtemp
432
 
    rename = _win32_rename
 
494
    rename = _rename_wrap_exception(_win32_rename)
 
495
    try:
 
496
        from . import _walkdirs_win32
 
497
    except ImportError:
 
498
        pass
 
499
    else:
 
500
        lstat = _walkdirs_win32.lstat
 
501
        fstat = _walkdirs_win32.fstat
 
502
        wrap_stat = _walkdirs_win32.wrap_stat
433
503
 
434
504
    MIN_ABS_PATHLENGTH = 3
435
505
 
439
509
        """
440
510
        exception = excinfo[1]
441
511
        if function in (os.remove, os.rmdir) \
442
 
            and isinstance(exception, OSError) \
443
 
            and exception.errno == errno.EACCES:
 
512
                and isinstance(exception, OSError) \
 
513
                and exception.errno == errno.EACCES:
444
514
            make_writable(path)
445
515
            function(path)
446
516
        else:
450
520
        """Replacer for shutil.rmtree: could remove readonly dirs/files"""
451
521
        return shutil.rmtree(path, ignore_errors, onerror)
452
522
 
453
 
    f = win32utils.get_unicode_argv     # special function or None
454
 
    if f is not None:
455
 
        get_unicode_argv = f
 
523
    get_unicode_argv = getattr(win32utils, 'get_unicode_argv', get_unicode_argv)
 
524
    path_from_environ = win32utils.get_environ_unicode
 
525
    _get_home_dir = win32utils.get_home_location
 
526
    getuser_unicode = win32utils.get_user_name
456
527
 
457
528
elif sys.platform == 'darwin':
458
529
    getcwd = _mac_getcwd
459
530
 
460
531
 
461
 
def get_terminal_encoding():
 
532
def get_terminal_encoding(trace=False):
462
533
    """Find the best encoding for printing to the screen.
463
534
 
464
535
    This attempts to check both sys.stdout and sys.stdin to see
470
541
 
471
542
    On my standard US Windows XP, the preferred encoding is
472
543
    cp1252, but the console is cp437
 
544
 
 
545
    :param trace: If True trace the selected encoding via mutter().
473
546
    """
474
 
    from bzrlib.trace import mutter
 
547
    from .trace import mutter
475
548
    output_encoding = getattr(sys.stdout, 'encoding', None)
476
549
    if not output_encoding:
477
550
        input_encoding = getattr(sys.stdin, 'encoding', None)
478
551
        if not input_encoding:
479
552
            output_encoding = get_user_encoding()
480
 
            mutter('encoding stdout as osutils.get_user_encoding() %r',
481
 
                   output_encoding)
 
553
            if trace:
 
554
                mutter('encoding stdout as osutils.get_user_encoding() %r',
 
555
                       output_encoding)
482
556
        else:
483
557
            output_encoding = input_encoding
484
 
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
558
            if trace:
 
559
                mutter('encoding stdout as sys.stdin encoding %r',
 
560
                       output_encoding)
485
561
    else:
486
 
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
562
        if trace:
 
563
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
487
564
    if output_encoding == 'cp0':
488
565
        # invalid encoding (cp0 means 'no codepage' on Windows)
489
566
        output_encoding = get_user_encoding()
490
 
        mutter('cp0 is invalid encoding.'
491
 
               ' encoding stdout as osutils.get_user_encoding() %r',
492
 
               output_encoding)
 
567
        if trace:
 
568
            mutter('cp0 is invalid encoding.'
 
569
                   ' encoding stdout as osutils.get_user_encoding() %r',
 
570
                   output_encoding)
493
571
    # check encoding
494
572
    try:
495
573
        codecs.lookup(output_encoding)
496
574
    except LookupError:
497
 
        sys.stderr.write('bzr: warning:'
 
575
        sys.stderr.write('brz: warning:'
498
576
                         ' unknown terminal encoding %s.\n'
499
577
                         '  Using encoding %s instead.\n'
500
578
                         % (output_encoding, get_user_encoding())
501
 
                        )
 
579
                         )
502
580
        output_encoding = get_user_encoding()
503
581
 
504
582
    return output_encoding
509
587
        F = realpath
510
588
    else:
511
589
        F = abspath
512
 
    [p,e] = os.path.split(f)
 
590
    [p, e] = os.path.split(f)
513
591
    if e == "" or e == "." or e == "..":
514
592
        return F(f)
515
593
    else:
519
597
def isdir(f):
520
598
    """True if f is an accessible directory."""
521
599
    try:
522
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
600
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
523
601
    except OSError:
524
602
        return False
525
603
 
527
605
def isfile(f):
528
606
    """True if f is a regular file."""
529
607
    try:
530
 
        return S_ISREG(os.lstat(f)[ST_MODE])
 
608
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
531
609
    except OSError:
532
610
        return False
533
611
 
 
612
 
534
613
def islink(f):
535
614
    """True if f is a symlink."""
536
615
    try:
537
 
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
616
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
538
617
    except OSError:
539
618
        return False
540
619
 
 
620
 
541
621
def is_inside(dir, fname):
542
622
    """True if fname is inside dir.
543
623
 
553
633
    if dir == fname:
554
634
        return True
555
635
 
556
 
    if dir == '':
 
636
    if dir in ('', b''):
557
637
        return True
558
638
 
559
 
    if dir[-1] != '/':
560
 
        dir += '/'
 
639
    if isinstance(dir, bytes):
 
640
        if not dir.endswith(b'/'):
 
641
            dir += b'/'
 
642
    else:
 
643
        if not dir.endswith('/'):
 
644
            dir += '/'
561
645
 
562
646
    return fname.startswith(dir)
563
647
 
636
720
    # writes fail on some platforms (e.g. Windows with SMB  mounted
637
721
    # drives).
638
722
    if not segment_size:
639
 
        segment_size = 5242880 # 5MB
640
 
    segments = range(len(bytes) / segment_size + 1)
 
723
        segment_size = 5242880  # 5MB
 
724
    offsets = range(0, len(bytes), segment_size)
 
725
    view = memoryview(bytes)
641
726
    write = file_handle.write
642
 
    for segment_index in segments:
643
 
        segment = buffer(bytes, segment_index * segment_size, segment_size)
644
 
        write(segment)
 
727
    for offset in offsets:
 
728
        write(view[offset:offset + segment_size])
645
729
 
646
730
 
647
731
def file_iterator(input_file, readsize=32768):
652
736
        yield b
653
737
 
654
738
 
 
739
# GZ 2017-09-16: Makes sense in general for hexdigest() result to be text, but
 
740
# used as bytes through most interfaces so encode with this wrapper.
 
741
if PY3:
 
742
    def _hexdigest(hashobj):
 
743
        return hashobj.hexdigest().encode()
 
744
else:
 
745
    def _hexdigest(hashobj):
 
746
        return hashobj.hexdigest()
 
747
 
 
748
 
655
749
def sha_file(f):
656
750
    """Calculate the hexdigest of an open file.
657
751
 
658
752
    The file cursor should be already at the start.
659
753
    """
660
754
    s = sha()
661
 
    BUFSIZE = 128<<10
 
755
    BUFSIZE = 128 << 10
662
756
    while True:
663
757
        b = f.read(BUFSIZE)
664
758
        if not b:
665
759
            break
666
760
        s.update(b)
667
 
    return s.hexdigest()
 
761
    return _hexdigest(s)
668
762
 
669
763
 
670
764
def size_sha_file(f):
675
769
    """
676
770
    size = 0
677
771
    s = sha()
678
 
    BUFSIZE = 128<<10
 
772
    BUFSIZE = 128 << 10
679
773
    while True:
680
774
        b = f.read(BUFSIZE)
681
775
        if not b:
682
776
            break
683
777
        size += len(b)
684
778
        s.update(b)
685
 
    return size, s.hexdigest()
 
779
    return size, _hexdigest(s)
686
780
 
687
781
 
688
782
def sha_file_by_name(fname):
691
785
    f = os.open(fname, os.O_RDONLY | O_BINARY | O_NOINHERIT)
692
786
    try:
693
787
        while True:
694
 
            b = os.read(f, 1<<16)
 
788
            b = os.read(f, 1 << 16)
695
789
            if not b:
696
 
                return s.hexdigest()
 
790
                return _hexdigest(s)
697
791
            s.update(b)
698
792
    finally:
699
793
        os.close(f)
702
796
def sha_strings(strings, _factory=sha):
703
797
    """Return the sha-1 of concatenation of strings"""
704
798
    s = _factory()
705
 
    map(s.update, strings)
706
 
    return s.hexdigest()
 
799
    for string in strings:
 
800
        s.update(string)
 
801
    return _hexdigest(s)
707
802
 
708
803
 
709
804
def sha_string(f, _factory=sha):
710
 
    return _factory(f).hexdigest()
 
805
    # GZ 2017-09-16: Dodgy if factory is ever not sha, probably shouldn't be.
 
806
    return _hexdigest(_factory(f))
711
807
 
712
808
 
713
809
def fingerprint_file(f):
714
810
    b = f.read()
715
811
    return {'size': len(b),
716
 
            'sha1': sha(b).hexdigest()}
 
812
            'sha1': _hexdigest(sha(b))}
717
813
 
718
814
 
719
815
def compare_files(a, b):
724
820
        bi = b.read(BUFSIZE)
725
821
        if ai != bi:
726
822
            return False
727
 
        if ai == '':
 
823
        if not ai:
728
824
            return True
729
825
 
730
826
 
735
831
    offset = datetime.fromtimestamp(t) - datetime.utcfromtimestamp(t)
736
832
    return offset.days * 86400 + offset.seconds
737
833
 
 
834
 
738
835
weekdays = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
739
836
_default_format_by_weekday_num = [wd + " %Y-%m-%d %H:%M:%S" for wd in weekdays]
740
837
 
752
849
    :param show_offset: Whether to append the timezone.
753
850
    """
754
851
    (date_fmt, tt, offset_str) = \
755
 
               _format_date(t, offset, timezone, date_fmt, show_offset)
 
852
        _format_date(t, offset, timezone, date_fmt, show_offset)
756
853
    date_fmt = date_fmt.replace('%a', weekdays[tt[6]])
757
854
    date_str = time.strftime(date_fmt, tt)
758
855
    return date_str + offset_str
763
860
 
764
861
 
765
862
def format_date_with_offset_in_original_timezone(t, offset=0,
766
 
    _cache=_offset_cache):
 
863
                                                 _cache=_offset_cache):
767
864
    """Return a formatted date string in the original timezone.
768
865
 
769
866
    This routine may be faster then format_date.
796
893
    :param show_offset: Whether to append the timezone.
797
894
    """
798
895
    (date_fmt, tt, offset_str) = \
799
 
               _format_date(t, offset, timezone, date_fmt, show_offset)
 
896
        _format_date(t, offset, timezone, date_fmt, show_offset)
800
897
    date_str = time.strftime(date_fmt, tt)
801
 
    if not isinstance(date_str, unicode):
 
898
    if not isinstance(date_str, text_type):
802
899
        date_str = date_str.decode(get_user_encoding(), 'replace')
803
900
    return date_str + offset_str
804
901
 
815
912
        tt = time.localtime(t)
816
913
        offset = local_time_offset(t)
817
914
    else:
818
 
        raise errors.UnsupportedTimezoneFormat(timezone)
 
915
        raise UnsupportedTimezoneFormat(timezone)
819
916
    if date_fmt is None:
820
917
        date_fmt = "%a %Y-%m-%d %H:%M:%S"
821
918
    if show_offset:
845
942
        delta = -delta
846
943
 
847
944
    seconds = delta
848
 
    if seconds < 90: # print seconds up to 90 seconds
 
945
    if seconds < 90:  # print seconds up to 90 seconds
849
946
        if seconds == 1:
850
947
            return '%d second %s' % (seconds, direction,)
851
948
        else:
857
954
        plural_seconds = ''
858
955
    else:
859
956
        plural_seconds = 's'
860
 
    if minutes < 90: # print minutes, seconds up to 90 minutes
 
957
    if minutes < 90:  # print minutes, seconds up to 90 minutes
861
958
        if minutes == 1:
862
959
            return '%d minute, %d second%s %s' % (
863
 
                    minutes, seconds, plural_seconds, direction)
 
960
                minutes, seconds, plural_seconds, direction)
864
961
        else:
865
962
            return '%d minutes, %d second%s %s' % (
866
 
                    minutes, seconds, plural_seconds, direction)
 
963
                minutes, seconds, plural_seconds, direction)
867
964
 
868
965
    hours = int(minutes / 60)
869
966
    minutes -= 60 * hours
878
975
    return '%d hours, %d minute%s %s' % (hours, minutes,
879
976
                                         plural_minutes, direction)
880
977
 
 
978
 
881
979
def filesize(f):
882
980
    """Return size of given open file."""
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
 
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":
895
991
    try:
896
 
        rand_bytes = file('/dev/urandom', 'rb').read
897
 
    # Otherwise, use this hack as a last resort
898
 
    except (IOError, OSError):
 
992
        rand_bytes(1)
 
993
    except NotImplementedError:
899
994
        # not well seeded, but better than nothing
900
995
        def rand_bytes(n):
901
996
            import random
907
1002
 
908
1003
 
909
1004
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
 
1005
 
 
1006
 
910
1007
def rand_chars(num):
911
1008
    """Return a random string of num alphanumeric characters
912
1009
 
915
1012
    """
916
1013
    s = ''
917
1014
    for raw_byte in rand_bytes(num):
918
 
        s += ALNUM[ord(raw_byte) % 36]
 
1015
        if not PY3:
 
1016
            s += ALNUM[ord(raw_byte) % 36]
 
1017
        else:
 
1018
            s += ALNUM[raw_byte % 36]
919
1019
    return s
920
1020
 
921
1021
 
922
 
## TODO: We could later have path objects that remember their list
923
 
## decomposition (might be too tricksy though.)
 
1022
# TODO: We could later have path objects that remember their list
 
1023
# decomposition (might be too tricksy though.)
924
1024
 
925
1025
def splitpath(p):
926
1026
    """Turn string into list of parts."""
927
 
    # split on either delimiter because people might use either on
928
 
    # Windows
929
 
    ps = re.split(r'[\\/]', p)
 
1027
    if os.path.sep == '\\':
 
1028
        # split on either delimiter because people might use either on
 
1029
        # Windows
 
1030
        if isinstance(p, bytes):
 
1031
            ps = re.split(b'[\\\\/]', p)
 
1032
        else:
 
1033
            ps = re.split(r'[\\/]', p)
 
1034
    else:
 
1035
        if isinstance(p, bytes):
 
1036
            ps = p.split(b'/')
 
1037
        else:
 
1038
            ps = p.split('/')
930
1039
 
931
1040
    rps = []
932
1041
    for f in ps:
933
 
        if f == '..':
934
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
935
 
        elif (f == '.') or (f == ''):
 
1042
        if f in ('..', b'..'):
 
1043
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
 
1044
        elif f in ('.', '', b'.', b''):
936
1045
            pass
937
1046
        else:
938
1047
            rps.append(f)
942
1051
def joinpath(p):
943
1052
    for f in p:
944
1053
        if (f == '..') or (f is None) or (f == ''):
945
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1054
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
946
1055
    return pathjoin(*p)
947
1056
 
948
1057
 
949
1058
def parent_directories(filename):
950
1059
    """Return the list of parent directories, deepest first.
951
 
    
 
1060
 
952
1061
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
953
1062
    """
954
1063
    parents = []
970
1079
    implementation should be loaded instead::
971
1080
 
972
1081
    >>> try:
973
 
    >>>     import bzrlib._fictional_extension_pyx
 
1082
    >>>     import breezy._fictional_extension_pyx
974
1083
    >>> except ImportError, e:
975
 
    >>>     bzrlib.osutils.failed_to_load_extension(e)
976
 
    >>>     import bzrlib._fictional_extension_py
 
1084
    >>>     breezy.osutils.failed_to_load_extension(e)
 
1085
    >>>     import breezy._fictional_extension_py
977
1086
    """
978
1087
    # NB: This docstring is just an example, not a doctest, because doctest
979
1088
    # currently can't cope with the use of lazy imports in this namespace --
980
1089
    # mbp 20090729
981
 
    
 
1090
 
982
1091
    # This currently doesn't report the failure at the time it occurs, because
983
1092
    # they tend to happen very early in startup when we can't check config
984
1093
    # files etc, and also we want to report all failures but not spam the user
985
1094
    # with 10 warnings.
986
 
    from bzrlib import trace
987
1095
    exception_str = str(exception)
988
1096
    if exception_str not in _extension_load_failures:
989
1097
        trace.mutter("failed to load compiled extension: %s" % exception_str)
993
1101
def report_extension_load_failures():
994
1102
    if not _extension_load_failures:
995
1103
        return
996
 
    from bzrlib.config import GlobalConfig
997
 
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
 
1104
    if config.GlobalConfig().suppress_warning('missing_extensions'):
998
1105
        return
999
1106
    # the warnings framework should by default show this only once
1000
 
    from bzrlib.trace import warning
 
1107
    from .trace import warning
1001
1108
    warning(
1002
 
        "bzr: warning: some compiled extensions could not be loaded; "
1003
 
        "see <https://answers.launchpad.net/bzr/+faq/703>")
 
1109
        "brz: warning: some compiled extensions could not be loaded; "
 
1110
        "see ``brz help missing-extensions``")
1004
1111
    # we no longer show the specific missing extensions here, because it makes
1005
1112
    # the message too long and scary - see
1006
1113
    # https://bugs.launchpad.net/bzr/+bug/430529
1007
1114
 
1008
1115
 
1009
1116
try:
1010
 
    from bzrlib._chunks_to_lines_pyx import chunks_to_lines
1011
 
except ImportError, e:
 
1117
    from ._chunks_to_lines_pyx import chunks_to_lines
 
1118
except ImportError as e:
1012
1119
    failed_to_load_extension(e)
1013
 
    from bzrlib._chunks_to_lines_py import chunks_to_lines
 
1120
    from ._chunks_to_lines_py import chunks_to_lines
1014
1121
 
1015
1122
 
1016
1123
def split_lines(s):
1017
1124
    """Split s into lines, but without removing the newline characters."""
1018
1125
    # Trivially convert a fulltext into a 'chunked' representation, and let
1019
1126
    # chunks_to_lines do the heavy lifting.
1020
 
    if isinstance(s, str):
 
1127
    if isinstance(s, bytes):
1021
1128
        # chunks_to_lines only supports 8-bit strings
1022
1129
        return chunks_to_lines([s])
1023
1130
    else:
1029
1136
 
1030
1137
    This supports Unicode or plain string objects.
1031
1138
    """
1032
 
    lines = s.split('\n')
1033
 
    result = [line + '\n' for line in lines[:-1]]
 
1139
    nl = b'\n' if isinstance(s, bytes) else u'\n'
 
1140
    lines = s.split(nl)
 
1141
    result = [line + nl for line in lines[:-1]]
1034
1142
    if lines[-1]:
1035
1143
        result.append(lines[-1])
1036
1144
    return result
1047
1155
        return
1048
1156
    try:
1049
1157
        os.link(src, dest)
1050
 
    except (OSError, IOError), e:
 
1158
    except (OSError, IOError) as e:
1051
1159
        if e.errno != errno.EXDEV:
1052
1160
            raise
1053
1161
        shutil.copyfile(src, dest)
1054
1162
 
1055
1163
 
1056
1164
def delete_any(path):
1057
 
    """Delete a file, symlink or directory.  
1058
 
    
 
1165
    """Delete a file, symlink or directory.
 
1166
 
1059
1167
    Will delete even if readonly.
1060
1168
    """
1061
1169
    try:
1062
 
       _delete_file_or_dir(path)
1063
 
    except (OSError, IOError), e:
 
1170
        _delete_file_or_dir(path)
 
1171
    except (OSError, IOError) as e:
1064
1172
        if e.errno in (errno.EPERM, errno.EACCES):
1065
1173
            # make writable and try again
1066
1174
            try:
1078
1186
    # - root can damage a solaris file system by using unlink,
1079
1187
    # - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
1080
1188
    #   EACCES, OSX: EPERM) when invoked on a directory.
1081
 
    if isdir(path): # Takes care of symlinks
 
1189
    if isdir(path):  # Takes care of symlinks
1082
1190
        os.rmdir(path)
1083
1191
    else:
1084
1192
        os.unlink(path)
1126
1234
    #    separators
1127
1235
    # 3) '\xa0' isn't unicode safe since it is >128.
1128
1236
 
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':
 
1237
    if isinstance(s, str):
 
1238
        ws = ' \t\n\r\v\f'
 
1239
    else:
 
1240
        ws = (b' ', b'\t', b'\n', b'\r', b'\v', b'\f')
 
1241
    for ch in ws:
1134
1242
        if ch in s:
1135
1243
            return True
1136
1244
    else:
1162
1270
 
1163
1271
    if len(base) < MIN_ABS_PATHLENGTH:
1164
1272
        # must have space for e.g. a drive letter
1165
 
        raise ValueError('%r is too short to calculate a relative path'
1166
 
            % (base,))
 
1273
        raise ValueError(gettext('%r is too short to calculate a relative path')
 
1274
                         % (base,))
1167
1275
 
1168
1276
    rp = abspath(path)
1169
1277
 
1214
1322
        lbit = bit.lower()
1215
1323
        try:
1216
1324
            next_entries = _listdir(current)
1217
 
        except OSError: # enoent, eperm, etc
 
1325
        except OSError:  # enoent, eperm, etc
1218
1326
            # We can't find this in the filesystem, so just append the
1219
1327
            # remaining bits.
1220
1328
            current = pathjoin(current, bit, *list(bit_iter))
1231
1339
            break
1232
1340
    return current[len(abs_base):].lstrip('/')
1233
1341
 
 
1342
 
1234
1343
# XXX - TODO - we need better detection/integration of case-insensitive
1235
1344
# file-systems; Linux often sees FAT32 devices (or NFS-mounted OSX
1236
1345
# filesystems), for example, so could probably benefit from the same basic
1241
1350
else:
1242
1351
    canonical_relpath = relpath
1243
1352
 
 
1353
 
1244
1354
def canonical_relpaths(base, paths):
1245
1355
    """Create an iterable to canonicalize a sequence of relative paths.
1246
1356
 
1250
1360
    # but for now, we haven't optimized...
1251
1361
    return [canonical_relpath(base, p) for p in paths]
1252
1362
 
 
1363
 
 
1364
def decode_filename(filename):
 
1365
    """Decode the filename using the filesystem encoding
 
1366
 
 
1367
    If it is unicode, it is returned.
 
1368
    Otherwise it is decoded from the the filesystem's encoding. If decoding
 
1369
    fails, a errors.BadFilenameEncoding exception is raised.
 
1370
    """
 
1371
    if isinstance(filename, text_type):
 
1372
        return filename
 
1373
    try:
 
1374
        return filename.decode(_fs_enc)
 
1375
    except UnicodeDecodeError:
 
1376
        raise errors.BadFilenameEncoding(filename, _fs_enc)
 
1377
 
 
1378
 
1253
1379
def safe_unicode(unicode_or_utf8_string):
1254
1380
    """Coerce unicode_or_utf8_string into unicode.
1255
1381
 
1257
1383
    Otherwise it is decoded from utf-8. If decoding fails, the exception is
1258
1384
    wrapped in a BzrBadParameterNotUnicode exception.
1259
1385
    """
1260
 
    if isinstance(unicode_or_utf8_string, unicode):
 
1386
    if isinstance(unicode_or_utf8_string, text_type):
1261
1387
        return unicode_or_utf8_string
1262
1388
    try:
1263
1389
        return unicode_or_utf8_string.decode('utf8')
1271
1397
    If it is a str, it is returned.
1272
1398
    If it is Unicode, it is encoded into a utf-8 string.
1273
1399
    """
1274
 
    if isinstance(unicode_or_utf8_string, str):
 
1400
    if isinstance(unicode_or_utf8_string, bytes):
1275
1401
        # TODO: jam 20070209 This is overkill, and probably has an impact on
1276
1402
        #       performance if we are dealing with lots of apis that want a
1277
1403
        #       utf-8 revision id
1284
1410
    return unicode_or_utf8_string.encode('utf-8')
1285
1411
 
1286
1412
 
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):
 
1413
def safe_revision_id(unicode_or_utf8_string):
1293
1414
    """Revision ids should now be utf8, but at one point they were unicode.
1294
1415
 
1295
1416
    :param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
1296
1417
        utf8 or None).
1297
 
    :param warn: Functions that are sanitizing user data can set warn=False
1298
1418
    :return: None or a utf8 revision id.
1299
1419
    """
1300
1420
    if (unicode_or_utf8_string is None
1301
 
        or unicode_or_utf8_string.__class__ == str):
 
1421
            or unicode_or_utf8_string.__class__ == bytes):
1302
1422
        return 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
    raise TypeError('Unicode revision ids are no longer supported. '
 
1424
                    'Revision id generators should be creating utf8 revision '
 
1425
                    'ids.')
 
1426
 
 
1427
 
 
1428
def safe_file_id(unicode_or_utf8_string):
1314
1429
    """File ids should now be utf8, but at one point they were unicode.
1315
1430
 
1316
1431
    This is the same as safe_utf8, except it uses the cached encode functions
1318
1433
 
1319
1434
    :param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
1320
1435
        utf8 or None).
1321
 
    :param warn: Functions that are sanitizing user data can set warn=False
1322
1436
    :return: None or a utf8 file id.
1323
1437
    """
1324
1438
    if (unicode_or_utf8_string is None
1325
 
        or unicode_or_utf8_string.__class__ == str):
 
1439
            or unicode_or_utf8_string.__class__ == bytes):
1326
1440
        return unicode_or_utf8_string
1327
 
    if warn:
1328
 
        symbol_versioning.warn(_file_id_warning, DeprecationWarning,
1329
 
                               stacklevel=2)
1330
 
    return cache_utf8.encode(unicode_or_utf8_string)
 
1441
    raise TypeError('Unicode file ids are no longer supported. '
 
1442
                    'File id generators should be creating utf8 file ids.')
1331
1443
 
1332
1444
 
1333
1445
_platform_normalizes_filenames = False
1338
1450
def normalizes_filenames():
1339
1451
    """Return True if this platform normalizes unicode filenames.
1340
1452
 
1341
 
    Mac OSX does, Windows/Linux do not.
 
1453
    Only Mac OSX.
1342
1454
    """
1343
1455
    return _platform_normalizes_filenames
1344
1456
 
1349
1461
    On platforms where the system normalizes filenames (Mac OSX),
1350
1462
    you can access a file by any path which will normalize correctly.
1351
1463
    On platforms where the system does not normalize filenames
1352
 
    (Windows, Linux), you have to access a file by its exact path.
 
1464
    (everything else), you have to access a file by its exact path.
1353
1465
 
1354
1466
    Internally, bzr only supports NFC normalization, since that is
1355
1467
    the standard for XML documents.
1358
1470
    can be accessed by that path.
1359
1471
    """
1360
1472
 
1361
 
    return unicodedata.normalize('NFC', unicode(path)), True
 
1473
    if isinstance(path, bytes):
 
1474
        path = path.decode(sys.getfilesystemencoding())
 
1475
    return unicodedata.normalize('NFC', path), True
1362
1476
 
1363
1477
 
1364
1478
def _inaccessible_normalized_filename(path):
1365
1479
    __doc__ = _accessible_normalized_filename.__doc__
1366
1480
 
1367
 
    normalized = unicodedata.normalize('NFC', unicode(path))
 
1481
    if isinstance(path, bytes):
 
1482
        path = path.decode(sys.getfilesystemencoding())
 
1483
    normalized = unicodedata.normalize('NFC', path)
1368
1484
    return normalized, normalized == path
1369
1485
 
1370
1486
 
1393
1509
    except AttributeError:
1394
1510
        # siginterrupt doesn't exist on this platform, or for this version
1395
1511
        # of Python.
1396
 
        siginterrupt = lambda signum, flag: None
 
1512
        def siginterrupt(signum, flag): return None
1397
1513
    if restart_syscall:
1398
1514
        def sig_handler(*args):
1399
1515
            # Python resets the siginterrupt flag when a signal is
1417
1533
terminal_width() returns None.
1418
1534
"""
1419
1535
 
 
1536
# Keep some state so that terminal_width can detect if _terminal_size has
 
1537
# returned a different size since the process started.  See docstring and
 
1538
# comments of terminal_width for details.
 
1539
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
 
1540
_terminal_size_state = 'no_data'
 
1541
_first_terminal_size = None
 
1542
 
1420
1543
 
1421
1544
def terminal_width():
1422
1545
    """Return terminal width.
1424
1547
    None is returned if the width can't established precisely.
1425
1548
 
1426
1549
    The rules are:
1427
 
    - if BZR_COLUMNS is set, returns its value
 
1550
    - if BRZ_COLUMNS is set, returns its value
1428
1551
    - if there is no controlling terminal, returns None
 
1552
    - query the OS, if the queried size has changed since the last query,
 
1553
      return its value,
1429
1554
    - if COLUMNS is set, returns its value,
 
1555
    - if the OS has a value (even though it's never changed), return its value.
1430
1556
 
1431
1557
    From there, we need to query the OS to get the size of the controlling
1432
1558
    terminal.
1433
1559
 
1434
 
    Unices:
 
1560
    On Unices we query the OS by:
1435
1561
    - get termios.TIOCGWINSZ
1436
1562
    - if an error occurs or a negative value is obtained, returns None
1437
1563
 
1438
 
    Windows:
1439
 
    
 
1564
    On Windows we query the OS by:
1440
1565
    - win32utils.get_console_size() decides,
1441
1566
    - returns None on error (provided default value)
1442
1567
    """
 
1568
    # Note to implementors: if changing the rules for determining the width,
 
1569
    # make sure you've considered the behaviour in these cases:
 
1570
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
 
1571
    #  - brz log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
 
1572
    #    0,0.
 
1573
    #  - (add more interesting cases here, if you find any)
 
1574
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
 
1575
    # but we don't want to register a signal handler because it is impossible
 
1576
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
 
1577
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
 
1578
    # time so we can notice if the reported size has changed, which should have
 
1579
    # a similar effect.
1443
1580
 
1444
 
    # If BZR_COLUMNS is set, take it, user is always right
 
1581
    # If BRZ_COLUMNS is set, take it, user is always right
 
1582
    # Except if they specified 0 in which case, impose no limit here
1445
1583
    try:
1446
 
        return int(os.environ['BZR_COLUMNS'])
 
1584
        width = int(os.environ['BRZ_COLUMNS'])
1447
1585
    except (KeyError, ValueError):
1448
 
        pass
 
1586
        width = None
 
1587
    if width is not None:
 
1588
        if width > 0:
 
1589
            return width
 
1590
        else:
 
1591
            return None
1449
1592
 
1450
1593
    isatty = getattr(sys.stdout, 'isatty', None)
1451
 
    if  isatty is None or not isatty():
1452
 
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
 
1594
    if isatty is None or not isatty():
 
1595
        # Don't guess, setting BRZ_COLUMNS is the recommended way to override.
1453
1596
        return None
1454
1597
 
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))
 
1598
    # Query the OS
 
1599
    width, height = os_size = _terminal_size(None, None)
 
1600
    global _first_terminal_size, _terminal_size_state
 
1601
    if _terminal_size_state == 'no_data':
 
1602
        _first_terminal_size = os_size
 
1603
        _terminal_size_state = 'unchanged'
 
1604
    elif (_terminal_size_state == 'unchanged' and
 
1605
          _first_terminal_size != os_size):
 
1606
        _terminal_size_state = 'changed'
 
1607
 
 
1608
    # If the OS claims to know how wide the terminal is, and this value has
 
1609
    # ever changed, use that.
 
1610
    if _terminal_size_state == 'changed':
 
1611
        if width is not None and width > 0:
 
1612
            return width
 
1613
 
 
1614
    # If COLUMNS is set, use it.
1458
1615
    try:
1459
1616
        return int(os.environ['COLUMNS'])
1460
1617
    except (KeyError, ValueError):
1461
1618
        pass
1462
1619
 
1463
 
    width, height = _terminal_size(None, None)
1464
 
    if width <= 0:
1465
 
        # Consider invalid values as meaning no width
1466
 
        return None
 
1620
    # Finally, use an unchanged size from the OS, if we have one.
 
1621
    if _terminal_size_state == 'unchanged':
 
1622
        if width is not None and width > 0:
 
1623
            return width
1467
1624
 
1468
 
    return width
 
1625
    # The width could not be determined.
 
1626
    return None
1469
1627
 
1470
1628
 
1471
1629
def _win32_terminal_size(width, height):
1472
 
    width, height = win32utils.get_console_size(defaultx=width, defaulty=height)
 
1630
    width, height = win32utils.get_console_size(
 
1631
        defaultx=width, defaulty=height)
1473
1632
    return width, height
1474
1633
 
1475
1634
 
1476
1635
def _ioctl_terminal_size(width, height):
1477
1636
    try:
1478
 
        import struct, fcntl, termios
 
1637
        import struct
 
1638
        import fcntl
 
1639
        import termios
1479
1640
        s = struct.pack('HHHH', 0, 0, 0, 0)
1480
1641
        x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1481
1642
        height, width = struct.unpack('HHHH', x)[0:2]
1483
1644
        pass
1484
1645
    return width, height
1485
1646
 
 
1647
 
1486
1648
_terminal_size = None
1487
1649
"""Returns the terminal size as (width, height).
1488
1650
 
1498
1660
    _terminal_size = _ioctl_terminal_size
1499
1661
 
1500
1662
 
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
 
 
1526
1663
def supports_executable():
1527
1664
    return sys.platform != "win32"
1528
1665
 
1553
1690
        if orig_val is not None:
1554
1691
            del os.environ[env_variable]
1555
1692
    else:
1556
 
        if isinstance(value, unicode):
 
1693
        if not PY3 and isinstance(value, text_type):
1557
1694
            value = value.encode(get_user_encoding())
1558
1695
        os.environ[env_variable] = value
1559
1696
    return orig_val
1573
1710
        raise errors.IllegalPath(path)
1574
1711
 
1575
1712
 
1576
 
_WIN32_ERROR_DIRECTORY = 267 # Similar to errno.ENOTDIR
 
1713
_WIN32_ERROR_DIRECTORY = 267  # Similar to errno.ENOTDIR
 
1714
 
1577
1715
 
1578
1716
def _is_error_enotdir(e):
1579
1717
    """Check if this exception represents ENOTDIR.
1591
1729
    :return: True if this represents an ENOTDIR error. False otherwise.
1592
1730
    """
1593
1731
    en = getattr(e, 'errno', None)
1594
 
    if (en == errno.ENOTDIR
1595
 
        or (sys.platform == 'win32'
1596
 
            and (en == _WIN32_ERROR_DIRECTORY
1597
 
                 or (en == errno.EINVAL
1598
 
                     and getattr(e, 'winerror', None) == _WIN32_ERROR_DIRECTORY)
1599
 
        ))):
 
1732
    if (en == errno.ENOTDIR or
 
1733
        (sys.platform == 'win32' and
 
1734
            (en == _WIN32_ERROR_DIRECTORY or
 
1735
             (en == errno.EINVAL
 
1736
              and getattr(e, 'winerror', None) == _WIN32_ERROR_DIRECTORY)
 
1737
             ))):
1600
1738
        return True
1601
1739
    return False
1602
1740
 
1629
1767
        rooted higher up.
1630
1768
    :return: an iterator over the dirs.
1631
1769
    """
1632
 
    #TODO there is a bit of a smell where the results of the directory-
 
1770
    # TODO there is a bit of a smell where the results of the directory-
1633
1771
    # summary in this, and the path from the root, may not agree
1634
1772
    # depending on top and prefix - i.e. ./foo and foo as a pair leads to
1635
1773
    # potentially confusing output. We should make this more robust - but
1651
1789
        dirblock = []
1652
1790
        append = dirblock.append
1653
1791
        try:
1654
 
            names = sorted(_listdir(top))
1655
 
        except OSError, e:
 
1792
            names = sorted(map(decode_filename, _listdir(top)))
 
1793
        except OSError as e:
1656
1794
            if not _is_error_enotdir(e):
1657
1795
                raise
1658
1796
        else:
1711
1849
    """
1712
1850
    global _selected_dir_reader
1713
1851
    if _selected_dir_reader is None:
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.
 
1852
        if sys.platform == "win32":
1721
1853
            try:
1722
 
                from bzrlib._walkdirs_win32 import Win32ReadDir
 
1854
                from ._walkdirs_win32 import Win32ReadDir
1723
1855
                _selected_dir_reader = Win32ReadDir()
1724
1856
            except ImportError:
1725
1857
                pass
1726
 
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1727
 
            # ANSI_X3.4-1968 is a form of ASCII
 
1858
        elif _fs_enc in ('utf-8', 'ascii'):
1728
1859
            try:
1729
 
                from bzrlib._readdir_pyx import UTF8DirReader
 
1860
                from ._readdir_pyx import UTF8DirReader
1730
1861
                _selected_dir_reader = UTF8DirReader()
1731
 
            except ImportError, e:
 
1862
            except ImportError as e:
1732
1863
                failed_to_load_extension(e)
1733
1864
                pass
1734
1865
 
1779
1910
        See DirReader.read_dir for details.
1780
1911
        """
1781
1912
        _utf8_encode = self._utf8_encode
 
1913
 
 
1914
        def _fs_decode(s): return s.decode(_fs_enc)
 
1915
 
 
1916
        def _fs_encode(s): return s.encode(_fs_enc)
1782
1917
        _lstat = os.lstat
1783
1918
        _listdir = os.listdir
1784
1919
        _kind_from_mode = file_kind_from_stat_mode
1785
1920
 
1786
1921
        if prefix:
1787
 
            relprefix = prefix + '/'
 
1922
            relprefix = prefix + b'/'
1788
1923
        else:
1789
 
            relprefix = ''
1790
 
        top_slash = top + u'/'
 
1924
            relprefix = b''
 
1925
        top_slash = top + '/'
1791
1926
 
1792
1927
        dirblock = []
1793
1928
        append = dirblock.append
1794
 
        for name in sorted(_listdir(top)):
 
1929
        for name_native in _listdir(top.encode('utf-8')):
1795
1930
            try:
1796
 
                name_utf8 = _utf8_encode(name)[0]
 
1931
                name = _fs_decode(name_native)
1797
1932
            except UnicodeDecodeError:
1798
1933
                raise errors.BadFilenameEncoding(
1799
 
                    _utf8_encode(relprefix)[0] + name, _fs_enc)
 
1934
                    relprefix + name_native, _fs_enc)
 
1935
            name_utf8 = _utf8_encode(name)[0]
1800
1936
            abspath = top_slash + name
1801
1937
            statvalue = _lstat(abspath)
1802
1938
            kind = _kind_from_mode(statvalue.st_mode)
1803
1939
            append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
1804
 
        return dirblock
 
1940
        return sorted(dirblock)
1805
1941
 
1806
1942
 
1807
1943
def copy_tree(from_path, to_path, handlers={}):
1832
1968
        link_to = os.readlink(source)
1833
1969
        os.symlink(link_to, dest)
1834
1970
 
1835
 
    real_handlers = {'file':shutil.copy2,
1836
 
                     'symlink':copy_link,
1837
 
                     'directory':copy_dir,
1838
 
                    }
 
1971
    real_handlers = {'file': shutil.copy2,
 
1972
                     'symlink': copy_link,
 
1973
                     'directory': copy_dir,
 
1974
                     }
1839
1975
    real_handlers.update(handlers)
1840
1976
 
1841
1977
    if not os.path.exists(to_path):
1856
1992
    if chown is None:
1857
1993
        return
1858
1994
 
1859
 
    if src == None:
 
1995
    if src is None:
1860
1996
        src = os.path.dirname(dst)
1861
1997
        if src == '':
1862
1998
            src = '.'
1864
2000
    try:
1865
2001
        s = os.stat(src)
1866
2002
        chown(dst, s.st_uid, s.st_gid)
1867
 
    except OSError, e:
1868
 
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
 
2003
    except OSError:
 
2004
        trace.warning(
 
2005
            'Unable to copy ownership from "%s" to "%s". '
 
2006
            'You may want to set it manually.', src, dst)
 
2007
        trace.log_exception_quietly()
1869
2008
 
1870
2009
 
1871
2010
def path_prefix_key(path):
1873
2012
 
1874
2013
    This can be used to sort paths in the same way that walkdirs does.
1875
2014
    """
1876
 
    return (dirname(path) , path)
 
2015
    return (dirname(path), path)
1877
2016
 
1878
2017
 
1879
2018
def compare_paths_prefix_order(path_a, path_b):
1880
2019
    """Compare path_a and path_b to generate the same order walkdirs uses."""
1881
2020
    key_a = path_prefix_key(path_a)
1882
2021
    key_b = path_prefix_key(path_b)
1883
 
    return cmp(key_a, key_b)
 
2022
    return (key_a > key_b) - (key_a < key_b)
1884
2023
 
1885
2024
 
1886
2025
_cached_user_encoding = None
1887
2026
 
1888
2027
 
1889
 
def get_user_encoding(use_cache=True):
 
2028
def get_user_encoding():
1890
2029
    """Find out what the preferred user encoding is.
1891
2030
 
1892
2031
    This is generally the encoding that is used for command line parameters
1893
2032
    and file contents. This may be different from the terminal encoding
1894
2033
    or the filesystem encoding.
1895
2034
 
1896
 
    :param  use_cache:  Enable cache for detected encoding.
1897
 
                        (This parameter is turned on by default,
1898
 
                        and required only for selftesting)
1899
 
 
1900
2035
    :return: A string defining the preferred user encoding
1901
2036
    """
1902
2037
    global _cached_user_encoding
1903
 
    if _cached_user_encoding is not None and use_cache:
 
2038
    if _cached_user_encoding is not None:
1904
2039
        return _cached_user_encoding
1905
2040
 
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'
 
2041
    if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
 
2042
        # Use the existing locale settings and call nl_langinfo directly
 
2043
        # rather than going through getpreferredencoding. This avoids
 
2044
        # <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
 
2045
        # possibility of the setlocale call throwing an error.
 
2046
        user_encoding = locale.nl_langinfo(locale.CODESET)
1923
2047
    else:
1924
 
        import locale
 
2048
        # GZ 2011-12-19: On windows could call GetACP directly instead.
 
2049
        user_encoding = locale.getpreferredencoding(False)
1925
2050
 
1926
2051
    try:
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:'
 
2052
        user_encoding = codecs.lookup(user_encoding).name
 
2053
    except LookupError:
 
2054
        if user_encoding not in ("", "cp0"):
 
2055
            sys.stderr.write('brz: warning:'
1950
2056
                             ' unknown encoding %s.'
1951
2057
                             ' Continuing with ascii encoding.\n'
1952
2058
                             % user_encoding
1953
 
                            )
1954
 
            user_encoding = 'ascii'
1955
 
 
1956
 
    if use_cache:
1957
 
        _cached_user_encoding = user_encoding
1958
 
 
 
2059
                             )
 
2060
        user_encoding = 'ascii'
 
2061
    else:
 
2062
        # Get 'ascii' when setlocale has not been called or LANG=C or unset.
 
2063
        if user_encoding == 'ascii':
 
2064
            if sys.platform == 'darwin':
 
2065
                # OSX is special-cased in Python to have a UTF-8 filesystem
 
2066
                # encoding and previously had LANG set here if not present.
 
2067
                user_encoding = 'utf-8'
 
2068
            # GZ 2011-12-19: Maybe UTF-8 should be the default in this case
 
2069
            #                for some other posix platforms as well.
 
2070
 
 
2071
    _cached_user_encoding = user_encoding
1959
2072
    return user_encoding
1960
2073
 
1961
2074
 
 
2075
def get_diff_header_encoding():
 
2076
    return get_terminal_encoding()
 
2077
 
 
2078
 
1962
2079
def get_host_name():
1963
2080
    """Return the current unicode host name.
1964
2081
 
1966
2083
    behaves inconsistently on different platforms.
1967
2084
    """
1968
2085
    if sys.platform == "win32":
1969
 
        import win32utils
1970
2086
        return win32utils.get_host_name()
1971
2087
    else:
1972
2088
        import socket
 
2089
        if PY3:
 
2090
            return socket.gethostname()
1973
2091
        return socket.gethostname().decode(get_user_encoding())
1974
2092
 
1975
2093
 
1979
2097
# data at once.
1980
2098
MAX_SOCKET_CHUNK = 64 * 1024
1981
2099
 
 
2100
_end_of_stream_errors = [errno.ECONNRESET, errno.EPIPE, errno.EINVAL]
 
2101
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
 
2102
    _eno = getattr(errno, _eno, None)
 
2103
    if _eno is not None:
 
2104
        _end_of_stream_errors.append(_eno)
 
2105
del _eno
 
2106
 
 
2107
 
1982
2108
def read_bytes_from_socket(sock, report_activity=None,
1983
 
        max_read_size=MAX_SOCKET_CHUNK):
 
2109
                           max_read_size=MAX_SOCKET_CHUNK):
1984
2110
    """Read up to max_read_size of bytes from sock and notify of progress.
1985
2111
 
1986
2112
    Translates "Connection reset by peer" into file-like EOF (return an
1987
2113
    empty string rather than raise an error), and repeats the recv if
1988
2114
    interrupted by a signal.
1989
2115
    """
1990
 
    while 1:
 
2116
    while True:
1991
2117
        try:
1992
 
            bytes = sock.recv(max_read_size)
1993
 
        except socket.error, e:
 
2118
            data = sock.recv(max_read_size)
 
2119
        except socket.error as e:
1994
2120
            eno = e.args[0]
1995
 
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
 
2121
            if eno in _end_of_stream_errors:
1996
2122
                # The connection was closed by the other side.  Callers expect
1997
2123
                # an empty string to signal end-of-stream.
1998
 
                return ""
 
2124
                return b""
1999
2125
            elif eno == errno.EINTR:
2000
2126
                # Retry the interrupted recv.
2001
2127
                continue
2002
2128
            raise
2003
2129
        else:
2004
2130
            if report_activity is not None:
2005
 
                report_activity(len(bytes), 'read')
2006
 
            return bytes
 
2131
                report_activity(len(data), 'read')
 
2132
            return data
2007
2133
 
2008
2134
 
2009
2135
def recv_all(socket, count):
2016
2142
 
2017
2143
    This isn't optimized and is intended mostly for use in testing.
2018
2144
    """
2019
 
    b = ''
 
2145
    b = b''
2020
2146
    while len(b) < count:
2021
2147
        new = read_bytes_from_socket(socket, None, count - len(b))
2022
 
        if new == '':
2023
 
            break # eof
 
2148
        if new == b'':
 
2149
            break  # eof
2024
2150
        b += new
2025
2151
    return b
2026
2152
 
2027
2153
 
2028
2154
def send_all(sock, bytes, report_activity=None):
2029
2155
    """Send all bytes on a socket.
2030
 
 
 
2156
 
2031
2157
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2032
2158
    some platforms, and catches EINTR which may be thrown if the send is
2033
2159
    interrupted by a signal.
2034
2160
 
2035
2161
    This is preferred to socket.sendall(), because it avoids portability bugs
2036
2162
    and provides activity reporting.
2037
 
 
 
2163
 
2038
2164
    :param report_activity: Call this as bytes are read, see
2039
2165
        Transport._report_activity
2040
2166
    """
2041
2167
    sent_total = 0
2042
2168
    byte_count = len(bytes)
 
2169
    view = memoryview(bytes)
2043
2170
    while sent_total < byte_count:
2044
2171
        try:
2045
 
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2046
 
        except socket.error, e:
 
2172
            sent = sock.send(view[sent_total:sent_total + MAX_SOCKET_CHUNK])
 
2173
        except (socket.error, IOError) as e:
 
2174
            if e.args[0] in _end_of_stream_errors:
 
2175
                raise errors.ConnectionReset(
 
2176
                    "Error trying to write to socket", e)
2047
2177
            if e.args[0] != errno.EINTR:
2048
2178
                raise
2049
2179
        else:
 
2180
            if sent == 0:
 
2181
                raise errors.ConnectionReset('Sending to %s returned 0 bytes'
 
2182
                                             % (sock,))
2050
2183
            sent_total += sent
2051
 
            report_activity(sent, 'write')
 
2184
            if report_activity is not None:
 
2185
                report_activity(sent, 'write')
 
2186
 
 
2187
 
 
2188
def connect_socket(address):
 
2189
    # Slight variation of the socket.create_connection() function (provided by
 
2190
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
 
2191
    # provide it for previous python versions. Also, we don't use the timeout
 
2192
    # parameter (provided by the python implementation) so we don't implement
 
2193
    # it either).
 
2194
    err = socket.error('getaddrinfo returns an empty list')
 
2195
    host, port = address
 
2196
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
 
2197
        af, socktype, proto, canonname, sa = res
 
2198
        sock = None
 
2199
        try:
 
2200
            sock = socket.socket(af, socktype, proto)
 
2201
            sock.connect(sa)
 
2202
            return sock
 
2203
 
 
2204
        except socket.error as e:
 
2205
            err = e
 
2206
            # 'err' is now the most recent error
 
2207
            if sock is not None:
 
2208
                sock.close()
 
2209
    raise err
2052
2210
 
2053
2211
 
2054
2212
def dereference_path(path):
2073
2231
def resource_string(package, resource_name):
2074
2232
    """Load a resource from a package and return it as a string.
2075
2233
 
2076
 
    Note: Only packages that start with bzrlib are currently supported.
 
2234
    Note: Only packages that start with breezy are currently supported.
2077
2235
 
2078
2236
    This is designed to be a lightweight implementation of resource
2079
2237
    loading in a way which is API compatible with the same API from
2082
2240
    If and when pkg_resources becomes a standard library, this routine
2083
2241
    can delegate to it.
2084
2242
    """
2085
 
    # Check package name is within bzrlib
2086
 
    if package == "bzrlib":
 
2243
    # Check package name is within breezy
 
2244
    if package == "breezy":
2087
2245
        resource_relpath = resource_name
2088
 
    elif package.startswith("bzrlib."):
2089
 
        package = package[len("bzrlib."):].replace('.', os.sep)
 
2246
    elif package.startswith("breezy."):
 
2247
        package = package[len("breezy."):].replace('.', os.sep)
2090
2248
        resource_relpath = pathjoin(package, resource_name)
2091
2249
    else:
2092
 
        raise errors.BzrError('resource package %s not in bzrlib' % package)
 
2250
        raise errors.BzrError('resource package %s not in breezy' % package)
2093
2251
 
2094
2252
    # Map the resource to a file and read its contents
2095
 
    base = dirname(bzrlib.__file__)
 
2253
    base = dirname(breezy.__file__)
2096
2254
    if getattr(sys, 'frozen', None):    # bzr.exe
2097
2255
        base = abspath(pathjoin(base, '..', '..'))
2098
 
    filename = pathjoin(base, resource_relpath)
2099
 
    return open(filename, 'rU').read()
 
2256
    with open(pathjoin(base, resource_relpath), "rt") as f:
 
2257
        return f.read()
2100
2258
 
2101
2259
 
2102
2260
def file_kind_from_stat_mode_thunk(mode):
2103
2261
    global file_kind_from_stat_mode
2104
2262
    if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
2105
2263
        try:
2106
 
            from bzrlib._readdir_pyx import UTF8DirReader
 
2264
            from ._readdir_pyx import UTF8DirReader
2107
2265
            file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2108
 
        except ImportError, e:
 
2266
        except ImportError:
2109
2267
            # This is one time where we won't warn that an extension failed to
2110
2268
            # load. The extension is never available on Windows anyway.
2111
 
            from bzrlib._readdir_py import (
 
2269
            from ._readdir_py import (
2112
2270
                _kind_from_mode as file_kind_from_stat_mode
2113
2271
                )
2114
2272
    return file_kind_from_stat_mode(mode)
 
2273
 
 
2274
 
2115
2275
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2116
2276
 
2117
2277
 
2118
 
def file_kind(f, _lstat=os.lstat):
 
2278
def file_stat(f, _lstat=os.lstat):
2119
2279
    try:
2120
 
        return file_kind_from_stat_mode(_lstat(f).st_mode)
2121
 
    except OSError, e:
 
2280
        # XXX cache?
 
2281
        return _lstat(f)
 
2282
    except OSError as e:
2122
2283
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2123
2284
            raise errors.NoSuchFile(f)
2124
2285
        raise
2125
2286
 
2126
2287
 
 
2288
def file_kind(f, _lstat=os.lstat):
 
2289
    stat_value = file_stat(f, _lstat)
 
2290
    return file_kind_from_stat_mode(stat_value.st_mode)
 
2291
 
 
2292
 
2127
2293
def until_no_eintr(f, *a, **kw):
2128
2294
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2129
 
    
 
2295
 
2130
2296
    WARNING: you must be certain that it is safe to retry the call repeatedly
2131
2297
    if EINTR does occur.  This is typically only true for low-level operations
2132
2298
    like os.read.  If in any doubt, don't use this.
2134
2300
    Keep in mind that this is not a complete solution to EINTR.  There is
2135
2301
    probably code in the Python standard library and other dependencies that
2136
2302
    may encounter EINTR if a signal arrives (and there is signal handler for
2137
 
    that signal).  So this function can reduce the impact for IO that bzrlib
 
2303
    that signal).  So this function can reduce the impact for IO that breezy
2138
2304
    directly controls, but it is not a complete solution.
2139
2305
    """
2140
2306
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
2141
2307
    while True:
2142
2308
        try:
2143
2309
            return f(*a, **kw)
2144
 
        except (IOError, OSError), e:
 
2310
        except (IOError, OSError) as e:
2145
2311
            if e.errno == errno.EINTR:
2146
2312
                continue
2147
2313
            raise
2148
2314
 
2149
2315
 
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
 
 
2173
2316
if sys.platform == "win32":
2174
 
    import msvcrt
2175
2317
    def getchar():
 
2318
        import msvcrt
2176
2319
        return msvcrt.getch()
2177
2320
else:
2178
 
    import tty
2179
 
    import termios
2180
2321
    def getchar():
 
2322
        import tty
 
2323
        import termios
2181
2324
        fd = sys.stdin.fileno()
2182
2325
        settings = termios.tcgetattr(fd)
2183
2326
        try:
2187
2330
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2188
2331
        return ch
2189
2332
 
2190
 
 
2191
 
if sys.platform == 'linux2':
 
2333
if sys.platform.startswith('linux'):
2192
2334
    def _local_concurrency():
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
 
2335
        try:
 
2336
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2337
        except (ValueError, OSError, AttributeError):
 
2338
            return None
2199
2339
elif sys.platform == 'darwin':
2200
2340
    def _local_concurrency():
2201
2341
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2202
2342
                                stdout=subprocess.PIPE).communicate()[0]
2203
 
elif sys.platform[0:7] == 'freebsd':
 
2343
elif "bsd" in sys.platform:
2204
2344
    def _local_concurrency():
2205
2345
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2206
2346
                                stdout=subprocess.PIPE).communicate()[0]
2207
2347
elif sys.platform == 'sunos5':
2208
2348
    def _local_concurrency():
2209
 
        return subprocess.Popen(['psrinfo', '-p',],
 
2349
        return subprocess.Popen(['psrinfo', '-p', ],
2210
2350
                                stdout=subprocess.PIPE).communicate()[0]
2211
2351
elif sys.platform == "win32":
2212
2352
    def _local_concurrency():
2220
2360
 
2221
2361
_cached_local_concurrency = None
2222
2362
 
 
2363
 
2223
2364
def local_concurrency(use_cache=True):
2224
2365
    """Return how many processes can be run concurrently.
2225
2366
 
2231
2372
    if _cached_local_concurrency is not None and use_cache:
2232
2373
        return _cached_local_concurrency
2233
2374
 
2234
 
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
 
2375
    concurrency = os.environ.get('BRZ_CONCURRENCY', None)
2235
2376
    if concurrency is None:
 
2377
        import multiprocessing
2236
2378
        try:
2237
 
            concurrency = _local_concurrency()
2238
 
        except (OSError, IOError):
2239
 
            pass
 
2379
            concurrency = multiprocessing.cpu_count()
 
2380
        except NotImplementedError:
 
2381
            # multiprocessing.cpu_count() isn't implemented on all platforms
 
2382
            try:
 
2383
                concurrency = _local_concurrency()
 
2384
            except (OSError, IOError):
 
2385
                pass
2240
2386
    try:
2241
2387
        concurrency = int(concurrency)
2242
2388
    except (TypeError, ValueError):
2243
2389
        concurrency = 1
2244
2390
    if use_cache:
2245
 
        _cached_concurrency = concurrency
 
2391
        _cached_local_concurrency = concurrency
2246
2392
    return concurrency
2247
2393
 
2248
2394
 
2254
2400
        self.encode = encode
2255
2401
 
2256
2402
    def write(self, object):
2257
 
        if type(object) is str:
 
2403
        if isinstance(object, str):
2258
2404
            self.stream.write(object)
2259
2405
        else:
2260
2406
            data, _ = self.encode(object, self.errors)
2261
2407
            self.stream.write(data)
2262
2408
 
 
2409
 
2263
2410
if sys.platform == 'win32':
2264
2411
    def open_file(filename, mode='r', bufsize=-1):
2265
2412
        """This function is used to override the ``open`` builtin.
2266
 
        
 
2413
 
2267
2414
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2268
2415
        child processes.  Deleting or renaming a closed file opened with this
2269
2416
        function is not blocking child processes.
2293
2440
            else:
2294
2441
                flags |= os.O_WRONLY
2295
2442
            flags |= os.O_CREAT | os.O_APPEND
2296
 
        else: #reading
 
2443
        else:  # reading
2297
2444
            if updating:
2298
2445
                flags |= os.O_RDWR
2299
2446
            else:
2302
2449
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2303
2450
else:
2304
2451
    open_file = open
 
2452
 
 
2453
 
 
2454
def available_backup_name(base, exists):
 
2455
    """Find a non-existing backup file name.
 
2456
 
 
2457
    This will *not* create anything, this only return a 'free' entry.  This
 
2458
    should be used for checking names in a directory below a locked
 
2459
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
 
2460
    Leap) and generally discouraged.
 
2461
 
 
2462
    :param base: The base name.
 
2463
 
 
2464
    :param exists: A callable returning True if the path parameter exists.
 
2465
    """
 
2466
    counter = 1
 
2467
    name = "%s.~%d~" % (base, counter)
 
2468
    while exists(name):
 
2469
        counter += 1
 
2470
        name = "%s.~%d~" % (base, counter)
 
2471
    return name
 
2472
 
 
2473
 
 
2474
def set_fd_cloexec(fd):
 
2475
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
 
2476
    support for this is not available.
 
2477
    """
 
2478
    try:
 
2479
        import fcntl
 
2480
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
 
2481
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
 
2482
    except (ImportError, AttributeError):
 
2483
        # Either the fcntl module or specific constants are not present
 
2484
        pass
 
2485
 
 
2486
 
 
2487
def find_executable_on_path(name):
 
2488
    """Finds an executable on the PATH.
 
2489
 
 
2490
    On Windows, this will try to append each extension in the PATHEXT
 
2491
    environment variable to the name, if it cannot be found with the name
 
2492
    as given.
 
2493
 
 
2494
    :param name: The base name of the executable.
 
2495
    :return: The path to the executable found or None.
 
2496
    """
 
2497
    if sys.platform == 'win32':
 
2498
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
 
2499
        exts = [ext.lower() for ext in exts]
 
2500
        base, ext = os.path.splitext(name)
 
2501
        if ext != '':
 
2502
            if ext.lower() not in exts:
 
2503
                return None
 
2504
            name = base
 
2505
            exts = [ext]
 
2506
    else:
 
2507
        exts = ['']
 
2508
    path = os.environ.get('PATH')
 
2509
    if path is not None:
 
2510
        path = path.split(os.pathsep)
 
2511
        for ext in exts:
 
2512
            for d in path:
 
2513
                f = os.path.join(d, name) + ext
 
2514
                if os.access(f, os.X_OK):
 
2515
                    return f
 
2516
    if sys.platform == 'win32':
 
2517
        app_path = win32utils.get_app_path(name)
 
2518
        if app_path != name:
 
2519
            return app_path
 
2520
    return None
 
2521
 
 
2522
 
 
2523
def _posix_is_local_pid_dead(pid):
 
2524
    """True if pid doesn't correspond to live process on this machine"""
 
2525
    try:
 
2526
        # Special meaning of unix kill: just check if it's there.
 
2527
        os.kill(pid, 0)
 
2528
    except OSError as e:
 
2529
        if e.errno == errno.ESRCH:
 
2530
            # On this machine, and really not found: as sure as we can be
 
2531
            # that it's dead.
 
2532
            return True
 
2533
        elif e.errno == errno.EPERM:
 
2534
            # exists, though not ours
 
2535
            return False
 
2536
        else:
 
2537
            trace.mutter("os.kill(%d, 0) failed: %s" % (pid, e))
 
2538
            # Don't really know.
 
2539
            return False
 
2540
    else:
 
2541
        # Exists and our process: not dead.
 
2542
        return False
 
2543
 
 
2544
 
 
2545
if sys.platform == "win32":
 
2546
    is_local_pid_dead = win32utils.is_local_pid_dead
 
2547
else:
 
2548
    is_local_pid_dead = _posix_is_local_pid_dead
 
2549
 
 
2550
_maybe_ignored = ['EAGAIN', 'EINTR', 'ENOTSUP', 'EOPNOTSUPP', 'EACCES']
 
2551
_fdatasync_ignored = [getattr(errno, name) for name in _maybe_ignored
 
2552
                      if getattr(errno, name, None) is not None]
 
2553
 
 
2554
 
 
2555
def fdatasync(fileno):
 
2556
    """Flush file contents to disk if possible.
 
2557
 
 
2558
    :param fileno: Integer OS file handle.
 
2559
    :raises TransportNotPossible: If flushing to disk is not possible.
 
2560
    """
 
2561
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
 
2562
    if fn is not None:
 
2563
        try:
 
2564
            fn(fileno)
 
2565
        except IOError as e:
 
2566
            # See bug #1075108, on some platforms fdatasync exists, but can
 
2567
            # raise ENOTSUP. However, we are calling fdatasync to be helpful
 
2568
            # and reduce the chance of corruption-on-powerloss situations. It
 
2569
            # is not a mandatory call, so it is ok to suppress failures.
 
2570
            trace.mutter("ignoring error calling fdatasync: %s" % (e,))
 
2571
            if getattr(e, 'errno', None) not in _fdatasync_ignored:
 
2572
                raise
 
2573
 
 
2574
 
 
2575
def ensure_empty_directory_exists(path, exception_class):
 
2576
    """Make sure a local directory exists and is empty.
 
2577
 
 
2578
    If it does not exist, it is created.  If it exists and is not empty, an
 
2579
    instance of exception_class is raised.
 
2580
    """
 
2581
    try:
 
2582
        os.mkdir(path)
 
2583
    except OSError as e:
 
2584
        if e.errno != errno.EEXIST:
 
2585
            raise
 
2586
        if os.listdir(path) != []:
 
2587
            raise exception_class(path)
 
2588
 
 
2589
 
 
2590
def is_environment_error(evalue):
 
2591
    """True if exception instance is due to a process environment issue
 
2592
 
 
2593
    This includes OSError and IOError, but also other errors that come from
 
2594
    the operating system or core libraries but are not subclasses of those.
 
2595
    """
 
2596
    if isinstance(evalue, (EnvironmentError, select.error)):
 
2597
        return True
 
2598
    if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
 
2599
        return True
 
2600
    return False
 
2601
 
 
2602
 
 
2603
if PY3:
 
2604
    perf_counter = time.perf_counter
 
2605
else:
 
2606
    perf_counter = time.clock