← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/crash.py

  • Committer: Martin Pool
  • Date: 2010-02-23 07:43:11 UTC
  • mfrom: (4797.2.20 2.1)
  • mto: This revision was merged to the branch mainline in revision 5055.
  • Revision ID: mbp@sourcefrog.net-20100223074311-gnj55xdhrgz9l94e
Merge 2.1 back to trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/crash.py
 
1
# Copyright (C) 2009, 2010 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 it's /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_DISBLE 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
        pass
 
74
    except Exception, 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
        stderr.write("bzr: failed to report crash using apport:\n "
 
78
            "    %r\n" % e)
 
79
        pass
 
80
    return report_bug_legacy(exc_info, stderr)
 
81
 
 
82
 
 
83
def report_bug_legacy(exc_info, err_file):
 
84
    """Report a bug by just printing a message to the user."""
 
85
    trace.print_exception(exc_info, err_file)
 
86
    err_file.write('\n')
 
87
    err_file.write('bzr %s on python %s (%s)\n' % \
 
88
                       (bzrlib.__version__,
 
89
                        bzrlib._format_version_tuple(sys.version_info),
 
90
                        platform.platform(aliased=1)))
 
91
    err_file.write('arguments: %r\n' % sys.argv)
 
92
    err_file.write(
 
93
        'encoding: %r, fsenc: %r, lang: %r\n' % (
 
94
            osutils.get_user_encoding(), sys.getfilesystemencoding(),
 
95
            os.environ.get('LANG')))
 
96
    err_file.write("plugins:\n")
 
97
    err_file.write(_format_plugin_list())
 
98
    err_file.write(
 
99
        "\n\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
        "    including this traceback and a description of the problem.\n"
 
104
        )
 
105
 
 
106
 
 
107
def report_bug_to_apport(exc_info, stderr):
 
108
    """Report a bug to apport for optional automatic filing.
 
109
 
 
110
    :returns: The name of the crash file, or None if we didn't write one.
 
111
    """
 
112
    # this function is based on apport_package_hook.py, but omitting some of the
 
113
    # Ubuntu-specific policy about what to report and when
 
114
 
 
115
    # if the import fails, the exception will be caught at a higher level and
 
116
    # we'll report the error by other means
 
117
    import apport
 
118
 
 
119
    crash_filename = _write_apport_report_to_file(exc_info)
 
120
 
 
121
    if crash_filename is None:
 
122
        stderr.write("\n"
 
123
            "apport is set to ignore crashes in this version of bzr.\n"
 
124
            )
 
125
    else:
 
126
        trace.print_exception(exc_info, stderr)
 
127
        stderr.write("\n"
 
128
            "You can report this problem to Bazaar's developers by running\n"
 
129
            "    apport-bug %s\n"
 
130
            "if a bug-reporting window does not automatically appear.\n"
 
131
            % (crash_filename))
 
132
        # XXX: on Windows, Mac, and other platforms where we might have the
 
133
        # apport libraries but not have an apport always running, we could
 
134
        # synchronously file now
 
135
 
 
136
    return crash_filename
 
137
 
 
138
 
 
139
def _write_apport_report_to_file(exc_info):
 
140
    import traceback
 
141
    from apport.report import Report
 
142
 
 
143
    exc_type, exc_object, exc_tb = exc_info
 
144
 
 
145
    pr = Report()
 
146
    # add_proc_info gets the executable and interpreter path, which is needed,
 
147
    # plus some less useful stuff like the memory map
 
148
    pr.add_proc_info()
 
149
    pr.add_user_info()
 
150
 
 
151
    # Package and SourcePackage are needed so that apport will report about even
 
152
    # non-packaged versions of bzr; also this reports on their packaged
 
153
    # dependencies which is useful.
 
154
    pr['SourcePackage'] = 'bzr'
 
155
    pr['Package'] = 'bzr'
 
156
 
 
157
    pr['CommandLine'] = pprint.pformat(sys.argv)
 
158
    pr['BzrVersion'] = bzrlib.__version__
 
159
    pr['PythonVersion'] = bzrlib._format_version_tuple(sys.version_info)
 
160
    pr['Platform'] = platform.platform(aliased=1)
 
161
    pr['UserEncoding'] = osutils.get_user_encoding()
 
162
    pr['FileSystemEncoding'] = sys.getfilesystemencoding()
 
163
    pr['Locale'] = os.environ.get('LANG')
 
164
    pr['BzrPlugins'] = _format_plugin_list()
 
165
    pr['PythonLoadedModules'] = _format_module_list()
 
166
    pr['BzrDebugFlags'] = pprint.pformat(debug.debug_flags)
 
167
 
 
168
    tb_file = StringIO()
 
169
    traceback.print_exception(exc_type, exc_object, exc_tb, file=tb_file)
 
170
    pr['Traceback'] = tb_file.getvalue()
 
171
 
 
172
    _attach_log_tail(pr)
 
173
 
 
174
    # We want to use the 'bzr' crashdb so that it gets sent directly upstream,
 
175
    # which is a reasonable default for most internal errors.  However, if we
 
176
    # set it here then apport will crash later if it doesn't know about that
 
177
    # crashdb.  Instead, we rely on the bzr package installing both a
 
178
    # source hook telling crashes to go to this crashdb, and a crashdb
 
179
    # configuration describing it.
 
180
 
 
181
    # these may contain some sensitive info (smtp_passwords)
 
182
    # TODO: strip that out and attach the rest
 
183
    #
 
184
    #attach_file_if_exists(report,
 
185
    #   os.path.join(dot_bzr, 'bazaar.conf', 'BzrConfig')
 
186
    #attach_file_if_exists(report,
 
187
    #   os.path.join(dot_bzr, 'locations.conf', 'BzrLocations')
 
188
    
 
189
    # strip username, hostname, etc
 
190
    pr.anonymize()
 
191
 
 
192
    if pr.check_ignored():
 
193
        # eg configured off in ~/.apport-ignore.xml
 
194
        return None
 
195
    else:
 
196
        crash_file_name, crash_file = _open_crash_file()
 
197
        pr.write(crash_file)
 
198
        crash_file.close()
 
199
        return crash_file_name
 
200
 
 
201
 
 
202
def _attach_log_tail(pr):
 
203
    try:
 
204
        bzr_log = open(trace._get_bzr_log_filename(), 'rt')
 
205
    except (IOError, OSError), e:
 
206
        pr['BzrLogTail'] = repr(e)
 
207
        return
 
208
    try:
 
209
        lines = bzr_log.readlines()
 
210
        pr['BzrLogTail'] = ''.join(lines[-40:])
 
211
    finally:
 
212
        bzr_log.close()
 
213
 
 
214
 
 
215
def _open_crash_file():
 
216
    crash_dir = config.crash_dir()
 
217
    if not osutils.isdir(crash_dir):
 
218
        # on unix this should be /var/crash and should already exist; on
 
219
        # Windows or if it's manually configured it might need to be created,
 
220
        # and then it should be private
 
221
        os.makedirs(crash_dir, mode=0600)
 
222
    date_string = time.strftime('%Y-%m-%dT%H:%M', time.gmtime())
 
223
    # XXX: getuid doesn't work on win32, but the crash directory is per-user
 
224
    if sys.platform == 'win32':
 
225
        user_part = ''
 
226
    else:
 
227
        user_part = '.%d' % os.getuid()
 
228
    filename = osutils.pathjoin(
 
229
        crash_dir,
 
230
        'bzr%s.%s.crash' % (
 
231
            user_part,
 
232
            date_string))
 
233
    # be careful here that people can't play tmp-type symlink mischief in the
 
234
    # world-writable directory
 
235
    return filename, os.fdopen(
 
236
        os.open(filename, 
 
237
            os.O_WRONLY|os.O_CREAT|os.O_EXCL,
 
238
            0600),
 
239
        'w')
 
240
 
 
241
 
 
242
def _format_plugin_list():
 
243
    plugin_lines = []
 
244
    for name, a_plugin in sorted(plugin.plugins().items()):
 
245
        plugin_lines.append("  %-20s %s [%s]" %
 
246
            (name, a_plugin.path(), a_plugin.__version__))
 
247
    return '\n'.join(plugin_lines)
 
248
 
 
249
 
 
250
def _format_module_list():
 
251
    return pprint.pformat(sys.modules)