/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-11-16 18:33:33 UTC
  • mfrom: (2138.1.1 robuster.external.diff)
  • Revision ID: pqm@pqm.ubuntu.com-20061116183333-5f56523d7b44e564
(Dmitry Vasiliev) Robuster external diff output handling.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/trace.py
1
 
# Copyright (C) 2005, Canonical Ltd
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
2
16
 
3
17
"""Messages and logging for bazaar-ng.
4
18
 
27
41
 
28
42
Exceptions are reported in a brief form to stderr so as not to look scary.
29
43
BzrErrors are required to be able to format themselves into a properly
30
 
explanatory message.  This is not true for builtin excexceptions such as
 
44
explanatory message.  This is not true for builtin exceptions such as
31
45
KeyError, which typically just str to "0".  They're printed in a different
32
46
form.
33
47
"""
34
48
 
35
 
# TODO: in debug mode, stderr should get full tracebacks and also
36
 
# debug messages.  (Is this really needed?)
37
 
 
38
49
# FIXME: Unfortunately it turns out that python's logging module
39
50
# is quite expensive, even when the message is not printed by any handlers.
40
51
# We should perhaps change back to just simply doing it here.
41
52
 
42
 
 
 
53
import os
 
54
import re
43
55
import sys
44
 
import os
 
56
 
 
57
from bzrlib.lazy_import import lazy_import
 
58
lazy_import(globals(), """
 
59
import errno
45
60
import logging
 
61
from cStringIO import StringIO
 
62
""")
46
63
 
47
64
import bzrlib
48
 
from bzrlib.errors import BzrError, BzrNewError
 
65
from bzrlib.symbol_versioning import (deprecated_function,
 
66
        zero_nine,
 
67
        )
49
68
 
 
69
lazy_import(globals(), """
 
70
from bzrlib import debug
 
71
""")
50
72
 
51
73
_file_handler = None
52
74
_stderr_handler = None
53
75
_stderr_quiet = False
54
76
_trace_file = None
 
77
_trace_depth = 0
55
78
_bzr_log_file = None
56
 
 
57
 
 
58
 
class QuietFormatter(logging.Formatter):
59
 
    """Formatter that supresses the details of errors.
60
 
 
61
 
    This is used by default on stderr so as not to scare the user.
62
 
    """
63
 
    # At first I tried overriding formatException to suppress the
64
 
    # exception details, but that has global effect: no loggers
65
 
    # can get the exception details is we suppress them here.
66
 
 
67
 
    def format(self, record):
68
 
        if record.levelno >= logging.WARNING:
69
 
            s = 'bzr: ' + record.levelname + ': '
70
 
        else:
71
 
            s = ''
72
 
        s += record.getMessage()
73
 
        if record.exc_info:
74
 
            s += '\n' + format_exception_short(record.exc_info)
75
 
        return s
76
 
        
 
79
_use_apport = True
 
80
 
 
81
 
77
82
# configure convenient aliases for output routines
78
83
 
79
84
_bzr_logger = logging.getLogger('bzr')
80
85
 
81
86
def note(*args, **kwargs):
 
87
    # FIXME note always emits utf-8, regardless of the terminal encoding
82
88
    import bzrlib.ui
83
89
    bzrlib.ui.ui_factory.clear_term()
84
90
    _bzr_logger.info(*args, **kwargs)
96
102
def mutter(fmt, *args):
97
103
    if _trace_file is None:
98
104
        return
99
 
    if hasattr(_trace_file, 'closed') and _trace_file.closed:
 
105
    if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
100
106
        return
 
107
 
 
108
    if isinstance(fmt, unicode):
 
109
        fmt = fmt.encode('utf8')
 
110
 
101
111
    if len(args) > 0:
102
 
        out = fmt % args
 
112
        # It seems that if we do ascii % (unicode, ascii) we can
 
113
        # get a unicode cannot encode ascii error, so make sure that "fmt"
 
114
        # is a unicode string
 
115
        real_args = []
 
116
        for arg in args:
 
117
            if isinstance(arg, unicode):
 
118
                arg = arg.encode('utf8')
 
119
            real_args.append(arg)
 
120
        out = fmt % tuple(real_args)
103
121
    else:
104
122
        out = fmt
105
123
    out += '\n'
106
124
    _trace_file.write(out)
107
 
debug = mutter
 
125
    # TODO: jam 20051227 Consider flushing the trace file to help debugging
 
126
    #_trace_file.flush()
108
127
 
109
128
 
110
129
def _rollover_trace_maybe(trace_fname):
125
144
    # information if something goes wrong.  In a future version this
126
145
    # file will be removed on successful completion.
127
146
    global _file_handler, _bzr_log_file
128
 
    import stat, codecs
 
147
    import codecs
129
148
 
130
149
    trace_fname = os.path.join(os.path.expanduser(tracefilename))
131
150
    _rollover_trace_maybe(trace_fname)
132
151
    try:
133
152
        LINE_BUFFERED = 1
134
 
        tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
 
153
        #tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
 
154
        tf = open(trace_fname, 'at', LINE_BUFFERED)
135
155
        _bzr_log_file = tf
136
156
        if tf.tell() == 0:
137
157
            tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
147
167
        warning("failed to open trace file: %s" % (e))
148
168
 
149
169
 
150
 
def log_startup(argv):
151
 
    debug('\n\nbzr %s invoked on python %s (%s)',
152
 
          bzrlib.__version__,
153
 
          '.'.join(map(str, sys.version_info)),
154
 
          sys.platform)
155
 
    debug('  arguments: %r', argv)
156
 
    debug('  working dir: %r', os.getcwdu())
157
 
 
158
 
 
 
170
@deprecated_function(zero_nine)
159
171
def log_exception(msg=None):
160
172
    """Log the last exception to stderr and the trace file.
161
173
 
164
176
    """
165
177
    if msg:
166
178
        error(msg)
167
 
    else:
168
 
        exc_str = format_exception_short(sys.exc_info())
169
 
        error(exc_str)
170
179
    log_exception_quietly()
171
180
 
172
181
 
178
187
    errors loading plugins.
179
188
    """
180
189
    import traceback
181
 
    debug(traceback.format_exc())
 
190
    mutter(traceback.format_exc())
182
191
 
183
192
 
184
193
def enable_default_logging():
186
195
    # FIXME: if this is run twice, things get confused
187
196
    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
188
197
    _stderr_handler = logging.StreamHandler()
189
 
    _stderr_handler.setFormatter(QuietFormatter())
190
198
    logging.getLogger('').addHandler(_stderr_handler)
191
199
    _stderr_handler.setLevel(logging.INFO)
192
200
    if not _file_handler:
194
202
    _trace_file = _bzr_log_file
195
203
    if _file_handler:
196
204
        _file_handler.setLevel(logging.DEBUG)
197
 
    _bzr_logger.setLevel(logging.DEBUG) 
198
 
 
 
205
    _bzr_logger.setLevel(logging.DEBUG)
199
206
 
200
207
 
201
208
def be_quiet(quiet=True):
231
238
    """Redirect logging to a temporary file for a test
232
239
    
233
240
    returns an opaque reference that should be passed to disable_test_log
234
 
    after the test complete.
 
241
    after the test completes.
235
242
    """
236
243
    disable_default_logging()
237
244
    global _trace_file
 
245
    global _trace_depth
238
246
    hdlr = logging.StreamHandler(to_file)
239
247
    hdlr.setLevel(logging.DEBUG)
240
248
    hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
241
249
    _bzr_logger.addHandler(hdlr)
242
250
    _bzr_logger.setLevel(logging.DEBUG)
243
 
    result = hdlr, _trace_file
 
251
    result = hdlr, _trace_file, _trace_depth
244
252
    _trace_file = to_file
 
253
    _trace_depth += 1
245
254
    return result
246
255
 
247
256
 
248
 
def disable_test_log((test_log_hdlr, old_trace_file)):
 
257
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
249
258
    _bzr_logger.removeHandler(test_log_hdlr)
250
259
    test_log_hdlr.close()
 
260
    global _trace_file
 
261
    global _trace_depth
251
262
    _trace_file = old_trace_file
252
 
    enable_default_logging()
253
 
 
254
 
 
255
 
def format_exception_short(exc_info):
256
 
    """Make a short string form of an exception.
257
 
 
258
 
    This is used for display to stderr.  It specially handles exception
259
 
    classes without useful string methods.
260
 
 
261
 
    The result has no trailing newline.
262
 
 
263
 
    exc_info - typically an exception from sys.exc_info()
 
263
    _trace_depth = old_trace_depth
 
264
    if not _trace_depth:
 
265
        enable_default_logging()
 
266
 
 
267
 
 
268
def report_exception(exc_info, err_file):
 
269
    exc_type, exc_object, exc_tb = exc_info
 
270
    # Log the full traceback to ~/.bzr.log
 
271
    log_exception_quietly()
 
272
    if (isinstance(exc_object, IOError)
 
273
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
 
274
        print >>err_file, "bzr: broken pipe"
 
275
    elif isinstance(exc_object, KeyboardInterrupt):
 
276
        print >>err_file, "bzr: interrupted"
 
277
    elif not getattr(exc_object, 'internal_error', True):
 
278
        report_user_error(exc_info, err_file)
 
279
    elif isinstance(exc_object, (OSError, IOError)):
 
280
        # Might be nice to catch all of these and show them as something more
 
281
        # specific, but there are too many cases at the moment.
 
282
        report_user_error(exc_info, err_file)
 
283
    else:
 
284
        return report_bug(exc_info, err_file)
 
285
 
 
286
 
 
287
# TODO: Should these be specially encoding the output?
 
288
def report_user_error(exc_info, err_file):
 
289
    """Report to err_file an error that's not an internal error.
 
290
 
 
291
    These don't get a traceback unless -Derror was given.
264
292
    """
265
 
    exc_type, exc_object, exc_tb = exc_info
266
 
    try:
267
 
        if exc_type is None:
268
 
            return '(no exception)'
269
 
        if isinstance(exc_object, (BzrError, BzrNewError)):
270
 
            return str(exc_object)
271
 
        else:
272
 
            import traceback
273
 
            tb = traceback.extract_tb(exc_tb)
274
 
            msg = '%s: %s' % (exc_type, exc_object)
275
 
            if msg[-1] == '\n':
276
 
                msg = msg[:-1]
277
 
            if tb:
278
 
                msg += '\n  at %s line %d\n  in %s' % (tb[-1][:3])
279
 
            return msg
280
 
    except Exception, formatting_exc:
281
 
        # XXX: is this really better than just letting it run up?
282
 
        return '(error formatting exception of type %s: %s)' \
283
 
                % (exc_type, formatting_exc)
 
293
    if 'error' in debug.debug_flags:
 
294
        report_bug(exc_info, err_file)
 
295
        return
 
296
    print >>err_file, "bzr: ERROR:", str(exc_info[1])
 
297
 
 
298
 
 
299
def report_bug(exc_info, err_file):
 
300
    """Report an exception that probably indicates a bug in bzr"""
 
301
    # local import because its only needed here, and this is not a loop.
 
302
    import tempfile
 
303
    # local import because the other functions do it too.
 
304
    import traceback
 
305
    # local import due to circular dependency
 
306
    import bzrlib.plugin
 
307
    global _use_apport
 
308
    try:
 
309
        # detect apport presence.
 
310
        import apport_utils
 
311
        import problem_report
 
312
    except ImportError:
 
313
        # not present, dont use it.
 
314
        _use_apport = False
 
315
    if not _use_apport:
 
316
        # policy disabled, or not present, use the old ui.
 
317
        return _old_report_bug(exc_info, err_file)
 
318
 
 
319
    exc_type, exc_object, exc_tb = exc_info
 
320
    err_file.write(
 
321
        "bzr: ERROR: %s.%s: %s\n" % (
 
322
        exc_type.__module__, exc_type.__name__, exc_object)
 
323
        )
 
324
    report = problem_report.ProblemReport()
 
325
    report_file, report_filename = tempfile.mkstemp(
 
326
        suffix='.txt', prefix='bzr-crash-', dir='/tmp')
 
327
    python_report_file = os.fdopen(report_file, 'w')
 
328
    try:
 
329
        report['CommandLine'] = ' '.join(sys.argv)
 
330
        # assume we are packaged as bzr.
 
331
        apport_utils.report_add_package_info(report, 'bzr')
 
332
        report['BzrPlugins'] = ' '.join(bzrlib.plugin.all_plugins())
 
333
        tb_file = StringIO()
 
334
        traceback.print_exception(exc_type, exc_object, exc_tb, file=tb_file)
 
335
        report['Traceback'] = tb_file.getvalue()
 
336
        apport_utils.report_add_os_info(report)
 
337
        report.write(python_report_file)
 
338
        # give the user a pretty output.
 
339
 
 
340
        err_file.write(
 
341
            'This is an unexpected error within bzr and we would appreciate a bug report.\n'
 
342
            '\n'
 
343
            'bzr has written a crash report file that will assist our debugging of this\n'
 
344
            'in the file %s\n'
 
345
            '\n'
 
346
            'This is a plain text file, whose contents you can check if you have privacy\n'
 
347
            'concerns. We gather the package data about bzr, your command line, plugins\n'
 
348
            'And the backtrace from within bzr. If you had a password in the URL you\n'
 
349
            'provided to bzr, you should edit that file to remove the password.\n'
 
350
            '\n'
 
351
            '** To file a bug for this please visit our bugtracker at the URL \n'
 
352
            '"https://launchpad.net/products/bzr/+filebug" and report a bug describing\n'
 
353
            'what you were attempting and attach the bzr-crash file mentioned above.\n'
 
354
            'Alternatively you can email bazaar-ng@lists.canonical.com with the same\n'
 
355
            'description and attach the bzr-crash file to the email.\n' %
 
356
                report_filename
 
357
            )
 
358
    finally:
 
359
        python_report_file.close()
 
360
    return report, report_filename
 
361
 
 
362
def _old_report_bug(exc_info, err_file):
 
363
    """Write a synopsis of an exception that is probably a bug to err_file."""
 
364
    import traceback
 
365
    exc_type, exc_object, exc_tb = exc_info
 
366
    print >>err_file, "bzr: ERROR: %s.%s: %s" % (
 
367
        exc_type.__module__, exc_type.__name__, exc_object)
 
368
    print >>err_file
 
369
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
 
370
    print >>err_file
 
371
    print >>err_file, 'bzr %s on python %s (%s)' % \
 
372
                       (bzrlib.__version__,
 
373
                        '.'.join(map(str, sys.version_info)),
 
374
                        sys.platform)
 
375
    print >>err_file, 'arguments: %r' % sys.argv
 
376
    print >>err_file
 
377
    print >>err_file, "** please send this report to bazaar-ng@lists.ubuntu.com"