/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

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

Show diffs side-by-side

added added

removed removed

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