/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-05-30 19:16:23 UTC
  • mto: This revision was merged to the branch mainline in revision 6639.
  • Revision ID: jelmer@jelmer.uk-20170530191623-t9ls96vjy9wslpoo
Remove deprecated functionality.

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 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('\\', '/'))
 
374
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
 
375
    return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
313
376
 
314
377
 
315
378
def _win98_abspath(path):
326
389
    #   /path       => C:/path
327
390
    path = unicode(path)
328
391
    # check for absolute path
329
 
    drive = _nt_splitdrive(path)[0]
 
392
    drive = ntpath.splitdrive(path)[0]
330
393
    if drive == '' and path[:2] not in('//','\\\\'):
331
 
        cwd = os.getcwdu()
 
394
        cwd = _getcwd()
332
395
        # we cannot simply os.path.join cwd and path
333
396
        # because os.path.join('C:','/path') produce '/path'
334
397
        # and this is incorrect
335
398
        if path[:1] in ('/','\\'):
336
 
            cwd = _nt_splitdrive(cwd)[0]
 
399
            cwd = ntpath.splitdrive(cwd)[0]
337
400
            path = path[1:]
338
401
        path = cwd + '\\' + path
339
 
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
 
402
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
340
403
 
341
404
 
342
405
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('\\', '/'))
 
406
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
 
407
    return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
345
408
 
346
409
 
347
410
def _win32_pathjoin(*args):
348
 
    return _nt_join(*args).replace('\\', '/')
 
411
    return ntpath.join(*args).replace('\\', '/')
349
412
 
350
413
 
351
414
def _win32_normpath(path):
352
 
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
415
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
353
416
 
354
417
 
355
418
def _win32_getcwd():
356
 
    return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
 
419
    return _win32_fixdrive(_getcwd().replace('\\', '/'))
357
420
 
358
421
 
359
422
def _win32_mkdtemp(*args, **kwargs):
360
423
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
361
424
 
362
425
 
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
426
def _win32_rename(old, new):
372
427
    """We expect to be able to atomically replace 'new' with old.
373
428
 
375
430
    and then deleted.
376
431
    """
377
432
    try:
378
 
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
379
 
    except OSError, e:
 
433
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
 
434
    except OSError as e:
380
435
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
381
436
            # If we try to rename a non-existant file onto cwd, we get
382
437
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT
386
441
        raise
387
442
 
388
443
 
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
444
def _mac_getcwd():
400
 
    return unicodedata.normalize('NFC', os.getcwdu())
401
 
 
 
445
    return unicodedata.normalize('NFC', _getcwd())
 
446
 
 
447
 
 
448
def _rename_wrap_exception(rename_func):
 
449
    """Adds extra information to any exceptions that come from rename().
 
450
 
 
451
    The exception has an updated message and 'old_filename' and 'new_filename'
 
452
    attributes.
 
453
    """
 
454
 
 
455
    def _rename_wrapper(old, new):
 
456
        try:
 
457
            rename_func(old, new)
 
458
        except OSError as e:
 
459
            detailed_error = OSError(e.errno, e.strerror +
 
460
                                " [occurred when renaming '%s' to '%s']" %
 
461
                                (old, new))
 
462
            detailed_error.old_filename = old
 
463
            detailed_error.new_filename = new
 
464
            raise detailed_error
 
465
 
 
466
    return _rename_wrapper
 
467
 
 
468
 
 
469
if sys.version_info > (3,):
 
470
    _getcwd = os.getcwd
 
471
else:
 
472
    _getcwd = os.getcwdu
 
473
 
 
474
 
 
475
# Default rename wraps os.rename()
 
476
rename = _rename_wrap_exception(os.rename)
402
477
 
403
478
# Default is to just use the python builtins, but these can be rebound on
404
479
# particular platforms.
405
480
abspath = _posix_abspath
406
481
realpath = _posix_realpath
407
482
pathjoin = os.path.join
408
 
normpath = os.path.normpath
409
 
rename = _wrapped_rename # overridden below on win32
410
 
getcwd = os.getcwdu
 
483
normpath = _posix_normpath
 
484
path_from_environ = _posix_path_from_environ
 
485
_get_home_dir = _posix_get_home_dir
 
486
getuser_unicode = _posix_getuser_unicode
 
487
getcwd = _getcwd
411
488
dirname = os.path.dirname
412
489
basename = os.path.basename
413
490
split = os.path.split
414
491
splitext = os.path.splitext
415
 
# These were already imported into local scope
 
492
# These were already lazily imported into local scope
416
493
# mkdtemp = tempfile.mkdtemp
417
494
# rmtree = shutil.rmtree
 
495
lstat = os.lstat
 
496
fstat = os.fstat
 
497
 
 
498
def wrap_stat(st):
 
499
    return st
 
500
 
418
501
 
419
502
MIN_ABS_PATHLENGTH = 1
420
503
 
429
512
    normpath = _win32_normpath
430
513
    getcwd = _win32_getcwd
431
514
    mkdtemp = _win32_mkdtemp
432
 
    rename = _win32_rename
 
515
    rename = _rename_wrap_exception(_win32_rename)
 
516
    try:
 
517
        from . import _walkdirs_win32
 
518
    except ImportError:
 
519
        pass
 
520
    else:
 
521
        lstat = _walkdirs_win32.lstat
 
522
        fstat = _walkdirs_win32.fstat
 
523
        wrap_stat = _walkdirs_win32.wrap_stat
433
524
 
434
525
    MIN_ABS_PATHLENGTH = 3
435
526
 
453
544
    f = win32utils.get_unicode_argv     # special function or None
454
545
    if f is not None:
455
546
        get_unicode_argv = f
 
547
    path_from_environ = win32utils.get_environ_unicode
 
548
    _get_home_dir = win32utils.get_home_location
 
549
    getuser_unicode = win32utils.get_user_name
456
550
 
457
551
elif sys.platform == 'darwin':
458
552
    getcwd = _mac_getcwd
459
553
 
460
554
 
461
 
def get_terminal_encoding():
 
555
def get_terminal_encoding(trace=False):
462
556
    """Find the best encoding for printing to the screen.
463
557
 
464
558
    This attempts to check both sys.stdout and sys.stdin to see
470
564
 
471
565
    On my standard US Windows XP, the preferred encoding is
472
566
    cp1252, but the console is cp437
 
567
 
 
568
    :param trace: If True trace the selected encoding via mutter().
473
569
    """
474
 
    from bzrlib.trace import mutter
 
570
    from .trace import mutter
475
571
    output_encoding = getattr(sys.stdout, 'encoding', None)
476
572
    if not output_encoding:
477
573
        input_encoding = getattr(sys.stdin, 'encoding', None)
478
574
        if not input_encoding:
479
575
            output_encoding = get_user_encoding()
480
 
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
576
            if trace:
 
577
                mutter('encoding stdout as osutils.get_user_encoding() %r',
481
578
                   output_encoding)
482
579
        else:
483
580
            output_encoding = input_encoding
484
 
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
581
            if trace:
 
582
                mutter('encoding stdout as sys.stdin encoding %r',
 
583
                    output_encoding)
485
584
    else:
486
 
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
585
        if trace:
 
586
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
487
587
    if output_encoding == 'cp0':
488
588
        # invalid encoding (cp0 means 'no codepage' on Windows)
489
589
        output_encoding = get_user_encoding()
490
 
        mutter('cp0 is invalid encoding.'
 
590
        if trace:
 
591
            mutter('cp0 is invalid encoding.'
491
592
               ' encoding stdout as osutils.get_user_encoding() %r',
492
593
               output_encoding)
493
594
    # check encoding
494
595
    try:
495
596
        codecs.lookup(output_encoding)
496
597
    except LookupError:
497
 
        sys.stderr.write('bzr: warning:'
 
598
        sys.stderr.write('brz: warning:'
498
599
                         ' unknown terminal encoding %s.\n'
499
600
                         '  Using encoding %s instead.\n'
500
601
                         % (output_encoding, get_user_encoding())
519
620
def isdir(f):
520
621
    """True if f is an accessible directory."""
521
622
    try:
522
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
623
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
523
624
    except OSError:
524
625
        return False
525
626
 
527
628
def isfile(f):
528
629
    """True if f is a regular file."""
529
630
    try:
530
 
        return S_ISREG(os.lstat(f)[ST_MODE])
 
631
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
531
632
    except OSError:
532
633
        return False
533
634
 
534
635
def islink(f):
535
636
    """True if f is a symlink."""
536
637
    try:
537
 
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
638
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
538
639
    except OSError:
539
640
        return False
540
641
 
728
829
            return True
729
830
 
730
831
 
 
832
def gmtime(seconds=None):
 
833
    """Convert seconds since the Epoch to a time tuple expressing UTC (a.k.a.
 
834
    GMT). When 'seconds' is not passed in, convert the current time instead.
 
835
    Handy replacement for time.gmtime() buggy on Windows and 32-bit platforms.
 
836
    """
 
837
    if seconds is None:
 
838
        seconds = time.time()
 
839
    return (datetime(1970, 1, 1) + timedelta(seconds=seconds)).timetuple()
 
840
 
 
841
 
731
842
def local_time_offset(t=None):
732
843
    """Return offset of local zone from GMT, either at present or at time t."""
733
844
    if t is None:
773
884
    """
774
885
    if offset is None:
775
886
        offset = 0
776
 
    tt = time.gmtime(t + offset)
 
887
    tt = gmtime(t + offset)
777
888
    date_fmt = _default_format_by_weekday_num[tt[6]]
778
889
    date_str = time.strftime(date_fmt, tt)
779
890
    offset_str = _cache.get(offset, None)
798
909
    (date_fmt, tt, offset_str) = \
799
910
               _format_date(t, offset, timezone, date_fmt, show_offset)
800
911
    date_str = time.strftime(date_fmt, tt)
801
 
    if not isinstance(date_str, unicode):
 
912
    if not isinstance(date_str, text_type):
802
913
        date_str = date_str.decode(get_user_encoding(), 'replace')
803
914
    return date_str + offset_str
804
915
 
805
916
 
806
917
def _format_date(t, offset, timezone, date_fmt, show_offset):
807
918
    if timezone == 'utc':
808
 
        tt = time.gmtime(t)
 
919
        tt = gmtime(t)
809
920
        offset = 0
810
921
    elif timezone == 'original':
811
922
        if offset is None:
812
923
            offset = 0
813
 
        tt = time.gmtime(t + offset)
 
924
        tt = gmtime(t + offset)
814
925
    elif timezone == 'local':
815
926
        tt = time.localtime(t)
816
927
        offset = local_time_offset(t)
826
937
 
827
938
 
828
939
def compact_date(when):
829
 
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
 
940
    return time.strftime('%Y%m%d%H%M%S', gmtime(when))
830
941
 
831
942
 
832
943
def format_delta(delta):
880
991
 
881
992
def filesize(f):
882
993
    """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
 
994
    return os.fstat(f.fileno())[stat.ST_SIZE]
 
995
 
 
996
 
 
997
# Alias os.urandom to support platforms (which?) without /dev/urandom and 
 
998
# override if it doesn't work. Avoid checking on windows where there is
 
999
# significant initialisation cost that can be avoided for some bzr calls.
 
1000
 
 
1001
rand_bytes = os.urandom
 
1002
 
 
1003
if rand_bytes.__module__ != "nt":
895
1004
    try:
896
 
        rand_bytes = file('/dev/urandom', 'rb').read
897
 
    # Otherwise, use this hack as a last resort
898
 
    except (IOError, OSError):
 
1005
        rand_bytes(1)
 
1006
    except NotImplementedError:
899
1007
        # not well seeded, but better than nothing
900
1008
        def rand_bytes(n):
901
1009
            import random
931
1039
    rps = []
932
1040
    for f in ps:
933
1041
        if f == '..':
934
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1042
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
935
1043
        elif (f == '.') or (f == ''):
936
1044
            pass
937
1045
        else:
942
1050
def joinpath(p):
943
1051
    for f in p:
944
1052
        if (f == '..') or (f is None) or (f == ''):
945
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1053
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
946
1054
    return pathjoin(*p)
947
1055
 
948
1056
 
949
1057
def parent_directories(filename):
950
1058
    """Return the list of parent directories, deepest first.
951
 
    
 
1059
 
952
1060
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
953
1061
    """
954
1062
    parents = []
970
1078
    implementation should be loaded instead::
971
1079
 
972
1080
    >>> try:
973
 
    >>>     import bzrlib._fictional_extension_pyx
 
1081
    >>>     import breezy._fictional_extension_pyx
974
1082
    >>> except ImportError, e:
975
 
    >>>     bzrlib.osutils.failed_to_load_extension(e)
976
 
    >>>     import bzrlib._fictional_extension_py
 
1083
    >>>     breezy.osutils.failed_to_load_extension(e)
 
1084
    >>>     import breezy._fictional_extension_py
977
1085
    """
978
1086
    # NB: This docstring is just an example, not a doctest, because doctest
979
1087
    # currently can't cope with the use of lazy imports in this namespace --
980
1088
    # mbp 20090729
981
 
    
 
1089
 
982
1090
    # This currently doesn't report the failure at the time it occurs, because
983
1091
    # they tend to happen very early in startup when we can't check config
984
1092
    # files etc, and also we want to report all failures but not spam the user
985
1093
    # with 10 warnings.
986
 
    from bzrlib import trace
987
1094
    exception_str = str(exception)
988
1095
    if exception_str not in _extension_load_failures:
989
1096
        trace.mutter("failed to load compiled extension: %s" % exception_str)
993
1100
def report_extension_load_failures():
994
1101
    if not _extension_load_failures:
995
1102
        return
996
 
    from bzrlib.config import GlobalConfig
997
 
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
 
1103
    if config.GlobalStack().get('ignore_missing_extensions'):
998
1104
        return
999
1105
    # the warnings framework should by default show this only once
1000
 
    from bzrlib.trace import warning
 
1106
    from .trace import warning
1001
1107
    warning(
1002
 
        "bzr: warning: some compiled extensions could not be loaded; "
 
1108
        "brz: warning: some compiled extensions could not be loaded; "
1003
1109
        "see <https://answers.launchpad.net/bzr/+faq/703>")
1004
1110
    # we no longer show the specific missing extensions here, because it makes
1005
1111
    # the message too long and scary - see
1007
1113
 
1008
1114
 
1009
1115
try:
1010
 
    from bzrlib._chunks_to_lines_pyx import chunks_to_lines
1011
 
except ImportError, e:
 
1116
    from ._chunks_to_lines_pyx import chunks_to_lines
 
1117
except ImportError as e:
1012
1118
    failed_to_load_extension(e)
1013
 
    from bzrlib._chunks_to_lines_py import chunks_to_lines
 
1119
    from ._chunks_to_lines_py import chunks_to_lines
1014
1120
 
1015
1121
 
1016
1122
def split_lines(s):
1047
1153
        return
1048
1154
    try:
1049
1155
        os.link(src, dest)
1050
 
    except (OSError, IOError), e:
 
1156
    except (OSError, IOError) as e:
1051
1157
        if e.errno != errno.EXDEV:
1052
1158
            raise
1053
1159
        shutil.copyfile(src, dest)
1054
1160
 
1055
1161
 
1056
1162
def delete_any(path):
1057
 
    """Delete a file, symlink or directory.  
1058
 
    
 
1163
    """Delete a file, symlink or directory.
 
1164
 
1059
1165
    Will delete even if readonly.
1060
1166
    """
1061
1167
    try:
1062
1168
       _delete_file_or_dir(path)
1063
 
    except (OSError, IOError), e:
 
1169
    except (OSError, IOError) as e:
1064
1170
        if e.errno in (errno.EPERM, errno.EACCES):
1065
1171
            # make writable and try again
1066
1172
            try:
1162
1268
 
1163
1269
    if len(base) < MIN_ABS_PATHLENGTH:
1164
1270
        # must have space for e.g. a drive letter
1165
 
        raise ValueError('%r is too short to calculate a relative path'
 
1271
        raise ValueError(gettext('%r is too short to calculate a relative path')
1166
1272
            % (base,))
1167
1273
 
1168
1274
    rp = abspath(path)
1250
1356
    # but for now, we haven't optimized...
1251
1357
    return [canonical_relpath(base, p) for p in paths]
1252
1358
 
 
1359
 
 
1360
def decode_filename(filename):
 
1361
    """Decode the filename using the filesystem encoding
 
1362
 
 
1363
    If it is unicode, it is returned.
 
1364
    Otherwise it is decoded from the the filesystem's encoding. If decoding
 
1365
    fails, a errors.BadFilenameEncoding exception is raised.
 
1366
    """
 
1367
    if isinstance(filename, text_type):
 
1368
        return filename
 
1369
    try:
 
1370
        return filename.decode(_fs_enc)
 
1371
    except UnicodeDecodeError:
 
1372
        raise errors.BadFilenameEncoding(filename, _fs_enc)
 
1373
 
 
1374
 
1253
1375
def safe_unicode(unicode_or_utf8_string):
1254
1376
    """Coerce unicode_or_utf8_string into unicode.
1255
1377
 
1257
1379
    Otherwise it is decoded from utf-8. If decoding fails, the exception is
1258
1380
    wrapped in a BzrBadParameterNotUnicode exception.
1259
1381
    """
1260
 
    if isinstance(unicode_or_utf8_string, unicode):
 
1382
    if isinstance(unicode_or_utf8_string, text_type):
1261
1383
        return unicode_or_utf8_string
1262
1384
    try:
1263
1385
        return unicode_or_utf8_string.decode('utf8')
1284
1406
    return unicode_or_utf8_string.encode('utf-8')
1285
1407
 
1286
1408
 
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):
 
1409
def safe_revision_id(unicode_or_utf8_string):
1293
1410
    """Revision ids should now be utf8, but at one point they were unicode.
1294
1411
 
1295
1412
    :param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
1296
1413
        utf8 or None).
1297
 
    :param warn: Functions that are sanitizing user data can set warn=False
1298
1414
    :return: None or a utf8 revision id.
1299
1415
    """
1300
1416
    if (unicode_or_utf8_string is None
1301
1417
        or unicode_or_utf8_string.__class__ == str):
1302
1418
        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):
 
1419
    raise TypeError('Unicode revision ids are no longer supported. '
 
1420
                    'Revision id generators should be creating utf8 revision '
 
1421
                    'ids.')
 
1422
 
 
1423
 
 
1424
def safe_file_id(unicode_or_utf8_string):
1314
1425
    """File ids should now be utf8, but at one point they were unicode.
1315
1426
 
1316
1427
    This is the same as safe_utf8, except it uses the cached encode functions
1318
1429
 
1319
1430
    :param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
1320
1431
        utf8 or None).
1321
 
    :param warn: Functions that are sanitizing user data can set warn=False
1322
1432
    :return: None or a utf8 file id.
1323
1433
    """
1324
1434
    if (unicode_or_utf8_string is None
1325
1435
        or unicode_or_utf8_string.__class__ == str):
1326
1436
        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)
 
1437
    raise TypeError('Unicode file ids are no longer supported. '
 
1438
                    'File id generators should be creating utf8 file ids.')
1331
1439
 
1332
1440
 
1333
1441
_platform_normalizes_filenames = False
1338
1446
def normalizes_filenames():
1339
1447
    """Return True if this platform normalizes unicode filenames.
1340
1448
 
1341
 
    Mac OSX does, Windows/Linux do not.
 
1449
    Only Mac OSX.
1342
1450
    """
1343
1451
    return _platform_normalizes_filenames
1344
1452
 
1349
1457
    On platforms where the system normalizes filenames (Mac OSX),
1350
1458
    you can access a file by any path which will normalize correctly.
1351
1459
    On platforms where the system does not normalize filenames
1352
 
    (Windows, Linux), you have to access a file by its exact path.
 
1460
    (everything else), you have to access a file by its exact path.
1353
1461
 
1354
1462
    Internally, bzr only supports NFC normalization, since that is
1355
1463
    the standard for XML documents.
1417
1525
terminal_width() returns None.
1418
1526
"""
1419
1527
 
 
1528
# Keep some state so that terminal_width can detect if _terminal_size has
 
1529
# returned a different size since the process started.  See docstring and
 
1530
# comments of terminal_width for details.
 
1531
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
 
1532
_terminal_size_state = 'no_data'
 
1533
_first_terminal_size = None
1420
1534
 
1421
1535
def terminal_width():
1422
1536
    """Return terminal width.
1424
1538
    None is returned if the width can't established precisely.
1425
1539
 
1426
1540
    The rules are:
1427
 
    - if BZR_COLUMNS is set, returns its value
 
1541
    - if BRZ_COLUMNS is set, returns its value
1428
1542
    - if there is no controlling terminal, returns None
 
1543
    - query the OS, if the queried size has changed since the last query,
 
1544
      return its value,
1429
1545
    - if COLUMNS is set, returns its value,
 
1546
    - if the OS has a value (even though it's never changed), return its value.
1430
1547
 
1431
1548
    From there, we need to query the OS to get the size of the controlling
1432
1549
    terminal.
1433
1550
 
1434
 
    Unices:
 
1551
    On Unices we query the OS by:
1435
1552
    - get termios.TIOCGWINSZ
1436
1553
    - if an error occurs or a negative value is obtained, returns None
1437
1554
 
1438
 
    Windows:
1439
 
    
 
1555
    On Windows we query the OS by:
1440
1556
    - win32utils.get_console_size() decides,
1441
1557
    - returns None on error (provided default value)
1442
1558
    """
 
1559
    # Note to implementors: if changing the rules for determining the width,
 
1560
    # make sure you've considered the behaviour in these cases:
 
1561
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
 
1562
    #  - brz log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
 
1563
    #    0,0.
 
1564
    #  - (add more interesting cases here, if you find any)
 
1565
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
 
1566
    # but we don't want to register a signal handler because it is impossible
 
1567
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
 
1568
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
 
1569
    # time so we can notice if the reported size has changed, which should have
 
1570
    # a similar effect.
1443
1571
 
1444
 
    # If BZR_COLUMNS is set, take it, user is always right
 
1572
    # If BRZ_COLUMNS is set, take it, user is always right
 
1573
    # Except if they specified 0 in which case, impose no limit here
1445
1574
    try:
1446
 
        return int(os.environ['BZR_COLUMNS'])
 
1575
        width = int(os.environ['BRZ_COLUMNS'])
1447
1576
    except (KeyError, ValueError):
1448
 
        pass
 
1577
        width = None
 
1578
    if width is not None:
 
1579
        if width > 0:
 
1580
            return width
 
1581
        else:
 
1582
            return None
1449
1583
 
1450
1584
    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.
 
1585
    if isatty is None or not isatty():
 
1586
        # Don't guess, setting BRZ_COLUMNS is the recommended way to override.
1453
1587
        return None
1454
1588
 
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))
 
1589
    # Query the OS
 
1590
    width, height = os_size = _terminal_size(None, None)
 
1591
    global _first_terminal_size, _terminal_size_state
 
1592
    if _terminal_size_state == 'no_data':
 
1593
        _first_terminal_size = os_size
 
1594
        _terminal_size_state = 'unchanged'
 
1595
    elif (_terminal_size_state == 'unchanged' and
 
1596
          _first_terminal_size != os_size):
 
1597
        _terminal_size_state = 'changed'
 
1598
 
 
1599
    # If the OS claims to know how wide the terminal is, and this value has
 
1600
    # ever changed, use that.
 
1601
    if _terminal_size_state == 'changed':
 
1602
        if width is not None and width > 0:
 
1603
            return width
 
1604
 
 
1605
    # If COLUMNS is set, use it.
1458
1606
    try:
1459
1607
        return int(os.environ['COLUMNS'])
1460
1608
    except (KeyError, ValueError):
1461
1609
        pass
1462
1610
 
1463
 
    width, height = _terminal_size(None, None)
1464
 
    if width <= 0:
1465
 
        # Consider invalid values as meaning no width
1466
 
        return None
 
1611
    # Finally, use an unchanged size from the OS, if we have one.
 
1612
    if _terminal_size_state == 'unchanged':
 
1613
        if width is not None and width > 0:
 
1614
            return width
1467
1615
 
1468
 
    return width
 
1616
    # The width could not be determined.
 
1617
    return None
1469
1618
 
1470
1619
 
1471
1620
def _win32_terminal_size(width, height):
1498
1647
    _terminal_size = _ioctl_terminal_size
1499
1648
 
1500
1649
 
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
1650
def supports_executable():
1527
1651
    return sys.platform != "win32"
1528
1652
 
1553
1677
        if orig_val is not None:
1554
1678
            del os.environ[env_variable]
1555
1679
    else:
1556
 
        if isinstance(value, unicode):
 
1680
        if not PY3 and isinstance(value, text_type):
1557
1681
            value = value.encode(get_user_encoding())
1558
1682
        os.environ[env_variable] = value
1559
1683
    return orig_val
1651
1775
        dirblock = []
1652
1776
        append = dirblock.append
1653
1777
        try:
1654
 
            names = sorted(_listdir(top))
1655
 
        except OSError, e:
 
1778
            names = sorted(map(decode_filename, _listdir(top)))
 
1779
        except OSError as e:
1656
1780
            if not _is_error_enotdir(e):
1657
1781
                raise
1658
1782
        else:
1711
1835
    """
1712
1836
    global _selected_dir_reader
1713
1837
    if _selected_dir_reader is None:
1714
 
        fs_encoding = _fs_enc.upper()
1715
1838
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1716
1839
            # Win98 doesn't have unicode apis like FindFirstFileW
1717
1840
            # TODO: We possibly could support Win98 by falling back to the
1719
1842
            #       but that gets a bit tricky, and requires custom compiling
1720
1843
            #       for win98 anyway.
1721
1844
            try:
1722
 
                from bzrlib._walkdirs_win32 import Win32ReadDir
 
1845
                from ._walkdirs_win32 import Win32ReadDir
1723
1846
                _selected_dir_reader = Win32ReadDir()
1724
1847
            except ImportError:
1725
1848
                pass
1726
 
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1727
 
            # ANSI_X3.4-1968 is a form of ASCII
 
1849
        elif _fs_enc in ('utf-8', 'ascii'):
1728
1850
            try:
1729
 
                from bzrlib._readdir_pyx import UTF8DirReader
 
1851
                from ._readdir_pyx import UTF8DirReader
1730
1852
                _selected_dir_reader = UTF8DirReader()
1731
 
            except ImportError, e:
 
1853
            except ImportError as e:
1732
1854
                failed_to_load_extension(e)
1733
1855
                pass
1734
1856
 
1864
1986
    try:
1865
1987
        s = os.stat(src)
1866
1988
        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))
 
1989
    except OSError as e:
 
1990
        trace.warning(
 
1991
            'Unable to copy ownership from "%s" to "%s". '
 
1992
            'You may want to set it manually.', src, dst)
 
1993
        trace.log_exception_quietly()
1869
1994
 
1870
1995
 
1871
1996
def path_prefix_key(path):
1886
2011
_cached_user_encoding = None
1887
2012
 
1888
2013
 
1889
 
def get_user_encoding(use_cache=True):
 
2014
def get_user_encoding():
1890
2015
    """Find out what the preferred user encoding is.
1891
2016
 
1892
2017
    This is generally the encoding that is used for command line parameters
1893
2018
    and file contents. This may be different from the terminal encoding
1894
2019
    or the filesystem encoding.
1895
2020
 
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
2021
    :return: A string defining the preferred user encoding
1901
2022
    """
1902
2023
    global _cached_user_encoding
1903
 
    if _cached_user_encoding is not None and use_cache:
 
2024
    if _cached_user_encoding is not None:
1904
2025
        return _cached_user_encoding
1905
2026
 
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'
 
2027
    if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
 
2028
        # Use the existing locale settings and call nl_langinfo directly
 
2029
        # rather than going through getpreferredencoding. This avoids
 
2030
        # <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
 
2031
        # possibility of the setlocale call throwing an error.
 
2032
        user_encoding = locale.nl_langinfo(locale.CODESET)
1923
2033
    else:
1924
 
        import locale
 
2034
        # GZ 2011-12-19: On windows could call GetACP directly instead.
 
2035
        user_encoding = locale.getpreferredencoding(False)
1925
2036
 
1926
2037
    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:'
 
2038
        user_encoding = codecs.lookup(user_encoding).name
 
2039
    except LookupError:
 
2040
        if user_encoding not in ("", "cp0"):
 
2041
            sys.stderr.write('brz: warning:'
1950
2042
                             ' unknown encoding %s.'
1951
2043
                             ' Continuing with ascii encoding.\n'
1952
2044
                             % user_encoding
1953
2045
                            )
1954
 
            user_encoding = 'ascii'
1955
 
 
1956
 
    if use_cache:
1957
 
        _cached_user_encoding = user_encoding
1958
 
 
 
2046
        user_encoding = 'ascii'
 
2047
    else:
 
2048
        # Get 'ascii' when setlocale has not been called or LANG=C or unset.
 
2049
        if user_encoding == 'ascii':
 
2050
            if sys.platform == 'darwin':
 
2051
                # OSX is special-cased in Python to have a UTF-8 filesystem
 
2052
                # encoding and previously had LANG set here if not present.
 
2053
                user_encoding = 'utf-8'
 
2054
            # GZ 2011-12-19: Maybe UTF-8 should be the default in this case
 
2055
            #                for some other posix platforms as well.
 
2056
 
 
2057
    _cached_user_encoding = user_encoding
1959
2058
    return user_encoding
1960
2059
 
1961
2060
 
 
2061
def get_diff_header_encoding():
 
2062
    return get_terminal_encoding()
 
2063
 
 
2064
 
1962
2065
def get_host_name():
1963
2066
    """Return the current unicode host name.
1964
2067
 
1966
2069
    behaves inconsistently on different platforms.
1967
2070
    """
1968
2071
    if sys.platform == "win32":
1969
 
        import win32utils
1970
2072
        return win32utils.get_host_name()
1971
2073
    else:
1972
2074
        import socket
1979
2081
# data at once.
1980
2082
MAX_SOCKET_CHUNK = 64 * 1024
1981
2083
 
 
2084
_end_of_stream_errors = [errno.ECONNRESET, errno.EPIPE, errno.EINVAL]
 
2085
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
 
2086
    _eno = getattr(errno, _eno, None)
 
2087
    if _eno is not None:
 
2088
        _end_of_stream_errors.append(_eno)
 
2089
del _eno
 
2090
 
 
2091
 
1982
2092
def read_bytes_from_socket(sock, report_activity=None,
1983
2093
        max_read_size=MAX_SOCKET_CHUNK):
1984
2094
    """Read up to max_read_size of bytes from sock and notify of progress.
1987
2097
    empty string rather than raise an error), and repeats the recv if
1988
2098
    interrupted by a signal.
1989
2099
    """
1990
 
    while 1:
 
2100
    while True:
1991
2101
        try:
1992
2102
            bytes = sock.recv(max_read_size)
1993
 
        except socket.error, e:
 
2103
        except socket.error as e:
1994
2104
            eno = e.args[0]
1995
 
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
 
2105
            if eno in _end_of_stream_errors:
1996
2106
                # The connection was closed by the other side.  Callers expect
1997
2107
                # an empty string to signal end-of-stream.
1998
2108
                return ""
2027
2137
 
2028
2138
def send_all(sock, bytes, report_activity=None):
2029
2139
    """Send all bytes on a socket.
2030
 
 
 
2140
 
2031
2141
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2032
2142
    some platforms, and catches EINTR which may be thrown if the send is
2033
2143
    interrupted by a signal.
2034
2144
 
2035
2145
    This is preferred to socket.sendall(), because it avoids portability bugs
2036
2146
    and provides activity reporting.
2037
 
 
 
2147
 
2038
2148
    :param report_activity: Call this as bytes are read, see
2039
2149
        Transport._report_activity
2040
2150
    """
2043
2153
    while sent_total < byte_count:
2044
2154
        try:
2045
2155
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2046
 
        except socket.error, e:
 
2156
        except (socket.error, IOError) as e:
 
2157
            if e.args[0] in _end_of_stream_errors:
 
2158
                raise errors.ConnectionReset(
 
2159
                    "Error trying to write to socket", e)
2047
2160
            if e.args[0] != errno.EINTR:
2048
2161
                raise
2049
2162
        else:
 
2163
            if sent == 0:
 
2164
                raise errors.ConnectionReset('Sending to %s returned 0 bytes'
 
2165
                                             % (sock,))
2050
2166
            sent_total += sent
2051
 
            report_activity(sent, 'write')
 
2167
            if report_activity is not None:
 
2168
                report_activity(sent, 'write')
 
2169
 
 
2170
 
 
2171
def connect_socket(address):
 
2172
    # Slight variation of the socket.create_connection() function (provided by
 
2173
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
 
2174
    # provide it for previous python versions. Also, we don't use the timeout
 
2175
    # parameter (provided by the python implementation) so we don't implement
 
2176
    # it either).
 
2177
    err = socket.error('getaddrinfo returns an empty list')
 
2178
    host, port = address
 
2179
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
 
2180
        af, socktype, proto, canonname, sa = res
 
2181
        sock = None
 
2182
        try:
 
2183
            sock = socket.socket(af, socktype, proto)
 
2184
            sock.connect(sa)
 
2185
            return sock
 
2186
 
 
2187
        except socket.error as err:
 
2188
            # 'err' is now the most recent error
 
2189
            if sock is not None:
 
2190
                sock.close()
 
2191
    raise err
2052
2192
 
2053
2193
 
2054
2194
def dereference_path(path):
2073
2213
def resource_string(package, resource_name):
2074
2214
    """Load a resource from a package and return it as a string.
2075
2215
 
2076
 
    Note: Only packages that start with bzrlib are currently supported.
 
2216
    Note: Only packages that start with breezy are currently supported.
2077
2217
 
2078
2218
    This is designed to be a lightweight implementation of resource
2079
2219
    loading in a way which is API compatible with the same API from
2082
2222
    If and when pkg_resources becomes a standard library, this routine
2083
2223
    can delegate to it.
2084
2224
    """
2085
 
    # Check package name is within bzrlib
2086
 
    if package == "bzrlib":
 
2225
    # Check package name is within breezy
 
2226
    if package == "breezy":
2087
2227
        resource_relpath = resource_name
2088
 
    elif package.startswith("bzrlib."):
2089
 
        package = package[len("bzrlib."):].replace('.', os.sep)
 
2228
    elif package.startswith("breezy."):
 
2229
        package = package[len("breezy."):].replace('.', os.sep)
2090
2230
        resource_relpath = pathjoin(package, resource_name)
2091
2231
    else:
2092
 
        raise errors.BzrError('resource package %s not in bzrlib' % package)
 
2232
        raise errors.BzrError('resource package %s not in breezy' % package)
2093
2233
 
2094
2234
    # Map the resource to a file and read its contents
2095
 
    base = dirname(bzrlib.__file__)
 
2235
    base = dirname(breezy.__file__)
2096
2236
    if getattr(sys, 'frozen', None):    # bzr.exe
2097
2237
        base = abspath(pathjoin(base, '..', '..'))
2098
 
    filename = pathjoin(base, resource_relpath)
2099
 
    return open(filename, 'rU').read()
2100
 
 
 
2238
    f = file(pathjoin(base, resource_relpath), "rU")
 
2239
    try:
 
2240
        return f.read()
 
2241
    finally:
 
2242
        f.close()
2101
2243
 
2102
2244
def file_kind_from_stat_mode_thunk(mode):
2103
2245
    global file_kind_from_stat_mode
2104
2246
    if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
2105
2247
        try:
2106
 
            from bzrlib._readdir_pyx import UTF8DirReader
 
2248
            from ._readdir_pyx import UTF8DirReader
2107
2249
            file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2108
 
        except ImportError, e:
 
2250
        except ImportError as e:
2109
2251
            # This is one time where we won't warn that an extension failed to
2110
2252
            # load. The extension is never available on Windows anyway.
2111
 
            from bzrlib._readdir_py import (
 
2253
            from ._readdir_py import (
2112
2254
                _kind_from_mode as file_kind_from_stat_mode
2113
2255
                )
2114
2256
    return file_kind_from_stat_mode(mode)
2115
2257
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2116
2258
 
2117
 
 
2118
 
def file_kind(f, _lstat=os.lstat):
 
2259
def file_stat(f, _lstat=os.lstat):
2119
2260
    try:
2120
 
        return file_kind_from_stat_mode(_lstat(f).st_mode)
2121
 
    except OSError, e:
 
2261
        # XXX cache?
 
2262
        return _lstat(f)
 
2263
    except OSError as e:
2122
2264
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2123
2265
            raise errors.NoSuchFile(f)
2124
2266
        raise
2125
2267
 
 
2268
def file_kind(f, _lstat=os.lstat):
 
2269
    stat_value = file_stat(f, _lstat)
 
2270
    return file_kind_from_stat_mode(stat_value.st_mode)
2126
2271
 
2127
2272
def until_no_eintr(f, *a, **kw):
2128
2273
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2129
 
    
 
2274
 
2130
2275
    WARNING: you must be certain that it is safe to retry the call repeatedly
2131
2276
    if EINTR does occur.  This is typically only true for low-level operations
2132
2277
    like os.read.  If in any doubt, don't use this.
2134
2279
    Keep in mind that this is not a complete solution to EINTR.  There is
2135
2280
    probably code in the Python standard library and other dependencies that
2136
2281
    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
 
2282
    that signal).  So this function can reduce the impact for IO that breezy
2138
2283
    directly controls, but it is not a complete solution.
2139
2284
    """
2140
2285
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
2141
2286
    while True:
2142
2287
        try:
2143
2288
            return f(*a, **kw)
2144
 
        except (IOError, OSError), e:
 
2289
        except (IOError, OSError) as e:
2145
2290
            if e.errno == errno.EINTR:
2146
2291
                continue
2147
2292
            raise
2148
2293
 
2149
2294
 
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
2295
if sys.platform == "win32":
2174
 
    import msvcrt
2175
2296
    def getchar():
 
2297
        import msvcrt
2176
2298
        return msvcrt.getch()
2177
2299
else:
2178
 
    import tty
2179
 
    import termios
2180
2300
    def getchar():
 
2301
        import tty
 
2302
        import termios
2181
2303
        fd = sys.stdin.fileno()
2182
2304
        settings = termios.tcgetattr(fd)
2183
2305
        try:
2187
2309
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2188
2310
        return ch
2189
2311
 
2190
 
 
2191
 
if sys.platform == 'linux2':
 
2312
if sys.platform.startswith('linux'):
2192
2313
    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
 
2314
        try:
 
2315
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2316
        except (ValueError, OSError, AttributeError):
 
2317
            return None
2199
2318
elif sys.platform == 'darwin':
2200
2319
    def _local_concurrency():
2201
2320
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2202
2321
                                stdout=subprocess.PIPE).communicate()[0]
2203
 
elif sys.platform[0:7] == 'freebsd':
 
2322
elif "bsd" in sys.platform:
2204
2323
    def _local_concurrency():
2205
2324
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2206
2325
                                stdout=subprocess.PIPE).communicate()[0]
2231
2350
    if _cached_local_concurrency is not None and use_cache:
2232
2351
        return _cached_local_concurrency
2233
2352
 
2234
 
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
 
2353
    concurrency = os.environ.get('BRZ_CONCURRENCY', None)
2235
2354
    if concurrency is None:
2236
2355
        try:
2237
 
            concurrency = _local_concurrency()
2238
 
        except (OSError, IOError):
2239
 
            pass
 
2356
            import multiprocessing
 
2357
            concurrency = multiprocessing.cpu_count()
 
2358
        except (ImportError, NotImplementedError):
 
2359
            # multiprocessing is only available on Python >= 2.6
 
2360
            # and multiprocessing.cpu_count() isn't implemented on all
 
2361
            # platforms
 
2362
            try:
 
2363
                concurrency = _local_concurrency()
 
2364
            except (OSError, IOError):
 
2365
                pass
2240
2366
    try:
2241
2367
        concurrency = int(concurrency)
2242
2368
    except (TypeError, ValueError):
2254
2380
        self.encode = encode
2255
2381
 
2256
2382
    def write(self, object):
2257
 
        if type(object) is str:
 
2383
        if isinstance(object, str):
2258
2384
            self.stream.write(object)
2259
2385
        else:
2260
2386
            data, _ = self.encode(object, self.errors)
2263
2389
if sys.platform == 'win32':
2264
2390
    def open_file(filename, mode='r', bufsize=-1):
2265
2391
        """This function is used to override the ``open`` builtin.
2266
 
        
 
2392
 
2267
2393
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2268
2394
        child processes.  Deleting or renaming a closed file opened with this
2269
2395
        function is not blocking child processes.
2302
2428
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2303
2429
else:
2304
2430
    open_file = open
 
2431
 
 
2432
 
 
2433
def available_backup_name(base, exists):
 
2434
    """Find a non-existing backup file name.
 
2435
 
 
2436
    This will *not* create anything, this only return a 'free' entry.  This
 
2437
    should be used for checking names in a directory below a locked
 
2438
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
 
2439
    Leap) and generally discouraged.
 
2440
 
 
2441
    :param base: The base name.
 
2442
 
 
2443
    :param exists: A callable returning True if the path parameter exists.
 
2444
    """
 
2445
    counter = 1
 
2446
    name = "%s.~%d~" % (base, counter)
 
2447
    while exists(name):
 
2448
        counter += 1
 
2449
        name = "%s.~%d~" % (base, counter)
 
2450
    return name
 
2451
 
 
2452
 
 
2453
def set_fd_cloexec(fd):
 
2454
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
 
2455
    support for this is not available.
 
2456
    """
 
2457
    try:
 
2458
        import fcntl
 
2459
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
 
2460
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
 
2461
    except (ImportError, AttributeError):
 
2462
        # Either the fcntl module or specific constants are not present
 
2463
        pass
 
2464
 
 
2465
 
 
2466
def find_executable_on_path(name):
 
2467
    """Finds an executable on the PATH.
 
2468
    
 
2469
    On Windows, this will try to append each extension in the PATHEXT
 
2470
    environment variable to the name, if it cannot be found with the name
 
2471
    as given.
 
2472
    
 
2473
    :param name: The base name of the executable.
 
2474
    :return: The path to the executable found or None.
 
2475
    """
 
2476
    if sys.platform == 'win32':
 
2477
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
 
2478
        exts = [ext.lower() for ext in exts]
 
2479
        base, ext = os.path.splitext(name)
 
2480
        if ext != '':
 
2481
            if ext.lower() not in exts:
 
2482
                return None
 
2483
            name = base
 
2484
            exts = [ext]
 
2485
    else:
 
2486
        exts = ['']
 
2487
    path = os.environ.get('PATH')
 
2488
    if path is not None:
 
2489
        path = path.split(os.pathsep)
 
2490
        for ext in exts:
 
2491
            for d in path:
 
2492
                f = os.path.join(d, name) + ext
 
2493
                if os.access(f, os.X_OK):
 
2494
                    return f
 
2495
    if sys.platform == 'win32':
 
2496
        app_path = win32utils.get_app_path(name)
 
2497
        if app_path != name:
 
2498
            return app_path
 
2499
    return None
 
2500
 
 
2501
 
 
2502
def _posix_is_local_pid_dead(pid):
 
2503
    """True if pid doesn't correspond to live process on this machine"""
 
2504
    try:
 
2505
        # Special meaning of unix kill: just check if it's there.
 
2506
        os.kill(pid, 0)
 
2507
    except OSError as e:
 
2508
        if e.errno == errno.ESRCH:
 
2509
            # On this machine, and really not found: as sure as we can be
 
2510
            # that it's dead.
 
2511
            return True
 
2512
        elif e.errno == errno.EPERM:
 
2513
            # exists, though not ours
 
2514
            return False
 
2515
        else:
 
2516
            mutter("os.kill(%d, 0) failed: %s" % (pid, e))
 
2517
            # Don't really know.
 
2518
            return False
 
2519
    else:
 
2520
        # Exists and our process: not dead.
 
2521
        return False
 
2522
 
 
2523
if sys.platform == "win32":
 
2524
    is_local_pid_dead = win32utils.is_local_pid_dead
 
2525
else:
 
2526
    is_local_pid_dead = _posix_is_local_pid_dead
 
2527
 
 
2528
_maybe_ignored = ['EAGAIN', 'EINTR', 'ENOTSUP', 'EOPNOTSUPP', 'EACCES']
 
2529
_fdatasync_ignored = [getattr(errno, name) for name in _maybe_ignored
 
2530
                      if getattr(errno, name, None) is not None]
 
2531
 
 
2532
 
 
2533
def fdatasync(fileno):
 
2534
    """Flush file contents to disk if possible.
 
2535
    
 
2536
    :param fileno: Integer OS file handle.
 
2537
    :raises TransportNotPossible: If flushing to disk is not possible.
 
2538
    """
 
2539
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
 
2540
    if fn is not None:
 
2541
        try:
 
2542
            fn(fileno)
 
2543
        except IOError as e:
 
2544
            # See bug #1075108, on some platforms fdatasync exists, but can
 
2545
            # raise ENOTSUP. However, we are calling fdatasync to be helpful
 
2546
            # and reduce the chance of corruption-on-powerloss situations. It
 
2547
            # is not a mandatory call, so it is ok to suppress failures.
 
2548
            trace.mutter("ignoring error calling fdatasync: %s" % (e,))
 
2549
            if getattr(e, 'errno', None) not in _fdatasync_ignored:
 
2550
                raise
 
2551
 
 
2552
 
 
2553
def ensure_empty_directory_exists(path, exception_class):
 
2554
    """Make sure a local directory exists and is empty.
 
2555
    
 
2556
    If it does not exist, it is created.  If it exists and is not empty, an
 
2557
    instance of exception_class is raised.
 
2558
    """
 
2559
    try:
 
2560
        os.mkdir(path)
 
2561
    except OSError as e:
 
2562
        if e.errno != errno.EEXIST:
 
2563
            raise
 
2564
        if os.listdir(path) != []:
 
2565
            raise exception_class(path)
 
2566
 
 
2567
 
 
2568
def is_environment_error(evalue):
 
2569
    """True if exception instance is due to a process environment issue
 
2570
 
 
2571
    This includes OSError and IOError, but also other errors that come from
 
2572
    the operating system or core libraries but are not subclasses of those.
 
2573
    """
 
2574
    if isinstance(evalue, (EnvironmentError, select.error)):
 
2575
        return True
 
2576
    if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
 
2577
        return True
 
2578
    return False