14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
18
"""Handling and reporting crashes.
19
A crash is an exception propagated up almost to the top level of Bazaar.
21
If we have apport <https://launchpad.net/apport/>, we store a report of the
22
crash using apport into its /var/crash spool directory, from where the user
23
can either manually send it to Launchpad. In some cases (at least Ubuntu
24
development releases), Apport may pop up a window asking if they want
27
Without apport, we just write a crash report to stderr and the user can report
28
this manually if the wish.
30
We never send crash data across the network without user opt-in.
32
In principle apport can run on any platform though as of Feb 2010 there seem
33
to be some portability bugs.
35
To force this off in bzr turn set APPORT_DISABLE in the environment or
39
from __future__ import absolute_import
41
21
# for interactive testing, try the 'bzr assert-fail' command
42
22
# or see http://code.launchpad.net/~mbp/bzr/bzr-fail
44
# to test with apport it's useful to set
45
# export APPORT_IGNORE_OBSOLETE_PACKAGES=1
64
41
def report_bug(exc_info, stderr):
65
if ('no_apport' in debug.debug_flags) or \
66
os.environ.get('APPORT_DISABLE', None):
67
return report_bug_legacy(exc_info, stderr)
69
if report_bug_to_apport(exc_info, stderr):
70
# wrote a file; if None then report the old way
42
if 'no_apport' not in debug.debug_flags:
44
report_bug_to_apport(exc_info, stderr)
72
except ImportError, e:
73
trace.mutter("couldn't find apport bug-reporting library: %s" % e)
75
# this should only happen if apport is installed but it didn't
76
# work, eg because of an io error writing the crash file
77
trace.mutter("bzr: failed to report crash using apport: %r" % e)
78
trace.log_exception_quietly()
79
return report_bug_legacy(exc_info, stderr)
46
except ImportError, e:
47
trace.mutter("couldn't find apport bug-reporting library: %s" % e)
50
# this should only happen if apport is installed but it didn't
51
# work, eg because of an io error writing the crash file
52
sys.stderr.write("bzr: failed to report crash using apport:\n "
55
report_bug_legacy(exc_info, stderr)
82
58
def report_bug_legacy(exc_info, err_file):
83
59
"""Report a bug by just printing a message to the user."""
84
60
trace.print_exception(exc_info, err_file)
85
61
err_file.write('\n')
88
err_file.write(textwrap.fill(l,
89
width=78, subsequent_indent=' ') + '\n')
90
print_wrapped('bzr %s on python %s (%s)\n' % \
92
bzrlib._format_version_tuple(sys.version_info),
93
platform.platform(aliased=1)))
94
print_wrapped('arguments: %r\n' % sys.argv)
95
print_wrapped(textwrap.fill(
96
'plugins: ' + plugin.format_concise_plugin_list(),
98
subsequent_indent=' ',
62
err_file.write('bzr %s on python %s (%s)\n' % \
64
bzrlib._format_version_tuple(sys.version_info),
65
platform.platform(aliased=1)))
66
err_file.write('arguments: %r\n' % sys.argv)
101
68
'encoding: %r, fsenc: %r, lang: %r\n' % (
102
69
osutils.get_user_encoding(), sys.getfilesystemencoding(),
103
70
os.environ.get('LANG')))
104
# We used to show all the plugins here, but it's too verbose.
71
err_file.write("plugins:\n")
72
err_file.write(_format_plugin_list())
107
75
"*** Bazaar has encountered an internal error. This probably indicates a\n"
108
76
" bug in Bazaar. You can help us fix it by filing a bug report at\n"
109
77
" https://bugs.launchpad.net/bzr/+filebug\n"
114
82
def report_bug_to_apport(exc_info, stderr):
115
83
"""Report a bug to apport for optional automatic filing.
117
:returns: The name of the crash file, or None if we didn't write one.
119
# this function is based on apport_package_hook.py, but omitting some of the
85
# this is based on apport_package_hook.py, but omitting some of the
120
86
# Ubuntu-specific policy about what to report and when
122
# This import is apparently not used, but we're doing it so that if the
123
# import fails, the exception will be caught at a higher level and we'll
124
# report the error by other means.
88
# if this fails its caught at a higher level; we don't want to open the
89
# crash file unless apport can be loaded.
127
crash_filename = _write_apport_report_to_file(exc_info)
129
if crash_filename is None:
131
"apport is set to ignore crashes in this version of bzr.\n"
134
trace.print_exception(exc_info, stderr)
136
"You can report this problem to Bazaar's developers by running\n"
138
"if a bug-reporting window does not automatically appear.\n"
140
# XXX: on Windows, Mac, and other platforms where we might have the
141
# apport libraries but not have an apport always running, we could
142
# synchronously file now
144
return crash_filename
147
def _write_apport_report_to_file(exc_info):
92
crash_file = _open_crash_file()
94
_write_apport_report_to_file(exc_info, crash_file)
98
stderr.write("bzr: ERROR: %s.%s: %s\n"
100
"*** Bazaar has encountered an internal error. This probably indicates a\n"
101
" bug in Bazaar. You can help us fix it by filing a bug report at\n"
102
" https://bugs.launchpad.net/bzr/+filebug\n"
103
" attaching the crash file\n"
105
" and including a description of the problem.\n"
107
" The crash file is plain text and you can inspect or edit it to remove\n"
108
" private information.\n"
109
% (exc_info[0].__module__, exc_info[0].__name__, exc_info[1],
113
def _write_apport_report_to_file(exc_info, crash_file):
149
115
from apport.report import Report
151
117
exc_type, exc_object, exc_tb = exc_info
154
# add_proc_info sets the ExecutablePath, InterpreterPath, etc.
156
# It also adds ProcMaps which for us is rarely useful and mostly noise, so
120
# add_proc_info gives you the memory map of the process: this seems rarely
121
# useful for Bazaar and it does make the report harder to scan, though it
122
# does tell you what binary modules are loaded.
159
124
pr.add_user_info()
161
# Package and SourcePackage are needed so that apport will report about even
162
# non-packaged versions of bzr; also this reports on their packaged
163
# dependencies which is useful.
164
pr['SourcePackage'] = 'bzr'
165
pr['Package'] = 'bzr'
167
125
pr['CommandLine'] = pprint.pformat(sys.argv)
168
126
pr['BzrVersion'] = bzrlib.__version__
169
127
pr['PythonVersion'] = bzrlib._format_version_tuple(sys.version_info)
170
128
pr['Platform'] = platform.platform(aliased=1)
171
129
pr['UserEncoding'] = osutils.get_user_encoding()
172
130
pr['FileSystemEncoding'] = sys.getfilesystemencoding()
173
pr['Locale'] = os.environ.get('LANG', 'C')
131
pr['Locale'] = os.environ.get('LANG')
174
132
pr['BzrPlugins'] = _format_plugin_list()
175
133
pr['PythonLoadedModules'] = _format_module_list()
176
134
pr['BzrDebugFlags'] = pprint.pformat(debug.debug_flags)
178
# actually we'd rather file directly against the upstream product, but
179
# apport does seem to count on there being one in there; we might need to
180
# redirect it elsewhere anyhow
181
pr['SourcePackage'] = 'bzr'
182
pr['Package'] = 'bzr'
184
# tell apport to file directly against the bzr package using
185
# <https://bugs.launchpad.net/bzr/+bug/391015>
187
# XXX: unfortunately apport may crash later if the crashdb definition
189
pr['CrashDb'] = 'bzr'
191
136
tb_file = StringIO()
192
137
traceback.print_exception(exc_type, exc_object, exc_tb, file=tb_file)
193
138
pr['Traceback'] = tb_file.getvalue()
197
# We want to use the 'bzr' crashdb so that it gets sent directly upstream,
198
# which is a reasonable default for most internal errors. However, if we
199
# set it here then apport will crash later if it doesn't know about that
200
# crashdb. Instead, we rely on the bzr package installing both a
201
# source hook telling crashes to go to this crashdb, and a crashdb
202
# configuration describing it.
204
# these may contain some sensitive info (smtp_passwords)
205
# TODO: strip that out and attach the rest
207
#attach_file_if_exists(report,
208
# os.path.join(dot_bzr, 'bazaar.conf', 'BzrConfig')
209
#attach_file_if_exists(report,
210
# os.path.join(dot_bzr, 'locations.conf', 'BzrLocations')
212
# strip username, hostname, etc
215
if pr.check_ignored():
216
# eg configured off in ~/.apport-ignore.xml
219
crash_file_name, crash_file = _open_crash_file()
222
return crash_file_name
225
def _attach_log_tail(pr):
227
bzr_log = open(trace._get_bzr_log_filename(), 'rt')
228
except (IOError, OSError), e:
229
pr['BzrLogTail'] = repr(e)
232
lines = bzr_log.readlines()
233
pr['BzrLogTail'] = ''.join(lines[-40:])
238
143
def _open_crash_file():
239
144
crash_dir = config.crash_dir()
145
# user-readable only, just in case the contents are sensitive.
240
146
if not osutils.isdir(crash_dir):
241
# on unix this should be /var/crash and should already exist; on
242
# Windows or if it's manually configured it might need to be created,
243
# and then it should be private
244
os.makedirs(crash_dir, mode=0600)
245
date_string = time.strftime('%Y-%m-%dT%H:%M', time.gmtime())
246
# XXX: getuid doesn't work on win32, but the crash directory is per-user
247
if sys.platform == 'win32':
250
user_part = '.%d' % os.getuid()
251
filename = osutils.pathjoin(
256
# be careful here that people can't play tmp-type symlink mischief in the
257
# world-writable directory
258
return filename, os.fdopen(
260
os.O_WRONLY|os.O_CREAT|os.O_EXCL,
147
os.makedirs(crash_dir, mode=0700)
148
filename = 'bzr-%s-%s.crash' % (
149
osutils.compact_date(time.time()),
151
return open(osutils.pathjoin(crash_dir, filename), 'wt')
265
154
def _format_plugin_list():
266
return ''.join(plugin.describe_plugins(show_paths=True))
156
for name, a_plugin in sorted(plugin.plugins().items()):
157
plugin_lines.append(" %-20s %s [%s]" %
158
(name, a_plugin.path(), a_plugin.__version__))
159
return '\n'.join(plugin_lines)
269
162
def _format_module_list():
added
removed
bzrlib/crash.py
