← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/crash.py

  • Committer: Martin Packman
  • Date: 2011-12-23 19:38:22 UTC
  • mto: This revision was merged to the branch mainline in revision 6405.
  • Revision ID: martin.packman@canonical.com-20111223193822-hesheea4o8aqwexv
Accept and document passing the medium rather than transport for smart connections

Show diffs side-by-side

added added

removed removed

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