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
109
108
def note(*args, **kwargs):
110
# FIXME note always emits utf-8, regardless of the terminal encoding
109
"""Output a note to the user.
111
Takes the same parameters as logging.info.
112
115
# FIXME: clearing the ui and then going through the abstract logging
113
116
# framework is whack; we should probably have a logging Handler that
114
117
# deals with terminal output if needed.
116
bzrlib.ui.ui_factory.clear_term()
118
ui.ui_factory.clear_term()
117
119
_bzr_logger.info(*args, **kwargs)
120
122
def warning(*args, **kwargs):
122
bzrlib.ui.ui_factory.clear_term()
123
ui.ui_factory.clear_term()
123
124
_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
127
def show_error(*args, **kwargs):
128
"""Show an error message to the user.
130
Don't use this for exceptions, use report_exception instead.
132
_bzr_logger.error(*args, **kwargs)
134
135
def mutter(fmt, *args):
135
136
if _trace_file is None:
138
# XXX: Don't check this every time; instead anyone who closes the file
139
# ought to deregister it. We can tolerate None.
137
140
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
193
196
def _get_bzr_log_filename():
194
bzr_log = os.environ.get('BZR_LOG')
197
bzr_log = osutils.path_from_environ('BZR_LOG')
197
home = os.environ.get('BZR_HOME')
200
home = osutils.path_from_environ('BZR_HOME')
199
if sys.platform == 'win32':
200
from bzrlib import win32utils
201
home = win32utils.get_home_location()
203
home = os.path.expanduser('~')
202
# GZ 2012-02-01: Logging to the home dir is bad, but XDG is unclear
203
# over what would be better. On windows, bug 240550
204
# suggests LOCALAPPDATA be used instead.
205
home = osutils._get_home_dir()
204
206
return os.path.join(home, '.bzr.log')
207
209
def _open_bzr_log():
208
"""Open the .bzr.log trace file.
210
"""Open the .bzr.log trace file.
210
212
If the log is more than a particular length, the old file is renamed to
211
213
.bzr.log.old and a new file is started. Otherwise, we append to the
214
216
This sets the global _bzr_log_filename.
216
218
global _bzr_log_filename
220
def _open_or_create_log_file(filename):
221
"""Open existing log file, or create with ownership and permissions
223
It inherits the ownership and permissions (masked by umask) from
224
the containing directory to cope better with being run under sudo
225
with $HOME still set to the user's homedir.
227
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
230
fd = os.open(filename, flags)
233
if e.errno != errno.ENOENT:
236
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
238
if e.errno != errno.EEXIST:
241
osutils.copy_ownership_from_path(filename)
243
return os.fdopen(fd, 'at', 0) # unbuffered
217
246
_bzr_log_filename = _get_bzr_log_filename()
218
247
_rollover_trace_maybe(_bzr_log_filename)
220
bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered
221
# bzr_log_file.tell() on windows always return 0 until some writing done
249
bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
222
250
bzr_log_file.write('\n')
223
251
if bzr_log_file.tell() <= 2:
224
252
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
225
253
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
226
254
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
227
256
return bzr_log_file
229
warning("failed to open trace file: %s" % (e))
258
except EnvironmentError, e:
259
# If we are failing to open the log, then most likely logging has not
260
# been set up yet. So we just write to stderr rather than using
261
# 'warning()'. If we using warning(), users get the unhelpful 'no
262
# handlers registered for "bzr"' when something goes wrong on the
263
# server. (bug #503886)
264
sys.stderr.write("failed to open trace file: %s\n" % (e,))
230
265
# TODO: What should happen if we fail to open the trace file? Maybe the
231
266
# objects should be pointed at /dev/null or the equivalent? Currently
232
267
# returns None which will cause failures later.
235
271
def enable_default_logging():
236
272
"""Configure default logging: messages to stderr and debug to .bzr.log
238
274
This should only be called once per process.
240
276
Non-command-line programs embedding bzrlib do not need to call this. They
241
277
can instead either pass a file to _push_log_file, or act directly on
242
278
logging.getLogger("bzr").
244
280
Output can be redirected away by calling _push_log_file.
282
:return: A memento from push_log_file for restoring the log state.
246
# create encoded wrapper around stderr
284
start_time = osutils.format_local_date(_bzr_log_start_time,
247
286
bzr_log_file = _open_bzr_log()
248
push_log_file(bzr_log_file,
287
if bzr_log_file is not None:
288
bzr_log_file.write(start_time.encode('utf-8') + '\n')
289
memento = push_log_file(bzr_log_file,
249
290
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
250
291
r'%Y-%m-%d %H:%M:%S')
251
292
# after hooking output into bzr_log, we also need to attach a stderr
252
293
# handler, writing only at level info and with encoding
253
writer_factory = codecs.getwriter(osutils.get_terminal_encoding())
254
encoded_stderr = writer_factory(sys.stderr, errors='replace')
255
stderr_handler = logging.StreamHandler(encoded_stderr)
256
stderr_handler.setLevel(logging.INFO)
294
stderr_handler = EncodedStreamHandler(sys.stderr,
295
osutils.get_terminal_encoding(), 'replace', level=logging.INFO)
257
296
logging.getLogger('bzr').addHandler(stderr_handler)
260
300
def push_log_file(to_file, log_format=None, date_format=None):
296
335
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
297
336
"""Undo changes to logging/tracing done by _push_log_file.
299
This flushes, but does not close the trace file.
338
This flushes, but does not close the trace file (so that anything that was
301
341
Takes the memento returned from _push_log_file."""
302
342
global _trace_file
303
343
_trace_file = old_trace_file
304
344
bzr_logger = logging.getLogger('bzr')
305
345
bzr_logger.removeHandler(new_handler)
306
# must be closed, otherwise logging will try to close it atexit, and the
346
# must be closed, otherwise logging will try to close it at exit, and the
307
347
# file will likely already be closed underneath.
308
348
new_handler.close()
309
349
bzr_logger.handlers = old_handlers
310
new_trace_file.flush()
313
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
314
def enable_test_log(to_file):
315
"""Redirect logging to a temporary file for a test
317
:returns: an opaque reference that should be passed to disable_test_log
318
after the test completes.
320
return push_log_file(to_file)
323
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
324
def disable_test_log(memento):
325
return pop_log_file(memento)
350
if new_trace_file is not None:
351
new_trace_file.flush()
328
354
def log_exception_quietly():
329
355
"""Log the last exception to the trace file only.
331
Used for exceptions that occur internally and that may be
332
interesting to developers but not to users. For example,
357
Used for exceptions that occur internally and that may be
358
interesting to developers but not to users. For example,
333
359
errors loading plugins.
335
361
mutter(traceback.format_exc())
379
405
return _verbosity_level > 0
382
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
383
def disable_default_logging():
384
"""Turn off default log handlers.
386
Don't call this method, use _push_log_file and _pop_log_file instead.
408
def debug_memory(message='', short=True):
409
"""Write out a memory dump."""
410
if sys.platform == 'win32':
411
from bzrlib import win32utils
412
win32utils.debug_memory_win32api(message=message, short=short)
414
_debug_memory_proc(message=message, short=short)
417
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
419
def _debug_memory_proc(message='', short=True):
421
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
425
status = status_file.read()
430
for line in status.splitlines():
434
for field in _short_fields:
435
if line.startswith(field):
439
def _dump_memory_usage(err_file):
442
fd, name = tempfile.mkstemp(prefix="bzr_memdump", suffix=".json")
443
dump_file = os.fdopen(fd, 'w')
444
from meliae import scanner
445
scanner.dump_gc_objects(dump_file)
446
err_file.write("Memory dumped to %s\n" % name)
448
err_file.write("Dumping memory requires meliae module.\n")
449
log_exception_quietly()
451
err_file.write("Exception while dumping memory.\n")
452
log_exception_quietly()
454
if dump_file is not None:
460
def _qualified_exception_name(eclass, unqualified_bzrlib_errors=False):
461
"""Give name of error class including module for non-builtin exceptions
463
If `unqualified_bzrlib_errors` is True, errors specific to bzrlib will
464
also omit the module prefix.
466
class_name = eclass.__name__
467
module_name = eclass.__module__
468
if module_name in ("exceptions", "__main__") or (
469
unqualified_bzrlib_errors and module_name == "bzrlib.errors"):
471
return "%s.%s" % (module_name, class_name)
391
474
def report_exception(exc_info, err_file):
396
479
:return: The appropriate exit code for this error.
398
exc_type, exc_object, exc_tb = exc_info
399
481
# Log the full traceback to ~/.bzr.log
400
482
log_exception_quietly()
401
if (isinstance(exc_object, IOError)
402
and getattr(exc_object, 'errno', None) == errno.EPIPE):
403
err_file.write("bzr: broken pipe\n")
483
if 'error' in debug.debug_flags:
484
print_exception(exc_info, err_file)
404
485
return errors.EXIT_ERROR
405
elif isinstance(exc_object, KeyboardInterrupt):
486
exc_type, exc_object, exc_tb = exc_info
487
if isinstance(exc_object, KeyboardInterrupt):
406
488
err_file.write("bzr: interrupted\n")
407
489
return errors.EXIT_ERROR
490
elif isinstance(exc_object, MemoryError):
491
err_file.write("bzr: out of memory\n")
492
if 'mem_dump' in debug.debug_flags:
493
_dump_memory_usage(err_file)
495
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
496
return errors.EXIT_ERROR
408
497
elif isinstance(exc_object, ImportError) \
409
498
and str(exc_object).startswith("No module named "):
410
499
report_user_error(exc_info, err_file,
413
502
elif not getattr(exc_object, 'internal_error', True):
414
503
report_user_error(exc_info, err_file)
415
504
return errors.EXIT_ERROR
416
elif isinstance(exc_object, (OSError, IOError)):
505
elif osutils.is_environment_error(exc_object):
506
if getattr(exc_object, 'errno', None) == errno.EPIPE:
507
err_file.write("bzr: broken pipe\n")
508
return errors.EXIT_ERROR
417
509
# Might be nice to catch all of these and show them as something more
418
510
# specific, but there are too many cases at the moment.
419
511
report_user_error(exc_info, err_file)
452
541
def report_bug(exc_info, err_file):
453
542
"""Report an exception that probably indicates a bug in bzr"""
454
print_exception(exc_info, err_file)
456
err_file.write('bzr %s on python %s (%s)\n' % \
458
bzrlib._format_version_tuple(sys.version_info),
460
err_file.write('arguments: %r\n' % sys.argv)
462
'encoding: %r, fsenc: %r, lang: %r\n' % (
463
osutils.get_user_encoding(), sys.getfilesystemencoding(),
464
os.environ.get('LANG')))
465
err_file.write("plugins:\n")
466
for name, a_plugin in sorted(plugin.plugins().items()):
467
err_file.write(" %-20s %s [%s]\n" %
468
(name, a_plugin.path(), a_plugin.__version__))
471
*** Bazaar has encountered an internal error.
472
Please report a bug at https://bugs.launchpad.net/bzr/+filebug
473
including this traceback, and a description of what you
474
were doing when the error occurred.
543
from bzrlib.crash import report_bug
544
report_bug(exc_info, err_file)
547
def _flush_stdout_stderr():
548
# called from the bzrlib library finalizer returned by bzrlib.initialize()
552
except ValueError, e:
553
# On Windows, I get ValueError calling stdout.flush() on a closed
558
if e.errno in [errno.EINVAL, errno.EPIPE]:
565
# called from the bzrlib library finalizer returned by bzrlib.initialize()
571
class EncodedStreamHandler(logging.Handler):
572
"""Robustly write logging events to a stream using the specified encoding
574
Messages are expected to be formatted to unicode, but UTF-8 byte strings
575
are also accepted. An error during formatting or a str message in another
576
encoding will be quitely noted as an error in the Bazaar log file.
578
The stream is not closed so sys.stdout or sys.stderr may be passed.
581
def __init__(self, stream, encoding=None, errors='strict', level=0):
582
logging.Handler.__init__(self, level)
585
encoding = getattr(stream, "encoding", "ascii")
586
self.encoding = encoding
590
flush = getattr(self.stream, "flush", None)
591
if flush is not None:
594
def emit(self, record):
596
line = self.format(record)
597
if not isinstance(line, unicode):
598
line = line.decode("utf-8")
599
self.stream.write(line.encode(self.encoding, self.errors) + "\n")
601
log_exception_quietly()
602
# Try saving the details that would have been logged in some form
603
msg = args = "<Unformattable>"
605
msg = repr(record.msg).encode("ascii")
606
args = repr(record.args).encode("ascii")
609
# Using mutter() bypasses the logging module and writes directly
610
# to the file so there's no danger of getting into a loop here.
611
mutter("Logging record unformattable: %s %% %s", msg, args)
614
class Config(object):
615
"""Configuration of message tracing in bzrlib.
617
This implements the context manager protocol and should manage any global
618
variables still used. The default config used is DefaultConfig, but
619
embedded uses of bzrlib may wish to use a custom manager.
623
return self # This is bound to the 'as' clause in a with statement.
625
def __exit__(self, exc_type, exc_val, exc_tb):
626
return False # propogate exceptions.
629
class DefaultConfig(Config):
630
"""A default configuration for tracing of messages in bzrlib.
632
This implements the context manager protocol.
636
self._original_filename = _bzr_log_filename
637
self._original_state = enable_default_logging()
638
return self # This is bound to the 'as' clause in a with statement.
640
def __exit__(self, exc_type, exc_val, exc_tb):
641
pop_log_file(self._original_state)
642
global _bzr_log_filename
643
_bzr_log_filename = self._original_filename
644
return False # propogate exceptions.
added
removed
bzrlib/trace.py
