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
14
14
# along with this program; if not, write to the Free Software
15
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.
113
113
def note(*args, **kwargs):
114
"""Output a note to the user.
116
Takes the same parameters as logging.info.
114
120
# FIXME note always emits utf-8, regardless of the terminal encoding
116
122
# FIXME: clearing the ui and then going through the abstract logging
145
151
_bzr_logger.error(*args, **kwargs)
154
def show_error(*args, **kwargs):
149
155
"""Show an error message to the user.
151
157
Don't use this for exceptions, use report_exception instead.
153
159
_bzr_logger.error(*args, **kwargs)
156
_last_mutter_flush_time = None
159
162
def mutter(fmt, *args):
160
global _last_mutter_flush_time
161
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.
163
167
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
182
186
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
183
187
out = timestamp + out + '\n'
184
188
_trace_file.write(out)
185
# We flush if we haven't flushed for a few seconds. We don't want to flush
186
# on every mutter, but when a command takes a while, it can be nice to see
187
# updates in the debug log.
188
if (_last_mutter_flush_time is None
189
or (now - _last_mutter_flush_time) > 2.0):
190
flush = getattr(_trace_file, 'flush', None)
191
if flush is not None:
193
_last_mutter_flush_time = now
189
# there's no explicit flushing; the file is typically line buffered.
196
192
def mutter_callsite(stacklevel, fmt, *args):
248
244
This sets the global _bzr_log_filename.
250
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
251
274
_bzr_log_filename = _get_bzr_log_filename()
252
275
_rollover_trace_maybe(_bzr_log_filename)
254
bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered
255
# 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)
256
278
bzr_log_file.write('\n')
257
279
if bzr_log_file.tell() <= 2:
258
280
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
259
281
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
260
282
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
261
284
return bzr_log_file
263
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,))
264
293
# TODO: What should happen if we fail to open the trace file? Maybe the
265
294
# objects should be pointed at /dev/null or the equivalent? Currently
266
295
# returns None which will cause failures later.
277
306
logging.getLogger("bzr").
279
308
Output can be redirected away by calling _push_log_file.
310
:return: A memento from push_log_file for restoring the log state.
281
# Do this before we open the log file, so we prevent
282
# get_terminal_encoding() from mutter()ing multiple times
283
term_encoding = osutils.get_terminal_encoding()
284
312
start_time = osutils.format_local_date(_bzr_log_start_time,
285
313
timezone='local')
286
314
# create encoded wrapper around stderr
287
315
bzr_log_file = _open_bzr_log()
288
316
if bzr_log_file is not None:
289
317
bzr_log_file.write(start_time.encode('utf-8') + '\n')
290
push_log_file(bzr_log_file,
318
memento = push_log_file(bzr_log_file,
291
319
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
292
320
r'%Y-%m-%d %H:%M:%S')
293
321
# after hooking output into bzr_log, we also need to attach a stderr
294
322
# handler, writing only at level info and with encoding
323
term_encoding = osutils.get_terminal_encoding()
295
324
writer_factory = codecs.getwriter(term_encoding)
296
325
encoded_stderr = writer_factory(sys.stderr, errors='replace')
297
326
stderr_handler = logging.StreamHandler(encoded_stderr)
298
327
stderr_handler.setLevel(logging.INFO)
299
328
logging.getLogger('bzr').addHandler(stderr_handler)
302
332
def push_log_file(to_file, log_format=None, date_format=None):
338
368
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
339
369
"""Undo changes to logging/tracing done by _push_log_file.
341
This flushes, but does not close the trace file.
371
This flushes, but does not close the trace file (so that anything that was
343
374
Takes the memento returned from _push_log_file."""
344
375
global _trace_file
345
376
_trace_file = old_trace_file
346
377
bzr_logger = logging.getLogger('bzr')
347
378
bzr_logger.removeHandler(new_handler)
348
# must be closed, otherwise logging will try to close it atexit, and the
379
# must be closed, otherwise logging will try to close it at exit, and the
349
380
# file will likely already be closed underneath.
350
381
new_handler.close()
351
382
bzr_logger.handlers = old_handlers
352
new_trace_file.flush()
383
if new_trace_file is not None:
384
new_trace_file.flush()
355
387
def log_exception_quietly():
446
478
:return: The appropriate exit code for this error.
448
exc_type, exc_object, exc_tb = exc_info
449
480
# Log the full traceback to ~/.bzr.log
450
481
log_exception_quietly()
482
if 'error' in debug.debug_flags:
483
print_exception(exc_info, err_file)
484
return errors.EXIT_ERROR
485
exc_type, exc_object, exc_tb = exc_info
451
486
if (isinstance(exc_object, IOError)
452
487
and getattr(exc_object, 'errno', None) == errno.EPIPE):
453
488
err_file.write("bzr: broken pipe\n")
466
501
elif not getattr(exc_object, 'internal_error', True):
467
502
report_user_error(exc_info, err_file)
468
503
return errors.EXIT_ERROR
469
elif isinstance(exc_object, (OSError, IOError)):
504
elif isinstance(exc_object, (OSError, IOError)) or (
505
# GZ 2010-05-20: Like (exc_type is pywintypes.error) but avoid import
506
exc_type.__name__ == "error" and exc_type.__module__ == "pywintypes"):
470
507
# Might be nice to catch all of these and show them as something more
471
508
# specific, but there are too many cases at the moment.
472
509
report_user_error(exc_info, err_file)
494
531
:param advice: Extra advice to the user to be printed following the
497
if 'error' in debug.debug_flags:
498
print_exception(exc_info, err_file)
500
534
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
502
536
err_file.write("%s\n" % (advice,))
506
540
"""Report an exception that probably indicates a bug in bzr"""
507
541
from bzrlib.crash import report_bug
508
542
report_bug(exc_info, err_file)
545
def _flush_stdout_stderr():
546
# called from the bzrlib library finalizer returned by bzrlib.initialize()
552
if e.errno in [errno.EINVAL, errno.EPIPE]:
559
# called from the bzrlib library finalizer returned by bzrlib.initialize()
565
class Config(object):
566
"""Configuration of message tracing in bzrlib.
568
This implements the context manager protocol and should manage any global
569
variables still used. The default config used is DefaultConfig, but
570
embedded uses of bzrlib may wish to use a custom manager.
574
return self # This is bound to the 'as' clause in a with statement.
576
def __exit__(self, exc_type, exc_val, exc_tb):
577
return False # propogate exceptions.
580
class DefaultConfig(Config):
581
"""A default configuration for tracing of messages in bzrlib.
583
This implements the context manager protocol.
587
self._original_filename = _bzr_log_filename
588
self._original_state = enable_default_logging()
589
return self # This is bound to the 'as' clause in a with statement.
591
def __exit__(self, exc_type, exc_val, exc_tb):
592
pop_log_file(self._original_state)
593
global _bzr_log_filename
594
_bzr_log_filename = self._original_filename
595
return False # propogate exceptions.
added
removed
bzrlib/trace.py
