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.
145
145
_bzr_logger.error(*args, **kwargs)
148
def show_error(*args, **kwargs):
149
149
"""Show an error message to the user.
151
151
Don't use this for exceptions, use report_exception instead.
153
153
_bzr_logger.error(*args, **kwargs)
156
_last_mutter_flush_time = None
159
156
def mutter(fmt, *args):
160
global _last_mutter_flush_time
161
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.
163
161
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
182
180
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
183
181
out = timestamp + out + '\n'
184
182
_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
183
# there's no explicit flushing; the file is typically line buffered.
196
186
def mutter_callsite(stacklevel, fmt, *args):
248
238
This sets the global _bzr_log_filename.
250
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
251
268
_bzr_log_filename = _get_bzr_log_filename()
252
269
_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
271
bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
256
272
bzr_log_file.write('\n')
257
273
if bzr_log_file.tell() <= 2:
258
274
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
259
275
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
260
276
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
261
278
return bzr_log_file
263
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,))
264
287
# TODO: What should happen if we fail to open the trace file? Maybe the
265
288
# objects should be pointed at /dev/null or the equivalent? Currently
266
289
# returns None which will cause failures later.
446
469
:return: The appropriate exit code for this error.
448
exc_type, exc_object, exc_tb = exc_info
449
471
# Log the full traceback to ~/.bzr.log
450
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
451
477
if (isinstance(exc_object, IOError)
452
478
and getattr(exc_object, 'errno', None) == errno.EPIPE):
453
479
err_file.write("bzr: broken pipe\n")
494
520
: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
523
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
502
525
err_file.write("%s\n" % (advice,))
506
529
"""Report an exception that probably indicates a bug in bzr"""
507
530
from bzrlib.crash import report_bug
508
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
