1
# Copyright (C) 2005, 2006 Canonical Ltd
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.
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.
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
17
"""Messages and logging for bazaar-ng.
19
Messages are supplied by callers as a string-formatting template, plus values
20
to be inserted into it. The actual %-formatting is deferred to the log
21
library so that it doesn't need to be done for messages that won't be emitted.
23
Messages are classified by severity levels: critical, error, warning, info,
26
They can be sent to two places: to stderr, and to ~/.bzr.log. For purposes
27
such as running the test suite, they can also be redirected away from both of
28
those two places to another location.
30
~/.bzr.log gets all messages, and full tracebacks for uncaught exceptions.
31
This trace file is always in UTF-8, regardless of the user's default encoding,
32
so that we can always rely on writing any message.
34
Output to stderr depends on the mode chosen by the user. By default, messages
35
of info and above are sent out, which results in progress messages such as the
36
list of files processed by add and commit. In quiet mode, only warnings and
37
above are shown. In debug mode, stderr gets debug messages too.
39
Errors that terminate an operation are generally passed back as exceptions;
40
others may be just emitted as messages.
42
Exceptions are reported in a brief form to stderr so as not to look scary.
43
BzrErrors are required to be able to format themselves into a properly
44
explanatory message. This is not true for builtin exceptions such as
45
KeyError, which typically just str to "0". They're printed in a different
49
# FIXME: Unfortunately it turns out that python's logging module
50
# is quite expensive, even when the message is not printed by any handlers.
51
# We should perhaps change back to just simply doing it here.
57
from bzrlib.lazy_import import lazy_import
58
lazy_import(globals(), """
61
from cStringIO import StringIO
65
from bzrlib.symbol_versioning import (deprecated_function,
69
lazy_import(globals(), """
70
from bzrlib import debug
74
_stderr_handler = None
82
# configure convenient aliases for output routines
84
_bzr_logger = logging.getLogger('bzr')
86
def note(*args, **kwargs):
87
# FIXME note always emits utf-8, regardless of the terminal encoding
89
bzrlib.ui.ui_factory.clear_term()
90
_bzr_logger.info(*args, **kwargs)
92
def warning(*args, **kwargs):
94
bzrlib.ui.ui_factory.clear_term()
95
_bzr_logger.warning(*args, **kwargs)
98
log_error = _bzr_logger.error
99
error = _bzr_logger.error
102
def mutter(fmt, *args):
103
if _trace_file is None:
105
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
108
if isinstance(fmt, unicode):
109
fmt = fmt.encode('utf8')
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
117
if isinstance(arg, unicode):
118
arg = arg.encode('utf8')
119
real_args.append(arg)
120
out = fmt % tuple(real_args)
124
_trace_file.write(out)
125
# TODO: jam 20051227 Consider flushing the trace file to help debugging
129
def _rollover_trace_maybe(trace_fname):
132
size = os.stat(trace_fname)[stat.ST_SIZE]
135
old_fname = trace_fname + '.old'
136
from osutils import rename
137
rename(trace_fname, old_fname)
142
def open_tracefile(tracefilename='~/.bzr.log'):
143
# Messages are always written to here, so that we have some
144
# information if something goes wrong. In a future version this
145
# file will be removed on successful completion.
146
global _file_handler, _bzr_log_file
149
trace_fname = os.path.join(os.path.expanduser(tracefilename))
150
_rollover_trace_maybe(trace_fname)
153
#tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
154
tf = open(trace_fname, 'at', LINE_BUFFERED)
157
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
158
tf.write("you can delete or truncate this file, or include sections in\n")
159
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
160
_file_handler = logging.StreamHandler(tf)
161
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
162
datefmt = r'%a %H:%M:%S'
163
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
164
_file_handler.setLevel(logging.DEBUG)
165
logging.getLogger('').addHandler(_file_handler)
167
warning("failed to open trace file: %s" % (e))
170
@deprecated_function(zero_nine)
171
def log_exception(msg=None):
172
"""Log the last exception to stderr and the trace file.
174
The exception string representation is used as the error
175
summary, unless msg is given.
179
log_exception_quietly()
182
def log_exception_quietly():
183
"""Log the last exception to the trace file only.
185
Used for exceptions that occur internally and that may be
186
interesting to developers but not to users. For example,
187
errors loading plugins.
190
mutter(traceback.format_exc())
193
def enable_default_logging():
194
"""Configure default logging to stderr and .bzr.log"""
195
# FIXME: if this is run twice, things get confused
196
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
197
_stderr_handler = logging.StreamHandler()
198
logging.getLogger('').addHandler(_stderr_handler)
199
_stderr_handler.setLevel(logging.INFO)
200
if not _file_handler:
202
_trace_file = _bzr_log_file
204
_file_handler.setLevel(logging.DEBUG)
205
_bzr_logger.setLevel(logging.DEBUG)
208
def be_quiet(quiet=True):
209
global _stderr_handler, _stderr_quiet
211
_stderr_quiet = quiet
213
_stderr_handler.setLevel(logging.WARNING)
215
_stderr_handler.setLevel(logging.INFO)
223
def disable_default_logging():
224
"""Turn off default log handlers.
226
This is intended to be used by the test framework, which doesn't
227
want leakage from the code-under-test into the main logs.
230
l = logging.getLogger('')
231
l.removeHandler(_stderr_handler)
233
l.removeHandler(_file_handler)
237
def enable_test_log(to_file):
238
"""Redirect logging to a temporary file for a test
240
returns an opaque reference that should be passed to disable_test_log
241
after the test completes.
243
disable_default_logging()
246
hdlr = logging.StreamHandler(to_file)
247
hdlr.setLevel(logging.DEBUG)
248
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
249
_bzr_logger.addHandler(hdlr)
250
_bzr_logger.setLevel(logging.DEBUG)
251
result = hdlr, _trace_file, _trace_depth
252
_trace_file = to_file
257
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
258
_bzr_logger.removeHandler(test_log_hdlr)
259
test_log_hdlr.close()
262
_trace_file = old_trace_file
263
_trace_depth = old_trace_depth
265
enable_default_logging()
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)
284
return report_bug(exc_info, err_file)
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.
291
These don't get a traceback unless -Derror was given.
293
if 'error' in debug.debug_flags:
294
report_bug(exc_info, err_file)
296
print >>err_file, "bzr: ERROR:", str(exc_info[1])
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.
303
# local import because the other functions do it too.
305
# local import due to circular dependency
309
# detect apport presence.
311
import problem_report
313
# not present, dont use it.
316
# policy disabled, or not present, use the old ui.
317
return _old_report_bug(exc_info, err_file)
319
exc_type, exc_object, exc_tb = exc_info
321
"bzr: ERROR: %s.%s: %s\n" % (
322
exc_type.__module__, exc_type.__name__, exc_object)
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')
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())
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.
341
'This is an unexpected error within bzr and we would appreciate a bug report.\n'
343
'bzr has written a crash report file that will assist our debugging of this\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'
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' %
359
python_report_file.close()
360
return report, report_filename
362
def _old_report_bug(exc_info, err_file):
363
"""Write a synopsis of an exception that is probably a bug to err_file."""
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)
369
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
371
print >>err_file, 'bzr %s on python %s (%s)' % \
373
'.'.join(map(str, sys.version_info)),
375
print >>err_file, 'arguments: %r' % sys.argv
377
print >>err_file, "** please send this report to bazaar-ng@lists.ubuntu.com"
added
removed
bzrlib/trace.py
