1
# Copyright (C) 2005-2010 Canonical Ltd
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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
113
113
def note(*args, **kwargs):
114
"""Output a note to the user.
116
Takes the same parameters as logging.info.
120
114
# FIXME note always emits utf-8, regardless of the terminal encoding
122
116
# FIXME: clearing the ui and then going through the abstract logging
151
145
_bzr_logger.error(*args, **kwargs)
154
def show_error(*args, **kwargs):
155
149
"""Show an error message to the user.
157
151
Don't use this for exceptions, use report_exception instead.
244
238
This sets the global _bzr_log_filename.
246
240
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
241
_bzr_log_filename = _get_bzr_log_filename()
275
242
_rollover_trace_maybe(_bzr_log_filename)
277
bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
244
bzr_log_file = open(_bzr_log_filename, 'at', buffering=0) # unbuffered
245
# bzr_log_file.tell() on windows always return 0 until some writing done
278
246
bzr_log_file.write('\n')
279
247
if bzr_log_file.tell() <= 2:
280
248
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
281
249
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
282
250
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
284
251
return bzr_log_file
286
except EnvironmentError, e:
287
253
# If we are failing to open the log, then most likely logging has not
288
254
# been set up yet. So we just write to stderr rather than using
289
255
# 'warning()'. If we using warning(), users get the unhelpful 'no
306
272
logging.getLogger("bzr").
308
274
Output can be redirected away by calling _push_log_file.
310
:return: A memento from push_log_file for restoring the log state.
276
# Do this before we open the log file, so we prevent
277
# get_terminal_encoding() from mutter()ing multiple times
278
term_encoding = osutils.get_terminal_encoding()
312
279
start_time = osutils.format_local_date(_bzr_log_start_time,
313
280
timezone='local')
314
281
# create encoded wrapper around stderr
315
282
bzr_log_file = _open_bzr_log()
316
283
if bzr_log_file is not None:
317
284
bzr_log_file.write(start_time.encode('utf-8') + '\n')
318
memento = push_log_file(bzr_log_file,
285
push_log_file(bzr_log_file,
319
286
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
320
287
r'%Y-%m-%d %H:%M:%S')
321
288
# after hooking output into bzr_log, we also need to attach a stderr
322
289
# handler, writing only at level info and with encoding
323
term_encoding = osutils.get_terminal_encoding()
324
290
writer_factory = codecs.getwriter(term_encoding)
325
291
encoded_stderr = writer_factory(sys.stderr, errors='replace')
326
292
stderr_handler = logging.StreamHandler(encoded_stderr)
327
293
stderr_handler.setLevel(logging.INFO)
328
294
logging.getLogger('bzr').addHandler(stderr_handler)
332
297
def push_log_file(to_file, log_format=None, date_format=None):
368
333
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
369
334
"""Undo changes to logging/tracing done by _push_log_file.
371
This flushes, but does not close the trace file (so that anything that was
336
This flushes, but does not close the trace file.
374
338
Takes the memento returned from _push_log_file."""
375
339
global _trace_file
376
340
_trace_file = old_trace_file
377
341
bzr_logger = logging.getLogger('bzr')
378
342
bzr_logger.removeHandler(new_handler)
379
# must be closed, otherwise logging will try to close it at exit, and the
343
# must be closed, otherwise logging will try to close it atexit, and the
380
344
# file will likely already be closed underneath.
381
345
new_handler.close()
382
346
bzr_logger.handlers = old_handlers
383
if new_trace_file is not None:
384
new_trace_file.flush()
347
new_trace_file.flush()
387
350
def log_exception_quietly():
501
464
elif not getattr(exc_object, 'internal_error', True):
502
465
report_user_error(exc_info, err_file)
503
466
return errors.EXIT_ERROR
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"):
467
elif isinstance(exc_object, (OSError, IOError)):
507
468
# Might be nice to catch all of these and show them as something more
508
469
# specific, but there are too many cases at the moment.
509
470
report_user_error(exc_info, err_file)
540
501
"""Report an exception that probably indicates a bug in bzr"""
541
502
from bzrlib.crash import report_bug
542
503
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
