/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

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

Show diffs side-by-side

added added

removed removed

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