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.
120
110
# FIXME note always emits utf-8, regardless of the terminal encoding
122
112
# FIXME: clearing the ui and then going through the abstract logging
133
123
_bzr_logger.warning(*args, **kwargs)
136
@deprecated_function(deprecated_in((2, 1, 0)))
137
def info(*args, **kwargs):
138
"""Deprecated: use trace.note instead."""
139
note(*args, **kwargs)
142
@deprecated_function(deprecated_in((2, 1, 0)))
143
def log_error(*args, **kwargs):
144
"""Deprecated: use bzrlib.trace.show_error instead"""
145
_bzr_logger.error(*args, **kwargs)
148
@deprecated_function(deprecated_in((2, 1, 0)))
149
def error(*args, **kwargs):
150
"""Deprecated: use bzrlib.trace.show_error instead"""
151
_bzr_logger.error(*args, **kwargs)
154
def show_error(*args, **kwargs):
155
"""Show an error message to the user.
157
Don't use this for exceptions, use report_exception instead.
159
_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
162
134
def mutter(fmt, *args):
163
135
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.
167
137
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
182
152
out = fmt % tuple(real_args)
186
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
155
timestamp = '%0.3f ' % (time.time() - _bzr_log_start_time,)
187
156
out = timestamp + out + '\n'
188
157
_trace_file.write(out)
189
# 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
192
162
def mutter_callsite(stacklevel, fmt, *args):
237
207
def _open_bzr_log():
238
"""Open the .bzr.log trace file.
208
"""Open the .bzr.log trace file.
240
210
If the log is more than a particular length, the old file is renamed to
241
211
.bzr.log.old and a new file is started. Otherwise, we append to the
244
214
This sets the global _bzr_log_filename.
246
216
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
274
217
_bzr_log_filename = _get_bzr_log_filename()
275
218
_rollover_trace_maybe(_bzr_log_filename)
277
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
278
222
bzr_log_file.write('\n')
279
223
if bzr_log_file.tell() <= 2:
280
224
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
281
225
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
282
226
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
284
227
return bzr_log_file
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,))
229
warning("failed to open trace file: %s" % (e))
293
230
# TODO: What should happen if we fail to open the trace file? Maybe the
294
231
# objects should be pointed at /dev/null or the equivalent? Currently
295
232
# returns None which will cause failures later.
299
235
def enable_default_logging():
314
250
timezone='local')
315
251
# create encoded wrapper around stderr
316
252
bzr_log_file = _open_bzr_log()
317
if bzr_log_file is not None:
318
bzr_log_file.write(start_time.encode('utf-8') + '\n')
253
bzr_log_file.write(start_time.encode('utf-8') + '\n')
319
254
push_log_file(bzr_log_file,
320
255
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
321
256
r'%Y-%m-%d %H:%M:%S')
381
316
new_trace_file.flush()
319
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
320
def enable_test_log(to_file):
321
"""Redirect logging to a temporary file for a test
323
:returns: an opaque reference that should be passed to disable_test_log
324
after the test completes.
326
return push_log_file(to_file)
329
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
330
def disable_test_log(memento):
331
return pop_log_file(memento)
384
334
def log_exception_quietly():
385
335
"""Log the last exception to the trace file only.
387
Used for exceptions that occur internally and that may be
388
interesting to developers but not to users. For example,
337
Used for exceptions that occur internally and that may be
338
interesting to developers but not to users. For example,
389
339
errors loading plugins.
391
341
mutter(traceback.format_exc())
435
385
return _verbosity_level > 0
388
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
389
def disable_default_logging():
390
"""Turn off default log handlers.
392
Don't call this method, use _push_log_file and _pop_log_file instead.
397
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
438
399
def debug_memory(message='', short=True):
439
400
"""Write out a memory dump."""
440
if sys.platform == 'win32':
441
from bzrlib import win32utils
442
win32utils.debug_memory_win32api(message=message, short=short)
444
_debug_memory_proc(message=message, short=short)
447
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
449
def _debug_memory_proc(message='', short=True):
451
402
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
475
426
:return: The appropriate exit code for this error.
428
exc_type, exc_object, exc_tb = exc_info
477
429
# Log the full traceback to ~/.bzr.log
478
430
log_exception_quietly()
479
if 'error' in debug.debug_flags:
480
print_exception(exc_info, err_file)
481
return errors.EXIT_ERROR
482
exc_type, exc_object, exc_tb = exc_info
483
431
if (isinstance(exc_object, IOError)
484
432
and getattr(exc_object, 'errno', None) == errno.EPIPE):
485
433
err_file.write("bzr: broken pipe\n")
487
435
elif isinstance(exc_object, KeyboardInterrupt):
488
436
err_file.write("bzr: interrupted\n")
489
437
return errors.EXIT_ERROR
490
elif isinstance(exc_object, MemoryError):
491
err_file.write("bzr: out of memory\n")
492
return errors.EXIT_ERROR
493
438
elif isinstance(exc_object, ImportError) \
494
439
and str(exc_object).startswith("No module named "):
495
440
report_user_error(exc_info, err_file,
498
443
elif not getattr(exc_object, 'internal_error', True):
499
444
report_user_error(exc_info, err_file)
500
445
return errors.EXIT_ERROR
501
elif isinstance(exc_object, (OSError, IOError)) or (
502
# GZ 2010-05-20: Like (exc_type is pywintypes.error) but avoid import
503
exc_type.__name__ == "error" and exc_type.__module__ == "pywintypes"):
446
elif isinstance(exc_object, (OSError, IOError)):
504
447
# Might be nice to catch all of these and show them as something more
505
448
# specific, but there are too many cases at the moment.
506
449
report_user_error(exc_info, err_file)
528
471
:param advice: Extra advice to the user to be printed following the
474
if 'error' in debug.debug_flags:
475
print_exception(exc_info, err_file)
531
477
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
533
479
err_file.write("%s\n" % (advice,))
536
482
def report_bug(exc_info, err_file):
537
483
"""Report an exception that probably indicates a bug in bzr"""
538
from bzrlib.crash import report_bug
539
report_bug(exc_info, err_file)
542
def _flush_stdout_stderr():
543
# installed into an atexit hook by bzrlib.initialize()
549
if e.errno in [errno.EINVAL, errno.EPIPE]:
556
# run from atexit hook
484
print_exception(exc_info, err_file)
486
err_file.write('bzr %s on python %s (%s)\n' % \
488
bzrlib._format_version_tuple(sys.version_info),
490
err_file.write('arguments: %r\n' % sys.argv)
492
'encoding: %r, fsenc: %r, lang: %r\n' % (
493
osutils.get_user_encoding(), sys.getfilesystemencoding(),
494
os.environ.get('LANG')))
495
err_file.write("plugins:\n")
496
for name, a_plugin in sorted(plugin.plugins().items()):
497
err_file.write(" %-20s %s [%s]\n" %
498
(name, a_plugin.path(), a_plugin.__version__))
501
*** Bazaar has encountered an internal error.
502
Please report a bug at https://bugs.launchpad.net/bzr/+filebug
503
including this traceback, and a description of what you
504
were doing when the error occurred.
added
removed
bzrlib/trace.py
