/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/osutils.py

  • Committer: Jelmer Vernooij
  • Date: 2019-02-17 04:45:29 UTC
  • mto: (7290.1.9 work)
  • mto: This revision was merged to the branch mainline in revision 7295.
  • Revision ID: jelmer@jelmer.uk-20190217044529-uttid7powincb9fq
https://launchpad.net/bugs/1804830
Add bug #.

Show diffs side-by-side

added added

removed removed

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