Digitalstack/myaac
2
0
Fork 0
mirror of https://github.com/slawkens/myaac.git synced 2025-04-26 17:29:21 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add Whoops exception handler (nicer debug info in dev mode)

Browse Source 
On production = no errors
This commit is contained in:
slawkens 2023-05-29 08:55:26 +02:00
parent 7690811da3
commit 7c2c88f780
7 changed files with 15 additions and 127 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -30,6 +30,7 @@ Minimum PHP version for this release is 7.2.5.
* support for Account Number
* suggest account number option
* many new functions, hooks and configurables
* better Exception Handler (Whoops - https://github.com/filp/whoops)
### Changed
* Composer is now used for external libraries like: Twig, PHPMailer, fast-route etc.

2
common.php
View File

@ -141,8 +141,6 @@ if(!IS_CLI) {
define('ADMIN_URL', SERVER_URL . BASE_DIR . '/' . ADMIN_PANEL_FOLDER . '/');
//define('CURRENT_URL', BASE_URL . $_SERVER['REQUEST_URI']);
require SYSTEM . 'exception.php';
}
$autoloadFile = VENDOR . 'autoload.php';

3
composer.json
View File

@ -11,6 +11,7 @@
"twig/twig": "^2.0",
"erusev/parsedown": "^1.7",
"nikic/fast-route": "^1.3",
"matomo/device-detector": "^6.0"
"matomo/device-detector": "^6.0",
"filp/whoops": "^2.15"
}
}

46
system/exception.php
View File

@ -1,54 +1,20 @@
<?php
/**
* Exception handler
* Whoops exception handler
*
* @package MyAAC
* @author Slawkens <slawkens@gmail.com>
* @copyright 2023 MyAAC
* @link https://my-aac.org
*/
require LIBS . 'SensitiveException.php';
/**
* @param Exception $exception
*/
function exception_handler($exception) {
$message = $exception->getMessage();
if($exception instanceof SensitiveException) {
$message = 'This error is sensitive and has been logged into ' . LOGS . 'error.log.<br/>View this file for more information.';
$whoops = new \Whoops\Run;
// log error to file
$f = fopen(LOGS . 'error.log', 'ab');
if(!$f) {
$message = 'We wanted to save detailed informations about this error, but file: ' . LOGS . "error.log couldn't be opened for writing.. so the detailed information couldn't be saved.. are you sure directory system/logs is writable by web server? Correct this, and then refresh this site.";
if(IS_CLI) {
$whoops->pushHandler(new \Whoops\Handler\PlainTextHandler);
}
else {
fwrite($f, '[' . date(DateTime::RFC1123) . '] ' . $exception->getMessage() . PHP_EOL);
fclose($f);
}
$whoops->pushHandler(new \Whoops\Handler\PrettyPageHandler);
}
$backtrace_formatted = nl2br($exception->getTraceAsString());
// display basic error message without template
// template is missing, why? probably someone deleted templates dir, or it wasn't downloaded right
$template_file = SYSTEM . 'templates/exception.html.twig';
if(!file_exists($template_file)) {
echo 'Something went terribly wrong..<br/><br/>';
echo "$message<br/><br/>";
echo 'Backtrace:<br>';
echo $backtrace_formatted;
return;
}
// display beautiful error message
// the file is .twig.html, but its not really parsed by Twig
// we just replace some values manually
// cause in case Twig throws exception, we can show it too
$content = file_get_contents($template_file);
$content = str_replace(array('{{ BASE_URL }}', '{{ exceptionClass }}', '{{ message }}', '{{ backtrace }}', '{{ powered_by }}'), array(BASE_URL, get_class($exception), $message, $backtrace_formatted, base64_decode('UG93ZXJlZCBieSA8YSBocmVmPSJodHRwOi8vbXktYWFjLm9yZyIgdGFyZ2V0PSJfYmxhbmsiPk15QUFDLjwvYT4=')), $content);
echo $content;
}
set_exception_handler('exception_handler');
$whoops->register();

4
system/init.php
View File

@ -18,6 +18,10 @@ if(!isset($config['installed']) || !$config['installed']) {
throw new RuntimeException('MyAAC has not been installed yet or there was error during installation. Please install again.');
}
if(config('env') === 'dev') {
require SYSTEM . 'exception.php';
}
date_default_timezone_set($config['date_timezone']);
// take care of trailing slash at the end
if($config['server_path'][strlen($config['server_path']) - 1] !== '/')

3
system/libs/SensitiveException.php
View File

@ -1,3 +0,0 @@
<?php
class SensitiveException extends Exception {}

79
system/templates/exception.html.twig
View File

@ -1,79 +0,0 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Something went wrong...</title>
<meta name="description" content="myaac">
<meta name="generator" content="MyAAC">
<link rel="stylesheet" href="tools/css/messages.css">
<link rel="shortcut icon" href="images/error.ico">
<base href="{{ BASE_URL }}" />
<style>
body{
background-color: #e3e7ed;
font-family: Verdana, Geneva, sans-serif;
}
.center {
height: 500px;
position: absolute;
top:0;
bottom: 0;
left: 0;
right: 0;
margin: auto;
}
.wide{
min-width: 350px;
max-width: 350px;
}
.big{
font-size: 20px!important;
}
#footer {
position: absolute;
bottom: 15px;
width: 100%;
border-top: 1px solid #eee;
text-align: center;
color: #555;
}
#footer p {
text-align: center;
}
.error {
font-weight: normal;
font-size: 12px;
}
</style>
<!--[if lt IE 9]>
<script src="tools/js/html5shiv.min.js"></script>
<![endif]-->
</head>
<body>
<div class="center wide">
<h2 class="wide">Whoops something went wrong...</h2>
<div class="error wide">
Exception class: {{ exceptionClass }}()
<br/><br/>
{{ message }}
<br/><br/><br/>
<b>Backtrace:</b><br/><br/>
{{ backtrace }}
</div>
</div>
<div id="footer">
<p>{{ powered_by }}</p>
</div>
</body>
</html>