-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Expand file tree
/
Copy pathErrorHandler.php
More file actions
582 lines (516 loc) · 17.4 KB
/
ErrorHandler.php
File metadata and controls
582 lines (516 loc) · 17.4 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
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
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
<?php
declare(strict_types=1);
namespace PhpMyAdmin\Error;
use ErrorException;
use Fig\Http\Message\StatusCodeInterface;
use Laminas\HttpHandlerRunner\Emitter\SapiEmitter;
use PhpMyAdmin\Config;
use PhpMyAdmin\Current;
use PhpMyAdmin\Exceptions\ExitException;
use PhpMyAdmin\Http\Factory\ResponseFactory;
use PhpMyAdmin\ResponseRenderer;
use PhpMyAdmin\Url;
use Throwable;
use function __;
use function array_filter;
use function array_splice;
use function count;
use function defined;
use function error_reporting;
use function function_exists;
use function htmlspecialchars;
use function sprintf;
use const E_COMPILE_ERROR;
use const E_COMPILE_WARNING;
use const E_CORE_ERROR;
use const E_CORE_WARNING;
use const E_DEPRECATED;
use const E_ERROR;
use const E_NOTICE;
use const E_PARSE;
use const E_RECOVERABLE_ERROR;
use const E_USER_DEPRECATED;
use const E_USER_ERROR;
use const E_USER_NOTICE;
use const E_USER_WARNING;
use const E_WARNING;
/**
* handling errors
*/
class ErrorHandler
{
private static self|null $instance = null;
/**
* holds errors to be displayed or reported later ...
*
* @var Error[]
*/
private array $errors = [];
/**
* Hide location of errors
*/
private bool $hideLocation = false;
/**
* Initial error reporting state
*/
private int $errorReporting = 0;
public function __construct()
{
if (! function_exists('error_reporting')) {
return;
}
$this->errorReporting = error_reporting();
}
public static function getInstance(): self
{
if (self::$instance === null) {
self::$instance = new self();
}
return self::$instance;
}
/**
* Destructor
*
* stores errors in session
*/
public function __destruct()
{
if (! isset($_SESSION['errors'])) {
$_SESSION['errors'] = [];
}
// remember only not displayed errors
foreach ($this->errors as $key => $error) {
/**
* We don't want to store all errors here as it would
* explode user session.
*/
if (count($_SESSION['errors']) >= 10) {
$error = new Error(
0,
__('Too many error messages, some are not displayed.'),
__FILE__,
__LINE__,
);
$_SESSION['errors'][$error->getHash()] = $error;
break;
}
if ($error->isDisplayed()) {
continue;
}
$_SESSION['errors'][$key] = $error;
}
}
/**
* Toggles location hiding
*
* @param bool $hide Whether to hide
*/
public function setHideLocation(bool $hide): void
{
$this->hideLocation = $hide;
}
/**
* returns array with all errors
*
* @param bool $check Whether to check for session errors
*
* @return Error[]
*/
public function getErrors(bool $check = true): array
{
if ($check) {
$this->checkSavedErrors();
}
return $this->errors;
}
/**
* returns the errors occurred in the current run only.
* Does not include the errors saved in the SESSION
*
* @return Error[]
*/
public function getCurrentErrors(): array
{
return $this->errors;
}
/**
* Pops recent errors from the storage
*
* @param int $count Old error count (amount of errors to splice)
*
* @return Error[] The non spliced elements (total-$count)
*/
public function sliceErrors(int $count): array
{
// store the errors before any operation, example number of items: 10
$errors = $this->getErrors(false);
// before array_splice $this->errors has 10 elements
// cut out $count items out, let's say $count = 9
// $errors will now contain 10 - 9 = 1 elements
// $this->errors will contain the 9 elements left
$this->errors = array_splice($errors, 0, $count);
return $errors;
}
/**
* Error handler - called when errors are triggered/occurred
*
* This calls the addError() function, escaping the error string
* Ignores the errors wherever Error Control Operator (@) is used.
*
* @param int $errno error number
* @param string $errstr error string
* @param string $errfile error file
* @param int $errline error line
*
* @return false
*
* @throws ErrorException
*/
public function handleError(
int $errno,
string $errstr,
string $errfile,
int $errline,
): bool {
if (! function_exists('error_reporting')) {
return false;
}
/**
* Check if Error Control Operator (@) was used.
* See: https://github.com/phpmyadmin/phpmyadmin/issues/16729
*/
$isSilenced = (error_reporting() & $errno) === 0;
$config = Config::getInstance();
if ($config->config->environment === 'development' && ! $isSilenced) {
throw new ErrorException($errstr, 0, $errno, $errfile, $errline);
}
if (! $isSilenced || $this->errorReporting === 0) {
$this->addError($errstr, $errno, $errfile, $errline);
}
return false;
}
/**
* Hides exception if it's not in the development environment.
*/
public function handleException(Throwable $exception): void
{
$this->hideLocation = Config::getInstance()->config->environment !== 'development';
$message = $exception::class;
if (! ($exception instanceof \Error) || ! $this->hideLocation) {
$message .= ': ' . $exception->getMessage();
}
$this->addError(
$message,
(int) $exception->getCode(),
$exception->getFile(),
$exception->getLine(),
);
}
/**
* Add an error; can also be called directly (with or without escaping)
*
* The following error types cannot be handled with a user defined function:
* E_ERROR, E_PARSE, E_CORE_ERROR, E_CORE_WARNING, E_COMPILE_ERROR,
* E_COMPILE_WARNING,
* and most of E_STRICT raised in the file where set_error_handler() is called.
*
* Do not use the context parameter as we want to avoid storing the
* complete $GLOBALS inside $_SESSION['errors']
*
* @param string $errstr error string
* @param int $errno error number
* @param string $errfile error file
* @param int $errline error line
* @param bool $escape whether to escape the error string
*/
public function addError(
string $errstr,
int $errno,
string $errfile,
int $errline,
bool $escape = true,
): void {
if ($escape) {
$errstr = htmlspecialchars($errstr);
}
// create error object
$error = new Error($errno, $errstr, $errfile, $errline);
$error->setHideLocation($this->hideLocation);
// Deprecation errors will be shown in development environment, as they will have a different number.
if ($error->getErrorNumber() !== E_DEPRECATED) {
// do not repeat errors
$this->errors[$error->getHash()] = $error;
}
switch ($error->getErrorNumber()) {
case 2048: // E_STRICT
case E_DEPRECATED:
case E_NOTICE:
case E_WARNING:
case E_CORE_WARNING:
case E_COMPILE_WARNING:
case E_RECOVERABLE_ERROR:
/* Avoid rendering BB code in PHP errors */
$error->setBBCode(false);
break;
case E_USER_NOTICE:
case E_USER_WARNING:
case E_USER_ERROR:
case E_USER_DEPRECATED:
// just collect the error
// display is called from outside
break;
case E_ERROR:
case E_PARSE:
case E_CORE_ERROR:
case E_COMPILE_ERROR:
default:
// FATAL error, display it and exit
$this->dispFatalError($error);
}
}
public function addUserError(string $message, bool $escape = true): void
{
// The file name and line number are not relevant for user errors
$error = new Error(
E_USER_WARNING,
$escape ? htmlspecialchars($message) : $message,
__FILE__,
__LINE__,
);
$this->errors[$error->getHash()] = $error;
}
public function addNotice(string $message, bool $escape = true): void
{
// The file name and line number are not relevant for user errors
$error = new Error(
E_USER_NOTICE,
$escape ? htmlspecialchars($message) : $message,
__FILE__,
__LINE__,
);
$this->errors[$error->getHash()] = $error;
}
/**
* display fatal error and exit
*
* @param Error $error the error
*/
protected function dispFatalError(Error $error): never
{
$response = ResponseFactory::create()->createResponse(StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR);
$response->getBody()->write(sprintf(
"<!DOCTYPE html>\n<html lang=\"en\">\n<head><title>%s</title></head>\n<body>\n%s\n</body>\n</html>",
$error->getTitle(),
$error->getDisplay(),
));
(new SapiEmitter())->emit($response);
if (defined('TESTSUITE')) {
throw new ExitException();
}
exit;
}
/**
* Displays user errors not displayed
*/
public function dispUserErrors(): void
{
echo $this->getDispUserErrors();
}
/**
* Renders user errors not displayed
*/
private function getDispUserErrors(): string
{
$retval = '';
foreach ($this->getErrors() as $error) {
if (! $error->isUserError() || $error->isDisplayed()) {
continue;
}
$retval .= $error->getDisplay();
}
return $retval;
}
/**
* renders errors not displayed
*/
public function getDispErrors(): string
{
$retval = '';
// display errors if SendErrorReports is set to 'ask'.
$config = Config::getInstance();
if ($config->config->SendErrorReports !== 'never') {
foreach ($this->getErrors() as $error) {
if ($error->isDisplayed()) {
continue;
}
$retval .= $error->getDisplay();
}
} else {
$retval .= $this->getDispUserErrors();
}
if ($config->config->SendErrorReports !== 'never' && $this->countActualErrors() !== 0) {
// add report button.
$retval .= '<form method="post" action="' . Url::getFromRoute('/error-report')
. '" id="pma_report_errors_form"';
if ($config->config->SendErrorReports === 'always') {
// in case of 'always', generate 'invisible' form.
$retval .= ' class="hide"';
}
$retval .= '>';
$retval .= Url::getHiddenFields([
'exception_type' => 'php',
'send_error_report' => '1',
'server' => Current::$server,
]);
$retval .= '<input type="submit" value="'
. __('Report')
. '" id="pma_report_errors" class="btn btn-primary float-end">'
. '<input type="checkbox" name="always_send"'
. ' id="errorReportAlwaysSendCheckbox" value="true">'
. '<label for="errorReportAlwaysSendCheckbox">'
. __('Automatically send report next time')
. '</label>';
if ($config->config->SendErrorReports === 'ask') {
// add ignore buttons
$retval .= '<input type="submit" value="'
. __('Ignore')
. '" id="pma_ignore_errors_bottom" class="btn btn-secondary float-end">';
}
$retval .= '<input type="submit" value="'
. __('Ignore All')
. '" id="pma_ignore_all_errors_bottom" class="btn btn-secondary float-end">';
$retval .= '</form>';
}
return $retval;
}
/**
* look in session for saved errors
*/
private function checkSavedErrors(): void
{
if (! isset($_SESSION['errors'])) {
return;
}
// restore saved errors
foreach ($_SESSION['errors'] as $hash => $error) {
if (! $error instanceof Error || isset($this->errors[$hash])) {
continue;
}
$this->errors[$hash] = $error;
}
// delete stored errors
$_SESSION['errors'] = [];
unset($_SESSION['errors']);
}
/**
* return count of errors
*
* @param bool $check Whether to check for session errors
*
* @return int number of errors occurred
*/
public function countErrors(bool $check = true): int
{
return count($this->getErrors($check));
}
public function countUserErrors(): int
{
return count(array_filter($this->getErrors(), static fn (Error $error): bool => $error->isUserError()));
}
private function countActualErrors(): int
{
return count(array_filter($this->getErrors(), static fn (Error $error): bool => ! $error->isUserError()));
}
/**
* whether there are errors to display or not
*/
public function hasDisplayErrors(): bool
{
if (Config::getInstance()->config->SendErrorReports !== 'never') {
return $this->getErrors() !== [];
}
return $this->countUserErrors() !== 0;
}
/**
* Deletes previously stored errors in SESSION.
* Saves current errors in session as previous errors.
* Required to save current errors in case 'ask'
*/
public function savePreviousErrors(): void
{
unset($_SESSION['prev_errors']);
$_SESSION['prev_errors'] = $this->getCurrentErrors();
}
/**
* Function to check if there are any errors to be prompted.
* Needed because user warnings raised are
* also collected by global error handler.
* This distinguishes between the actual errors
* and user errors raised to warn user.
*/
public function hasErrorsForPrompt(): bool
{
return Config::getInstance()->config->SendErrorReports !== 'never'
&& $this->countActualErrors() !== 0;
}
/**
* Function to report all the collected php errors.
* Must be called at the end of each script
* by the {@see getInstance()} only.
*/
public function reportErrors(): void
{
if ($this->getErrors() === [] || $this->countActualErrors() === 0) {
return;
}
// Delete all the prev_errors in session & store new prev_errors in session
$this->savePreviousErrors();
$response = ResponseRenderer::getInstance();
$jsCode = '';
$config = Config::getInstance();
if ($config->config->SendErrorReports === 'always') {
if ($response->isAjax()) {
// set flag for automatic report submission.
$response->addJSON('sendErrorAlways', '1');
} else {
// send the error reports asynchronously & without asking user
$jsCode .= '$("#pma_report_errors_form").submit();'
. 'window.ajaxShowMessage(
window.Messages.phpErrorsBeingSubmitted, false
);';
// js code to appropriate focusing,
$jsCode .= '$("html, body").animate({
scrollTop:$(document).height()
}, "slow");';
}
} elseif ($config->config->SendErrorReports === 'ask') {
//ask user whether to submit errors or not.
if (! $response->isAjax()) {
// js code to show appropriate msgs, event binding & focusing.
$jsCode = 'window.ajaxShowMessage(window.Messages.phpErrorsFound);'
. '$("#pma_ignore_errors_popup").on("click", function() {
window.ignorePhpErrors()
});'
. '$("#pma_ignore_all_errors_popup").on("click",
function() {
window.ignorePhpErrors(false)
});'
. '$("#pma_ignore_errors_bottom").on("click", function(e) {
e.preventDefault();
window.ignorePhpErrors()
});'
. '$("#pma_ignore_all_errors_bottom").on("click",
function(e) {
e.preventDefault();
window.ignorePhpErrors(false)
});'
. '$("html, body").animate({
scrollTop:$(document).height()
}, "slow");';
}
}
// The errors are already sent from the response.
// Just focus on errors division upon load event.
$response->getFooterScripts()->addCode($jsCode);
}
}