/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to breezy/osutils.py

  • Committer: Jelmer Vernooij
  • Date: 2017-12-04 23:01:39 UTC
  • mto: This revision was merged to the branch mainline in revision 6839.
  • Revision ID: jelmer@jelmer.uk-20171204230139-1sc3c18ikwewdejm
Remove bytes_to_gzip; work with chunks instead.

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
from datetime import timedelta
 
31
import getpass
 
32
import locale
 
33
import ntpath
35
34
import posixpath
 
35
import select
 
36
# We need to import both shutil and rmtree as we export the later on posix
 
37
# and need the former on windows
36
38
import shutil
37
 
from shutil import (
38
 
    rmtree,
39
 
    )
 
39
from shutil import rmtree
40
40
import socket
41
41
import subprocess
 
42
# We need to import both tempfile and mkdtemp as we export the later on posix
 
43
# and need the former on windows
42
44
import tempfile
43
 
from tempfile import (
44
 
    mkdtemp,
45
 
    )
 
45
from tempfile import mkdtemp
46
46
import unicodedata
47
47
 
48
 
from bzrlib import (
49
 
    cache_utf8,
50
 
    errors,
 
48
from breezy import (
 
49
    config,
51
50
    trace,
52
51
    win32utils,
53
52
    )
 
53
from breezy.i18n import gettext
54
54
""")
55
55
 
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
 
56
from .sixish import (
 
57
    PY3,
 
58
    text_type,
 
59
    )
 
60
 
 
61
from hashlib import (
 
62
    md5,
 
63
    sha1 as sha,
 
64
    )
 
65
 
 
66
 
 
67
import breezy
 
68
from . import (
 
69
    _fs_enc,
 
70
    errors,
 
71
    )
77
72
 
78
73
 
79
74
# Cross platform wall-clock time functionality with decent resolution.
96
91
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
97
92
 
98
93
 
 
94
class UnsupportedTimezoneFormat(errors.BzrError):
 
95
 
 
96
    _fmt = ('Unsupported timezone format "%(timezone)s", '
 
97
            'options are "utc", "original", "local".')
 
98
 
 
99
    def __init__(self, timezone):
 
100
        self.timezone = timezone
 
101
 
 
102
 
99
103
def get_unicode_argv():
 
104
    if PY3:
 
105
        return sys.argv[1:]
100
106
    try:
101
107
        user_encoding = get_user_encoding()
102
108
        return [a.decode(user_encoding) for a in sys.argv[1:]]
103
109
    except UnicodeDecodeError:
104
 
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
105
 
                                                            "encoding." % a))
 
110
        raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
 
111
            "application locale.").format(a, user_encoding))
106
112
 
107
113
 
108
114
def make_readonly(filename):
109
115
    """Make a filename read-only."""
110
116
    mod = os.lstat(filename).st_mode
111
117
    if not stat.S_ISLNK(mod):
112
 
        mod = mod & 0777555
113
 
        os.chmod(filename, mod)
 
118
        mod = mod & 0o777555
 
119
        chmod_if_possible(filename, mod)
114
120
 
115
121
 
116
122
def make_writable(filename):
117
123
    mod = os.lstat(filename).st_mode
118
124
    if not stat.S_ISLNK(mod):
119
 
        mod = mod | 0200
120
 
        os.chmod(filename, mod)
 
125
        mod = mod | 0o200
 
126
        chmod_if_possible(filename, mod)
 
127
 
 
128
 
 
129
def chmod_if_possible(filename, mode):
 
130
    # Set file mode if that can be safely done.
 
131
    # Sometimes even on unix the filesystem won't allow it - see
 
132
    # https://bugs.launchpad.net/bzr/+bug/606537
 
133
    try:
 
134
        # It is probably faster to just do the chmod, rather than
 
135
        # doing a stat, and then trying to compare
 
136
        os.chmod(filename, mode)
 
137
    except (IOError, OSError) as e:
 
138
        # Permission/access denied seems to commonly happen on smbfs; there's
 
139
        # probably no point warning about it.
 
140
        # <https://bugs.launchpad.net/bzr/+bug/606537>
 
141
        if getattr(e, 'errno') in (errno.EPERM, errno.EACCES):
 
142
            trace.mutter("ignore error on chmod of %r: %r" % (
 
143
                filename, e))
 
144
            return
 
145
        raise
121
146
 
122
147
 
123
148
def minimum_path_selection(paths):
198
223
            stat = getattr(os, 'lstat', os.stat)
199
224
            stat(f)
200
225
            return True
201
 
        except OSError, e:
 
226
        except OSError as e:
202
227
            if e.errno == errno.ENOENT:
203
228
                return False;
204
229
            else:
205
 
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
 
230
                raise errors.BzrError(gettext("lstat/stat of ({0!r}): {1!r}").format(f, e))
206
231
 
207
232
 
208
233
def fancy_rename(old, new, rename_func, unlink_func):
232
257
    file_existed = False
233
258
    try:
234
259
        rename_func(new, tmp_name)
235
 
    except (errors.NoSuchFile,), e:
 
260
    except (errors.NoSuchFile,) as e:
236
261
        pass
237
 
    except IOError, e:
 
262
    except IOError as e:
238
263
        # RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
239
264
        # function raises an IOError with errno is None when a rename fails.
240
265
        # This then gets caught here.
241
266
        if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
242
267
            raise
243
 
    except Exception, e:
 
268
    except Exception as e:
244
269
        if (getattr(e, 'errno', None) is None
245
270
            or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
246
271
            raise
247
272
    else:
248
273
        file_existed = True
249
274
 
250
 
    failure_exc = None
251
275
    success = False
252
276
    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)
264
 
                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
 
277
        # This may throw an exception, in which case success will
 
278
        # not be set.
 
279
        rename_func(old, new)
 
280
        success = True
 
281
    except (IOError, OSError) as e:
 
282
        # source and target may be aliases of each other (e.g. on a
 
283
        # case-insensitive filesystem), so we may have accidentally renamed
 
284
        # source by when we tried to rename target
 
285
        if (file_existed and e.errno in (None, errno.ENOENT)
 
286
            and old.lower() == new.lower()):
 
287
            # source and target are the same file on a case-insensitive
 
288
            # filesystem, so we don't generate an exception
 
289
            pass
 
290
        else:
 
291
            raise
268
292
    finally:
269
293
        if file_existed:
270
294
            # If the file used to exist, rename it back into place
273
297
                unlink_func(tmp_name)
274
298
            else:
275
299
                rename_func(tmp_name, new)
276
 
    if failure_exc is not None:
277
 
        raise failure_exc[0], failure_exc[1], failure_exc[2]
278
300
 
279
301
 
280
302
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
281
303
# choke on a Unicode string containing a relative path if
282
304
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
283
305
# string.
284
 
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
285
306
def _posix_abspath(path):
286
307
    # jam 20060426 rather than encoding to fsencoding
287
308
    # copy posixpath.abspath, but use os.getcwdu instead
288
309
    if not posixpath.isabs(path):
289
310
        path = posixpath.join(getcwd(), path)
290
 
    return posixpath.normpath(path)
 
311
    return _posix_normpath(path)
291
312
 
292
313
 
293
314
def _posix_realpath(path):
294
315
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
295
316
 
296
317
 
 
318
def _posix_normpath(path):
 
319
    path = posixpath.normpath(path)
 
320
    # Bug 861008: posixpath.normpath() returns a path normalized according to
 
321
    # the POSIX standard, which stipulates (for compatibility reasons) that two
 
322
    # leading slashes must not be simplified to one, and only if there are 3 or
 
323
    # more should they be simplified as one. So we treat the leading 2 slashes
 
324
    # as a special case here by simply removing the first slash, as we consider
 
325
    # that breaking POSIX compatibility for this obscure feature is acceptable.
 
326
    # This is not a paranoid precaution, as we notably get paths like this when
 
327
    # the repo is hosted at the root of the filesystem, i.e. in "/".    
 
328
    if path.startswith('//'):
 
329
        path = path[1:]
 
330
    return path
 
331
 
 
332
 
 
333
def _posix_path_from_environ(key):
 
334
    """Get unicode path from `key` in environment or None if not present
 
335
 
 
336
    Note that posix systems use arbitrary byte strings for filesystem objects,
 
337
    so a path that raises BadFilenameEncoding here may still be accessible.
 
338
    """
 
339
    val = os.environ.get(key, None)
 
340
    if PY3 or val is None:
 
341
        return val
 
342
    try:
 
343
        return val.decode(_fs_enc)
 
344
    except UnicodeDecodeError:
 
345
        # GZ 2011-12-12:Ideally want to include `key` in the exception message
 
346
        raise errors.BadFilenameEncoding(val, _fs_enc)
 
347
 
 
348
 
 
349
def _posix_get_home_dir():
 
350
    """Get the home directory of the current user as a unicode path"""
 
351
    path = posixpath.expanduser("~")
 
352
    try:
 
353
        return path.decode(_fs_enc)
 
354
    except AttributeError:
 
355
        return path
 
356
    except UnicodeDecodeError:
 
357
        raise errors.BadFilenameEncoding(path, _fs_enc)
 
358
 
 
359
 
 
360
def _posix_getuser_unicode():
 
361
    """Get username from environment or password database as unicode"""
 
362
    name = getpass.getuser()
 
363
    if PY3:
 
364
        return name
 
365
    user_encoding = get_user_encoding()
 
366
    try:
 
367
        return name.decode(user_encoding)
 
368
    except UnicodeDecodeError:
 
369
        raise errors.BzrError("Encoding of username %r is unsupported by %s "
 
370
            "application locale." % (name, user_encoding))
 
371
 
 
372
 
297
373
def _win32_fixdrive(path):
298
374
    """Force drive letters to be consistent.
299
375
 
303
379
    running python.exe under cmd.exe return capital C:\\
304
380
    running win32 python inside a cygwin shell returns lowercase c:\\
305
381
    """
306
 
    drive, path = _nt_splitdrive(path)
 
382
    drive, path = ntpath.splitdrive(path)
307
383
    return drive.upper() + path
308
384
 
309
385
 
310
386
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('\\', '/'))
 
387
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
 
388
    return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
340
389
 
341
390
 
342
391
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('\\', '/'))
 
392
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
 
393
    return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
345
394
 
346
395
 
347
396
def _win32_pathjoin(*args):
348
 
    return _nt_join(*args).replace('\\', '/')
 
397
    return ntpath.join(*args).replace('\\', '/')
349
398
 
350
399
 
351
400
def _win32_normpath(path):
352
 
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
401
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
353
402
 
354
403
 
355
404
def _win32_getcwd():
356
 
    return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
 
405
    return _win32_fixdrive(_getcwd().replace('\\', '/'))
357
406
 
358
407
 
359
408
def _win32_mkdtemp(*args, **kwargs):
360
409
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
361
410
 
362
411
 
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
412
def _win32_rename(old, new):
372
413
    """We expect to be able to atomically replace 'new' with old.
373
414
 
375
416
    and then deleted.
376
417
    """
377
418
    try:
378
 
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
379
 
    except OSError, e:
 
419
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
 
420
    except OSError as e:
380
421
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
381
422
            # If we try to rename a non-existant file onto cwd, we get
382
423
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT
386
427
        raise
387
428
 
388
429
 
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
430
def _mac_getcwd():
400
 
    return unicodedata.normalize('NFC', os.getcwdu())
401
 
 
 
431
    return unicodedata.normalize('NFC', _getcwd())
 
432
 
 
433
 
 
434
def _rename_wrap_exception(rename_func):
 
435
    """Adds extra information to any exceptions that come from rename().
 
436
 
 
437
    The exception has an updated message and 'old_filename' and 'new_filename'
 
438
    attributes.
 
439
    """
 
440
 
 
441
    def _rename_wrapper(old, new):
 
442
        try:
 
443
            rename_func(old, new)
 
444
        except OSError as e:
 
445
            detailed_error = OSError(e.errno, e.strerror +
 
446
                                " [occurred when renaming '%s' to '%s']" %
 
447
                                (old, new))
 
448
            detailed_error.old_filename = old
 
449
            detailed_error.new_filename = new
 
450
            raise detailed_error
 
451
 
 
452
    return _rename_wrapper
 
453
 
 
454
 
 
455
if sys.version_info > (3,):
 
456
    _getcwd = os.getcwd
 
457
else:
 
458
    _getcwd = os.getcwdu
 
459
 
 
460
 
 
461
# Default rename wraps os.rename()
 
462
rename = _rename_wrap_exception(os.rename)
402
463
 
403
464
# Default is to just use the python builtins, but these can be rebound on
404
465
# particular platforms.
405
466
abspath = _posix_abspath
406
467
realpath = _posix_realpath
407
468
pathjoin = os.path.join
408
 
normpath = os.path.normpath
409
 
rename = _wrapped_rename # overridden below on win32
410
 
getcwd = os.getcwdu
 
469
normpath = _posix_normpath
 
470
path_from_environ = _posix_path_from_environ
 
471
_get_home_dir = _posix_get_home_dir
 
472
getuser_unicode = _posix_getuser_unicode
 
473
getcwd = _getcwd
411
474
dirname = os.path.dirname
412
475
basename = os.path.basename
413
476
split = os.path.split
414
477
splitext = os.path.splitext
415
 
# These were already imported into local scope
 
478
# These were already lazily imported into local scope
416
479
# mkdtemp = tempfile.mkdtemp
417
480
# rmtree = shutil.rmtree
 
481
lstat = os.lstat
 
482
fstat = os.fstat
 
483
 
 
484
def wrap_stat(st):
 
485
    return st
 
486
 
418
487
 
419
488
MIN_ABS_PATHLENGTH = 1
420
489
 
421
490
 
422
491
if sys.platform == 'win32':
423
 
    if win32utils.winver == 'Windows 98':
424
 
        abspath = _win98_abspath
425
 
    else:
426
 
        abspath = _win32_abspath
 
492
    abspath = _win32_abspath
427
493
    realpath = _win32_realpath
428
494
    pathjoin = _win32_pathjoin
429
495
    normpath = _win32_normpath
430
496
    getcwd = _win32_getcwd
431
497
    mkdtemp = _win32_mkdtemp
432
 
    rename = _win32_rename
 
498
    rename = _rename_wrap_exception(_win32_rename)
 
499
    try:
 
500
        from . import _walkdirs_win32
 
501
    except ImportError:
 
502
        pass
 
503
    else:
 
504
        lstat = _walkdirs_win32.lstat
 
505
        fstat = _walkdirs_win32.fstat
 
506
        wrap_stat = _walkdirs_win32.wrap_stat
433
507
 
434
508
    MIN_ABS_PATHLENGTH = 3
435
509
 
453
527
    f = win32utils.get_unicode_argv     # special function or None
454
528
    if f is not None:
455
529
        get_unicode_argv = f
 
530
    path_from_environ = win32utils.get_environ_unicode
 
531
    _get_home_dir = win32utils.get_home_location
 
532
    getuser_unicode = win32utils.get_user_name
456
533
 
457
534
elif sys.platform == 'darwin':
458
535
    getcwd = _mac_getcwd
459
536
 
460
537
 
461
 
def get_terminal_encoding():
 
538
def get_terminal_encoding(trace=False):
462
539
    """Find the best encoding for printing to the screen.
463
540
 
464
541
    This attempts to check both sys.stdout and sys.stdin to see
470
547
 
471
548
    On my standard US Windows XP, the preferred encoding is
472
549
    cp1252, but the console is cp437
 
550
 
 
551
    :param trace: If True trace the selected encoding via mutter().
473
552
    """
474
 
    from bzrlib.trace import mutter
 
553
    from .trace import mutter
475
554
    output_encoding = getattr(sys.stdout, 'encoding', None)
476
555
    if not output_encoding:
477
556
        input_encoding = getattr(sys.stdin, 'encoding', None)
478
557
        if not input_encoding:
479
558
            output_encoding = get_user_encoding()
480
 
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
559
            if trace:
 
560
                mutter('encoding stdout as osutils.get_user_encoding() %r',
481
561
                   output_encoding)
482
562
        else:
483
563
            output_encoding = input_encoding
484
 
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
564
            if trace:
 
565
                mutter('encoding stdout as sys.stdin encoding %r',
 
566
                    output_encoding)
485
567
    else:
486
 
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
568
        if trace:
 
569
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
487
570
    if output_encoding == 'cp0':
488
571
        # invalid encoding (cp0 means 'no codepage' on Windows)
489
572
        output_encoding = get_user_encoding()
490
 
        mutter('cp0 is invalid encoding.'
 
573
        if trace:
 
574
            mutter('cp0 is invalid encoding.'
491
575
               ' encoding stdout as osutils.get_user_encoding() %r',
492
576
               output_encoding)
493
577
    # check encoding
494
578
    try:
495
579
        codecs.lookup(output_encoding)
496
580
    except LookupError:
497
 
        sys.stderr.write('bzr: warning:'
 
581
        sys.stderr.write('brz: warning:'
498
582
                         ' unknown terminal encoding %s.\n'
499
583
                         '  Using encoding %s instead.\n'
500
584
                         % (output_encoding, get_user_encoding())
509
593
        F = realpath
510
594
    else:
511
595
        F = abspath
512
 
    [p,e] = os.path.split(f)
 
596
    [p, e] = os.path.split(f)
513
597
    if e == "" or e == "." or e == "..":
514
598
        return F(f)
515
599
    else:
519
603
def isdir(f):
520
604
    """True if f is an accessible directory."""
521
605
    try:
522
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
606
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
523
607
    except OSError:
524
608
        return False
525
609
 
527
611
def isfile(f):
528
612
    """True if f is a regular file."""
529
613
    try:
530
 
        return S_ISREG(os.lstat(f)[ST_MODE])
 
614
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
531
615
    except OSError:
532
616
        return False
533
617
 
534
618
def islink(f):
535
619
    """True if f is a symlink."""
536
620
    try:
537
 
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
621
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
538
622
    except OSError:
539
623
        return False
540
624
 
637
721
    # drives).
638
722
    if not segment_size:
639
723
        segment_size = 5242880 # 5MB
640
 
    segments = range(len(bytes) / segment_size + 1)
 
724
    offsets = range(0, len(bytes), segment_size)
 
725
    view = memoryview(bytes)
641
726
    write = file_handle.write
642
 
    for segment_index in segments:
643
 
        segment = buffer(bytes, segment_index * segment_size, segment_size)
644
 
        write(segment)
 
727
    for offset in offsets:
 
728
        write(view[offset:offset+segment_size])
645
729
 
646
730
 
647
731
def file_iterator(input_file, readsize=32768):
652
736
        yield b
653
737
 
654
738
 
 
739
# GZ 2017-09-16: Makes sense in general for hexdigest() result to be text, but
 
740
# used as bytes through most interfaces so encode with this wrapper.
 
741
if PY3:
 
742
    def _hexdigest(hashobj):
 
743
        return hashobj.hexdigest().encode()
 
744
else:
 
745
    def _hexdigest(hashobj):
 
746
        return hashobj.hexdigest()
 
747
 
 
748
 
655
749
def sha_file(f):
656
750
    """Calculate the hexdigest of an open file.
657
751
 
664
758
        if not b:
665
759
            break
666
760
        s.update(b)
667
 
    return s.hexdigest()
 
761
    return _hexdigest(s)
668
762
 
669
763
 
670
764
def size_sha_file(f):
682
776
            break
683
777
        size += len(b)
684
778
        s.update(b)
685
 
    return size, s.hexdigest()
 
779
    return size, _hexdigest(s)
686
780
 
687
781
 
688
782
def sha_file_by_name(fname):
693
787
        while True:
694
788
            b = os.read(f, 1<<16)
695
789
            if not b:
696
 
                return s.hexdigest()
 
790
                return _hexdigest(s)
697
791
            s.update(b)
698
792
    finally:
699
793
        os.close(f)
702
796
def sha_strings(strings, _factory=sha):
703
797
    """Return the sha-1 of concatenation of strings"""
704
798
    s = _factory()
705
 
    map(s.update, strings)
706
 
    return s.hexdigest()
 
799
    for string in strings:
 
800
        s.update(string)
 
801
    return _hexdigest(s)
707
802
 
708
803
 
709
804
def sha_string(f, _factory=sha):
710
 
    return _factory(f).hexdigest()
 
805
    # GZ 2017-09-16: Dodgy if factory is ever not sha, probably shouldn't be.
 
806
    return _hexdigest(_factory(f))
711
807
 
712
808
 
713
809
def fingerprint_file(f):
714
810
    b = f.read()
715
811
    return {'size': len(b),
716
 
            'sha1': sha(b).hexdigest()}
 
812
            'sha1': _hexdigest(sha(b))}
717
813
 
718
814
 
719
815
def compare_files(a, b):
728
824
            return True
729
825
 
730
826
 
 
827
def gmtime(seconds=None):
 
828
    """Convert seconds since the Epoch to a time tuple expressing UTC (a.k.a.
 
829
    GMT). When 'seconds' is not passed in, convert the current time instead.
 
830
    Handy replacement for time.gmtime() buggy on Windows and 32-bit platforms.
 
831
    """
 
832
    if seconds is None:
 
833
        seconds = time.time()
 
834
    return (datetime(1970, 1, 1) + timedelta(seconds=seconds)).timetuple()
 
835
 
 
836
 
731
837
def local_time_offset(t=None):
732
838
    """Return offset of local zone from GMT, either at present or at time t."""
733
839
    if t is None:
773
879
    """
774
880
    if offset is None:
775
881
        offset = 0
776
 
    tt = time.gmtime(t + offset)
 
882
    tt = gmtime(t + offset)
777
883
    date_fmt = _default_format_by_weekday_num[tt[6]]
778
884
    date_str = time.strftime(date_fmt, tt)
779
885
    offset_str = _cache.get(offset, None)
798
904
    (date_fmt, tt, offset_str) = \
799
905
               _format_date(t, offset, timezone, date_fmt, show_offset)
800
906
    date_str = time.strftime(date_fmt, tt)
801
 
    if not isinstance(date_str, unicode):
 
907
    if not isinstance(date_str, text_type):
802
908
        date_str = date_str.decode(get_user_encoding(), 'replace')
803
909
    return date_str + offset_str
804
910
 
805
911
 
806
912
def _format_date(t, offset, timezone, date_fmt, show_offset):
807
913
    if timezone == 'utc':
808
 
        tt = time.gmtime(t)
 
914
        tt = gmtime(t)
809
915
        offset = 0
810
916
    elif timezone == 'original':
811
917
        if offset is None:
812
918
            offset = 0
813
 
        tt = time.gmtime(t + offset)
 
919
        tt = gmtime(t + offset)
814
920
    elif timezone == 'local':
815
921
        tt = time.localtime(t)
816
922
        offset = local_time_offset(t)
817
923
    else:
818
 
        raise errors.UnsupportedTimezoneFormat(timezone)
 
924
        raise UnsupportedTimezoneFormat(timezone)
819
925
    if date_fmt is None:
820
926
        date_fmt = "%a %Y-%m-%d %H:%M:%S"
821
927
    if show_offset:
826
932
 
827
933
 
828
934
def compact_date(when):
829
 
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
 
935
    return time.strftime('%Y%m%d%H%M%S', gmtime(when))
830
936
 
831
937
 
832
938
def format_delta(delta):
880
986
 
881
987
def filesize(f):
882
988
    """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
 
989
    return os.fstat(f.fileno())[stat.ST_SIZE]
 
990
 
 
991
 
 
992
# Alias os.urandom to support platforms (which?) without /dev/urandom and 
 
993
# override if it doesn't work. Avoid checking on windows where there is
 
994
# significant initialisation cost that can be avoided for some bzr calls.
 
995
 
 
996
rand_bytes = os.urandom
 
997
 
 
998
if rand_bytes.__module__ != "nt":
895
999
    try:
896
 
        rand_bytes = file('/dev/urandom', 'rb').read
897
 
    # Otherwise, use this hack as a last resort
898
 
    except (IOError, OSError):
 
1000
        rand_bytes(1)
 
1001
    except NotImplementedError:
899
1002
        # not well seeded, but better than nothing
900
1003
        def rand_bytes(n):
901
1004
            import random
915
1018
    """
916
1019
    s = ''
917
1020
    for raw_byte in rand_bytes(num):
918
 
        s += ALNUM[ord(raw_byte) % 36]
 
1021
        if not PY3:
 
1022
            s += ALNUM[ord(raw_byte) % 36]
 
1023
        else:
 
1024
            s += ALNUM[raw_byte % 36]
919
1025
    return s
920
1026
 
921
1027
 
931
1037
    rps = []
932
1038
    for f in ps:
933
1039
        if f == '..':
934
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1040
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
935
1041
        elif (f == '.') or (f == ''):
936
1042
            pass
937
1043
        else:
942
1048
def joinpath(p):
943
1049
    for f in p:
944
1050
        if (f == '..') or (f is None) or (f == ''):
945
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1051
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
946
1052
    return pathjoin(*p)
947
1053
 
948
1054
 
949
1055
def parent_directories(filename):
950
1056
    """Return the list of parent directories, deepest first.
951
 
    
 
1057
 
952
1058
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
953
1059
    """
954
1060
    parents = []
970
1076
    implementation should be loaded instead::
971
1077
 
972
1078
    >>> try:
973
 
    >>>     import bzrlib._fictional_extension_pyx
 
1079
    >>>     import breezy._fictional_extension_pyx
974
1080
    >>> except ImportError, e:
975
 
    >>>     bzrlib.osutils.failed_to_load_extension(e)
976
 
    >>>     import bzrlib._fictional_extension_py
 
1081
    >>>     breezy.osutils.failed_to_load_extension(e)
 
1082
    >>>     import breezy._fictional_extension_py
977
1083
    """
978
1084
    # NB: This docstring is just an example, not a doctest, because doctest
979
1085
    # currently can't cope with the use of lazy imports in this namespace --
980
1086
    # mbp 20090729
981
 
    
 
1087
 
982
1088
    # This currently doesn't report the failure at the time it occurs, because
983
1089
    # they tend to happen very early in startup when we can't check config
984
1090
    # files etc, and also we want to report all failures but not spam the user
985
1091
    # with 10 warnings.
986
 
    from bzrlib import trace
987
1092
    exception_str = str(exception)
988
1093
    if exception_str not in _extension_load_failures:
989
1094
        trace.mutter("failed to load compiled extension: %s" % exception_str)
993
1098
def report_extension_load_failures():
994
1099
    if not _extension_load_failures:
995
1100
        return
996
 
    from bzrlib.config import GlobalConfig
997
 
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
 
1101
    if config.GlobalConfig().suppress_warning('missing_extensions'):
998
1102
        return
999
1103
    # the warnings framework should by default show this only once
1000
 
    from bzrlib.trace import warning
 
1104
    from .trace import warning
1001
1105
    warning(
1002
 
        "bzr: warning: some compiled extensions could not be loaded; "
1003
 
        "see <https://answers.launchpad.net/bzr/+faq/703>")
 
1106
        "brz: warning: some compiled extensions could not be loaded; "
 
1107
        "see ``brz help missing-extensions``")
1004
1108
    # we no longer show the specific missing extensions here, because it makes
1005
1109
    # the message too long and scary - see
1006
1110
    # https://bugs.launchpad.net/bzr/+bug/430529
1007
1111
 
1008
1112
 
1009
1113
try:
1010
 
    from bzrlib._chunks_to_lines_pyx import chunks_to_lines
1011
 
except ImportError, e:
 
1114
    from ._chunks_to_lines_pyx import chunks_to_lines
 
1115
except ImportError as e:
1012
1116
    failed_to_load_extension(e)
1013
 
    from bzrlib._chunks_to_lines_py import chunks_to_lines
 
1117
    from ._chunks_to_lines_py import chunks_to_lines
1014
1118
 
1015
1119
 
1016
1120
def split_lines(s):
1029
1133
 
1030
1134
    This supports Unicode or plain string objects.
1031
1135
    """
1032
 
    lines = s.split('\n')
1033
 
    result = [line + '\n' for line in lines[:-1]]
 
1136
    nl = b'\n' if isinstance(s, bytes) else u'\n'
 
1137
    lines = s.split(nl)
 
1138
    result = [line + nl for line in lines[:-1]]
1034
1139
    if lines[-1]:
1035
1140
        result.append(lines[-1])
1036
1141
    return result
1047
1152
        return
1048
1153
    try:
1049
1154
        os.link(src, dest)
1050
 
    except (OSError, IOError), e:
 
1155
    except (OSError, IOError) as e:
1051
1156
        if e.errno != errno.EXDEV:
1052
1157
            raise
1053
1158
        shutil.copyfile(src, dest)
1054
1159
 
1055
1160
 
1056
1161
def delete_any(path):
1057
 
    """Delete a file, symlink or directory.  
1058
 
    
 
1162
    """Delete a file, symlink or directory.
 
1163
 
1059
1164
    Will delete even if readonly.
1060
1165
    """
1061
1166
    try:
1062
1167
       _delete_file_or_dir(path)
1063
 
    except (OSError, IOError), e:
 
1168
    except (OSError, IOError) as e:
1064
1169
        if e.errno in (errno.EPERM, errno.EACCES):
1065
1170
            # make writable and try again
1066
1171
            try:
1126
1231
    #    separators
1127
1232
    # 3) '\xa0' isn't unicode safe since it is >128.
1128
1233
 
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':
 
1234
    if isinstance(s, str):
 
1235
        ws = ' \t\n\r\v\f'
 
1236
    else:
 
1237
        ws = (b' ', b'\t', b'\n', b'\r', b'\v', b'\f')
 
1238
    for ch in ws:
1134
1239
        if ch in s:
1135
1240
            return True
1136
1241
    else:
1162
1267
 
1163
1268
    if len(base) < MIN_ABS_PATHLENGTH:
1164
1269
        # must have space for e.g. a drive letter
1165
 
        raise ValueError('%r is too short to calculate a relative path'
 
1270
        raise ValueError(gettext('%r is too short to calculate a relative path')
1166
1271
            % (base,))
1167
1272
 
1168
1273
    rp = abspath(path)
1250
1355
    # but for now, we haven't optimized...
1251
1356
    return [canonical_relpath(base, p) for p in paths]
1252
1357
 
 
1358
 
 
1359
def decode_filename(filename):
 
1360
    """Decode the filename using the filesystem encoding
 
1361
 
 
1362
    If it is unicode, it is returned.
 
1363
    Otherwise it is decoded from the the filesystem's encoding. If decoding
 
1364
    fails, a errors.BadFilenameEncoding exception is raised.
 
1365
    """
 
1366
    if isinstance(filename, text_type):
 
1367
        return filename
 
1368
    try:
 
1369
        return filename.decode(_fs_enc)
 
1370
    except UnicodeDecodeError:
 
1371
        raise errors.BadFilenameEncoding(filename, _fs_enc)
 
1372
 
 
1373
 
1253
1374
def safe_unicode(unicode_or_utf8_string):
1254
1375
    """Coerce unicode_or_utf8_string into unicode.
1255
1376
 
1257
1378
    Otherwise it is decoded from utf-8. If decoding fails, the exception is
1258
1379
    wrapped in a BzrBadParameterNotUnicode exception.
1259
1380
    """
1260
 
    if isinstance(unicode_or_utf8_string, unicode):
 
1381
    if isinstance(unicode_or_utf8_string, text_type):
1261
1382
        return unicode_or_utf8_string
1262
1383
    try:
1263
1384
        return unicode_or_utf8_string.decode('utf8')
1271
1392
    If it is a str, it is returned.
1272
1393
    If it is Unicode, it is encoded into a utf-8 string.
1273
1394
    """
1274
 
    if isinstance(unicode_or_utf8_string, str):
 
1395
    if isinstance(unicode_or_utf8_string, bytes):
1275
1396
        # TODO: jam 20070209 This is overkill, and probably has an impact on
1276
1397
        #       performance if we are dealing with lots of apis that want a
1277
1398
        #       utf-8 revision id
1284
1405
    return unicode_or_utf8_string.encode('utf-8')
1285
1406
 
1286
1407
 
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):
 
1408
def safe_revision_id(unicode_or_utf8_string):
1293
1409
    """Revision ids should now be utf8, but at one point they were unicode.
1294
1410
 
1295
1411
    :param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
1296
1412
        utf8 or None).
1297
 
    :param warn: Functions that are sanitizing user data can set warn=False
1298
1413
    :return: None or a utf8 revision id.
1299
1414
    """
1300
1415
    if (unicode_or_utf8_string is None
1301
 
        or unicode_or_utf8_string.__class__ == str):
 
1416
        or unicode_or_utf8_string.__class__ == bytes):
1302
1417
        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):
 
1418
    raise TypeError('Unicode revision ids are no longer supported. '
 
1419
                    'Revision id generators should be creating utf8 revision '
 
1420
                    'ids.')
 
1421
 
 
1422
 
 
1423
def safe_file_id(unicode_or_utf8_string):
1314
1424
    """File ids should now be utf8, but at one point they were unicode.
1315
1425
 
1316
1426
    This is the same as safe_utf8, except it uses the cached encode functions
1318
1428
 
1319
1429
    :param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
1320
1430
        utf8 or None).
1321
 
    :param warn: Functions that are sanitizing user data can set warn=False
1322
1431
    :return: None or a utf8 file id.
1323
1432
    """
1324
1433
    if (unicode_or_utf8_string is None
1325
 
        or unicode_or_utf8_string.__class__ == str):
 
1434
        or unicode_or_utf8_string.__class__ == bytes):
1326
1435
        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)
 
1436
    raise TypeError('Unicode file ids are no longer supported. '
 
1437
                    'File id generators should be creating utf8 file ids.')
1331
1438
 
1332
1439
 
1333
1440
_platform_normalizes_filenames = False
1338
1445
def normalizes_filenames():
1339
1446
    """Return True if this platform normalizes unicode filenames.
1340
1447
 
1341
 
    Mac OSX does, Windows/Linux do not.
 
1448
    Only Mac OSX.
1342
1449
    """
1343
1450
    return _platform_normalizes_filenames
1344
1451
 
1349
1456
    On platforms where the system normalizes filenames (Mac OSX),
1350
1457
    you can access a file by any path which will normalize correctly.
1351
1458
    On platforms where the system does not normalize filenames
1352
 
    (Windows, Linux), you have to access a file by its exact path.
 
1459
    (everything else), you have to access a file by its exact path.
1353
1460
 
1354
1461
    Internally, bzr only supports NFC normalization, since that is
1355
1462
    the standard for XML documents.
1358
1465
    can be accessed by that path.
1359
1466
    """
1360
1467
 
1361
 
    return unicodedata.normalize('NFC', unicode(path)), True
 
1468
    return unicodedata.normalize('NFC', text_type(path)), True
1362
1469
 
1363
1470
 
1364
1471
def _inaccessible_normalized_filename(path):
1365
1472
    __doc__ = _accessible_normalized_filename.__doc__
1366
1473
 
1367
 
    normalized = unicodedata.normalize('NFC', unicode(path))
 
1474
    normalized = unicodedata.normalize('NFC', text_type(path))
1368
1475
    return normalized, normalized == path
1369
1476
 
1370
1477
 
1417
1524
terminal_width() returns None.
1418
1525
"""
1419
1526
 
 
1527
# Keep some state so that terminal_width can detect if _terminal_size has
 
1528
# returned a different size since the process started.  See docstring and
 
1529
# comments of terminal_width for details.
 
1530
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
 
1531
_terminal_size_state = 'no_data'
 
1532
_first_terminal_size = None
1420
1533
 
1421
1534
def terminal_width():
1422
1535
    """Return terminal width.
1424
1537
    None is returned if the width can't established precisely.
1425
1538
 
1426
1539
    The rules are:
1427
 
    - if BZR_COLUMNS is set, returns its value
 
1540
    - if BRZ_COLUMNS is set, returns its value
1428
1541
    - if there is no controlling terminal, returns None
 
1542
    - query the OS, if the queried size has changed since the last query,
 
1543
      return its value,
1429
1544
    - if COLUMNS is set, returns its value,
 
1545
    - if the OS has a value (even though it's never changed), return its value.
1430
1546
 
1431
1547
    From there, we need to query the OS to get the size of the controlling
1432
1548
    terminal.
1433
1549
 
1434
 
    Unices:
 
1550
    On Unices we query the OS by:
1435
1551
    - get termios.TIOCGWINSZ
1436
1552
    - if an error occurs or a negative value is obtained, returns None
1437
1553
 
1438
 
    Windows:
1439
 
    
 
1554
    On Windows we query the OS by:
1440
1555
    - win32utils.get_console_size() decides,
1441
1556
    - returns None on error (provided default value)
1442
1557
    """
 
1558
    # Note to implementors: if changing the rules for determining the width,
 
1559
    # make sure you've considered the behaviour in these cases:
 
1560
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
 
1561
    #  - brz log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
 
1562
    #    0,0.
 
1563
    #  - (add more interesting cases here, if you find any)
 
1564
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
 
1565
    # but we don't want to register a signal handler because it is impossible
 
1566
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
 
1567
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
 
1568
    # time so we can notice if the reported size has changed, which should have
 
1569
    # a similar effect.
1443
1570
 
1444
 
    # If BZR_COLUMNS is set, take it, user is always right
 
1571
    # If BRZ_COLUMNS is set, take it, user is always right
 
1572
    # Except if they specified 0 in which case, impose no limit here
1445
1573
    try:
1446
 
        return int(os.environ['BZR_COLUMNS'])
 
1574
        width = int(os.environ['BRZ_COLUMNS'])
1447
1575
    except (KeyError, ValueError):
1448
 
        pass
 
1576
        width = None
 
1577
    if width is not None:
 
1578
        if width > 0:
 
1579
            return width
 
1580
        else:
 
1581
            return None
1449
1582
 
1450
1583
    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.
 
1584
    if isatty is None or not isatty():
 
1585
        # Don't guess, setting BRZ_COLUMNS is the recommended way to override.
1453
1586
        return None
1454
1587
 
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))
 
1588
    # Query the OS
 
1589
    width, height = os_size = _terminal_size(None, None)
 
1590
    global _first_terminal_size, _terminal_size_state
 
1591
    if _terminal_size_state == 'no_data':
 
1592
        _first_terminal_size = os_size
 
1593
        _terminal_size_state = 'unchanged'
 
1594
    elif (_terminal_size_state == 'unchanged' and
 
1595
          _first_terminal_size != os_size):
 
1596
        _terminal_size_state = 'changed'
 
1597
 
 
1598
    # If the OS claims to know how wide the terminal is, and this value has
 
1599
    # ever changed, use that.
 
1600
    if _terminal_size_state == 'changed':
 
1601
        if width is not None and width > 0:
 
1602
            return width
 
1603
 
 
1604
    # If COLUMNS is set, use it.
1458
1605
    try:
1459
1606
        return int(os.environ['COLUMNS'])
1460
1607
    except (KeyError, ValueError):
1461
1608
        pass
1462
1609
 
1463
 
    width, height = _terminal_size(None, None)
1464
 
    if width <= 0:
1465
 
        # Consider invalid values as meaning no width
1466
 
        return None
 
1610
    # Finally, use an unchanged size from the OS, if we have one.
 
1611
    if _terminal_size_state == 'unchanged':
 
1612
        if width is not None and width > 0:
 
1613
            return width
1467
1614
 
1468
 
    return width
 
1615
    # The width could not be determined.
 
1616
    return None
1469
1617
 
1470
1618
 
1471
1619
def _win32_terminal_size(width, height):
1498
1646
    _terminal_size = _ioctl_terminal_size
1499
1647
 
1500
1648
 
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
1649
def supports_executable():
1527
1650
    return sys.platform != "win32"
1528
1651
 
1553
1676
        if orig_val is not None:
1554
1677
            del os.environ[env_variable]
1555
1678
    else:
1556
 
        if isinstance(value, unicode):
 
1679
        if not PY3 and isinstance(value, text_type):
1557
1680
            value = value.encode(get_user_encoding())
1558
1681
        os.environ[env_variable] = value
1559
1682
    return orig_val
1651
1774
        dirblock = []
1652
1775
        append = dirblock.append
1653
1776
        try:
1654
 
            names = sorted(_listdir(top))
1655
 
        except OSError, e:
 
1777
            names = sorted(map(decode_filename, _listdir(top)))
 
1778
        except OSError as e:
1656
1779
            if not _is_error_enotdir(e):
1657
1780
                raise
1658
1781
        else:
1711
1834
    """
1712
1835
    global _selected_dir_reader
1713
1836
    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.
 
1837
        if sys.platform == "win32":
1721
1838
            try:
1722
 
                from bzrlib._walkdirs_win32 import Win32ReadDir
 
1839
                from ._walkdirs_win32 import Win32ReadDir
1723
1840
                _selected_dir_reader = Win32ReadDir()
1724
1841
            except ImportError:
1725
1842
                pass
1726
 
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1727
 
            # ANSI_X3.4-1968 is a form of ASCII
 
1843
        elif _fs_enc in ('utf-8', 'ascii'):
1728
1844
            try:
1729
 
                from bzrlib._readdir_pyx import UTF8DirReader
 
1845
                from ._readdir_pyx import UTF8DirReader
1730
1846
                _selected_dir_reader = UTF8DirReader()
1731
 
            except ImportError, e:
 
1847
            except ImportError as e:
1732
1848
                failed_to_load_extension(e)
1733
1849
                pass
1734
1850
 
1784
1900
        _kind_from_mode = file_kind_from_stat_mode
1785
1901
 
1786
1902
        if prefix:
1787
 
            relprefix = prefix + '/'
 
1903
            relprefix = prefix + b'/'
1788
1904
        else:
1789
 
            relprefix = ''
1790
 
        top_slash = top + u'/'
 
1905
            relprefix = b''
 
1906
        top_slash = top + '/'
1791
1907
 
1792
1908
        dirblock = []
1793
1909
        append = dirblock.append
1832
1948
        link_to = os.readlink(source)
1833
1949
        os.symlink(link_to, dest)
1834
1950
 
1835
 
    real_handlers = {'file':shutil.copy2,
1836
 
                     'symlink':copy_link,
1837
 
                     'directory':copy_dir,
 
1951
    real_handlers = {'file': shutil.copy2,
 
1952
                     'symlink': copy_link,
 
1953
                     'directory': copy_dir,
1838
1954
                    }
1839
1955
    real_handlers.update(handlers)
1840
1956
 
1864
1980
    try:
1865
1981
        s = os.stat(src)
1866
1982
        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))
 
1983
    except OSError as e:
 
1984
        trace.warning(
 
1985
            'Unable to copy ownership from "%s" to "%s". '
 
1986
            'You may want to set it manually.', src, dst)
 
1987
        trace.log_exception_quietly()
1869
1988
 
1870
1989
 
1871
1990
def path_prefix_key(path):
1873
1992
 
1874
1993
    This can be used to sort paths in the same way that walkdirs does.
1875
1994
    """
1876
 
    return (dirname(path) , path)
 
1995
    return (dirname(path), path)
1877
1996
 
1878
1997
 
1879
1998
def compare_paths_prefix_order(path_a, path_b):
1886
2005
_cached_user_encoding = None
1887
2006
 
1888
2007
 
1889
 
def get_user_encoding(use_cache=True):
 
2008
def get_user_encoding():
1890
2009
    """Find out what the preferred user encoding is.
1891
2010
 
1892
2011
    This is generally the encoding that is used for command line parameters
1893
2012
    and file contents. This may be different from the terminal encoding
1894
2013
    or the filesystem encoding.
1895
2014
 
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
2015
    :return: A string defining the preferred user encoding
1901
2016
    """
1902
2017
    global _cached_user_encoding
1903
 
    if _cached_user_encoding is not None and use_cache:
 
2018
    if _cached_user_encoding is not None:
1904
2019
        return _cached_user_encoding
1905
2020
 
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'
 
2021
    if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
 
2022
        # Use the existing locale settings and call nl_langinfo directly
 
2023
        # rather than going through getpreferredencoding. This avoids
 
2024
        # <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
 
2025
        # possibility of the setlocale call throwing an error.
 
2026
        user_encoding = locale.nl_langinfo(locale.CODESET)
1923
2027
    else:
1924
 
        import locale
 
2028
        # GZ 2011-12-19: On windows could call GetACP directly instead.
 
2029
        user_encoding = locale.getpreferredencoding(False)
1925
2030
 
1926
2031
    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:'
 
2032
        user_encoding = codecs.lookup(user_encoding).name
 
2033
    except LookupError:
 
2034
        if user_encoding not in ("", "cp0"):
 
2035
            sys.stderr.write('brz: warning:'
1950
2036
                             ' unknown encoding %s.'
1951
2037
                             ' Continuing with ascii encoding.\n'
1952
2038
                             % user_encoding
1953
2039
                            )
1954
 
            user_encoding = 'ascii'
1955
 
 
1956
 
    if use_cache:
1957
 
        _cached_user_encoding = user_encoding
1958
 
 
 
2040
        user_encoding = 'ascii'
 
2041
    else:
 
2042
        # Get 'ascii' when setlocale has not been called or LANG=C or unset.
 
2043
        if user_encoding == 'ascii':
 
2044
            if sys.platform == 'darwin':
 
2045
                # OSX is special-cased in Python to have a UTF-8 filesystem
 
2046
                # encoding and previously had LANG set here if not present.
 
2047
                user_encoding = 'utf-8'
 
2048
            # GZ 2011-12-19: Maybe UTF-8 should be the default in this case
 
2049
            #                for some other posix platforms as well.
 
2050
 
 
2051
    _cached_user_encoding = user_encoding
1959
2052
    return user_encoding
1960
2053
 
1961
2054
 
 
2055
def get_diff_header_encoding():
 
2056
    return get_terminal_encoding()
 
2057
 
 
2058
 
1962
2059
def get_host_name():
1963
2060
    """Return the current unicode host name.
1964
2061
 
1966
2063
    behaves inconsistently on different platforms.
1967
2064
    """
1968
2065
    if sys.platform == "win32":
1969
 
        import win32utils
1970
2066
        return win32utils.get_host_name()
1971
2067
    else:
1972
2068
        import socket
 
2069
        if PY3:
 
2070
            return socket.gethostname()
1973
2071
        return socket.gethostname().decode(get_user_encoding())
1974
2072
 
1975
2073
 
1979
2077
# data at once.
1980
2078
MAX_SOCKET_CHUNK = 64 * 1024
1981
2079
 
 
2080
_end_of_stream_errors = [errno.ECONNRESET, errno.EPIPE, errno.EINVAL]
 
2081
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
 
2082
    _eno = getattr(errno, _eno, None)
 
2083
    if _eno is not None:
 
2084
        _end_of_stream_errors.append(_eno)
 
2085
del _eno
 
2086
 
 
2087
 
1982
2088
def read_bytes_from_socket(sock, report_activity=None,
1983
2089
        max_read_size=MAX_SOCKET_CHUNK):
1984
2090
    """Read up to max_read_size of bytes from sock and notify of progress.
1987
2093
    empty string rather than raise an error), and repeats the recv if
1988
2094
    interrupted by a signal.
1989
2095
    """
1990
 
    while 1:
 
2096
    while True:
1991
2097
        try:
1992
2098
            bytes = sock.recv(max_read_size)
1993
 
        except socket.error, e:
 
2099
        except socket.error as e:
1994
2100
            eno = e.args[0]
1995
 
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
 
2101
            if eno in _end_of_stream_errors:
1996
2102
                # The connection was closed by the other side.  Callers expect
1997
2103
                # an empty string to signal end-of-stream.
1998
2104
                return ""
2027
2133
 
2028
2134
def send_all(sock, bytes, report_activity=None):
2029
2135
    """Send all bytes on a socket.
2030
 
 
 
2136
 
2031
2137
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2032
2138
    some platforms, and catches EINTR which may be thrown if the send is
2033
2139
    interrupted by a signal.
2034
2140
 
2035
2141
    This is preferred to socket.sendall(), because it avoids portability bugs
2036
2142
    and provides activity reporting.
2037
 
 
 
2143
 
2038
2144
    :param report_activity: Call this as bytes are read, see
2039
2145
        Transport._report_activity
2040
2146
    """
2041
2147
    sent_total = 0
2042
2148
    byte_count = len(bytes)
 
2149
    view = memoryview(bytes)
2043
2150
    while sent_total < byte_count:
2044
2151
        try:
2045
 
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2046
 
        except socket.error, e:
 
2152
            sent = sock.send(view[sent_total:sent_total+MAX_SOCKET_CHUNK])
 
2153
        except (socket.error, IOError) as e:
 
2154
            if e.args[0] in _end_of_stream_errors:
 
2155
                raise errors.ConnectionReset(
 
2156
                    "Error trying to write to socket", e)
2047
2157
            if e.args[0] != errno.EINTR:
2048
2158
                raise
2049
2159
        else:
 
2160
            if sent == 0:
 
2161
                raise errors.ConnectionReset('Sending to %s returned 0 bytes'
 
2162
                                             % (sock,))
2050
2163
            sent_total += sent
2051
 
            report_activity(sent, 'write')
 
2164
            if report_activity is not None:
 
2165
                report_activity(sent, 'write')
 
2166
 
 
2167
 
 
2168
def connect_socket(address):
 
2169
    # Slight variation of the socket.create_connection() function (provided by
 
2170
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
 
2171
    # provide it for previous python versions. Also, we don't use the timeout
 
2172
    # parameter (provided by the python implementation) so we don't implement
 
2173
    # it either).
 
2174
    err = socket.error('getaddrinfo returns an empty list')
 
2175
    host, port = address
 
2176
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
 
2177
        af, socktype, proto, canonname, sa = res
 
2178
        sock = None
 
2179
        try:
 
2180
            sock = socket.socket(af, socktype, proto)
 
2181
            sock.connect(sa)
 
2182
            return sock
 
2183
 
 
2184
        except socket.error as err:
 
2185
            # 'err' is now the most recent error
 
2186
            if sock is not None:
 
2187
                sock.close()
 
2188
    raise err
2052
2189
 
2053
2190
 
2054
2191
def dereference_path(path):
2073
2210
def resource_string(package, resource_name):
2074
2211
    """Load a resource from a package and return it as a string.
2075
2212
 
2076
 
    Note: Only packages that start with bzrlib are currently supported.
 
2213
    Note: Only packages that start with breezy are currently supported.
2077
2214
 
2078
2215
    This is designed to be a lightweight implementation of resource
2079
2216
    loading in a way which is API compatible with the same API from
2082
2219
    If and when pkg_resources becomes a standard library, this routine
2083
2220
    can delegate to it.
2084
2221
    """
2085
 
    # Check package name is within bzrlib
2086
 
    if package == "bzrlib":
 
2222
    # Check package name is within breezy
 
2223
    if package == "breezy":
2087
2224
        resource_relpath = resource_name
2088
 
    elif package.startswith("bzrlib."):
2089
 
        package = package[len("bzrlib."):].replace('.', os.sep)
 
2225
    elif package.startswith("breezy."):
 
2226
        package = package[len("breezy."):].replace('.', os.sep)
2090
2227
        resource_relpath = pathjoin(package, resource_name)
2091
2228
    else:
2092
 
        raise errors.BzrError('resource package %s not in bzrlib' % package)
 
2229
        raise errors.BzrError('resource package %s not in breezy' % package)
2093
2230
 
2094
2231
    # Map the resource to a file and read its contents
2095
 
    base = dirname(bzrlib.__file__)
 
2232
    base = dirname(breezy.__file__)
2096
2233
    if getattr(sys, 'frozen', None):    # bzr.exe
2097
2234
        base = abspath(pathjoin(base, '..', '..'))
2098
 
    filename = pathjoin(base, resource_relpath)
2099
 
    return open(filename, 'rU').read()
2100
 
 
 
2235
    f = file(pathjoin(base, resource_relpath), "rU")
 
2236
    try:
 
2237
        return f.read()
 
2238
    finally:
 
2239
        f.close()
2101
2240
 
2102
2241
def file_kind_from_stat_mode_thunk(mode):
2103
2242
    global file_kind_from_stat_mode
2104
2243
    if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
2105
2244
        try:
2106
 
            from bzrlib._readdir_pyx import UTF8DirReader
 
2245
            from ._readdir_pyx import UTF8DirReader
2107
2246
            file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2108
 
        except ImportError, e:
 
2247
        except ImportError as e:
2109
2248
            # This is one time where we won't warn that an extension failed to
2110
2249
            # load. The extension is never available on Windows anyway.
2111
 
            from bzrlib._readdir_py import (
 
2250
            from ._readdir_py import (
2112
2251
                _kind_from_mode as file_kind_from_stat_mode
2113
2252
                )
2114
2253
    return file_kind_from_stat_mode(mode)
2115
2254
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2116
2255
 
2117
 
 
2118
 
def file_kind(f, _lstat=os.lstat):
 
2256
def file_stat(f, _lstat=os.lstat):
2119
2257
    try:
2120
 
        return file_kind_from_stat_mode(_lstat(f).st_mode)
2121
 
    except OSError, e:
 
2258
        # XXX cache?
 
2259
        return _lstat(f)
 
2260
    except OSError as e:
2122
2261
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2123
2262
            raise errors.NoSuchFile(f)
2124
2263
        raise
2125
2264
 
 
2265
def file_kind(f, _lstat=os.lstat):
 
2266
    stat_value = file_stat(f, _lstat)
 
2267
    return file_kind_from_stat_mode(stat_value.st_mode)
2126
2268
 
2127
2269
def until_no_eintr(f, *a, **kw):
2128
2270
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2129
 
    
 
2271
 
2130
2272
    WARNING: you must be certain that it is safe to retry the call repeatedly
2131
2273
    if EINTR does occur.  This is typically only true for low-level operations
2132
2274
    like os.read.  If in any doubt, don't use this.
2134
2276
    Keep in mind that this is not a complete solution to EINTR.  There is
2135
2277
    probably code in the Python standard library and other dependencies that
2136
2278
    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
 
2279
    that signal).  So this function can reduce the impact for IO that breezy
2138
2280
    directly controls, but it is not a complete solution.
2139
2281
    """
2140
2282
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
2141
2283
    while True:
2142
2284
        try:
2143
2285
            return f(*a, **kw)
2144
 
        except (IOError, OSError), e:
 
2286
        except (IOError, OSError) as e:
2145
2287
            if e.errno == errno.EINTR:
2146
2288
                continue
2147
2289
            raise
2148
2290
 
2149
2291
 
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
2292
if sys.platform == "win32":
2174
 
    import msvcrt
2175
2293
    def getchar():
 
2294
        import msvcrt
2176
2295
        return msvcrt.getch()
2177
2296
else:
2178
 
    import tty
2179
 
    import termios
2180
2297
    def getchar():
 
2298
        import tty
 
2299
        import termios
2181
2300
        fd = sys.stdin.fileno()
2182
2301
        settings = termios.tcgetattr(fd)
2183
2302
        try:
2187
2306
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2188
2307
        return ch
2189
2308
 
2190
 
 
2191
 
if sys.platform == 'linux2':
 
2309
if sys.platform.startswith('linux'):
2192
2310
    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
 
2311
        try:
 
2312
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2313
        except (ValueError, OSError, AttributeError):
 
2314
            return None
2199
2315
elif sys.platform == 'darwin':
2200
2316
    def _local_concurrency():
2201
2317
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2202
2318
                                stdout=subprocess.PIPE).communicate()[0]
2203
 
elif sys.platform[0:7] == 'freebsd':
 
2319
elif "bsd" in sys.platform:
2204
2320
    def _local_concurrency():
2205
2321
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2206
2322
                                stdout=subprocess.PIPE).communicate()[0]
2231
2347
    if _cached_local_concurrency is not None and use_cache:
2232
2348
        return _cached_local_concurrency
2233
2349
 
2234
 
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
 
2350
    concurrency = os.environ.get('BRZ_CONCURRENCY', None)
2235
2351
    if concurrency is None:
 
2352
        import multiprocessing
2236
2353
        try:
2237
 
            concurrency = _local_concurrency()
2238
 
        except (OSError, IOError):
2239
 
            pass
 
2354
            concurrency = multiprocessing.cpu_count()
 
2355
        except NotImplementedError:
 
2356
            # multiprocessing.cpu_count() isn't implemented on all platforms
 
2357
            try:
 
2358
                concurrency = _local_concurrency()
 
2359
            except (OSError, IOError):
 
2360
                pass
2240
2361
    try:
2241
2362
        concurrency = int(concurrency)
2242
2363
    except (TypeError, ValueError):
2254
2375
        self.encode = encode
2255
2376
 
2256
2377
    def write(self, object):
2257
 
        if type(object) is str:
 
2378
        if isinstance(object, str):
2258
2379
            self.stream.write(object)
2259
2380
        else:
2260
2381
            data, _ = self.encode(object, self.errors)
2263
2384
if sys.platform == 'win32':
2264
2385
    def open_file(filename, mode='r', bufsize=-1):
2265
2386
        """This function is used to override the ``open`` builtin.
2266
 
        
 
2387
 
2267
2388
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2268
2389
        child processes.  Deleting or renaming a closed file opened with this
2269
2390
        function is not blocking child processes.
2302
2423
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2303
2424
else:
2304
2425
    open_file = open
 
2426
 
 
2427
 
 
2428
def available_backup_name(base, exists):
 
2429
    """Find a non-existing backup file name.
 
2430
 
 
2431
    This will *not* create anything, this only return a 'free' entry.  This
 
2432
    should be used for checking names in a directory below a locked
 
2433
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
 
2434
    Leap) and generally discouraged.
 
2435
 
 
2436
    :param base: The base name.
 
2437
 
 
2438
    :param exists: A callable returning True if the path parameter exists.
 
2439
    """
 
2440
    counter = 1
 
2441
    name = "%s.~%d~" % (base, counter)
 
2442
    while exists(name):
 
2443
        counter += 1
 
2444
        name = "%s.~%d~" % (base, counter)
 
2445
    return name
 
2446
 
 
2447
 
 
2448
def set_fd_cloexec(fd):
 
2449
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
 
2450
    support for this is not available.
 
2451
    """
 
2452
    try:
 
2453
        import fcntl
 
2454
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
 
2455
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
 
2456
    except (ImportError, AttributeError):
 
2457
        # Either the fcntl module or specific constants are not present
 
2458
        pass
 
2459
 
 
2460
 
 
2461
def find_executable_on_path(name):
 
2462
    """Finds an executable on the PATH.
 
2463
    
 
2464
    On Windows, this will try to append each extension in the PATHEXT
 
2465
    environment variable to the name, if it cannot be found with the name
 
2466
    as given.
 
2467
    
 
2468
    :param name: The base name of the executable.
 
2469
    :return: The path to the executable found or None.
 
2470
    """
 
2471
    if sys.platform == 'win32':
 
2472
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
 
2473
        exts = [ext.lower() for ext in exts]
 
2474
        base, ext = os.path.splitext(name)
 
2475
        if ext != '':
 
2476
            if ext.lower() not in exts:
 
2477
                return None
 
2478
            name = base
 
2479
            exts = [ext]
 
2480
    else:
 
2481
        exts = ['']
 
2482
    path = os.environ.get('PATH')
 
2483
    if path is not None:
 
2484
        path = path.split(os.pathsep)
 
2485
        for ext in exts:
 
2486
            for d in path:
 
2487
                f = os.path.join(d, name) + ext
 
2488
                if os.access(f, os.X_OK):
 
2489
                    return f
 
2490
    if sys.platform == 'win32':
 
2491
        app_path = win32utils.get_app_path(name)
 
2492
        if app_path != name:
 
2493
            return app_path
 
2494
    return None
 
2495
 
 
2496
 
 
2497
def _posix_is_local_pid_dead(pid):
 
2498
    """True if pid doesn't correspond to live process on this machine"""
 
2499
    try:
 
2500
        # Special meaning of unix kill: just check if it's there.
 
2501
        os.kill(pid, 0)
 
2502
    except OSError as e:
 
2503
        if e.errno == errno.ESRCH:
 
2504
            # On this machine, and really not found: as sure as we can be
 
2505
            # that it's dead.
 
2506
            return True
 
2507
        elif e.errno == errno.EPERM:
 
2508
            # exists, though not ours
 
2509
            return False
 
2510
        else:
 
2511
            mutter("os.kill(%d, 0) failed: %s" % (pid, e))
 
2512
            # Don't really know.
 
2513
            return False
 
2514
    else:
 
2515
        # Exists and our process: not dead.
 
2516
        return False
 
2517
 
 
2518
if sys.platform == "win32":
 
2519
    is_local_pid_dead = win32utils.is_local_pid_dead
 
2520
else:
 
2521
    is_local_pid_dead = _posix_is_local_pid_dead
 
2522
 
 
2523
_maybe_ignored = ['EAGAIN', 'EINTR', 'ENOTSUP', 'EOPNOTSUPP', 'EACCES']
 
2524
_fdatasync_ignored = [getattr(errno, name) for name in _maybe_ignored
 
2525
                      if getattr(errno, name, None) is not None]
 
2526
 
 
2527
 
 
2528
def fdatasync(fileno):
 
2529
    """Flush file contents to disk if possible.
 
2530
    
 
2531
    :param fileno: Integer OS file handle.
 
2532
    :raises TransportNotPossible: If flushing to disk is not possible.
 
2533
    """
 
2534
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
 
2535
    if fn is not None:
 
2536
        try:
 
2537
            fn(fileno)
 
2538
        except IOError as e:
 
2539
            # See bug #1075108, on some platforms fdatasync exists, but can
 
2540
            # raise ENOTSUP. However, we are calling fdatasync to be helpful
 
2541
            # and reduce the chance of corruption-on-powerloss situations. It
 
2542
            # is not a mandatory call, so it is ok to suppress failures.
 
2543
            trace.mutter("ignoring error calling fdatasync: %s" % (e,))
 
2544
            if getattr(e, 'errno', None) not in _fdatasync_ignored:
 
2545
                raise
 
2546
 
 
2547
 
 
2548
def ensure_empty_directory_exists(path, exception_class):
 
2549
    """Make sure a local directory exists and is empty.
 
2550
    
 
2551
    If it does not exist, it is created.  If it exists and is not empty, an
 
2552
    instance of exception_class is raised.
 
2553
    """
 
2554
    try:
 
2555
        os.mkdir(path)
 
2556
    except OSError as e:
 
2557
        if e.errno != errno.EEXIST:
 
2558
            raise
 
2559
        if os.listdir(path) != []:
 
2560
            raise exception_class(path)
 
2561
 
 
2562
 
 
2563
def is_environment_error(evalue):
 
2564
    """True if exception instance is due to a process environment issue
 
2565
 
 
2566
    This includes OSError and IOError, but also other errors that come from
 
2567
    the operating system or core libraries but are not subclasses of those.
 
2568
    """
 
2569
    if isinstance(evalue, (EnvironmentError, select.error)):
 
2570
        return True
 
2571
    if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
 
2572
        return True
 
2573
    return False