/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Robert Collins
  • Date: 2010-05-06 23:41:35 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506234135-yivbzczw1sejxnxc
Lock methods on ``Tree``, ``Branch`` and ``Repository`` are now
expected to return an object which can be used to unlock them. This reduces
duplicate code when using cleanups. The previous 'tokens's returned by
``Branch.lock_write`` and ``Repository.lock_write`` are now attributes
on the result of the lock_write. ``repository.RepositoryWriteLockResult``
and ``branch.BranchWriteLockResult`` document this. (Robert Collins)

``log._get_info_for_log_files`` now takes an add_cleanup callable.
(Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/osutils.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
from __future__ import absolute_import
18
 
 
19
 
import errno
20
17
import os
21
18
import re
22
19
import stat
 
20
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
23
21
import sys
24
22
import time
25
23
import codecs
26
24
 
27
 
from .lazy_import import lazy_import
 
25
from bzrlib.lazy_import import lazy_import
28
26
lazy_import(globals(), """
29
27
from datetime import datetime
30
 
import getpass
31
 
import locale
32
 
import ntpath
 
28
import errno
 
29
from ntpath import (abspath as _nt_abspath,
 
30
                    join as _nt_join,
 
31
                    normpath as _nt_normpath,
 
32
                    realpath as _nt_realpath,
 
33
                    splitdrive as _nt_splitdrive,
 
34
                    )
33
35
import posixpath
34
 
import select
35
 
# We need to import both shutil and rmtree as we export the later on posix
36
 
# and need the former on windows
37
36
import shutil
38
 
from shutil import rmtree
 
37
from shutil import (
 
38
    rmtree,
 
39
    )
39
40
import socket
40
41
import subprocess
41
 
# We need to import both tempfile and mkdtemp as we export the later on posix
42
 
# and need the former on windows
43
42
import tempfile
44
 
from tempfile import mkdtemp
 
43
from tempfile import (
 
44
    mkdtemp,
 
45
    )
45
46
import unicodedata
46
47
 
47
 
from breezy import (
48
 
    config,
 
48
from bzrlib import (
 
49
    cache_utf8,
 
50
    errors,
49
51
    trace,
50
52
    win32utils,
51
53
    )
52
 
from breezy.i18n import gettext
53
54
""")
54
55
 
55
 
from .sixish import (
56
 
    PY3,
57
 
    text_type,
58
 
    )
59
 
 
60
 
from hashlib import (
61
 
    md5,
62
 
    sha1 as sha,
63
 
    )
64
 
 
65
 
 
66
 
import breezy
67
 
from . import (
68
 
    _fs_enc,
69
 
    errors,
70
 
    )
71
 
 
 
56
from bzrlib.symbol_versioning import (
 
57
    deprecated_function,
 
58
    deprecated_in,
 
59
    )
 
60
 
 
61
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
 
62
# of 2.5
 
63
if sys.version_info < (2, 5):
 
64
    import md5 as _mod_md5
 
65
    md5 = _mod_md5.new
 
66
    import sha as _mod_sha
 
67
    sha = _mod_sha.new
 
68
else:
 
69
    from hashlib import (
 
70
        md5,
 
71
        sha1 as sha,
 
72
        )
 
73
 
 
74
 
 
75
import bzrlib
 
76
from bzrlib import symbol_versioning
 
77
 
 
78
 
 
79
# Cross platform wall-clock time functionality with decent resolution.
 
80
# On Linux ``time.clock`` returns only CPU time. On Windows, ``time.time()``
 
81
# only has a resolution of ~15ms. Note that ``time.clock()`` is not
 
82
# synchronized with ``time.time()``, this is only meant to be used to find
 
83
# delta times by subtracting from another call to this function.
 
84
timer_func = time.time
 
85
if sys.platform == 'win32':
 
86
    timer_func = time.clock
72
87
 
73
88
# On win32, O_BINARY is used to indicate the file should
74
89
# be opened in binary mode, rather than text mode.
81
96
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
82
97
 
83
98
 
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
99
def get_unicode_argv():
94
 
    if PY3:
95
 
        return sys.argv[1:]
96
100
    try:
97
101
        user_encoding = get_user_encoding()
98
102
        return [a.decode(user_encoding) for a in sys.argv[1:]]
99
103
    except UnicodeDecodeError:
100
 
        raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
101
 
                                      "application locale.").format(a, user_encoding))
 
104
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
 
105
                                                            "encoding." % a))
102
106
 
103
107
 
104
108
def make_readonly(filename):
105
109
    """Make a filename read-only."""
106
110
    mod = os.lstat(filename).st_mode
107
111
    if not stat.S_ISLNK(mod):
108
 
        mod = mod & 0o777555
109
 
        chmod_if_possible(filename, mod)
 
112
        mod = mod & 0777555
 
113
        os.chmod(filename, mod)
110
114
 
111
115
 
112
116
def make_writable(filename):
113
117
    mod = os.lstat(filename).st_mode
114
118
    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
 
119
        mod = mod | 0200
 
120
        os.chmod(filename, mod)
136
121
 
137
122
 
138
123
def minimum_path_selection(paths):
146
131
        return set(paths)
147
132
 
148
133
    def sort_key(path):
149
 
        if isinstance(path, bytes):
150
 
            return path.split(b'/')
151
 
        else:
152
 
            return path.split('/')
 
134
        return path.split('/')
153
135
    sorted_paths = sorted(list(paths), key=sort_key)
154
136
 
155
137
    search_paths = [sorted_paths[0]]
182
164
 
183
165
_directory_kind = 'directory'
184
166
 
185
 
 
186
167
def get_umask():
187
168
    """Return the current umask"""
188
169
    # Assume that people aren't messing with the umask while running
217
198
            stat = getattr(os, 'lstat', os.stat)
218
199
            stat(f)
219
200
            return True
220
 
        except OSError as e:
 
201
        except OSError, e:
221
202
            if e.errno == errno.ENOENT:
222
 
                return False
 
203
                return False;
223
204
            else:
224
 
                raise errors.BzrError(
225
 
                    gettext("lstat/stat of ({0!r}): {1!r}").format(f, e))
 
205
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
226
206
 
227
207
 
228
208
def fancy_rename(old, new, rename_func, unlink_func):
252
232
    file_existed = False
253
233
    try:
254
234
        rename_func(new, tmp_name)
255
 
    except (errors.NoSuchFile,):
 
235
    except (errors.NoSuchFile,), e:
256
236
        pass
257
 
    except IOError as e:
 
237
    except IOError, e:
258
238
        # RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
259
239
        # function raises an IOError with errno is None when a rename fails.
260
240
        # This then gets caught here.
261
241
        if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
262
242
            raise
263
 
    except Exception as e:
 
243
    except Exception, e:
264
244
        if (getattr(e, 'errno', None) is None
265
 
                or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
 
245
            or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
266
246
            raise
267
247
    else:
268
248
        file_existed = True
269
249
 
 
250
    failure_exc = None
270
251
    success = False
271
252
    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)
 
253
        try:
 
254
            # This may throw an exception, in which case success will
 
255
            # not be set.
 
256
            rename_func(old, new)
 
257
            success = True
 
258
        except (IOError, OSError), e:
 
259
            # source and target may be aliases of each other (e.g. on a
 
260
            # case-insensitive filesystem), so we may have accidentally renamed
 
261
            # source by when we tried to rename target
 
262
            failure_exc = sys.exc_info()
 
263
            if (file_existed and e.errno in (None, errno.ENOENT)
281
264
                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
 
265
                # source and target are the same file on a case-insensitive
 
266
                # filesystem, so we don't generate an exception
 
267
                failure_exc = None
287
268
    finally:
288
269
        if file_existed:
289
270
            # If the file used to exist, rename it back into place
292
273
                unlink_func(tmp_name)
293
274
            else:
294
275
                rename_func(tmp_name, new)
 
276
    if failure_exc is not None:
 
277
        raise failure_exc[0], failure_exc[1], failure_exc[2]
295
278
 
296
279
 
297
280
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
298
281
# choke on a Unicode string containing a relative path if
299
282
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
300
283
# string.
 
284
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
301
285
def _posix_abspath(path):
302
286
    # jam 20060426 rather than encoding to fsencoding
303
287
    # copy posixpath.abspath, but use os.getcwdu instead
304
288
    if not posixpath.isabs(path):
305
289
        path = posixpath.join(getcwd(), path)
306
 
    return _posix_normpath(path)
 
290
    return posixpath.normpath(path)
307
291
 
308
292
 
309
293
def _posix_realpath(path):
310
294
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
311
295
 
312
296
 
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
297
def _win32_fixdrive(path):
369
298
    """Force drive letters to be consistent.
370
299
 
374
303
    running python.exe under cmd.exe return capital C:\\
375
304
    running win32 python inside a cygwin shell returns lowercase c:\\
376
305
    """
377
 
    drive, path = ntpath.splitdrive(path)
 
306
    drive, path = _nt_splitdrive(path)
378
307
    return drive.upper() + path
379
308
 
380
309
 
381
310
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('\\', '/'))
 
311
    # Real _nt_abspath doesn't have a problem with a unicode cwd
 
312
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
 
313
 
 
314
 
 
315
def _win98_abspath(path):
 
316
    """Return the absolute version of a path.
 
317
    Windows 98 safe implementation (python reimplementation
 
318
    of Win32 API function GetFullPathNameW)
 
319
    """
 
320
    # Corner cases:
 
321
    #   C:\path     => C:/path
 
322
    #   C:/path     => C:/path
 
323
    #   \\HOST\path => //HOST/path
 
324
    #   //HOST/path => //HOST/path
 
325
    #   path        => C:/cwd/path
 
326
    #   /path       => C:/path
 
327
    path = unicode(path)
 
328
    # check for absolute path
 
329
    drive = _nt_splitdrive(path)[0]
 
330
    if drive == '' and path[:2] not in('//','\\\\'):
 
331
        cwd = os.getcwdu()
 
332
        # we cannot simply os.path.join cwd and path
 
333
        # because os.path.join('C:','/path') produce '/path'
 
334
        # and this is incorrect
 
335
        if path[:1] in ('/','\\'):
 
336
            cwd = _nt_splitdrive(cwd)[0]
 
337
            path = path[1:]
 
338
        path = cwd + '\\' + path
 
339
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
384
340
 
385
341
 
386
342
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('\\', '/'))
 
343
    # Real _nt_realpath doesn't have a problem with a unicode cwd
 
344
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
389
345
 
390
346
 
391
347
def _win32_pathjoin(*args):
392
 
    return ntpath.join(*args).replace('\\', '/')
 
348
    return _nt_join(*args).replace('\\', '/')
393
349
 
394
350
 
395
351
def _win32_normpath(path):
396
 
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
 
352
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
397
353
 
398
354
 
399
355
def _win32_getcwd():
400
 
    return _win32_fixdrive(_getcwd().replace('\\', '/'))
 
356
    return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
401
357
 
402
358
 
403
359
def _win32_mkdtemp(*args, **kwargs):
404
360
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
405
361
 
406
362
 
 
363
def _add_rename_error_details(e, old, new):
 
364
    new_e = OSError(e.errno, "failed to rename %s to %s: %s"
 
365
        % (old, new, e.strerror))
 
366
    new_e.filename = old
 
367
    new_e.to_filename = new
 
368
    return new_e
 
369
 
 
370
 
407
371
def _win32_rename(old, new):
408
372
    """We expect to be able to atomically replace 'new' with old.
409
373
 
411
375
    and then deleted.
412
376
    """
413
377
    try:
414
 
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
415
 
    except OSError as e:
 
378
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
 
379
    except OSError, e:
416
380
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
417
381
            # If we try to rename a non-existant file onto cwd, we get
418
382
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT
422
386
        raise
423
387
 
424
388
 
 
389
def _wrapped_rename(old, new):
 
390
    """Rename a file or directory"""
 
391
    try:
 
392
        os.rename(old, new)
 
393
    except (IOError, OSError), e:
 
394
        # this is eventually called by all rename-like functions, so should 
 
395
        # catch all of them
 
396
        raise _add_rename_error_details(e, old, new)
 
397
 
 
398
 
425
399
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)
 
400
    return unicodedata.normalize('NFC', os.getcwdu())
 
401
 
458
402
 
459
403
# Default is to just use the python builtins, but these can be rebound on
460
404
# particular platforms.
461
405
abspath = _posix_abspath
462
406
realpath = _posix_realpath
463
407
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
 
408
normpath = os.path.normpath
 
409
rename = _wrapped_rename # overridden below on win32
 
410
getcwd = os.getcwdu
469
411
dirname = os.path.dirname
470
412
basename = os.path.basename
471
413
split = os.path.split
472
414
splitext = os.path.splitext
473
 
# These were already lazily imported into local scope
 
415
# These were already imported into local scope
474
416
# mkdtemp = tempfile.mkdtemp
475
417
# rmtree = shutil.rmtree
476
 
lstat = os.lstat
477
 
fstat = os.fstat
478
 
 
479
 
 
480
 
def wrap_stat(st):
481
 
    return st
482
 
 
483
418
 
484
419
MIN_ABS_PATHLENGTH = 1
485
420
 
486
421
 
487
422
if sys.platform == 'win32':
488
 
    abspath = _win32_abspath
 
423
    if win32utils.winver == 'Windows 98':
 
424
        abspath = _win98_abspath
 
425
    else:
 
426
        abspath = _win32_abspath
489
427
    realpath = _win32_realpath
490
428
    pathjoin = _win32_pathjoin
491
429
    normpath = _win32_normpath
492
430
    getcwd = _win32_getcwd
493
431
    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
 
432
    rename = _win32_rename
503
433
 
504
434
    MIN_ABS_PATHLENGTH = 3
505
435
 
509
439
        """
510
440
        exception = excinfo[1]
511
441
        if function in (os.remove, os.rmdir) \
512
 
                and isinstance(exception, OSError) \
513
 
                and exception.errno == errno.EACCES:
 
442
            and isinstance(exception, OSError) \
 
443
            and exception.errno == errno.EACCES:
514
444
            make_writable(path)
515
445
            function(path)
516
446
        else:
520
450
        """Replacer for shutil.rmtree: could remove readonly dirs/files"""
521
451
        return shutil.rmtree(path, ignore_errors, onerror)
522
452
 
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
 
453
    f = win32utils.get_unicode_argv     # special function or None
 
454
    if f is not None:
 
455
        get_unicode_argv = f
527
456
 
528
457
elif sys.platform == 'darwin':
529
458
    getcwd = _mac_getcwd
530
459
 
531
460
 
532
 
def get_terminal_encoding(trace=False):
 
461
def get_terminal_encoding():
533
462
    """Find the best encoding for printing to the screen.
534
463
 
535
464
    This attempts to check both sys.stdout and sys.stdin to see
541
470
 
542
471
    On my standard US Windows XP, the preferred encoding is
543
472
    cp1252, but the console is cp437
544
 
 
545
 
    :param trace: If True trace the selected encoding via mutter().
546
473
    """
547
 
    from .trace import mutter
 
474
    from bzrlib.trace import mutter
548
475
    output_encoding = getattr(sys.stdout, 'encoding', None)
549
476
    if not output_encoding:
550
477
        input_encoding = getattr(sys.stdin, 'encoding', None)
551
478
        if not input_encoding:
552
479
            output_encoding = get_user_encoding()
553
 
            if trace:
554
 
                mutter('encoding stdout as osutils.get_user_encoding() %r',
555
 
                       output_encoding)
 
480
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
481
                   output_encoding)
556
482
        else:
557
483
            output_encoding = input_encoding
558
 
            if trace:
559
 
                mutter('encoding stdout as sys.stdin encoding %r',
560
 
                       output_encoding)
 
484
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
561
485
    else:
562
 
        if trace:
563
 
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
486
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
564
487
    if output_encoding == 'cp0':
565
488
        # invalid encoding (cp0 means 'no codepage' on Windows)
566
489
        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)
 
490
        mutter('cp0 is invalid encoding.'
 
491
               ' encoding stdout as osutils.get_user_encoding() %r',
 
492
               output_encoding)
571
493
    # check encoding
572
494
    try:
573
495
        codecs.lookup(output_encoding)
574
496
    except LookupError:
575
 
        sys.stderr.write('brz: warning:'
 
497
        sys.stderr.write('bzr: warning:'
576
498
                         ' unknown terminal encoding %s.\n'
577
499
                         '  Using encoding %s instead.\n'
578
500
                         % (output_encoding, get_user_encoding())
579
 
                         )
 
501
                        )
580
502
        output_encoding = get_user_encoding()
581
503
 
582
504
    return output_encoding
587
509
        F = realpath
588
510
    else:
589
511
        F = abspath
590
 
    [p, e] = os.path.split(f)
 
512
    [p,e] = os.path.split(f)
591
513
    if e == "" or e == "." or e == "..":
592
514
        return F(f)
593
515
    else:
597
519
def isdir(f):
598
520
    """True if f is an accessible directory."""
599
521
    try:
600
 
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
 
522
        return S_ISDIR(os.lstat(f)[ST_MODE])
601
523
    except OSError:
602
524
        return False
603
525
 
605
527
def isfile(f):
606
528
    """True if f is a regular file."""
607
529
    try:
608
 
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
 
530
        return S_ISREG(os.lstat(f)[ST_MODE])
609
531
    except OSError:
610
532
        return False
611
533
 
612
 
 
613
534
def islink(f):
614
535
    """True if f is a symlink."""
615
536
    try:
616
 
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
 
537
        return S_ISLNK(os.lstat(f)[ST_MODE])
617
538
    except OSError:
618
539
        return False
619
540
 
620
 
 
621
541
def is_inside(dir, fname):
622
542
    """True if fname is inside dir.
623
543
 
633
553
    if dir == fname:
634
554
        return True
635
555
 
636
 
    if dir in ('', b''):
 
556
    if dir == '':
637
557
        return True
638
558
 
639
 
    if isinstance(dir, bytes):
640
 
        if not dir.endswith(b'/'):
641
 
            dir += b'/'
642
 
    else:
643
 
        if not dir.endswith('/'):
644
 
            dir += '/'
 
559
    if dir[-1] != '/':
 
560
        dir += '/'
645
561
 
646
562
    return fname.startswith(dir)
647
563
 
720
636
    # writes fail on some platforms (e.g. Windows with SMB  mounted
721
637
    # drives).
722
638
    if not segment_size:
723
 
        segment_size = 5242880  # 5MB
724
 
    offsets = range(0, len(bytes), segment_size)
725
 
    view = memoryview(bytes)
 
639
        segment_size = 5242880 # 5MB
 
640
    segments = range(len(bytes) / segment_size + 1)
726
641
    write = file_handle.write
727
 
    for offset in offsets:
728
 
        write(view[offset:offset + segment_size])
 
642
    for segment_index in segments:
 
643
        segment = buffer(bytes, segment_index * segment_size, segment_size)
 
644
        write(segment)
729
645
 
730
646
 
731
647
def file_iterator(input_file, readsize=32768):
736
652
        yield b
737
653
 
738
654
 
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
655
def sha_file(f):
750
656
    """Calculate the hexdigest of an open file.
751
657
 
752
658
    The file cursor should be already at the start.
753
659
    """
754
660
    s = sha()
755
 
    BUFSIZE = 128 << 10
 
661
    BUFSIZE = 128<<10
756
662
    while True:
757
663
        b = f.read(BUFSIZE)
758
664
        if not b:
759
665
            break
760
666
        s.update(b)
761
 
    return _hexdigest(s)
 
667
    return s.hexdigest()
762
668
 
763
669
 
764
670
def size_sha_file(f):
769
675
    """
770
676
    size = 0
771
677
    s = sha()
772
 
    BUFSIZE = 128 << 10
 
678
    BUFSIZE = 128<<10
773
679
    while True:
774
680
        b = f.read(BUFSIZE)
775
681
        if not b:
776
682
            break
777
683
        size += len(b)
778
684
        s.update(b)
779
 
    return size, _hexdigest(s)
 
685
    return size, s.hexdigest()
780
686
 
781
687
 
782
688
def sha_file_by_name(fname):
785
691
    f = os.open(fname, os.O_RDONLY | O_BINARY | O_NOINHERIT)
786
692
    try:
787
693
        while True:
788
 
            b = os.read(f, 1 << 16)
 
694
            b = os.read(f, 1<<16)
789
695
            if not b:
790
 
                return _hexdigest(s)
 
696
                return s.hexdigest()
791
697
            s.update(b)
792
698
    finally:
793
699
        os.close(f)
796
702
def sha_strings(strings, _factory=sha):
797
703
    """Return the sha-1 of concatenation of strings"""
798
704
    s = _factory()
799
 
    for string in strings:
800
 
        s.update(string)
801
 
    return _hexdigest(s)
 
705
    map(s.update, strings)
 
706
    return s.hexdigest()
802
707
 
803
708
 
804
709
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))
 
710
    return _factory(f).hexdigest()
807
711
 
808
712
 
809
713
def fingerprint_file(f):
810
714
    b = f.read()
811
715
    return {'size': len(b),
812
 
            'sha1': _hexdigest(sha(b))}
 
716
            'sha1': sha(b).hexdigest()}
813
717
 
814
718
 
815
719
def compare_files(a, b):
820
724
        bi = b.read(BUFSIZE)
821
725
        if ai != bi:
822
726
            return False
823
 
        if not ai:
 
727
        if ai == '':
824
728
            return True
825
729
 
826
730
 
831
735
    offset = datetime.fromtimestamp(t) - datetime.utcfromtimestamp(t)
832
736
    return offset.days * 86400 + offset.seconds
833
737
 
834
 
 
835
738
weekdays = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
836
739
_default_format_by_weekday_num = [wd + " %Y-%m-%d %H:%M:%S" for wd in weekdays]
837
740
 
849
752
    :param show_offset: Whether to append the timezone.
850
753
    """
851
754
    (date_fmt, tt, offset_str) = \
852
 
        _format_date(t, offset, timezone, date_fmt, show_offset)
 
755
               _format_date(t, offset, timezone, date_fmt, show_offset)
853
756
    date_fmt = date_fmt.replace('%a', weekdays[tt[6]])
854
757
    date_str = time.strftime(date_fmt, tt)
855
758
    return date_str + offset_str
860
763
 
861
764
 
862
765
def format_date_with_offset_in_original_timezone(t, offset=0,
863
 
                                                 _cache=_offset_cache):
 
766
    _cache=_offset_cache):
864
767
    """Return a formatted date string in the original timezone.
865
768
 
866
769
    This routine may be faster then format_date.
893
796
    :param show_offset: Whether to append the timezone.
894
797
    """
895
798
    (date_fmt, tt, offset_str) = \
896
 
        _format_date(t, offset, timezone, date_fmt, show_offset)
 
799
               _format_date(t, offset, timezone, date_fmt, show_offset)
897
800
    date_str = time.strftime(date_fmt, tt)
898
 
    if not isinstance(date_str, text_type):
 
801
    if not isinstance(date_str, unicode):
899
802
        date_str = date_str.decode(get_user_encoding(), 'replace')
900
803
    return date_str + offset_str
901
804
 
912
815
        tt = time.localtime(t)
913
816
        offset = local_time_offset(t)
914
817
    else:
915
 
        raise UnsupportedTimezoneFormat(timezone)
 
818
        raise errors.UnsupportedTimezoneFormat(timezone)
916
819
    if date_fmt is None:
917
820
        date_fmt = "%a %Y-%m-%d %H:%M:%S"
918
821
    if show_offset:
942
845
        delta = -delta
943
846
 
944
847
    seconds = delta
945
 
    if seconds < 90:  # print seconds up to 90 seconds
 
848
    if seconds < 90: # print seconds up to 90 seconds
946
849
        if seconds == 1:
947
850
            return '%d second %s' % (seconds, direction,)
948
851
        else:
954
857
        plural_seconds = ''
955
858
    else:
956
859
        plural_seconds = 's'
957
 
    if minutes < 90:  # print minutes, seconds up to 90 minutes
 
860
    if minutes < 90: # print minutes, seconds up to 90 minutes
958
861
        if minutes == 1:
959
862
            return '%d minute, %d second%s %s' % (
960
 
                minutes, seconds, plural_seconds, direction)
 
863
                    minutes, seconds, plural_seconds, direction)
961
864
        else:
962
865
            return '%d minutes, %d second%s %s' % (
963
 
                minutes, seconds, plural_seconds, direction)
 
866
                    minutes, seconds, plural_seconds, direction)
964
867
 
965
868
    hours = int(minutes / 60)
966
869
    minutes -= 60 * hours
975
878
    return '%d hours, %d minute%s %s' % (hours, minutes,
976
879
                                         plural_minutes, direction)
977
880
 
978
 
 
979
881
def filesize(f):
980
882
    """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":
 
883
    return os.fstat(f.fileno())[ST_SIZE]
 
884
 
 
885
 
 
886
# Define rand_bytes based on platform.
 
887
try:
 
888
    # Python 2.4 and later have os.urandom,
 
889
    # but it doesn't work on some arches
 
890
    os.urandom(1)
 
891
    rand_bytes = os.urandom
 
892
except (NotImplementedError, AttributeError):
 
893
    # If python doesn't have os.urandom, or it doesn't work,
 
894
    # then try to first pull random data from /dev/urandom
991
895
    try:
992
 
        rand_bytes(1)
993
 
    except NotImplementedError:
 
896
        rand_bytes = file('/dev/urandom', 'rb').read
 
897
    # Otherwise, use this hack as a last resort
 
898
    except (IOError, OSError):
994
899
        # not well seeded, but better than nothing
995
900
        def rand_bytes(n):
996
901
            import random
1002
907
 
1003
908
 
1004
909
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
1005
 
 
1006
 
 
1007
910
def rand_chars(num):
1008
911
    """Return a random string of num alphanumeric characters
1009
912
 
1012
915
    """
1013
916
    s = ''
1014
917
    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]
 
918
        s += ALNUM[ord(raw_byte) % 36]
1019
919
    return s
1020
920
 
1021
921
 
1022
 
# TODO: We could later have path objects that remember their list
1023
 
# decomposition (might be too tricksy though.)
 
922
## TODO: We could later have path objects that remember their list
 
923
## decomposition (might be too tricksy though.)
1024
924
 
1025
925
def splitpath(p):
1026
926
    """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 = ('.', '')
 
927
    # split on either delimiter because people might use either on
 
928
    # Windows
 
929
    ps = re.split(r'[\\/]', p)
1047
930
 
1048
931
    rps = []
1049
932
    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:
 
933
        if f == '..':
 
934
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
935
        elif (f == '.') or (f == ''):
1053
936
            pass
1054
937
        else:
1055
938
            rps.append(f)
1059
942
def joinpath(p):
1060
943
    for f in p:
1061
944
        if (f == '..') or (f is None) or (f == ''):
1062
 
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
 
945
            raise errors.BzrError("sorry, %r not allowed in path" % f)
1063
946
    return pathjoin(*p)
1064
947
 
1065
948
 
1066
949
def parent_directories(filename):
1067
950
    """Return the list of parent directories, deepest first.
1068
 
 
 
951
    
1069
952
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
1070
953
    """
1071
954
    parents = []
1087
970
    implementation should be loaded instead::
1088
971
 
1089
972
    >>> try:
1090
 
    >>>     import breezy._fictional_extension_pyx
 
973
    >>>     import bzrlib._fictional_extension_pyx
1091
974
    >>> except ImportError, e:
1092
 
    >>>     breezy.osutils.failed_to_load_extension(e)
1093
 
    >>>     import breezy._fictional_extension_py
 
975
    >>>     bzrlib.osutils.failed_to_load_extension(e)
 
976
    >>>     import bzrlib._fictional_extension_py
1094
977
    """
1095
978
    # NB: This docstring is just an example, not a doctest, because doctest
1096
979
    # currently can't cope with the use of lazy imports in this namespace --
1097
980
    # mbp 20090729
1098
 
 
 
981
    
1099
982
    # This currently doesn't report the failure at the time it occurs, because
1100
983
    # they tend to happen very early in startup when we can't check config
1101
984
    # files etc, and also we want to report all failures but not spam the user
1102
985
    # with 10 warnings.
 
986
    from bzrlib import trace
1103
987
    exception_str = str(exception)
1104
988
    if exception_str not in _extension_load_failures:
1105
989
        trace.mutter("failed to load compiled extension: %s" % exception_str)
1109
993
def report_extension_load_failures():
1110
994
    if not _extension_load_failures:
1111
995
        return
1112
 
    if config.GlobalConfig().suppress_warning('missing_extensions'):
 
996
    from bzrlib.config import GlobalConfig
 
997
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
1113
998
        return
1114
999
    # the warnings framework should by default show this only once
1115
 
    from .trace import warning
 
1000
    from bzrlib.trace import warning
1116
1001
    warning(
1117
 
        "brz: warning: some compiled extensions could not be loaded; "
1118
 
        "see ``brz help missing-extensions``")
 
1002
        "bzr: warning: some compiled extensions could not be loaded; "
 
1003
        "see <https://answers.launchpad.net/bzr/+faq/703>")
1119
1004
    # we no longer show the specific missing extensions here, because it makes
1120
1005
    # the message too long and scary - see
1121
1006
    # https://bugs.launchpad.net/bzr/+bug/430529
1122
1007
 
1123
1008
 
1124
1009
try:
1125
 
    from ._chunks_to_lines_pyx import chunks_to_lines
1126
 
except ImportError as e:
 
1010
    from bzrlib._chunks_to_lines_pyx import chunks_to_lines
 
1011
except ImportError, e:
1127
1012
    failed_to_load_extension(e)
1128
 
    from ._chunks_to_lines_py import chunks_to_lines
 
1013
    from bzrlib._chunks_to_lines_py import chunks_to_lines
1129
1014
 
1130
1015
 
1131
1016
def split_lines(s):
1132
1017
    """Split s into lines, but without removing the newline characters."""
1133
1018
    # Trivially convert a fulltext into a 'chunked' representation, and let
1134
1019
    # chunks_to_lines do the heavy lifting.
1135
 
    if isinstance(s, bytes):
 
1020
    if isinstance(s, str):
1136
1021
        # chunks_to_lines only supports 8-bit strings
1137
1022
        return chunks_to_lines([s])
1138
1023
    else:
1144
1029
 
1145
1030
    This supports Unicode or plain string objects.
1146
1031
    """
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]]
 
1032
    lines = s.split('\n')
 
1033
    result = [line + '\n' for line in lines[:-1]]
1150
1034
    if lines[-1]:
1151
1035
        result.append(lines[-1])
1152
1036
    return result
1163
1047
        return
1164
1048
    try:
1165
1049
        os.link(src, dest)
1166
 
    except (OSError, IOError) as e:
 
1050
    except (OSError, IOError), e:
1167
1051
        if e.errno != errno.EXDEV:
1168
1052
            raise
1169
1053
        shutil.copyfile(src, dest)
1170
1054
 
1171
1055
 
1172
1056
def delete_any(path):
1173
 
    """Delete a file, symlink or directory.
1174
 
 
 
1057
    """Delete a file, symlink or directory.  
 
1058
    
1175
1059
    Will delete even if readonly.
1176
1060
    """
1177
1061
    try:
1178
 
        _delete_file_or_dir(path)
1179
 
    except (OSError, IOError) as e:
 
1062
       _delete_file_or_dir(path)
 
1063
    except (OSError, IOError), e:
1180
1064
        if e.errno in (errno.EPERM, errno.EACCES):
1181
1065
            # make writable and try again
1182
1066
            try:
1194
1078
    # - root can damage a solaris file system by using unlink,
1195
1079
    # - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
1196
1080
    #   EACCES, OSX: EPERM) when invoked on a directory.
1197
 
    if isdir(path):  # Takes care of symlinks
 
1081
    if isdir(path): # Takes care of symlinks
1198
1082
        os.rmdir(path)
1199
1083
    else:
1200
1084
        os.unlink(path)
1242
1126
    #    separators
1243
1127
    # 3) '\xa0' isn't unicode safe since it is >128.
1244
1128
 
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:
 
1129
    # This should *not* be a unicode set of characters in case the source
 
1130
    # string is not a Unicode string. We can auto-up-cast the characters since
 
1131
    # they are ascii, but we don't want to auto-up-cast the string in case it
 
1132
    # is utf-8
 
1133
    for ch in ' \t\n\r\v\f':
1250
1134
        if ch in s:
1251
1135
            return True
1252
1136
    else:
1278
1162
 
1279
1163
    if len(base) < MIN_ABS_PATHLENGTH:
1280
1164
        # must have space for e.g. a drive letter
1281
 
        raise ValueError(gettext('%r is too short to calculate a relative path')
1282
 
                         % (base,))
 
1165
        raise ValueError('%r is too short to calculate a relative path'
 
1166
            % (base,))
1283
1167
 
1284
1168
    rp = abspath(path)
1285
1169
 
1330
1214
        lbit = bit.lower()
1331
1215
        try:
1332
1216
            next_entries = _listdir(current)
1333
 
        except OSError:  # enoent, eperm, etc
 
1217
        except OSError: # enoent, eperm, etc
1334
1218
            # We can't find this in the filesystem, so just append the
1335
1219
            # remaining bits.
1336
1220
            current = pathjoin(current, bit, *list(bit_iter))
1347
1231
            break
1348
1232
    return current[len(abs_base):].lstrip('/')
1349
1233
 
1350
 
 
1351
1234
# XXX - TODO - we need better detection/integration of case-insensitive
1352
1235
# file-systems; Linux often sees FAT32 devices (or NFS-mounted OSX
1353
1236
# filesystems), for example, so could probably benefit from the same basic
1358
1241
else:
1359
1242
    canonical_relpath = relpath
1360
1243
 
1361
 
 
1362
1244
def canonical_relpaths(base, paths):
1363
1245
    """Create an iterable to canonicalize a sequence of relative paths.
1364
1246
 
1368
1250
    # but for now, we haven't optimized...
1369
1251
    return [canonical_relpath(base, p) for p in paths]
1370
1252
 
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
1253
def safe_unicode(unicode_or_utf8_string):
1388
1254
    """Coerce unicode_or_utf8_string into unicode.
1389
1255
 
1391
1257
    Otherwise it is decoded from utf-8. If decoding fails, the exception is
1392
1258
    wrapped in a BzrBadParameterNotUnicode exception.
1393
1259
    """
1394
 
    if isinstance(unicode_or_utf8_string, text_type):
 
1260
    if isinstance(unicode_or_utf8_string, unicode):
1395
1261
        return unicode_or_utf8_string
1396
1262
    try:
1397
1263
        return unicode_or_utf8_string.decode('utf8')
1405
1271
    If it is a str, it is returned.
1406
1272
    If it is Unicode, it is encoded into a utf-8 string.
1407
1273
    """
1408
 
    if isinstance(unicode_or_utf8_string, bytes):
 
1274
    if isinstance(unicode_or_utf8_string, str):
1409
1275
        # TODO: jam 20070209 This is overkill, and probably has an impact on
1410
1276
        #       performance if we are dealing with lots of apis that want a
1411
1277
        #       utf-8 revision id
1418
1284
    return unicode_or_utf8_string.encode('utf-8')
1419
1285
 
1420
1286
 
1421
 
def safe_revision_id(unicode_or_utf8_string):
 
1287
_revision_id_warning = ('Unicode revision ids were deprecated in bzr 0.15.'
 
1288
                        ' Revision id generators should be creating utf8'
 
1289
                        ' revision ids.')
 
1290
 
 
1291
 
 
1292
def safe_revision_id(unicode_or_utf8_string, warn=True):
1422
1293
    """Revision ids should now be utf8, but at one point they were unicode.
1423
1294
 
1424
1295
    :param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
1425
1296
        utf8 or None).
 
1297
    :param warn: Functions that are sanitizing user data can set warn=False
1426
1298
    :return: None or a utf8 revision id.
1427
1299
    """
1428
1300
    if (unicode_or_utf8_string is None
1429
 
            or unicode_or_utf8_string.__class__ == bytes):
 
1301
        or unicode_or_utf8_string.__class__ == str):
1430
1302
        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):
 
1303
    if warn:
 
1304
        symbol_versioning.warn(_revision_id_warning, DeprecationWarning,
 
1305
                               stacklevel=2)
 
1306
    return cache_utf8.encode(unicode_or_utf8_string)
 
1307
 
 
1308
 
 
1309
_file_id_warning = ('Unicode file ids were deprecated in bzr 0.15. File id'
 
1310
                    ' generators should be creating utf8 file ids.')
 
1311
 
 
1312
 
 
1313
def safe_file_id(unicode_or_utf8_string, warn=True):
1437
1314
    """File ids should now be utf8, but at one point they were unicode.
1438
1315
 
1439
1316
    This is the same as safe_utf8, except it uses the cached encode functions
1441
1318
 
1442
1319
    :param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
1443
1320
        utf8 or None).
 
1321
    :param warn: Functions that are sanitizing user data can set warn=False
1444
1322
    :return: None or a utf8 file id.
1445
1323
    """
1446
1324
    if (unicode_or_utf8_string is None
1447
 
            or unicode_or_utf8_string.__class__ == bytes):
 
1325
        or unicode_or_utf8_string.__class__ == str):
1448
1326
        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.')
 
1327
    if warn:
 
1328
        symbol_versioning.warn(_file_id_warning, DeprecationWarning,
 
1329
                               stacklevel=2)
 
1330
    return cache_utf8.encode(unicode_or_utf8_string)
1451
1331
 
1452
1332
 
1453
1333
_platform_normalizes_filenames = False
1458
1338
def normalizes_filenames():
1459
1339
    """Return True if this platform normalizes unicode filenames.
1460
1340
 
1461
 
    Only Mac OSX.
 
1341
    Mac OSX does, Windows/Linux do not.
1462
1342
    """
1463
1343
    return _platform_normalizes_filenames
1464
1344
 
1469
1349
    On platforms where the system normalizes filenames (Mac OSX),
1470
1350
    you can access a file by any path which will normalize correctly.
1471
1351
    On platforms where the system does not normalize filenames
1472
 
    (everything else), you have to access a file by its exact path.
 
1352
    (Windows, Linux), you have to access a file by its exact path.
1473
1353
 
1474
1354
    Internally, bzr only supports NFC normalization, since that is
1475
1355
    the standard for XML documents.
1478
1358
    can be accessed by that path.
1479
1359
    """
1480
1360
 
1481
 
    if isinstance(path, bytes):
1482
 
        path = path.decode(sys.getfilesystemencoding())
1483
 
    return unicodedata.normalize('NFC', path), True
 
1361
    return unicodedata.normalize('NFC', unicode(path)), True
1484
1362
 
1485
1363
 
1486
1364
def _inaccessible_normalized_filename(path):
1487
1365
    __doc__ = _accessible_normalized_filename.__doc__
1488
1366
 
1489
 
    if isinstance(path, bytes):
1490
 
        path = path.decode(sys.getfilesystemencoding())
1491
 
    normalized = unicodedata.normalize('NFC', path)
 
1367
    normalized = unicodedata.normalize('NFC', unicode(path))
1492
1368
    return normalized, normalized == path
1493
1369
 
1494
1370
 
1517
1393
    except AttributeError:
1518
1394
        # siginterrupt doesn't exist on this platform, or for this version
1519
1395
        # of Python.
1520
 
        def siginterrupt(signum, flag): return None
 
1396
        siginterrupt = lambda signum, flag: None
1521
1397
    if restart_syscall:
1522
1398
        def sig_handler(*args):
1523
1399
            # Python resets the siginterrupt flag when a signal is
1541
1417
terminal_width() returns None.
1542
1418
"""
1543
1419
 
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
1420
 
1552
1421
def terminal_width():
1553
1422
    """Return terminal width.
1555
1424
    None is returned if the width can't established precisely.
1556
1425
 
1557
1426
    The rules are:
1558
 
    - if BRZ_COLUMNS is set, returns its value
 
1427
    - if BZR_COLUMNS is set, returns its value
1559
1428
    - 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
1429
    - if COLUMNS is set, returns its value,
1563
 
    - if the OS has a value (even though it's never changed), return its value.
1564
1430
 
1565
1431
    From there, we need to query the OS to get the size of the controlling
1566
1432
    terminal.
1567
1433
 
1568
 
    On Unices we query the OS by:
 
1434
    Unices:
1569
1435
    - get termios.TIOCGWINSZ
1570
1436
    - if an error occurs or a negative value is obtained, returns None
1571
1437
 
1572
 
    On Windows we query the OS by:
 
1438
    Windows:
 
1439
    
1573
1440
    - win32utils.get_console_size() decides,
1574
1441
    - returns None on error (provided default value)
1575
1442
    """
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
1443
 
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
 
1444
    # If BZR_COLUMNS is set, take it, user is always right
1591
1445
    try:
1592
 
        width = int(os.environ['BRZ_COLUMNS'])
 
1446
        return int(os.environ['BZR_COLUMNS'])
1593
1447
    except (KeyError, ValueError):
1594
 
        width = None
1595
 
    if width is not None:
1596
 
        if width > 0:
1597
 
            return width
1598
 
        else:
1599
 
            return None
 
1448
        pass
1600
1449
 
1601
1450
    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.
 
1451
    if  isatty is None or not isatty():
 
1452
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1604
1453
        return None
1605
1454
 
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.
 
1455
    # If COLUMNS is set, take it, the terminal knows better (even inside a
 
1456
    # given terminal, the application can decide to set COLUMNS to a lower
 
1457
    # value (splitted screen) or a bigger value (scroll bars))
1623
1458
    try:
1624
1459
        return int(os.environ['COLUMNS'])
1625
1460
    except (KeyError, ValueError):
1626
1461
        pass
1627
1462
 
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
 
1463
    width, height = _terminal_size(None, None)
 
1464
    if width <= 0:
 
1465
        # Consider invalid values as meaning no width
 
1466
        return None
1632
1467
 
1633
 
    # The width could not be determined.
1634
 
    return None
 
1468
    return width
1635
1469
 
1636
1470
 
1637
1471
def _win32_terminal_size(width, height):
1638
 
    width, height = win32utils.get_console_size(
1639
 
        defaultx=width, defaulty=height)
 
1472
    width, height = win32utils.get_console_size(defaultx=width, defaulty=height)
1640
1473
    return width, height
1641
1474
 
1642
1475
 
1643
1476
def _ioctl_terminal_size(width, height):
1644
1477
    try:
1645
 
        import struct
1646
 
        import fcntl
1647
 
        import termios
 
1478
        import struct, fcntl, termios
1648
1479
        s = struct.pack('HHHH', 0, 0, 0, 0)
1649
1480
        x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1650
1481
        height, width = struct.unpack('HHHH', x)[0:2]
1652
1483
        pass
1653
1484
    return width, height
1654
1485
 
1655
 
 
1656
1486
_terminal_size = None
1657
1487
"""Returns the terminal size as (width, height).
1658
1488
 
1668
1498
    _terminal_size = _ioctl_terminal_size
1669
1499
 
1670
1500
 
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
 
1501
def _terminal_size_changed(signum, frame):
 
1502
    """Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
 
1503
    width, height = _terminal_size(None, None)
 
1504
    if width is not None:
 
1505
        os.environ['COLUMNS'] = str(width)
 
1506
 
 
1507
 
 
1508
_registered_sigwinch = False
 
1509
def watch_sigwinch():
 
1510
    """Register for SIGWINCH, once and only once.
 
1511
 
 
1512
    Do nothing if the signal module is not available.
 
1513
    """
 
1514
    global _registered_sigwinch
 
1515
    if not _registered_sigwinch:
 
1516
        try:
 
1517
            import signal
 
1518
            if getattr(signal, "SIGWINCH", None) is not None:
 
1519
                set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
 
1520
        except ImportError:
 
1521
            # python doesn't provide signal support, nothing we can do about it
 
1522
            pass
 
1523
        _registered_sigwinch = True
 
1524
 
 
1525
 
 
1526
def supports_executable():
 
1527
    return sys.platform != "win32"
1705
1528
 
1706
1529
 
1707
1530
def supports_posix_readonly():
1730
1553
        if orig_val is not None:
1731
1554
            del os.environ[env_variable]
1732
1555
    else:
1733
 
        if not PY3 and isinstance(value, text_type):
 
1556
        if isinstance(value, unicode):
1734
1557
            value = value.encode(get_user_encoding())
1735
1558
        os.environ[env_variable] = value
1736
1559
    return orig_val
1750
1573
        raise errors.IllegalPath(path)
1751
1574
 
1752
1575
 
1753
 
_WIN32_ERROR_DIRECTORY = 267  # Similar to errno.ENOTDIR
1754
 
 
 
1576
_WIN32_ERROR_DIRECTORY = 267 # Similar to errno.ENOTDIR
1755
1577
 
1756
1578
def _is_error_enotdir(e):
1757
1579
    """Check if this exception represents ENOTDIR.
1769
1591
    :return: True if this represents an ENOTDIR error. False otherwise.
1770
1592
    """
1771
1593
    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
 
             ))):
 
1594
    if (en == errno.ENOTDIR
 
1595
        or (sys.platform == 'win32'
 
1596
            and (en == _WIN32_ERROR_DIRECTORY
 
1597
                 or (en == errno.EINVAL
 
1598
                     and getattr(e, 'winerror', None) == _WIN32_ERROR_DIRECTORY)
 
1599
        ))):
1778
1600
        return True
1779
1601
    return False
1780
1602
 
1807
1629
        rooted higher up.
1808
1630
    :return: an iterator over the dirs.
1809
1631
    """
1810
 
    # TODO there is a bit of a smell where the results of the directory-
 
1632
    #TODO there is a bit of a smell where the results of the directory-
1811
1633
    # summary in this, and the path from the root, may not agree
1812
1634
    # depending on top and prefix - i.e. ./foo and foo as a pair leads to
1813
1635
    # potentially confusing output. We should make this more robust - but
1829
1651
        dirblock = []
1830
1652
        append = dirblock.append
1831
1653
        try:
1832
 
            names = sorted(map(decode_filename, _listdir(top)))
1833
 
        except OSError as e:
 
1654
            names = sorted(_listdir(top))
 
1655
        except OSError, e:
1834
1656
            if not _is_error_enotdir(e):
1835
1657
                raise
1836
1658
        else:
1889
1711
    """
1890
1712
    global _selected_dir_reader
1891
1713
    if _selected_dir_reader is None:
1892
 
        if sys.platform == "win32":
 
1714
        fs_encoding = _fs_enc.upper()
 
1715
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
 
1716
            # Win98 doesn't have unicode apis like FindFirstFileW
 
1717
            # TODO: We possibly could support Win98 by falling back to the
 
1718
            #       original FindFirstFile, and using TCHAR instead of WCHAR,
 
1719
            #       but that gets a bit tricky, and requires custom compiling
 
1720
            #       for win98 anyway.
1893
1721
            try:
1894
 
                from ._walkdirs_win32 import Win32ReadDir
 
1722
                from bzrlib._walkdirs_win32 import Win32ReadDir
1895
1723
                _selected_dir_reader = Win32ReadDir()
1896
1724
            except ImportError:
1897
1725
                pass
1898
 
        elif _fs_enc in ('utf-8', 'ascii'):
 
1726
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
 
1727
            # ANSI_X3.4-1968 is a form of ASCII
1899
1728
            try:
1900
 
                from ._readdir_pyx import UTF8DirReader
 
1729
                from bzrlib._readdir_pyx import UTF8DirReader
1901
1730
                _selected_dir_reader = UTF8DirReader()
1902
 
            except ImportError as e:
 
1731
            except ImportError, e:
1903
1732
                failed_to_load_extension(e)
1904
1733
                pass
1905
1734
 
1950
1779
        See DirReader.read_dir for details.
1951
1780
        """
1952
1781
        _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
1782
        _lstat = os.lstat
1958
1783
        _listdir = os.listdir
1959
1784
        _kind_from_mode = file_kind_from_stat_mode
1960
1785
 
1961
1786
        if prefix:
1962
 
            relprefix = prefix + b'/'
 
1787
            relprefix = prefix + '/'
1963
1788
        else:
1964
 
            relprefix = b''
1965
 
        top_slash = top + '/'
 
1789
            relprefix = ''
 
1790
        top_slash = top + u'/'
1966
1791
 
1967
1792
        dirblock = []
1968
1793
        append = dirblock.append
1969
 
        for name_native in _listdir(top.encode('utf-8')):
 
1794
        for name in sorted(_listdir(top)):
1970
1795
            try:
1971
 
                name = _fs_decode(name_native)
 
1796
                name_utf8 = _utf8_encode(name)[0]
1972
1797
            except UnicodeDecodeError:
1973
1798
                raise errors.BadFilenameEncoding(
1974
 
                    relprefix + name_native, _fs_enc)
1975
 
            name_utf8 = _utf8_encode(name)[0]
 
1799
                    _utf8_encode(relprefix)[0] + name, _fs_enc)
1976
1800
            abspath = top_slash + name
1977
1801
            statvalue = _lstat(abspath)
1978
1802
            kind = _kind_from_mode(statvalue.st_mode)
1979
1803
            append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
1980
 
        return sorted(dirblock)
 
1804
        return dirblock
1981
1805
 
1982
1806
 
1983
1807
def copy_tree(from_path, to_path, handlers={}):
2008
1832
        link_to = os.readlink(source)
2009
1833
        os.symlink(link_to, dest)
2010
1834
 
2011
 
    real_handlers = {'file': shutil.copy2,
2012
 
                     'symlink': copy_link,
2013
 
                     'directory': copy_dir,
2014
 
                     }
 
1835
    real_handlers = {'file':shutil.copy2,
 
1836
                     'symlink':copy_link,
 
1837
                     'directory':copy_dir,
 
1838
                    }
2015
1839
    real_handlers.update(handlers)
2016
1840
 
2017
1841
    if not os.path.exists(to_path):
2032
1856
    if chown is None:
2033
1857
        return
2034
1858
 
2035
 
    if src is None:
 
1859
    if src == None:
2036
1860
        src = os.path.dirname(dst)
2037
1861
        if src == '':
2038
1862
            src = '.'
2040
1864
    try:
2041
1865
        s = os.stat(src)
2042
1866
        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()
 
1867
    except OSError, e:
 
1868
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
2048
1869
 
2049
1870
 
2050
1871
def path_prefix_key(path):
2052
1873
 
2053
1874
    This can be used to sort paths in the same way that walkdirs does.
2054
1875
    """
2055
 
    return (dirname(path), path)
 
1876
    return (dirname(path) , path)
2056
1877
 
2057
1878
 
2058
1879
def compare_paths_prefix_order(path_a, path_b):
2059
1880
    """Compare path_a and path_b to generate the same order walkdirs uses."""
2060
1881
    key_a = path_prefix_key(path_a)
2061
1882
    key_b = path_prefix_key(path_b)
2062
 
    return (key_a > key_b) - (key_a < key_b)
 
1883
    return cmp(key_a, key_b)
2063
1884
 
2064
1885
 
2065
1886
_cached_user_encoding = None
2066
1887
 
2067
1888
 
2068
 
def get_user_encoding():
 
1889
def get_user_encoding(use_cache=True):
2069
1890
    """Find out what the preferred user encoding is.
2070
1891
 
2071
1892
    This is generally the encoding that is used for command line parameters
2072
1893
    and file contents. This may be different from the terminal encoding
2073
1894
    or the filesystem encoding.
2074
1895
 
 
1896
    :param  use_cache:  Enable cache for detected encoding.
 
1897
                        (This parameter is turned on by default,
 
1898
                        and required only for selftesting)
 
1899
 
2075
1900
    :return: A string defining the preferred user encoding
2076
1901
    """
2077
1902
    global _cached_user_encoding
2078
 
    if _cached_user_encoding is not None:
 
1903
    if _cached_user_encoding is not None and use_cache:
2079
1904
        return _cached_user_encoding
2080
1905
 
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)
 
1906
    if sys.platform == 'darwin':
 
1907
        # python locale.getpreferredencoding() always return
 
1908
        # 'mac-roman' on darwin. That's a lie.
 
1909
        sys.platform = 'posix'
 
1910
        try:
 
1911
            if os.environ.get('LANG', None) is None:
 
1912
                # If LANG is not set, we end up with 'ascii', which is bad
 
1913
                # ('mac-roman' is more than ascii), so we set a default which
 
1914
                # will give us UTF-8 (which appears to work in all cases on
 
1915
                # OSX). Users are still free to override LANG of course, as
 
1916
                # long as it give us something meaningful. This work-around
 
1917
                # *may* not be needed with python 3k and/or OSX 10.5, but will
 
1918
                # work with them too -- vila 20080908
 
1919
                os.environ['LANG'] = 'en_US.UTF-8'
 
1920
            import locale
 
1921
        finally:
 
1922
            sys.platform = 'darwin'
2087
1923
    else:
2088
 
        # GZ 2011-12-19: On windows could call GetACP directly instead.
2089
 
        user_encoding = locale.getpreferredencoding(False)
 
1924
        import locale
2090
1925
 
2091
1926
    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:'
 
1927
        user_encoding = locale.getpreferredencoding()
 
1928
    except locale.Error, e:
 
1929
        sys.stderr.write('bzr: warning: %s\n'
 
1930
                         '  Could not determine what text encoding to use.\n'
 
1931
                         '  This error usually means your Python interpreter\n'
 
1932
                         '  doesn\'t support the locale set by $LANG (%s)\n'
 
1933
                         "  Continuing with ascii encoding.\n"
 
1934
                         % (e, os.environ.get('LANG')))
 
1935
        user_encoding = 'ascii'
 
1936
 
 
1937
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
 
1938
    # treat that as ASCII, and not support printing unicode characters to the
 
1939
    # console.
 
1940
    #
 
1941
    # For python scripts run under vim, we get '', so also treat that as ASCII
 
1942
    if user_encoding in (None, 'cp0', ''):
 
1943
        user_encoding = 'ascii'
 
1944
    else:
 
1945
        # check encoding
 
1946
        try:
 
1947
            codecs.lookup(user_encoding)
 
1948
        except LookupError:
 
1949
            sys.stderr.write('bzr: warning:'
2096
1950
                             ' unknown encoding %s.'
2097
1951
                             ' Continuing with ascii encoding.\n'
2098
1952
                             % 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
 
1953
                            )
 
1954
            user_encoding = 'ascii'
 
1955
 
 
1956
    if use_cache:
 
1957
        _cached_user_encoding = user_encoding
 
1958
 
2112
1959
    return user_encoding
2113
1960
 
2114
1961
 
2115
 
def get_diff_header_encoding():
2116
 
    return get_terminal_encoding()
2117
 
 
2118
 
 
2119
1962
def get_host_name():
2120
1963
    """Return the current unicode host name.
2121
1964
 
2123
1966
    behaves inconsistently on different platforms.
2124
1967
    """
2125
1968
    if sys.platform == "win32":
 
1969
        import win32utils
2126
1970
        return win32utils.get_host_name()
2127
1971
    else:
2128
1972
        import socket
2129
 
        if PY3:
2130
 
            return socket.gethostname()
2131
1973
        return socket.gethostname().decode(get_user_encoding())
2132
1974
 
2133
1975
 
2137
1979
# data at once.
2138
1980
MAX_SOCKET_CHUNK = 64 * 1024
2139
1981
 
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
1982
def read_bytes_from_socket(sock, report_activity=None,
2149
 
                           max_read_size=MAX_SOCKET_CHUNK):
 
1983
        max_read_size=MAX_SOCKET_CHUNK):
2150
1984
    """Read up to max_read_size of bytes from sock and notify of progress.
2151
1985
 
2152
1986
    Translates "Connection reset by peer" into file-like EOF (return an
2153
1987
    empty string rather than raise an error), and repeats the recv if
2154
1988
    interrupted by a signal.
2155
1989
    """
2156
 
    while True:
 
1990
    while 1:
2157
1991
        try:
2158
 
            data = sock.recv(max_read_size)
2159
 
        except socket.error as e:
 
1992
            bytes = sock.recv(max_read_size)
 
1993
        except socket.error, e:
2160
1994
            eno = e.args[0]
2161
 
            if eno in _end_of_stream_errors:
 
1995
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
2162
1996
                # The connection was closed by the other side.  Callers expect
2163
1997
                # an empty string to signal end-of-stream.
2164
 
                return b""
 
1998
                return ""
2165
1999
            elif eno == errno.EINTR:
2166
2000
                # Retry the interrupted recv.
2167
2001
                continue
2168
2002
            raise
2169
2003
        else:
2170
2004
            if report_activity is not None:
2171
 
                report_activity(len(data), 'read')
2172
 
            return data
 
2005
                report_activity(len(bytes), 'read')
 
2006
            return bytes
2173
2007
 
2174
2008
 
2175
2009
def recv_all(socket, count):
2182
2016
 
2183
2017
    This isn't optimized and is intended mostly for use in testing.
2184
2018
    """
2185
 
    b = b''
 
2019
    b = ''
2186
2020
    while len(b) < count:
2187
2021
        new = read_bytes_from_socket(socket, None, count - len(b))
2188
 
        if new == b'':
2189
 
            break  # eof
 
2022
        if new == '':
 
2023
            break # eof
2190
2024
        b += new
2191
2025
    return b
2192
2026
 
2193
2027
 
2194
2028
def send_all(sock, bytes, report_activity=None):
2195
2029
    """Send all bytes on a socket.
2196
 
 
 
2030
 
2197
2031
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2198
2032
    some platforms, and catches EINTR which may be thrown if the send is
2199
2033
    interrupted by a signal.
2200
2034
 
2201
2035
    This is preferred to socket.sendall(), because it avoids portability bugs
2202
2036
    and provides activity reporting.
2203
 
 
 
2037
 
2204
2038
    :param report_activity: Call this as bytes are read, see
2205
2039
        Transport._report_activity
2206
2040
    """
2207
2041
    sent_total = 0
2208
2042
    byte_count = len(bytes)
2209
 
    view = memoryview(bytes)
2210
2043
    while sent_total < byte_count:
2211
2044
        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)
 
2045
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
 
2046
        except socket.error, e:
2217
2047
            if e.args[0] != errno.EINTR:
2218
2048
                raise
2219
2049
        else:
2220
 
            if sent == 0:
2221
 
                raise errors.ConnectionReset('Sending to %s returned 0 bytes'
2222
 
                                             % (sock,))
2223
2050
            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
 
2051
            report_activity(sent, 'write')
2250
2052
 
2251
2053
 
2252
2054
def dereference_path(path):
2271
2073
def resource_string(package, resource_name):
2272
2074
    """Load a resource from a package and return it as a string.
2273
2075
 
2274
 
    Note: Only packages that start with breezy are currently supported.
 
2076
    Note: Only packages that start with bzrlib are currently supported.
2275
2077
 
2276
2078
    This is designed to be a lightweight implementation of resource
2277
2079
    loading in a way which is API compatible with the same API from
2280
2082
    If and when pkg_resources becomes a standard library, this routine
2281
2083
    can delegate to it.
2282
2084
    """
2283
 
    # Check package name is within breezy
2284
 
    if package == "breezy":
 
2085
    # Check package name is within bzrlib
 
2086
    if package == "bzrlib":
2285
2087
        resource_relpath = resource_name
2286
 
    elif package.startswith("breezy."):
2287
 
        package = package[len("breezy."):].replace('.', os.sep)
 
2088
    elif package.startswith("bzrlib."):
 
2089
        package = package[len("bzrlib."):].replace('.', os.sep)
2288
2090
        resource_relpath = pathjoin(package, resource_name)
2289
2091
    else:
2290
 
        raise errors.BzrError('resource package %s not in breezy' % package)
 
2092
        raise errors.BzrError('resource package %s not in bzrlib' % package)
2291
2093
 
2292
2094
    # Map the resource to a file and read its contents
2293
 
    base = dirname(breezy.__file__)
 
2095
    base = dirname(bzrlib.__file__)
2294
2096
    if getattr(sys, 'frozen', None):    # bzr.exe
2295
2097
        base = abspath(pathjoin(base, '..', '..'))
2296
 
    with open(pathjoin(base, resource_relpath), "rt") as f:
2297
 
        return f.read()
 
2098
    filename = pathjoin(base, resource_relpath)
 
2099
    return open(filename, 'rU').read()
2298
2100
 
2299
2101
 
2300
2102
def file_kind_from_stat_mode_thunk(mode):
2301
2103
    global file_kind_from_stat_mode
2302
2104
    if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
2303
2105
        try:
2304
 
            from ._readdir_pyx import UTF8DirReader
 
2106
            from bzrlib._readdir_pyx import UTF8DirReader
2305
2107
            file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2306
 
        except ImportError:
 
2108
        except ImportError, e:
2307
2109
            # This is one time where we won't warn that an extension failed to
2308
2110
            # load. The extension is never available on Windows anyway.
2309
 
            from ._readdir_py import (
 
2111
            from bzrlib._readdir_py import (
2310
2112
                _kind_from_mode as file_kind_from_stat_mode
2311
2113
                )
2312
2114
    return file_kind_from_stat_mode(mode)
2313
 
 
2314
 
 
2315
2115
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2316
2116
 
2317
2117
 
2318
 
def file_stat(f, _lstat=os.lstat):
 
2118
def file_kind(f, _lstat=os.lstat):
2319
2119
    try:
2320
 
        # XXX cache?
2321
 
        return _lstat(f)
2322
 
    except OSError as e:
 
2120
        return file_kind_from_stat_mode(_lstat(f).st_mode)
 
2121
    except OSError, e:
2323
2122
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2324
2123
            raise errors.NoSuchFile(f)
2325
2124
        raise
2326
2125
 
2327
2126
 
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
2127
def until_no_eintr(f, *a, **kw):
2334
2128
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2335
 
 
 
2129
    
2336
2130
    WARNING: you must be certain that it is safe to retry the call repeatedly
2337
2131
    if EINTR does occur.  This is typically only true for low-level operations
2338
2132
    like os.read.  If in any doubt, don't use this.
2340
2134
    Keep in mind that this is not a complete solution to EINTR.  There is
2341
2135
    probably code in the Python standard library and other dependencies that
2342
2136
    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
 
2137
    that signal).  So this function can reduce the impact for IO that bzrlib
2344
2138
    directly controls, but it is not a complete solution.
2345
2139
    """
2346
2140
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
2347
2141
    while True:
2348
2142
        try:
2349
2143
            return f(*a, **kw)
2350
 
        except (IOError, OSError) as e:
 
2144
        except (IOError, OSError), e:
2351
2145
            if e.errno == errno.EINTR:
2352
2146
                continue
2353
2147
            raise
2354
2148
 
2355
2149
 
 
2150
def re_compile_checked(re_string, flags=0, where=""):
 
2151
    """Return a compiled re, or raise a sensible error.
 
2152
 
 
2153
    This should only be used when compiling user-supplied REs.
 
2154
 
 
2155
    :param re_string: Text form of regular expression.
 
2156
    :param flags: eg re.IGNORECASE
 
2157
    :param where: Message explaining to the user the context where
 
2158
        it occurred, eg 'log search filter'.
 
2159
    """
 
2160
    # from https://bugs.launchpad.net/bzr/+bug/251352
 
2161
    try:
 
2162
        re_obj = re.compile(re_string, flags)
 
2163
        re_obj.search("")
 
2164
        return re_obj
 
2165
    except re.error, e:
 
2166
        if where:
 
2167
            where = ' in ' + where
 
2168
        # despite the name 'error' is a type
 
2169
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
 
2170
            % (where, re_string, e))
 
2171
 
 
2172
 
2356
2173
if sys.platform == "win32":
 
2174
    import msvcrt
2357
2175
    def getchar():
2358
 
        import msvcrt
2359
2176
        return msvcrt.getch()
2360
2177
else:
 
2178
    import tty
 
2179
    import termios
2361
2180
    def getchar():
2362
 
        import tty
2363
 
        import termios
2364
2181
        fd = sys.stdin.fileno()
2365
2182
        settings = termios.tcgetattr(fd)
2366
2183
        try:
2370
2187
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2371
2188
        return ch
2372
2189
 
2373
 
if sys.platform.startswith('linux'):
 
2190
 
 
2191
if sys.platform == 'linux2':
2374
2192
    def _local_concurrency():
2375
 
        try:
2376
 
            return os.sysconf('SC_NPROCESSORS_ONLN')
2377
 
        except (ValueError, OSError, AttributeError):
2378
 
            return None
 
2193
        concurrency = None
 
2194
        prefix = 'processor'
 
2195
        for line in file('/proc/cpuinfo', 'rb'):
 
2196
            if line.startswith(prefix):
 
2197
                concurrency = int(line[line.find(':')+1:]) + 1
 
2198
        return concurrency
2379
2199
elif sys.platform == 'darwin':
2380
2200
    def _local_concurrency():
2381
2201
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2382
2202
                                stdout=subprocess.PIPE).communicate()[0]
2383
 
elif "bsd" in sys.platform:
 
2203
elif sys.platform[0:7] == 'freebsd':
2384
2204
    def _local_concurrency():
2385
2205
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2386
2206
                                stdout=subprocess.PIPE).communicate()[0]
2387
2207
elif sys.platform == 'sunos5':
2388
2208
    def _local_concurrency():
2389
 
        return subprocess.Popen(['psrinfo', '-p', ],
 
2209
        return subprocess.Popen(['psrinfo', '-p',],
2390
2210
                                stdout=subprocess.PIPE).communicate()[0]
2391
2211
elif sys.platform == "win32":
2392
2212
    def _local_concurrency():
2400
2220
 
2401
2221
_cached_local_concurrency = None
2402
2222
 
2403
 
 
2404
2223
def local_concurrency(use_cache=True):
2405
2224
    """Return how many processes can be run concurrently.
2406
2225
 
2412
2231
    if _cached_local_concurrency is not None and use_cache:
2413
2232
        return _cached_local_concurrency
2414
2233
 
2415
 
    concurrency = os.environ.get('BRZ_CONCURRENCY', None)
 
2234
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2416
2235
    if concurrency is None:
2417
 
        import multiprocessing
2418
2236
        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
 
2237
            concurrency = _local_concurrency()
 
2238
        except (OSError, IOError):
 
2239
            pass
2426
2240
    try:
2427
2241
        concurrency = int(concurrency)
2428
2242
    except (TypeError, ValueError):
2429
2243
        concurrency = 1
2430
2244
    if use_cache:
2431
 
        _cached_local_concurrency = concurrency
 
2245
        _cached_concurrency = concurrency
2432
2246
    return concurrency
2433
2247
 
2434
2248
 
2440
2254
        self.encode = encode
2441
2255
 
2442
2256
    def write(self, object):
2443
 
        if isinstance(object, str):
 
2257
        if type(object) is str:
2444
2258
            self.stream.write(object)
2445
2259
        else:
2446
2260
            data, _ = self.encode(object, self.errors)
2447
2261
            self.stream.write(data)
2448
2262
 
2449
 
 
2450
2263
if sys.platform == 'win32':
2451
2264
    def open_file(filename, mode='r', bufsize=-1):
2452
2265
        """This function is used to override the ``open`` builtin.
2453
 
 
 
2266
        
2454
2267
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2455
2268
        child processes.  Deleting or renaming a closed file opened with this
2456
2269
        function is not blocking child processes.
2480
2293
            else:
2481
2294
                flags |= os.O_WRONLY
2482
2295
            flags |= os.O_CREAT | os.O_APPEND
2483
 
        else:  # reading
 
2296
        else: #reading
2484
2297
            if updating:
2485
2298
                flags |= os.O_RDWR
2486
2299
            else:
2489
2302
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2490
2303
else:
2491
2304
    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