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.
109
113
def note(*args, **kwargs):
114
"""Output a note to the user.
116
Takes the same parameters as logging.info.
110
120
# FIXME note always emits utf-8, regardless of the terminal encoding
112
122
# FIXME: clearing the ui and then going through the abstract logging
123
133
_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
136
@deprecated_function(deprecated_in((2, 1, 0)))
137
def info(*args, **kwargs):
138
"""Deprecated: use trace.note instead."""
139
note(*args, **kwargs)
142
@deprecated_function(deprecated_in((2, 1, 0)))
143
def log_error(*args, **kwargs):
144
"""Deprecated: use bzrlib.trace.show_error instead"""
145
_bzr_logger.error(*args, **kwargs)
148
@deprecated_function(deprecated_in((2, 1, 0)))
149
def error(*args, **kwargs):
150
"""Deprecated: use bzrlib.trace.show_error instead"""
151
_bzr_logger.error(*args, **kwargs)
154
def show_error(*args, **kwargs):
155
"""Show an error message to the user.
157
Don't use this for exceptions, use report_exception instead.
159
_bzr_logger.error(*args, **kwargs)
136
162
def mutter(fmt, *args):
137
global _last_mutter_flush_time
138
163
if _trace_file is None:
165
# XXX: Don't check this every time; instead anyone who closes the file
166
# ought to deregister it. We can tolerate None.
140
167
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
159
186
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
160
187
out = timestamp + out + '\n'
161
188
_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
189
# there's no explicit flushing; the file is typically line buffered.
173
192
def mutter_callsite(stacklevel, fmt, *args):
218
237
def _open_bzr_log():
219
"""Open the .bzr.log trace file.
238
"""Open the .bzr.log trace file.
221
240
If the log is more than a particular length, the old file is renamed to
222
241
.bzr.log.old and a new file is started. Otherwise, we append to the
225
244
This sets the global _bzr_log_filename.
227
246
global _bzr_log_filename
248
def _open_or_create_log_file(filename):
249
"""Open existing log file, or create with ownership and permissions
251
It inherits the ownership and permissions (masked by umask) from
252
the containing directory to cope better with being run under sudo
253
with $HOME still set to the user's homedir.
255
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
258
fd = os.open(filename, flags)
261
if e.errno != errno.ENOENT:
264
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
266
if e.errno != errno.EEXIST:
269
osutils.copy_ownership_from_path(filename)
271
return os.fdopen(fd, 'at', 0) # unbuffered
228
274
_bzr_log_filename = _get_bzr_log_filename()
229
275
_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
277
bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
233
278
bzr_log_file.write('\n')
234
279
if bzr_log_file.tell() <= 2:
235
280
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
236
281
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
237
282
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
238
284
return bzr_log_file
240
warning("failed to open trace file: %s" % (e))
286
except EnvironmentError, e:
287
# If we are failing to open the log, then most likely logging has not
288
# been set up yet. So we just write to stderr rather than using
289
# 'warning()'. If we using warning(), users get the unhelpful 'no
290
# handlers registered for "bzr"' when something goes wrong on the
291
# server. (bug #503886)
292
sys.stderr.write("failed to open trace file: %s\n" % (e,))
241
293
# TODO: What should happen if we fail to open the trace file? Maybe the
242
294
# objects should be pointed at /dev/null or the equivalent? Currently
243
295
# returns None which will cause failures later.
329
381
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
384
def log_exception_quietly():
348
385
"""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,
387
Used for exceptions that occur internally and that may be
388
interesting to developers but not to users. For example,
352
389
errors loading plugins.
354
391
mutter(traceback.format_exc())
398
435
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
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
412
438
def debug_memory(message='', short=True):
413
439
"""Write out a memory dump."""
440
if sys.platform == 'win32':
441
from bzrlib import win32utils
442
win32utils.debug_memory_win32api(message=message, short=short)
444
_debug_memory_proc(message=message, short=short)
447
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
449
def _debug_memory_proc(message='', short=True):
415
451
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
439
475
:return: The appropriate exit code for this error.
441
exc_type, exc_object, exc_tb = exc_info
442
477
# Log the full traceback to ~/.bzr.log
443
478
log_exception_quietly()
479
if 'error' in debug.debug_flags:
480
print_exception(exc_info, err_file)
481
return errors.EXIT_ERROR
482
exc_type, exc_object, exc_tb = exc_info
444
483
if (isinstance(exc_object, IOError)
445
484
and getattr(exc_object, 'errno', None) == errno.EPIPE):
446
485
err_file.write("bzr: broken pipe\n")
448
487
elif isinstance(exc_object, KeyboardInterrupt):
449
488
err_file.write("bzr: interrupted\n")
450
489
return errors.EXIT_ERROR
490
elif isinstance(exc_object, MemoryError):
491
err_file.write("bzr: out of memory\n")
492
return errors.EXIT_ERROR
451
493
elif isinstance(exc_object, ImportError) \
452
494
and str(exc_object).startswith("No module named "):
453
495
report_user_error(exc_info, err_file,
456
498
elif not getattr(exc_object, 'internal_error', True):
457
499
report_user_error(exc_info, err_file)
458
500
return errors.EXIT_ERROR
459
elif isinstance(exc_object, (OSError, IOError)):
501
elif isinstance(exc_object, (OSError, IOError)) or (
502
# GZ 2010-05-20: Like (exc_type is pywintypes.error) but avoid import
503
exc_type.__name__ == "error" and exc_type.__module__ == "pywintypes"):
460
504
# Might be nice to catch all of these and show them as something more
461
505
# specific, but there are too many cases at the moment.
462
506
report_user_error(exc_info, err_file)
484
528
:param advice: Extra advice to the user to be printed following the
487
if 'error' in debug.debug_flags:
488
print_exception(exc_info, err_file)
490
531
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
492
533
err_file.write("%s\n" % (advice,))
495
536
def report_bug(exc_info, err_file):
496
537
"""Report an exception that probably indicates a bug in bzr"""
497
print_exception(exc_info, err_file)
499
err_file.write('bzr %s on python %s (%s)\n' % \
501
bzrlib._format_version_tuple(sys.version_info),
503
err_file.write('arguments: %r\n' % sys.argv)
505
'encoding: %r, fsenc: %r, lang: %r\n' % (
506
osutils.get_user_encoding(), sys.getfilesystemencoding(),
507
os.environ.get('LANG')))
508
err_file.write("plugins:\n")
509
for name, a_plugin in sorted(plugin.plugins().items()):
510
err_file.write(" %-20s %s [%s]\n" %
511
(name, a_plugin.path(), a_plugin.__version__))
514
*** Bazaar has encountered an internal error.
515
Please report a bug at https://bugs.launchpad.net/bzr/+filebug
516
including this traceback, and a description of what you
517
were doing when the error occurred.
538
from bzrlib.crash import report_bug
539
report_bug(exc_info, err_file)
542
def _flush_stdout_stderr():
543
# installed into an atexit hook by bzrlib.initialize()
549
if e.errno in [errno.EINVAL, errno.EPIPE]:
556
# run from atexit hook
added
removed
bzrlib/trace.py
