← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/crash.py

  • Committer: Aaron Bentley
  • Date: 2005-08-26 14:39:43 UTC
  • mfrom: (974.2.7) (974.2.6)
  • mto: (1185.3.4)
  • mto: This revision was merged to the branch mainline in revision 1178.
  • Revision ID: abentley@panoramicfeedback.com-20050826143943-c677569cfb887d35
Merged changes from the merge4 branch

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/crash.py
1
 
# Copyright (C) 2009, 2010, 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
 
        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 sets the ExecutablePath, InterpreterPath, etc.
147
 
    pr.add_proc_info()
148
 
    # It also adds ProcMaps which for us is rarely useful and mostly noise, so
149
 
    # let's remove it.
150
 
    del pr['ProcMaps']
151
 
    pr.add_user_info()
152
 
 
153
 
    # Package and SourcePackage are needed so that apport will report about even
154
 
    # non-packaged versions of bzr; also this reports on their packaged
155
 
    # dependencies which is useful.
156
 
    pr['SourcePackage'] = 'bzr'
157
 
    pr['Package'] = 'bzr'
158
 
 
159
 
    pr['CommandLine'] = pprint.pformat(sys.argv)
160
 
    pr['BzrVersion'] = bzrlib.__version__
161
 
    pr['PythonVersion'] = bzrlib._format_version_tuple(sys.version_info)
162
 
    pr['Platform'] = platform.platform(aliased=1)
163
 
    pr['UserEncoding'] = osutils.get_user_encoding()
164
 
    pr['FileSystemEncoding'] = sys.getfilesystemencoding()
165
 
    pr['Locale'] = os.environ.get('LANG')
166
 
    pr['BzrPlugins'] = _format_plugin_list()
167
 
    pr['PythonLoadedModules'] = _format_module_list()
168
 
    pr['BzrDebugFlags'] = pprint.pformat(debug.debug_flags)
169
 
 
170
 
    # actually we'd rather file directly against the upstream product, but
171
 
    # apport does seem to count on there being one in there; we might need to
172
 
    # redirect it elsewhere anyhow
173
 
    pr['SourcePackage'] = 'bzr'
174
 
    pr['Package'] = 'bzr'
175
 
 
176
 
    # tell apport to file directly against the bzr package using 
177
 
    # <https://bugs.launchpad.net/bzr/+bug/391015>
178
 
    #
179
 
    # XXX: unfortunately apport may crash later if the crashdb definition
180
 
    # file isn't present
181
 
    pr['CrashDb'] = 'bzr'
182
 
 
183
 
    tb_file = StringIO()
184
 
    traceback.print_exception(exc_type, exc_object, exc_tb, file=tb_file)
185
 
    pr['Traceback'] = tb_file.getvalue()
186
 
 
187
 
    _attach_log_tail(pr)
188
 
 
189
 
    # We want to use the 'bzr' crashdb so that it gets sent directly upstream,
190
 
    # which is a reasonable default for most internal errors.  However, if we
191
 
    # set it here then apport will crash later if it doesn't know about that
192
 
    # crashdb.  Instead, we rely on the bzr package installing both a
193
 
    # source hook telling crashes to go to this crashdb, and a crashdb
194
 
    # configuration describing it.
195
 
 
196
 
    # these may contain some sensitive info (smtp_passwords)
197
 
    # TODO: strip that out and attach the rest
198
 
    #
199
 
    #attach_file_if_exists(report,
200
 
    #   os.path.join(dot_bzr, 'bazaar.conf', 'BzrConfig')
201
 
    #attach_file_if_exists(report,
202
 
    #   os.path.join(dot_bzr, 'locations.conf', 'BzrLocations')
203
 
    
204
 
    # strip username, hostname, etc
205
 
    pr.anonymize()
206
 
 
207
 
    if pr.check_ignored():
208
 
        # eg configured off in ~/.apport-ignore.xml
209
 
        return None
210
 
    else:
211
 
        crash_file_name, crash_file = _open_crash_file()
212
 
        pr.write(crash_file)
213
 
        crash_file.close()
214
 
        return crash_file_name
215
 
 
216
 
 
217
 
def _attach_log_tail(pr):
218
 
    try:
219
 
        bzr_log = open(trace._get_bzr_log_filename(), 'rt')
220
 
    except (IOError, OSError), e:
221
 
        pr['BzrLogTail'] = repr(e)
222
 
        return
223
 
    try:
224
 
        lines = bzr_log.readlines()
225
 
        pr['BzrLogTail'] = ''.join(lines[-40:])
226
 
    finally:
227
 
        bzr_log.close()
228
 
 
229
 
 
230
 
def _open_crash_file():
231
 
    crash_dir = config.crash_dir()
232
 
    if not osutils.isdir(crash_dir):
233
 
        # on unix this should be /var/crash and should already exist; on
234
 
        # Windows or if it's manually configured it might need to be created,
235
 
        # and then it should be private
236
 
        os.makedirs(crash_dir, mode=0600)
237
 
    date_string = time.strftime('%Y-%m-%dT%H:%M', time.gmtime())
238
 
    # XXX: getuid doesn't work on win32, but the crash directory is per-user
239
 
    if sys.platform == 'win32':
240
 
        user_part = ''
241
 
    else:
242
 
        user_part = '.%d' % os.getuid()
243
 
    filename = osutils.pathjoin(
244
 
        crash_dir,
245
 
        'bzr%s.%s.crash' % (
246
 
            user_part,
247
 
            date_string))
248
 
    # be careful here that people can't play tmp-type symlink mischief in the
249
 
    # world-writable directory
250
 
    return filename, os.fdopen(
251
 
        os.open(filename, 
252
 
            os.O_WRONLY|os.O_CREAT|os.O_EXCL,
253
 
            0600),
254
 
        'w')
255
 
 
256
 
 
257
 
def _format_plugin_list():
258
 
    return ''.join(plugin.describe_plugins(show_paths=True))
259
 
 
260
 
 
261
 
def _format_module_list():
262
 
    return pprint.pformat(sys.modules)