1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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
113
114
def note(*args, **kwargs):
115
"""Output a note to the user.
117
Takes the same parameters as logging.info.
114
121
# FIXME note always emits utf-8, regardless of the terminal encoding
116
123
# FIXME: clearing the ui and then going through the abstract logging
145
152
_bzr_logger.error(*args, **kwargs)
155
def show_error(*args, **kwargs):
149
156
"""Show an error message to the user.
151
158
Don't use this for exceptions, use report_exception instead.
238
245
This sets the global _bzr_log_filename.
240
247
global _bzr_log_filename
249
def _open_or_create_log_file(filename):
250
"""Open existing log file, or create with ownership and permissions
252
It inherits the ownership and permissions (masked by umask) from
253
the containing directory to cope better with being run under sudo
254
with $HOME still set to the user's homedir.
256
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
259
fd = os.open(filename, flags)
262
if e.errno != errno.ENOENT:
265
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
267
if e.errno != errno.EEXIST:
270
osutils.copy_ownership_from_path(filename)
272
return os.fdopen(fd, 'at', 0) # unbuffered
241
275
_bzr_log_filename = _get_bzr_log_filename()
242
276
_rollover_trace_maybe(_bzr_log_filename)
244
bzr_log_file = open(_bzr_log_filename, 'at', buffering=0) # unbuffered
245
# bzr_log_file.tell() on windows always return 0 until some writing done
278
bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
246
279
bzr_log_file.write('\n')
247
280
if bzr_log_file.tell() <= 2:
248
281
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
249
282
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
250
283
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
251
285
return bzr_log_file
287
except EnvironmentError, e:
253
288
# If we are failing to open the log, then most likely logging has not
254
289
# been set up yet. So we just write to stderr rather than using
255
290
# 'warning()'. If we using warning(), users get the unhelpful 'no
272
307
logging.getLogger("bzr").
274
309
Output can be redirected away by calling _push_log_file.
311
:return: A memento from push_log_file for restoring the log state.
276
# Do this before we open the log file, so we prevent
277
# get_terminal_encoding() from mutter()ing multiple times
278
term_encoding = osutils.get_terminal_encoding()
279
313
start_time = osutils.format_local_date(_bzr_log_start_time,
280
314
timezone='local')
281
315
# create encoded wrapper around stderr
282
316
bzr_log_file = _open_bzr_log()
283
317
if bzr_log_file is not None:
284
318
bzr_log_file.write(start_time.encode('utf-8') + '\n')
285
push_log_file(bzr_log_file,
319
memento = push_log_file(bzr_log_file,
286
320
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
287
321
r'%Y-%m-%d %H:%M:%S')
288
322
# after hooking output into bzr_log, we also need to attach a stderr
289
323
# handler, writing only at level info and with encoding
324
term_encoding = osutils.get_terminal_encoding()
290
325
writer_factory = codecs.getwriter(term_encoding)
291
326
encoded_stderr = writer_factory(sys.stderr, errors='replace')
292
327
stderr_handler = logging.StreamHandler(encoded_stderr)
293
328
stderr_handler.setLevel(logging.INFO)
294
329
logging.getLogger('bzr').addHandler(stderr_handler)
297
333
def push_log_file(to_file, log_format=None, date_format=None):
333
369
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
334
370
"""Undo changes to logging/tracing done by _push_log_file.
336
This flushes, but does not close the trace file.
372
This flushes, but does not close the trace file (so that anything that was
338
375
Takes the memento returned from _push_log_file."""
339
376
global _trace_file
340
377
_trace_file = old_trace_file
341
378
bzr_logger = logging.getLogger('bzr')
342
379
bzr_logger.removeHandler(new_handler)
343
# must be closed, otherwise logging will try to close it atexit, and the
380
# must be closed, otherwise logging will try to close it at exit, and the
344
381
# file will likely already be closed underneath.
345
382
new_handler.close()
346
383
bzr_logger.handlers = old_handlers
347
new_trace_file.flush()
384
if new_trace_file is not None:
385
new_trace_file.flush()
350
388
def log_exception_quietly():
473
def _dump_memory_usage(err_file):
476
fd, name = tempfile.mkstemp(prefix="bzr_memdump", suffix=".json")
477
dump_file = os.fdopen(fd, 'w')
478
from meliae import scanner
479
scanner.dump_gc_objects(dump_file)
480
err_file.write("Memory dumped to %s\n" % name)
482
err_file.write("Dumping memory requires meliae module.\n")
483
log_exception_quietly()
485
err_file.write("Exception while dumping memory.\n")
486
log_exception_quietly()
488
if dump_file is not None:
436
493
def report_exception(exc_info, err_file):
437
494
"""Report an exception to err_file (typically stderr) and to .bzr.log.
455
512
return errors.EXIT_ERROR
456
513
elif isinstance(exc_object, MemoryError):
457
514
err_file.write("bzr: out of memory\n")
515
if 'mem_dump' in debug.debug_flags:
516
_dump_memory_usage(err_file)
518
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
458
519
return errors.EXIT_ERROR
459
520
elif isinstance(exc_object, ImportError) \
460
521
and str(exc_object).startswith("No module named "):
464
525
elif not getattr(exc_object, 'internal_error', True):
465
526
report_user_error(exc_info, err_file)
466
527
return errors.EXIT_ERROR
467
elif isinstance(exc_object, (OSError, IOError)):
528
elif isinstance(exc_object, (OSError, IOError)) or (
529
# GZ 2010-05-20: Like (exc_type is pywintypes.error) but avoid import
530
exc_type.__name__ == "error" and exc_type.__module__ == "pywintypes"):
468
531
# Might be nice to catch all of these and show them as something more
469
532
# specific, but there are too many cases at the moment.
470
533
report_user_error(exc_info, err_file)
501
564
"""Report an exception that probably indicates a bug in bzr"""
502
565
from bzrlib.crash import report_bug
503
566
report_bug(exc_info, err_file)
569
def _flush_stdout_stderr():
570
# called from the bzrlib library finalizer returned by bzrlib.initialize()
576
if e.errno in [errno.EINVAL, errno.EPIPE]:
583
# called from the bzrlib library finalizer returned by bzrlib.initialize()
589
class Config(object):
590
"""Configuration of message tracing in bzrlib.
592
This implements the context manager protocol and should manage any global
593
variables still used. The default config used is DefaultConfig, but
594
embedded uses of bzrlib may wish to use a custom manager.
598
return self # This is bound to the 'as' clause in a with statement.
600
def __exit__(self, exc_type, exc_val, exc_tb):
601
return False # propogate exceptions.
604
class DefaultConfig(Config):
605
"""A default configuration for tracing of messages in bzrlib.
607
This implements the context manager protocol.
611
self._original_filename = _bzr_log_filename
612
self._original_state = enable_default_logging()
613
return self # This is bound to the 'as' clause in a with statement.
615
def __exit__(self, exc_type, exc_val, exc_tb):
616
pop_log_file(self._original_state)
617
global _bzr_log_filename
618
_bzr_log_filename = self._original_filename
619
return False # propogate exceptions.
added
removed
bzrlib/trace.py
