1
# Copyright (C) 2005-2010 Canonical Ltd
1
# Copyright (C) 2005, 2006, 2007, 2008 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.
17
"""Messages and logging for bazaar-ng.
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 debug mode, stderr gets debug messages too.
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.
38
39
Errors that terminate an operation are generally passed back as exceptions;
39
40
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.
119
114
# FIXME note always emits utf-8, regardless of the terminal encoding
121
116
# FIXME: clearing the ui and then going through the abstract logging
150
145
_bzr_logger.error(*args, **kwargs)
153
def show_error(*args, **kwargs):
154
149
"""Show an error message to the user.
156
151
Don't use this for exceptions, use report_exception instead.
158
153
_bzr_logger.error(*args, **kwargs)
156
_last_mutter_flush_time = None
161
159
def mutter(fmt, *args):
160
global _last_mutter_flush_time
162
161
if _trace_file is None:
164
# XXX: Don't check this every time; instead anyone who closes the file
165
# ought to deregister it. We can tolerate None.
166
163
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
185
182
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
186
183
out = timestamp + out + '\n'
187
184
_trace_file.write(out)
188
# there's no explicit flushing; the file is typically line buffered.
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
191
196
def mutter_callsite(stacklevel, fmt, *args):
243
248
This sets the global _bzr_log_filename.
245
250
global _bzr_log_filename
247
def _open_or_create_log_file(filename):
248
"""Open existing log file, or create with ownership and permissions
250
It inherits the ownership and permissions (masked by umask) from
251
the containing directory to cope better with being run under sudo
252
with $HOME still set to the user's homedir.
254
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
257
fd = os.open(filename, flags)
260
if e.errno != errno.ENOENT:
263
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
265
if e.errno != errno.EEXIST:
268
osutils.copy_ownership_from_path(filename)
270
return os.fdopen(fd, 'at', 0) # unbuffered
273
251
_bzr_log_filename = _get_bzr_log_filename()
274
252
_rollover_trace_maybe(_bzr_log_filename)
276
bzr_log_file = _open_or_create_log_file(_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
256
bzr_log_file.write('\n')
278
257
if bzr_log_file.tell() <= 2:
279
258
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
280
259
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
281
260
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
283
261
return bzr_log_file
285
except EnvironmentError, e:
286
# If we are failing to open the log, then most likely logging has not
287
# been set up yet. So we just write to stderr rather than using
288
# 'warning()'. If we using warning(), users get the unhelpful 'no
289
# handlers registered for "bzr"' when something goes wrong on the
290
# server. (bug #503886)
291
sys.stderr.write("failed to open trace file: %s\n" % (e,))
263
warning("failed to open trace file: %s" % (e))
292
264
# TODO: What should happen if we fail to open the trace file? Maybe the
293
265
# objects should be pointed at /dev/null or the equivalent? Currently
294
266
# returns None which will cause failures later.
474
446
:return: The appropriate exit code for this error.
448
exc_type, exc_object, exc_tb = exc_info
476
449
# Log the full traceback to ~/.bzr.log
477
450
log_exception_quietly()
478
if 'error' in debug.debug_flags:
479
print_exception(exc_info, err_file)
480
return errors.EXIT_ERROR
481
exc_type, exc_object, exc_tb = exc_info
482
451
if (isinstance(exc_object, IOError)
483
452
and getattr(exc_object, 'errno', None) == errno.EPIPE):
484
453
err_file.write("bzr: broken pipe\n")
525
494
: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)
528
500
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
530
502
err_file.write("%s\n" % (advice,))
534
506
"""Report an exception that probably indicates a bug in bzr"""
535
507
from bzrlib.crash import report_bug
536
508
report_bug(exc_info, err_file)
539
def _flush_stdout_stderr():
540
# installed into an atexit hook by bzrlib.initialize()
546
if e.errno in [errno.EINVAL, errno.EPIPE]:
553
# run from atexit hook
added
removed
bzrlib/trace.py
