/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to breezy/osutils.py

  • Committer: Jelmer Vernooij
  • Date: 2017-06-10 01:35:53 UTC
  • mto: (6670.4.8 move-bzr)
  • mto: This revision was merged to the branch mainline in revision 6681.
  • Revision ID: jelmer@jelmer.uk-20170610013553-560y7mn3su4pp763
Fix remaining tests.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/osutils.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from __future__ import absolute_import
 
18
 
 
19
import errno
17
20
import os
18
21
import re
19
22
import stat
20
 
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
21
23
import sys
22
24
import time
23
25
import codecs
24
26
 
25
 
from bzrlib.lazy_import import lazy_import
 
27
from .lazy_import import lazy_import
26
28
lazy_import(globals(), """
27
29
from datetime import datetime
28
 
import errno
29
 
from ntpath import (abspath as _nt_abspath,
30
 
                    join as _nt_join,
31
 
                    normpath as _nt_normpath,
32
 
                    realpath as _nt_realpath,
33
 
                    splitdrive as _nt_splitdrive,
34
 
                    )
 
30
from datetime import timedelta
 
31
import getpass
 
32
import locale
 
33
import ntpath
35
34
import posixpath
 
35
import select
 
36
# We need to import both shutil and rmtree as we export the later on posix
 
37
# and need the former on windows
36
38
import shutil
37
 
from shutil import (
38
 
    rmtree,
39
 
    )
 
39
from shutil import rmtree
40
40
import socket
41
41
import subprocess
 
42
# We need to import both tempfile and mkdtemp as we export the later on posix
 
43
# and need the former on windows
42
44
import tempfile
43
 
from tempfile import (
44
 
    mkdtemp,
45
 
    )
 
45
from tempfile import mkdtemp
46
46
import unicodedata
47
47
 
48
 
from bzrlib import (
49
 
    cache_utf8,
 
48
from breezy import (
 
49
    config,
50
50
    errors,
51
51
    trace,
52
52
    win32utils,
53
53
    )
 
54
from breezy.i18n import gettext
54
55
""")
55
56
 
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
 
57
from .sixish import (
 
58
    PY3,
 
59
    text_type,
 
60
    )
 
61
 
 
62
from hashlib import (
 
63
    md5,
 
64
    sha1 as sha,
 
65
    )
 
66
 
 
67
 
 
68
import breezy
 
69
from . import _fs_enc
77
70
 
78
71
 
79
72
# Cross platform wall-clock time functionality with decent resolution.
97
90
 
98
91
 
99
92
def get_unicode_argv():
 
93
    if PY3:
 
94
        return sys.argv[1:]
100
95
    try:
101
96
        user_encoding = get_user_encoding()
102
97
        return [a.decode(user_encoding) for a in sys.argv[1:]]
103
98
    except UnicodeDecodeError:
104
 
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
105
 
                                                            "encoding." % a))
 
99
        raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
 
100
            "application locale.").format(a, user_encoding))
106
101
 
107
102
 
108
103
def make_readonly(filename):
109
104
    """Make a filename read-only."""
110
105
    mod = os.lstat(filename).st_mode
111
106
    if not stat.S_ISLNK(mod):
112
 
        mod = mod & 0777555
113
 
        os.chmod(filename, mod)
 
107
        mod = mod & 0o777555
 
108
        chmod_if_possible(filename, mod)
114
109
 
115
110
 
116
111
def make_writable(filename):
117
112
    mod = os.lstat(filename).st_mode
118
113
    if not stat.S_ISLNK(mod):
119
 
        mod = mod | 0200
120
 
        os.chmod(filename, mod)
 
114
        mod = mod | 0o200
 
115
        chmod_if_possible(filename, mod)
 
116
 
 
117
 
 
118
def chmod_if_possible(filename, mode):
 
119
    # Set file mode if that can be safely done.
 
120
    # Sometimes even on unix the filesystem won't allow it - see
 
121
    # https://bugs.launchpad.net/bzr/+bug/606537
 
122
    try:
 
123
        # It is probably faster to just do the chmod, rather than
 
124
        # doing a stat, and then trying to compare
 
125
        os.chmod(filename, mode)
 
126
    except (IOError, OSError) as e:
 
127
        # Permission/access denied seems to commonly happen on smbfs; there's
 
128
        # probably no point warning about it.
 
129
        # <https://bugs.launchpad.net/bzr/+bug/606537>
 
130
        if getattr(e, 'errno') in (errno.EPERM, errno.EACCES):
 
131
            trace.mutter("ignore error on chmod of %r: %r" % (
 
132
                filename, e))
 
133
            return
 
134
        raise
121
135
 
122
136
 
123
137
def minimum_path_selection(paths):
198
212
            stat = getattr(os, 'lstat', os.stat)
199
213
            stat(f)
200
214
            return True
201
 
        except OSError, e:
 
215
        except OSError as e:
202
216
            if e.errno == errno.ENOENT:
203
217
                return False;
204
218
            else:
205
 
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
 
219
                raise errors.BzrError(gettext("lstat/stat of ({0!r}): {1!r}").format(f, e))
206
220
 
207
221
 
208
222
def fancy_rename(old, new, rename_func, unlink_func):
232
246
    file_existed = False
233
247
    try:
234
248
        rename_func(new, tmp_name)
235
 
    except (errors.NoSuchFile,), e:
 
249
    except (errors.NoSuchFile,) as e:
236
250
        pass
237
 
    except IOError, e:
 
251
    except IOError as e:
238
252
        # RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
239
253
        # function raises an IOError with errno is None when a rename fails.
240
254
        # This then gets caught here.
241
255
        if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
242
256
            raise
243
 
    except Exception, e:
 
257
    except Exception as e:
244
258
        if (getattr(e, 'errno', None) is None
245
259
            or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
246
260
            raise
247
261
    else:
248
262
        file_existed = True
249
263
 
250
 
    failure_exc = None
251
264
    success = False
252
265
    try:
253
 
        try:
254
 
            # This may throw an exception, in which case success will
255
 
            # not be set.
256
 
            rename_func(old, new)
257
 
            success = True
258
 
        except (IOError, OSError), e:
259
 
            # source and target may be aliases of each other (e.g. on a
260
 
            # case-insensitive filesystem), so we may have accidentally renamed
261
 
            # source by when we tried to rename target
262
 
            failure_exc = sys.exc_info()
263
 
            if (file_existed and e.errno in (None, errno.ENOENT)
264
 
                and old.lower() == new.lower()):
265
 
                # source and target are the same file on a case-insensitive
266
 
                # filesystem, so we don't generate an exception
267
 
                failure_exc = None
 
266
        # This may throw an exception, in which case success will
 
267
        # not be set.
 
268
        rename_func(old, new)
 
269
        success = True
 
270
    except (IOError, OSError) as e:
 
271
        # source and target may be aliases of each other (e.g. on a
 
272
        # case-insensitive filesystem), so we may have accidentally renamed
 
273
        # source by when we tried to rename target
 
274
        if (file_existed and e.errno in (None, errno.ENOENT)
 
275
            and old.lower() == new.lower()):
 
276
            # source and target are the same file on a case-insensitive
 
277
            # filesystem, so we don't generate an exception
 
278
            pass
 
279
        else:
 
280
            raise
268
281
    finally:
269
282
        if file_existed:
270
283
            # If the file used to exist, rename it back into place
273
286
                unlink_func(tmp_name)
274
287
            else:
275
288
                rename_func(tmp_name, new)
276
 
    if failure_exc is not None:
277
 
        raise failure_exc[0], failure_exc[1], failure_exc[2]
278
289
 
279
290
 
280
291
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
281
292
# choke on a Unicode string containing a relative path if
282
293
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
283
294
# string.
284
 
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
285
295
def _posix_abspath(path):
286
296
    # jam 20060426 rather than encoding to fsencoding
287
297
    # copy posixpath.abspath, but use os.getcwdu instead
288
298
    if not posixpath.isabs(path):
289
299
        path = posixpath.join(getcwd(), path)
290
 
    return posixpath.normpath(path)
 
300
    return _posix_normpath(path)
291
301
 
292
302
 
293
303
def _posix_realpath(path):
294
304
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
295
305
 
296
306
 
 
307
def _posix_normpath(path):
 
308
    path = posixpath.normpath(path)
 
309
    # Bug 861008: posixpath.normpath() returns a path normalized according to
 
310
    # the POSIX standard, which stipulates (for compatibility reasons) that two
 
311
    # leading slashes must not be simplified to one, and only if there are 3 or
 
312
    # more should they be simplified as one. So we treat the leading 2 slashes
 
313
    # as a special case here by simply removing the first slash, as we consider
 
314
    # that breaking POSIX compatibility for this obscure feature is acceptable.
 
315
    # This is not a paranoid precaution, as we notably get paths like this when
 
316
    # the repo is hosted at the root of the filesystem, i.e. in "/".    
 
317
    if path.startswith('//'):
 
318
        path = path[1:]
 
319
    return path
 
320
 
 
321
 
 
322
def _posix_path_from_environ(key):
 
323
    """Get unicode path from `key` in environment or None if not present
 
324
 
 
325
    Note that posix systems use arbitrary byte strings for filesystem objects,
 
326
    so a path that raises BadFilenameEncoding here may still be accessible.
 
327
    """
 
328
    val = os.environ.get(key, None)
 
329
    if PY3 or val is None:
 
330
        return val
 
331
    try:
 
332
        return val.decode(_fs_enc)
 
333
    except UnicodeDecodeError:
 
334
        # GZ 2011-12-12:Ideally want to include `key` in the exception message
 
335
        raise errors.BadFilenameEncoding(val, _fs_enc)
 
336
 
 
337
 
 
338
def _posix_get_home_dir():
 
339
    """Get the home directory of the current user as a unicode path"""
 
340
    path = posixpath.expanduser("~")
 
341
    try:
 
342
        return path.decode(_fs_enc)
 
343
    except AttributeError:
 
344
        return path
 
345
    except UnicodeDecodeError:
 
346
        raise errors.BadFilenameEncoding(path, _fs_enc)
 
347
 
 
348
 
 
349
def _posix_getuser_unicode():
 
350
    """Get username from environment or password database as unicode"""
 
351
    name = getpass.getuser()
 
352
    user_encoding = get_user_encoding()
 
353
    try:
 
354
        return name.decode(user_encoding)
 
355
    except UnicodeDecodeError:
 
356
        raise errors.BzrError("Encoding of username %r is unsupported by %s "
 
357
            "application locale." % (name, user_encoding))
 
358
 
 
359
 
297
360
def _win32_fixdrive(path):
298
361
    """Force drive letters to be consistent.
299
362
 
303
366
    running python.exe under cmd.exe return capital C:\\
304
367
    running win32 python inside a cygwin shell returns lowercase c:\\
305
368
    """
306
 
    drive, path = _nt_splitdrive(path)
 
369
    drive, path = ntpath.splitdrive(path)
307
370
    return drive.upper() + path
308
371
 
309
372
 
310
373
def _win32_abspath(path):
311
 
    # Real _nt_abspath doesn't have a problem with a unicode cwd
312
 
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
313
 
 
314
 
 
315
 
def _win98_abspath(path):
316
 
    """Return the absolute version of a path.
317
 
    Windows 98 safe implementation (python reimplementation
318
 
    of Win32 API function GetFullPathNameW)
319
 
    """
320
 
    # Corner cases:
321
 
    #   C:\path     => C:/path
322
 
    #   C:/path     => C:/path
323
 
    #   \\HOST\path => //HOST/path
324
 
    #   //HOST/path => //HOST/path
325
 
    #   path        => C:/cwd/path
326
 
    #   /path       => C:/path
327
 
    path = unicode(path)
328
 
    # check for absolute path
329
 
    drive = _nt_splitdrive(path)[0]
330
 
    if drive == '' and path[:2] not in('//','\\\\'):
331
 
        cwd = os.getcwdu()
332
 
        # we cannot simply os.path.join cwd and path
333
 
        # because os.path.join('C:','/path') produce '/path'
334
 
        # and this is incorrect
335
 
        if path[:1] in ('/','\\'):
336
 
            cwd = _nt_splitdrive(cwd)[0]
337
 
            path = path[1:]
338
 
        path = cwd + '\\' + path
339
 
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
 
374
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
 
375
    return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
340
376
 
341
377
 
342
378
def _win32_realpath(path):
343
 
    # Real _nt_realpath doesn't have a problem with a unicode cwd
344
 
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
 
379
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
 
380
    return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
345
381
 
346
382
 
347
383
def _win32_pathjoin(*args):
348
 
    return _nt_join(*args).replace('\\', '/')
 
384
    return ntpath.join(*args).replace('\\', '/')
349
385
 
350
386
 
351
387
def _win32_normpath(path):
352
 
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
388
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
353
389
 
354
390
 
355
391
def _win32_getcwd():
356
 
    return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
 
392
    return _win32_fixdrive(_getcwd().replace('\\', '/'))
357
393
 
358
394
 
359
395
def _win32_mkdtemp(*args, **kwargs):
360
396
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
361
397
 
362
398
 
363
 
def _add_rename_error_details(e, old, new):
364
 
    new_e = OSError(e.errno, "failed to rename %s to %s: %s"
365
 
        % (old, new, e.strerror))
366
 
    new_e.filename = old
367
 
    new_e.to_filename = new
368
 
    return new_e
369
 
 
370
 
 
371
399
def _win32_rename(old, new):
372
400
    """We expect to be able to atomically replace 'new' with old.
373
401
 
375
403
    and then deleted.
376
404
    """
377
405
    try:
378
 
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
379
 
    except OSError, e:
 
406
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
 
407
    except OSError as e:
380
408
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
381
409
            # If we try to rename a non-existant file onto cwd, we get
382
410
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT
386
414
        raise
387
415
 
388
416
 
389
 
def _wrapped_rename(old, new):
390
 
    """Rename a file or directory"""
391
 
    try:
392
 
        os.rename(old, new)
393
 
    except (IOError, OSError), e:
394
 
        # this is eventually called by all rename-like functions, so should 
395
 
        # catch all of them
396
 
        raise _add_rename_error_details(e, old, new)
397
 
 
398
 
 
399
417
def _mac_getcwd():
400
 
    return unicodedata.normalize('NFC', os.getcwdu())
401
 
 
 
418
    return unicodedata.normalize('NFC', _getcwd())
 
419
 
 
420
 
 
421
def _rename_wrap_exception(rename_func):
 
422
    """Adds extra information to any exceptions that come from rename().
 
423
 
 
424
    The exception has an updated message and 'old_filename' and 'new_filename'
 
425
    attributes.
 
426
    """
 
427
 
 
428
    def _rename_wrapper(old, new):
 
429
        try:
 
430
            rename_func(old, new)
 
431
        except OSError as e:
 
432
            detailed_error = OSError(e.errno, e.strerror +
 
433
                                " [occurred when renaming '%s' to '%s']" %
 
434
                                (old, new))
 
435
            detailed_error.old_filename = old
 
436
            detailed_error.new_filename = new
 
437
            raise detailed_error
 
438
 
 
439
    return _rename_wrapper
 
440
 
 
441
 
 
442
if sys.version_info > (3,):
 
443
    _getcwd = os.getcwd
 
444
else:
 
445
    _getcwd = os.getcwdu
 
446
 
 
447
 
 
448
# Default rename wraps os.rename()
 
449
rename = _rename_wrap_exception(os.rename)
402
450
 
403
451
# Default is to just use the python builtins, but these can be rebound on
404
452
# particular platforms.
405
453
abspath = _posix_abspath
406
454
realpath = _posix_realpath
407
455
pathjoin = os.path.join
408
 
normpath = os.path.normpath
409
 
rename = _wrapped_rename # overridden below on win32
410
 
getcwd = os.getcwdu
 
456
normpath = _posix_normpath
 
457
path_from_environ = _posix_path_from_environ
 
458
_get_home_dir = _posix_get_home_dir
 
459
getuser_unicode = _posix_getuser_unicode
 
460
getcwd = _getcwd
411
461
dirname = os.path.dirname
412
462
basename = os.path.basename
413
463
split = os.path.split
414
464
splitext = os.path.splitext
415
 
# These were already imported into local scope
 
465
# These were already lazily imported into local scope
416
466
# mkdtemp = tempfile.mkdtemp
417
467
# rmtree = shutil.rmtree
 
468
lstat = os.lstat
 
469
fstat = os.fstat
 
470
 
 
471
def wrap_stat(st):
 
472
    return st
 
473
 
418
474
 
419
475
MIN_ABS_PATHLENGTH = 1
420
476
 
421
477
 
422
478
if sys.platform == 'win32':
423
 
    if win32utils.winver == 'Windows 98':
424
 
        abspath = _win98_abspath
425
 
    else:
426
 
        abspath = _win32_abspath
 
479
    abspath = _win32_abspath
427
480
    realpath = _win32_realpath
428
481
    pathjoin = _win32_pathjoin
429
482
    normpath = _win32_normpath
430
483
    getcwd = _win32_getcwd
431
484
    mkdtemp = _win32_mkdtemp
432
 
    rename = _win32_rename
 
485
    rename = _rename_wrap_exception(_win32_rename)
 
486
    try:
 
487
        from . import _walkdirs_win32
 
488
    except ImportError:
 
489
        pass
 
490
    else:
 
491
        lstat = _walkdirs_win32.lstat
 
492
        fstat = _walkdirs_win32.fstat
 
493
        wrap_stat = _walkdirs_win32.wrap_stat
433
494
 
434
495
    MIN_ABS_PATHLENGTH = 3
435
496
 
453
514
    f = win32utils.get_unicode_argv     # special function or None
454
515
    if f is not None:
455
516
        get_unicode_argv = f
 
517
    path_from_environ = win32utils.get_environ_unicode
 
518
    _get_home_dir = win32utils.get_home_location
 
519
    getuser_unicode = win32utils.get_user_name
456
520
 
457
521
elif sys.platform == 'darwin':
458
522
    getcwd = _mac_getcwd
459
523
 
460
524
 
461
 
def get_terminal_encoding():
 
525
def get_terminal_encoding(trace=False):
462
526
    """Find the best encoding for printing to the screen.
463
527
 
464
528
    This attempts to check both sys.stdout and sys.stdin to see
470
534
 
471
535
    On my standard US Windows XP, the preferred encoding is
472
536
    cp1252, but the console is cp437
 
537
 
 
538
    :param trace: If True trace the selected encoding via mutter().
473
539
    """
474
 
    from bzrlib.trace import mutter
 
540
    from .trace import mutter
475
541
    output_encoding = getattr(sys.stdout, 'encoding', None)
476
542
    if not output_encoding:
477
543
        input_encoding = getattr(sys.stdin, 'encoding', None)
478
544
        if not input_encoding:
479
545
            output_encoding = get_user_encoding()
480
 
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
546
            if trace:
 
547
                mutter('encoding stdout as osutils.get_user_encoding() %r',
481
548
                   output_encoding)
482
549
        else:
483
550
            output_encoding = input_encoding
484
 
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
551
            if trace:
 
552
                mutter('encoding stdout as sys.stdin encoding %r',
 
553
                    output_encoding)
485
554
    else:
486
 
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
555
        if trace:
 
556
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
487
557
    if output_encoding == 'cp0':
488
558
        # invalid encoding (cp0 means 'no codepage' on Windows)
489
559
        output_encoding = get_user_encoding()
490
 
        mutter('cp0 is invalid encoding.'
 
560
        if trace:
 
561
            mutter('cp0 is invalid encoding.'
491
562
               ' encoding stdout as osutils.get_user_encoding() %r',
492
563
               output_encoding)
493
564
    # check encoding
494
565
    try:
495
566
        codecs.lookup(output_encoding)
496
567
    except LookupError:
497
 
        sys.stderr.write('bzr: warning:'
 
568
        sys.stderr.write('brz: warning:'
498
569
                         ' unknown terminal encoding %s.\n'
499
570
                         '  Using encoding %s instead.\n'
500
571
                         % (output_encoding, get_user_encoding())
519
590
def isdir(f):
520
591
    """True if f is an accessible directory."""
521
592
    try:
522
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
593
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
523
594
    except OSError:
524
595
        return False
525
596
 
527
598
def isfile(f):
528
599
    """True if f is a regular file."""
529
600
    try:
530
 
        return S_ISREG(os.lstat(f)[ST_MODE])
 
601
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
531
602
    except OSError:
532
603
        return False
533
604
 
534
605
def islink(f):
535
606
    """True if f is a symlink."""
536
607
    try:
537
 
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
608
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
538
609
    except OSError:
539
610
        return False
540
611
 
637
708
    # drives).
638
709
    if not segment_size:
639
710
        segment_size = 5242880 # 5MB
640
 
    segments = range(len(bytes) / segment_size + 1)
 
711
    offsets = range(0, len(bytes), segment_size)
 
712
    view = memoryview(bytes)
641
713
    write = file_handle.write
642
 
    for segment_index in segments:
643
 
        segment = buffer(bytes, segment_index * segment_size, segment_size)
644
 
        write(segment)
 
714
    for offset in offsets:
 
715
        write(view[offset:offset+segment_size])
645
716
 
646
717
 
647
718
def file_iterator(input_file, readsize=32768):
702
773
def sha_strings(strings, _factory=sha):
703
774
    """Return the sha-1 of concatenation of strings"""
704
775
    s = _factory()
705
 
    map(s.update, strings)
 
776
    for string in strings:
 
777
        s.update(string)
706
778
    return s.hexdigest()
707
779
 
708
780
 
728
800
            return True
729
801
 
730
802
 
 
803
def gmtime(seconds=None):
 
804
    """Convert seconds since the Epoch to a time tuple expressing UTC (a.k.a.
 
805
    GMT). When 'seconds' is not passed in, convert the current time instead.
 
806
    Handy replacement for time.gmtime() buggy on Windows and 32-bit platforms.
 
807
    """
 
808
    if seconds is None:
 
809
        seconds = time.time()
 
810
    return (datetime(1970, 1, 1) + timedelta(seconds=seconds)).timetuple()
 
811
 
 
812
 
731
813
def local_time_offset(t=None):
732
814
    """Return offset of local zone from GMT, either at present or at time t."""
733
815
    if t is None:
773
855
    """
774
856
    if offset is None:
775
857
        offset = 0
776
 
    tt = time.gmtime(t + offset)
 
858
    tt = gmtime(t + offset)
777
859
    date_fmt = _default_format_by_weekday_num[tt[6]]
778
860
    date_str = time.strftime(date_fmt, tt)
779
861
    offset_str = _cache.get(offset, None)
798
880
    (date_fmt, tt, offset_str) = \
799
881
               _format_date(t, offset, timezone, date_fmt, show_offset)
800
882
    date_str = time.strftime(date_fmt, tt)
801
 
    if not isinstance(date_str, unicode):
 
883
    if not isinstance(date_str, text_type):
802
884
        date_str = date_str.decode(get_user_encoding(), 'replace')
803
885
    return date_str + offset_str
804
886
 
805
887
 
806
888
def _format_date(t, offset, timezone, date_fmt, show_offset):
807
889
    if timezone == 'utc':
808
 
        tt = time.gmtime(t)
 
890
        tt = gmtime(t)
809
891
        offset = 0
810
892
    elif timezone == 'original':
811
893
        if offset is None:
812
894
            offset = 0
813
 
        tt = time.gmtime(t + offset)
 
895
        tt = gmtime(t + offset)
814
896
    elif timezone == 'local':
815
897
        tt = time.localtime(t)
816
898
        offset = local_time_offset(t)
826
908
 
827
909
 
828
910
def compact_date(when):
829
 
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
 
911
    return time.strftime('%Y%m%d%H%M%S', gmtime(when))
830
912
 
831
913
 
832
914
def format_delta(delta):
880
962
 
881
963
def filesize(f):
882
964
    """Return size of given open file."""
883
 
    return os.fstat(f.fileno())[ST_SIZE]
884
 
 
885
 
 
886
 
# Define rand_bytes based on platform.
887
 
try:
888
 
    # Python 2.4 and later have os.urandom,
889
 
    # but it doesn't work on some arches
890
 
    os.urandom(1)
891
 
    rand_bytes = os.urandom
892
 
except (NotImplementedError, AttributeError):
893
 
    # If python doesn't have os.urandom, or it doesn't work,
894
 
    # then try to first pull random data from /dev/urandom
 
965
    return os.fstat(f.fileno())[stat.ST_SIZE]
 
966
 
 
967
 
 
968
# Alias os.urandom to support platforms (which?) without /dev/urandom and 
 
969
# override if it doesn't work. Avoid checking on windows where there is
 
970
# significant initialisation cost that can be avoided for some bzr calls.
 
971
 
 
972
rand_bytes = os.urandom
 
973
 
 
974
if rand_bytes.__module__ != "nt":
895
975
    try:
896
 
        rand_bytes = file('/dev/urandom', 'rb').read
897
 
    # Otherwise, use this hack as a last resort
898
 
    except (IOError, OSError):
 
976
        rand_bytes(1)
 
977
    except NotImplementedError:
899
978
        # not well seeded, but better than nothing
900
979
        def rand_bytes(n):
901
980
            import random
931
1010
    rps = []
932
1011
    for f in ps:
933
1012
        if f == '..':
934
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1013
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
935
1014
        elif (f == '.') or (f == ''):
936
1015
            pass
937
1016
        else:
942
1021
def joinpath(p):
943
1022
    for f in p:
944
1023
        if (f == '..') or (f is None) or (f == ''):
945
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1024
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
946
1025
    return pathjoin(*p)
947
1026
 
948
1027
 
949
1028
def parent_directories(filename):
950
1029
    """Return the list of parent directories, deepest first.
951
 
    
 
1030
 
952
1031
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
953
1032
    """
954
1033
    parents = []
970
1049
    implementation should be loaded instead::
971
1050
 
972
1051
    >>> try:
973
 
    >>>     import bzrlib._fictional_extension_pyx
 
1052
    >>>     import breezy._fictional_extension_pyx
974
1053
    >>> except ImportError, e:
975
 
    >>>     bzrlib.osutils.failed_to_load_extension(e)
976
 
    >>>     import bzrlib._fictional_extension_py
 
1054
    >>>     breezy.osutils.failed_to_load_extension(e)
 
1055
    >>>     import breezy._fictional_extension_py
977
1056
    """
978
1057
    # NB: This docstring is just an example, not a doctest, because doctest
979
1058
    # currently can't cope with the use of lazy imports in this namespace --
980
1059
    # mbp 20090729
981
 
    
 
1060
 
982
1061
    # This currently doesn't report the failure at the time it occurs, because
983
1062
    # they tend to happen very early in startup when we can't check config
984
1063
    # files etc, and also we want to report all failures but not spam the user
985
1064
    # with 10 warnings.
986
 
    from bzrlib import trace
987
1065
    exception_str = str(exception)
988
1066
    if exception_str not in _extension_load_failures:
989
1067
        trace.mutter("failed to load compiled extension: %s" % exception_str)
993
1071
def report_extension_load_failures():
994
1072
    if not _extension_load_failures:
995
1073
        return
996
 
    from bzrlib.config import GlobalConfig
997
 
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
 
1074
    if config.GlobalStack().get('ignore_missing_extensions'):
998
1075
        return
999
1076
    # the warnings framework should by default show this only once
1000
 
    from bzrlib.trace import warning
 
1077
    from .trace import warning
1001
1078
    warning(
1002
 
        "bzr: warning: some compiled extensions could not be loaded; "
 
1079
        "brz: warning: some compiled extensions could not be loaded; "
1003
1080
        "see <https://answers.launchpad.net/bzr/+faq/703>")
1004
1081
    # we no longer show the specific missing extensions here, because it makes
1005
1082
    # the message too long and scary - see
1007
1084
 
1008
1085
 
1009
1086
try:
1010
 
    from bzrlib._chunks_to_lines_pyx import chunks_to_lines
1011
 
except ImportError, e:
 
1087
    from ._chunks_to_lines_pyx import chunks_to_lines
 
1088
except ImportError as e:
1012
1089
    failed_to_load_extension(e)
1013
 
    from bzrlib._chunks_to_lines_py import chunks_to_lines
 
1090
    from ._chunks_to_lines_py import chunks_to_lines
1014
1091
 
1015
1092
 
1016
1093
def split_lines(s):
1047
1124
        return
1048
1125
    try:
1049
1126
        os.link(src, dest)
1050
 
    except (OSError, IOError), e:
 
1127
    except (OSError, IOError) as e:
1051
1128
        if e.errno != errno.EXDEV:
1052
1129
            raise
1053
1130
        shutil.copyfile(src, dest)
1054
1131
 
1055
1132
 
1056
1133
def delete_any(path):
1057
 
    """Delete a file, symlink or directory.  
1058
 
    
 
1134
    """Delete a file, symlink or directory.
 
1135
 
1059
1136
    Will delete even if readonly.
1060
1137
    """
1061
1138
    try:
1062
1139
       _delete_file_or_dir(path)
1063
 
    except (OSError, IOError), e:
 
1140
    except (OSError, IOError) as e:
1064
1141
        if e.errno in (errno.EPERM, errno.EACCES):
1065
1142
            # make writable and try again
1066
1143
            try:
1162
1239
 
1163
1240
    if len(base) < MIN_ABS_PATHLENGTH:
1164
1241
        # must have space for e.g. a drive letter
1165
 
        raise ValueError('%r is too short to calculate a relative path'
 
1242
        raise ValueError(gettext('%r is too short to calculate a relative path')
1166
1243
            % (base,))
1167
1244
 
1168
1245
    rp = abspath(path)
1250
1327
    # but for now, we haven't optimized...
1251
1328
    return [canonical_relpath(base, p) for p in paths]
1252
1329
 
 
1330
 
 
1331
def decode_filename(filename):
 
1332
    """Decode the filename using the filesystem encoding
 
1333
 
 
1334
    If it is unicode, it is returned.
 
1335
    Otherwise it is decoded from the the filesystem's encoding. If decoding
 
1336
    fails, a errors.BadFilenameEncoding exception is raised.
 
1337
    """
 
1338
    if isinstance(filename, text_type):
 
1339
        return filename
 
1340
    try:
 
1341
        return filename.decode(_fs_enc)
 
1342
    except UnicodeDecodeError:
 
1343
        raise errors.BadFilenameEncoding(filename, _fs_enc)
 
1344
 
 
1345
 
1253
1346
def safe_unicode(unicode_or_utf8_string):
1254
1347
    """Coerce unicode_or_utf8_string into unicode.
1255
1348
 
1257
1350
    Otherwise it is decoded from utf-8. If decoding fails, the exception is
1258
1351
    wrapped in a BzrBadParameterNotUnicode exception.
1259
1352
    """
1260
 
    if isinstance(unicode_or_utf8_string, unicode):
 
1353
    if isinstance(unicode_or_utf8_string, text_type):
1261
1354
        return unicode_or_utf8_string
1262
1355
    try:
1263
1356
        return unicode_or_utf8_string.decode('utf8')
1284
1377
    return unicode_or_utf8_string.encode('utf-8')
1285
1378
 
1286
1379
 
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):
 
1380
def safe_revision_id(unicode_or_utf8_string):
1293
1381
    """Revision ids should now be utf8, but at one point they were unicode.
1294
1382
 
1295
1383
    :param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
1296
1384
        utf8 or None).
1297
 
    :param warn: Functions that are sanitizing user data can set warn=False
1298
1385
    :return: None or a utf8 revision id.
1299
1386
    """
1300
1387
    if (unicode_or_utf8_string is None
1301
1388
        or unicode_or_utf8_string.__class__ == str):
1302
1389
        return unicode_or_utf8_string
1303
 
    if warn:
1304
 
        symbol_versioning.warn(_revision_id_warning, DeprecationWarning,
1305
 
                               stacklevel=2)
1306
 
    return cache_utf8.encode(unicode_or_utf8_string)
1307
 
 
1308
 
 
1309
 
_file_id_warning = ('Unicode file ids were deprecated in bzr 0.15. File id'
1310
 
                    ' generators should be creating utf8 file ids.')
1311
 
 
1312
 
 
1313
 
def safe_file_id(unicode_or_utf8_string, warn=True):
 
1390
    raise TypeError('Unicode revision ids are no longer supported. '
 
1391
                    'Revision id generators should be creating utf8 revision '
 
1392
                    'ids.')
 
1393
 
 
1394
 
 
1395
def safe_file_id(unicode_or_utf8_string):
1314
1396
    """File ids should now be utf8, but at one point they were unicode.
1315
1397
 
1316
1398
    This is the same as safe_utf8, except it uses the cached encode functions
1318
1400
 
1319
1401
    :param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
1320
1402
        utf8 or None).
1321
 
    :param warn: Functions that are sanitizing user data can set warn=False
1322
1403
    :return: None or a utf8 file id.
1323
1404
    """
1324
1405
    if (unicode_or_utf8_string is None
1325
1406
        or unicode_or_utf8_string.__class__ == str):
1326
1407
        return unicode_or_utf8_string
1327
 
    if warn:
1328
 
        symbol_versioning.warn(_file_id_warning, DeprecationWarning,
1329
 
                               stacklevel=2)
1330
 
    return cache_utf8.encode(unicode_or_utf8_string)
 
1408
    raise TypeError('Unicode file ids are no longer supported. '
 
1409
                    'File id generators should be creating utf8 file ids.')
1331
1410
 
1332
1411
 
1333
1412
_platform_normalizes_filenames = False
1338
1417
def normalizes_filenames():
1339
1418
    """Return True if this platform normalizes unicode filenames.
1340
1419
 
1341
 
    Mac OSX does, Windows/Linux do not.
 
1420
    Only Mac OSX.
1342
1421
    """
1343
1422
    return _platform_normalizes_filenames
1344
1423
 
1349
1428
    On platforms where the system normalizes filenames (Mac OSX),
1350
1429
    you can access a file by any path which will normalize correctly.
1351
1430
    On platforms where the system does not normalize filenames
1352
 
    (Windows, Linux), you have to access a file by its exact path.
 
1431
    (everything else), you have to access a file by its exact path.
1353
1432
 
1354
1433
    Internally, bzr only supports NFC normalization, since that is
1355
1434
    the standard for XML documents.
1417
1496
terminal_width() returns None.
1418
1497
"""
1419
1498
 
 
1499
# Keep some state so that terminal_width can detect if _terminal_size has
 
1500
# returned a different size since the process started.  See docstring and
 
1501
# comments of terminal_width for details.
 
1502
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
 
1503
_terminal_size_state = 'no_data'
 
1504
_first_terminal_size = None
1420
1505
 
1421
1506
def terminal_width():
1422
1507
    """Return terminal width.
1424
1509
    None is returned if the width can't established precisely.
1425
1510
 
1426
1511
    The rules are:
1427
 
    - if BZR_COLUMNS is set, returns its value
 
1512
    - if BRZ_COLUMNS is set, returns its value
1428
1513
    - if there is no controlling terminal, returns None
 
1514
    - query the OS, if the queried size has changed since the last query,
 
1515
      return its value,
1429
1516
    - if COLUMNS is set, returns its value,
 
1517
    - if the OS has a value (even though it's never changed), return its value.
1430
1518
 
1431
1519
    From there, we need to query the OS to get the size of the controlling
1432
1520
    terminal.
1433
1521
 
1434
 
    Unices:
 
1522
    On Unices we query the OS by:
1435
1523
    - get termios.TIOCGWINSZ
1436
1524
    - if an error occurs or a negative value is obtained, returns None
1437
1525
 
1438
 
    Windows:
1439
 
    
 
1526
    On Windows we query the OS by:
1440
1527
    - win32utils.get_console_size() decides,
1441
1528
    - returns None on error (provided default value)
1442
1529
    """
 
1530
    # Note to implementors: if changing the rules for determining the width,
 
1531
    # make sure you've considered the behaviour in these cases:
 
1532
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
 
1533
    #  - brz log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
 
1534
    #    0,0.
 
1535
    #  - (add more interesting cases here, if you find any)
 
1536
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
 
1537
    # but we don't want to register a signal handler because it is impossible
 
1538
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
 
1539
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
 
1540
    # time so we can notice if the reported size has changed, which should have
 
1541
    # a similar effect.
1443
1542
 
1444
 
    # If BZR_COLUMNS is set, take it, user is always right
 
1543
    # If BRZ_COLUMNS is set, take it, user is always right
 
1544
    # Except if they specified 0 in which case, impose no limit here
1445
1545
    try:
1446
 
        return int(os.environ['BZR_COLUMNS'])
 
1546
        width = int(os.environ['BRZ_COLUMNS'])
1447
1547
    except (KeyError, ValueError):
1448
 
        pass
 
1548
        width = None
 
1549
    if width is not None:
 
1550
        if width > 0:
 
1551
            return width
 
1552
        else:
 
1553
            return None
1449
1554
 
1450
1555
    isatty = getattr(sys.stdout, 'isatty', None)
1451
 
    if  isatty is None or not isatty():
1452
 
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
 
1556
    if isatty is None or not isatty():
 
1557
        # Don't guess, setting BRZ_COLUMNS is the recommended way to override.
1453
1558
        return None
1454
1559
 
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))
 
1560
    # Query the OS
 
1561
    width, height = os_size = _terminal_size(None, None)
 
1562
    global _first_terminal_size, _terminal_size_state
 
1563
    if _terminal_size_state == 'no_data':
 
1564
        _first_terminal_size = os_size
 
1565
        _terminal_size_state = 'unchanged'
 
1566
    elif (_terminal_size_state == 'unchanged' and
 
1567
          _first_terminal_size != os_size):
 
1568
        _terminal_size_state = 'changed'
 
1569
 
 
1570
    # If the OS claims to know how wide the terminal is, and this value has
 
1571
    # ever changed, use that.
 
1572
    if _terminal_size_state == 'changed':
 
1573
        if width is not None and width > 0:
 
1574
            return width
 
1575
 
 
1576
    # If COLUMNS is set, use it.
1458
1577
    try:
1459
1578
        return int(os.environ['COLUMNS'])
1460
1579
    except (KeyError, ValueError):
1461
1580
        pass
1462
1581
 
1463
 
    width, height = _terminal_size(None, None)
1464
 
    if width <= 0:
1465
 
        # Consider invalid values as meaning no width
1466
 
        return None
 
1582
    # Finally, use an unchanged size from the OS, if we have one.
 
1583
    if _terminal_size_state == 'unchanged':
 
1584
        if width is not None and width > 0:
 
1585
            return width
1467
1586
 
1468
 
    return width
 
1587
    # The width could not be determined.
 
1588
    return None
1469
1589
 
1470
1590
 
1471
1591
def _win32_terminal_size(width, height):
1498
1618
    _terminal_size = _ioctl_terminal_size
1499
1619
 
1500
1620
 
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
1621
def supports_executable():
1527
1622
    return sys.platform != "win32"
1528
1623
 
1553
1648
        if orig_val is not None:
1554
1649
            del os.environ[env_variable]
1555
1650
    else:
1556
 
        if isinstance(value, unicode):
 
1651
        if not PY3 and isinstance(value, text_type):
1557
1652
            value = value.encode(get_user_encoding())
1558
1653
        os.environ[env_variable] = value
1559
1654
    return orig_val
1651
1746
        dirblock = []
1652
1747
        append = dirblock.append
1653
1748
        try:
1654
 
            names = sorted(_listdir(top))
1655
 
        except OSError, e:
 
1749
            names = sorted(map(decode_filename, _listdir(top)))
 
1750
        except OSError as e:
1656
1751
            if not _is_error_enotdir(e):
1657
1752
                raise
1658
1753
        else:
1711
1806
    """
1712
1807
    global _selected_dir_reader
1713
1808
    if _selected_dir_reader is None:
1714
 
        fs_encoding = _fs_enc.upper()
1715
 
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1716
 
            # Win98 doesn't have unicode apis like FindFirstFileW
1717
 
            # TODO: We possibly could support Win98 by falling back to the
1718
 
            #       original FindFirstFile, and using TCHAR instead of WCHAR,
1719
 
            #       but that gets a bit tricky, and requires custom compiling
1720
 
            #       for win98 anyway.
 
1809
        if sys.platform == "win32":
1721
1810
            try:
1722
 
                from bzrlib._walkdirs_win32 import Win32ReadDir
 
1811
                from ._walkdirs_win32 import Win32ReadDir
1723
1812
                _selected_dir_reader = Win32ReadDir()
1724
1813
            except ImportError:
1725
1814
                pass
1726
 
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1727
 
            # ANSI_X3.4-1968 is a form of ASCII
 
1815
        elif _fs_enc in ('utf-8', 'ascii'):
1728
1816
            try:
1729
 
                from bzrlib._readdir_pyx import UTF8DirReader
 
1817
                from ._readdir_pyx import UTF8DirReader
1730
1818
                _selected_dir_reader = UTF8DirReader()
1731
 
            except ImportError, e:
 
1819
            except ImportError as e:
1732
1820
                failed_to_load_extension(e)
1733
1821
                pass
1734
1822
 
1864
1952
    try:
1865
1953
        s = os.stat(src)
1866
1954
        chown(dst, s.st_uid, s.st_gid)
1867
 
    except OSError, e:
1868
 
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
 
1955
    except OSError as e:
 
1956
        trace.warning(
 
1957
            'Unable to copy ownership from "%s" to "%s". '
 
1958
            'You may want to set it manually.', src, dst)
 
1959
        trace.log_exception_quietly()
1869
1960
 
1870
1961
 
1871
1962
def path_prefix_key(path):
1886
1977
_cached_user_encoding = None
1887
1978
 
1888
1979
 
1889
 
def get_user_encoding(use_cache=True):
 
1980
def get_user_encoding():
1890
1981
    """Find out what the preferred user encoding is.
1891
1982
 
1892
1983
    This is generally the encoding that is used for command line parameters
1893
1984
    and file contents. This may be different from the terminal encoding
1894
1985
    or the filesystem encoding.
1895
1986
 
1896
 
    :param  use_cache:  Enable cache for detected encoding.
1897
 
                        (This parameter is turned on by default,
1898
 
                        and required only for selftesting)
1899
 
 
1900
1987
    :return: A string defining the preferred user encoding
1901
1988
    """
1902
1989
    global _cached_user_encoding
1903
 
    if _cached_user_encoding is not None and use_cache:
 
1990
    if _cached_user_encoding is not None:
1904
1991
        return _cached_user_encoding
1905
1992
 
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'
 
1993
    if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
 
1994
        # Use the existing locale settings and call nl_langinfo directly
 
1995
        # rather than going through getpreferredencoding. This avoids
 
1996
        # <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
 
1997
        # possibility of the setlocale call throwing an error.
 
1998
        user_encoding = locale.nl_langinfo(locale.CODESET)
1923
1999
    else:
1924
 
        import locale
 
2000
        # GZ 2011-12-19: On windows could call GetACP directly instead.
 
2001
        user_encoding = locale.getpreferredencoding(False)
1925
2002
 
1926
2003
    try:
1927
 
        user_encoding = locale.getpreferredencoding()
1928
 
    except locale.Error, e:
1929
 
        sys.stderr.write('bzr: warning: %s\n'
1930
 
                         '  Could not determine what text encoding to use.\n'
1931
 
                         '  This error usually means your Python interpreter\n'
1932
 
                         '  doesn\'t support the locale set by $LANG (%s)\n'
1933
 
                         "  Continuing with ascii encoding.\n"
1934
 
                         % (e, os.environ.get('LANG')))
1935
 
        user_encoding = 'ascii'
1936
 
 
1937
 
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
1938
 
    # treat that as ASCII, and not support printing unicode characters to the
1939
 
    # console.
1940
 
    #
1941
 
    # For python scripts run under vim, we get '', so also treat that as ASCII
1942
 
    if user_encoding in (None, 'cp0', ''):
1943
 
        user_encoding = 'ascii'
1944
 
    else:
1945
 
        # check encoding
1946
 
        try:
1947
 
            codecs.lookup(user_encoding)
1948
 
        except LookupError:
1949
 
            sys.stderr.write('bzr: warning:'
 
2004
        user_encoding = codecs.lookup(user_encoding).name
 
2005
    except LookupError:
 
2006
        if user_encoding not in ("", "cp0"):
 
2007
            sys.stderr.write('brz: warning:'
1950
2008
                             ' unknown encoding %s.'
1951
2009
                             ' Continuing with ascii encoding.\n'
1952
2010
                             % user_encoding
1953
2011
                            )
1954
 
            user_encoding = 'ascii'
1955
 
 
1956
 
    if use_cache:
1957
 
        _cached_user_encoding = user_encoding
1958
 
 
 
2012
        user_encoding = 'ascii'
 
2013
    else:
 
2014
        # Get 'ascii' when setlocale has not been called or LANG=C or unset.
 
2015
        if user_encoding == 'ascii':
 
2016
            if sys.platform == 'darwin':
 
2017
                # OSX is special-cased in Python to have a UTF-8 filesystem
 
2018
                # encoding and previously had LANG set here if not present.
 
2019
                user_encoding = 'utf-8'
 
2020
            # GZ 2011-12-19: Maybe UTF-8 should be the default in this case
 
2021
            #                for some other posix platforms as well.
 
2022
 
 
2023
    _cached_user_encoding = user_encoding
1959
2024
    return user_encoding
1960
2025
 
1961
2026
 
 
2027
def get_diff_header_encoding():
 
2028
    return get_terminal_encoding()
 
2029
 
 
2030
 
1962
2031
def get_host_name():
1963
2032
    """Return the current unicode host name.
1964
2033
 
1966
2035
    behaves inconsistently on different platforms.
1967
2036
    """
1968
2037
    if sys.platform == "win32":
1969
 
        import win32utils
1970
2038
        return win32utils.get_host_name()
1971
2039
    else:
1972
2040
        import socket
1979
2047
# data at once.
1980
2048
MAX_SOCKET_CHUNK = 64 * 1024
1981
2049
 
 
2050
_end_of_stream_errors = [errno.ECONNRESET, errno.EPIPE, errno.EINVAL]
 
2051
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
 
2052
    _eno = getattr(errno, _eno, None)
 
2053
    if _eno is not None:
 
2054
        _end_of_stream_errors.append(_eno)
 
2055
del _eno
 
2056
 
 
2057
 
1982
2058
def read_bytes_from_socket(sock, report_activity=None,
1983
2059
        max_read_size=MAX_SOCKET_CHUNK):
1984
2060
    """Read up to max_read_size of bytes from sock and notify of progress.
1987
2063
    empty string rather than raise an error), and repeats the recv if
1988
2064
    interrupted by a signal.
1989
2065
    """
1990
 
    while 1:
 
2066
    while True:
1991
2067
        try:
1992
2068
            bytes = sock.recv(max_read_size)
1993
 
        except socket.error, e:
 
2069
        except socket.error as e:
1994
2070
            eno = e.args[0]
1995
 
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
 
2071
            if eno in _end_of_stream_errors:
1996
2072
                # The connection was closed by the other side.  Callers expect
1997
2073
                # an empty string to signal end-of-stream.
1998
2074
                return ""
2027
2103
 
2028
2104
def send_all(sock, bytes, report_activity=None):
2029
2105
    """Send all bytes on a socket.
2030
 
 
 
2106
 
2031
2107
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2032
2108
    some platforms, and catches EINTR which may be thrown if the send is
2033
2109
    interrupted by a signal.
2034
2110
 
2035
2111
    This is preferred to socket.sendall(), because it avoids portability bugs
2036
2112
    and provides activity reporting.
2037
 
 
 
2113
 
2038
2114
    :param report_activity: Call this as bytes are read, see
2039
2115
        Transport._report_activity
2040
2116
    """
2041
2117
    sent_total = 0
2042
2118
    byte_count = len(bytes)
 
2119
    view = memoryview(bytes)
2043
2120
    while sent_total < byte_count:
2044
2121
        try:
2045
 
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2046
 
        except socket.error, e:
 
2122
            sent = sock.send(view[sent_total:sent_total+MAX_SOCKET_CHUNK])
 
2123
        except (socket.error, IOError) as e:
 
2124
            if e.args[0] in _end_of_stream_errors:
 
2125
                raise errors.ConnectionReset(
 
2126
                    "Error trying to write to socket", e)
2047
2127
            if e.args[0] != errno.EINTR:
2048
2128
                raise
2049
2129
        else:
 
2130
            if sent == 0:
 
2131
                raise errors.ConnectionReset('Sending to %s returned 0 bytes'
 
2132
                                             % (sock,))
2050
2133
            sent_total += sent
2051
 
            report_activity(sent, 'write')
 
2134
            if report_activity is not None:
 
2135
                report_activity(sent, 'write')
 
2136
 
 
2137
 
 
2138
def connect_socket(address):
 
2139
    # Slight variation of the socket.create_connection() function (provided by
 
2140
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
 
2141
    # provide it for previous python versions. Also, we don't use the timeout
 
2142
    # parameter (provided by the python implementation) so we don't implement
 
2143
    # it either).
 
2144
    err = socket.error('getaddrinfo returns an empty list')
 
2145
    host, port = address
 
2146
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
 
2147
        af, socktype, proto, canonname, sa = res
 
2148
        sock = None
 
2149
        try:
 
2150
            sock = socket.socket(af, socktype, proto)
 
2151
            sock.connect(sa)
 
2152
            return sock
 
2153
 
 
2154
        except socket.error as err:
 
2155
            # 'err' is now the most recent error
 
2156
            if sock is not None:
 
2157
                sock.close()
 
2158
    raise err
2052
2159
 
2053
2160
 
2054
2161
def dereference_path(path):
2073
2180
def resource_string(package, resource_name):
2074
2181
    """Load a resource from a package and return it as a string.
2075
2182
 
2076
 
    Note: Only packages that start with bzrlib are currently supported.
 
2183
    Note: Only packages that start with breezy are currently supported.
2077
2184
 
2078
2185
    This is designed to be a lightweight implementation of resource
2079
2186
    loading in a way which is API compatible with the same API from
2082
2189
    If and when pkg_resources becomes a standard library, this routine
2083
2190
    can delegate to it.
2084
2191
    """
2085
 
    # Check package name is within bzrlib
2086
 
    if package == "bzrlib":
 
2192
    # Check package name is within breezy
 
2193
    if package == "breezy":
2087
2194
        resource_relpath = resource_name
2088
 
    elif package.startswith("bzrlib."):
2089
 
        package = package[len("bzrlib."):].replace('.', os.sep)
 
2195
    elif package.startswith("breezy."):
 
2196
        package = package[len("breezy."):].replace('.', os.sep)
2090
2197
        resource_relpath = pathjoin(package, resource_name)
2091
2198
    else:
2092
 
        raise errors.BzrError('resource package %s not in bzrlib' % package)
 
2199
        raise errors.BzrError('resource package %s not in breezy' % package)
2093
2200
 
2094
2201
    # Map the resource to a file and read its contents
2095
 
    base = dirname(bzrlib.__file__)
 
2202
    base = dirname(breezy.__file__)
2096
2203
    if getattr(sys, 'frozen', None):    # bzr.exe
2097
2204
        base = abspath(pathjoin(base, '..', '..'))
2098
 
    filename = pathjoin(base, resource_relpath)
2099
 
    return open(filename, 'rU').read()
2100
 
 
 
2205
    f = file(pathjoin(base, resource_relpath), "rU")
 
2206
    try:
 
2207
        return f.read()
 
2208
    finally:
 
2209
        f.close()
2101
2210
 
2102
2211
def file_kind_from_stat_mode_thunk(mode):
2103
2212
    global file_kind_from_stat_mode
2104
2213
    if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
2105
2214
        try:
2106
 
            from bzrlib._readdir_pyx import UTF8DirReader
 
2215
            from ._readdir_pyx import UTF8DirReader
2107
2216
            file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2108
 
        except ImportError, e:
 
2217
        except ImportError as e:
2109
2218
            # This is one time where we won't warn that an extension failed to
2110
2219
            # load. The extension is never available on Windows anyway.
2111
 
            from bzrlib._readdir_py import (
 
2220
            from ._readdir_py import (
2112
2221
                _kind_from_mode as file_kind_from_stat_mode
2113
2222
                )
2114
2223
    return file_kind_from_stat_mode(mode)
2115
2224
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2116
2225
 
2117
 
 
2118
 
def file_kind(f, _lstat=os.lstat):
 
2226
def file_stat(f, _lstat=os.lstat):
2119
2227
    try:
2120
 
        return file_kind_from_stat_mode(_lstat(f).st_mode)
2121
 
    except OSError, e:
 
2228
        # XXX cache?
 
2229
        return _lstat(f)
 
2230
    except OSError as e:
2122
2231
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2123
2232
            raise errors.NoSuchFile(f)
2124
2233
        raise
2125
2234
 
 
2235
def file_kind(f, _lstat=os.lstat):
 
2236
    stat_value = file_stat(f, _lstat)
 
2237
    return file_kind_from_stat_mode(stat_value.st_mode)
2126
2238
 
2127
2239
def until_no_eintr(f, *a, **kw):
2128
2240
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2129
 
    
 
2241
 
2130
2242
    WARNING: you must be certain that it is safe to retry the call repeatedly
2131
2243
    if EINTR does occur.  This is typically only true for low-level operations
2132
2244
    like os.read.  If in any doubt, don't use this.
2134
2246
    Keep in mind that this is not a complete solution to EINTR.  There is
2135
2247
    probably code in the Python standard library and other dependencies that
2136
2248
    may encounter EINTR if a signal arrives (and there is signal handler for
2137
 
    that signal).  So this function can reduce the impact for IO that bzrlib
 
2249
    that signal).  So this function can reduce the impact for IO that breezy
2138
2250
    directly controls, but it is not a complete solution.
2139
2251
    """
2140
2252
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
2141
2253
    while True:
2142
2254
        try:
2143
2255
            return f(*a, **kw)
2144
 
        except (IOError, OSError), e:
 
2256
        except (IOError, OSError) as e:
2145
2257
            if e.errno == errno.EINTR:
2146
2258
                continue
2147
2259
            raise
2148
2260
 
2149
2261
 
2150
 
def re_compile_checked(re_string, flags=0, where=""):
2151
 
    """Return a compiled re, or raise a sensible error.
2152
 
 
2153
 
    This should only be used when compiling user-supplied REs.
2154
 
 
2155
 
    :param re_string: Text form of regular expression.
2156
 
    :param flags: eg re.IGNORECASE
2157
 
    :param where: Message explaining to the user the context where
2158
 
        it occurred, eg 'log search filter'.
2159
 
    """
2160
 
    # from https://bugs.launchpad.net/bzr/+bug/251352
2161
 
    try:
2162
 
        re_obj = re.compile(re_string, flags)
2163
 
        re_obj.search("")
2164
 
        return re_obj
2165
 
    except re.error, e:
2166
 
        if where:
2167
 
            where = ' in ' + where
2168
 
        # despite the name 'error' is a type
2169
 
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2170
 
            % (where, re_string, e))
2171
 
 
2172
 
 
2173
2262
if sys.platform == "win32":
2174
 
    import msvcrt
2175
2263
    def getchar():
 
2264
        import msvcrt
2176
2265
        return msvcrt.getch()
2177
2266
else:
2178
 
    import tty
2179
 
    import termios
2180
2267
    def getchar():
 
2268
        import tty
 
2269
        import termios
2181
2270
        fd = sys.stdin.fileno()
2182
2271
        settings = termios.tcgetattr(fd)
2183
2272
        try:
2187
2276
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2188
2277
        return ch
2189
2278
 
2190
 
 
2191
 
if sys.platform == 'linux2':
 
2279
if sys.platform.startswith('linux'):
2192
2280
    def _local_concurrency():
2193
 
        concurrency = None
2194
 
        prefix = 'processor'
2195
 
        for line in file('/proc/cpuinfo', 'rb'):
2196
 
            if line.startswith(prefix):
2197
 
                concurrency = int(line[line.find(':')+1:]) + 1
2198
 
        return concurrency
 
2281
        try:
 
2282
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2283
        except (ValueError, OSError, AttributeError):
 
2284
            return None
2199
2285
elif sys.platform == 'darwin':
2200
2286
    def _local_concurrency():
2201
2287
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2202
2288
                                stdout=subprocess.PIPE).communicate()[0]
2203
 
elif sys.platform[0:7] == 'freebsd':
 
2289
elif "bsd" in sys.platform:
2204
2290
    def _local_concurrency():
2205
2291
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2206
2292
                                stdout=subprocess.PIPE).communicate()[0]
2231
2317
    if _cached_local_concurrency is not None and use_cache:
2232
2318
        return _cached_local_concurrency
2233
2319
 
2234
 
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
 
2320
    concurrency = os.environ.get('BRZ_CONCURRENCY', None)
2235
2321
    if concurrency is None:
2236
2322
        try:
2237
 
            concurrency = _local_concurrency()
2238
 
        except (OSError, IOError):
2239
 
            pass
 
2323
            import multiprocessing
 
2324
            concurrency = multiprocessing.cpu_count()
 
2325
        except (ImportError, NotImplementedError):
 
2326
            # multiprocessing is only available on Python >= 2.6
 
2327
            # and multiprocessing.cpu_count() isn't implemented on all
 
2328
            # platforms
 
2329
            try:
 
2330
                concurrency = _local_concurrency()
 
2331
            except (OSError, IOError):
 
2332
                pass
2240
2333
    try:
2241
2334
        concurrency = int(concurrency)
2242
2335
    except (TypeError, ValueError):
2254
2347
        self.encode = encode
2255
2348
 
2256
2349
    def write(self, object):
2257
 
        if type(object) is str:
 
2350
        if isinstance(object, str):
2258
2351
            self.stream.write(object)
2259
2352
        else:
2260
2353
            data, _ = self.encode(object, self.errors)
2263
2356
if sys.platform == 'win32':
2264
2357
    def open_file(filename, mode='r', bufsize=-1):
2265
2358
        """This function is used to override the ``open`` builtin.
2266
 
        
 
2359
 
2267
2360
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2268
2361
        child processes.  Deleting or renaming a closed file opened with this
2269
2362
        function is not blocking child processes.
2302
2395
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2303
2396
else:
2304
2397
    open_file = open
 
2398
 
 
2399
 
 
2400
def available_backup_name(base, exists):
 
2401
    """Find a non-existing backup file name.
 
2402
 
 
2403
    This will *not* create anything, this only return a 'free' entry.  This
 
2404
    should be used for checking names in a directory below a locked
 
2405
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
 
2406
    Leap) and generally discouraged.
 
2407
 
 
2408
    :param base: The base name.
 
2409
 
 
2410
    :param exists: A callable returning True if the path parameter exists.
 
2411
    """
 
2412
    counter = 1
 
2413
    name = "%s.~%d~" % (base, counter)
 
2414
    while exists(name):
 
2415
        counter += 1
 
2416
        name = "%s.~%d~" % (base, counter)
 
2417
    return name
 
2418
 
 
2419
 
 
2420
def set_fd_cloexec(fd):
 
2421
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
 
2422
    support for this is not available.
 
2423
    """
 
2424
    try:
 
2425
        import fcntl
 
2426
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
 
2427
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
 
2428
    except (ImportError, AttributeError):
 
2429
        # Either the fcntl module or specific constants are not present
 
2430
        pass
 
2431
 
 
2432
 
 
2433
def find_executable_on_path(name):
 
2434
    """Finds an executable on the PATH.
 
2435
    
 
2436
    On Windows, this will try to append each extension in the PATHEXT
 
2437
    environment variable to the name, if it cannot be found with the name
 
2438
    as given.
 
2439
    
 
2440
    :param name: The base name of the executable.
 
2441
    :return: The path to the executable found or None.
 
2442
    """
 
2443
    if sys.platform == 'win32':
 
2444
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
 
2445
        exts = [ext.lower() for ext in exts]
 
2446
        base, ext = os.path.splitext(name)
 
2447
        if ext != '':
 
2448
            if ext.lower() not in exts:
 
2449
                return None
 
2450
            name = base
 
2451
            exts = [ext]
 
2452
    else:
 
2453
        exts = ['']
 
2454
    path = os.environ.get('PATH')
 
2455
    if path is not None:
 
2456
        path = path.split(os.pathsep)
 
2457
        for ext in exts:
 
2458
            for d in path:
 
2459
                f = os.path.join(d, name) + ext
 
2460
                if os.access(f, os.X_OK):
 
2461
                    return f
 
2462
    if sys.platform == 'win32':
 
2463
        app_path = win32utils.get_app_path(name)
 
2464
        if app_path != name:
 
2465
            return app_path
 
2466
    return None
 
2467
 
 
2468
 
 
2469
def _posix_is_local_pid_dead(pid):
 
2470
    """True if pid doesn't correspond to live process on this machine"""
 
2471
    try:
 
2472
        # Special meaning of unix kill: just check if it's there.
 
2473
        os.kill(pid, 0)
 
2474
    except OSError as e:
 
2475
        if e.errno == errno.ESRCH:
 
2476
            # On this machine, and really not found: as sure as we can be
 
2477
            # that it's dead.
 
2478
            return True
 
2479
        elif e.errno == errno.EPERM:
 
2480
            # exists, though not ours
 
2481
            return False
 
2482
        else:
 
2483
            mutter("os.kill(%d, 0) failed: %s" % (pid, e))
 
2484
            # Don't really know.
 
2485
            return False
 
2486
    else:
 
2487
        # Exists and our process: not dead.
 
2488
        return False
 
2489
 
 
2490
if sys.platform == "win32":
 
2491
    is_local_pid_dead = win32utils.is_local_pid_dead
 
2492
else:
 
2493
    is_local_pid_dead = _posix_is_local_pid_dead
 
2494
 
 
2495
_maybe_ignored = ['EAGAIN', 'EINTR', 'ENOTSUP', 'EOPNOTSUPP', 'EACCES']
 
2496
_fdatasync_ignored = [getattr(errno, name) for name in _maybe_ignored
 
2497
                      if getattr(errno, name, None) is not None]
 
2498
 
 
2499
 
 
2500
def fdatasync(fileno):
 
2501
    """Flush file contents to disk if possible.
 
2502
    
 
2503
    :param fileno: Integer OS file handle.
 
2504
    :raises TransportNotPossible: If flushing to disk is not possible.
 
2505
    """
 
2506
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
 
2507
    if fn is not None:
 
2508
        try:
 
2509
            fn(fileno)
 
2510
        except IOError as e:
 
2511
            # See bug #1075108, on some platforms fdatasync exists, but can
 
2512
            # raise ENOTSUP. However, we are calling fdatasync to be helpful
 
2513
            # and reduce the chance of corruption-on-powerloss situations. It
 
2514
            # is not a mandatory call, so it is ok to suppress failures.
 
2515
            trace.mutter("ignoring error calling fdatasync: %s" % (e,))
 
2516
            if getattr(e, 'errno', None) not in _fdatasync_ignored:
 
2517
                raise
 
2518
 
 
2519
 
 
2520
def ensure_empty_directory_exists(path, exception_class):
 
2521
    """Make sure a local directory exists and is empty.
 
2522
    
 
2523
    If it does not exist, it is created.  If it exists and is not empty, an
 
2524
    instance of exception_class is raised.
 
2525
    """
 
2526
    try:
 
2527
        os.mkdir(path)
 
2528
    except OSError as e:
 
2529
        if e.errno != errno.EEXIST:
 
2530
            raise
 
2531
        if os.listdir(path) != []:
 
2532
            raise exception_class(path)
 
2533
 
 
2534
 
 
2535
def is_environment_error(evalue):
 
2536
    """True if exception instance is due to a process environment issue
 
2537
 
 
2538
    This includes OSError and IOError, but also other errors that come from
 
2539
    the operating system or core libraries but are not subclasses of those.
 
2540
    """
 
2541
    if isinstance(evalue, (EnvironmentError, select.error)):
 
2542
        return True
 
2543
    if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
 
2544
        return True
 
2545
    return False