From bbb8075166da0b3a315a764d20a785e4ce82e312 Mon Sep 17 00:00:00 2001 From: jove Date: Thu, 1 Sep 2016 20:45:52 +0100 Subject: [PATCH] Overhauls error handling. --- inc/display.php | 63 -------------------------------- inc/error.php | 91 +++++++++++++++++++++++++++++++++++++++++++++++ inc/functions.php | 59 +++++------------------------- 3 files changed, 99 insertions(+), 114 deletions(-) create mode 100644 inc/error.php diff --git a/inc/display.php b/inc/display.php index 90cf3434..ce39197c 100644 --- a/inc/display.php +++ b/inc/display.php @@ -71,69 +71,6 @@ function createBoardlist($mod=false) { ); } -function error($message, $priority = true, $debug_stuff = false) { - global $board, $mod, $config, $db_error; - - if ($config['syslog'] && $priority !== false) { - // Use LOG_NOTICE instead of LOG_ERR or LOG_WARNING because most error message are not significant. - _syslog($priority !== true ? $priority : LOG_NOTICE, $message); - } - - if (defined('STDIN')) { - // Running from CLI - echo('Error: ' . $message . "\n"); - debug_print_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS); - die(); - } - - if ($config['debug'] && isset($db_error)) { - $debug_stuff = array_combine(array('SQLSTATE', 'Error code', 'Error message'), $db_error); - } - - if ($config['debug']) { - $debug_stuff['backtrace'] = debug_backtrace(); - } - - // Return the bad request header, necessary for AJAX posts - // czaks: is it really so? the ajax errors only work when this is commented out - // better yet use it when ajax is disabled - if (!isset ($_POST['json_response'])) { - header($_SERVER['SERVER_PROTOCOL'] . ' 400 Bad Request'); - } - - // Is there a reason to disable this? - if (isset($_POST['json_response'])) { - header('Content-Type: text/json; charset=utf-8'); - die(json_encode(array( - 'error' => $message - ))); - } - - $pw = $config['db']['password']; - $debug_callback = function(&$item) use (&$debug_callback, $pw) { - if (is_array($item)) { - $item = array_filter($item, $debug_callback); - } - return ($item !== $pw || !$pw); - }; - - - if ($debug_stuff) - $debug_stuff = array_filter($debug_stuff, $debug_callback); - - die(Element('page.html', array( - 'config' => $config, - 'title' => _('Error'), - 'subtitle' => _('An error has occured.'), - 'body' => Element('error.html', array( - 'config' => $config, - 'message' => $message, - 'mod' => $mod, - 'board' => isset($board) ? $board : false, - 'debug' => is_array($debug_stuff) ? str_replace("\n", ' ', utf8tohtml(print_r($debug_stuff, true))) : utf8tohtml($debug_stuff) - )) - ))); -} function loginForm($error=false, $username=false, $redirect=false) { global $config; diff --git a/inc/error.php b/inc/error.php new file mode 100644 index 00000000..da707911 --- /dev/null +++ b/inc/error.php @@ -0,0 +1,91 @@ +getMessage()); +} + +set_exception_handler('exception_handler'); + +function fatal_error_handler(){ + if (($error = error_get_last()) && $error['type'] == E_ERROR) { + error('Caught fatal error: ' . $error['message'] . ' in ' . $error['file'] . ' at line ' . $error['line']); + } +} + +register_shutdown_function('fatal_error_handler'); + +$error_recursion=false; + +function error($message, $priority = true, $debug_stuff = false) { + global $board, $mod, $config, $db_error, $error_recursion; + + if($error_recursion!==false){ + die("Error recursion detected with " . $message . "
Original error:".$error_recursion); + } + + $error_recursion=$message; + + if (defined('STDIN')) { + // Running from CLI + echo('Error: ' . $message . "\n"); + debug_print_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS); + die(); + } + + if(!empty($config)){ + + if ($config['syslog'] && $priority !== false) { + // Use LOG_NOTICE instead of LOG_ERR or LOG_WARNING because most error message are not significant. + _syslog($priority !== true ? $priority : LOG_NOTICE, $message); + } + + if ($config['debug']) { + $debug_stuff=array(); + if(isset($db_error)){ + $debug_stuff = array_combine(array('SQLSTATE', 'Error code', 'Error message'), $db_error); + } + $debug_stuff['backtrace'] = debug_backtrace(); + $pw = $config['db']['password']; + $debug_callback = function(&$item) use (&$debug_callback, $pw) { + if (is_array($item)) { + return array_map($debug_callback, $item); + } + return ($item == $pw ? 'hunter2' : $item); + }; + $debug_stuff = array_map($debug_callback, $debug_stuff); + } + } + + if (isset($_POST['json_response'])) { + header('Content-Type: text/json; charset=utf-8'); + $data=array('error'=>$message); + if(!empty($config) && $config['debug']){ + $data['debug']=$debug_stuff; + } + print json_encode($data); + exit(); + } + + header($_SERVER['SERVER_PROTOCOL'] . ' 500 Internal Server Error'); + + die(Element('page.html', array( + 'config' => $config, + 'title' => _('Error'), + 'subtitle' => _('An error has occured.'), + 'body' => Element('error.html', array( + 'config' => $config, + 'message' => $message, + 'mod' => $mod, + 'board' => isset($board) ? $board : false, + 'debug' => str_replace("\n", ' ', utf8tohtml(print_r($debug_stuff, true))) + )) + ))); +} diff --git a/inc/functions.php b/inc/functions.php index ff5d51df..5213c8bd 100755 --- a/inc/functions.php +++ b/inc/functions.php @@ -12,7 +12,7 @@ if (realpath($_SERVER['SCRIPT_FILENAME']) == str_replace('\\', '/', __FILE__)) { define('TINYBOARD', null); $microtime_start = microtime(true); - +require_once 'inc/error.php'; require_once 'inc/cache.php'; require_once 'inc/display.php'; require_once 'inc/template.php'; @@ -26,11 +26,10 @@ if (!extension_loaded('gettext')) { // the user is not currently logged in as a moderator $mod = false; -register_shutdown_function('fatal_error_handler'); mb_internal_encoding('UTF-8'); loadConfig(); -function init_locale($locale, $error='error') { +function init_locale($locale) { if (extension_loaded('gettext')) { if (setlocale(LC_ALL, $locale) === false) { //$error('The specified locale (' . $locale . ') does not exist on your platform!'); @@ -40,7 +39,7 @@ function init_locale($locale, $error='error') { textdomain('tinyboard'); } else { if (_setlocale(LC_ALL, $locale) === false) { - $error('The specified locale (' . $locale . ') does not exist on your platform!'); + error('The specified locale (' . $locale . ') does not exist on your platform!'); } _bindtextdomain('tinyboard', './inc/locale'); _bind_textdomain_codeset('tinyboard', 'UTF-8'); @@ -53,8 +52,6 @@ $current_locale = 'en'; function loadConfig() { global $board, $config, $__ip, $debug, $__version, $microtime_start, $current_locale, $events; - $error = function_exists('error') ? 'error' : 'basic_error_function_because_the_other_isnt_loaded_yet'; - $boardsuffix = isset($board['uri']) ? $board['uri'] : ''; if (!isset($_SERVER['REMOTE_ADDR'])) @@ -77,7 +74,7 @@ function loadConfig() { if ($config['locale'] != $current_locale) { $current_locale = $config['locale']; - init_locale($config['locale'], $error); + init_locale($config['locale']); } } else { @@ -118,7 +115,7 @@ function loadConfig() { } if (!file_exists('inc/instance-config.php')) - $error('Tinyboard is not configured! Create inc/instance-config.php.'); + error('Tinyboard is not configured! Create inc/instance-config.php.'); // Initialize locale as early as possible @@ -148,7 +145,7 @@ function loadConfig() { if ($config['locale'] != $current_locale) { $current_locale = $config['locale']; - init_locale($config['locale'], $error); + init_locale($config['locale']); } require 'inc/config.php'; @@ -161,7 +158,7 @@ function loadConfig() { if ($config['locale'] != $current_locale) { $current_locale = $config['locale']; - init_locale($config['locale'], $error); + init_locale($config['locale']); } if (!isset($config['global_message'])) @@ -271,7 +268,7 @@ function loadConfig() { $_SERVER['REMOTE_ADDR'] = $m[2]; if ($config['verbose_errors']) { - set_error_handler('verbose_error_handler'); + set_error_handler('error_handler'); error_reporting(E_ALL); ini_set('display_errors', true); ini_set('html_errors', false); @@ -332,36 +329,6 @@ function loadConfig() { } } -function basic_error_function_because_the_other_isnt_loaded_yet($message, $priority = true) { - global $config; - - if ($config['syslog'] && $priority !== false) { - // Use LOG_NOTICE instead of LOG_ERR or LOG_WARNING because most error message are not significant. - _syslog($priority !== true ? $priority : LOG_NOTICE, $message); - } - - // Yes, this is horrible. - die('Error' . - '' . - '

Error

' . $message . '
' . - '

This alternative error page is being displayed because the other couldn\'t be found or hasn\'t loaded yet.

'); -} - -function fatal_error_handler() { - if ($error = error_get_last()) { - if ($error['type'] == E_ERROR) { - if (function_exists('error')) { - error('Caught fatal error: ' . $error['message'] . ' in ' . $error['file'] . ' on line ' . $error['line'], LOG_ERR); - } else { - basic_error_function_because_the_other_isnt_loaded_yet('Caught fatal error: ' . $error['message'] . ' in ' . $error['file'] . ' on line ' . $error['line'], LOG_ERR); - } - } - } -} function _syslog($priority, $message) { if (isset($_SERVER['REMOTE_ADDR'], $_SERVER['REQUEST_METHOD'], $_SERVER['REQUEST_URI'])) { @@ -372,16 +339,6 @@ function _syslog($priority, $message) { } } -function verbose_error_handler($errno, $errstr, $errfile, $errline) { - if (error_reporting() == 0) - return false; // Looks like this warning was suppressed by the @ operator. - error(utf8tohtml($errstr), true, array( - 'file' => $errfile . ':' . $errline, - 'errno' => $errno, - 'error' => $errstr, - 'backtrace' => array_slice(debug_backtrace(), 1) - )); -} function define_groups() { global $config;