1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
1
# Copyright (C) 2005-2010 Canonical Ltd
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
13
13
# You should have received a copy of the GNU General Public License
14
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
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Messages and logging for bazaar-ng.
17
"""Messages and logging.
19
19
Messages are supplied by callers as a string-formatting template, plus values
20
20
to be inserted into it. The actual %-formatting is deferred to the log
34
34
Output to stderr depends on the mode chosen by the user. By default, messages
35
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.
36
list of files processed by add and commit. In debug mode, stderr gets debug messages too.
39
38
Errors that terminate an operation are generally passed back as exceptions;
40
39
others may be just emitted as messages.
123
127
_bzr_logger.warning(*args, **kwargs)
126
# configure convenient aliases for output routines
128
# TODO: deprecate them, have one name for each.
130
log_error = _bzr_logger.error
131
error = _bzr_logger.error
134
_last_mutter_flush_time = None
130
@deprecated_function(deprecated_in((2, 1, 0)))
131
def info(*args, **kwargs):
132
"""Deprecated: use trace.note instead."""
133
note(*args, **kwargs)
136
@deprecated_function(deprecated_in((2, 1, 0)))
137
def log_error(*args, **kwargs):
138
"""Deprecated: use bzrlib.trace.show_error instead"""
139
_bzr_logger.error(*args, **kwargs)
142
@deprecated_function(deprecated_in((2, 1, 0)))
143
def error(*args, **kwargs):
144
"""Deprecated: use bzrlib.trace.show_error instead"""
145
_bzr_logger.error(*args, **kwargs)
148
def show_error(*args, **kwargs):
149
"""Show an error message to the user.
151
Don't use this for exceptions, use report_exception instead.
153
_bzr_logger.error(*args, **kwargs)
136
156
def mutter(fmt, *args):
137
global _last_mutter_flush_time
138
157
if _trace_file is None:
159
# XXX: Don't check this every time; instead anyone who closes the file
160
# ought to deregister it. We can tolerate None.
140
161
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
159
180
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
160
181
out = timestamp + out + '\n'
161
182
_trace_file.write(out)
162
# We flush if we haven't flushed for a few seconds. We don't want to flush
163
# on every mutter, but when a command takes a while, it can be nice to see
164
# updates in the debug log.
165
if (_last_mutter_flush_time is None
166
or (now - _last_mutter_flush_time) > 2.0):
167
flush = getattr(_trace_file, 'flush', None)
168
if flush is not None:
170
_last_mutter_flush_time = now
183
# there's no explicit flushing; the file is typically line buffered.
173
186
def mutter_callsite(stacklevel, fmt, *args):
218
231
def _open_bzr_log():
219
"""Open the .bzr.log trace file.
232
"""Open the .bzr.log trace file.
221
234
If the log is more than a particular length, the old file is renamed to
222
235
.bzr.log.old and a new file is started. Otherwise, we append to the
225
238
This sets the global _bzr_log_filename.
227
240
global _bzr_log_filename
242
def _open_or_create_log_file(filename):
243
"""Open existing log file, or create with ownership and permissions
245
It inherits the ownership and permissions (masked by umask) from
246
the containing directory to cope better with being run under sudo
247
with $HOME still set to the user's homedir.
249
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
252
fd = os.open(filename, flags)
255
if e.errno != errno.ENOENT:
258
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
260
if e.errno != errno.EEXIST:
263
osutils.copy_ownership_from_path(filename)
265
return os.fdopen(fd, 'at', 0) # unbuffered
228
268
_bzr_log_filename = _get_bzr_log_filename()
229
269
_rollover_trace_maybe(_bzr_log_filename)
231
bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered
232
# bzr_log_file.tell() on windows always return 0 until some writing done
271
bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
233
272
bzr_log_file.write('\n')
234
273
if bzr_log_file.tell() <= 2:
235
274
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
236
275
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
237
276
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
238
278
return bzr_log_file
240
warning("failed to open trace file: %s" % (e))
280
except EnvironmentError, e:
281
# If we are failing to open the log, then most likely logging has not
282
# been set up yet. So we just write to stderr rather than using
283
# 'warning()'. If we using warning(), users get the unhelpful 'no
284
# handlers registered for "bzr"' when something goes wrong on the
285
# server. (bug #503886)
286
sys.stderr.write("failed to open trace file: %s\n" % (e,))
241
287
# TODO: What should happen if we fail to open the trace file? Maybe the
242
288
# objects should be pointed at /dev/null or the equivalent? Currently
243
289
# returns None which will cause failures later.
329
375
new_trace_file.flush()
332
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
333
def enable_test_log(to_file):
334
"""Redirect logging to a temporary file for a test
336
:returns: an opaque reference that should be passed to disable_test_log
337
after the test completes.
339
return push_log_file(to_file)
342
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
343
def disable_test_log(memento):
344
return pop_log_file(memento)
347
378
def log_exception_quietly():
348
379
"""Log the last exception to the trace file only.
350
Used for exceptions that occur internally and that may be
351
interesting to developers but not to users. For example,
381
Used for exceptions that occur internally and that may be
382
interesting to developers but not to users. For example,
352
383
errors loading plugins.
354
385
mutter(traceback.format_exc())
398
429
return _verbosity_level > 0
401
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
402
def disable_default_logging():
403
"""Turn off default log handlers.
405
Don't call this method, use _push_log_file and _pop_log_file instead.
410
432
def debug_memory(message='', short=True):
411
433
"""Write out a memory dump."""
412
434
if sys.platform == 'win32':
447
469
:return: The appropriate exit code for this error.
449
exc_type, exc_object, exc_tb = exc_info
450
471
# Log the full traceback to ~/.bzr.log
451
472
log_exception_quietly()
473
if 'error' in debug.debug_flags:
474
print_exception(exc_info, err_file)
475
return errors.EXIT_ERROR
476
exc_type, exc_object, exc_tb = exc_info
452
477
if (isinstance(exc_object, IOError)
453
478
and getattr(exc_object, 'errno', None) == errno.EPIPE):
454
479
err_file.write("bzr: broken pipe\n")
456
481
elif isinstance(exc_object, KeyboardInterrupt):
457
482
err_file.write("bzr: interrupted\n")
458
483
return errors.EXIT_ERROR
484
elif isinstance(exc_object, MemoryError):
485
err_file.write("bzr: out of memory\n")
486
return errors.EXIT_ERROR
459
487
elif isinstance(exc_object, ImportError) \
460
488
and str(exc_object).startswith("No module named "):
461
489
report_user_error(exc_info, err_file,
492
520
:param advice: Extra advice to the user to be printed following the
495
if 'error' in debug.debug_flags:
496
print_exception(exc_info, err_file)
498
523
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
500
525
err_file.write("%s\n" % (advice,))
503
528
def report_bug(exc_info, err_file):
504
529
"""Report an exception that probably indicates a bug in bzr"""
505
print_exception(exc_info, err_file)
507
err_file.write('bzr %s on python %s (%s)\n' % \
509
bzrlib._format_version_tuple(sys.version_info),
511
err_file.write('arguments: %r\n' % sys.argv)
513
'encoding: %r, fsenc: %r, lang: %r\n' % (
514
osutils.get_user_encoding(), sys.getfilesystemencoding(),
515
os.environ.get('LANG')))
516
err_file.write("plugins:\n")
517
for name, a_plugin in sorted(plugin.plugins().items()):
518
err_file.write(" %-20s %s [%s]\n" %
519
(name, a_plugin.path(), a_plugin.__version__))
522
*** Bazaar has encountered an internal error.
523
Please report a bug at https://bugs.launchpad.net/bzr/+filebug
524
including this traceback, and a description of what you
525
were doing when the error occurred.
530
from bzrlib.crash import report_bug
531
report_bug(exc_info, err_file)
534
def _flush_stdout_stderr():
535
# installed into an atexit hook by bzrlib.initialize()
541
if e.errno in [errno.EINVAL, errno.EPIPE]:
548
# run from atexit hook
added
removed
bzrlib/trace.py
