/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: Breezy landing bot
  • Author(s): Jelmer Vernooij
  • Date: 2018-11-16 18:59:44 UTC
  • mfrom: (7143.15.15 more-cleanups)
  • Revision ID: breezy.the.bot@gmail.com-20181116185944-biefv1sub37qfybm
Sprinkle some PEP8iness.

Merged from https://code.launchpad.net/~jelmer/brz/more-cleanups/+merge/358611

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