← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

  • Committer: John Arbash Meinel
  • Date: 2013-05-19 14:29:37 UTC
  • mfrom: (6437.63.9 2.5)
  • mto: (6437.63.10 2.5)
  • mto: This revision was merged to the branch mainline in revision 6575.
  • Revision ID: john@arbash-meinel.com-20130519142937-21ykz2n2y2f22za9
Merge in the actual 2.5 branch. It seems I failed before

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/trace.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
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
12
12
#
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
"""Messages and logging for bazaar-ng.
 
17
"""Messages and logging.
18
18
 
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
33
33
 
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.
38
37
 
39
38
Errors that terminate an operation are generally passed back as exceptions;
40
39
others may be just emitted as messages.
46
45
form.
47
46
"""
48
47
 
 
48
from __future__ import absolute_import
 
49
 
49
50
# FIXME: Unfortunately it turns out that python's logging module
50
51
# is quite expensive, even when the message is not printed by any handlers.
51
52
# We should perhaps change back to just simply doing it here.
 
53
#
 
54
# On the other hand, as of 1.2 we generally only call the mutter() statement
 
55
# if (according to debug_flags) we actually intend to write it.  So the
 
56
# increased cost of logging.py is not so bad, and we could standardize on
 
57
# that.
52
58
 
 
59
import logging
53
60
import os
54
61
import sys
55
 
import re
 
62
import time
56
63
 
57
64
from bzrlib.lazy_import import lazy_import
58
65
lazy_import(globals(), """
 
66
from cStringIO import StringIO
59
67
import errno
60
 
import logging
 
68
import locale
 
69
import tempfile
 
70
import traceback
61
71
""")
62
72
 
63
73
import bzrlib
64
 
from bzrlib.symbol_versioning import (deprecated_function,
65
 
        zero_nine,
66
 
        )
67
74
 
68
75
lazy_import(globals(), """
69
 
from bzrlib import debug
 
76
from bzrlib import (
 
77
    debug,
 
78
    errors,
 
79
    osutils,
 
80
    ui,
 
81
    )
70
82
""")
71
83
 
72
 
_file_handler = None
73
 
_stderr_handler = None
74
 
_stderr_quiet = False
 
84
 
 
85
# global verbosity for bzrlib; controls the log level for stderr; 0=normal; <0
 
86
# is quiet; >0 is verbose.
 
87
_verbosity_level = 0
 
88
 
 
89
# File-like object where mutter/debug output is currently sent.  Can be
 
90
# changed by _push_log_file etc.  This is directly manipulated by some
 
91
# external code; maybe there should be functions to do that more precisely
 
92
# than push/pop_log_file.
75
93
_trace_file = None
76
 
_trace_depth = 0
77
 
_bzr_log_file = None
78
 
 
79
 
 
80
 
# configure convenient aliases for output routines
81
 
 
 
94
 
 
95
# Absolute path for ~/.bzr.log.  Not changed even if the log/trace output is
 
96
# redirected elsewhere.  Used to show the location in --version.
 
97
_bzr_log_filename = None
 
98
 
 
99
# The time the first message was written to the trace file, so that we can
 
100
# show relative times since startup.
 
101
_bzr_log_start_time = bzrlib._start_time
 
102
 
 
103
 
 
104
# held in a global for quick reference
82
105
_bzr_logger = logging.getLogger('bzr')
83
106
 
 
107
 
84
108
def note(*args, **kwargs):
85
 
    # FIXME note always emits utf-8, regardless of the terminal encoding
86
 
    import bzrlib.ui
87
 
    bzrlib.ui.ui_factory.clear_term()
 
109
    """Output a note to the user.
 
110
 
 
111
    Takes the same parameters as logging.info.
 
112
 
 
113
    :return: None
 
114
    """
 
115
    # FIXME: clearing the ui and then going through the abstract logging
 
116
    # framework is whack; we should probably have a logging Handler that
 
117
    # deals with terminal output if needed.
 
118
    ui.ui_factory.clear_term()
88
119
    _bzr_logger.info(*args, **kwargs)
89
120
 
 
121
 
90
122
def warning(*args, **kwargs):
91
 
    import bzrlib.ui
92
 
    bzrlib.ui.ui_factory.clear_term()
 
123
    ui.ui_factory.clear_term()
93
124
    _bzr_logger.warning(*args, **kwargs)
94
125
 
95
 
info = note
96
 
log_error = _bzr_logger.error
97
 
error =     _bzr_logger.error
 
126
 
 
127
def show_error(*args, **kwargs):
 
128
    """Show an error message to the user.
 
129
 
 
130
    Don't use this for exceptions, use report_exception instead.
 
131
    """
 
132
    _bzr_logger.error(*args, **kwargs)
98
133
 
99
134
 
100
135
def mutter(fmt, *args):
101
136
    if _trace_file is None:
102
137
        return
 
138
    # XXX: Don't check this every time; instead anyone who closes the file
 
139
    # ought to deregister it.  We can tolerate None.
103
140
    if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
104
141
        return
105
142
 
118
155
        out = fmt % tuple(real_args)
119
156
    else:
120
157
        out = fmt
121
 
    out += '\n'
 
158
    now = time.time()
 
159
    timestamp = '%0.3f  ' % (now - _bzr_log_start_time,)
 
160
    out = timestamp + out + '\n'
122
161
    _trace_file.write(out)
123
 
    # TODO: jam 20051227 Consider flushing the trace file to help debugging
124
 
    #_trace_file.flush()
 
162
    # there's no explicit flushing; the file is typically line buffered.
 
163
 
 
164
 
 
165
def mutter_callsite(stacklevel, fmt, *args):
 
166
    """Perform a mutter of fmt and args, logging the call trace.
 
167
 
 
168
    :param stacklevel: The number of frames to show. None will show all
 
169
        frames.
 
170
    :param fmt: The format string to pass to mutter.
 
171
    :param args: A list of substitution variables.
 
172
    """
 
173
    outf = StringIO()
 
174
    if stacklevel is None:
 
175
        limit = None
 
176
    else:
 
177
        limit = stacklevel + 1
 
178
    traceback.print_stack(limit=limit, file=outf)
 
179
    formatted_lines = outf.getvalue().splitlines()
 
180
    formatted_stack = '\n'.join(formatted_lines[:-2])
 
181
    mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
125
182
 
126
183
 
127
184
def _rollover_trace_maybe(trace_fname):
131
188
        if size <= 4 << 20:
132
189
            return
133
190
        old_fname = trace_fname + '.old'
134
 
        from osutils import rename
135
 
        rename(trace_fname, old_fname)
 
191
        osutils.rename(trace_fname, old_fname)
136
192
    except OSError:
137
193
        return
138
194
 
139
195
 
140
 
def open_tracefile(tracefilename=None):
141
 
    # Messages are always written to here, so that we have some
142
 
    # information if something goes wrong.  In a future version this
143
 
    # file will be removed on successful completion.
144
 
    global _file_handler, _bzr_log_file
145
 
    import codecs
146
 
 
147
 
    if tracefilename is None:
148
 
        if sys.platform == 'win32':
149
 
            from bzrlib import win32utils
150
 
            home = win32utils.get_home_location()
151
 
        else:
152
 
            home = os.path.expanduser('~')
153
 
        tracefilename = os.path.join(home, '.bzr.log')
154
 
 
155
 
    trace_fname = os.path.expanduser(tracefilename)
156
 
    _rollover_trace_maybe(trace_fname)
 
196
def _get_bzr_log_filename():
 
197
    bzr_log = osutils.path_from_environ('BZR_LOG')
 
198
    if bzr_log:
 
199
        return bzr_log
 
200
    home = osutils.path_from_environ('BZR_HOME')
 
201
    if home is None:
 
202
        # GZ 2012-02-01: Logging to the home dir is bad, but XDG is unclear
 
203
        #                over what would be better. On windows, bug 240550
 
204
        #                suggests LOCALAPPDATA be used instead.
 
205
        home = osutils._get_home_dir()
 
206
    return os.path.join(home, '.bzr.log')
 
207
 
 
208
 
 
209
def _open_bzr_log():
 
210
    """Open the .bzr.log trace file.
 
211
 
 
212
    If the log is more than a particular length, the old file is renamed to
 
213
    .bzr.log.old and a new file is started.  Otherwise, we append to the
 
214
    existing file.
 
215
 
 
216
    This sets the global _bzr_log_filename.
 
217
    """
 
218
    global _bzr_log_filename
 
219
 
 
220
    def _open_or_create_log_file(filename):
 
221
        """Open existing log file, or create with ownership and permissions
 
222
 
 
223
        It inherits the ownership and permissions (masked by umask) from
 
224
        the containing directory to cope better with being run under sudo
 
225
        with $HOME still set to the user's homedir.
 
226
        """
 
227
        flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
 
228
        while True:
 
229
            try:
 
230
                fd = os.open(filename, flags)
 
231
                break
 
232
            except OSError, e:
 
233
                if e.errno != errno.ENOENT:
 
234
                    raise
 
235
            try:
 
236
                fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
 
237
            except OSError, e:
 
238
                if e.errno != errno.EEXIST:
 
239
                    raise
 
240
            else:
 
241
                osutils.copy_ownership_from_path(filename)
 
242
                break
 
243
        return os.fdopen(fd, 'at', 0) # unbuffered
 
244
 
 
245
 
 
246
    _bzr_log_filename = _get_bzr_log_filename()
 
247
    _rollover_trace_maybe(_bzr_log_filename)
157
248
    try:
158
 
        LINE_BUFFERED = 1
159
 
        #tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
160
 
        tf = open(trace_fname, 'at', LINE_BUFFERED)
161
 
        _bzr_log_file = tf
162
 
        # tf.tell() on windows always return 0 until some writing done
163
 
        tf.write('\n')
164
 
        if tf.tell() <= 2:
165
 
            tf.write("this is a debug log for diagnosing/reporting problems in bzr\n")
166
 
            tf.write("you can delete or truncate this file, or include sections in\n")
167
 
            tf.write("bug reports to bazaar@lists.canonical.com\n\n")
168
 
        _file_handler = logging.StreamHandler(tf)
169
 
        fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
170
 
        datefmt = r'%a %H:%M:%S'
171
 
        _file_handler.setFormatter(logging.Formatter(fmt, datefmt))
172
 
        _file_handler.setLevel(logging.DEBUG)
173
 
        logging.getLogger('').addHandler(_file_handler)
174
 
    except IOError, e:
175
 
        warning("failed to open trace file: %s" % (e))
176
 
 
177
 
 
178
 
@deprecated_function(zero_nine)
179
 
def log_exception(msg=None):
180
 
    """Log the last exception to stderr and the trace file.
181
 
 
182
 
    The exception string representation is used as the error
183
 
    summary, unless msg is given.
184
 
 
185
 
    Please see log_exception_quietly() for the replacement API.
186
 
    """
187
 
    if msg:
188
 
        error(msg)
189
 
    log_exception_quietly()
 
249
        bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
 
250
        bzr_log_file.write('\n')
 
251
        if bzr_log_file.tell() <= 2:
 
252
            bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
 
253
            bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
 
254
            bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
 
255
 
 
256
        return bzr_log_file
 
257
 
 
258
    except EnvironmentError, e:
 
259
        # If we are failing to open the log, then most likely logging has not
 
260
        # been set up yet. So we just write to stderr rather than using
 
261
        # 'warning()'. If we using warning(), users get the unhelpful 'no
 
262
        # handlers registered for "bzr"' when something goes wrong on the
 
263
        # server. (bug #503886)
 
264
        sys.stderr.write("failed to open trace file: %s\n" % (e,))
 
265
    # TODO: What should happen if we fail to open the trace file?  Maybe the
 
266
    # objects should be pointed at /dev/null or the equivalent?  Currently
 
267
    # returns None which will cause failures later.
 
268
    return None
 
269
 
 
270
 
 
271
def enable_default_logging():
 
272
    """Configure default logging: messages to stderr and debug to .bzr.log
 
273
 
 
274
    This should only be called once per process.
 
275
 
 
276
    Non-command-line programs embedding bzrlib do not need to call this.  They
 
277
    can instead either pass a file to _push_log_file, or act directly on
 
278
    logging.getLogger("bzr").
 
279
 
 
280
    Output can be redirected away by calling _push_log_file.
 
281
 
 
282
    :return: A memento from push_log_file for restoring the log state.
 
283
    """
 
284
    start_time = osutils.format_local_date(_bzr_log_start_time,
 
285
                                           timezone='local')
 
286
    bzr_log_file = _open_bzr_log()
 
287
    if bzr_log_file is not None:
 
288
        bzr_log_file.write(start_time.encode('utf-8') + '\n')
 
289
    memento = push_log_file(bzr_log_file,
 
290
        r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
 
291
        r'%Y-%m-%d %H:%M:%S')
 
292
    # after hooking output into bzr_log, we also need to attach a stderr
 
293
    # handler, writing only at level info and with encoding
 
294
    stderr_handler = EncodedStreamHandler(sys.stderr,
 
295
        osutils.get_terminal_encoding(), 'replace', level=logging.INFO)
 
296
    logging.getLogger('bzr').addHandler(stderr_handler)
 
297
    return memento
 
298
 
 
299
 
 
300
def push_log_file(to_file, log_format=None, date_format=None):
 
301
    """Intercept log and trace messages and send them to a file.
 
302
 
 
303
    :param to_file: A file-like object to which messages will be sent.
 
304
 
 
305
    :returns: A memento that should be passed to _pop_log_file to restore the
 
306
        previously active logging.
 
307
    """
 
308
    global _trace_file
 
309
    # make a new handler
 
310
    new_handler = EncodedStreamHandler(to_file, "utf-8", level=logging.DEBUG)
 
311
    if log_format is None:
 
312
        log_format = '%(levelname)8s  %(message)s'
 
313
    new_handler.setFormatter(logging.Formatter(log_format, date_format))
 
314
    # save and remove any existing log handlers
 
315
    bzr_logger = logging.getLogger('bzr')
 
316
    old_handlers = bzr_logger.handlers[:]
 
317
    del bzr_logger.handlers[:]
 
318
    # set that as the default logger
 
319
    bzr_logger.addHandler(new_handler)
 
320
    bzr_logger.setLevel(logging.DEBUG)
 
321
    # TODO: check if any changes are needed to the root logger
 
322
    #
 
323
    # TODO: also probably need to save and restore the level on bzr_logger.
 
324
    # but maybe we can avoid setting the logger level altogether, and just set
 
325
    # the level on the handler?
 
326
    #
 
327
    # save the old trace file
 
328
    old_trace_file = _trace_file
 
329
    # send traces to the new one
 
330
    _trace_file = to_file
 
331
    result = new_handler, _trace_file
 
332
    return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
 
333
 
 
334
 
 
335
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
 
336
    """Undo changes to logging/tracing done by _push_log_file.
 
337
 
 
338
    This flushes, but does not close the trace file (so that anything that was
 
339
    in it is output.
 
340
 
 
341
    Takes the memento returned from _push_log_file."""
 
342
    global _trace_file
 
343
    _trace_file = old_trace_file
 
344
    bzr_logger = logging.getLogger('bzr')
 
345
    bzr_logger.removeHandler(new_handler)
 
346
    # must be closed, otherwise logging will try to close it at exit, and the
 
347
    # file will likely already be closed underneath.
 
348
    new_handler.close()
 
349
    bzr_logger.handlers = old_handlers
 
350
    if new_trace_file is not None:
 
351
        new_trace_file.flush()
190
352
 
191
353
 
192
354
def log_exception_quietly():
193
355
    """Log the last exception to the trace file only.
194
356
 
195
 
    Used for exceptions that occur internally and that may be 
196
 
    interesting to developers but not to users.  For example, 
 
357
    Used for exceptions that occur internally and that may be
 
358
    interesting to developers but not to users.  For example,
197
359
    errors loading plugins.
198
360
    """
199
 
    import traceback
200
361
    mutter(traceback.format_exc())
201
362
 
202
363
 
203
 
def enable_default_logging():
204
 
    """Configure default logging to stderr and .bzr.log"""
205
 
    # FIXME: if this is run twice, things get confused
206
 
    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
207
 
    _stderr_handler = logging.StreamHandler()
208
 
    logging.getLogger('').addHandler(_stderr_handler)
209
 
    _stderr_handler.setLevel(logging.INFO)
210
 
    if not _file_handler:
211
 
        open_tracefile()
212
 
    _trace_file = _bzr_log_file
213
 
    if _file_handler:
214
 
        _file_handler.setLevel(logging.DEBUG)
215
 
    _bzr_logger.setLevel(logging.DEBUG)
 
364
def set_verbosity_level(level):
 
365
    """Set the verbosity level.
 
366
 
 
367
    :param level: -ve for quiet, 0 for normal, +ve for verbose
 
368
    """
 
369
    global _verbosity_level
 
370
    _verbosity_level = level
 
371
    _update_logging_level(level < 0)
 
372
    ui.ui_factory.be_quiet(level < 0)
 
373
 
 
374
 
 
375
def get_verbosity_level():
 
376
    """Get the verbosity level.
 
377
 
 
378
    See set_verbosity_level() for values.
 
379
    """
 
380
    return _verbosity_level
216
381
 
217
382
 
218
383
def be_quiet(quiet=True):
219
 
    global _stderr_handler, _stderr_quiet
220
 
    
221
 
    _stderr_quiet = quiet
222
 
    if quiet:
223
 
        _stderr_handler.setLevel(logging.WARNING)
224
 
    else:
225
 
        _stderr_handler.setLevel(logging.INFO)
 
384
    if quiet:
 
385
        set_verbosity_level(-1)
 
386
    else:
 
387
        set_verbosity_level(0)
 
388
 
 
389
 
 
390
def _update_logging_level(quiet=True):
 
391
    """Hide INFO messages if quiet."""
 
392
    if quiet:
 
393
        _bzr_logger.setLevel(logging.WARNING)
 
394
    else:
 
395
        _bzr_logger.setLevel(logging.INFO)
226
396
 
227
397
 
228
398
def is_quiet():
229
 
    global _stderr_quiet
230
 
    return _stderr_quiet
231
 
 
232
 
 
233
 
def disable_default_logging():
234
 
    """Turn off default log handlers.
235
 
 
236
 
    This is intended to be used by the test framework, which doesn't
237
 
    want leakage from the code-under-test into the main logs.
238
 
    """
239
 
 
240
 
    l = logging.getLogger('')
241
 
    l.removeHandler(_stderr_handler)
242
 
    if _file_handler:
243
 
        l.removeHandler(_file_handler)
244
 
    _trace_file = None
245
 
 
246
 
 
247
 
def enable_test_log(to_file):
248
 
    """Redirect logging to a temporary file for a test
249
 
    
250
 
    returns an opaque reference that should be passed to disable_test_log
251
 
    after the test completes.
252
 
    """
253
 
    disable_default_logging()
254
 
    global _trace_file
255
 
    global _trace_depth
256
 
    hdlr = logging.StreamHandler(to_file)
257
 
    hdlr.setLevel(logging.DEBUG)
258
 
    hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
259
 
    _bzr_logger.addHandler(hdlr)
260
 
    _bzr_logger.setLevel(logging.DEBUG)
261
 
    result = hdlr, _trace_file, _trace_depth
262
 
    _trace_file = to_file
263
 
    _trace_depth += 1
264
 
    return result
265
 
 
266
 
 
267
 
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
268
 
    _bzr_logger.removeHandler(test_log_hdlr)
269
 
    test_log_hdlr.close()
270
 
    global _trace_file
271
 
    global _trace_depth
272
 
    _trace_file = old_trace_file
273
 
    _trace_depth = old_trace_depth
274
 
    if not _trace_depth:
275
 
        enable_default_logging()
 
399
    """Is the verbosity level negative?"""
 
400
    return _verbosity_level < 0
 
401
 
 
402
 
 
403
def is_verbose():
 
404
    """Is the verbosity level positive?"""
 
405
    return _verbosity_level > 0
 
406
 
 
407
 
 
408
def debug_memory(message='', short=True):
 
409
    """Write out a memory dump."""
 
410
    if sys.platform == 'win32':
 
411
        from bzrlib import win32utils
 
412
        win32utils.debug_memory_win32api(message=message, short=short)
 
413
    else:
 
414
        _debug_memory_proc(message=message, short=short)
 
415
 
 
416
 
 
417
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
 
418
 
 
419
def _debug_memory_proc(message='', short=True):
 
420
    try:
 
421
        status_file = file('/proc/%s/status' % os.getpid(), 'rb')
 
422
    except IOError:
 
423
        return
 
424
    try:
 
425
        status = status_file.read()
 
426
    finally:
 
427
        status_file.close()
 
428
    if message:
 
429
        note(message)
 
430
    for line in status.splitlines():
 
431
        if not short:
 
432
            note(line)
 
433
        else:
 
434
            for field in _short_fields:
 
435
                if line.startswith(field):
 
436
                    note(line)
 
437
                    break
 
438
 
 
439
def _dump_memory_usage(err_file):
 
440
    try:
 
441
        try:
 
442
            fd, name = tempfile.mkstemp(prefix="bzr_memdump", suffix=".json")
 
443
            dump_file = os.fdopen(fd, 'w')
 
444
            from meliae import scanner
 
445
            scanner.dump_gc_objects(dump_file)
 
446
            err_file.write("Memory dumped to %s\n" % name)
 
447
        except ImportError:
 
448
            err_file.write("Dumping memory requires meliae module.\n")
 
449
            log_exception_quietly()
 
450
        except:
 
451
            err_file.write("Exception while dumping memory.\n")
 
452
            log_exception_quietly()
 
453
    finally:
 
454
        if dump_file is not None:
 
455
            dump_file.close()
 
456
        elif fd is not None:
 
457
            os.close(fd)
 
458
 
 
459
 
 
460
def _qualified_exception_name(eclass, unqualified_bzrlib_errors=False):
 
461
    """Give name of error class including module for non-builtin exceptions
 
462
 
 
463
    If `unqualified_bzrlib_errors` is True, errors specific to bzrlib will
 
464
    also omit the module prefix.
 
465
    """
 
466
    class_name = eclass.__name__
 
467
    module_name = eclass.__module__
 
468
    if module_name in ("exceptions", "__main__") or (
 
469
            unqualified_bzrlib_errors and module_name == "bzrlib.errors"):
 
470
        return class_name
 
471
    return "%s.%s" % (module_name, class_name)
276
472
 
277
473
 
278
474
def report_exception(exc_info, err_file):
279
 
    exc_type, exc_object, exc_tb = exc_info
 
475
    """Report an exception to err_file (typically stderr) and to .bzr.log.
 
476
 
 
477
    This will show either a full traceback or a short message as appropriate.
 
478
 
 
479
    :return: The appropriate exit code for this error.
 
480
    """
280
481
    # Log the full traceback to ~/.bzr.log
281
482
    log_exception_quietly()
282
 
    if (isinstance(exc_object, IOError)
283
 
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
284
 
        print >>err_file, "bzr: broken pipe"
285
 
    elif isinstance(exc_object, KeyboardInterrupt):
286
 
        print >>err_file, "bzr: interrupted"
 
483
    if 'error' in debug.debug_flags:
 
484
        print_exception(exc_info, err_file)
 
485
        return errors.EXIT_ERROR
 
486
    exc_type, exc_object, exc_tb = exc_info
 
487
    if isinstance(exc_object, KeyboardInterrupt):
 
488
        err_file.write("bzr: interrupted\n")
 
489
        return errors.EXIT_ERROR
 
490
    elif isinstance(exc_object, MemoryError):
 
491
        err_file.write("bzr: out of memory\n")
 
492
        if 'mem_dump' in debug.debug_flags:
 
493
            _dump_memory_usage(err_file)
 
494
        else:
 
495
            err_file.write("Use -Dmem_dump to dump memory to a file.\n")
 
496
        return errors.EXIT_ERROR
 
497
    elif isinstance(exc_object, ImportError) \
 
498
        and str(exc_object).startswith("No module named "):
 
499
        report_user_error(exc_info, err_file,
 
500
            'You may need to install this Python library separately.')
 
501
        return errors.EXIT_ERROR
287
502
    elif not getattr(exc_object, 'internal_error', True):
288
503
        report_user_error(exc_info, err_file)
289
 
    elif isinstance(exc_object, (OSError, IOError)):
 
504
        return errors.EXIT_ERROR
 
505
    elif osutils.is_environment_error(exc_object):
 
506
        if getattr(exc_object, 'errno', None) == errno.EPIPE:
 
507
            err_file.write("bzr: broken pipe\n")
 
508
            return errors.EXIT_ERROR
290
509
        # Might be nice to catch all of these and show them as something more
291
510
        # specific, but there are too many cases at the moment.
292
511
        report_user_error(exc_info, err_file)
 
512
        return errors.EXIT_ERROR
293
513
    else:
294
514
        report_bug(exc_info, err_file)
 
515
        return errors.EXIT_INTERNAL_ERROR
 
516
 
 
517
 
 
518
def print_exception(exc_info, err_file):
 
519
    exc_type, exc_object, exc_tb = exc_info
 
520
    err_file.write("bzr: ERROR: %s.%s: %s\n" % (
 
521
        exc_type.__module__, exc_type.__name__, exc_object))
 
522
    err_file.write('\n')
 
523
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
295
524
 
296
525
 
297
526
# TODO: Should these be specially encoding the output?
298
 
def report_user_error(exc_info, err_file):
 
527
def report_user_error(exc_info, err_file, advice=None):
299
528
    """Report to err_file an error that's not an internal error.
300
529
 
301
530
    These don't get a traceback unless -Derror was given.
 
531
 
 
532
    :param exc_info: 3-tuple from sys.exc_info()
 
533
    :param advice: Extra advice to the user to be printed following the
 
534
        exception.
302
535
    """
303
 
    if 'error' in debug.debug_flags:
304
 
        report_bug(exc_info, err_file)
305
 
        return
306
 
    print >>err_file, "bzr: ERROR:", str(exc_info[1])
 
536
    err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
 
537
    if advice:
 
538
        err_file.write("%s\n" % (advice,))
307
539
 
308
540
 
309
541
def report_bug(exc_info, err_file):
310
542
    """Report an exception that probably indicates a bug in bzr"""
311
 
    import traceback
312
 
    exc_type, exc_object, exc_tb = exc_info
313
 
    print >>err_file, "bzr: ERROR: %s.%s: %s" % (
314
 
        exc_type.__module__, exc_type.__name__, exc_object)
315
 
    print >>err_file
316
 
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
317
 
    print >>err_file
318
 
    print >>err_file, 'bzr %s on python %s (%s)' % \
319
 
                       (bzrlib.__version__,
320
 
                        '.'.join(map(str, sys.version_info)),
321
 
                        sys.platform)
322
 
    print >>err_file, 'arguments: %r' % sys.argv
323
 
    print >>err_file
324
 
    print >>err_file, "** please send this report to bazaar@lists.ubuntu.com"
 
543
    from bzrlib.crash import report_bug
 
544
    report_bug(exc_info, err_file)
 
545
 
 
546
 
 
547
def _flush_stdout_stderr():
 
548
    # called from the bzrlib library finalizer returned by bzrlib.initialize()
 
549
    try:
 
550
        sys.stdout.flush()
 
551
        sys.stderr.flush()
 
552
    except ValueError, e:
 
553
        # On Windows, I get ValueError calling stdout.flush() on a closed
 
554
        # handle
 
555
        pass
 
556
    except IOError, e:
 
557
        import errno
 
558
        if e.errno in [errno.EINVAL, errno.EPIPE]:
 
559
            pass
 
560
        else:
 
561
            raise
 
562
 
 
563
 
 
564
def _flush_trace():
 
565
    # called from the bzrlib library finalizer returned by bzrlib.initialize()
 
566
    global _trace_file
 
567
    if _trace_file:
 
568
        _trace_file.flush()
 
569
 
 
570
 
 
571
class EncodedStreamHandler(logging.Handler):
 
572
    """Robustly write logging events to a stream using the specified encoding
 
573
 
 
574
    Messages are expected to be formatted to unicode, but UTF-8 byte strings
 
575
    are also accepted. An error during formatting or a str message in another
 
576
    encoding will be quitely noted as an error in the Bazaar log file.
 
577
 
 
578
    The stream is not closed so sys.stdout or sys.stderr may be passed.
 
579
    """
 
580
 
 
581
    def __init__(self, stream, encoding=None, errors='strict', level=0):
 
582
        logging.Handler.__init__(self, level)
 
583
        self.stream = stream
 
584
        if encoding is None:
 
585
            encoding = getattr(stream, "encoding", "ascii")
 
586
        self.encoding = encoding
 
587
        self.errors = errors
 
588
 
 
589
    def flush(self):
 
590
        flush = getattr(self.stream, "flush", None)
 
591
        if flush is not None:
 
592
            flush()
 
593
 
 
594
    def emit(self, record):
 
595
        try:
 
596
            line = self.format(record)
 
597
            if not isinstance(line, unicode):
 
598
                line = line.decode("utf-8")
 
599
            self.stream.write(line.encode(self.encoding, self.errors) + "\n")
 
600
        except Exception:
 
601
            log_exception_quietly()
 
602
            # Try saving the details that would have been logged in some form
 
603
            msg = args = "<Unformattable>"
 
604
            try:
 
605
                msg = repr(record.msg).encode("ascii")
 
606
                args = repr(record.args).encode("ascii")
 
607
            except Exception:
 
608
                pass
 
609
            # Using mutter() bypasses the logging module and writes directly
 
610
            # to the file so there's no danger of getting into a loop here.
 
611
            mutter("Logging record unformattable: %s %% %s", msg, args)
 
612
 
 
613
 
 
614
class Config(object):
 
615
    """Configuration of message tracing in bzrlib.
 
616
 
 
617
    This implements the context manager protocol and should manage any global
 
618
    variables still used. The default config used is DefaultConfig, but
 
619
    embedded uses of bzrlib may wish to use a custom manager.
 
620
    """
 
621
 
 
622
    def __enter__(self):
 
623
        return self # This is bound to the 'as' clause in a with statement.
 
624
 
 
625
    def __exit__(self, exc_type, exc_val, exc_tb):
 
626
        return False # propogate exceptions.
 
627
 
 
628
 
 
629
class DefaultConfig(Config):
 
630
    """A default configuration for tracing of messages in bzrlib.
 
631
 
 
632
    This implements the context manager protocol.
 
633
    """
 
634
 
 
635
    def __enter__(self):
 
636
        self._original_filename = _bzr_log_filename
 
637
        self._original_state = enable_default_logging()
 
638
        return self # This is bound to the 'as' clause in a with statement.
 
639
 
 
640
    def __exit__(self, exc_type, exc_val, exc_tb):
 
641
        pop_log_file(self._original_state)
 
642
        global _bzr_log_filename
 
643
        _bzr_log_filename = self._original_filename
 
644
        return False # propogate exceptions.