/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: 2018-07-08 14:45:27 UTC
  • mto: This revision was merged to the branch mainline in revision 7036.
  • Revision ID: jelmer@jelmer.uk-20180708144527-codhlvdcdg9y0nji
Fix a bunch of merge tests.

Show diffs side-by-side

added added

removed removed

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