/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: Canonical.com Patch Queue Manager
  • Date: 2010-04-06 06:59:03 UTC
  • mfrom: (5051.5.1 subunit)
  • Revision ID: pqm@pqm.ubuntu.com-20100406065903-y9dxgwmog1pmw7dz
Use subunit when running tests in PQM.

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,
 
21
                  S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
23
22
import sys
24
23
import time
25
24
import codecs
 
25
import warnings
26
26
 
27
 
from .lazy_import import lazy_import
 
27
from bzrlib.lazy_import import lazy_import
28
28
lazy_import(globals(), """
29
29
from datetime import datetime
30
 
import getpass
31
 
import locale
32
 
import ntpath
 
30
import errno
 
31
from ntpath import (abspath as _nt_abspath,
 
32
                    join as _nt_join,
 
33
                    normpath as _nt_normpath,
 
34
                    realpath as _nt_realpath,
 
35
                    splitdrive as _nt_splitdrive,
 
36
                    )
33
37
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
38
import shutil
38
 
from shutil import rmtree
 
39
from shutil import (
 
40
    rmtree,
 
41
    )
 
42
import signal
39
43
import socket
40
44
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
45
import tempfile
44
 
from tempfile import mkdtemp
 
46
from tempfile import (
 
47
    mkdtemp,
 
48
    )
45
49
import unicodedata
46
50
 
47
 
from breezy import (
48
 
    config,
 
51
from bzrlib import (
 
52
    cache_utf8,
 
53
    errors,
49
54
    trace,
50
55
    win32utils,
51
56
    )
52
 
from breezy.i18n import gettext
53
57
""")
54
58
 
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
 
    )
71
 
 
 
59
from bzrlib.symbol_versioning import (
 
60
    deprecated_function,
 
61
    deprecated_in,
 
62
    )
 
63
 
 
64
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
 
65
# of 2.5
 
66
if sys.version_info < (2, 5):
 
67
    import md5 as _mod_md5
 
68
    md5 = _mod_md5.new
 
69
    import sha as _mod_sha
 
70
    sha = _mod_sha.new
 
71
else:
 
72
    from hashlib import (
 
73
        md5,
 
74
        sha1 as sha,
 
75
        )
 
76
 
 
77
 
 
78
import bzrlib
 
79
from bzrlib import symbol_versioning
 
80
 
 
81
 
 
82
# Cross platform wall-clock time functionality with decent resolution.
 
83
# On Linux ``time.clock`` returns only CPU time. On Windows, ``time.time()``
 
84
# only has a resolution of ~15ms. Note that ``time.clock()`` is not
 
85
# synchronized with ``time.time()``, this is only meant to be used to find
 
86
# delta times by subtracting from another call to this function.
 
87
timer_func = time.time
 
88
if sys.platform == 'win32':
 
89
    timer_func = time.clock
72
90
 
73
91
# On win32, O_BINARY is used to indicate the file should
74
92
# be opened in binary mode, rather than text mode.
81
99
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
82
100
 
83
101
 
84
 
class UnsupportedTimezoneFormat(errors.BzrError):
85
 
 
86
 
    _fmt = ('Unsupported timezone format "%(timezone)s", '
87
 
            'options are "utc", "original", "local".')
88
 
 
89
 
    def __init__(self, timezone):
90
 
        self.timezone = timezone
91
 
 
92
 
 
93
102
def get_unicode_argv():
94
 
    if PY3:
95
 
        return sys.argv[1:]
96
103
    try:
97
104
        user_encoding = get_user_encoding()
98
105
        return [a.decode(user_encoding) for a in sys.argv[1:]]
99
106
    except UnicodeDecodeError:
100
 
        raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
101
 
                                      "application locale.").format(a, user_encoding))
 
107
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
 
108
                                                            "encoding." % a))
102
109
 
103
110
 
104
111
def make_readonly(filename):
105
112
    """Make a filename read-only."""
106
113
    mod = os.lstat(filename).st_mode
107
114
    if not stat.S_ISLNK(mod):
108
 
        mod = mod & 0o777555
109
 
        chmod_if_possible(filename, mod)
 
115
        mod = mod & 0777555
 
116
        os.chmod(filename, mod)
110
117
 
111
118
 
112
119
def make_writable(filename):
113
120
    mod = os.lstat(filename).st_mode
114
121
    if not stat.S_ISLNK(mod):
115
 
        mod = mod | 0o200
116
 
        chmod_if_possible(filename, mod)
117
 
 
118
 
 
119
 
def chmod_if_possible(filename, mode):
120
 
    # Set file mode if that can be safely done.
121
 
    # Sometimes even on unix the filesystem won't allow it - see
122
 
    # https://bugs.launchpad.net/bzr/+bug/606537
123
 
    try:
124
 
        # It is probably faster to just do the chmod, rather than
125
 
        # doing a stat, and then trying to compare
126
 
        os.chmod(filename, mode)
127
 
    except (IOError, OSError) as e:
128
 
        # Permission/access denied seems to commonly happen on smbfs; there's
129
 
        # probably no point warning about it.
130
 
        # <https://bugs.launchpad.net/bzr/+bug/606537>
131
 
        if getattr(e, 'errno') in (errno.EPERM, errno.EACCES):
132
 
            trace.mutter("ignore error on chmod of %r: %r" % (
133
 
                filename, e))
134
 
            return
135
 
        raise
 
122
        mod = mod | 0200
 
123
        os.chmod(filename, mod)
136
124
 
137
125
 
138
126
def minimum_path_selection(paths):
146
134
        return set(paths)
147
135
 
148
136
    def sort_key(path):
149
 
        if isinstance(path, bytes):
150
 
            return path.split(b'/')
151
 
        else:
152
 
            return path.split('/')
 
137
        return path.split('/')
153
138
    sorted_paths = sorted(list(paths), key=sort_key)
154
139
 
155
140
    search_paths = [sorted_paths[0]]
182
167
 
183
168
_directory_kind = 'directory'
184
169
 
185
 
 
186
170
def get_umask():
187
171
    """Return the current umask"""
188
172
    # Assume that people aren't messing with the umask while running
217
201
            stat = getattr(os, 'lstat', os.stat)
218
202
            stat(f)
219
203
            return True
220
 
        except OSError as e:
 
204
        except OSError, e:
221
205
            if e.errno == errno.ENOENT:
222
 
                return False
 
206
                return False;
223
207
            else:
224
 
                raise errors.BzrError(
225
 
                    gettext("lstat/stat of ({0!r}): {1!r}").format(f, e))
 
208
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
226
209
 
227
210
 
228
211
def fancy_rename(old, new, rename_func, unlink_func):
252
235
    file_existed = False
253
236
    try:
254
237
        rename_func(new, tmp_name)
255
 
    except (errors.NoSuchFile,):
 
238
    except (errors.NoSuchFile,), e:
256
239
        pass
257
 
    except IOError as e:
 
240
    except IOError, e:
258
241
        # RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
259
242
        # function raises an IOError with errno is None when a rename fails.
260
243
        # This then gets caught here.
261
244
        if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
262
245
            raise
263
 
    except Exception as e:
 
246
    except Exception, e:
264
247
        if (getattr(e, 'errno', None) is None
265
 
                or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
 
248
            or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
266
249
            raise
267
250
    else:
268
251
        file_existed = True
269
252
 
 
253
    failure_exc = None
270
254
    success = False
271
255
    try:
272
 
        # This may throw an exception, in which case success will
273
 
        # not be set.
274
 
        rename_func(old, new)
275
 
        success = True
276
 
    except (IOError, OSError) as e:
277
 
        # source and target may be aliases of each other (e.g. on a
278
 
        # case-insensitive filesystem), so we may have accidentally renamed
279
 
        # source by when we tried to rename target
280
 
        if (file_existed and e.errno in (None, errno.ENOENT)
 
256
        try:
 
257
            # This may throw an exception, in which case success will
 
258
            # not be set.
 
259
            rename_func(old, new)
 
260
            success = True
 
261
        except (IOError, OSError), e:
 
262
            # source and target may be aliases of each other (e.g. on a
 
263
            # case-insensitive filesystem), so we may have accidentally renamed
 
264
            # source by when we tried to rename target
 
265
            failure_exc = sys.exc_info()
 
266
            if (file_existed and e.errno in (None, errno.ENOENT)
281
267
                and old.lower() == new.lower()):
282
 
            # source and target are the same file on a case-insensitive
283
 
            # filesystem, so we don't generate an exception
284
 
            pass
285
 
        else:
286
 
            raise
 
268
                # source and target are the same file on a case-insensitive
 
269
                # filesystem, so we don't generate an exception
 
270
                failure_exc = None
287
271
    finally:
288
272
        if file_existed:
289
273
            # If the file used to exist, rename it back into place
292
276
                unlink_func(tmp_name)
293
277
            else:
294
278
                rename_func(tmp_name, new)
 
279
    if failure_exc is not None:
 
280
        raise failure_exc[0], failure_exc[1], failure_exc[2]
295
281
 
296
282
 
297
283
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
298
284
# choke on a Unicode string containing a relative path if
299
285
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
300
286
# string.
 
287
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
301
288
def _posix_abspath(path):
302
289
    # jam 20060426 rather than encoding to fsencoding
303
290
    # copy posixpath.abspath, but use os.getcwdu instead
304
291
    if not posixpath.isabs(path):
305
292
        path = posixpath.join(getcwd(), path)
306
 
    return _posix_normpath(path)
 
293
    return posixpath.normpath(path)
307
294
 
308
295
 
309
296
def _posix_realpath(path):
310
297
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
311
298
 
312
299
 
313
 
def _posix_normpath(path):
314
 
    path = posixpath.normpath(path)
315
 
    # Bug 861008: posixpath.normpath() returns a path normalized according to
316
 
    # the POSIX standard, which stipulates (for compatibility reasons) that two
317
 
    # leading slashes must not be simplified to one, and only if there are 3 or
318
 
    # more should they be simplified as one. So we treat the leading 2 slashes
319
 
    # as a special case here by simply removing the first slash, as we consider
320
 
    # that breaking POSIX compatibility for this obscure feature is acceptable.
321
 
    # This is not a paranoid precaution, as we notably get paths like this when
322
 
    # the repo is hosted at the root of the filesystem, i.e. in "/".
323
 
    if path.startswith('//'):
324
 
        path = path[1:]
325
 
    return path
326
 
 
327
 
 
328
 
def _posix_path_from_environ(key):
329
 
    """Get unicode path from `key` in environment or None if not present
330
 
 
331
 
    Note that posix systems use arbitrary byte strings for filesystem objects,
332
 
    so a path that raises BadFilenameEncoding here may still be accessible.
333
 
    """
334
 
    val = os.environ.get(key, None)
335
 
    if PY3 or val is None:
336
 
        return val
337
 
    try:
338
 
        return val.decode(_fs_enc)
339
 
    except UnicodeDecodeError:
340
 
        # GZ 2011-12-12:Ideally want to include `key` in the exception message
341
 
        raise errors.BadFilenameEncoding(val, _fs_enc)
342
 
 
343
 
 
344
 
def _posix_get_home_dir():
345
 
    """Get the home directory of the current user as a unicode path"""
346
 
    path = posixpath.expanduser("~")
347
 
    try:
348
 
        return path.decode(_fs_enc)
349
 
    except AttributeError:
350
 
        return path
351
 
    except UnicodeDecodeError:
352
 
        raise errors.BadFilenameEncoding(path, _fs_enc)
353
 
 
354
 
 
355
 
def _posix_getuser_unicode():
356
 
    """Get username from environment or password database as unicode"""
357
 
    name = getpass.getuser()
358
 
    if PY3:
359
 
        return name
360
 
    user_encoding = get_user_encoding()
361
 
    try:
362
 
        return name.decode(user_encoding)
363
 
    except UnicodeDecodeError:
364
 
        raise errors.BzrError("Encoding of username %r is unsupported by %s "
365
 
                              "application locale." % (name, user_encoding))
366
 
 
367
 
 
368
300
def _win32_fixdrive(path):
369
301
    """Force drive letters to be consistent.
370
302
 
374
306
    running python.exe under cmd.exe return capital C:\\
375
307
    running win32 python inside a cygwin shell returns lowercase c:\\
376
308
    """
377
 
    drive, path = ntpath.splitdrive(path)
 
309
    drive, path = _nt_splitdrive(path)
378
310
    return drive.upper() + path
379
311
 
380
312
 
381
313
def _win32_abspath(path):
382
 
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
383
 
    return _win32_fixdrive(ntpath.abspath(path).replace('\\', '/'))
 
314
    # Real _nt_abspath doesn't have a problem with a unicode cwd
 
315
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
 
316
 
 
317
 
 
318
def _win98_abspath(path):
 
319
    """Return the absolute version of a path.
 
320
    Windows 98 safe implementation (python reimplementation
 
321
    of Win32 API function GetFullPathNameW)
 
322
    """
 
323
    # Corner cases:
 
324
    #   C:\path     => C:/path
 
325
    #   C:/path     => C:/path
 
326
    #   \\HOST\path => //HOST/path
 
327
    #   //HOST/path => //HOST/path
 
328
    #   path        => C:/cwd/path
 
329
    #   /path       => C:/path
 
330
    path = unicode(path)
 
331
    # check for absolute path
 
332
    drive = _nt_splitdrive(path)[0]
 
333
    if drive == '' and path[:2] not in('//','\\\\'):
 
334
        cwd = os.getcwdu()
 
335
        # we cannot simply os.path.join cwd and path
 
336
        # because os.path.join('C:','/path') produce '/path'
 
337
        # and this is incorrect
 
338
        if path[:1] in ('/','\\'):
 
339
            cwd = _nt_splitdrive(cwd)[0]
 
340
            path = path[1:]
 
341
        path = cwd + '\\' + path
 
342
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
384
343
 
385
344
 
386
345
def _win32_realpath(path):
387
 
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
388
 
    return _win32_fixdrive(ntpath.realpath(path).replace('\\', '/'))
 
346
    # Real _nt_realpath doesn't have a problem with a unicode cwd
 
347
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
389
348
 
390
349
 
391
350
def _win32_pathjoin(*args):
392
 
    return ntpath.join(*args).replace('\\', '/')
 
351
    return _nt_join(*args).replace('\\', '/')
393
352
 
394
353
 
395
354
def _win32_normpath(path):
396
 
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
 
355
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
397
356
 
398
357
 
399
358
def _win32_getcwd():
400
 
    return _win32_fixdrive(_getcwd().replace('\\', '/'))
 
359
    return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
401
360
 
402
361
 
403
362
def _win32_mkdtemp(*args, **kwargs):
412
371
    """
413
372
    try:
414
373
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
415
 
    except OSError as e:
 
374
    except OSError, e:
416
375
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
417
376
            # If we try to rename a non-existant file onto cwd, we get
418
377
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT
423
382
 
424
383
 
425
384
def _mac_getcwd():
426
 
    return unicodedata.normalize('NFC', _getcwd())
427
 
 
428
 
 
429
 
def _rename_wrap_exception(rename_func):
430
 
    """Adds extra information to any exceptions that come from rename().
431
 
 
432
 
    The exception has an updated message and 'old_filename' and 'new_filename'
433
 
    attributes.
434
 
    """
435
 
 
436
 
    def _rename_wrapper(old, new):
437
 
        try:
438
 
            rename_func(old, new)
439
 
        except OSError as e:
440
 
            detailed_error = OSError(e.errno, e.strerror +
441
 
                                     " [occurred when renaming '%s' to '%s']" %
442
 
                                     (old, new))
443
 
            detailed_error.old_filename = old
444
 
            detailed_error.new_filename = new
445
 
            raise detailed_error
446
 
 
447
 
    return _rename_wrapper
448
 
 
449
 
 
450
 
if sys.version_info > (3,):
451
 
    _getcwd = os.getcwd
452
 
else:
453
 
    _getcwd = os.getcwdu
454
 
 
455
 
 
456
 
# Default rename wraps os.rename()
457
 
rename = _rename_wrap_exception(os.rename)
 
385
    return unicodedata.normalize('NFC', os.getcwdu())
 
386
 
458
387
 
459
388
# Default is to just use the python builtins, but these can be rebound on
460
389
# particular platforms.
461
390
abspath = _posix_abspath
462
391
realpath = _posix_realpath
463
392
pathjoin = os.path.join
464
 
normpath = _posix_normpath
465
 
path_from_environ = _posix_path_from_environ
466
 
_get_home_dir = _posix_get_home_dir
467
 
getuser_unicode = _posix_getuser_unicode
468
 
getcwd = _getcwd
 
393
normpath = os.path.normpath
 
394
getcwd = os.getcwdu
 
395
rename = os.rename
469
396
dirname = os.path.dirname
470
397
basename = os.path.basename
471
398
split = os.path.split
472
399
splitext = os.path.splitext
473
 
# These were already lazily imported into local scope
 
400
# These were already imported into local scope
474
401
# mkdtemp = tempfile.mkdtemp
475
402
# rmtree = shutil.rmtree
476
 
lstat = os.lstat
477
 
fstat = os.fstat
478
 
 
479
 
 
480
 
def wrap_stat(st):
481
 
    return st
482
 
 
483
403
 
484
404
MIN_ABS_PATHLENGTH = 1
485
405
 
486
406
 
487
407
if sys.platform == 'win32':
488
 
    abspath = _win32_abspath
 
408
    if win32utils.winver == 'Windows 98':
 
409
        abspath = _win98_abspath
 
410
    else:
 
411
        abspath = _win32_abspath
489
412
    realpath = _win32_realpath
490
413
    pathjoin = _win32_pathjoin
491
414
    normpath = _win32_normpath
492
415
    getcwd = _win32_getcwd
493
416
    mkdtemp = _win32_mkdtemp
494
 
    rename = _rename_wrap_exception(_win32_rename)
495
 
    try:
496
 
        from . import _walkdirs_win32
497
 
    except ImportError:
498
 
        pass
499
 
    else:
500
 
        lstat = _walkdirs_win32.lstat
501
 
        fstat = _walkdirs_win32.fstat
502
 
        wrap_stat = _walkdirs_win32.wrap_stat
 
417
    rename = _win32_rename
503
418
 
504
419
    MIN_ABS_PATHLENGTH = 3
505
420
 
509
424
        """
510
425
        exception = excinfo[1]
511
426
        if function in (os.remove, os.rmdir) \
512
 
                and isinstance(exception, OSError) \
513
 
                and exception.errno == errno.EACCES:
 
427
            and isinstance(exception, OSError) \
 
428
            and exception.errno == errno.EACCES:
514
429
            make_writable(path)
515
430
            function(path)
516
431
        else:
520
435
        """Replacer for shutil.rmtree: could remove readonly dirs/files"""
521
436
        return shutil.rmtree(path, ignore_errors, onerror)
522
437
 
523
 
    get_unicode_argv = getattr(win32utils, 'get_unicode_argv', get_unicode_argv)
524
 
    path_from_environ = win32utils.get_environ_unicode
525
 
    _get_home_dir = win32utils.get_home_location
526
 
    getuser_unicode = win32utils.get_user_name
 
438
    f = win32utils.get_unicode_argv     # special function or None
 
439
    if f is not None:
 
440
        get_unicode_argv = f
527
441
 
528
442
elif sys.platform == 'darwin':
529
443
    getcwd = _mac_getcwd
530
444
 
531
445
 
532
 
def get_terminal_encoding(trace=False):
 
446
def get_terminal_encoding():
533
447
    """Find the best encoding for printing to the screen.
534
448
 
535
449
    This attempts to check both sys.stdout and sys.stdin to see
541
455
 
542
456
    On my standard US Windows XP, the preferred encoding is
543
457
    cp1252, but the console is cp437
544
 
 
545
 
    :param trace: If True trace the selected encoding via mutter().
546
458
    """
547
 
    from .trace import mutter
 
459
    from bzrlib.trace import mutter
548
460
    output_encoding = getattr(sys.stdout, 'encoding', None)
549
461
    if not output_encoding:
550
462
        input_encoding = getattr(sys.stdin, 'encoding', None)
551
463
        if not input_encoding:
552
464
            output_encoding = get_user_encoding()
553
 
            if trace:
554
 
                mutter('encoding stdout as osutils.get_user_encoding() %r',
555
 
                       output_encoding)
 
465
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
466
                   output_encoding)
556
467
        else:
557
468
            output_encoding = input_encoding
558
 
            if trace:
559
 
                mutter('encoding stdout as sys.stdin encoding %r',
560
 
                       output_encoding)
 
469
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
561
470
    else:
562
 
        if trace:
563
 
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
471
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
564
472
    if output_encoding == 'cp0':
565
473
        # invalid encoding (cp0 means 'no codepage' on Windows)
566
474
        output_encoding = get_user_encoding()
567
 
        if trace:
568
 
            mutter('cp0 is invalid encoding.'
569
 
                   ' encoding stdout as osutils.get_user_encoding() %r',
570
 
                   output_encoding)
 
475
        mutter('cp0 is invalid encoding.'
 
476
               ' encoding stdout as osutils.get_user_encoding() %r',
 
477
               output_encoding)
571
478
    # check encoding
572
479
    try:
573
480
        codecs.lookup(output_encoding)
574
481
    except LookupError:
575
 
        sys.stderr.write('brz: warning:'
 
482
        sys.stderr.write('bzr: warning:'
576
483
                         ' unknown terminal encoding %s.\n'
577
484
                         '  Using encoding %s instead.\n'
578
485
                         % (output_encoding, get_user_encoding())
579
 
                         )
 
486
                        )
580
487
        output_encoding = get_user_encoding()
581
488
 
582
489
    return output_encoding
587
494
        F = realpath
588
495
    else:
589
496
        F = abspath
590
 
    [p, e] = os.path.split(f)
 
497
    [p,e] = os.path.split(f)
591
498
    if e == "" or e == "." or e == "..":
592
499
        return F(f)
593
500
    else:
597
504
def isdir(f):
598
505
    """True if f is an accessible directory."""
599
506
    try:
600
 
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
 
507
        return S_ISDIR(os.lstat(f)[ST_MODE])
601
508
    except OSError:
602
509
        return False
603
510
 
605
512
def isfile(f):
606
513
    """True if f is a regular file."""
607
514
    try:
608
 
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
 
515
        return S_ISREG(os.lstat(f)[ST_MODE])
609
516
    except OSError:
610
517
        return False
611
518
 
612
 
 
613
519
def islink(f):
614
520
    """True if f is a symlink."""
615
521
    try:
616
 
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
 
522
        return S_ISLNK(os.lstat(f)[ST_MODE])
617
523
    except OSError:
618
524
        return False
619
525
 
620
 
 
621
526
def is_inside(dir, fname):
622
527
    """True if fname is inside dir.
623
528
 
633
538
    if dir == fname:
634
539
        return True
635
540
 
636
 
    if dir in ('', b''):
 
541
    if dir == '':
637
542
        return True
638
543
 
639
 
    if isinstance(dir, bytes):
640
 
        if not dir.endswith(b'/'):
641
 
            dir += b'/'
642
 
    else:
643
 
        if not dir.endswith('/'):
644
 
            dir += '/'
 
544
    if dir[-1] != '/':
 
545
        dir += '/'
645
546
 
646
547
    return fname.startswith(dir)
647
548
 
720
621
    # writes fail on some platforms (e.g. Windows with SMB  mounted
721
622
    # drives).
722
623
    if not segment_size:
723
 
        segment_size = 5242880  # 5MB
724
 
    offsets = range(0, len(bytes), segment_size)
725
 
    view = memoryview(bytes)
 
624
        segment_size = 5242880 # 5MB
 
625
    segments = range(len(bytes) / segment_size + 1)
726
626
    write = file_handle.write
727
 
    for offset in offsets:
728
 
        write(view[offset:offset + segment_size])
 
627
    for segment_index in segments:
 
628
        segment = buffer(bytes, segment_index * segment_size, segment_size)
 
629
        write(segment)
729
630
 
730
631
 
731
632
def file_iterator(input_file, readsize=32768):
736
637
        yield b
737
638
 
738
639
 
739
 
# GZ 2017-09-16: Makes sense in general for hexdigest() result to be text, but
740
 
# used as bytes through most interfaces so encode with this wrapper.
741
 
if PY3:
742
 
    def _hexdigest(hashobj):
743
 
        return hashobj.hexdigest().encode()
744
 
else:
745
 
    def _hexdigest(hashobj):
746
 
        return hashobj.hexdigest()
747
 
 
748
 
 
749
640
def sha_file(f):
750
641
    """Calculate the hexdigest of an open file.
751
642
 
752
643
    The file cursor should be already at the start.
753
644
    """
754
645
    s = sha()
755
 
    BUFSIZE = 128 << 10
 
646
    BUFSIZE = 128<<10
756
647
    while True:
757
648
        b = f.read(BUFSIZE)
758
649
        if not b:
759
650
            break
760
651
        s.update(b)
761
 
    return _hexdigest(s)
 
652
    return s.hexdigest()
762
653
 
763
654
 
764
655
def size_sha_file(f):
769
660
    """
770
661
    size = 0
771
662
    s = sha()
772
 
    BUFSIZE = 128 << 10
 
663
    BUFSIZE = 128<<10
773
664
    while True:
774
665
        b = f.read(BUFSIZE)
775
666
        if not b:
776
667
            break
777
668
        size += len(b)
778
669
        s.update(b)
779
 
    return size, _hexdigest(s)
 
670
    return size, s.hexdigest()
780
671
 
781
672
 
782
673
def sha_file_by_name(fname):
785
676
    f = os.open(fname, os.O_RDONLY | O_BINARY | O_NOINHERIT)
786
677
    try:
787
678
        while True:
788
 
            b = os.read(f, 1 << 16)
 
679
            b = os.read(f, 1<<16)
789
680
            if not b:
790
 
                return _hexdigest(s)
 
681
                return s.hexdigest()
791
682
            s.update(b)
792
683
    finally:
793
684
        os.close(f)
796
687
def sha_strings(strings, _factory=sha):
797
688
    """Return the sha-1 of concatenation of strings"""
798
689
    s = _factory()
799
 
    for string in strings:
800
 
        s.update(string)
801
 
    return _hexdigest(s)
 
690
    map(s.update, strings)
 
691
    return s.hexdigest()
802
692
 
803
693
 
804
694
def sha_string(f, _factory=sha):
805
 
    # GZ 2017-09-16: Dodgy if factory is ever not sha, probably shouldn't be.
806
 
    return _hexdigest(_factory(f))
 
695
    return _factory(f).hexdigest()
807
696
 
808
697
 
809
698
def fingerprint_file(f):
810
699
    b = f.read()
811
700
    return {'size': len(b),
812
 
            'sha1': _hexdigest(sha(b))}
 
701
            'sha1': sha(b).hexdigest()}
813
702
 
814
703
 
815
704
def compare_files(a, b):
820
709
        bi = b.read(BUFSIZE)
821
710
        if ai != bi:
822
711
            return False
823
 
        if not ai:
 
712
        if ai == '':
824
713
            return True
825
714
 
826
715
 
831
720
    offset = datetime.fromtimestamp(t) - datetime.utcfromtimestamp(t)
832
721
    return offset.days * 86400 + offset.seconds
833
722
 
834
 
 
835
723
weekdays = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
836
724
_default_format_by_weekday_num = [wd + " %Y-%m-%d %H:%M:%S" for wd in weekdays]
837
725
 
849
737
    :param show_offset: Whether to append the timezone.
850
738
    """
851
739
    (date_fmt, tt, offset_str) = \
852
 
        _format_date(t, offset, timezone, date_fmt, show_offset)
 
740
               _format_date(t, offset, timezone, date_fmt, show_offset)
853
741
    date_fmt = date_fmt.replace('%a', weekdays[tt[6]])
854
742
    date_str = time.strftime(date_fmt, tt)
855
743
    return date_str + offset_str
860
748
 
861
749
 
862
750
def format_date_with_offset_in_original_timezone(t, offset=0,
863
 
                                                 _cache=_offset_cache):
 
751
    _cache=_offset_cache):
864
752
    """Return a formatted date string in the original timezone.
865
753
 
866
754
    This routine may be faster then format_date.
893
781
    :param show_offset: Whether to append the timezone.
894
782
    """
895
783
    (date_fmt, tt, offset_str) = \
896
 
        _format_date(t, offset, timezone, date_fmt, show_offset)
 
784
               _format_date(t, offset, timezone, date_fmt, show_offset)
897
785
    date_str = time.strftime(date_fmt, tt)
898
 
    if not isinstance(date_str, text_type):
 
786
    if not isinstance(date_str, unicode):
899
787
        date_str = date_str.decode(get_user_encoding(), 'replace')
900
788
    return date_str + offset_str
901
789
 
912
800
        tt = time.localtime(t)
913
801
        offset = local_time_offset(t)
914
802
    else:
915
 
        raise UnsupportedTimezoneFormat(timezone)
 
803
        raise errors.UnsupportedTimezoneFormat(timezone)
916
804
    if date_fmt is None:
917
805
        date_fmt = "%a %Y-%m-%d %H:%M:%S"
918
806
    if show_offset:
942
830
        delta = -delta
943
831
 
944
832
    seconds = delta
945
 
    if seconds < 90:  # print seconds up to 90 seconds
 
833
    if seconds < 90: # print seconds up to 90 seconds
946
834
        if seconds == 1:
947
835
            return '%d second %s' % (seconds, direction,)
948
836
        else:
954
842
        plural_seconds = ''
955
843
    else:
956
844
        plural_seconds = 's'
957
 
    if minutes < 90:  # print minutes, seconds up to 90 minutes
 
845
    if minutes < 90: # print minutes, seconds up to 90 minutes
958
846
        if minutes == 1:
959
847
            return '%d minute, %d second%s %s' % (
960
 
                minutes, seconds, plural_seconds, direction)
 
848
                    minutes, seconds, plural_seconds, direction)
961
849
        else:
962
850
            return '%d minutes, %d second%s %s' % (
963
 
                minutes, seconds, plural_seconds, direction)
 
851
                    minutes, seconds, plural_seconds, direction)
964
852
 
965
853
    hours = int(minutes / 60)
966
854
    minutes -= 60 * hours
975
863
    return '%d hours, %d minute%s %s' % (hours, minutes,
976
864
                                         plural_minutes, direction)
977
865
 
978
 
 
979
866
def filesize(f):
980
867
    """Return size of given open file."""
981
 
    return os.fstat(f.fileno())[stat.ST_SIZE]
982
 
 
983
 
 
984
 
# Alias os.urandom to support platforms (which?) without /dev/urandom and
985
 
# override if it doesn't work. Avoid checking on windows where there is
986
 
# significant initialisation cost that can be avoided for some bzr calls.
987
 
 
988
 
rand_bytes = os.urandom
989
 
 
990
 
if rand_bytes.__module__ != "nt":
 
868
    return os.fstat(f.fileno())[ST_SIZE]
 
869
 
 
870
 
 
871
# Define rand_bytes based on platform.
 
872
try:
 
873
    # Python 2.4 and later have os.urandom,
 
874
    # but it doesn't work on some arches
 
875
    os.urandom(1)
 
876
    rand_bytes = os.urandom
 
877
except (NotImplementedError, AttributeError):
 
878
    # If python doesn't have os.urandom, or it doesn't work,
 
879
    # then try to first pull random data from /dev/urandom
991
880
    try:
992
 
        rand_bytes(1)
993
 
    except NotImplementedError:
 
881
        rand_bytes = file('/dev/urandom', 'rb').read
 
882
    # Otherwise, use this hack as a last resort
 
883
    except (IOError, OSError):
994
884
        # not well seeded, but better than nothing
995
885
        def rand_bytes(n):
996
886
            import random
1002
892
 
1003
893
 
1004
894
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
1005
 
 
1006
 
 
1007
895
def rand_chars(num):
1008
896
    """Return a random string of num alphanumeric characters
1009
897
 
1012
900
    """
1013
901
    s = ''
1014
902
    for raw_byte in rand_bytes(num):
1015
 
        if not PY3:
1016
 
            s += ALNUM[ord(raw_byte) % 36]
1017
 
        else:
1018
 
            s += ALNUM[raw_byte % 36]
 
903
        s += ALNUM[ord(raw_byte) % 36]
1019
904
    return s
1020
905
 
1021
906
 
1022
 
# TODO: We could later have path objects that remember their list
1023
 
# decomposition (might be too tricksy though.)
 
907
## TODO: We could later have path objects that remember their list
 
908
## decomposition (might be too tricksy though.)
1024
909
 
1025
910
def splitpath(p):
1026
911
    """Turn string into list of parts."""
1027
 
    use_bytes = isinstance(p, bytes)
1028
 
    if os.path.sep == '\\':
1029
 
        # split on either delimiter because people might use either on
1030
 
        # Windows
1031
 
        if use_bytes:
1032
 
            ps = re.split(b'[\\\\/]', p)
1033
 
        else:
1034
 
            ps = re.split(r'[\\/]', p)
1035
 
    else:
1036
 
        if use_bytes:
1037
 
            ps = p.split(b'/')
1038
 
        else:
1039
 
            ps = p.split('/')
1040
 
 
1041
 
    if use_bytes:
1042
 
        parent_dir = b'..'
1043
 
        current_empty_dir = (b'.', b'')
1044
 
    else:
1045
 
        parent_dir = '..'
1046
 
        current_empty_dir = ('.', '')
 
912
    # split on either delimiter because people might use either on
 
913
    # Windows
 
914
    ps = re.split(r'[\\/]', p)
1047
915
 
1048
916
    rps = []
1049
917
    for f in ps:
1050
 
        if f == parent_dir:
1051
 
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
1052
 
        elif f in current_empty_dir:
 
918
        if f == '..':
 
919
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
920
        elif (f == '.') or (f == ''):
1053
921
            pass
1054
922
        else:
1055
923
            rps.append(f)
1059
927
def joinpath(p):
1060
928
    for f in p:
1061
929
        if (f == '..') or (f is None) or (f == ''):
1062
 
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
 
930
            raise errors.BzrError("sorry, %r not allowed in path" % f)
1063
931
    return pathjoin(*p)
1064
932
 
1065
933
 
1066
934
def parent_directories(filename):
1067
935
    """Return the list of parent directories, deepest first.
1068
 
 
 
936
    
1069
937
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
1070
938
    """
1071
939
    parents = []
1087
955
    implementation should be loaded instead::
1088
956
 
1089
957
    >>> try:
1090
 
    >>>     import breezy._fictional_extension_pyx
 
958
    >>>     import bzrlib._fictional_extension_pyx
1091
959
    >>> except ImportError, e:
1092
 
    >>>     breezy.osutils.failed_to_load_extension(e)
1093
 
    >>>     import breezy._fictional_extension_py
 
960
    >>>     bzrlib.osutils.failed_to_load_extension(e)
 
961
    >>>     import bzrlib._fictional_extension_py
1094
962
    """
1095
963
    # NB: This docstring is just an example, not a doctest, because doctest
1096
964
    # currently can't cope with the use of lazy imports in this namespace --
1097
965
    # mbp 20090729
1098
 
 
 
966
    
1099
967
    # This currently doesn't report the failure at the time it occurs, because
1100
968
    # they tend to happen very early in startup when we can't check config
1101
969
    # files etc, and also we want to report all failures but not spam the user
1102
970
    # with 10 warnings.
 
971
    from bzrlib import trace
1103
972
    exception_str = str(exception)
1104
973
    if exception_str not in _extension_load_failures:
1105
974
        trace.mutter("failed to load compiled extension: %s" % exception_str)
1109
978
def report_extension_load_failures():
1110
979
    if not _extension_load_failures:
1111
980
        return
1112
 
    if config.GlobalConfig().suppress_warning('missing_extensions'):
 
981
    from bzrlib.config import GlobalConfig
 
982
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
1113
983
        return
1114
984
    # the warnings framework should by default show this only once
1115
 
    from .trace import warning
 
985
    from bzrlib.trace import warning
1116
986
    warning(
1117
 
        "brz: warning: some compiled extensions could not be loaded; "
1118
 
        "see ``brz help missing-extensions``")
 
987
        "bzr: warning: some compiled extensions could not be loaded; "
 
988
        "see <https://answers.launchpad.net/bzr/+faq/703>")
1119
989
    # we no longer show the specific missing extensions here, because it makes
1120
990
    # the message too long and scary - see
1121
991
    # https://bugs.launchpad.net/bzr/+bug/430529
1122
992
 
1123
993
 
1124
994
try:
1125
 
    from ._chunks_to_lines_pyx import chunks_to_lines
1126
 
except ImportError as e:
 
995
    from bzrlib._chunks_to_lines_pyx import chunks_to_lines
 
996
except ImportError, e:
1127
997
    failed_to_load_extension(e)
1128
 
    from ._chunks_to_lines_py import chunks_to_lines
 
998
    from bzrlib._chunks_to_lines_py import chunks_to_lines
1129
999
 
1130
1000
 
1131
1001
def split_lines(s):
1132
1002
    """Split s into lines, but without removing the newline characters."""
1133
1003
    # Trivially convert a fulltext into a 'chunked' representation, and let
1134
1004
    # chunks_to_lines do the heavy lifting.
1135
 
    if isinstance(s, bytes):
 
1005
    if isinstance(s, str):
1136
1006
        # chunks_to_lines only supports 8-bit strings
1137
1007
        return chunks_to_lines([s])
1138
1008
    else:
1144
1014
 
1145
1015
    This supports Unicode or plain string objects.
1146
1016
    """
1147
 
    nl = b'\n' if isinstance(s, bytes) else u'\n'
1148
 
    lines = s.split(nl)
1149
 
    result = [line + nl for line in lines[:-1]]
 
1017
    lines = s.split('\n')
 
1018
    result = [line + '\n' for line in lines[:-1]]
1150
1019
    if lines[-1]:
1151
1020
        result.append(lines[-1])
1152
1021
    return result
1163
1032
        return
1164
1033
    try:
1165
1034
        os.link(src, dest)
1166
 
    except (OSError, IOError) as e:
 
1035
    except (OSError, IOError), e:
1167
1036
        if e.errno != errno.EXDEV:
1168
1037
            raise
1169
1038
        shutil.copyfile(src, dest)
1170
1039
 
1171
1040
 
1172
1041
def delete_any(path):
1173
 
    """Delete a file, symlink or directory.
1174
 
 
 
1042
    """Delete a file, symlink or directory.  
 
1043
    
1175
1044
    Will delete even if readonly.
1176
1045
    """
1177
1046
    try:
1178
 
        _delete_file_or_dir(path)
1179
 
    except (OSError, IOError) as e:
 
1047
       _delete_file_or_dir(path)
 
1048
    except (OSError, IOError), e:
1180
1049
        if e.errno in (errno.EPERM, errno.EACCES):
1181
1050
            # make writable and try again
1182
1051
            try:
1194
1063
    # - root can damage a solaris file system by using unlink,
1195
1064
    # - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
1196
1065
    #   EACCES, OSX: EPERM) when invoked on a directory.
1197
 
    if isdir(path):  # Takes care of symlinks
 
1066
    if isdir(path): # Takes care of symlinks
1198
1067
        os.rmdir(path)
1199
1068
    else:
1200
1069
        os.unlink(path)
1242
1111
    #    separators
1243
1112
    # 3) '\xa0' isn't unicode safe since it is >128.
1244
1113
 
1245
 
    if isinstance(s, str):
1246
 
        ws = ' \t\n\r\v\f'
1247
 
    else:
1248
 
        ws = (b' ', b'\t', b'\n', b'\r', b'\v', b'\f')
1249
 
    for ch in ws:
 
1114
    # This should *not* be a unicode set of characters in case the source
 
1115
    # string is not a Unicode string. We can auto-up-cast the characters since
 
1116
    # they are ascii, but we don't want to auto-up-cast the string in case it
 
1117
    # is utf-8
 
1118
    for ch in ' \t\n\r\v\f':
1250
1119
        if ch in s:
1251
1120
            return True
1252
1121
    else:
1263
1132
 
1264
1133
 
1265
1134
def relpath(base, path):
1266
 
    """Return path relative to base, or raise PathNotChild exception.
 
1135
    """Return path relative to base, or raise exception.
1267
1136
 
1268
1137
    The path may be either an absolute path or a path relative to the
1269
1138
    current working directory.
1271
1140
    os.path.commonprefix (python2.4) has a bad bug that it works just
1272
1141
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
1273
1142
    avoids that problem.
1274
 
 
1275
 
    NOTE: `base` should not have a trailing slash otherwise you'll get
1276
 
    PathNotChild exceptions regardless of `path`.
1277
1143
    """
1278
1144
 
1279
1145
    if len(base) < MIN_ABS_PATHLENGTH:
1280
1146
        # must have space for e.g. a drive letter
1281
 
        raise ValueError(gettext('%r is too short to calculate a relative path')
1282
 
                         % (base,))
 
1147
        raise ValueError('%r is too short to calculate a relative path'
 
1148
            % (base,))
1283
1149
 
1284
1150
    rp = abspath(path)
1285
1151
 
1330
1196
        lbit = bit.lower()
1331
1197
        try:
1332
1198
            next_entries = _listdir(current)
1333
 
        except OSError:  # enoent, eperm, etc
 
1199
        except OSError: # enoent, eperm, etc
1334
1200
            # We can't find this in the filesystem, so just append the
1335
1201
            # remaining bits.
1336
1202
            current = pathjoin(current, bit, *list(bit_iter))
1347
1213
            break
1348
1214
    return current[len(abs_base):].lstrip('/')
1349
1215
 
1350
 
 
1351
1216
# XXX - TODO - we need better detection/integration of case-insensitive
1352
1217
# file-systems; Linux often sees FAT32 devices (or NFS-mounted OSX
1353
1218
# filesystems), for example, so could probably benefit from the same basic
1358
1223
else:
1359
1224
    canonical_relpath = relpath
1360
1225
 
1361
 
 
1362
1226
def canonical_relpaths(base, paths):
1363
1227
    """Create an iterable to canonicalize a sequence of relative paths.
1364
1228
 
1368
1232
    # but for now, we haven't optimized...
1369
1233
    return [canonical_relpath(base, p) for p in paths]
1370
1234
 
1371
 
 
1372
 
def decode_filename(filename):
1373
 
    """Decode the filename using the filesystem encoding
1374
 
 
1375
 
    If it is unicode, it is returned.
1376
 
    Otherwise it is decoded from the the filesystem's encoding. If decoding
1377
 
    fails, a errors.BadFilenameEncoding exception is raised.
1378
 
    """
1379
 
    if isinstance(filename, text_type):
1380
 
        return filename
1381
 
    try:
1382
 
        return filename.decode(_fs_enc)
1383
 
    except UnicodeDecodeError:
1384
 
        raise errors.BadFilenameEncoding(filename, _fs_enc)
1385
 
 
1386
 
 
1387
1235
def safe_unicode(unicode_or_utf8_string):
1388
1236
    """Coerce unicode_or_utf8_string into unicode.
1389
1237
 
1391
1239
    Otherwise it is decoded from utf-8. If decoding fails, the exception is
1392
1240
    wrapped in a BzrBadParameterNotUnicode exception.
1393
1241
    """
1394
 
    if isinstance(unicode_or_utf8_string, text_type):
 
1242
    if isinstance(unicode_or_utf8_string, unicode):
1395
1243
        return unicode_or_utf8_string
1396
1244
    try:
1397
1245
        return unicode_or_utf8_string.decode('utf8')
1405
1253
    If it is a str, it is returned.
1406
1254
    If it is Unicode, it is encoded into a utf-8 string.
1407
1255
    """
1408
 
    if isinstance(unicode_or_utf8_string, bytes):
 
1256
    if isinstance(unicode_or_utf8_string, str):
1409
1257
        # TODO: jam 20070209 This is overkill, and probably has an impact on
1410
1258
        #       performance if we are dealing with lots of apis that want a
1411
1259
        #       utf-8 revision id
1418
1266
    return unicode_or_utf8_string.encode('utf-8')
1419
1267
 
1420
1268
 
1421
 
def safe_revision_id(unicode_or_utf8_string):
 
1269
_revision_id_warning = ('Unicode revision ids were deprecated in bzr 0.15.'
 
1270
                        ' Revision id generators should be creating utf8'
 
1271
                        ' revision ids.')
 
1272
 
 
1273
 
 
1274
def safe_revision_id(unicode_or_utf8_string, warn=True):
1422
1275
    """Revision ids should now be utf8, but at one point they were unicode.
1423
1276
 
1424
1277
    :param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
1425
1278
        utf8 or None).
 
1279
    :param warn: Functions that are sanitizing user data can set warn=False
1426
1280
    :return: None or a utf8 revision id.
1427
1281
    """
1428
1282
    if (unicode_or_utf8_string is None
1429
 
            or unicode_or_utf8_string.__class__ == bytes):
 
1283
        or unicode_or_utf8_string.__class__ == str):
1430
1284
        return unicode_or_utf8_string
1431
 
    raise TypeError('Unicode revision ids are no longer supported. '
1432
 
                    'Revision id generators should be creating utf8 revision '
1433
 
                    'ids.')
1434
 
 
1435
 
 
1436
 
def safe_file_id(unicode_or_utf8_string):
 
1285
    if warn:
 
1286
        symbol_versioning.warn(_revision_id_warning, DeprecationWarning,
 
1287
                               stacklevel=2)
 
1288
    return cache_utf8.encode(unicode_or_utf8_string)
 
1289
 
 
1290
 
 
1291
_file_id_warning = ('Unicode file ids were deprecated in bzr 0.15. File id'
 
1292
                    ' generators should be creating utf8 file ids.')
 
1293
 
 
1294
 
 
1295
def safe_file_id(unicode_or_utf8_string, warn=True):
1437
1296
    """File ids should now be utf8, but at one point they were unicode.
1438
1297
 
1439
1298
    This is the same as safe_utf8, except it uses the cached encode functions
1441
1300
 
1442
1301
    :param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
1443
1302
        utf8 or None).
 
1303
    :param warn: Functions that are sanitizing user data can set warn=False
1444
1304
    :return: None or a utf8 file id.
1445
1305
    """
1446
1306
    if (unicode_or_utf8_string is None
1447
 
            or unicode_or_utf8_string.__class__ == bytes):
 
1307
        or unicode_or_utf8_string.__class__ == str):
1448
1308
        return unicode_or_utf8_string
1449
 
    raise TypeError('Unicode file ids are no longer supported. '
1450
 
                    'File id generators should be creating utf8 file ids.')
 
1309
    if warn:
 
1310
        symbol_versioning.warn(_file_id_warning, DeprecationWarning,
 
1311
                               stacklevel=2)
 
1312
    return cache_utf8.encode(unicode_or_utf8_string)
1451
1313
 
1452
1314
 
1453
1315
_platform_normalizes_filenames = False
1458
1320
def normalizes_filenames():
1459
1321
    """Return True if this platform normalizes unicode filenames.
1460
1322
 
1461
 
    Only Mac OSX.
 
1323
    Mac OSX does, Windows/Linux do not.
1462
1324
    """
1463
1325
    return _platform_normalizes_filenames
1464
1326
 
1469
1331
    On platforms where the system normalizes filenames (Mac OSX),
1470
1332
    you can access a file by any path which will normalize correctly.
1471
1333
    On platforms where the system does not normalize filenames
1472
 
    (everything else), you have to access a file by its exact path.
 
1334
    (Windows, Linux), you have to access a file by its exact path.
1473
1335
 
1474
1336
    Internally, bzr only supports NFC normalization, since that is
1475
1337
    the standard for XML documents.
1478
1340
    can be accessed by that path.
1479
1341
    """
1480
1342
 
1481
 
    if isinstance(path, bytes):
1482
 
        path = path.decode(sys.getfilesystemencoding())
1483
 
    return unicodedata.normalize('NFC', path), True
 
1343
    return unicodedata.normalize('NFC', unicode(path)), True
1484
1344
 
1485
1345
 
1486
1346
def _inaccessible_normalized_filename(path):
1487
1347
    __doc__ = _accessible_normalized_filename.__doc__
1488
1348
 
1489
 
    if isinstance(path, bytes):
1490
 
        path = path.decode(sys.getfilesystemencoding())
1491
 
    normalized = unicodedata.normalize('NFC', path)
 
1349
    normalized = unicodedata.normalize('NFC', unicode(path))
1492
1350
    return normalized, normalized == path
1493
1351
 
1494
1352
 
1507
1365
        False)`).  May be ignored if the feature is not available on this
1508
1366
        platform or Python version.
1509
1367
    """
1510
 
    try:
1511
 
        import signal
1512
 
        siginterrupt = signal.siginterrupt
1513
 
    except ImportError:
1514
 
        # This python implementation doesn't provide signal support, hence no
1515
 
        # handler exists
1516
 
        return None
1517
 
    except AttributeError:
1518
 
        # siginterrupt doesn't exist on this platform, or for this version
1519
 
        # of Python.
1520
 
        def siginterrupt(signum, flag): return None
 
1368
    old_handler = signal.signal(signum, handler)
1521
1369
    if restart_syscall:
1522
 
        def sig_handler(*args):
1523
 
            # Python resets the siginterrupt flag when a signal is
1524
 
            # received.  <http://bugs.python.org/issue8354>
1525
 
            # As a workaround for some cases, set it back the way we want it.
 
1370
        try:
 
1371
            siginterrupt = signal.siginterrupt
 
1372
        except AttributeError: # siginterrupt doesn't exist on this platform, or for this version of
 
1373
            # Python.
 
1374
            pass
 
1375
        else:
1526
1376
            siginterrupt(signum, False)
1527
 
            # Now run the handler function passed to set_signal_handler.
1528
 
            handler(*args)
1529
 
    else:
1530
 
        sig_handler = handler
1531
 
    old_handler = signal.signal(signum, sig_handler)
1532
 
    if restart_syscall:
1533
 
        siginterrupt(signum, False)
1534
1377
    return old_handler
1535
1378
 
1536
1379
 
1541
1384
terminal_width() returns None.
1542
1385
"""
1543
1386
 
1544
 
# Keep some state so that terminal_width can detect if _terminal_size has
1545
 
# returned a different size since the process started.  See docstring and
1546
 
# comments of terminal_width for details.
1547
 
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
1548
 
_terminal_size_state = 'no_data'
1549
 
_first_terminal_size = None
1550
 
 
1551
1387
 
1552
1388
def terminal_width():
1553
1389
    """Return terminal width.
1555
1391
    None is returned if the width can't established precisely.
1556
1392
 
1557
1393
    The rules are:
1558
 
    - if BRZ_COLUMNS is set, returns its value
 
1394
    - if BZR_COLUMNS is set, returns its value
1559
1395
    - if there is no controlling terminal, returns None
1560
 
    - query the OS, if the queried size has changed since the last query,
1561
 
      return its value,
1562
1396
    - if COLUMNS is set, returns its value,
1563
 
    - if the OS has a value (even though it's never changed), return its value.
1564
1397
 
1565
1398
    From there, we need to query the OS to get the size of the controlling
1566
1399
    terminal.
1567
1400
 
1568
 
    On Unices we query the OS by:
 
1401
    Unices:
1569
1402
    - get termios.TIOCGWINSZ
1570
1403
    - if an error occurs or a negative value is obtained, returns None
1571
1404
 
1572
 
    On Windows we query the OS by:
 
1405
    Windows:
 
1406
    
1573
1407
    - win32utils.get_console_size() decides,
1574
1408
    - returns None on error (provided default value)
1575
1409
    """
1576
 
    # Note to implementors: if changing the rules for determining the width,
1577
 
    # make sure you've considered the behaviour in these cases:
1578
 
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1579
 
    #  - brz log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1580
 
    #    0,0.
1581
 
    #  - (add more interesting cases here, if you find any)
1582
 
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1583
 
    # but we don't want to register a signal handler because it is impossible
1584
 
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
1585
 
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
1586
 
    # time so we can notice if the reported size has changed, which should have
1587
 
    # a similar effect.
1588
1410
 
1589
 
    # If BRZ_COLUMNS is set, take it, user is always right
1590
 
    # Except if they specified 0 in which case, impose no limit here
 
1411
    # If BZR_COLUMNS is set, take it, user is always right
1591
1412
    try:
1592
 
        width = int(os.environ['BRZ_COLUMNS'])
 
1413
        return int(os.environ['BZR_COLUMNS'])
1593
1414
    except (KeyError, ValueError):
1594
 
        width = None
1595
 
    if width is not None:
1596
 
        if width > 0:
1597
 
            return width
1598
 
        else:
1599
 
            return None
 
1415
        pass
1600
1416
 
1601
1417
    isatty = getattr(sys.stdout, 'isatty', None)
1602
 
    if isatty is None or not isatty():
1603
 
        # Don't guess, setting BRZ_COLUMNS is the recommended way to override.
 
1418
    if  isatty is None or not isatty():
 
1419
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1604
1420
        return None
1605
1421
 
1606
 
    # Query the OS
1607
 
    width, height = os_size = _terminal_size(None, None)
1608
 
    global _first_terminal_size, _terminal_size_state
1609
 
    if _terminal_size_state == 'no_data':
1610
 
        _first_terminal_size = os_size
1611
 
        _terminal_size_state = 'unchanged'
1612
 
    elif (_terminal_size_state == 'unchanged' and
1613
 
          _first_terminal_size != os_size):
1614
 
        _terminal_size_state = 'changed'
1615
 
 
1616
 
    # If the OS claims to know how wide the terminal is, and this value has
1617
 
    # ever changed, use that.
1618
 
    if _terminal_size_state == 'changed':
1619
 
        if width is not None and width > 0:
1620
 
            return width
1621
 
 
1622
 
    # If COLUMNS is set, use it.
 
1422
    # If COLUMNS is set, take it, the terminal knows better (even inside a
 
1423
    # given terminal, the application can decide to set COLUMNS to a lower
 
1424
    # value (splitted screen) or a bigger value (scroll bars))
1623
1425
    try:
1624
1426
        return int(os.environ['COLUMNS'])
1625
1427
    except (KeyError, ValueError):
1626
1428
        pass
1627
1429
 
1628
 
    # Finally, use an unchanged size from the OS, if we have one.
1629
 
    if _terminal_size_state == 'unchanged':
1630
 
        if width is not None and width > 0:
1631
 
            return width
 
1430
    width, height = _terminal_size(None, None)
 
1431
    if width <= 0:
 
1432
        # Consider invalid values as meaning no width
 
1433
        return None
1632
1434
 
1633
 
    # The width could not be determined.
1634
 
    return None
 
1435
    return width
1635
1436
 
1636
1437
 
1637
1438
def _win32_terminal_size(width, height):
1638
 
    width, height = win32utils.get_console_size(
1639
 
        defaultx=width, defaulty=height)
 
1439
    width, height = win32utils.get_console_size(defaultx=width, defaulty=height)
1640
1440
    return width, height
1641
1441
 
1642
1442
 
1643
1443
def _ioctl_terminal_size(width, height):
1644
1444
    try:
1645
 
        import struct
1646
 
        import fcntl
1647
 
        import termios
 
1445
        import struct, fcntl, termios
1648
1446
        s = struct.pack('HHHH', 0, 0, 0, 0)
1649
1447
        x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1650
1448
        height, width = struct.unpack('HHHH', x)[0:2]
1652
1450
        pass
1653
1451
    return width, height
1654
1452
 
1655
 
 
1656
1453
_terminal_size = None
1657
1454
"""Returns the terminal size as (width, height).
1658
1455
 
1668
1465
    _terminal_size = _ioctl_terminal_size
1669
1466
 
1670
1467
 
1671
 
def supports_executable(path):
1672
 
    """Return if filesystem at path supports executable bit.
1673
 
 
1674
 
    :param path: Path for which to check the file system
1675
 
    :return: boolean indicating whether executable bit can be stored/relied upon
1676
 
    """
1677
 
    if sys.platform == 'win32':
1678
 
        return False
1679
 
    try:
1680
 
        fs_type = get_fs_type(path)
1681
 
    except errors.DependencyNotPresent as e:
1682
 
        trace.mutter('Unable to get fs type for %r: %s', path, e)
1683
 
    else:
1684
 
        if fs_type in ('vfat', 'ntfs'):
1685
 
            # filesystems known to not support executable bit
1686
 
            return False
1687
 
    return True
1688
 
 
1689
 
 
1690
 
def supports_symlinks(path):
1691
 
    """Return if the filesystem at path supports the creation of symbolic links.
1692
 
 
1693
 
    """
1694
 
    if not has_symlinks():
1695
 
        return False
1696
 
    try:
1697
 
        fs_type = get_fs_type(path)
1698
 
    except errors.DependencyNotPresent as e:
1699
 
        trace.mutter('Unable to get fs type for %r: %s', path, e)
1700
 
    else:
1701
 
        if fs_type in ('vfat', 'ntfs'):
1702
 
            # filesystems known to not support symlinks
1703
 
            return False
1704
 
    return True
 
1468
def _terminal_size_changed(signum, frame):
 
1469
    """Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
 
1470
    width, height = _terminal_size(None, None)
 
1471
    if width is not None:
 
1472
        os.environ['COLUMNS'] = str(width)
 
1473
 
 
1474
 
 
1475
_registered_sigwinch = False
 
1476
 
 
1477
def watch_sigwinch():
 
1478
    """Register for SIGWINCH, once and only once."""
 
1479
    global _registered_sigwinch
 
1480
    if not _registered_sigwinch:
 
1481
        if sys.platform == 'win32':
 
1482
            # Martin (gz) mentioned WINDOW_BUFFER_SIZE_RECORD from
 
1483
            # ReadConsoleInput but I've no idea how to plug that in
 
1484
            # the current design -- vila 20091216
 
1485
            pass
 
1486
        else:
 
1487
            set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
 
1488
        _registered_sigwinch = True
 
1489
 
 
1490
 
 
1491
def supports_executable():
 
1492
    return sys.platform != "win32"
1705
1493
 
1706
1494
 
1707
1495
def supports_posix_readonly():
1730
1518
        if orig_val is not None:
1731
1519
            del os.environ[env_variable]
1732
1520
    else:
1733
 
        if not PY3 and isinstance(value, text_type):
 
1521
        if isinstance(value, unicode):
1734
1522
            value = value.encode(get_user_encoding())
1735
1523
        os.environ[env_variable] = value
1736
1524
    return orig_val
1750
1538
        raise errors.IllegalPath(path)
1751
1539
 
1752
1540
 
1753
 
_WIN32_ERROR_DIRECTORY = 267  # Similar to errno.ENOTDIR
1754
 
 
 
1541
_WIN32_ERROR_DIRECTORY = 267 # Similar to errno.ENOTDIR
1755
1542
 
1756
1543
def _is_error_enotdir(e):
1757
1544
    """Check if this exception represents ENOTDIR.
1769
1556
    :return: True if this represents an ENOTDIR error. False otherwise.
1770
1557
    """
1771
1558
    en = getattr(e, 'errno', None)
1772
 
    if (en == errno.ENOTDIR or
1773
 
        (sys.platform == 'win32' and
1774
 
            (en == _WIN32_ERROR_DIRECTORY or
1775
 
             (en == errno.EINVAL
1776
 
              and getattr(e, 'winerror', None) == _WIN32_ERROR_DIRECTORY)
1777
 
             ))):
 
1559
    if (en == errno.ENOTDIR
 
1560
        or (sys.platform == 'win32'
 
1561
            and (en == _WIN32_ERROR_DIRECTORY
 
1562
                 or (en == errno.EINVAL
 
1563
                     and getattr(e, 'winerror', None) == _WIN32_ERROR_DIRECTORY)
 
1564
        ))):
1778
1565
        return True
1779
1566
    return False
1780
1567
 
1807
1594
        rooted higher up.
1808
1595
    :return: an iterator over the dirs.
1809
1596
    """
1810
 
    # TODO there is a bit of a smell where the results of the directory-
 
1597
    #TODO there is a bit of a smell where the results of the directory-
1811
1598
    # summary in this, and the path from the root, may not agree
1812
1599
    # depending on top and prefix - i.e. ./foo and foo as a pair leads to
1813
1600
    # potentially confusing output. We should make this more robust - but
1829
1616
        dirblock = []
1830
1617
        append = dirblock.append
1831
1618
        try:
1832
 
            names = sorted(map(decode_filename, _listdir(top)))
1833
 
        except OSError as e:
 
1619
            names = sorted(_listdir(top))
 
1620
        except OSError, e:
1834
1621
            if not _is_error_enotdir(e):
1835
1622
                raise
1836
1623
        else:
1889
1676
    """
1890
1677
    global _selected_dir_reader
1891
1678
    if _selected_dir_reader is None:
1892
 
        if sys.platform == "win32":
 
1679
        fs_encoding = _fs_enc.upper()
 
1680
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
 
1681
            # Win98 doesn't have unicode apis like FindFirstFileW
 
1682
            # TODO: We possibly could support Win98 by falling back to the
 
1683
            #       original FindFirstFile, and using TCHAR instead of WCHAR,
 
1684
            #       but that gets a bit tricky, and requires custom compiling
 
1685
            #       for win98 anyway.
1893
1686
            try:
1894
 
                from ._walkdirs_win32 import Win32ReadDir
 
1687
                from bzrlib._walkdirs_win32 import Win32ReadDir
1895
1688
                _selected_dir_reader = Win32ReadDir()
1896
1689
            except ImportError:
1897
1690
                pass
1898
 
        elif _fs_enc in ('utf-8', 'ascii'):
 
1691
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
 
1692
            # ANSI_X3.4-1968 is a form of ASCII
1899
1693
            try:
1900
 
                from ._readdir_pyx import UTF8DirReader
 
1694
                from bzrlib._readdir_pyx import UTF8DirReader
1901
1695
                _selected_dir_reader = UTF8DirReader()
1902
 
            except ImportError as e:
 
1696
            except ImportError, e:
1903
1697
                failed_to_load_extension(e)
1904
1698
                pass
1905
1699
 
1950
1744
        See DirReader.read_dir for details.
1951
1745
        """
1952
1746
        _utf8_encode = self._utf8_encode
1953
 
 
1954
 
        def _fs_decode(s): return s.decode(_fs_enc)
1955
 
 
1956
 
        def _fs_encode(s): return s.encode(_fs_enc)
1957
1747
        _lstat = os.lstat
1958
1748
        _listdir = os.listdir
1959
1749
        _kind_from_mode = file_kind_from_stat_mode
1960
1750
 
1961
1751
        if prefix:
1962
 
            relprefix = prefix + b'/'
 
1752
            relprefix = prefix + '/'
1963
1753
        else:
1964
 
            relprefix = b''
1965
 
        top_slash = top + '/'
 
1754
            relprefix = ''
 
1755
        top_slash = top + u'/'
1966
1756
 
1967
1757
        dirblock = []
1968
1758
        append = dirblock.append
1969
 
        for name_native in _listdir(top.encode('utf-8')):
 
1759
        for name in sorted(_listdir(top)):
1970
1760
            try:
1971
 
                name = _fs_decode(name_native)
 
1761
                name_utf8 = _utf8_encode(name)[0]
1972
1762
            except UnicodeDecodeError:
1973
1763
                raise errors.BadFilenameEncoding(
1974
 
                    relprefix + name_native, _fs_enc)
1975
 
            name_utf8 = _utf8_encode(name)[0]
 
1764
                    _utf8_encode(relprefix)[0] + name, _fs_enc)
1976
1765
            abspath = top_slash + name
1977
1766
            statvalue = _lstat(abspath)
1978
1767
            kind = _kind_from_mode(statvalue.st_mode)
1979
1768
            append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
1980
 
        return sorted(dirblock)
 
1769
        return dirblock
1981
1770
 
1982
1771
 
1983
1772
def copy_tree(from_path, to_path, handlers={}):
2008
1797
        link_to = os.readlink(source)
2009
1798
        os.symlink(link_to, dest)
2010
1799
 
2011
 
    real_handlers = {'file': shutil.copy2,
2012
 
                     'symlink': copy_link,
2013
 
                     'directory': copy_dir,
2014
 
                     }
 
1800
    real_handlers = {'file':shutil.copy2,
 
1801
                     'symlink':copy_link,
 
1802
                     'directory':copy_dir,
 
1803
                    }
2015
1804
    real_handlers.update(handlers)
2016
1805
 
2017
1806
    if not os.path.exists(to_path):
2022
1811
            real_handlers[kind](abspath, relpath)
2023
1812
 
2024
1813
 
2025
 
def copy_ownership_from_path(dst, src=None):
 
1814
def copy_ownership(dst, src=None):
2026
1815
    """Copy usr/grp ownership from src file/dir to dst file/dir.
2027
1816
 
2028
1817
    If src is None, the containing directory is used as source. If chown
2032
1821
    if chown is None:
2033
1822
        return
2034
1823
 
2035
 
    if src is None:
 
1824
    if src == None:
2036
1825
        src = os.path.dirname(dst)
2037
1826
        if src == '':
2038
1827
            src = '.'
2040
1829
    try:
2041
1830
        s = os.stat(src)
2042
1831
        chown(dst, s.st_uid, s.st_gid)
2043
 
    except OSError:
2044
 
        trace.warning(
2045
 
            'Unable to copy ownership from "%s" to "%s". '
2046
 
            'You may want to set it manually.', src, dst)
2047
 
        trace.log_exception_quietly()
 
1832
    except OSError, e:
 
1833
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
 
1834
 
 
1835
 
 
1836
def mkdir_with_ownership(path, ownership_src=None):
 
1837
    """Create the directory 'path' with specified ownership.
 
1838
 
 
1839
    If ownership_src is given, copies (chown) usr/grp ownership
 
1840
    from 'ownership_src' to 'path'. If ownership_src is None, use the
 
1841
    containing dir ownership.
 
1842
    """
 
1843
    os.mkdir(path)
 
1844
    copy_ownership(path, ownership_src)
 
1845
 
 
1846
 
 
1847
def open_with_ownership(filename, mode='r', bufsize=-1, ownership_src=None):
 
1848
    """Open the file 'filename' with the specified ownership.
 
1849
 
 
1850
    If ownership_src is specified, copy usr/grp ownership from ownership_src
 
1851
    to filename. If ownership_src is None, copy ownership from containing
 
1852
    directory.
 
1853
    Returns the opened file object.
 
1854
    """
 
1855
    f = open(filename, mode, bufsize)
 
1856
    copy_ownership(filename, ownership_src)
 
1857
    return f
2048
1858
 
2049
1859
 
2050
1860
def path_prefix_key(path):
2052
1862
 
2053
1863
    This can be used to sort paths in the same way that walkdirs does.
2054
1864
    """
2055
 
    return (dirname(path), path)
 
1865
    return (dirname(path) , path)
2056
1866
 
2057
1867
 
2058
1868
def compare_paths_prefix_order(path_a, path_b):
2059
1869
    """Compare path_a and path_b to generate the same order walkdirs uses."""
2060
1870
    key_a = path_prefix_key(path_a)
2061
1871
    key_b = path_prefix_key(path_b)
2062
 
    return (key_a > key_b) - (key_a < key_b)
 
1872
    return cmp(key_a, key_b)
2063
1873
 
2064
1874
 
2065
1875
_cached_user_encoding = None
2066
1876
 
2067
1877
 
2068
 
def get_user_encoding():
 
1878
def get_user_encoding(use_cache=True):
2069
1879
    """Find out what the preferred user encoding is.
2070
1880
 
2071
1881
    This is generally the encoding that is used for command line parameters
2072
1882
    and file contents. This may be different from the terminal encoding
2073
1883
    or the filesystem encoding.
2074
1884
 
 
1885
    :param  use_cache:  Enable cache for detected encoding.
 
1886
                        (This parameter is turned on by default,
 
1887
                        and required only for selftesting)
 
1888
 
2075
1889
    :return: A string defining the preferred user encoding
2076
1890
    """
2077
1891
    global _cached_user_encoding
2078
 
    if _cached_user_encoding is not None:
 
1892
    if _cached_user_encoding is not None and use_cache:
2079
1893
        return _cached_user_encoding
2080
1894
 
2081
 
    if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
2082
 
        # Use the existing locale settings and call nl_langinfo directly
2083
 
        # rather than going through getpreferredencoding. This avoids
2084
 
        # <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
2085
 
        # possibility of the setlocale call throwing an error.
2086
 
        user_encoding = locale.nl_langinfo(locale.CODESET)
 
1895
    if sys.platform == 'darwin':
 
1896
        # python locale.getpreferredencoding() always return
 
1897
        # 'mac-roman' on darwin. That's a lie.
 
1898
        sys.platform = 'posix'
 
1899
        try:
 
1900
            if os.environ.get('LANG', None) is None:
 
1901
                # If LANG is not set, we end up with 'ascii', which is bad
 
1902
                # ('mac-roman' is more than ascii), so we set a default which
 
1903
                # will give us UTF-8 (which appears to work in all cases on
 
1904
                # OSX). Users are still free to override LANG of course, as
 
1905
                # long as it give us something meaningful. This work-around
 
1906
                # *may* not be needed with python 3k and/or OSX 10.5, but will
 
1907
                # work with them too -- vila 20080908
 
1908
                os.environ['LANG'] = 'en_US.UTF-8'
 
1909
            import locale
 
1910
        finally:
 
1911
            sys.platform = 'darwin'
2087
1912
    else:
2088
 
        # GZ 2011-12-19: On windows could call GetACP directly instead.
2089
 
        user_encoding = locale.getpreferredencoding(False)
 
1913
        import locale
2090
1914
 
2091
1915
    try:
2092
 
        user_encoding = codecs.lookup(user_encoding).name
2093
 
    except LookupError:
2094
 
        if user_encoding not in ("", "cp0"):
2095
 
            sys.stderr.write('brz: warning:'
 
1916
        user_encoding = locale.getpreferredencoding()
 
1917
    except locale.Error, e:
 
1918
        sys.stderr.write('bzr: warning: %s\n'
 
1919
                         '  Could not determine what text encoding to use.\n'
 
1920
                         '  This error usually means your Python interpreter\n'
 
1921
                         '  doesn\'t support the locale set by $LANG (%s)\n'
 
1922
                         "  Continuing with ascii encoding.\n"
 
1923
                         % (e, os.environ.get('LANG')))
 
1924
        user_encoding = 'ascii'
 
1925
 
 
1926
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
 
1927
    # treat that as ASCII, and not support printing unicode characters to the
 
1928
    # console.
 
1929
    #
 
1930
    # For python scripts run under vim, we get '', so also treat that as ASCII
 
1931
    if user_encoding in (None, 'cp0', ''):
 
1932
        user_encoding = 'ascii'
 
1933
    else:
 
1934
        # check encoding
 
1935
        try:
 
1936
            codecs.lookup(user_encoding)
 
1937
        except LookupError:
 
1938
            sys.stderr.write('bzr: warning:'
2096
1939
                             ' unknown encoding %s.'
2097
1940
                             ' Continuing with ascii encoding.\n'
2098
1941
                             % user_encoding
2099
 
                             )
2100
 
        user_encoding = 'ascii'
2101
 
    else:
2102
 
        # Get 'ascii' when setlocale has not been called or LANG=C or unset.
2103
 
        if user_encoding == 'ascii':
2104
 
            if sys.platform == 'darwin':
2105
 
                # OSX is special-cased in Python to have a UTF-8 filesystem
2106
 
                # encoding and previously had LANG set here if not present.
2107
 
                user_encoding = 'utf-8'
2108
 
            # GZ 2011-12-19: Maybe UTF-8 should be the default in this case
2109
 
            #                for some other posix platforms as well.
2110
 
 
2111
 
    _cached_user_encoding = user_encoding
 
1942
                            )
 
1943
            user_encoding = 'ascii'
 
1944
 
 
1945
    if use_cache:
 
1946
        _cached_user_encoding = user_encoding
 
1947
 
2112
1948
    return user_encoding
2113
1949
 
2114
1950
 
2115
 
def get_diff_header_encoding():
2116
 
    return get_terminal_encoding()
2117
 
 
2118
 
 
2119
1951
def get_host_name():
2120
1952
    """Return the current unicode host name.
2121
1953
 
2123
1955
    behaves inconsistently on different platforms.
2124
1956
    """
2125
1957
    if sys.platform == "win32":
 
1958
        import win32utils
2126
1959
        return win32utils.get_host_name()
2127
1960
    else:
2128
1961
        import socket
2129
 
        if PY3:
2130
 
            return socket.gethostname()
2131
1962
        return socket.gethostname().decode(get_user_encoding())
2132
1963
 
2133
1964
 
2137
1968
# data at once.
2138
1969
MAX_SOCKET_CHUNK = 64 * 1024
2139
1970
 
2140
 
_end_of_stream_errors = [errno.ECONNRESET, errno.EPIPE, errno.EINVAL]
2141
 
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
2142
 
    _eno = getattr(errno, _eno, None)
2143
 
    if _eno is not None:
2144
 
        _end_of_stream_errors.append(_eno)
2145
 
del _eno
2146
 
 
2147
 
 
2148
1971
def read_bytes_from_socket(sock, report_activity=None,
2149
 
                           max_read_size=MAX_SOCKET_CHUNK):
 
1972
        max_read_size=MAX_SOCKET_CHUNK):
2150
1973
    """Read up to max_read_size of bytes from sock and notify of progress.
2151
1974
 
2152
1975
    Translates "Connection reset by peer" into file-like EOF (return an
2153
1976
    empty string rather than raise an error), and repeats the recv if
2154
1977
    interrupted by a signal.
2155
1978
    """
2156
 
    while True:
 
1979
    while 1:
2157
1980
        try:
2158
 
            data = sock.recv(max_read_size)
2159
 
        except socket.error as e:
 
1981
            bytes = sock.recv(max_read_size)
 
1982
        except socket.error, e:
2160
1983
            eno = e.args[0]
2161
 
            if eno in _end_of_stream_errors:
 
1984
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
2162
1985
                # The connection was closed by the other side.  Callers expect
2163
1986
                # an empty string to signal end-of-stream.
2164
 
                return b""
 
1987
                return ""
2165
1988
            elif eno == errno.EINTR:
2166
1989
                # Retry the interrupted recv.
2167
1990
                continue
2168
1991
            raise
2169
1992
        else:
2170
1993
            if report_activity is not None:
2171
 
                report_activity(len(data), 'read')
2172
 
            return data
 
1994
                report_activity(len(bytes), 'read')
 
1995
            return bytes
2173
1996
 
2174
1997
 
2175
1998
def recv_all(socket, count):
2182
2005
 
2183
2006
    This isn't optimized and is intended mostly for use in testing.
2184
2007
    """
2185
 
    b = b''
 
2008
    b = ''
2186
2009
    while len(b) < count:
2187
2010
        new = read_bytes_from_socket(socket, None, count - len(b))
2188
 
        if new == b'':
2189
 
            break  # eof
 
2011
        if new == '':
 
2012
            break # eof
2190
2013
        b += new
2191
2014
    return b
2192
2015
 
2193
2016
 
2194
2017
def send_all(sock, bytes, report_activity=None):
2195
2018
    """Send all bytes on a socket.
2196
 
 
 
2019
 
2197
2020
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2198
2021
    some platforms, and catches EINTR which may be thrown if the send is
2199
2022
    interrupted by a signal.
2200
2023
 
2201
2024
    This is preferred to socket.sendall(), because it avoids portability bugs
2202
2025
    and provides activity reporting.
2203
 
 
 
2026
 
2204
2027
    :param report_activity: Call this as bytes are read, see
2205
2028
        Transport._report_activity
2206
2029
    """
2207
2030
    sent_total = 0
2208
2031
    byte_count = len(bytes)
2209
 
    view = memoryview(bytes)
2210
2032
    while sent_total < byte_count:
2211
2033
        try:
2212
 
            sent = sock.send(view[sent_total:sent_total + MAX_SOCKET_CHUNK])
2213
 
        except (socket.error, IOError) as e:
2214
 
            if e.args[0] in _end_of_stream_errors:
2215
 
                raise errors.ConnectionReset(
2216
 
                    "Error trying to write to socket", e)
 
2034
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
 
2035
        except socket.error, e:
2217
2036
            if e.args[0] != errno.EINTR:
2218
2037
                raise
2219
2038
        else:
2220
 
            if sent == 0:
2221
 
                raise errors.ConnectionReset('Sending to %s returned 0 bytes'
2222
 
                                             % (sock,))
2223
2039
            sent_total += sent
2224
 
            if report_activity is not None:
2225
 
                report_activity(sent, 'write')
2226
 
 
2227
 
 
2228
 
def connect_socket(address):
2229
 
    # Slight variation of the socket.create_connection() function (provided by
2230
 
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
2231
 
    # provide it for previous python versions. Also, we don't use the timeout
2232
 
    # parameter (provided by the python implementation) so we don't implement
2233
 
    # it either).
2234
 
    err = socket.error('getaddrinfo returns an empty list')
2235
 
    host, port = address
2236
 
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
2237
 
        af, socktype, proto, canonname, sa = res
2238
 
        sock = None
2239
 
        try:
2240
 
            sock = socket.socket(af, socktype, proto)
2241
 
            sock.connect(sa)
2242
 
            return sock
2243
 
 
2244
 
        except socket.error as e:
2245
 
            err = e
2246
 
            # 'err' is now the most recent error
2247
 
            if sock is not None:
2248
 
                sock.close()
2249
 
    raise err
 
2040
            report_activity(sent, 'write')
2250
2041
 
2251
2042
 
2252
2043
def dereference_path(path):
2271
2062
def resource_string(package, resource_name):
2272
2063
    """Load a resource from a package and return it as a string.
2273
2064
 
2274
 
    Note: Only packages that start with breezy are currently supported.
 
2065
    Note: Only packages that start with bzrlib are currently supported.
2275
2066
 
2276
2067
    This is designed to be a lightweight implementation of resource
2277
2068
    loading in a way which is API compatible with the same API from
2280
2071
    If and when pkg_resources becomes a standard library, this routine
2281
2072
    can delegate to it.
2282
2073
    """
2283
 
    # Check package name is within breezy
2284
 
    if package == "breezy":
 
2074
    # Check package name is within bzrlib
 
2075
    if package == "bzrlib":
2285
2076
        resource_relpath = resource_name
2286
 
    elif package.startswith("breezy."):
2287
 
        package = package[len("breezy."):].replace('.', os.sep)
 
2077
    elif package.startswith("bzrlib."):
 
2078
        package = package[len("bzrlib."):].replace('.', os.sep)
2288
2079
        resource_relpath = pathjoin(package, resource_name)
2289
2080
    else:
2290
 
        raise errors.BzrError('resource package %s not in breezy' % package)
 
2081
        raise errors.BzrError('resource package %s not in bzrlib' % package)
2291
2082
 
2292
2083
    # Map the resource to a file and read its contents
2293
 
    base = dirname(breezy.__file__)
 
2084
    base = dirname(bzrlib.__file__)
2294
2085
    if getattr(sys, 'frozen', None):    # bzr.exe
2295
2086
        base = abspath(pathjoin(base, '..', '..'))
2296
 
    with open(pathjoin(base, resource_relpath), "rt") as f:
2297
 
        return f.read()
 
2087
    filename = pathjoin(base, resource_relpath)
 
2088
    return open(filename, 'rU').read()
2298
2089
 
2299
2090
 
2300
2091
def file_kind_from_stat_mode_thunk(mode):
2301
2092
    global file_kind_from_stat_mode
2302
2093
    if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
2303
2094
        try:
2304
 
            from ._readdir_pyx import UTF8DirReader
 
2095
            from bzrlib._readdir_pyx import UTF8DirReader
2305
2096
            file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2306
 
        except ImportError:
 
2097
        except ImportError, e:
2307
2098
            # This is one time where we won't warn that an extension failed to
2308
2099
            # load. The extension is never available on Windows anyway.
2309
 
            from ._readdir_py import (
 
2100
            from bzrlib._readdir_py import (
2310
2101
                _kind_from_mode as file_kind_from_stat_mode
2311
2102
                )
2312
2103
    return file_kind_from_stat_mode(mode)
2313
 
 
2314
 
 
2315
2104
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2316
2105
 
2317
2106
 
2318
 
def file_stat(f, _lstat=os.lstat):
 
2107
def file_kind(f, _lstat=os.lstat):
2319
2108
    try:
2320
 
        # XXX cache?
2321
 
        return _lstat(f)
2322
 
    except OSError as e:
 
2109
        return file_kind_from_stat_mode(_lstat(f).st_mode)
 
2110
    except OSError, e:
2323
2111
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2324
2112
            raise errors.NoSuchFile(f)
2325
2113
        raise
2326
2114
 
2327
2115
 
2328
 
def file_kind(f, _lstat=os.lstat):
2329
 
    stat_value = file_stat(f, _lstat)
2330
 
    return file_kind_from_stat_mode(stat_value.st_mode)
2331
 
 
2332
 
 
2333
2116
def until_no_eintr(f, *a, **kw):
2334
2117
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2335
 
 
 
2118
    
2336
2119
    WARNING: you must be certain that it is safe to retry the call repeatedly
2337
2120
    if EINTR does occur.  This is typically only true for low-level operations
2338
2121
    like os.read.  If in any doubt, don't use this.
2340
2123
    Keep in mind that this is not a complete solution to EINTR.  There is
2341
2124
    probably code in the Python standard library and other dependencies that
2342
2125
    may encounter EINTR if a signal arrives (and there is signal handler for
2343
 
    that signal).  So this function can reduce the impact for IO that breezy
 
2126
    that signal).  So this function can reduce the impact for IO that bzrlib
2344
2127
    directly controls, but it is not a complete solution.
2345
2128
    """
2346
2129
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
2347
2130
    while True:
2348
2131
        try:
2349
2132
            return f(*a, **kw)
2350
 
        except (IOError, OSError) as e:
 
2133
        except (IOError, OSError), e:
2351
2134
            if e.errno == errno.EINTR:
2352
2135
                continue
2353
2136
            raise
2354
2137
 
2355
2138
 
 
2139
def re_compile_checked(re_string, flags=0, where=""):
 
2140
    """Return a compiled re, or raise a sensible error.
 
2141
 
 
2142
    This should only be used when compiling user-supplied REs.
 
2143
 
 
2144
    :param re_string: Text form of regular expression.
 
2145
    :param flags: eg re.IGNORECASE
 
2146
    :param where: Message explaining to the user the context where
 
2147
        it occurred, eg 'log search filter'.
 
2148
    """
 
2149
    # from https://bugs.launchpad.net/bzr/+bug/251352
 
2150
    try:
 
2151
        re_obj = re.compile(re_string, flags)
 
2152
        re_obj.search("")
 
2153
        return re_obj
 
2154
    except re.error, e:
 
2155
        if where:
 
2156
            where = ' in ' + where
 
2157
        # despite the name 'error' is a type
 
2158
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
 
2159
            % (where, re_string, e))
 
2160
 
 
2161
 
2356
2162
if sys.platform == "win32":
 
2163
    import msvcrt
2357
2164
    def getchar():
2358
 
        import msvcrt
2359
2165
        return msvcrt.getch()
2360
2166
else:
 
2167
    import tty
 
2168
    import termios
2361
2169
    def getchar():
2362
 
        import tty
2363
 
        import termios
2364
2170
        fd = sys.stdin.fileno()
2365
2171
        settings = termios.tcgetattr(fd)
2366
2172
        try:
2370
2176
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2371
2177
        return ch
2372
2178
 
2373
 
if sys.platform.startswith('linux'):
 
2179
 
 
2180
if sys.platform == 'linux2':
2374
2181
    def _local_concurrency():
2375
 
        try:
2376
 
            return os.sysconf('SC_NPROCESSORS_ONLN')
2377
 
        except (ValueError, OSError, AttributeError):
2378
 
            return None
 
2182
        concurrency = None
 
2183
        prefix = 'processor'
 
2184
        for line in file('/proc/cpuinfo', 'rb'):
 
2185
            if line.startswith(prefix):
 
2186
                concurrency = int(line[line.find(':')+1:]) + 1
 
2187
        return concurrency
2379
2188
elif sys.platform == 'darwin':
2380
2189
    def _local_concurrency():
2381
2190
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2382
2191
                                stdout=subprocess.PIPE).communicate()[0]
2383
 
elif "bsd" in sys.platform:
 
2192
elif sys.platform[0:7] == 'freebsd':
2384
2193
    def _local_concurrency():
2385
2194
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2386
2195
                                stdout=subprocess.PIPE).communicate()[0]
2387
2196
elif sys.platform == 'sunos5':
2388
2197
    def _local_concurrency():
2389
 
        return subprocess.Popen(['psrinfo', '-p', ],
 
2198
        return subprocess.Popen(['psrinfo', '-p',],
2390
2199
                                stdout=subprocess.PIPE).communicate()[0]
2391
2200
elif sys.platform == "win32":
2392
2201
    def _local_concurrency():
2400
2209
 
2401
2210
_cached_local_concurrency = None
2402
2211
 
2403
 
 
2404
2212
def local_concurrency(use_cache=True):
2405
2213
    """Return how many processes can be run concurrently.
2406
2214
 
2412
2220
    if _cached_local_concurrency is not None and use_cache:
2413
2221
        return _cached_local_concurrency
2414
2222
 
2415
 
    concurrency = os.environ.get('BRZ_CONCURRENCY', None)
 
2223
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2416
2224
    if concurrency is None:
2417
 
        import multiprocessing
2418
2225
        try:
2419
 
            concurrency = multiprocessing.cpu_count()
2420
 
        except NotImplementedError:
2421
 
            # multiprocessing.cpu_count() isn't implemented on all platforms
2422
 
            try:
2423
 
                concurrency = _local_concurrency()
2424
 
            except (OSError, IOError):
2425
 
                pass
 
2226
            concurrency = _local_concurrency()
 
2227
        except (OSError, IOError):
 
2228
            pass
2426
2229
    try:
2427
2230
        concurrency = int(concurrency)
2428
2231
    except (TypeError, ValueError):
2429
2232
        concurrency = 1
2430
2233
    if use_cache:
2431
 
        _cached_local_concurrency = concurrency
 
2234
        _cached_concurrency = concurrency
2432
2235
    return concurrency
2433
2236
 
2434
2237
 
2440
2243
        self.encode = encode
2441
2244
 
2442
2245
    def write(self, object):
2443
 
        if isinstance(object, str):
 
2246
        if type(object) is str:
2444
2247
            self.stream.write(object)
2445
2248
        else:
2446
2249
            data, _ = self.encode(object, self.errors)
2447
2250
            self.stream.write(data)
2448
2251
 
2449
 
 
2450
2252
if sys.platform == 'win32':
2451
2253
    def open_file(filename, mode='r', bufsize=-1):
2452
2254
        """This function is used to override the ``open`` builtin.
2453
 
 
 
2255
        
2454
2256
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2455
2257
        child processes.  Deleting or renaming a closed file opened with this
2456
2258
        function is not blocking child processes.
2480
2282
            else:
2481
2283
                flags |= os.O_WRONLY
2482
2284
            flags |= os.O_CREAT | os.O_APPEND
2483
 
        else:  # reading
 
2285
        else: #reading
2484
2286
            if updating:
2485
2287
                flags |= os.O_RDWR
2486
2288
            else:
2489
2291
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2490
2292
else:
2491
2293
    open_file = open
2492
 
 
2493
 
 
2494
 
def available_backup_name(base, exists):
2495
 
    """Find a non-existing backup file name.
2496
 
 
2497
 
    This will *not* create anything, this only return a 'free' entry.  This
2498
 
    should be used for checking names in a directory below a locked
2499
 
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
2500
 
    Leap) and generally discouraged.
2501
 
 
2502
 
    :param base: The base name.
2503
 
 
2504
 
    :param exists: A callable returning True if the path parameter exists.
2505
 
    """
2506
 
    counter = 1
2507
 
    name = "%s.~%d~" % (base, counter)
2508
 
    while exists(name):
2509
 
        counter += 1
2510
 
        name = "%s.~%d~" % (base, counter)
2511
 
    return name
2512
 
 
2513
 
 
2514
 
def set_fd_cloexec(fd):
2515
 
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
2516
 
    support for this is not available.
2517
 
    """
2518
 
    try:
2519
 
        import fcntl
2520
 
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
2521
 
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
2522
 
    except (ImportError, AttributeError):
2523
 
        # Either the fcntl module or specific constants are not present
2524
 
        pass
2525
 
 
2526
 
 
2527
 
def find_executable_on_path(name):
2528
 
    """Finds an executable on the PATH.
2529
 
 
2530
 
    On Windows, this will try to append each extension in the PATHEXT
2531
 
    environment variable to the name, if it cannot be found with the name
2532
 
    as given.
2533
 
 
2534
 
    :param name: The base name of the executable.
2535
 
    :return: The path to the executable found or None.
2536
 
    """
2537
 
    if sys.platform == 'win32':
2538
 
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
2539
 
        exts = [ext.lower() for ext in exts]
2540
 
        base, ext = os.path.splitext(name)
2541
 
        if ext != '':
2542
 
            if ext.lower() not in exts:
2543
 
                return None
2544
 
            name = base
2545
 
            exts = [ext]
2546
 
    else:
2547
 
        exts = ['']
2548
 
    path = os.environ.get('PATH')
2549
 
    if path is not None:
2550
 
        path = path.split(os.pathsep)
2551
 
        for ext in exts:
2552
 
            for d in path:
2553
 
                f = os.path.join(d, name) + ext
2554
 
                if os.access(f, os.X_OK):
2555
 
                    return f
2556
 
    if sys.platform == 'win32':
2557
 
        app_path = win32utils.get_app_path(name)
2558
 
        if app_path != name:
2559
 
            return app_path
2560
 
    return None
2561
 
 
2562
 
 
2563
 
def _posix_is_local_pid_dead(pid):
2564
 
    """True if pid doesn't correspond to live process on this machine"""
2565
 
    try:
2566
 
        # Special meaning of unix kill: just check if it's there.
2567
 
        os.kill(pid, 0)
2568
 
    except OSError as e:
2569
 
        if e.errno == errno.ESRCH:
2570
 
            # On this machine, and really not found: as sure as we can be
2571
 
            # that it's dead.
2572
 
            return True
2573
 
        elif e.errno == errno.EPERM:
2574
 
            # exists, though not ours
2575
 
            return False
2576
 
        else:
2577
 
            trace.mutter("os.kill(%d, 0) failed: %s" % (pid, e))
2578
 
            # Don't really know.
2579
 
            return False
2580
 
    else:
2581
 
        # Exists and our process: not dead.
2582
 
        return False
2583
 
 
2584
 
 
2585
 
if sys.platform == "win32":
2586
 
    is_local_pid_dead = win32utils.is_local_pid_dead
2587
 
else:
2588
 
    is_local_pid_dead = _posix_is_local_pid_dead
2589
 
 
2590
 
_maybe_ignored = ['EAGAIN', 'EINTR', 'ENOTSUP', 'EOPNOTSUPP', 'EACCES']
2591
 
_fdatasync_ignored = [getattr(errno, name) for name in _maybe_ignored
2592
 
                      if getattr(errno, name, None) is not None]
2593
 
 
2594
 
 
2595
 
def fdatasync(fileno):
2596
 
    """Flush file contents to disk if possible.
2597
 
 
2598
 
    :param fileno: Integer OS file handle.
2599
 
    :raises TransportNotPossible: If flushing to disk is not possible.
2600
 
    """
2601
 
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
2602
 
    if fn is not None:
2603
 
        try:
2604
 
            fn(fileno)
2605
 
        except IOError as e:
2606
 
            # See bug #1075108, on some platforms fdatasync exists, but can
2607
 
            # raise ENOTSUP. However, we are calling fdatasync to be helpful
2608
 
            # and reduce the chance of corruption-on-powerloss situations. It
2609
 
            # is not a mandatory call, so it is ok to suppress failures.
2610
 
            trace.mutter("ignoring error calling fdatasync: %s" % (e,))
2611
 
            if getattr(e, 'errno', None) not in _fdatasync_ignored:
2612
 
                raise
2613
 
 
2614
 
 
2615
 
def ensure_empty_directory_exists(path, exception_class):
2616
 
    """Make sure a local directory exists and is empty.
2617
 
 
2618
 
    If it does not exist, it is created.  If it exists and is not empty, an
2619
 
    instance of exception_class is raised.
2620
 
    """
2621
 
    try:
2622
 
        os.mkdir(path)
2623
 
    except OSError as e:
2624
 
        if e.errno != errno.EEXIST:
2625
 
            raise
2626
 
        if os.listdir(path) != []:
2627
 
            raise exception_class(path)
2628
 
 
2629
 
 
2630
 
def is_environment_error(evalue):
2631
 
    """True if exception instance is due to a process environment issue
2632
 
 
2633
 
    This includes OSError and IOError, but also other errors that come from
2634
 
    the operating system or core libraries but are not subclasses of those.
2635
 
    """
2636
 
    if isinstance(evalue, (EnvironmentError, select.error)):
2637
 
        return True
2638
 
    if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
2639
 
        return True
2640
 
    return False
2641
 
 
2642
 
 
2643
 
def read_mtab(path):
2644
 
    """Read an fstab-style file and extract mountpoint+filesystem information.
2645
 
 
2646
 
    :param path: Path to read from
2647
 
    :yield: Tuples with mountpoints (as bytestrings) and filesystem names
2648
 
    """
2649
 
    with open(path, 'rb') as f:
2650
 
        for line in f:
2651
 
            if line.startswith(b'#'):
2652
 
                continue
2653
 
            cols = line.split()
2654
 
            if len(cols) < 3:
2655
 
                continue
2656
 
            yield cols[1], cols[2].decode('ascii', 'replace')
2657
 
 
2658
 
 
2659
 
MTAB_PATH = '/etc/mtab'
2660
 
 
2661
 
class FilesystemFinder(object):
2662
 
    """Find the filesystem for a particular path."""
2663
 
 
2664
 
    def __init__(self, mountpoints):
2665
 
        def key(x):
2666
 
            return len(x[0])
2667
 
        self._mountpoints = sorted(mountpoints, key=key, reverse=True)
2668
 
 
2669
 
    @classmethod
2670
 
    def from_mtab(cls):
2671
 
        """Create a FilesystemFinder from an mtab-style file.
2672
 
 
2673
 
        Note that this will silenty ignore mtab if it doesn't exist or can not
2674
 
        be opened.
2675
 
        """
2676
 
        # TODO(jelmer): Use inotify to be notified when /etc/mtab changes and
2677
 
        # we need to re-read it.
2678
 
        try:
2679
 
            return cls(read_mtab(MTAB_PATH))
2680
 
        except EnvironmentError as e:
2681
 
            trace.mutter('Unable to read mtab: %s', e)
2682
 
            return cls([])
2683
 
 
2684
 
    def find(self, path):
2685
 
        """Find the filesystem used by a particular path.
2686
 
 
2687
 
        :param path: Path to find (bytestring or text type)
2688
 
        :return: Filesystem name (as text type) or None, if the filesystem is
2689
 
            unknown.
2690
 
        """
2691
 
        for mountpoint, filesystem in self._mountpoints:
2692
 
            if is_inside(mountpoint, path):
2693
 
                return filesystem
2694
 
        return None
2695
 
 
2696
 
 
2697
 
_FILESYSTEM_FINDER = None
2698
 
 
2699
 
 
2700
 
def get_fs_type(path):
2701
 
    """Return the filesystem type for the partition a path is in.
2702
 
 
2703
 
    :param path: Path to search filesystem type for
2704
 
    :return: A FS type, as string. E.g. "ext2"
2705
 
    """
2706
 
    global _FILESYSTEM_FINDER
2707
 
    if _FILESYSTEM_FINDER is None:
2708
 
        _FILESYSTEM_FINDER = FilesystemFinder.from_mtab()
2709
 
 
2710
 
    if not isinstance(path, bytes):
2711
 
        path = path.encode(_fs_enc)
2712
 
 
2713
 
    return _FILESYSTEM_FINDER.find(path)
2714
 
 
2715
 
 
2716
 
if PY3:
2717
 
    perf_counter = time.perf_counter
2718
 
else:
2719
 
    perf_counter = time.clock