← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/trace.py

Merge bzr.dev (via NO_SMART_VFS branch).

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/trace.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
"""Messages and logging.
 
17
"""Messages and logging for bazaar-ng.
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 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.
37
38
 
38
39
Errors that terminate an operation are generally passed back as exceptions;
39
40
others may be just emitted as messages.
48
49
# FIXME: Unfortunately it turns out that python's logging module
49
50
# is quite expensive, even when the message is not printed by any handlers.
50
51
# We should perhaps change back to just simply doing it here.
51
 
#
52
 
# On the other hand, as of 1.2 we generally only call the mutter() statement
53
 
# if (according to debug_flags) we actually intend to write it.  So the
54
 
# increased cost of logging.py is not so bad, and we could standardize on
55
 
# that.
56
52
 
57
 
import codecs
58
 
import logging
59
53
import os
 
54
import re
60
55
import sys
61
 
import time
62
56
 
63
57
from bzrlib.lazy_import import lazy_import
64
58
lazy_import(globals(), """
 
59
import errno
 
60
import logging
65
61
from cStringIO import StringIO
66
 
import errno
67
 
import locale
68
 
import traceback
69
62
""")
70
63
 
71
64
import bzrlib
72
 
 
73
 
from bzrlib.symbol_versioning import (
74
 
    deprecated_function,
75
 
    deprecated_in,
76
 
    )
 
65
from bzrlib.symbol_versioning import (deprecated_function,
 
66
        zero_nine,
 
67
        )
77
68
 
78
69
lazy_import(globals(), """
79
 
from bzrlib import (
80
 
    debug,
81
 
    errors,
82
 
    osutils,
83
 
    plugin,
84
 
    symbol_versioning,
85
 
    ui,
86
 
    )
 
70
from bzrlib import debug
87
71
""")
88
72
 
89
 
 
90
 
# global verbosity for bzrlib; controls the log level for stderr; 0=normal; <0
91
 
# is quiet; >0 is verbose.
92
 
_verbosity_level = 0
93
 
 
94
 
# File-like object where mutter/debug output is currently sent.  Can be
95
 
# changed by _push_log_file etc.  This is directly manipulated by some
96
 
# external code; maybe there should be functions to do that more precisely
97
 
# than push/pop_log_file.
 
73
_file_handler = None
 
74
_stderr_handler = None
 
75
_stderr_quiet = False
98
76
_trace_file = None
99
 
 
100
 
# Absolute path for ~/.bzr.log.  Not changed even if the log/trace output is
101
 
# redirected elsewhere.  Used to show the location in --version.
102
 
_bzr_log_filename = None
103
 
 
104
 
# The time the first message was written to the trace file, so that we can
105
 
# show relative times since startup.
106
 
_bzr_log_start_time = bzrlib._start_time
107
 
 
108
 
 
109
 
# held in a global for quick reference
 
77
_trace_depth = 0
 
78
_bzr_log_file = None
 
79
_use_apport = True
 
80
 
 
81
 
 
82
# configure convenient aliases for output routines
 
83
 
110
84
_bzr_logger = logging.getLogger('bzr')
111
85
 
112
 
 
113
86
def note(*args, **kwargs):
114
 
    """Output a note to the user.
115
 
 
116
 
    Takes the same parameters as logging.info.
117
 
 
118
 
    :return: None
119
 
    """
120
87
    # FIXME note always emits utf-8, regardless of the terminal encoding
121
 
    #
122
 
    # FIXME: clearing the ui and then going through the abstract logging
123
 
    # framework is whack; we should probably have a logging Handler that
124
 
    # deals with terminal output if needed.
125
88
    import bzrlib.ui
126
89
    bzrlib.ui.ui_factory.clear_term()
127
90
    _bzr_logger.info(*args, **kwargs)
128
91
 
129
 
 
130
92
def warning(*args, **kwargs):
131
93
    import bzrlib.ui
132
94
    bzrlib.ui.ui_factory.clear_term()
133
95
    _bzr_logger.warning(*args, **kwargs)
134
96
 
135
 
 
136
 
@deprecated_function(deprecated_in((2, 1, 0)))
137
 
def info(*args, **kwargs):
138
 
    """Deprecated: use trace.note instead."""
139
 
    note(*args, **kwargs)
140
 
 
141
 
 
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)
146
 
 
147
 
 
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)
152
 
 
153
 
 
154
 
def show_error(*args, **kwargs):
155
 
    """Show an error message to the user.
156
 
 
157
 
    Don't use this for exceptions, use report_exception instead.
158
 
    """
159
 
    _bzr_logger.error(*args, **kwargs)
 
97
info = note
 
98
log_error = _bzr_logger.error
 
99
error =     _bzr_logger.error
160
100
 
161
101
 
162
102
def mutter(fmt, *args):
163
103
    if _trace_file is None:
164
104
        return
165
 
    # XXX: Don't check this every time; instead anyone who closes the file
166
 
    # ought to deregister it.  We can tolerate None.
167
105
    if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
168
106
        return
169
107
 
182
120
        out = fmt % tuple(real_args)
183
121
    else:
184
122
        out = fmt
185
 
    now = time.time()
186
 
    timestamp = '%0.3f  ' % (now - _bzr_log_start_time,)
187
 
    out = timestamp + out + '\n'
 
123
    out += '\n'
188
124
    _trace_file.write(out)
189
 
    # there's no explicit flushing; the file is typically line buffered.
190
 
 
191
 
 
192
 
def mutter_callsite(stacklevel, fmt, *args):
193
 
    """Perform a mutter of fmt and args, logging the call trace.
194
 
 
195
 
    :param stacklevel: The number of frames to show. None will show all
196
 
        frames.
197
 
    :param fmt: The format string to pass to mutter.
198
 
    :param args: A list of substitution variables.
199
 
    """
200
 
    outf = StringIO()
201
 
    if stacklevel is None:
202
 
        limit = None
203
 
    else:
204
 
        limit = stacklevel + 1
205
 
    traceback.print_stack(limit=limit, file=outf)
206
 
    formatted_lines = outf.getvalue().splitlines()
207
 
    formatted_stack = '\n'.join(formatted_lines[:-2])
208
 
    mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
 
125
    # TODO: jam 20051227 Consider flushing the trace file to help debugging
 
126
    #_trace_file.flush()
209
127
 
210
128
 
211
129
def _rollover_trace_maybe(trace_fname):
215
133
        if size <= 4 << 20:
216
134
            return
217
135
        old_fname = trace_fname + '.old'
218
 
        osutils.rename(trace_fname, old_fname)
 
136
        from osutils import rename
 
137
        rename(trace_fname, old_fname)
219
138
    except OSError:
220
139
        return
221
140
 
222
141
 
223
 
def _get_bzr_log_filename():
224
 
    bzr_log = os.environ.get('BZR_LOG')
225
 
    if bzr_log:
226
 
        return bzr_log
227
 
    home = os.environ.get('BZR_HOME')
228
 
    if home is None:
229
 
        if sys.platform == 'win32':
230
 
            from bzrlib import win32utils
231
 
            home = win32utils.get_home_location()
232
 
        else:
233
 
            home = os.path.expanduser('~')
234
 
    return os.path.join(home, '.bzr.log')
235
 
 
236
 
 
237
 
def _open_bzr_log():
238
 
    """Open the .bzr.log trace file.
239
 
 
240
 
    If the log is more than a particular length, the old file is renamed to
241
 
    .bzr.log.old and a new file is started.  Otherwise, we append to the
242
 
    existing file.
243
 
 
244
 
    This sets the global _bzr_log_filename.
245
 
    """
246
 
    global _bzr_log_filename
247
 
 
248
 
    def _open_or_create_log_file(filename):
249
 
        """Open existing log file, or create with ownership and permissions
250
 
 
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.
254
 
        """
255
 
        flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
256
 
        while True:
257
 
            try:
258
 
                fd = os.open(filename, flags)
259
 
                break
260
 
            except OSError, e:
261
 
                if e.errno != errno.ENOENT:
262
 
                    raise
263
 
            try:
264
 
                fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
265
 
            except OSError, e:
266
 
                if e.errno != errno.EEXIST:
267
 
                    raise
268
 
            else:
269
 
                osutils.copy_ownership_from_path(filename)
270
 
                break
271
 
        return os.fdopen(fd, 'at', 0) # unbuffered
272
 
 
273
 
 
274
 
    _bzr_log_filename = _get_bzr_log_filename()
275
 
    _rollover_trace_maybe(_bzr_log_filename)
 
142
def open_tracefile(tracefilename='~/.bzr.log'):
 
143
    # Messages are always written to here, so that we have some
 
144
    # information if something goes wrong.  In a future version this
 
145
    # file will be removed on successful completion.
 
146
    global _file_handler, _bzr_log_file
 
147
    import codecs
 
148
 
 
149
    trace_fname = os.path.join(os.path.expanduser(tracefilename))
 
150
    _rollover_trace_maybe(trace_fname)
276
151
    try:
277
 
        bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
278
 
        bzr_log_file.write('\n')
279
 
        if bzr_log_file.tell() <= 2:
280
 
            bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
281
 
            bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
282
 
            bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
283
 
 
284
 
        return bzr_log_file
285
 
 
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,))
293
 
    # TODO: What should happen if we fail to open the trace file?  Maybe the
294
 
    # objects should be pointed at /dev/null or the equivalent?  Currently
295
 
    # returns None which will cause failures later.
296
 
    return None
297
 
 
298
 
 
299
 
def enable_default_logging():
300
 
    """Configure default logging: messages to stderr and debug to .bzr.log
301
 
 
302
 
    This should only be called once per process.
303
 
 
304
 
    Non-command-line programs embedding bzrlib do not need to call this.  They
305
 
    can instead either pass a file to _push_log_file, or act directly on
306
 
    logging.getLogger("bzr").
307
 
 
308
 
    Output can be redirected away by calling _push_log_file.
309
 
    """
310
 
    # Do this before we open the log file, so we prevent
311
 
    # get_terminal_encoding() from mutter()ing multiple times
312
 
    term_encoding = osutils.get_terminal_encoding()
313
 
    start_time = osutils.format_local_date(_bzr_log_start_time,
314
 
                                           timezone='local')
315
 
    # create encoded wrapper around stderr
316
 
    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')
319
 
    push_log_file(bzr_log_file,
320
 
        r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
321
 
        r'%Y-%m-%d %H:%M:%S')
322
 
    # after hooking output into bzr_log, we also need to attach a stderr
323
 
    # handler, writing only at level info and with encoding
324
 
    writer_factory = codecs.getwriter(term_encoding)
325
 
    encoded_stderr = writer_factory(sys.stderr, errors='replace')
326
 
    stderr_handler = logging.StreamHandler(encoded_stderr)
327
 
    stderr_handler.setLevel(logging.INFO)
328
 
    logging.getLogger('bzr').addHandler(stderr_handler)
329
 
 
330
 
 
331
 
def push_log_file(to_file, log_format=None, date_format=None):
332
 
    """Intercept log and trace messages and send them to a file.
333
 
 
334
 
    :param to_file: A file-like object to which messages will be sent.
335
 
 
336
 
    :returns: A memento that should be passed to _pop_log_file to restore the
337
 
    previously active logging.
338
 
    """
339
 
    global _trace_file
340
 
    # make a new handler
341
 
    new_handler = logging.StreamHandler(to_file)
342
 
    new_handler.setLevel(logging.DEBUG)
343
 
    if log_format is None:
344
 
        log_format = '%(levelname)8s  %(message)s'
345
 
    new_handler.setFormatter(logging.Formatter(log_format, date_format))
346
 
    # save and remove any existing log handlers
347
 
    bzr_logger = logging.getLogger('bzr')
348
 
    old_handlers = bzr_logger.handlers[:]
349
 
    del bzr_logger.handlers[:]
350
 
    # set that as the default logger
351
 
    bzr_logger.addHandler(new_handler)
352
 
    bzr_logger.setLevel(logging.DEBUG)
353
 
    # TODO: check if any changes are needed to the root logger
354
 
    #
355
 
    # TODO: also probably need to save and restore the level on bzr_logger.
356
 
    # but maybe we can avoid setting the logger level altogether, and just set
357
 
    # the level on the handler?
358
 
    #
359
 
    # save the old trace file
360
 
    old_trace_file = _trace_file
361
 
    # send traces to the new one
362
 
    _trace_file = to_file
363
 
    result = new_handler, _trace_file
364
 
    return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
365
 
 
366
 
 
367
 
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
368
 
    """Undo changes to logging/tracing done by _push_log_file.
369
 
 
370
 
    This flushes, but does not close the trace file.
371
 
 
372
 
    Takes the memento returned from _push_log_file."""
373
 
    global _trace_file
374
 
    _trace_file = old_trace_file
375
 
    bzr_logger = logging.getLogger('bzr')
376
 
    bzr_logger.removeHandler(new_handler)
377
 
    # must be closed, otherwise logging will try to close it atexit, and the
378
 
    # file will likely already be closed underneath.
379
 
    new_handler.close()
380
 
    bzr_logger.handlers = old_handlers
381
 
    new_trace_file.flush()
 
152
        LINE_BUFFERED = 1
 
153
        #tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
 
154
        tf = open(trace_fname, 'at', LINE_BUFFERED)
 
155
        _bzr_log_file = tf
 
156
        if tf.tell() == 0:
 
157
            tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
 
158
            tf.write("you can delete or truncate this file, or include sections in\n")
 
159
            tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
 
160
        _file_handler = logging.StreamHandler(tf)
 
161
        fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
 
162
        datefmt = r'%a %H:%M:%S'
 
163
        _file_handler.setFormatter(logging.Formatter(fmt, datefmt))
 
164
        _file_handler.setLevel(logging.DEBUG)
 
165
        logging.getLogger('').addHandler(_file_handler)
 
166
    except IOError, e:
 
167
        warning("failed to open trace file: %s" % (e))
 
168
 
 
169
 
 
170
@deprecated_function(zero_nine)
 
171
def log_exception(msg=None):
 
172
    """Log the last exception to stderr and the trace file.
 
173
 
 
174
    The exception string representation is used as the error
 
175
    summary, unless msg is given.
 
176
    """
 
177
    if msg:
 
178
        error(msg)
 
179
    log_exception_quietly()
382
180
 
383
181
 
384
182
def log_exception_quietly():
385
183
    """Log the last exception to the trace file only.
386
184
 
387
 
    Used for exceptions that occur internally and that may be
388
 
    interesting to developers but not to users.  For example,
 
185
    Used for exceptions that occur internally and that may be 
 
186
    interesting to developers but not to users.  For example, 
389
187
    errors loading plugins.
390
188
    """
 
189
    import traceback
391
190
    mutter(traceback.format_exc())
392
191
 
393
192
 
394
 
def set_verbosity_level(level):
395
 
    """Set the verbosity level.
396
 
 
397
 
    :param level: -ve for quiet, 0 for normal, +ve for verbose
398
 
    """
399
 
    global _verbosity_level
400
 
    _verbosity_level = level
401
 
    _update_logging_level(level < 0)
402
 
    ui.ui_factory.be_quiet(level < 0)
403
 
 
404
 
 
405
 
def get_verbosity_level():
406
 
    """Get the verbosity level.
407
 
 
408
 
    See set_verbosity_level() for values.
409
 
    """
410
 
    return _verbosity_level
 
193
def enable_default_logging():
 
194
    """Configure default logging to stderr and .bzr.log"""
 
195
    # FIXME: if this is run twice, things get confused
 
196
    global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
 
197
    _stderr_handler = logging.StreamHandler()
 
198
    logging.getLogger('').addHandler(_stderr_handler)
 
199
    _stderr_handler.setLevel(logging.INFO)
 
200
    if not _file_handler:
 
201
        open_tracefile()
 
202
    _trace_file = _bzr_log_file
 
203
    if _file_handler:
 
204
        _file_handler.setLevel(logging.DEBUG)
 
205
    _bzr_logger.setLevel(logging.DEBUG)
411
206
 
412
207
 
413
208
def be_quiet(quiet=True):
414
 
    if quiet:
415
 
        set_verbosity_level(-1)
416
 
    else:
417
 
        set_verbosity_level(0)
418
 
 
419
 
 
420
 
def _update_logging_level(quiet=True):
421
 
    """Hide INFO messages if quiet."""
422
 
    if quiet:
423
 
        _bzr_logger.setLevel(logging.WARNING)
424
 
    else:
425
 
        _bzr_logger.setLevel(logging.INFO)
 
209
    global _stderr_handler, _stderr_quiet
 
210
    
 
211
    _stderr_quiet = quiet
 
212
    if quiet:
 
213
        _stderr_handler.setLevel(logging.WARNING)
 
214
    else:
 
215
        _stderr_handler.setLevel(logging.INFO)
426
216
 
427
217
 
428
218
def is_quiet():
429
 
    """Is the verbosity level negative?"""
430
 
    return _verbosity_level < 0
431
 
 
432
 
 
433
 
def is_verbose():
434
 
    """Is the verbosity level positive?"""
435
 
    return _verbosity_level > 0
436
 
 
437
 
 
438
 
def debug_memory(message='', short=True):
439
 
    """Write out a memory dump."""
440
 
    if sys.platform == 'win32':
441
 
        from bzrlib import win32utils
442
 
        win32utils.debug_memory_win32api(message=message, short=short)
443
 
    else:
444
 
        _debug_memory_proc(message=message, short=short)
445
 
 
446
 
 
447
 
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
448
 
 
449
 
def _debug_memory_proc(message='', short=True):
450
 
    try:
451
 
        status_file = file('/proc/%s/status' % os.getpid(), 'rb')
452
 
    except IOError:
453
 
        return
454
 
    try:
455
 
        status = status_file.read()
456
 
    finally:
457
 
        status_file.close()
458
 
    if message:
459
 
        note(message)
460
 
    for line in status.splitlines():
461
 
        if not short:
462
 
            note(line)
463
 
        else:
464
 
            for field in _short_fields:
465
 
                if line.startswith(field):
466
 
                    note(line)
467
 
                    break
 
219
    global _stderr_quiet
 
220
    return _stderr_quiet
 
221
 
 
222
 
 
223
def disable_default_logging():
 
224
    """Turn off default log handlers.
 
225
 
 
226
    This is intended to be used by the test framework, which doesn't
 
227
    want leakage from the code-under-test into the main logs.
 
228
    """
 
229
 
 
230
    l = logging.getLogger('')
 
231
    l.removeHandler(_stderr_handler)
 
232
    if _file_handler:
 
233
        l.removeHandler(_file_handler)
 
234
    _trace_file = None
 
235
 
 
236
 
 
237
def enable_test_log(to_file):
 
238
    """Redirect logging to a temporary file for a test
 
239
    
 
240
    returns an opaque reference that should be passed to disable_test_log
 
241
    after the test completes.
 
242
    """
 
243
    disable_default_logging()
 
244
    global _trace_file
 
245
    global _trace_depth
 
246
    hdlr = logging.StreamHandler(to_file)
 
247
    hdlr.setLevel(logging.DEBUG)
 
248
    hdlr.setFormatter(logging.Formatter('%(levelname)8s  %(message)s'))
 
249
    _bzr_logger.addHandler(hdlr)
 
250
    _bzr_logger.setLevel(logging.DEBUG)
 
251
    result = hdlr, _trace_file, _trace_depth
 
252
    _trace_file = to_file
 
253
    _trace_depth += 1
 
254
    return result
 
255
 
 
256
 
 
257
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
 
258
    _bzr_logger.removeHandler(test_log_hdlr)
 
259
    test_log_hdlr.close()
 
260
    global _trace_file
 
261
    global _trace_depth
 
262
    _trace_file = old_trace_file
 
263
    _trace_depth = old_trace_depth
 
264
    if not _trace_depth:
 
265
        enable_default_logging()
468
266
 
469
267
 
470
268
def report_exception(exc_info, err_file):
471
 
    """Report an exception to err_file (typically stderr) and to .bzr.log.
472
 
 
473
 
    This will show either a full traceback or a short message as appropriate.
474
 
 
475
 
    :return: The appropriate exit code for this error.
476
 
    """
 
269
    exc_type, exc_object, exc_tb = exc_info
477
270
    # Log the full traceback to ~/.bzr.log
478
271
    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
272
    if (isinstance(exc_object, IOError)
484
273
        and getattr(exc_object, 'errno', None) == errno.EPIPE):
485
 
        err_file.write("bzr: broken pipe\n")
486
 
        return errors.EXIT_ERROR
 
274
        print >>err_file, "bzr: broken pipe"
487
275
    elif 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
 
        return errors.EXIT_ERROR
493
 
    elif isinstance(exc_object, ImportError) \
494
 
        and str(exc_object).startswith("No module named "):
495
 
        report_user_error(exc_info, err_file,
496
 
            'You may need to install this Python library separately.')
497
 
        return errors.EXIT_ERROR
 
276
        print >>err_file, "bzr: interrupted"
498
277
    elif not getattr(exc_object, 'internal_error', True):
499
278
        report_user_error(exc_info, err_file)
500
 
        return errors.EXIT_ERROR
501
279
    elif isinstance(exc_object, (OSError, IOError)):
502
280
        # Might be nice to catch all of these and show them as something more
503
281
        # specific, but there are too many cases at the moment.
504
282
        report_user_error(exc_info, err_file)
505
 
        return errors.EXIT_ERROR
506
283
    else:
507
 
        report_bug(exc_info, err_file)
508
 
        return errors.EXIT_INTERNAL_ERROR
509
 
 
510
 
 
511
 
def print_exception(exc_info, err_file):
512
 
    exc_type, exc_object, exc_tb = exc_info
513
 
    err_file.write("bzr: ERROR: %s.%s: %s\n" % (
514
 
        exc_type.__module__, exc_type.__name__, exc_object))
515
 
    err_file.write('\n')
516
 
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
 
284
        return report_bug(exc_info, err_file)
517
285
 
518
286
 
519
287
# TODO: Should these be specially encoding the output?
520
 
def report_user_error(exc_info, err_file, advice=None):
 
288
def report_user_error(exc_info, err_file):
521
289
    """Report to err_file an error that's not an internal error.
522
290
 
523
291
    These don't get a traceback unless -Derror was given.
524
 
 
525
 
    :param exc_info: 3-tuple from sys.exc_info()
526
 
    :param advice: Extra advice to the user to be printed following the
527
 
        exception.
528
292
    """
529
 
    err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
530
 
    if advice:
531
 
        err_file.write("%s\n" % (advice,))
 
293
    if 'error' in debug.debug_flags:
 
294
        report_bug(exc_info, err_file)
 
295
        return
 
296
    print >>err_file, "bzr: ERROR:", str(exc_info[1])
532
297
 
533
298
 
534
299
def report_bug(exc_info, err_file):
535
300
    """Report an exception that probably indicates a bug in bzr"""
536
 
    from bzrlib.crash import report_bug
537
 
    report_bug(exc_info, err_file)
538
 
 
539
 
 
540
 
def _flush_stdout_stderr():
541
 
    # installed into an atexit hook by bzrlib.initialize()
542
 
    try:
543
 
        sys.stdout.flush()
544
 
        sys.stderr.flush()
545
 
    except IOError, e:
546
 
        import errno
547
 
        if e.errno in [errno.EINVAL, errno.EPIPE]:
548
 
            pass
549
 
        else:
550
 
            raise
551
 
 
552
 
 
553
 
def _flush_trace():
554
 
    # run from atexit hook
555
 
    global _trace_file
556
 
    if _trace_file:
557
 
        _trace_file.flush()
 
301
    # local import because its only needed here, and this is not a loop.
 
302
    import tempfile
 
303
    # local import because the other functions do it too.
 
304
    import traceback
 
305
    # local import due to circular dependency
 
306
    import bzrlib.plugin
 
307
    global _use_apport
 
308
    try:
 
309
        # detect apport presence.
 
310
        import apport_utils
 
311
        import problem_report
 
312
    except ImportError:
 
313
        # not present, dont use it.
 
314
        _use_apport = False
 
315
    if not _use_apport:
 
316
        # policy disabled, or not present, use the old ui.
 
317
        return _old_report_bug(exc_info, err_file)
 
318
 
 
319
    exc_type, exc_object, exc_tb = exc_info
 
320
    err_file.write(
 
321
        "bzr: ERROR: %s.%s: %s\n" % (
 
322
        exc_type.__module__, exc_type.__name__, exc_object)
 
323
        )
 
324
    report = problem_report.ProblemReport()
 
325
    report_file, report_filename = tempfile.mkstemp(
 
326
        suffix='.txt', prefix='bzr-crash-', dir='/tmp')
 
327
    python_report_file = os.fdopen(report_file, 'w')
 
328
    try:
 
329
        report['CommandLine'] = ' '.join(sys.argv)
 
330
        # assume we are packaged as bzr.
 
331
        apport_utils.report_add_package_info(report, 'bzr')
 
332
        report['BzrPlugins'] = ' '.join(bzrlib.plugin.all_plugins())
 
333
        tb_file = StringIO()
 
334
        traceback.print_exception(exc_type, exc_object, exc_tb, file=tb_file)
 
335
        report['Traceback'] = tb_file.getvalue()
 
336
        apport_utils.report_add_os_info(report)
 
337
        report.write(python_report_file)
 
338
        # give the user a pretty output.
 
339
 
 
340
        err_file.write(
 
341
            'This is an unexpected error within bzr and we would appreciate a bug report.\n'
 
342
            '\n'
 
343
            'bzr has written a crash report file that will assist our debugging of this\n'
 
344
            'in the file %s\n'
 
345
            '\n'
 
346
            'This is a plain text file, whose contents you can check if you have privacy\n'
 
347
            'concerns. We gather the package data about bzr, your command line, plugins\n'
 
348
            'And the backtrace from within bzr. If you had a password in the URL you\n'
 
349
            'provided to bzr, you should edit that file to remove the password.\n'
 
350
            '\n'
 
351
            '** To file a bug for this please visit our bugtracker at the URL \n'
 
352
            '"https://launchpad.net/products/bzr/+filebug" and report a bug describing\n'
 
353
            'what you were attempting and attach the bzr-crash file mentioned above.\n'
 
354
            'Alternatively you can email bazaar-ng@lists.canonical.com with the same\n'
 
355
            'description and attach the bzr-crash file to the email.\n' %
 
356
                report_filename
 
357
            )
 
358
    finally:
 
359
        python_report_file.close()
 
360
    return report, report_filename
 
361
 
 
362
def _old_report_bug(exc_info, err_file):
 
363
    """Write a synopsis of an exception that is probably a bug to err_file."""
 
364
    import traceback
 
365
    exc_type, exc_object, exc_tb = exc_info
 
366
    print >>err_file, "bzr: ERROR: %s.%s: %s" % (
 
367
        exc_type.__module__, exc_type.__name__, exc_object)
 
368
    print >>err_file
 
369
    traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
 
370
    print >>err_file
 
371
    print >>err_file, 'bzr %s on python %s (%s)' % \
 
372
                       (bzrlib.__version__,
 
373
                        '.'.join(map(str, sys.version_info)),
 
374
                        sys.platform)
 
375
    print >>err_file, 'arguments: %r' % sys.argv
 
376
    print >>err_file
 
377
    print >>err_file, "** please send this report to bazaar-ng@lists.ubuntu.com"