← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/crash.py

(jameinel) Allow 'bzr serve' to interpret SIGHUP as a graceful shutdown.
 (bug #795025) (John A Meinel)

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
        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
    import textwrap
 
88
    def print_wrapped(l):
 
89
        err_file.write(textwrap.fill(l,
 
90
            width=78, subsequent_indent='    ') + '\n')
 
91
    print_wrapped('bzr %s on python %s (%s)\n' % \
 
92
        (bzrlib.__version__,
 
93
        bzrlib._format_version_tuple(sys.version_info),
 
94
        platform.platform(aliased=1)))
 
95
    print_wrapped('arguments: %r\n' % sys.argv)
 
96
    print_wrapped(textwrap.fill(
 
97
        'plugins: ' + plugin.format_concise_plugin_list(),
 
98
        width=78,
 
99
        subsequent_indent='    ',
 
100
        ) + '\n')
 
101
    print_wrapped(
 
102
        'encoding: %r, fsenc: %r, lang: %r\n' % (
 
103
            osutils.get_user_encoding(), sys.getfilesystemencoding(),
 
104
            os.environ.get('LANG')))
 
105
    # We used to show all the plugins here, but it's too verbose.
 
106
    err_file.write(
 
107
        "\n"
 
108
        "*** Bazaar has encountered an internal error.  This probably indicates a\n"
 
109
        "    bug in Bazaar.  You can help us fix it by filing a bug report at\n"
 
110
        "        https://bugs.launchpad.net/bzr/+filebug\n"
 
111
        "    including this traceback and a description of the problem.\n"
 
112
        )
 
113
 
 
114
 
 
115
def report_bug_to_apport(exc_info, stderr):
 
116
    """Report a bug to apport for optional automatic filing.
 
117
 
 
118
    :returns: The name of the crash file, or None if we didn't write one.
 
119
    """
 
120
    # this function is based on apport_package_hook.py, but omitting some of the
 
121
    # Ubuntu-specific policy about what to report and when
 
122
 
 
123
    # This import is apparently not used, but we're doing it so that if the
 
124
    # import fails, the exception will be caught at a higher level and we'll
 
125
    # report the error by other means.
 
126
    import apport
 
127
 
 
128
    crash_filename = _write_apport_report_to_file(exc_info)
 
129
 
 
130
    if crash_filename is None:
 
131
        stderr.write("\n"
 
132
            "apport is set to ignore crashes in this version of bzr.\n"
 
133
            )
 
134
    else:
 
135
        trace.print_exception(exc_info, stderr)
 
136
        stderr.write("\n"
 
137
            "You can report this problem to Bazaar's developers by running\n"
 
138
            "    apport-bug %s\n"
 
139
            "if a bug-reporting window does not automatically appear.\n"
 
140
            % (crash_filename))
 
141
        # XXX: on Windows, Mac, and other platforms where we might have the
 
142
        # apport libraries but not have an apport always running, we could
 
143
        # synchronously file now
 
144
 
 
145
    return crash_filename
 
146
 
 
147
 
 
148
def _write_apport_report_to_file(exc_info):
 
149
    import traceback
 
150
    from apport.report import Report
 
151
 
 
152
    exc_type, exc_object, exc_tb = exc_info
 
153
 
 
154
    pr = Report()
 
155
    # add_proc_info sets the ExecutablePath, InterpreterPath, etc.
 
156
    pr.add_proc_info()
 
157
    # It also adds ProcMaps which for us is rarely useful and mostly noise, so
 
158
    # let's remove it.
 
159
    del pr['ProcMaps']
 
160
    pr.add_user_info()
 
161
 
 
162
    # Package and SourcePackage are needed so that apport will report about even
 
163
    # non-packaged versions of bzr; also this reports on their packaged
 
164
    # dependencies which is useful.
 
165
    pr['SourcePackage'] = 'bzr'
 
166
    pr['Package'] = 'bzr'
 
167
 
 
168
    pr['CommandLine'] = pprint.pformat(sys.argv)
 
169
    pr['BzrVersion'] = bzrlib.__version__
 
170
    pr['PythonVersion'] = bzrlib._format_version_tuple(sys.version_info)
 
171
    pr['Platform'] = platform.platform(aliased=1)
 
172
    pr['UserEncoding'] = osutils.get_user_encoding()
 
173
    pr['FileSystemEncoding'] = sys.getfilesystemencoding()
 
174
    pr['Locale'] = os.environ.get('LANG')
 
175
    pr['BzrPlugins'] = _format_plugin_list()
 
176
    pr['PythonLoadedModules'] = _format_module_list()
 
177
    pr['BzrDebugFlags'] = pprint.pformat(debug.debug_flags)
 
178
 
 
179
    # actually we'd rather file directly against the upstream product, but
 
180
    # apport does seem to count on there being one in there; we might need to
 
181
    # redirect it elsewhere anyhow
 
182
    pr['SourcePackage'] = 'bzr'
 
183
    pr['Package'] = 'bzr'
 
184
 
 
185
    # tell apport to file directly against the bzr package using 
 
186
    # <https://bugs.launchpad.net/bzr/+bug/391015>
 
187
    #
 
188
    # XXX: unfortunately apport may crash later if the crashdb definition
 
189
    # file isn't present
 
190
    pr['CrashDb'] = 'bzr'
 
191
 
 
192
    tb_file = StringIO()
 
193
    traceback.print_exception(exc_type, exc_object, exc_tb, file=tb_file)
 
194
    pr['Traceback'] = tb_file.getvalue()
 
195
 
 
196
    _attach_log_tail(pr)
 
197
 
 
198
    # We want to use the 'bzr' crashdb so that it gets sent directly upstream,
 
199
    # which is a reasonable default for most internal errors.  However, if we
 
200
    # set it here then apport will crash later if it doesn't know about that
 
201
    # crashdb.  Instead, we rely on the bzr package installing both a
 
202
    # source hook telling crashes to go to this crashdb, and a crashdb
 
203
    # configuration describing it.
 
204
 
 
205
    # these may contain some sensitive info (smtp_passwords)
 
206
    # TODO: strip that out and attach the rest
 
207
    #
 
208
    #attach_file_if_exists(report,
 
209
    #   os.path.join(dot_bzr, 'bazaar.conf', 'BzrConfig')
 
210
    #attach_file_if_exists(report,
 
211
    #   os.path.join(dot_bzr, 'locations.conf', 'BzrLocations')
 
212
    
 
213
    # strip username, hostname, etc
 
214
    pr.anonymize()
 
215
 
 
216
    if pr.check_ignored():
 
217
        # eg configured off in ~/.apport-ignore.xml
 
218
        return None
 
219
    else:
 
220
        crash_file_name, crash_file = _open_crash_file()
 
221
        pr.write(crash_file)
 
222
        crash_file.close()
 
223
        return crash_file_name
 
224
 
 
225
 
 
226
def _attach_log_tail(pr):
 
227
    try:
 
228
        bzr_log = open(trace._get_bzr_log_filename(), 'rt')
 
229
    except (IOError, OSError), e:
 
230
        pr['BzrLogTail'] = repr(e)
 
231
        return
 
232
    try:
 
233
        lines = bzr_log.readlines()
 
234
        pr['BzrLogTail'] = ''.join(lines[-40:])
 
235
    finally:
 
236
        bzr_log.close()
 
237
 
 
238
 
 
239
def _open_crash_file():
 
240
    crash_dir = config.crash_dir()
 
241
    if not osutils.isdir(crash_dir):
 
242
        # on unix this should be /var/crash and should already exist; on
 
243
        # Windows or if it's manually configured it might need to be created,
 
244
        # and then it should be private
 
245
        os.makedirs(crash_dir, mode=0600)
 
246
    date_string = time.strftime('%Y-%m-%dT%H:%M', time.gmtime())
 
247
    # XXX: getuid doesn't work on win32, but the crash directory is per-user
 
248
    if sys.platform == 'win32':
 
249
        user_part = ''
 
250
    else:
 
251
        user_part = '.%d' % os.getuid()
 
252
    filename = osutils.pathjoin(
 
253
        crash_dir,
 
254
        'bzr%s.%s.crash' % (
 
255
            user_part,
 
256
            date_string))
 
257
    # be careful here that people can't play tmp-type symlink mischief in the
 
258
    # world-writable directory
 
259
    return filename, os.fdopen(
 
260
        os.open(filename, 
 
261
            os.O_WRONLY|os.O_CREAT|os.O_EXCL,
 
262
            0600),
 
263
        'w')
 
264
 
 
265
 
 
266
def _format_plugin_list():
 
267
    return ''.join(plugin.describe_plugins(show_paths=True))
 
268
 
 
269
 
 
270
def _format_module_list():
 
271
    return pprint.pformat(sys.modules)