/
ErrorHandlerMiddleware.php
213 lines (192 loc) · 6.58 KB
/
ErrorHandlerMiddleware.php
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
<?php
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since 3.3.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Error\Middleware;
use Cake\Core\App;
use Cake\Core\Configure;
use Cake\Core\InstanceConfigTrait;
use Cake\Error\ExceptionRenderer;
use Cake\Log\Log;
use Exception;
/**
* Error handling middleware.
*
* Traps exceptions and converts them into HTML or content-type appropriate
* error pages using the CakePHP ExceptionRenderer.
*/
class ErrorHandlerMiddleware
{
use InstanceConfigTrait;
/**
* Default configuration values.
*
* - `log` Enable logging of exceptions.
* - `skipLog` List of exceptions to skip logging. Exceptions that
* extend one of the listed exceptions will also not be logged. Example:
*
* ```
* 'skipLog' => ['Cake\Error\NotFoundException', 'Cake\Error\UnauthorizedException']
* ```
*
* - `trace` Should error logs include stack traces?
*
* @var array
*/
protected $_defaultConfig = [
'skipLog' => [],
'log' => true,
'trace' => false,
];
/**
* Exception render.
*
* @var \Cake\Error\ExceptionRendererInterface|string|null
*/
protected $exceptionRenderer;
/**
* Constructor
*
* @param string|callable|null $exceptionRenderer The renderer or class name
* to use or a callable factory. If null, Configure::read('Error.exceptionRenderer')
* will be used.
* @param array $config Configuration options to use. If empty, `Configure::read('Error')`
* will be used.
*/
public function __construct($exceptionRenderer = null, array $config = [])
{
if ($exceptionRenderer) {
$this->exceptionRenderer = $exceptionRenderer;
}
$config = $config ?: Configure::read('Error');
$this->setConfig($config);
}
/**
* Wrap the remaining middleware with error handling.
*
* @param \Psr\Http\Message\ServerRequestInterface $request The request.
* @param \Psr\Http\Message\ResponseInterface $response The response.
* @param callable $next Callback to invoke the next middleware.
* @return \Psr\Http\Message\ResponseInterface A response
*/
public function __invoke($request, $response, $next)
{
try {
return $next($request, $response);
} catch (\Exception $e) {
return $this->handleException($e, $request, $response);
}
}
/**
* Handle an exception and generate an error response
*
* @param \Exception $exception The exception to handle.
* @param \Psr\Http\Message\ServerRequestInterface $request The request.
* @param \Psr\Http\Message\ResponseInterface $response The response.
* @return \Psr\Http\Message\ResponseInterface A response
*/
public function handleException($exception, $request, $response)
{
$renderer = $this->getRenderer($exception);
try {
$res = $renderer->render();
$this->logException($request, $exception);
return $res;
} catch (\Exception $e) {
$this->logException($request, $e);
$body = $response->getBody();
$body->write('An Internal Server Error Occurred');
$response = $response->withStatus(500)
->withBody($body);
}
return $response;
}
/**
* Get a renderer instance
*
* @param \Exception $exception The exception being rendered.
* @return \Cake\Error\ExceptionRendererInterface The exception renderer.
* @throws \Exception When the renderer class cannot be found.
*/
protected function getRenderer($exception)
{
if (!$this->exceptionRenderer) {
$this->exceptionRenderer = $this->getConfig('exceptionRenderer') ?: ExceptionRenderer::class;
}
if (is_string($this->exceptionRenderer)) {
$class = App::className($this->exceptionRenderer, 'Error');
if (!$class) {
throw new Exception(sprintf(
"The '%s' renderer class could not be found.",
$this->exceptionRenderer
));
}
return new $class($exception);
}
$factory = $this->exceptionRenderer;
return $factory($exception);
}
/**
* Log an error for the exception if applicable.
*
* @param \Psr\Http\Message\ServerRequestInterface $request The current request.
* @param \Exception $exception The exception to log a message for.
* @return void
*/
protected function logException($request, $exception)
{
if (!$this->getConfig('log')) {
return;
}
$skipLog = $this->getConfig('skipLog');
if ($skipLog) {
foreach ((array)$skipLog as $class) {
if ($exception instanceof $class) {
return;
}
}
}
Log::error($this->getMessage($request, $exception));
}
/**
* Generate the error log message.
*
* @param \Psr\Http\Message\ServerRequestInterface $request The current request.
* @param \Exception $exception The exception to log a message for.
* @return string Error message
*/
protected function getMessage($request, $exception)
{
$message = sprintf(
'[%s] %s',
get_class($exception),
$exception->getMessage()
);
$debug = Configure::read('debug');
if ($debug && method_exists($exception, 'getAttributes')) {
$attributes = $exception->getAttributes();
if ($attributes) {
$message .= "\nException Attributes: " . var_export($exception->getAttributes(), true);
}
}
$message .= "\nRequest URL: " . $request->getRequestTarget();
$referer = $request->getHeaderLine('Referer');
if ($referer) {
$message .= "\nReferer URL: " . $referer;
}
if ($this->getConfig('trace')) {
$message .= "\nStack Trace:\n" . $exception->getTraceAsString() . "\n\n";
}
return $message;
}
}