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
|
"""
Error handler middleware, and paste.config reporter integration
Usage::
error_caching_wsgi_app = ErrorMiddleware(wsgi_app)
These configuration keys are used:
``debug``:
show the errors in the browser
``error_email``:
if present, send errors to this email address
``error_log``:
if present, write errors to this file
``show_exceptions_in_error_log``:
if true (the default) then write errors to wsgi.errors
You can also use this outside of a web context, like::
import sys
import paste
import paste.error_middleware
try:
do stuff
except:
paste.error_middleware.exception_handler(
sys.exc_info(), paste.CONFIG, sys.stderr, html=False)
If you want to report, but not fully catch the exception, call
``raise`` after ``exception_handler``, which (when given no argument)
will reraise the exception.
By setting 'paste.throw_errors' to a true value, this middleware is
disabled. This can be useful in a testing environment where you don't
want errors to be caught and transformed.
"""
import sys
import traceback
import cgi
try:
from cStringIO import StringIO
except ImportError:
from StringIO import StringIO
from paste.exceptions import formatter, collector, reporter
from paste import wsgilib
class ErrorMiddleware(object):
def __init__(self, application):
self.application = application
def __call__(self, environ, start_response):
# We want to be careful about not sending headers twice,
# and the content type that the app has committed to (if there
# is an exception in the iterator body of the response)
started = []
if environ.get('paste.throw_errors'):
return self.application(environ, start_response)
environ['paste.throw_errors'] = True
def detect_start_response(status, headers, exc_info=None):
started.append(True)
return start_response(status, headers, exc_info)
try:
__traceback_supplement__ = Supplement, self, environ
app_iter = self.application(environ, detect_start_response)
return self.catching_iter(app_iter, environ)
except:
if not started:
start_response('500 Internal Server Error',
[('content-type', 'text/html')])
# @@: it would be nice to deal with bad content types here
response = self.exception_handler(sys.exc_info(), environ)
return [response]
def catching_iter(self, app_iter, environ):
__traceback_supplement__ = Supplement, self, environ
if not app_iter:
raise StopIteration
error_on_close = False
try:
for v in app_iter:
yield v
if hasattr(app_iter, 'close'):
error_on_close = True
app_iter.close()
except:
response = self.exception_handler(sys.exc_info(), environ)
if not error_on_close and hasattr(app_iter, 'close'):
try:
app_iter.close()
except:
close_response = self.exception_handler(
sys.exc_info(), environ)
response += (
'<hr noshade>Error in .close():<br>%s'
% close_response)
yield response
def exception_handler(self, exc_info, environ):
return handle_exception(
exc_info, environ['paste.config'], environ['wsgi.errors'],
html=True)
class Supplement(object):
def __init__(self, middleware, environ):
self.middleware = middleware
self.environ = environ
self.source_url = wsgilib.construct_url(environ)
def extraData(self):
data = {}
cgi_vars = data[('extra', 'CGI Variables')] = {}
wsgi_vars = data[('extra', 'WSGI Variables')] = {}
hide_vars = ['paste.config', 'wsgi.errors', 'wsgi.input',
'wsgi.multithread', 'wsgi.multiprocess',
'wsgi.run_once', 'wsgi.version',
'wsgi.url_scheme']
for name, value in self.environ.items():
if name.upper() == name:
if value:
cgi_vars[name] = value
elif name not in hide_vars:
wsgi_vars[name] = value
if self.environ['wsgi.version'] != (1, 0):
wsgi_vars['wsgi.version'] = self.environ['wsgi.version']
proc_desc = tuple([int(bool(self.environ[key]))
for key in ('wsgi.multiprocess',
'wsgi.multithread',
'wsgi.run_once')])
wsgi_vars['wsgi process'] = self.process_combos[proc_desc]
data[('extra', 'Configuration')] = dict(self.environ['paste.config'])
return data
process_combos = {
# multiprocess, multithread, run_once
(0, 0, 0): 'Non-concurrent server',
(0, 1, 0): 'Multithreaded',
(1, 0, 0): 'Multiprocess',
(1, 1, 0): 'Multi process AND threads (?)',
(0, 0, 1): 'Non-concurrent CGI',
(0, 1, 1): 'Multithread CGI (?)',
(1, 0, 1): 'CGI',
(1, 1, 1): 'Multi thread/process CGI (?)',
}
def handle_exception(exc_info, conf, error_stream, html=True):
reported = False
exc_data = collector.collect_exception(*exc_info)
extra_data = ''
if conf.get('error_email'):
rep = reporter.EmailReporter(
to_addresses=conf['error_email'],
from_address=conf.get('error_email_from', 'errors@localhost'),
smtp_server=conf.get('smtp_server', 'localhost'),
subject_prefix=conf.get('error_subject_prefix', ''))
rep_err = send_report(rep, exc_data, html=html)
if not rep_err:
extra_data += rep_err
reported = True
if conf.get('error_log'):
rep = reporter.LogReporter(
filename=conf['error_log'])
rep_err = send_report(rep, exc_data, html=html)
if not rep_err:
extra_data += rep_err
reported = True
if conf.get('show_exceptions_in_error_log', True):
rep = reporter.FileReporter(
file=error_stream)
rep_err = send_report(rep, exc_data, html=html)
if not rep_err:
extra_data += rep_err
reported = True
else:
error_stream.write('Error - %s: %s\n' % (
exc_data.exception_type, exc_data.exception_value))
if html:
if conf.get('debug', False):
return_error = error_template(
formatter.format_html(exc_data), extra_data)
extra_data = ''
reported = True
else:
return_error = error_template(
'''
An error occurred. See the error logs for more information.
(Turn debug on to display exception reports here)
''', '')
else:
return_error = None
if not reported and error_stream:
err_report = formatter.format_text(exc_data, show_hidden_frames=True)
err_report += '\n' + '-'*60 + '\n'
error_stream.write(err_report)
if extra_data:
error_stream.write(extra_data)
return return_error
def send_report(rep, exc_data, html=True):
try:
rep.report(exc_data)
except:
output = StringIO()
traceback.print_exc(file=output)
if html:
return """
<p>Additionally an error occurred while sending the %s report:
<pre>%s</pre>
</p>""" % (
cgi.escape(str(rep)), output.getvalue())
else:
return (
"Additionally an error occurred while sending the "
"%s report:\n%s" % (str(rep), output.getvalue()))
else:
return ''
def error_template(exception, extra):
return '''
<html>
<head>
<title>Server Error</title>
</head>
<body>
<h1>Server Error</h1>
%s
%s
</body>
</html>''' % (exception, extra)
|
