-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
ConsoleExceptionRenderer.php
141 lines (128 loc) · 4.12 KB
/
ConsoleExceptionRenderer.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
<?php
declare(strict_types=1);
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://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. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 4.4.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Error\Renderer;
use Cake\Console\ConsoleOutput;
use Cake\Core\Configure;
use Cake\Core\Exception\CakeException;
use Cake\Error\Debugger;
use Cake\Error\ExceptionRendererInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Throwable;
/**
* Plain text exception rendering with a stack trace.
*
* Useful in CI or plain text environments.
*/
class ConsoleExceptionRenderer implements ExceptionRendererInterface
{
/**
* @var \Throwable
*/
private Throwable $error;
/**
* @var \Cake\Console\ConsoleOutput
*/
private ConsoleOutput $output;
/**
* @var bool
*/
private bool $trace;
/**
* Constructor.
*
* @param \Throwable $error The error to render.
* @param \Psr\Http\Message\ServerRequestInterface|null $request Not used.
* @param array $config Error handling configuration.
*/
public function __construct(Throwable $error, ?ServerRequestInterface $request, array $config)
{
$this->error = $error;
$this->output = $config['stderr'] ?? new ConsoleOutput('php://stderr');
$this->trace = $config['trace'] ?? true;
}
/**
* Render an exception into a plain text message.
*
* @return \Psr\Http\Message\ResponseInterface|string
*/
public function render(): ResponseInterface|string
{
$exceptions = [$this->error];
$previous = $this->error->getPrevious();
while ($previous !== null) {
$exceptions[] = $previous;
$previous = $previous->getPrevious();
}
$out = [];
foreach ($exceptions as $i => $error) {
$parent = $i > 0 ? $exceptions[$i - 1] : null;
$out = array_merge($out, $this->renderException($error, $parent));
}
return join("\n", $out);
}
/**
* Render an individual exception
*
* @param \Throwable $exception The exception to render.
* @param ?\Throwable $parent The Exception index in the chain
* @return array
*/
protected function renderException(Throwable $exception, ?Throwable $parent): array
{
$out = [
sprintf(
'<error>%s[%s] %s</error> in %s on line %s',
$parent ? 'Caused by ' : '',
$exception::class,
$exception->getMessage(),
$exception->getFile(),
$exception->getLine()
),
];
$debug = Configure::read('debug');
if ($debug && $exception instanceof CakeException) {
$attributes = $exception->getAttributes();
if ($attributes) {
$out[] = '';
$out[] = '<info>Exception Attributes</info>';
$out[] = '';
$out[] = var_export($exception->getAttributes(), true);
}
}
if ($this->trace) {
$stacktrace = Debugger::getUniqueFrames($exception, $parent);
$out[] = '';
$out[] = '<info>Stack Trace:</info>';
$out[] = '';
$out[] = Debugger::formatTrace($stacktrace, ['format' => 'text']);
$out[] = '';
}
return $out;
}
/**
* Write output to the output stream
*
* @param \Psr\Http\Message\ResponseInterface|string $output The output to print.
* @return void
*/
public function write(ResponseInterface|string $output): void
{
if (is_string($output)) {
$this->output->write($output);
}
}
}