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
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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
109
def note(*args, **kwargs):
114
"""Output a note to the user.
116
Takes the same parameters as logging.info.
119
110
# FIXME note always emits utf-8, regardless of the terminal encoding
121
112
# FIXME: clearing the ui and then going through the abstract logging
132
123
_bzr_logger.warning(*args, **kwargs)
135
@deprecated_function(deprecated_in((2, 1, 0)))
136
def info(*args, **kwargs):
137
"""Deprecated: use trace.note instead."""
138
note(*args, **kwargs)
141
@deprecated_function(deprecated_in((2, 1, 0)))
142
def log_error(*args, **kwargs):
143
"""Deprecated: use bzrlib.trace.show_error instead"""
144
_bzr_logger.error(*args, **kwargs)
147
@deprecated_function(deprecated_in((2, 1, 0)))
148
def error(*args, **kwargs):
149
"""Deprecated: use bzrlib.trace.show_error instead"""
150
_bzr_logger.error(*args, **kwargs)
153
def show_error(*args, **kwargs):
154
"""Show an error message to the user.
156
Don't use this for exceptions, use report_exception instead.
158
_bzr_logger.error(*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
161
134
def mutter(fmt, *args):
162
135
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
137
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
181
152
out = fmt % tuple(real_args)
185
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
155
timestamp = '%0.3f ' % (time.time() - _bzr_log_start_time,)
186
156
out = timestamp + out + '\n'
187
157
_trace_file.write(out)
188
# there's no explicit flushing; the file is typically line buffered.
158
# no need to flush here, the trace file is now linebuffered when it's
191
162
def mutter_callsite(stacklevel, fmt, *args):
236
207
def _open_bzr_log():
237
"""Open the .bzr.log trace file.
208
"""Open the .bzr.log trace file.
239
210
If the log is more than a particular length, the old file is renamed to
240
211
.bzr.log.old and a new file is started. Otherwise, we append to the
243
214
This sets the global _bzr_log_filename.
245
216
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
217
_bzr_log_filename = _get_bzr_log_filename()
274
218
_rollover_trace_maybe(_bzr_log_filename)
276
bzr_log_file = _open_or_create_log_file(_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
277
222
bzr_log_file.write('\n')
278
223
if bzr_log_file.tell() <= 2:
279
224
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
280
225
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
281
226
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
283
227
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,))
229
warning("failed to open trace file: %s" % (e))
292
230
# TODO: What should happen if we fail to open the trace file? Maybe the
293
231
# objects should be pointed at /dev/null or the equivalent? Currently
294
232
# returns None which will cause failures later.
380
318
new_trace_file.flush()
321
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
322
def enable_test_log(to_file):
323
"""Redirect logging to a temporary file for a test
325
:returns: an opaque reference that should be passed to disable_test_log
326
after the test completes.
328
return push_log_file(to_file)
331
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
332
def disable_test_log(memento):
333
return pop_log_file(memento)
383
336
def log_exception_quietly():
384
337
"""Log the last exception to the trace file only.
386
Used for exceptions that occur internally and that may be
387
interesting to developers but not to users. For example,
339
Used for exceptions that occur internally and that may be
340
interesting to developers but not to users. For example,
388
341
errors loading plugins.
390
343
mutter(traceback.format_exc())
434
387
return _verbosity_level > 0
390
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
391
def disable_default_logging():
392
"""Turn off default log handlers.
394
Don't call this method, use _push_log_file and _pop_log_file instead.
399
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
437
401
def debug_memory(message='', short=True):
438
402
"""Write out a memory dump."""
439
if sys.platform == 'win32':
440
from bzrlib import win32utils
441
win32utils.debug_memory_win32api(message=message, short=short)
443
_debug_memory_proc(message=message, short=short)
446
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
448
def _debug_memory_proc(message='', short=True):
450
404
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
474
428
:return: The appropriate exit code for this error.
430
exc_type, exc_object, exc_tb = exc_info
476
431
# Log the full traceback to ~/.bzr.log
477
432
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
433
if (isinstance(exc_object, IOError)
483
434
and getattr(exc_object, 'errno', None) == errno.EPIPE):
484
435
err_file.write("bzr: broken pipe\n")
486
437
elif isinstance(exc_object, KeyboardInterrupt):
487
438
err_file.write("bzr: interrupted\n")
488
439
return errors.EXIT_ERROR
489
elif isinstance(exc_object, MemoryError):
490
err_file.write("bzr: out of memory\n")
491
return errors.EXIT_ERROR
492
440
elif isinstance(exc_object, ImportError) \
493
441
and str(exc_object).startswith("No module named "):
494
442
report_user_error(exc_info, err_file,
525
473
:param advice: Extra advice to the user to be printed following the
476
if 'error' in debug.debug_flags:
477
print_exception(exc_info, err_file)
528
479
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
530
481
err_file.write("%s\n" % (advice,))
533
484
def report_bug(exc_info, err_file):
534
485
"""Report an exception that probably indicates a bug in bzr"""
535
from bzrlib.crash import report_bug
536
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
486
print_exception(exc_info, err_file)
488
err_file.write('bzr %s on python %s (%s)\n' % \
490
bzrlib._format_version_tuple(sys.version_info),
492
err_file.write('arguments: %r\n' % sys.argv)
494
'encoding: %r, fsenc: %r, lang: %r\n' % (
495
osutils.get_user_encoding(), sys.getfilesystemencoding(),
496
os.environ.get('LANG')))
497
err_file.write("plugins:\n")
498
for name, a_plugin in sorted(plugin.plugins().items()):
499
err_file.write(" %-20s %s [%s]\n" %
500
(name, a_plugin.path(), a_plugin.__version__))
503
*** Bazaar has encountered an internal error.
504
Please report a bug at https://bugs.launchpad.net/bzr/+filebug
505
including this traceback, and a description of what you
506
were doing when the error occurred.
added
removed
bzrlib/trace.py
