/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-09-01 07:15:43 UTC
  • mfrom: (6770.3.2 py3_test_cleanup)
  • Revision ID: jelmer@jelmer.uk-20170901071543-1t83321xkog9qrxh
Merge lp:~gz/brz/py3_test_cleanup

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())
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):
702
786
def sha_strings(strings, _factory=sha):
703
787
    """Return the sha-1 of concatenation of strings"""
704
788
    s = _factory()
705
 
    map(s.update, strings)
 
789
    for string in strings:
 
790
        s.update(string)
706
791
    return s.hexdigest()
707
792
 
708
793
 
728
813
            return True
729
814
 
730
815
 
 
816
def gmtime(seconds=None):
 
817
    """Convert seconds since the Epoch to a time tuple expressing UTC (a.k.a.
 
818
    GMT). When 'seconds' is not passed in, convert the current time instead.
 
819
    Handy replacement for time.gmtime() buggy on Windows and 32-bit platforms.
 
820
    """
 
821
    if seconds is None:
 
822
        seconds = time.time()
 
823
    return (datetime(1970, 1, 1) + timedelta(seconds=seconds)).timetuple()
 
824
 
 
825
 
731
826
def local_time_offset(t=None):
732
827
    """Return offset of local zone from GMT, either at present or at time t."""
733
828
    if t is None:
773
868
    """
774
869
    if offset is None:
775
870
        offset = 0
776
 
    tt = time.gmtime(t + offset)
 
871
    tt = gmtime(t + offset)
777
872
    date_fmt = _default_format_by_weekday_num[tt[6]]
778
873
    date_str = time.strftime(date_fmt, tt)
779
874
    offset_str = _cache.get(offset, None)
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
 
805
900
 
806
901
def _format_date(t, offset, timezone, date_fmt, show_offset):
807
902
    if timezone == 'utc':
808
 
        tt = time.gmtime(t)
 
903
        tt = gmtime(t)
809
904
        offset = 0
810
905
    elif timezone == 'original':
811
906
        if offset is None:
812
907
            offset = 0
813
 
        tt = time.gmtime(t + offset)
 
908
        tt = gmtime(t + offset)
814
909
    elif timezone == 'local':
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:
826
921
 
827
922
 
828
923
def compact_date(when):
829
 
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
 
924
    return time.strftime('%Y%m%d%H%M%S', gmtime(when))
830
925
 
831
926
 
832
927
def format_delta(delta):
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
    return unicodedata.normalize('NFC', text_type(path)), True
1362
1458
 
1363
1459
 
1364
1460
def _inaccessible_normalized_filename(path):
1365
1461
    __doc__ = _accessible_normalized_filename.__doc__
1366
1462
 
1367
 
    normalized = unicodedata.normalize('NFC', unicode(path))
 
1463
    normalized = unicodedata.normalize('NFC', text_type(path))
1368
1464
    return normalized, normalized == path
1369
1465
 
1370
1466
 
1417
1513
terminal_width() returns None.
1418
1514
"""
1419
1515
 
 
1516
# Keep some state so that terminal_width can detect if _terminal_size has
 
1517
# returned a different size since the process started.  See docstring and
 
1518
# comments of terminal_width for details.
 
1519
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
 
1520
_terminal_size_state = 'no_data'
 
1521
_first_terminal_size = None
1420
1522
 
1421
1523
def terminal_width():
1422
1524
    """Return terminal width.
1424
1526
    None is returned if the width can't established precisely.
1425
1527
 
1426
1528
    The rules are:
1427
 
    - if BZR_COLUMNS is set, returns its value
 
1529
    - if BRZ_COLUMNS is set, returns its value
1428
1530
    - if there is no controlling terminal, returns None
 
1531
    - query the OS, if the queried size has changed since the last query,
 
1532
      return its value,
1429
1533
    - if COLUMNS is set, returns its value,
 
1534
    - if the OS has a value (even though it's never changed), return its value.
1430
1535
 
1431
1536
    From there, we need to query the OS to get the size of the controlling
1432
1537
    terminal.
1433
1538
 
1434
 
    Unices:
 
1539
    On Unices we query the OS by:
1435
1540
    - get termios.TIOCGWINSZ
1436
1541
    - if an error occurs or a negative value is obtained, returns None
1437
1542
 
1438
 
    Windows:
1439
 
    
 
1543
    On Windows we query the OS by:
1440
1544
    - win32utils.get_console_size() decides,
1441
1545
    - returns None on error (provided default value)
1442
1546
    """
 
1547
    # Note to implementors: if changing the rules for determining the width,
 
1548
    # make sure you've considered the behaviour in these cases:
 
1549
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
 
1550
    #  - brz log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
 
1551
    #    0,0.
 
1552
    #  - (add more interesting cases here, if you find any)
 
1553
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
 
1554
    # but we don't want to register a signal handler because it is impossible
 
1555
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
 
1556
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
 
1557
    # time so we can notice if the reported size has changed, which should have
 
1558
    # a similar effect.
1443
1559
 
1444
 
    # If BZR_COLUMNS is set, take it, user is always right
 
1560
    # If BRZ_COLUMNS is set, take it, user is always right
 
1561
    # Except if they specified 0 in which case, impose no limit here
1445
1562
    try:
1446
 
        return int(os.environ['BZR_COLUMNS'])
 
1563
        width = int(os.environ['BRZ_COLUMNS'])
1447
1564
    except (KeyError, ValueError):
1448
 
        pass
 
1565
        width = None
 
1566
    if width is not None:
 
1567
        if width > 0:
 
1568
            return width
 
1569
        else:
 
1570
            return None
1449
1571
 
1450
1572
    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.
 
1573
    if isatty is None or not isatty():
 
1574
        # Don't guess, setting BRZ_COLUMNS is the recommended way to override.
1453
1575
        return None
1454
1576
 
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))
 
1577
    # Query the OS
 
1578
    width, height = os_size = _terminal_size(None, None)
 
1579
    global _first_terminal_size, _terminal_size_state
 
1580
    if _terminal_size_state == 'no_data':
 
1581
        _first_terminal_size = os_size
 
1582
        _terminal_size_state = 'unchanged'
 
1583
    elif (_terminal_size_state == 'unchanged' and
 
1584
          _first_terminal_size != os_size):
 
1585
        _terminal_size_state = 'changed'
 
1586
 
 
1587
    # If the OS claims to know how wide the terminal is, and this value has
 
1588
    # ever changed, use that.
 
1589
    if _terminal_size_state == 'changed':
 
1590
        if width is not None and width > 0:
 
1591
            return width
 
1592
 
 
1593
    # If COLUMNS is set, use it.
1458
1594
    try:
1459
1595
        return int(os.environ['COLUMNS'])
1460
1596
    except (KeyError, ValueError):
1461
1597
        pass
1462
1598
 
1463
 
    width, height = _terminal_size(None, None)
1464
 
    if width <= 0:
1465
 
        # Consider invalid values as meaning no width
1466
 
        return None
 
1599
    # Finally, use an unchanged size from the OS, if we have one.
 
1600
    if _terminal_size_state == 'unchanged':
 
1601
        if width is not None and width > 0:
 
1602
            return width
1467
1603
 
1468
 
    return width
 
1604
    # The width could not be determined.
 
1605
    return None
1469
1606
 
1470
1607
 
1471
1608
def _win32_terminal_size(width, height):
1498
1635
    _terminal_size = _ioctl_terminal_size
1499
1636
 
1500
1637
 
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
1638
def supports_executable():
1527
1639
    return sys.platform != "win32"
1528
1640
 
1553
1665
        if orig_val is not None:
1554
1666
            del os.environ[env_variable]
1555
1667
    else:
1556
 
        if isinstance(value, unicode):
 
1668
        if not PY3 and isinstance(value, text_type):
1557
1669
            value = value.encode(get_user_encoding())
1558
1670
        os.environ[env_variable] = value
1559
1671
    return orig_val
1651
1763
        dirblock = []
1652
1764
        append = dirblock.append
1653
1765
        try:
1654
 
            names = sorted(_listdir(top))
1655
 
        except OSError, e:
 
1766
            names = sorted(map(decode_filename, _listdir(top)))
 
1767
        except OSError as e:
1656
1768
            if not _is_error_enotdir(e):
1657
1769
                raise
1658
1770
        else:
1711
1823
    """
1712
1824
    global _selected_dir_reader
1713
1825
    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.
 
1826
        if sys.platform == "win32":
1721
1827
            try:
1722
 
                from bzrlib._walkdirs_win32 import Win32ReadDir
 
1828
                from ._walkdirs_win32 import Win32ReadDir
1723
1829
                _selected_dir_reader = Win32ReadDir()
1724
1830
            except ImportError:
1725
1831
                pass
1726
 
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1727
 
            # ANSI_X3.4-1968 is a form of ASCII
 
1832
        elif _fs_enc in ('utf-8', 'ascii'):
1728
1833
            try:
1729
 
                from bzrlib._readdir_pyx import UTF8DirReader
 
1834
                from ._readdir_pyx import UTF8DirReader
1730
1835
                _selected_dir_reader = UTF8DirReader()
1731
 
            except ImportError, e:
 
1836
            except ImportError as e:
1732
1837
                failed_to_load_extension(e)
1733
1838
                pass
1734
1839
 
1784
1889
        _kind_from_mode = file_kind_from_stat_mode
1785
1890
 
1786
1891
        if prefix:
1787
 
            relprefix = prefix + '/'
 
1892
            relprefix = prefix + b'/'
1788
1893
        else:
1789
 
            relprefix = ''
1790
 
        top_slash = top + u'/'
 
1894
            relprefix = b''
 
1895
        top_slash = top + '/'
1791
1896
 
1792
1897
        dirblock = []
1793
1898
        append = dirblock.append
1864
1969
    try:
1865
1970
        s = os.stat(src)
1866
1971
        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))
 
1972
    except OSError as e:
 
1973
        trace.warning(
 
1974
            'Unable to copy ownership from "%s" to "%s". '
 
1975
            'You may want to set it manually.', src, dst)
 
1976
        trace.log_exception_quietly()
1869
1977
 
1870
1978
 
1871
1979
def path_prefix_key(path):
1886
1994
_cached_user_encoding = None
1887
1995
 
1888
1996
 
1889
 
def get_user_encoding(use_cache=True):
 
1997
def get_user_encoding():
1890
1998
    """Find out what the preferred user encoding is.
1891
1999
 
1892
2000
    This is generally the encoding that is used for command line parameters
1893
2001
    and file contents. This may be different from the terminal encoding
1894
2002
    or the filesystem encoding.
1895
2003
 
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
2004
    :return: A string defining the preferred user encoding
1901
2005
    """
1902
2006
    global _cached_user_encoding
1903
 
    if _cached_user_encoding is not None and use_cache:
 
2007
    if _cached_user_encoding is not None:
1904
2008
        return _cached_user_encoding
1905
2009
 
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'
 
2010
    if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
 
2011
        # Use the existing locale settings and call nl_langinfo directly
 
2012
        # rather than going through getpreferredencoding. This avoids
 
2013
        # <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
 
2014
        # possibility of the setlocale call throwing an error.
 
2015
        user_encoding = locale.nl_langinfo(locale.CODESET)
1923
2016
    else:
1924
 
        import locale
 
2017
        # GZ 2011-12-19: On windows could call GetACP directly instead.
 
2018
        user_encoding = locale.getpreferredencoding(False)
1925
2019
 
1926
2020
    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:'
 
2021
        user_encoding = codecs.lookup(user_encoding).name
 
2022
    except LookupError:
 
2023
        if user_encoding not in ("", "cp0"):
 
2024
            sys.stderr.write('brz: warning:'
1950
2025
                             ' unknown encoding %s.'
1951
2026
                             ' Continuing with ascii encoding.\n'
1952
2027
                             % user_encoding
1953
2028
                            )
1954
 
            user_encoding = 'ascii'
1955
 
 
1956
 
    if use_cache:
1957
 
        _cached_user_encoding = user_encoding
1958
 
 
 
2029
        user_encoding = 'ascii'
 
2030
    else:
 
2031
        # Get 'ascii' when setlocale has not been called or LANG=C or unset.
 
2032
        if user_encoding == 'ascii':
 
2033
            if sys.platform == 'darwin':
 
2034
                # OSX is special-cased in Python to have a UTF-8 filesystem
 
2035
                # encoding and previously had LANG set here if not present.
 
2036
                user_encoding = 'utf-8'
 
2037
            # GZ 2011-12-19: Maybe UTF-8 should be the default in this case
 
2038
            #                for some other posix platforms as well.
 
2039
 
 
2040
    _cached_user_encoding = user_encoding
1959
2041
    return user_encoding
1960
2042
 
1961
2043
 
 
2044
def get_diff_header_encoding():
 
2045
    return get_terminal_encoding()
 
2046
 
 
2047
 
1962
2048
def get_host_name():
1963
2049
    """Return the current unicode host name.
1964
2050
 
1966
2052
    behaves inconsistently on different platforms.
1967
2053
    """
1968
2054
    if sys.platform == "win32":
1969
 
        import win32utils
1970
2055
        return win32utils.get_host_name()
1971
2056
    else:
1972
2057
        import socket
 
2058
        if PY3:
 
2059
            return socket.gethostname()
1973
2060
        return socket.gethostname().decode(get_user_encoding())
1974
2061
 
1975
2062
 
1979
2066
# data at once.
1980
2067
MAX_SOCKET_CHUNK = 64 * 1024
1981
2068
 
 
2069
_end_of_stream_errors = [errno.ECONNRESET, errno.EPIPE, errno.EINVAL]
 
2070
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
 
2071
    _eno = getattr(errno, _eno, None)
 
2072
    if _eno is not None:
 
2073
        _end_of_stream_errors.append(_eno)
 
2074
del _eno
 
2075
 
 
2076
 
1982
2077
def read_bytes_from_socket(sock, report_activity=None,
1983
2078
        max_read_size=MAX_SOCKET_CHUNK):
1984
2079
    """Read up to max_read_size of bytes from sock and notify of progress.
1987
2082
    empty string rather than raise an error), and repeats the recv if
1988
2083
    interrupted by a signal.
1989
2084
    """
1990
 
    while 1:
 
2085
    while True:
1991
2086
        try:
1992
2087
            bytes = sock.recv(max_read_size)
1993
 
        except socket.error, e:
 
2088
        except socket.error as e:
1994
2089
            eno = e.args[0]
1995
 
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
 
2090
            if eno in _end_of_stream_errors:
1996
2091
                # The connection was closed by the other side.  Callers expect
1997
2092
                # an empty string to signal end-of-stream.
1998
2093
                return ""
2027
2122
 
2028
2123
def send_all(sock, bytes, report_activity=None):
2029
2124
    """Send all bytes on a socket.
2030
 
 
 
2125
 
2031
2126
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2032
2127
    some platforms, and catches EINTR which may be thrown if the send is
2033
2128
    interrupted by a signal.
2034
2129
 
2035
2130
    This is preferred to socket.sendall(), because it avoids portability bugs
2036
2131
    and provides activity reporting.
2037
 
 
 
2132
 
2038
2133
    :param report_activity: Call this as bytes are read, see
2039
2134
        Transport._report_activity
2040
2135
    """
2041
2136
    sent_total = 0
2042
2137
    byte_count = len(bytes)
 
2138
    view = memoryview(bytes)
2043
2139
    while sent_total < byte_count:
2044
2140
        try:
2045
 
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2046
 
        except socket.error, e:
 
2141
            sent = sock.send(view[sent_total:sent_total+MAX_SOCKET_CHUNK])
 
2142
        except (socket.error, IOError) as e:
 
2143
            if e.args[0] in _end_of_stream_errors:
 
2144
                raise errors.ConnectionReset(
 
2145
                    "Error trying to write to socket", e)
2047
2146
            if e.args[0] != errno.EINTR:
2048
2147
                raise
2049
2148
        else:
 
2149
            if sent == 0:
 
2150
                raise errors.ConnectionReset('Sending to %s returned 0 bytes'
 
2151
                                             % (sock,))
2050
2152
            sent_total += sent
2051
 
            report_activity(sent, 'write')
 
2153
            if report_activity is not None:
 
2154
                report_activity(sent, 'write')
 
2155
 
 
2156
 
 
2157
def connect_socket(address):
 
2158
    # Slight variation of the socket.create_connection() function (provided by
 
2159
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
 
2160
    # provide it for previous python versions. Also, we don't use the timeout
 
2161
    # parameter (provided by the python implementation) so we don't implement
 
2162
    # it either).
 
2163
    err = socket.error('getaddrinfo returns an empty list')
 
2164
    host, port = address
 
2165
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
 
2166
        af, socktype, proto, canonname, sa = res
 
2167
        sock = None
 
2168
        try:
 
2169
            sock = socket.socket(af, socktype, proto)
 
2170
            sock.connect(sa)
 
2171
            return sock
 
2172
 
 
2173
        except socket.error as err:
 
2174
            # 'err' is now the most recent error
 
2175
            if sock is not None:
 
2176
                sock.close()
 
2177
    raise err
2052
2178
 
2053
2179
 
2054
2180
def dereference_path(path):
2073
2199
def resource_string(package, resource_name):
2074
2200
    """Load a resource from a package and return it as a string.
2075
2201
 
2076
 
    Note: Only packages that start with bzrlib are currently supported.
 
2202
    Note: Only packages that start with breezy are currently supported.
2077
2203
 
2078
2204
    This is designed to be a lightweight implementation of resource
2079
2205
    loading in a way which is API compatible with the same API from
2082
2208
    If and when pkg_resources becomes a standard library, this routine
2083
2209
    can delegate to it.
2084
2210
    """
2085
 
    # Check package name is within bzrlib
2086
 
    if package == "bzrlib":
 
2211
    # Check package name is within breezy
 
2212
    if package == "breezy":
2087
2213
        resource_relpath = resource_name
2088
 
    elif package.startswith("bzrlib."):
2089
 
        package = package[len("bzrlib."):].replace('.', os.sep)
 
2214
    elif package.startswith("breezy."):
 
2215
        package = package[len("breezy."):].replace('.', os.sep)
2090
2216
        resource_relpath = pathjoin(package, resource_name)
2091
2217
    else:
2092
 
        raise errors.BzrError('resource package %s not in bzrlib' % package)
 
2218
        raise errors.BzrError('resource package %s not in breezy' % package)
2093
2219
 
2094
2220
    # Map the resource to a file and read its contents
2095
 
    base = dirname(bzrlib.__file__)
 
2221
    base = dirname(breezy.__file__)
2096
2222
    if getattr(sys, 'frozen', None):    # bzr.exe
2097
2223
        base = abspath(pathjoin(base, '..', '..'))
2098
 
    filename = pathjoin(base, resource_relpath)
2099
 
    return open(filename, 'rU').read()
2100
 
 
 
2224
    f = file(pathjoin(base, resource_relpath), "rU")
 
2225
    try:
 
2226
        return f.read()
 
2227
    finally:
 
2228
        f.close()
2101
2229
 
2102
2230
def file_kind_from_stat_mode_thunk(mode):
2103
2231
    global file_kind_from_stat_mode
2104
2232
    if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
2105
2233
        try:
2106
 
            from bzrlib._readdir_pyx import UTF8DirReader
 
2234
            from ._readdir_pyx import UTF8DirReader
2107
2235
            file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2108
 
        except ImportError, e:
 
2236
        except ImportError as e:
2109
2237
            # This is one time where we won't warn that an extension failed to
2110
2238
            # load. The extension is never available on Windows anyway.
2111
 
            from bzrlib._readdir_py import (
 
2239
            from ._readdir_py import (
2112
2240
                _kind_from_mode as file_kind_from_stat_mode
2113
2241
                )
2114
2242
    return file_kind_from_stat_mode(mode)
2115
2243
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2116
2244
 
2117
 
 
2118
 
def file_kind(f, _lstat=os.lstat):
 
2245
def file_stat(f, _lstat=os.lstat):
2119
2246
    try:
2120
 
        return file_kind_from_stat_mode(_lstat(f).st_mode)
2121
 
    except OSError, e:
 
2247
        # XXX cache?
 
2248
        return _lstat(f)
 
2249
    except OSError as e:
2122
2250
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2123
2251
            raise errors.NoSuchFile(f)
2124
2252
        raise
2125
2253
 
 
2254
def file_kind(f, _lstat=os.lstat):
 
2255
    stat_value = file_stat(f, _lstat)
 
2256
    return file_kind_from_stat_mode(stat_value.st_mode)
2126
2257
 
2127
2258
def until_no_eintr(f, *a, **kw):
2128
2259
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2129
 
    
 
2260
 
2130
2261
    WARNING: you must be certain that it is safe to retry the call repeatedly
2131
2262
    if EINTR does occur.  This is typically only true for low-level operations
2132
2263
    like os.read.  If in any doubt, don't use this.
2134
2265
    Keep in mind that this is not a complete solution to EINTR.  There is
2135
2266
    probably code in the Python standard library and other dependencies that
2136
2267
    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
 
2268
    that signal).  So this function can reduce the impact for IO that breezy
2138
2269
    directly controls, but it is not a complete solution.
2139
2270
    """
2140
2271
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
2141
2272
    while True:
2142
2273
        try:
2143
2274
            return f(*a, **kw)
2144
 
        except (IOError, OSError), e:
 
2275
        except (IOError, OSError) as e:
2145
2276
            if e.errno == errno.EINTR:
2146
2277
                continue
2147
2278
            raise
2148
2279
 
2149
2280
 
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
2281
if sys.platform == "win32":
2174
 
    import msvcrt
2175
2282
    def getchar():
 
2283
        import msvcrt
2176
2284
        return msvcrt.getch()
2177
2285
else:
2178
 
    import tty
2179
 
    import termios
2180
2286
    def getchar():
 
2287
        import tty
 
2288
        import termios
2181
2289
        fd = sys.stdin.fileno()
2182
2290
        settings = termios.tcgetattr(fd)
2183
2291
        try:
2187
2295
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2188
2296
        return ch
2189
2297
 
2190
 
 
2191
 
if sys.platform == 'linux2':
 
2298
if sys.platform.startswith('linux'):
2192
2299
    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
 
2300
        try:
 
2301
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2302
        except (ValueError, OSError, AttributeError):
 
2303
            return None
2199
2304
elif sys.platform == 'darwin':
2200
2305
    def _local_concurrency():
2201
2306
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2202
2307
                                stdout=subprocess.PIPE).communicate()[0]
2203
 
elif sys.platform[0:7] == 'freebsd':
 
2308
elif "bsd" in sys.platform:
2204
2309
    def _local_concurrency():
2205
2310
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2206
2311
                                stdout=subprocess.PIPE).communicate()[0]
2231
2336
    if _cached_local_concurrency is not None and use_cache:
2232
2337
        return _cached_local_concurrency
2233
2338
 
2234
 
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
 
2339
    concurrency = os.environ.get('BRZ_CONCURRENCY', None)
2235
2340
    if concurrency is None:
 
2341
        import multiprocessing
2236
2342
        try:
2237
 
            concurrency = _local_concurrency()
2238
 
        except (OSError, IOError):
2239
 
            pass
 
2343
            concurrency = multiprocessing.cpu_count()
 
2344
        except NotImplementedError:
 
2345
            # multiprocessing.cpu_count() isn't implemented on all platforms
 
2346
            try:
 
2347
                concurrency = _local_concurrency()
 
2348
            except (OSError, IOError):
 
2349
                pass
2240
2350
    try:
2241
2351
        concurrency = int(concurrency)
2242
2352
    except (TypeError, ValueError):
2254
2364
        self.encode = encode
2255
2365
 
2256
2366
    def write(self, object):
2257
 
        if type(object) is str:
 
2367
        if isinstance(object, str):
2258
2368
            self.stream.write(object)
2259
2369
        else:
2260
2370
            data, _ = self.encode(object, self.errors)
2263
2373
if sys.platform == 'win32':
2264
2374
    def open_file(filename, mode='r', bufsize=-1):
2265
2375
        """This function is used to override the ``open`` builtin.
2266
 
        
 
2376
 
2267
2377
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2268
2378
        child processes.  Deleting or renaming a closed file opened with this
2269
2379
        function is not blocking child processes.
2302
2412
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2303
2413
else:
2304
2414
    open_file = open
 
2415
 
 
2416
 
 
2417
def available_backup_name(base, exists):
 
2418
    """Find a non-existing backup file name.
 
2419
 
 
2420
    This will *not* create anything, this only return a 'free' entry.  This
 
2421
    should be used for checking names in a directory below a locked
 
2422
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
 
2423
    Leap) and generally discouraged.
 
2424
 
 
2425
    :param base: The base name.
 
2426
 
 
2427
    :param exists: A callable returning True if the path parameter exists.
 
2428
    """
 
2429
    counter = 1
 
2430
    name = "%s.~%d~" % (base, counter)
 
2431
    while exists(name):
 
2432
        counter += 1
 
2433
        name = "%s.~%d~" % (base, counter)
 
2434
    return name
 
2435
 
 
2436
 
 
2437
def set_fd_cloexec(fd):
 
2438
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
 
2439
    support for this is not available.
 
2440
    """
 
2441
    try:
 
2442
        import fcntl
 
2443
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
 
2444
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
 
2445
    except (ImportError, AttributeError):
 
2446
        # Either the fcntl module or specific constants are not present
 
2447
        pass
 
2448
 
 
2449
 
 
2450
def find_executable_on_path(name):
 
2451
    """Finds an executable on the PATH.
 
2452
    
 
2453
    On Windows, this will try to append each extension in the PATHEXT
 
2454
    environment variable to the name, if it cannot be found with the name
 
2455
    as given.
 
2456
    
 
2457
    :param name: The base name of the executable.
 
2458
    :return: The path to the executable found or None.
 
2459
    """
 
2460
    if sys.platform == 'win32':
 
2461
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
 
2462
        exts = [ext.lower() for ext in exts]
 
2463
        base, ext = os.path.splitext(name)
 
2464
        if ext != '':
 
2465
            if ext.lower() not in exts:
 
2466
                return None
 
2467
            name = base
 
2468
            exts = [ext]
 
2469
    else:
 
2470
        exts = ['']
 
2471
    path = os.environ.get('PATH')
 
2472
    if path is not None:
 
2473
        path = path.split(os.pathsep)
 
2474
        for ext in exts:
 
2475
            for d in path:
 
2476
                f = os.path.join(d, name) + ext
 
2477
                if os.access(f, os.X_OK):
 
2478
                    return f
 
2479
    if sys.platform == 'win32':
 
2480
        app_path = win32utils.get_app_path(name)
 
2481
        if app_path != name:
 
2482
            return app_path
 
2483
    return None
 
2484
 
 
2485
 
 
2486
def _posix_is_local_pid_dead(pid):
 
2487
    """True if pid doesn't correspond to live process on this machine"""
 
2488
    try:
 
2489
        # Special meaning of unix kill: just check if it's there.
 
2490
        os.kill(pid, 0)
 
2491
    except OSError as e:
 
2492
        if e.errno == errno.ESRCH:
 
2493
            # On this machine, and really not found: as sure as we can be
 
2494
            # that it's dead.
 
2495
            return True
 
2496
        elif e.errno == errno.EPERM:
 
2497
            # exists, though not ours
 
2498
            return False
 
2499
        else:
 
2500
            mutter("os.kill(%d, 0) failed: %s" % (pid, e))
 
2501
            # Don't really know.
 
2502
            return False
 
2503
    else:
 
2504
        # Exists and our process: not dead.
 
2505
        return False
 
2506
 
 
2507
if sys.platform == "win32":
 
2508
    is_local_pid_dead = win32utils.is_local_pid_dead
 
2509
else:
 
2510
    is_local_pid_dead = _posix_is_local_pid_dead
 
2511
 
 
2512
_maybe_ignored = ['EAGAIN', 'EINTR', 'ENOTSUP', 'EOPNOTSUPP', 'EACCES']
 
2513
_fdatasync_ignored = [getattr(errno, name) for name in _maybe_ignored
 
2514
                      if getattr(errno, name, None) is not None]
 
2515
 
 
2516
 
 
2517
def fdatasync(fileno):
 
2518
    """Flush file contents to disk if possible.
 
2519
    
 
2520
    :param fileno: Integer OS file handle.
 
2521
    :raises TransportNotPossible: If flushing to disk is not possible.
 
2522
    """
 
2523
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
 
2524
    if fn is not None:
 
2525
        try:
 
2526
            fn(fileno)
 
2527
        except IOError as e:
 
2528
            # See bug #1075108, on some platforms fdatasync exists, but can
 
2529
            # raise ENOTSUP. However, we are calling fdatasync to be helpful
 
2530
            # and reduce the chance of corruption-on-powerloss situations. It
 
2531
            # is not a mandatory call, so it is ok to suppress failures.
 
2532
            trace.mutter("ignoring error calling fdatasync: %s" % (e,))
 
2533
            if getattr(e, 'errno', None) not in _fdatasync_ignored:
 
2534
                raise
 
2535
 
 
2536
 
 
2537
def ensure_empty_directory_exists(path, exception_class):
 
2538
    """Make sure a local directory exists and is empty.
 
2539
    
 
2540
    If it does not exist, it is created.  If it exists and is not empty, an
 
2541
    instance of exception_class is raised.
 
2542
    """
 
2543
    try:
 
2544
        os.mkdir(path)
 
2545
    except OSError as e:
 
2546
        if e.errno != errno.EEXIST:
 
2547
            raise
 
2548
        if os.listdir(path) != []:
 
2549
            raise exception_class(path)
 
2550
 
 
2551
 
 
2552
def is_environment_error(evalue):
 
2553
    """True if exception instance is due to a process environment issue
 
2554
 
 
2555
    This includes OSError and IOError, but also other errors that come from
 
2556
    the operating system or core libraries but are not subclasses of those.
 
2557
    """
 
2558
    if isinstance(evalue, (EnvironmentError, select.error)):
 
2559
        return True
 
2560
    if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
 
2561
        return True
 
2562
    return False