/
ExceptionRenderer.php
354 lines (322 loc) · 11.1 KB
/
ExceptionRenderer.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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
<?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 2.0.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Error;
use Cake\Controller\Controller;
use Cake\Core\App;
use Cake\Core\Configure;
use Cake\Core\Exception\Exception as CakeException;
use Cake\Core\Exception\MissingPluginException;
use Cake\Event\Event;
use Cake\Network\Exception\HttpException;
use Cake\Network\Request;
use Cake\Network\Response;
use Cake\Routing\DispatcherFactory;
use Cake\Routing\Router;
use Cake\Utility\Inflector;
use Cake\View\Exception\MissingTemplateException;
use Exception;
/**
* Exception Renderer.
*
* Captures and handles all unhandled exceptions. Displays helpful framework errors when debug is true.
* When debug is false a CakeException will render 404 or 500 errors. If an uncaught exception is thrown
* and it is a type that ExceptionHandler does not know about it will be treated as a 500 error.
*
* ### Implementing application specific exception rendering
*
* You can implement application specific exception handling by creating a subclass of
* ExceptionRenderer and configure it to be the `exceptionRenderer` in config/error.php
*
* #### Using a subclass of ExceptionRenderer
*
* Using a subclass of ExceptionRenderer gives you full control over how Exceptions are rendered, you
* can configure your class in your config/app.php.
*/
class ExceptionRenderer
{
/**
* Controller instance.
*
* @var Controller
*/
public $controller = null;
/**
* Template to render for Cake\Core\Exception\Exception
*
* @var string
*/
public $template = '';
/**
* The method corresponding to the Exception this object is for.
*
* @var string
*/
public $method = '';
/**
* The exception being handled.
*
* @var \Exception
*/
public $error = null;
/**
* Creates the controller to perform rendering on the error response.
* If the error is a Cake\Core\Exception\Exception it will be converted to either a 400 or a 500
* code error depending on the code used to construct the error.
*
* @param \Exception $exception Exception
*/
public function __construct(Exception $exception)
{
$this->error = $exception;
$this->controller = $this->_getController();
}
/**
* Get the controller instance to handle the exception.
* Override this method in subclasses to customize the controller used.
* This method returns the built in `ErrorController` normally, or if an error is repeated
* a bare controller will be used.
*
* @return \Cake\Controller\Controller
* @triggers Controller.startup $controller
*/
protected function _getController()
{
if (!$request = Router::getRequest(true)) {
$request = Request::createFromGlobals();
}
$response = new Response();
try {
$class = App::className('Error', 'Controller', 'Controller');
$controller = new $class($request, $response);
$controller->startupProcess();
$startup = true;
} catch (Exception $e) {
$startup = false;
}
// Retry RequestHandler, as another aspect of startupProcess()
// could have failed. Ignore any exceptions out of startup, as
// there could be userland input data parsers.
if ($startup === false && !empty($controller) && isset($controller->RequestHandler)) {
try {
$event = new Event('Controller.startup', $controller);
$controller->RequestHandler->startup($event);
} catch (Exception $e) {
}
}
if (empty($controller)) {
$controller = new Controller($request, $response);
$controller->viewPath = 'Error';
}
return $controller;
}
/**
* Renders the response for the exception.
*
* @return \Cake\Network\Response The response to be sent.
*/
public function render()
{
$exception = $this->error;
$code = $this->_code($exception);
$method = $this->_method($exception);
$template = $this->_template($exception, $method, $code);
$isDebug = Configure::read('debug');
if (($isDebug || $exception instanceof HttpException) &&
method_exists($this, $method)
) {
return $this->_customMethod($method, $exception);
}
$message = $this->_message($exception, $code);
$url = $this->controller->request->here();
if (method_exists($exception, 'responseHeader')) {
$this->controller->response->header($exception->responseHeader());
}
$this->controller->response->statusCode($code);
$this->controller->set([
'message' => $message,
'url' => h($url),
'error' => $exception,
'code' => $code,
'_serialize' => ['message', 'url', 'code']
]);
if ($exception instanceof CakeException && $isDebug) {
$this->controller->set($this->error->getAttributes());
}
return $this->_outputMessage($template);
}
/**
* Render a custom error method/template.
*
* @param string $method The method name to invoke.
* @param \Exception $exception The exception to render.
* @return \Cake\Network\Response The response to send.
*/
protected function _customMethod($method, $exception)
{
$result = call_user_func([$this, $method], $exception);
$this->_shutdown();
if (is_string($result)) {
$this->controller->response->body($result);
$result = $this->controller->response;
}
return $result;
}
/**
* Get method name
*
* @param \Exception $exception Exception instance.
* @return string
*/
protected function _method(\Exception $exception)
{
list(, $baseClass) = namespaceSplit(get_class($exception));
if (substr($baseClass, -9) === 'Exception') {
$baseClass = substr($baseClass, 0, -9);
}
$method = Inflector::variable($baseClass) ?: 'error500';
return $this->method = $method;
}
/**
* Get error message.
*
* @param \Exception $exception Exception
* @param int $code Error code
* @return string Error message
*/
protected function _message(\Exception $exception, $code)
{
$message = $this->error->getMessage();
if (!Configure::read('debug') &&
!($exception instanceof HttpException)
) {
if ($code < 500) {
$message = __d('cake', 'Not Found');
} else {
$message = __d('cake', 'An Internal Error Has Occurred.');
}
}
return $message;
}
/**
* Get template for rendering exception info.
*
* @param \Exception $exception Exception instance.
* @param string $method Method name
* @param int $code Error code
* @return string Template name
*/
protected function _template(\Exception $exception, $method, $code)
{
$isHttpException = $exception instanceof HttpException;
if (!Configure::read('debug') && !$isHttpException) {
$template = 'error500';
if ($code < 500) {
$template = 'error400';
}
return $this->template = $template;
}
if ($isHttpException) {
$template = 'error500';
if ($code < 500) {
$template = 'error400';
}
return $this->template = $template;
}
$template = $method ?: 'error500';
if ($exception instanceof \PDOException) {
$template = 'pdo_error';
}
return $this->template = $template;
}
/**
* Get an error code value within range 400 to 506
*
* @param \Exception $exception Exception
* @return int Error code value within range 400 to 506
*/
protected function _code(\Exception $exception)
{
$code = 500;
$errorCode = $exception->getCode();
if ($errorCode >= 400 && $errorCode < 506) {
$code = $errorCode;
}
return $code;
}
/**
* Generate the response using the controller object.
*
* @param string $template The template to render.
* @return \Cake\Network\Response A response object that can be sent.
*/
protected function _outputMessage($template)
{
try {
$this->controller->render($template);
return $this->_shutdown();
} catch (MissingTemplateException $e) {
$attributes = $e->getAttributes();
if (isset($attributes['file']) && strpos($attributes['file'], 'error500') !== false) {
return $this->_outputMessageSafe('error500');
}
return $this->_outputMessage('error500');
} catch (MissingPluginException $e) {
$attributes = $e->getAttributes();
if (isset($attributes['plugin']) && $attributes['plugin'] === $this->controller->plugin) {
$this->controller->plugin = null;
}
return $this->_outputMessageSafe('error500');
} catch (\Exception $e) {
return $this->_outputMessageSafe('error500');
}
}
/**
* A safer way to render error messages, replaces all helpers, with basics
* and doesn't call component methods.
*
* @param string $template The template to render
* @return \Cake\Network\Response A response object that can be sent.
*/
protected function _outputMessageSafe($template)
{
$this->controller->layoutPath = null;
$this->controller->subDir = null;
$this->controller->viewPath = 'Error';
$this->controller->layout = 'error';
$this->controller->helpers = ['Form', 'Html', 'Session'];
$view = $this->controller->createView();
$this->controller->response->body($view->render($template, 'error'));
$this->controller->response->type('html');
return $this->controller->response;
}
/**
* Run the shutdown events.
*
* Triggers the afterFilter and afterDispatch events.
*
* @return \Cake\Network\Response The response to serve.
*/
protected function _shutdown()
{
$this->controller->dispatchEvent('Controller.shutdown');
$dispatcher = DispatcherFactory::create();
$args = [
'request' => $this->controller->request,
'response' => $this->controller->response
];
$result = $dispatcher->dispatchEvent('Dispatcher.afterDispatch', $args);
return $result->data['response'];
}
}