Skip to content
Navigation Menu
{{ message }}
-
-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathExceptionHandler.php
More file actions
317 lines (292 loc) · 9.03 KB
/
Copy pathExceptionHandler.php
File metadata and controls
317 lines (292 loc) · 9.03 KB
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
<?php declare(strict_types=1);
/*
* This file is part of Aplus Framework Debug Library.
*
* (c) Natan Felles <natanfelles@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Framework\Debug;
use ErrorException;
use Framework\CLI\CLI;
use Framework\Helpers\Isolation;
use Framework\Language\Language;
use Framework\Log\Logger;
use InvalidArgumentException;
use RuntimeException;
use Throwable;
/**
* Class ExceptionHandler.
*
* @package debug
*/
class ExceptionHandler
{
/**
* Development environment.
*/
public const string DEVELOPMENT = 'development';
/**
* Production environment.
*/
public const string PRODUCTION = 'production';
protected string $developmentView = __DIR__ . '/Views/exceptions/development.php';
protected string $productionView = __DIR__ . '/Views/exceptions/production.php';
protected ?Logger $logger = null;
protected string $environment = ExceptionHandler::PRODUCTION;
protected Language $language;
protected bool $testing = false;
protected SearchEngines $searchEngines;
/**
* ExceptionHandler constructor.
*
* @param string $environment
* @param Logger|null $logger
* @param Language|null $language
*
* @throws InvalidArgumentException if environment is invalid
*/
public function __construct(
string $environment = ExceptionHandler::PRODUCTION,
?Logger $logger = null,
?Language $language = null
) {
$this->setEnvironment($environment);
if ($logger) {
$this->logger = $logger;
}
if ($language) {
$this->setLanguage($language);
}
}
public function setEnvironment(string $environment) : static
{
if (!\in_array($environment, [
static::DEVELOPMENT,
static::PRODUCTION,
], true)) {
throw new InvalidArgumentException('Invalid environment: ' . $environment);
}
$this->environment = $environment;
return $this;
}
public function getEnvironment() : string
{
return $this->environment;
}
/**
* @return Logger|null
*/
public function getLogger() : ?Logger
{
return $this->logger;
}
public function setLanguage(?Language $language = null) : static
{
$this->language = $language ?? new Language();
$this->language->addDirectory(__DIR__ . '/Languages');
return $this;
}
/**
* @return Language
*/
public function getLanguage() : Language
{
if (!isset($this->language)) {
$this->setLanguage();
}
return $this->language;
}
protected function validateView(string $file) : string
{
$realpath = \realpath($file);
if (!$realpath || !\is_file($realpath)) {
throw new InvalidArgumentException(
'Invalid exceptions view file: ' . $file
);
}
return $realpath;
}
public function setDevelopmentView(string $file) : static
{
$this->developmentView = $this->validateView($file);
return $this;
}
public function getDevelopmentView() : string
{
return $this->developmentView;
}
public function setProductionView(string $file) : static
{
$this->productionView = $this->validateView($file);
return $this;
}
public function getProductionView() : string
{
return $this->productionView;
}
public function initialize(bool $handleErrors = true) : void
{
\set_exception_handler([$this, 'exceptionHandler']);
if ($handleErrors) {
\set_error_handler([$this, 'errorHandler']);
}
}
/**
* Exception handler.
*
* @param Throwable $exception The Throwable, exception, instance
*
* @throws RuntimeException if view file is not found
*/
public function exceptionHandler(Throwable $exception) : void
{
if (\ob_get_length()) {
\ob_end_clean();
}
$this->log((string) $exception);
if ($this->isCli()) {
$this->cliError($exception);
return;
}
\http_response_code(500);
if (!\headers_sent()) {
$this->sendHeaders();
}
if ($this->isJson() || $this->acceptJson()) {
$this->sendJson($exception);
return;
}
$file = $this->getEnvironment() === static::DEVELOPMENT
? $this->getDevelopmentView()
: $this->getProductionView();
Isolation::require($file, [
'handler' => $this,
'exception' => $exception,
]);
}
protected function isCli() : bool
{
return \PHP_SAPI === 'cli' || \defined('STDIN');
}
protected function isJson() : bool
{
return isset($_SERVER['HTTP_CONTENT_TYPE'])
&& \str_starts_with($_SERVER['HTTP_CONTENT_TYPE'], 'application/json');
}
protected function acceptJson() : bool
{
return isset($_SERVER['HTTP_ACCEPT'])
&& \str_contains($_SERVER['HTTP_ACCEPT'], 'application/json');
}
protected function sendJson(Throwable $exception) : void
{
$data = $this->getEnvironment() === static::DEVELOPMENT
? [
'exception' => $exception::class,
'message' => $exception->getMessage(),
'file' => $exception->getFile(),
'line' => $exception->getLine(),
'trace' => $exception->getTrace(),
]
: [
'message' => $this->getLanguage()->render('debug', 'exceptionDescription'),
];
echo \json_encode([
'status' => [
'code' => 500,
'reason' => 'Internal Server Error',
],
'data' => $data,
], \JSON_THROW_ON_ERROR | \JSON_UNESCAPED_SLASHES | \JSON_UNESCAPED_UNICODE);
}
protected function sendHeaders() : void
{
$contentType = 'text/html';
if ($this->isJson() || $this->acceptJson()) {
$contentType = 'application/json';
}
\header('Content-Type: ' . $contentType . '; charset=UTF-8');
}
protected function cliError(Throwable $exception) : void
{
$language = $this->getLanguage();
$message = $language->render('debug', 'exception')
. ': ' . $exception::class . \PHP_EOL;
$message .= $language->render('debug', 'message')
. ': ' . $exception->getMessage() . \PHP_EOL;
$message .= $language->render('debug', 'file')
. ': ' . $exception->getFile() . \PHP_EOL;
$message .= $language->render('debug', 'line')
. ': ' . $exception->getLine() . \PHP_EOL;
$message .= $language->render('debug', 'trace')
. ': ' . $exception->getTraceAsString();
CLI::error($message, $this->testing ? null : 1);
}
protected function log(string $message) : void
{
$this->getLogger()?->logCritical($message);
}
/**
* Error handler.
*
* @param int $errno The level of the error raised
* @param string $errstr The error message
* @param string|null $errfile The filename that the error was raised in
* @param int|null $errline The line number where the error was raised
*
* @see http://php.net/manual/en/function.set-error-handler.php
*
* @throws ErrorException if the error is included in the error_reporting
*
* @return bool
*/
public function errorHandler(
int $errno,
string $errstr,
?string $errfile = null,
?int $errline = null
) : bool {
if (!(\error_reporting() & $errno)) {
return true;
}
$type = match ($errno) {
\E_ERROR => 'Error',
\E_WARNING => 'Warning',
\E_PARSE => 'Parse',
\E_NOTICE => 'Notice',
\E_CORE_ERROR => 'Core Error',
\E_CORE_WARNING => 'Core Warning',
\E_COMPILE_ERROR => 'Compile Error',
\E_COMPILE_WARNING => 'Compile Warning',
\E_USER_ERROR => 'User Error',
\E_USER_WARNING => 'User Warning',
\E_USER_NOTICE => 'User Notice',
\E_RECOVERABLE_ERROR => 'Recoverable Error',
\E_DEPRECATED => 'Deprecated',
\E_USER_DEPRECATED => 'User Deprecated',
\E_ALL => 'All',
default => '',
};
throw new ErrorException(
($type ? $type . ': ' : '') . $errstr,
0,
$errno,
$errfile,
$errline
);
}
public function getSearchEngines() : SearchEngines
{
if (!isset($this->searchEngines)) {
$this->setSearchEngines(new SearchEngines());
}
return $this->searchEngines;
}
public function setSearchEngines(SearchEngines $searchEngines) : static
{
$this->searchEngines = $searchEngines;
return $this;
}
}
You can’t perform that action at this time.