1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
|
# Copyright (C) 2009-2011 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
"""Handling and reporting crashes.
A crash is an exception propagated up almost to the top level of Bazaar.
If we have apport <https://launchpad.net/apport/>, we store a report of the
crash using apport into its /var/crash spool directory, from where the user
can either manually send it to Launchpad. In some cases (at least Ubuntu
development releases), Apport may pop up a window asking if they want
to send it.
Without apport, we just write a crash report to stderr and the user can report
this manually if the wish.
We never send crash data across the network without user opt-in.
In principle apport can run on any platform though as of Feb 2010 there seem
to be some portability bugs.
To force this off in bzr turn set APPORT_DISABLE in the environment or
-Dno_apport.
"""
# for interactive testing, try the 'bzr assert-fail' command
# or see http://code.launchpad.net/~mbp/bzr/bzr-fail
#
# to test with apport it's useful to set
# export APPORT_IGNORE_OBSOLETE_PACKAGES=1
import os
import platform
import pprint
import sys
import time
from StringIO import StringIO
import bzrlib
from bzrlib import (
config,
debug,
osutils,
plugin,
trace,
)
def report_bug(exc_info, stderr):
if ('no_apport' in debug.debug_flags) or \
os.environ.get('APPORT_DISABLE', None):
return report_bug_legacy(exc_info, stderr)
try:
if report_bug_to_apport(exc_info, stderr):
# wrote a file; if None then report the old way
return
except ImportError, e:
trace.mutter("couldn't find apport bug-reporting library: %s" % e)
pass
except Exception, e:
# this should only happen if apport is installed but it didn't
# work, eg because of an io error writing the crash file
stderr.write("bzr: failed to report crash using apport:\n "
" %r\n" % e)
pass
return report_bug_legacy(exc_info, stderr)
def report_bug_legacy(exc_info, err_file):
"""Report a bug by just printing a message to the user."""
trace.print_exception(exc_info, err_file)
err_file.write('\n')
import textwrap
def print_wrapped(l):
err_file.write(textwrap.fill(l,
width=78, subsequent_indent=' ') + '\n')
print_wrapped('bzr %s on python %s (%s)\n' % \
(bzrlib.__version__,
bzrlib._format_version_tuple(sys.version_info),
platform.platform(aliased=1)))
print_wrapped('arguments: %r\n' % sys.argv)
print_wrapped(textwrap.fill(
'plugins: ' + plugin.format_concise_plugin_list(),
width=78,
subsequent_indent=' ',
) + '\n')
print_wrapped(
'encoding: %r, fsenc: %r, lang: %r\n' % (
osutils.get_user_encoding(), sys.getfilesystemencoding(),
os.environ.get('LANG')))
# We used to show all the plugins here, but it's too verbose.
err_file.write(
"\n"
"*** Bazaar has encountered an internal error. This probably indicates a\n"
" bug in Bazaar. You can help us fix it by filing a bug report at\n"
" https://bugs.launchpad.net/bzr/+filebug\n"
" including this traceback and a description of the problem.\n"
)
def report_bug_to_apport(exc_info, stderr):
"""Report a bug to apport for optional automatic filing.
:returns: The name of the crash file, or None if we didn't write one.
"""
# this function is based on apport_package_hook.py, but omitting some of the
# Ubuntu-specific policy about what to report and when
# if the import fails, the exception will be caught at a higher level and
# we'll report the error by other means
import apport
crash_filename = _write_apport_report_to_file(exc_info)
if crash_filename is None:
stderr.write("\n"
"apport is set to ignore crashes in this version of bzr.\n"
)
else:
trace.print_exception(exc_info, stderr)
stderr.write("\n"
"You can report this problem to Bazaar's developers by running\n"
" apport-bug %s\n"
"if a bug-reporting window does not automatically appear.\n"
% (crash_filename))
# XXX: on Windows, Mac, and other platforms where we might have the
# apport libraries but not have an apport always running, we could
# synchronously file now
return crash_filename
def _write_apport_report_to_file(exc_info):
import traceback
from apport.report import Report
exc_type, exc_object, exc_tb = exc_info
pr = Report()
# add_proc_info sets the ExecutablePath, InterpreterPath, etc.
pr.add_proc_info()
# It also adds ProcMaps which for us is rarely useful and mostly noise, so
# let's remove it.
del pr['ProcMaps']
pr.add_user_info()
# Package and SourcePackage are needed so that apport will report about even
# non-packaged versions of bzr; also this reports on their packaged
# dependencies which is useful.
pr['SourcePackage'] = 'bzr'
pr['Package'] = 'bzr'
pr['CommandLine'] = pprint.pformat(sys.argv)
pr['BzrVersion'] = bzrlib.__version__
pr['PythonVersion'] = bzrlib._format_version_tuple(sys.version_info)
pr['Platform'] = platform.platform(aliased=1)
pr['UserEncoding'] = osutils.get_user_encoding()
pr['FileSystemEncoding'] = sys.getfilesystemencoding()
pr['Locale'] = os.environ.get('LANG')
pr['BzrPlugins'] = _format_plugin_list()
pr['PythonLoadedModules'] = _format_module_list()
pr['BzrDebugFlags'] = pprint.pformat(debug.debug_flags)
# actually we'd rather file directly against the upstream product, but
# apport does seem to count on there being one in there; we might need to
# redirect it elsewhere anyhow
pr['SourcePackage'] = 'bzr'
pr['Package'] = 'bzr'
# tell apport to file directly against the bzr package using
# <https://bugs.launchpad.net/bzr/+bug/391015>
#
# XXX: unfortunately apport may crash later if the crashdb definition
# file isn't present
pr['CrashDb'] = 'bzr'
tb_file = StringIO()
traceback.print_exception(exc_type, exc_object, exc_tb, file=tb_file)
pr['Traceback'] = tb_file.getvalue()
_attach_log_tail(pr)
# We want to use the 'bzr' crashdb so that it gets sent directly upstream,
# which is a reasonable default for most internal errors. However, if we
# set it here then apport will crash later if it doesn't know about that
# crashdb. Instead, we rely on the bzr package installing both a
# source hook telling crashes to go to this crashdb, and a crashdb
# configuration describing it.
# these may contain some sensitive info (smtp_passwords)
# TODO: strip that out and attach the rest
#
#attach_file_if_exists(report,
# os.path.join(dot_bzr, 'bazaar.conf', 'BzrConfig')
#attach_file_if_exists(report,
# os.path.join(dot_bzr, 'locations.conf', 'BzrLocations')
# strip username, hostname, etc
pr.anonymize()
if pr.check_ignored():
# eg configured off in ~/.apport-ignore.xml
return None
else:
crash_file_name, crash_file = _open_crash_file()
pr.write(crash_file)
crash_file.close()
return crash_file_name
def _attach_log_tail(pr):
try:
bzr_log = open(trace._get_bzr_log_filename(), 'rt')
except (IOError, OSError), e:
pr['BzrLogTail'] = repr(e)
return
try:
lines = bzr_log.readlines()
pr['BzrLogTail'] = ''.join(lines[-40:])
finally:
bzr_log.close()
def _open_crash_file():
crash_dir = config.crash_dir()
if not osutils.isdir(crash_dir):
# on unix this should be /var/crash and should already exist; on
# Windows or if it's manually configured it might need to be created,
# and then it should be private
os.makedirs(crash_dir, mode=0600)
date_string = time.strftime('%Y-%m-%dT%H:%M', time.gmtime())
# XXX: getuid doesn't work on win32, but the crash directory is per-user
if sys.platform == 'win32':
user_part = ''
else:
user_part = '.%d' % os.getuid()
filename = osutils.pathjoin(
crash_dir,
'bzr%s.%s.crash' % (
user_part,
date_string))
# be careful here that people can't play tmp-type symlink mischief in the
# world-writable directory
return filename, os.fdopen(
os.open(filename,
os.O_WRONLY|os.O_CREAT|os.O_EXCL,
0600),
'w')
def _format_plugin_list():
return ''.join(plugin.describe_plugins(show_paths=True))
def _format_module_list():
return pprint.pformat(sys.modules)
|