/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-02-18 21:42:57 UTC
  • mto: This revision was merged to the branch mainline in revision 6859.
  • Revision ID: jelmer@jelmer.uk-20180218214257-jpevutp1wa30tz3v
Update TODO to reference Breezy, not Bazaar.

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
30
import getpass
30
 
from ntpath import (abspath as _nt_abspath,
31
 
                    join as _nt_join,
32
 
                    normpath as _nt_normpath,
33
 
                    realpath as _nt_realpath,
34
 
                    splitdrive as _nt_splitdrive,
35
 
                    )
 
31
import locale
 
32
import ntpath
36
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
37
37
import shutil
38
 
from shutil import (
39
 
    rmtree,
40
 
    )
 
38
from shutil import rmtree
41
39
import socket
42
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
43
43
import tempfile
44
 
from tempfile import (
45
 
    mkdtemp,
46
 
    )
 
44
from tempfile import mkdtemp
47
45
import unicodedata
48
46
 
49
 
from bzrlib import (
50
 
    cache_utf8,
51
 
    errors,
 
47
from breezy import (
 
48
    config,
52
49
    trace,
53
50
    win32utils,
54
51
    )
 
52
from breezy.i18n import gettext
55
53
""")
56
54
 
57
 
from bzrlib.symbol_versioning import (
58
 
    deprecated_function,
59
 
    deprecated_in,
60
 
    )
61
 
 
62
 
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
63
 
# of 2.5
64
 
if sys.version_info < (2, 5):
65
 
    import md5 as _mod_md5
66
 
    md5 = _mod_md5.new
67
 
    import sha as _mod_sha
68
 
    sha = _mod_sha.new
69
 
else:
70
 
    from hashlib import (
71
 
        md5,
72
 
        sha1 as sha,
73
 
        )
74
 
 
75
 
 
76
 
import bzrlib
77
 
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
    )
78
71
 
79
72
 
80
73
# Cross platform wall-clock time functionality with decent resolution.
97
90
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
98
91
 
99
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
 
100
102
def get_unicode_argv():
 
103
    if PY3:
 
104
        return sys.argv[1:]
101
105
    try:
102
106
        user_encoding = get_user_encoding()
103
107
        return [a.decode(user_encoding) for a in sys.argv[1:]]
104
108
    except UnicodeDecodeError:
105
 
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
106
 
                                                            "encoding." % a))
 
109
        raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
 
110
            "application locale.").format(a, user_encoding))
107
111
 
108
112
 
109
113
def make_readonly(filename):
110
114
    """Make a filename read-only."""
111
115
    mod = os.lstat(filename).st_mode
112
116
    if not stat.S_ISLNK(mod):
113
 
        mod = mod & 0777555
114
 
        os.chmod(filename, mod)
 
117
        mod = mod & 0o777555
 
118
        chmod_if_possible(filename, mod)
115
119
 
116
120
 
117
121
def make_writable(filename):
118
122
    mod = os.lstat(filename).st_mode
119
123
    if not stat.S_ISLNK(mod):
120
 
        mod = mod | 0200
121
 
        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
122
145
 
123
146
 
124
147
def minimum_path_selection(paths):
199
222
            stat = getattr(os, 'lstat', os.stat)
200
223
            stat(f)
201
224
            return True
202
 
        except OSError, e:
 
225
        except OSError as e:
203
226
            if e.errno == errno.ENOENT:
204
227
                return False;
205
228
            else:
206
 
                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))
207
230
 
208
231
 
209
232
def fancy_rename(old, new, rename_func, unlink_func):
233
256
    file_existed = False
234
257
    try:
235
258
        rename_func(new, tmp_name)
236
 
    except (errors.NoSuchFile,), e:
 
259
    except (errors.NoSuchFile,) as e:
237
260
        pass
238
 
    except IOError, e:
 
261
    except IOError as e:
239
262
        # RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
240
263
        # function raises an IOError with errno is None when a rename fails.
241
264
        # This then gets caught here.
242
265
        if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
243
266
            raise
244
 
    except Exception, e:
 
267
    except Exception as e:
245
268
        if (getattr(e, 'errno', None) is None
246
269
            or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
247
270
            raise
248
271
    else:
249
272
        file_existed = True
250
273
 
251
 
    failure_exc = None
252
274
    success = False
253
275
    try:
254
 
        try:
255
 
            # This may throw an exception, in which case success will
256
 
            # not be set.
257
 
            rename_func(old, new)
258
 
            success = True
259
 
        except (IOError, OSError), e:
260
 
            # source and target may be aliases of each other (e.g. on a
261
 
            # case-insensitive filesystem), so we may have accidentally renamed
262
 
            # source by when we tried to rename target
263
 
            failure_exc = sys.exc_info()
264
 
            if (file_existed and e.errno in (None, errno.ENOENT)
265
 
                and old.lower() == new.lower()):
266
 
                # source and target are the same file on a case-insensitive
267
 
                # filesystem, so we don't generate an exception
268
 
                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
269
291
    finally:
270
292
        if file_existed:
271
293
            # If the file used to exist, rename it back into place
274
296
                unlink_func(tmp_name)
275
297
            else:
276
298
                rename_func(tmp_name, new)
277
 
    if failure_exc is not None:
278
 
        raise failure_exc[0], failure_exc[1], failure_exc[2]
279
299
 
280
300
 
281
301
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
282
302
# choke on a Unicode string containing a relative path if
283
303
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
284
304
# string.
285
 
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
286
305
def _posix_abspath(path):
287
306
    # jam 20060426 rather than encoding to fsencoding
288
307
    # copy posixpath.abspath, but use os.getcwdu instead
289
308
    if not posixpath.isabs(path):
290
309
        path = posixpath.join(getcwd(), path)
291
 
    return posixpath.normpath(path)
 
310
    return _posix_normpath(path)
292
311
 
293
312
 
294
313
def _posix_realpath(path):
295
314
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
296
315
 
297
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
 
298
372
def _win32_fixdrive(path):
299
373
    """Force drive letters to be consistent.
300
374
 
304
378
    running python.exe under cmd.exe return capital C:\\
305
379
    running win32 python inside a cygwin shell returns lowercase c:\\
306
380
    """
307
 
    drive, path = _nt_splitdrive(path)
 
381
    drive, path = ntpath.splitdrive(path)
308
382
    return drive.upper() + path
309
383
 
310
384
 
311
385
def _win32_abspath(path):
312
 
    # Real _nt_abspath doesn't have a problem with a unicode cwd
313
 
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
314
 
 
315
 
 
316
 
def _win98_abspath(path):
317
 
    """Return the absolute version of a path.
318
 
    Windows 98 safe implementation (python reimplementation
319
 
    of Win32 API function GetFullPathNameW)
320
 
    """
321
 
    # Corner cases:
322
 
    #   C:\path     => C:/path
323
 
    #   C:/path     => C:/path
324
 
    #   \\HOST\path => //HOST/path
325
 
    #   //HOST/path => //HOST/path
326
 
    #   path        => C:/cwd/path
327
 
    #   /path       => C:/path
328
 
    path = unicode(path)
329
 
    # check for absolute path
330
 
    drive = _nt_splitdrive(path)[0]
331
 
    if drive == '' and path[:2] not in('//','\\\\'):
332
 
        cwd = os.getcwdu()
333
 
        # we cannot simply os.path.join cwd and path
334
 
        # because os.path.join('C:','/path') produce '/path'
335
 
        # and this is incorrect
336
 
        if path[:1] in ('/','\\'):
337
 
            cwd = _nt_splitdrive(cwd)[0]
338
 
            path = path[1:]
339
 
        path = cwd + '\\' + path
340
 
    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(unicode(path)).replace('\\', '/'))
341
388
 
342
389
 
343
390
def _win32_realpath(path):
344
 
    # Real _nt_realpath doesn't have a problem with a unicode cwd
345
 
    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(unicode(path)).replace('\\', '/'))
346
393
 
347
394
 
348
395
def _win32_pathjoin(*args):
349
 
    return _nt_join(*args).replace('\\', '/')
 
396
    return ntpath.join(*args).replace('\\', '/')
350
397
 
351
398
 
352
399
def _win32_normpath(path):
353
 
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
400
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
354
401
 
355
402
 
356
403
def _win32_getcwd():
357
 
    return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
 
404
    return _win32_fixdrive(_getcwd().replace('\\', '/'))
358
405
 
359
406
 
360
407
def _win32_mkdtemp(*args, **kwargs):
361
408
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
362
409
 
363
410
 
364
 
def _add_rename_error_details(e, old, new):
365
 
    new_e = OSError(e.errno, "failed to rename %s to %s: %s"
366
 
        % (old, new, e.strerror))
367
 
    new_e.filename = old
368
 
    new_e.to_filename = new
369
 
    return new_e
370
 
 
371
 
 
372
411
def _win32_rename(old, new):
373
412
    """We expect to be able to atomically replace 'new' with old.
374
413
 
376
415
    and then deleted.
377
416
    """
378
417
    try:
379
 
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
380
 
    except OSError, e:
 
418
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
 
419
    except OSError as e:
381
420
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
382
421
            # If we try to rename a non-existant file onto cwd, we get
383
422
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT
387
426
        raise
388
427
 
389
428
 
390
 
def _wrapped_rename(old, new):
391
 
    """Rename a file or directory"""
392
 
    try:
393
 
        os.rename(old, new)
394
 
    except (IOError, OSError), e:
395
 
        # this is eventually called by all rename-like functions, so should 
396
 
        # catch all of them
397
 
        raise _add_rename_error_details(e, old, new)
398
 
 
399
 
 
400
429
def _mac_getcwd():
401
 
    return unicodedata.normalize('NFC', os.getcwdu())
402
 
 
 
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)
403
462
 
404
463
# Default is to just use the python builtins, but these can be rebound on
405
464
# particular platforms.
406
465
abspath = _posix_abspath
407
466
realpath = _posix_realpath
408
467
pathjoin = os.path.join
409
 
normpath = os.path.normpath
410
 
rename = _wrapped_rename # overridden below on win32
411
 
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
412
473
dirname = os.path.dirname
413
474
basename = os.path.basename
414
475
split = os.path.split
415
476
splitext = os.path.splitext
416
 
# These were already imported into local scope
 
477
# These were already lazily imported into local scope
417
478
# mkdtemp = tempfile.mkdtemp
418
479
# rmtree = shutil.rmtree
 
480
lstat = os.lstat
 
481
fstat = os.fstat
 
482
 
 
483
def wrap_stat(st):
 
484
    return st
 
485
 
419
486
 
420
487
MIN_ABS_PATHLENGTH = 1
421
488
 
422
489
 
423
490
if sys.platform == 'win32':
424
 
    if win32utils.winver == 'Windows 98':
425
 
        abspath = _win98_abspath
426
 
    else:
427
 
        abspath = _win32_abspath
 
491
    abspath = _win32_abspath
428
492
    realpath = _win32_realpath
429
493
    pathjoin = _win32_pathjoin
430
494
    normpath = _win32_normpath
431
495
    getcwd = _win32_getcwd
432
496
    mkdtemp = _win32_mkdtemp
433
 
    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
434
506
 
435
507
    MIN_ABS_PATHLENGTH = 3
436
508
 
454
526
    f = win32utils.get_unicode_argv     # special function or None
455
527
    if f is not None:
456
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
457
532
 
458
533
elif sys.platform == 'darwin':
459
534
    getcwd = _mac_getcwd
460
535
 
461
536
 
462
 
def get_terminal_encoding():
 
537
def get_terminal_encoding(trace=False):
463
538
    """Find the best encoding for printing to the screen.
464
539
 
465
540
    This attempts to check both sys.stdout and sys.stdin to see
471
546
 
472
547
    On my standard US Windows XP, the preferred encoding is
473
548
    cp1252, but the console is cp437
 
549
 
 
550
    :param trace: If True trace the selected encoding via mutter().
474
551
    """
475
 
    from bzrlib.trace import mutter
 
552
    from .trace import mutter
476
553
    output_encoding = getattr(sys.stdout, 'encoding', None)
477
554
    if not output_encoding:
478
555
        input_encoding = getattr(sys.stdin, 'encoding', None)
479
556
        if not input_encoding:
480
557
            output_encoding = get_user_encoding()
481
 
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
558
            if trace:
 
559
                mutter('encoding stdout as osutils.get_user_encoding() %r',
482
560
                   output_encoding)
483
561
        else:
484
562
            output_encoding = input_encoding
485
 
            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)
486
566
    else:
487
 
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
567
        if trace:
 
568
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
488
569
    if output_encoding == 'cp0':
489
570
        # invalid encoding (cp0 means 'no codepage' on Windows)
490
571
        output_encoding = get_user_encoding()
491
 
        mutter('cp0 is invalid encoding.'
 
572
        if trace:
 
573
            mutter('cp0 is invalid encoding.'
492
574
               ' encoding stdout as osutils.get_user_encoding() %r',
493
575
               output_encoding)
494
576
    # check encoding
495
577
    try:
496
578
        codecs.lookup(output_encoding)
497
579
    except LookupError:
498
 
        sys.stderr.write('bzr: warning:'
 
580
        sys.stderr.write('brz: warning:'
499
581
                         ' unknown terminal encoding %s.\n'
500
582
                         '  Using encoding %s instead.\n'
501
583
                         % (output_encoding, get_user_encoding())
510
592
        F = realpath
511
593
    else:
512
594
        F = abspath
513
 
    [p,e] = os.path.split(f)
 
595
    [p, e] = os.path.split(f)
514
596
    if e == "" or e == "." or e == "..":
515
597
        return F(f)
516
598
    else:
520
602
def isdir(f):
521
603
    """True if f is an accessible directory."""
522
604
    try:
523
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
605
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
524
606
    except OSError:
525
607
        return False
526
608
 
528
610
def isfile(f):
529
611
    """True if f is a regular file."""
530
612
    try:
531
 
        return S_ISREG(os.lstat(f)[ST_MODE])
 
613
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
532
614
    except OSError:
533
615
        return False
534
616
 
535
617
def islink(f):
536
618
    """True if f is a symlink."""
537
619
    try:
538
 
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
620
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
539
621
    except OSError:
540
622
        return False
541
623
 
638
720
    # drives).
639
721
    if not segment_size:
640
722
        segment_size = 5242880 # 5MB
641
 
    segments = range(len(bytes) / segment_size + 1)
 
723
    offsets = range(0, len(bytes), segment_size)
 
724
    view = memoryview(bytes)
642
725
    write = file_handle.write
643
 
    for segment_index in segments:
644
 
        segment = buffer(bytes, segment_index * segment_size, segment_size)
645
 
        write(segment)
 
726
    for offset in offsets:
 
727
        write(view[offset:offset+segment_size])
646
728
 
647
729
 
648
730
def file_iterator(input_file, readsize=32768):
653
735
        yield b
654
736
 
655
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
 
656
748
def sha_file(f):
657
749
    """Calculate the hexdigest of an open file.
658
750
 
665
757
        if not b:
666
758
            break
667
759
        s.update(b)
668
 
    return s.hexdigest()
 
760
    return _hexdigest(s)
669
761
 
670
762
 
671
763
def size_sha_file(f):
683
775
            break
684
776
        size += len(b)
685
777
        s.update(b)
686
 
    return size, s.hexdigest()
 
778
    return size, _hexdigest(s)
687
779
 
688
780
 
689
781
def sha_file_by_name(fname):
694
786
        while True:
695
787
            b = os.read(f, 1<<16)
696
788
            if not b:
697
 
                return s.hexdigest()
 
789
                return _hexdigest(s)
698
790
            s.update(b)
699
791
    finally:
700
792
        os.close(f)
703
795
def sha_strings(strings, _factory=sha):
704
796
    """Return the sha-1 of concatenation of strings"""
705
797
    s = _factory()
706
 
    map(s.update, strings)
707
 
    return s.hexdigest()
 
798
    for string in strings:
 
799
        s.update(string)
 
800
    return _hexdigest(s)
708
801
 
709
802
 
710
803
def sha_string(f, _factory=sha):
711
 
    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))
712
806
 
713
807
 
714
808
def fingerprint_file(f):
715
809
    b = f.read()
716
810
    return {'size': len(b),
717
 
            'sha1': sha(b).hexdigest()}
 
811
            'sha1': _hexdigest(sha(b))}
718
812
 
719
813
 
720
814
def compare_files(a, b):
799
893
    (date_fmt, tt, offset_str) = \
800
894
               _format_date(t, offset, timezone, date_fmt, show_offset)
801
895
    date_str = time.strftime(date_fmt, tt)
802
 
    if not isinstance(date_str, unicode):
 
896
    if not isinstance(date_str, text_type):
803
897
        date_str = date_str.decode(get_user_encoding(), 'replace')
804
898
    return date_str + offset_str
805
899
 
816
910
        tt = time.localtime(t)
817
911
        offset = local_time_offset(t)
818
912
    else:
819
 
        raise errors.UnsupportedTimezoneFormat(timezone)
 
913
        raise UnsupportedTimezoneFormat(timezone)
820
914
    if date_fmt is None:
821
915
        date_fmt = "%a %Y-%m-%d %H:%M:%S"
822
916
    if show_offset:
881
975
 
882
976
def filesize(f):
883
977
    """Return size of given open file."""
884
 
    return os.fstat(f.fileno())[ST_SIZE]
885
 
 
886
 
 
887
 
# Define rand_bytes based on platform.
888
 
try:
889
 
    # Python 2.4 and later have os.urandom,
890
 
    # but it doesn't work on some arches
891
 
    os.urandom(1)
892
 
    rand_bytes = os.urandom
893
 
except (NotImplementedError, AttributeError):
894
 
    # If python doesn't have os.urandom, or it doesn't work,
895
 
    # 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":
896
988
    try:
897
 
        rand_bytes = file('/dev/urandom', 'rb').read
898
 
    # Otherwise, use this hack as a last resort
899
 
    except (IOError, OSError):
 
989
        rand_bytes(1)
 
990
    except NotImplementedError:
900
991
        # not well seeded, but better than nothing
901
992
        def rand_bytes(n):
902
993
            import random
916
1007
    """
917
1008
    s = ''
918
1009
    for raw_byte in rand_bytes(num):
919
 
        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]
920
1014
    return s
921
1015
 
922
1016
 
932
1026
    rps = []
933
1027
    for f in ps:
934
1028
        if f == '..':
935
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1029
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
936
1030
        elif (f == '.') or (f == ''):
937
1031
            pass
938
1032
        else:
943
1037
def joinpath(p):
944
1038
    for f in p:
945
1039
        if (f == '..') or (f is None) or (f == ''):
946
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1040
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
947
1041
    return pathjoin(*p)
948
1042
 
949
1043
 
950
1044
def parent_directories(filename):
951
1045
    """Return the list of parent directories, deepest first.
952
 
    
 
1046
 
953
1047
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
954
1048
    """
955
1049
    parents = []
971
1065
    implementation should be loaded instead::
972
1066
 
973
1067
    >>> try:
974
 
    >>>     import bzrlib._fictional_extension_pyx
 
1068
    >>>     import breezy._fictional_extension_pyx
975
1069
    >>> except ImportError, e:
976
 
    >>>     bzrlib.osutils.failed_to_load_extension(e)
977
 
    >>>     import bzrlib._fictional_extension_py
 
1070
    >>>     breezy.osutils.failed_to_load_extension(e)
 
1071
    >>>     import breezy._fictional_extension_py
978
1072
    """
979
1073
    # NB: This docstring is just an example, not a doctest, because doctest
980
1074
    # currently can't cope with the use of lazy imports in this namespace --
981
1075
    # mbp 20090729
982
 
    
 
1076
 
983
1077
    # This currently doesn't report the failure at the time it occurs, because
984
1078
    # they tend to happen very early in startup when we can't check config
985
1079
    # files etc, and also we want to report all failures but not spam the user
986
1080
    # with 10 warnings.
987
 
    from bzrlib import trace
988
1081
    exception_str = str(exception)
989
1082
    if exception_str not in _extension_load_failures:
990
1083
        trace.mutter("failed to load compiled extension: %s" % exception_str)
994
1087
def report_extension_load_failures():
995
1088
    if not _extension_load_failures:
996
1089
        return
997
 
    from bzrlib.config import GlobalConfig
998
 
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
 
1090
    if config.GlobalConfig().suppress_warning('missing_extensions'):
999
1091
        return
1000
1092
    # the warnings framework should by default show this only once
1001
 
    from bzrlib.trace import warning
 
1093
    from .trace import warning
1002
1094
    warning(
1003
 
        "bzr: warning: some compiled extensions could not be loaded; "
1004
 
        "see <https://answers.launchpad.net/bzr/+faq/703>")
 
1095
        "brz: warning: some compiled extensions could not be loaded; "
 
1096
        "see ``brz help missing-extensions``")
1005
1097
    # we no longer show the specific missing extensions here, because it makes
1006
1098
    # the message too long and scary - see
1007
1099
    # https://bugs.launchpad.net/bzr/+bug/430529
1008
1100
 
1009
1101
 
1010
1102
try:
1011
 
    from bzrlib._chunks_to_lines_pyx import chunks_to_lines
1012
 
except ImportError, e:
 
1103
    from ._chunks_to_lines_pyx import chunks_to_lines
 
1104
except ImportError as e:
1013
1105
    failed_to_load_extension(e)
1014
 
    from bzrlib._chunks_to_lines_py import chunks_to_lines
 
1106
    from ._chunks_to_lines_py import chunks_to_lines
1015
1107
 
1016
1108
 
1017
1109
def split_lines(s):
1030
1122
 
1031
1123
    This supports Unicode or plain string objects.
1032
1124
    """
1033
 
    lines = s.split('\n')
1034
 
    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]]
1035
1128
    if lines[-1]:
1036
1129
        result.append(lines[-1])
1037
1130
    return result
1048
1141
        return
1049
1142
    try:
1050
1143
        os.link(src, dest)
1051
 
    except (OSError, IOError), e:
 
1144
    except (OSError, IOError) as e:
1052
1145
        if e.errno != errno.EXDEV:
1053
1146
            raise
1054
1147
        shutil.copyfile(src, dest)
1055
1148
 
1056
1149
 
1057
1150
def delete_any(path):
1058
 
    """Delete a file, symlink or directory.  
1059
 
    
 
1151
    """Delete a file, symlink or directory.
 
1152
 
1060
1153
    Will delete even if readonly.
1061
1154
    """
1062
1155
    try:
1063
1156
       _delete_file_or_dir(path)
1064
 
    except (OSError, IOError), e:
 
1157
    except (OSError, IOError) as e:
1065
1158
        if e.errno in (errno.EPERM, errno.EACCES):
1066
1159
            # make writable and try again
1067
1160
            try:
1127
1220
    #    separators
1128
1221
    # 3) '\xa0' isn't unicode safe since it is >128.
1129
1222
 
1130
 
    # This should *not* be a unicode set of characters in case the source
1131
 
    # string is not a Unicode string. We can auto-up-cast the characters since
1132
 
    # they are ascii, but we don't want to auto-up-cast the string in case it
1133
 
    # is utf-8
1134
 
    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:
1135
1228
        if ch in s:
1136
1229
            return True
1137
1230
    else:
1163
1256
 
1164
1257
    if len(base) < MIN_ABS_PATHLENGTH:
1165
1258
        # must have space for e.g. a drive letter
1166
 
        raise ValueError('%r is too short to calculate a relative path'
 
1259
        raise ValueError(gettext('%r is too short to calculate a relative path')
1167
1260
            % (base,))
1168
1261
 
1169
1262
    rp = abspath(path)
1251
1344
    # but for now, we haven't optimized...
1252
1345
    return [canonical_relpath(base, p) for p in paths]
1253
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
 
1254
1363
def safe_unicode(unicode_or_utf8_string):
1255
1364
    """Coerce unicode_or_utf8_string into unicode.
1256
1365
 
1258
1367
    Otherwise it is decoded from utf-8. If decoding fails, the exception is
1259
1368
    wrapped in a BzrBadParameterNotUnicode exception.
1260
1369
    """
1261
 
    if isinstance(unicode_or_utf8_string, unicode):
 
1370
    if isinstance(unicode_or_utf8_string, text_type):
1262
1371
        return unicode_or_utf8_string
1263
1372
    try:
1264
1373
        return unicode_or_utf8_string.decode('utf8')
1272
1381
    If it is a str, it is returned.
1273
1382
    If it is Unicode, it is encoded into a utf-8 string.
1274
1383
    """
1275
 
    if isinstance(unicode_or_utf8_string, str):
 
1384
    if isinstance(unicode_or_utf8_string, bytes):
1276
1385
        # TODO: jam 20070209 This is overkill, and probably has an impact on
1277
1386
        #       performance if we are dealing with lots of apis that want a
1278
1387
        #       utf-8 revision id
1285
1394
    return unicode_or_utf8_string.encode('utf-8')
1286
1395
 
1287
1396
 
1288
 
_revision_id_warning = ('Unicode revision ids were deprecated in bzr 0.15.'
1289
 
                        ' Revision id generators should be creating utf8'
1290
 
                        ' revision ids.')
1291
 
 
1292
 
 
1293
 
def safe_revision_id(unicode_or_utf8_string, warn=True):
 
1397
def safe_revision_id(unicode_or_utf8_string):
1294
1398
    """Revision ids should now be utf8, but at one point they were unicode.
1295
1399
 
1296
1400
    :param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
1297
1401
        utf8 or None).
1298
 
    :param warn: Functions that are sanitizing user data can set warn=False
1299
1402
    :return: None or a utf8 revision id.
1300
1403
    """
1301
1404
    if (unicode_or_utf8_string is None
1302
 
        or unicode_or_utf8_string.__class__ == str):
 
1405
        or unicode_or_utf8_string.__class__ == bytes):
1303
1406
        return unicode_or_utf8_string
1304
 
    if warn:
1305
 
        symbol_versioning.warn(_revision_id_warning, DeprecationWarning,
1306
 
                               stacklevel=2)
1307
 
    return cache_utf8.encode(unicode_or_utf8_string)
1308
 
 
1309
 
 
1310
 
_file_id_warning = ('Unicode file ids were deprecated in bzr 0.15. File id'
1311
 
                    ' generators should be creating utf8 file ids.')
1312
 
 
1313
 
 
1314
 
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):
1315
1413
    """File ids should now be utf8, but at one point they were unicode.
1316
1414
 
1317
1415
    This is the same as safe_utf8, except it uses the cached encode functions
1319
1417
 
1320
1418
    :param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
1321
1419
        utf8 or None).
1322
 
    :param warn: Functions that are sanitizing user data can set warn=False
1323
1420
    :return: None or a utf8 file id.
1324
1421
    """
1325
1422
    if (unicode_or_utf8_string is None
1326
 
        or unicode_or_utf8_string.__class__ == str):
 
1423
        or unicode_or_utf8_string.__class__ == bytes):
1327
1424
        return unicode_or_utf8_string
1328
 
    if warn:
1329
 
        symbol_versioning.warn(_file_id_warning, DeprecationWarning,
1330
 
                               stacklevel=2)
1331
 
    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.')
1332
1427
 
1333
1428
 
1334
1429
_platform_normalizes_filenames = False
1339
1434
def normalizes_filenames():
1340
1435
    """Return True if this platform normalizes unicode filenames.
1341
1436
 
1342
 
    Mac OSX does, Windows/Linux do not.
 
1437
    Only Mac OSX.
1343
1438
    """
1344
1439
    return _platform_normalizes_filenames
1345
1440
 
1350
1445
    On platforms where the system normalizes filenames (Mac OSX),
1351
1446
    you can access a file by any path which will normalize correctly.
1352
1447
    On platforms where the system does not normalize filenames
1353
 
    (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.
1354
1449
 
1355
1450
    Internally, bzr only supports NFC normalization, since that is
1356
1451
    the standard for XML documents.
1359
1454
    can be accessed by that path.
1360
1455
    """
1361
1456
 
1362
 
    return unicodedata.normalize('NFC', unicode(path)), True
 
1457
    return unicodedata.normalize('NFC', text_type(path)), True
1363
1458
 
1364
1459
 
1365
1460
def _inaccessible_normalized_filename(path):
1366
1461
    __doc__ = _accessible_normalized_filename.__doc__
1367
1462
 
1368
 
    normalized = unicodedata.normalize('NFC', unicode(path))
 
1463
    normalized = unicodedata.normalize('NFC', text_type(path))
1369
1464
    return normalized, normalized == path
1370
1465
 
1371
1466
 
1418
1513
terminal_width() returns None.
1419
1514
"""
1420
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
1421
1522
 
1422
1523
def terminal_width():
1423
1524
    """Return terminal width.
1425
1526
    None is returned if the width can't established precisely.
1426
1527
 
1427
1528
    The rules are:
1428
 
    - if BZR_COLUMNS is set, returns its value
 
1529
    - if BRZ_COLUMNS is set, returns its value
1429
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,
1430
1533
    - if COLUMNS is set, returns its value,
 
1534
    - if the OS has a value (even though it's never changed), return its value.
1431
1535
 
1432
1536
    From there, we need to query the OS to get the size of the controlling
1433
1537
    terminal.
1434
1538
 
1435
 
    Unices:
 
1539
    On Unices we query the OS by:
1436
1540
    - get termios.TIOCGWINSZ
1437
1541
    - if an error occurs or a negative value is obtained, returns None
1438
1542
 
1439
 
    Windows:
1440
 
    
 
1543
    On Windows we query the OS by:
1441
1544
    - win32utils.get_console_size() decides,
1442
1545
    - returns None on error (provided default value)
1443
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.
1444
1559
 
1445
 
    # 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
1446
1562
    try:
1447
 
        return int(os.environ['BZR_COLUMNS'])
 
1563
        width = int(os.environ['BRZ_COLUMNS'])
1448
1564
    except (KeyError, ValueError):
1449
 
        pass
 
1565
        width = None
 
1566
    if width is not None:
 
1567
        if width > 0:
 
1568
            return width
 
1569
        else:
 
1570
            return None
1450
1571
 
1451
1572
    isatty = getattr(sys.stdout, 'isatty', None)
1452
 
    if  isatty is None or not isatty():
1453
 
        # 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.
1454
1575
        return None
1455
1576
 
1456
 
    # If COLUMNS is set, take it, the terminal knows better (even inside a
1457
 
    # given terminal, the application can decide to set COLUMNS to a lower
1458
 
    # 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.
1459
1594
    try:
1460
1595
        return int(os.environ['COLUMNS'])
1461
1596
    except (KeyError, ValueError):
1462
1597
        pass
1463
1598
 
1464
 
    width, height = _terminal_size(None, None)
1465
 
    if width <= 0:
1466
 
        # Consider invalid values as meaning no width
1467
 
        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
1468
1603
 
1469
 
    return width
 
1604
    # The width could not be determined.
 
1605
    return None
1470
1606
 
1471
1607
 
1472
1608
def _win32_terminal_size(width, height):
1499
1635
    _terminal_size = _ioctl_terminal_size
1500
1636
 
1501
1637
 
1502
 
def _terminal_size_changed(signum, frame):
1503
 
    """Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
1504
 
    width, height = _terminal_size(None, None)
1505
 
    if width is not None:
1506
 
        os.environ['COLUMNS'] = str(width)
1507
 
 
1508
 
 
1509
 
_registered_sigwinch = False
1510
 
def watch_sigwinch():
1511
 
    """Register for SIGWINCH, once and only once.
1512
 
 
1513
 
    Do nothing if the signal module is not available.
1514
 
    """
1515
 
    global _registered_sigwinch
1516
 
    if not _registered_sigwinch:
1517
 
        try:
1518
 
            import signal
1519
 
            if getattr(signal, "SIGWINCH", None) is not None:
1520
 
                set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
1521
 
        except ImportError:
1522
 
            # python doesn't provide signal support, nothing we can do about it
1523
 
            pass
1524
 
        _registered_sigwinch = True
1525
 
 
1526
 
 
1527
1638
def supports_executable():
1528
1639
    return sys.platform != "win32"
1529
1640
 
1554
1665
        if orig_val is not None:
1555
1666
            del os.environ[env_variable]
1556
1667
    else:
1557
 
        if isinstance(value, unicode):
 
1668
        if not PY3 and isinstance(value, text_type):
1558
1669
            value = value.encode(get_user_encoding())
1559
1670
        os.environ[env_variable] = value
1560
1671
    return orig_val
1652
1763
        dirblock = []
1653
1764
        append = dirblock.append
1654
1765
        try:
1655
 
            names = sorted(_listdir(top))
1656
 
        except OSError, e:
 
1766
            names = sorted(map(decode_filename, _listdir(top)))
 
1767
        except OSError as e:
1657
1768
            if not _is_error_enotdir(e):
1658
1769
                raise
1659
1770
        else:
1712
1823
    """
1713
1824
    global _selected_dir_reader
1714
1825
    if _selected_dir_reader is None:
1715
 
        fs_encoding = _fs_enc.upper()
1716
 
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1717
 
            # Win98 doesn't have unicode apis like FindFirstFileW
1718
 
            # TODO: We possibly could support Win98 by falling back to the
1719
 
            #       original FindFirstFile, and using TCHAR instead of WCHAR,
1720
 
            #       but that gets a bit tricky, and requires custom compiling
1721
 
            #       for win98 anyway.
 
1826
        if sys.platform == "win32":
1722
1827
            try:
1723
 
                from bzrlib._walkdirs_win32 import Win32ReadDir
 
1828
                from ._walkdirs_win32 import Win32ReadDir
1724
1829
                _selected_dir_reader = Win32ReadDir()
1725
1830
            except ImportError:
1726
1831
                pass
1727
 
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1728
 
            # ANSI_X3.4-1968 is a form of ASCII
 
1832
        elif _fs_enc in ('utf-8', 'ascii'):
1729
1833
            try:
1730
 
                from bzrlib._readdir_pyx import UTF8DirReader
 
1834
                from ._readdir_pyx import UTF8DirReader
1731
1835
                _selected_dir_reader = UTF8DirReader()
1732
 
            except ImportError, e:
 
1836
            except ImportError as e:
1733
1837
                failed_to_load_extension(e)
1734
1838
                pass
1735
1839
 
1785
1889
        _kind_from_mode = file_kind_from_stat_mode
1786
1890
 
1787
1891
        if prefix:
1788
 
            relprefix = prefix + '/'
 
1892
            relprefix = prefix + b'/'
1789
1893
        else:
1790
 
            relprefix = ''
1791
 
        top_slash = top + u'/'
 
1894
            relprefix = b''
 
1895
        top_slash = top + '/'
1792
1896
 
1793
1897
        dirblock = []
1794
1898
        append = dirblock.append
1833
1937
        link_to = os.readlink(source)
1834
1938
        os.symlink(link_to, dest)
1835
1939
 
1836
 
    real_handlers = {'file':shutil.copy2,
1837
 
                     'symlink':copy_link,
1838
 
                     'directory':copy_dir,
 
1940
    real_handlers = {'file': shutil.copy2,
 
1941
                     'symlink': copy_link,
 
1942
                     'directory': copy_dir,
1839
1943
                    }
1840
1944
    real_handlers.update(handlers)
1841
1945
 
1865
1969
    try:
1866
1970
        s = os.stat(src)
1867
1971
        chown(dst, s.st_uid, s.st_gid)
1868
 
    except OSError, e:
1869
 
        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()
1870
1977
 
1871
1978
 
1872
1979
def path_prefix_key(path):
1874
1981
 
1875
1982
    This can be used to sort paths in the same way that walkdirs does.
1876
1983
    """
1877
 
    return (dirname(path) , path)
 
1984
    return (dirname(path), path)
1878
1985
 
1879
1986
 
1880
1987
def compare_paths_prefix_order(path_a, path_b):
1887
1994
_cached_user_encoding = None
1888
1995
 
1889
1996
 
1890
 
def get_user_encoding(use_cache=True):
 
1997
def get_user_encoding():
1891
1998
    """Find out what the preferred user encoding is.
1892
1999
 
1893
2000
    This is generally the encoding that is used for command line parameters
1894
2001
    and file contents. This may be different from the terminal encoding
1895
2002
    or the filesystem encoding.
1896
2003
 
1897
 
    :param  use_cache:  Enable cache for detected encoding.
1898
 
                        (This parameter is turned on by default,
1899
 
                        and required only for selftesting)
1900
 
 
1901
2004
    :return: A string defining the preferred user encoding
1902
2005
    """
1903
2006
    global _cached_user_encoding
1904
 
    if _cached_user_encoding is not None and use_cache:
 
2007
    if _cached_user_encoding is not None:
1905
2008
        return _cached_user_encoding
1906
2009
 
1907
 
    if sys.platform == 'darwin':
1908
 
        # python locale.getpreferredencoding() always return
1909
 
        # 'mac-roman' on darwin. That's a lie.
1910
 
        sys.platform = 'posix'
1911
 
        try:
1912
 
            if os.environ.get('LANG', None) is None:
1913
 
                # If LANG is not set, we end up with 'ascii', which is bad
1914
 
                # ('mac-roman' is more than ascii), so we set a default which
1915
 
                # will give us UTF-8 (which appears to work in all cases on
1916
 
                # OSX). Users are still free to override LANG of course, as
1917
 
                # long as it give us something meaningful. This work-around
1918
 
                # *may* not be needed with python 3k and/or OSX 10.5, but will
1919
 
                # work with them too -- vila 20080908
1920
 
                os.environ['LANG'] = 'en_US.UTF-8'
1921
 
            import locale
1922
 
        finally:
1923
 
            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)
1924
2016
    else:
1925
 
        import locale
 
2017
        # GZ 2011-12-19: On windows could call GetACP directly instead.
 
2018
        user_encoding = locale.getpreferredencoding(False)
1926
2019
 
1927
2020
    try:
1928
 
        user_encoding = locale.getpreferredencoding()
1929
 
    except locale.Error, e:
1930
 
        sys.stderr.write('bzr: warning: %s\n'
1931
 
                         '  Could not determine what text encoding to use.\n'
1932
 
                         '  This error usually means your Python interpreter\n'
1933
 
                         '  doesn\'t support the locale set by $LANG (%s)\n'
1934
 
                         "  Continuing with ascii encoding.\n"
1935
 
                         % (e, os.environ.get('LANG')))
1936
 
        user_encoding = 'ascii'
1937
 
 
1938
 
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
1939
 
    # treat that as ASCII, and not support printing unicode characters to the
1940
 
    # console.
1941
 
    #
1942
 
    # For python scripts run under vim, we get '', so also treat that as ASCII
1943
 
    if user_encoding in (None, 'cp0', ''):
1944
 
        user_encoding = 'ascii'
1945
 
    else:
1946
 
        # check encoding
1947
 
        try:
1948
 
            codecs.lookup(user_encoding)
1949
 
        except LookupError:
1950
 
            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:'
1951
2025
                             ' unknown encoding %s.'
1952
2026
                             ' Continuing with ascii encoding.\n'
1953
2027
                             % user_encoding
1954
2028
                            )
1955
 
            user_encoding = 'ascii'
1956
 
 
1957
 
    if use_cache:
1958
 
        _cached_user_encoding = user_encoding
1959
 
 
 
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
1960
2041
    return user_encoding
1961
2042
 
1962
2043
 
 
2044
def get_diff_header_encoding():
 
2045
    return get_terminal_encoding()
 
2046
 
 
2047
 
1963
2048
def get_host_name():
1964
2049
    """Return the current unicode host name.
1965
2050
 
1967
2052
    behaves inconsistently on different platforms.
1968
2053
    """
1969
2054
    if sys.platform == "win32":
1970
 
        import win32utils
1971
2055
        return win32utils.get_host_name()
1972
2056
    else:
1973
2057
        import socket
 
2058
        if PY3:
 
2059
            return socket.gethostname()
1974
2060
        return socket.gethostname().decode(get_user_encoding())
1975
2061
 
1976
2062
 
1980
2066
# data at once.
1981
2067
MAX_SOCKET_CHUNK = 64 * 1024
1982
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
 
1983
2077
def read_bytes_from_socket(sock, report_activity=None,
1984
2078
        max_read_size=MAX_SOCKET_CHUNK):
1985
2079
    """Read up to max_read_size of bytes from sock and notify of progress.
1988
2082
    empty string rather than raise an error), and repeats the recv if
1989
2083
    interrupted by a signal.
1990
2084
    """
1991
 
    while 1:
 
2085
    while True:
1992
2086
        try:
1993
2087
            bytes = sock.recv(max_read_size)
1994
 
        except socket.error, e:
 
2088
        except socket.error as e:
1995
2089
            eno = e.args[0]
1996
 
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
 
2090
            if eno in _end_of_stream_errors:
1997
2091
                # The connection was closed by the other side.  Callers expect
1998
2092
                # an empty string to signal end-of-stream.
1999
2093
                return ""
2028
2122
 
2029
2123
def send_all(sock, bytes, report_activity=None):
2030
2124
    """Send all bytes on a socket.
2031
 
 
 
2125
 
2032
2126
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2033
2127
    some platforms, and catches EINTR which may be thrown if the send is
2034
2128
    interrupted by a signal.
2035
2129
 
2036
2130
    This is preferred to socket.sendall(), because it avoids portability bugs
2037
2131
    and provides activity reporting.
2038
 
 
 
2132
 
2039
2133
    :param report_activity: Call this as bytes are read, see
2040
2134
        Transport._report_activity
2041
2135
    """
2042
2136
    sent_total = 0
2043
2137
    byte_count = len(bytes)
 
2138
    view = memoryview(bytes)
2044
2139
    while sent_total < byte_count:
2045
2140
        try:
2046
 
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2047
 
        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)
2048
2146
            if e.args[0] != errno.EINTR:
2049
2147
                raise
2050
2148
        else:
 
2149
            if sent == 0:
 
2150
                raise errors.ConnectionReset('Sending to %s returned 0 bytes'
 
2151
                                             % (sock,))
2051
2152
            sent_total += sent
2052
 
            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
2053
2178
 
2054
2179
 
2055
2180
def dereference_path(path):
2074
2199
def resource_string(package, resource_name):
2075
2200
    """Load a resource from a package and return it as a string.
2076
2201
 
2077
 
    Note: Only packages that start with bzrlib are currently supported.
 
2202
    Note: Only packages that start with breezy are currently supported.
2078
2203
 
2079
2204
    This is designed to be a lightweight implementation of resource
2080
2205
    loading in a way which is API compatible with the same API from
2083
2208
    If and when pkg_resources becomes a standard library, this routine
2084
2209
    can delegate to it.
2085
2210
    """
2086
 
    # Check package name is within bzrlib
2087
 
    if package == "bzrlib":
 
2211
    # Check package name is within breezy
 
2212
    if package == "breezy":
2088
2213
        resource_relpath = resource_name
2089
 
    elif package.startswith("bzrlib."):
2090
 
        package = package[len("bzrlib."):].replace('.', os.sep)
 
2214
    elif package.startswith("breezy."):
 
2215
        package = package[len("breezy."):].replace('.', os.sep)
2091
2216
        resource_relpath = pathjoin(package, resource_name)
2092
2217
    else:
2093
 
        raise errors.BzrError('resource package %s not in bzrlib' % package)
 
2218
        raise errors.BzrError('resource package %s not in breezy' % package)
2094
2219
 
2095
2220
    # Map the resource to a file and read its contents
2096
 
    base = dirname(bzrlib.__file__)
 
2221
    base = dirname(breezy.__file__)
2097
2222
    if getattr(sys, 'frozen', None):    # bzr.exe
2098
2223
        base = abspath(pathjoin(base, '..', '..'))
2099
 
    filename = pathjoin(base, resource_relpath)
2100
 
    return open(filename, 'rU').read()
2101
 
 
 
2224
    f = file(pathjoin(base, resource_relpath), "rU")
 
2225
    try:
 
2226
        return f.read()
 
2227
    finally:
 
2228
        f.close()
2102
2229
 
2103
2230
def file_kind_from_stat_mode_thunk(mode):
2104
2231
    global file_kind_from_stat_mode
2105
2232
    if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
2106
2233
        try:
2107
 
            from bzrlib._readdir_pyx import UTF8DirReader
 
2234
            from ._readdir_pyx import UTF8DirReader
2108
2235
            file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2109
 
        except ImportError, e:
 
2236
        except ImportError as e:
2110
2237
            # This is one time where we won't warn that an extension failed to
2111
2238
            # load. The extension is never available on Windows anyway.
2112
 
            from bzrlib._readdir_py import (
 
2239
            from ._readdir_py import (
2113
2240
                _kind_from_mode as file_kind_from_stat_mode
2114
2241
                )
2115
2242
    return file_kind_from_stat_mode(mode)
2116
2243
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2117
2244
 
2118
 
 
2119
 
def file_kind(f, _lstat=os.lstat):
 
2245
def file_stat(f, _lstat=os.lstat):
2120
2246
    try:
2121
 
        return file_kind_from_stat_mode(_lstat(f).st_mode)
2122
 
    except OSError, e:
 
2247
        # XXX cache?
 
2248
        return _lstat(f)
 
2249
    except OSError as e:
2123
2250
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2124
2251
            raise errors.NoSuchFile(f)
2125
2252
        raise
2126
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)
2127
2257
 
2128
2258
def until_no_eintr(f, *a, **kw):
2129
2259
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2130
 
    
 
2260
 
2131
2261
    WARNING: you must be certain that it is safe to retry the call repeatedly
2132
2262
    if EINTR does occur.  This is typically only true for low-level operations
2133
2263
    like os.read.  If in any doubt, don't use this.
2135
2265
    Keep in mind that this is not a complete solution to EINTR.  There is
2136
2266
    probably code in the Python standard library and other dependencies that
2137
2267
    may encounter EINTR if a signal arrives (and there is signal handler for
2138
 
    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
2139
2269
    directly controls, but it is not a complete solution.
2140
2270
    """
2141
2271
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
2142
2272
    while True:
2143
2273
        try:
2144
2274
            return f(*a, **kw)
2145
 
        except (IOError, OSError), e:
 
2275
        except (IOError, OSError) as e:
2146
2276
            if e.errno == errno.EINTR:
2147
2277
                continue
2148
2278
            raise
2149
2279
 
2150
2280
 
2151
 
def re_compile_checked(re_string, flags=0, where=""):
2152
 
    """Return a compiled re, or raise a sensible error.
2153
 
 
2154
 
    This should only be used when compiling user-supplied REs.
2155
 
 
2156
 
    :param re_string: Text form of regular expression.
2157
 
    :param flags: eg re.IGNORECASE
2158
 
    :param where: Message explaining to the user the context where
2159
 
        it occurred, eg 'log search filter'.
2160
 
    """
2161
 
    # from https://bugs.launchpad.net/bzr/+bug/251352
2162
 
    try:
2163
 
        re_obj = re.compile(re_string, flags)
2164
 
        re_obj.search("")
2165
 
        return re_obj
2166
 
    except re.error, e:
2167
 
        if where:
2168
 
            where = ' in ' + where
2169
 
        # despite the name 'error' is a type
2170
 
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2171
 
            % (where, re_string, e))
2172
 
 
2173
 
 
2174
2281
if sys.platform == "win32":
2175
 
    import msvcrt
2176
2282
    def getchar():
 
2283
        import msvcrt
2177
2284
        return msvcrt.getch()
2178
2285
else:
2179
 
    import tty
2180
 
    import termios
2181
2286
    def getchar():
 
2287
        import tty
 
2288
        import termios
2182
2289
        fd = sys.stdin.fileno()
2183
2290
        settings = termios.tcgetattr(fd)
2184
2291
        try:
2188
2295
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2189
2296
        return ch
2190
2297
 
2191
 
 
2192
 
if sys.platform == 'linux2':
 
2298
if sys.platform.startswith('linux'):
2193
2299
    def _local_concurrency():
2194
 
        concurrency = None
2195
 
        prefix = 'processor'
2196
 
        for line in file('/proc/cpuinfo', 'rb'):
2197
 
            if line.startswith(prefix):
2198
 
                concurrency = int(line[line.find(':')+1:]) + 1
2199
 
        return concurrency
 
2300
        try:
 
2301
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2302
        except (ValueError, OSError, AttributeError):
 
2303
            return None
2200
2304
elif sys.platform == 'darwin':
2201
2305
    def _local_concurrency():
2202
2306
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2203
2307
                                stdout=subprocess.PIPE).communicate()[0]
2204
 
elif sys.platform[0:7] == 'freebsd':
 
2308
elif "bsd" in sys.platform:
2205
2309
    def _local_concurrency():
2206
2310
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2207
2311
                                stdout=subprocess.PIPE).communicate()[0]
2232
2336
    if _cached_local_concurrency is not None and use_cache:
2233
2337
        return _cached_local_concurrency
2234
2338
 
2235
 
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
 
2339
    concurrency = os.environ.get('BRZ_CONCURRENCY', None)
2236
2340
    if concurrency is None:
 
2341
        import multiprocessing
2237
2342
        try:
2238
 
            concurrency = _local_concurrency()
2239
 
        except (OSError, IOError):
2240
 
            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
2241
2350
    try:
2242
2351
        concurrency = int(concurrency)
2243
2352
    except (TypeError, ValueError):
2255
2364
        self.encode = encode
2256
2365
 
2257
2366
    def write(self, object):
2258
 
        if type(object) is str:
 
2367
        if isinstance(object, str):
2259
2368
            self.stream.write(object)
2260
2369
        else:
2261
2370
            data, _ = self.encode(object, self.errors)
2264
2373
if sys.platform == 'win32':
2265
2374
    def open_file(filename, mode='r', bufsize=-1):
2266
2375
        """This function is used to override the ``open`` builtin.
2267
 
        
 
2376
 
2268
2377
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2269
2378
        child processes.  Deleting or renaming a closed file opened with this
2270
2379
        function is not blocking child processes.
2305
2414
    open_file = open
2306
2415
 
2307
2416
 
2308
 
def getuser_unicode():
2309
 
    """Return the username as unicode.
2310
 
    """
2311
 
    try:
2312
 
        user_encoding = get_user_encoding()
2313
 
        username = getpass.getuser().decode(user_encoding)
2314
 
    except UnicodeDecodeError:
2315
 
        raise errors.BzrError("Can't decode username as %s." % \
2316
 
                user_encoding)
2317
 
    return username
 
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