248 lines
8.7 KiB
PHP
248 lines
8.7 KiB
PHP
<?php
|
|
// $Id$
|
|
|
|
/**
|
|
* @file
|
|
* Functions for error handling
|
|
*/
|
|
|
|
/**
|
|
* Error reporting level: display no errors.
|
|
*/
|
|
define('ERROR_REPORTING_HIDE', 0);
|
|
|
|
/**
|
|
* Error reporting level: display errors and warnings.
|
|
*/
|
|
define('ERROR_REPORTING_DISPLAY_SOME', 1);
|
|
|
|
/**
|
|
* Error reporting level: display all messages.
|
|
*/
|
|
define('ERROR_REPORTING_DISPLAY_ALL', 2);
|
|
|
|
/**
|
|
* Map PHP error constants to watchdog severity levels.
|
|
* The error constants are documented at
|
|
* http://php.net/manual/en/errorfunc.constants.php
|
|
*/
|
|
function drupal_error_levels() {
|
|
$types = array(
|
|
E_ERROR => array('Error', WATCHDOG_ERROR),
|
|
E_WARNING => array('Warning', WATCHDOG_WARNING),
|
|
E_PARSE => array('Parse error', WATCHDOG_ERROR),
|
|
E_NOTICE => array('Notice', WATCHDOG_NOTICE),
|
|
E_CORE_ERROR => array('Core error', WATCHDOG_ERROR),
|
|
E_CORE_WARNING => array('Core warning', WATCHDOG_WARNING),
|
|
E_COMPILE_ERROR => array('Compile error', WATCHDOG_ERROR),
|
|
E_COMPILE_WARNING => array('Compile warning', WATCHDOG_WARNING),
|
|
E_USER_ERROR => array('User error', WATCHDOG_ERROR),
|
|
E_USER_WARNING => array('User warning', WATCHDOG_WARNING),
|
|
E_USER_NOTICE => array('User notice', WATCHDOG_NOTICE),
|
|
E_STRICT => array('Strict warning', WATCHDOG_DEBUG),
|
|
E_RECOVERABLE_ERROR => array('Recoverable fatal error', WATCHDOG_ERROR),
|
|
);
|
|
// E_DEPRECATED and E_USER_DEPRECATED were added in PHP 5.3.0.
|
|
if (defined('E_DEPRECATED')) {
|
|
$types[E_DEPRECATED] = array('Deprecated function', WATCHDOG_DEBUG);
|
|
$types[E_USER_DEPRECATED] = array('User deprecated function', WATCHDOG_DEBUG);
|
|
}
|
|
return $types;
|
|
}
|
|
|
|
/**
|
|
* Custom PHP error handler.
|
|
*
|
|
* @param $error_level
|
|
* The level of the error raised.
|
|
* @param $message
|
|
* The error message.
|
|
* @param $filename
|
|
* The filename that the error was raised in.
|
|
* @param $line
|
|
* The line number the error was raised at.
|
|
* @param $context
|
|
* An array that points to the active symbol table at the point the error occurred.
|
|
*/
|
|
function _drupal_error_handler_real($error_level, $message, $filename, $line, $context) {
|
|
if ($error_level & error_reporting()) {
|
|
$types = drupal_error_levels();
|
|
list($severity_msg, $severity_level) = $types[$error_level];
|
|
$caller = _drupal_get_last_caller(debug_backtrace());
|
|
|
|
// We treat recoverable errors as fatal.
|
|
_drupal_log_error(array(
|
|
'%type' => isset($types[$error_level]) ? $severity_msg : 'Unknown error',
|
|
'%message' => $message,
|
|
'%function' => $caller['function'],
|
|
'%file' => $caller['file'],
|
|
'%line' => $caller['line'],
|
|
'severity_level' => $severity_level,
|
|
), $error_level == E_RECOVERABLE_ERROR);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Decode an exception, especially to retrive the correct caller.
|
|
*
|
|
* @param $exception
|
|
* The exception object that was thrown.
|
|
* @return An error in the format expected by _drupal_log_error().
|
|
*/
|
|
function _drupal_decode_exception($exception) {
|
|
$message = $exception->getMessage();
|
|
|
|
$backtrace = $exception->getTrace();
|
|
// Add the line throwing the exception to the backtrace.
|
|
array_unshift($backtrace, array('line' => $exception->getLine(), 'file' => $exception->getFile()));
|
|
|
|
// For PDOException errors, we try to return the initial caller,
|
|
// skipping internal functions of the database layer.
|
|
if ($exception instanceof PDOException) {
|
|
// The first element in the stack is the call, the second element gives us the caller.
|
|
// We skip calls that occurred in one of the classes of the database layer
|
|
// or in one of its global functions.
|
|
$db_functions = array('db_query', 'db_query_range');
|
|
while (!empty($backtrace[1]) && ($caller = $backtrace[1]) &&
|
|
((isset($caller['class']) && (strpos($caller['class'], 'Query') !== FALSE || strpos($caller['class'], 'Database') !== FALSE || strpos($caller['class'], 'PDO') !== FALSE)) ||
|
|
in_array($caller['function'], $db_functions))) {
|
|
// We remove that call.
|
|
array_shift($backtrace);
|
|
}
|
|
if (isset($exception->query_string, $exception->args)) {
|
|
$message .= ": " . $exception->query_string . "; " . print_r($exception->args, TRUE);
|
|
}
|
|
}
|
|
$caller = _drupal_get_last_caller($backtrace);
|
|
|
|
return array(
|
|
'%type' => get_class($exception),
|
|
'%message' => $message,
|
|
'%function' => $caller['function'],
|
|
'%file' => $caller['file'],
|
|
'%line' => $caller['line'],
|
|
'severity_level' => WATCHDOG_ERROR,
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Log a PHP error or exception, display an error page in fatal cases.
|
|
*
|
|
* @param $error
|
|
* An array with the following keys: %type, %message, %function, %file, %line.
|
|
* @param $fatal
|
|
* TRUE if the error is fatal.
|
|
*/
|
|
function _drupal_log_error($error, $fatal = FALSE) {
|
|
// Initialize a maintenance theme if the boostrap was not complete.
|
|
// Do it early because drupal_set_message() triggers a drupal_theme_initialize().
|
|
if ($fatal && (drupal_get_bootstrap_phase() != DRUPAL_BOOTSTRAP_FULL)) {
|
|
unset($GLOBALS['theme']);
|
|
if (!defined('MAINTENANCE_MODE')) {
|
|
define('MAINTENANCE_MODE', 'error');
|
|
}
|
|
drupal_maintenance_theme();
|
|
}
|
|
|
|
// When running inside the testing framework, we relay the errors
|
|
// to the tested site by the way of HTTP headers.
|
|
if (isset($_SERVER['HTTP_USER_AGENT']) && preg_match("/^simpletest\d+;/", $_SERVER['HTTP_USER_AGENT']) && !headers_sent() && (!defined('SIMPLETEST_COLLECT_ERRORS') || SIMPLETEST_COLLECT_ERRORS)) {
|
|
// $number does not use drupal_static as it should not be reset
|
|
// as it uniquely identifies each PHP error.
|
|
static $number = 0;
|
|
$assertion = array(
|
|
$error['%message'],
|
|
$error['%type'],
|
|
array(
|
|
'function' => $error['%function'],
|
|
'file' => $error['%file'],
|
|
'line' => $error['%line'],
|
|
),
|
|
);
|
|
header('X-Drupal-Assertion-' . $number . ': ' . rawurlencode(serialize($assertion)));
|
|
$number++;
|
|
}
|
|
|
|
try {
|
|
watchdog('php', '%type: %message in %function (line %line of %file).', $error, $error['severity_level']);
|
|
}
|
|
catch (Exception $e) {
|
|
// Ignore any additional watchdog exception, as that probably means
|
|
// that the database was not initialized correctly.
|
|
}
|
|
|
|
if ($fatal) {
|
|
drupal_add_http_header('Status', '500 Service unavailable (with message)');
|
|
}
|
|
|
|
if (isset($_SERVER['HTTP_X_REQUESTED_WITH']) && $_SERVER['HTTP_X_REQUESTED_WITH'] == 'XMLHttpRequest') {
|
|
if ($fatal) {
|
|
// When called from JavaScript, simply output the error message.
|
|
print t('%type: %message in %function (line %line of %file).', $error);
|
|
exit;
|
|
}
|
|
}
|
|
else {
|
|
// Display the message if the current error reporting level allows this type
|
|
// of message to be displayed, and unconditionnaly in update.php.
|
|
$error_level = variable_get('error_level', ERROR_REPORTING_DISPLAY_ALL);
|
|
$display_error = $error_level == ERROR_REPORTING_DISPLAY_ALL || ($error_level == ERROR_REPORTING_DISPLAY_SOME && $error['%type'] != 'Notice');
|
|
if ($display_error || (defined('MAINTENANCE_MODE') && MAINTENANCE_MODE == 'update')) {
|
|
$class = 'error';
|
|
|
|
// If error type is 'User notice' then treat it as debug information
|
|
// instead of an error message, see dd().
|
|
if ($error['%type'] == 'User notice') {
|
|
$error['%type'] = 'Debug';
|
|
$class = 'status';
|
|
}
|
|
|
|
drupal_set_message(t('%type: %message in %function (line %line of %file).', $error), $class);
|
|
}
|
|
|
|
if ($fatal) {
|
|
drupal_set_title(t('Error'));
|
|
// We fallback to a maintenance page at this point, because the page generation
|
|
// itself can generate errors.
|
|
print theme('maintenance_page', array('content' => t('The website encountered an unexpected error. Please try again later.')));
|
|
exit;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Gets the last caller from a backtrace.
|
|
*
|
|
* @param $backtrace
|
|
* A standard PHP backtrace.
|
|
* @return
|
|
* An associative array with keys 'file', 'line' and 'function'.
|
|
*/
|
|
function _drupal_get_last_caller($backtrace) {
|
|
// Errors that occur inside PHP internal functions do not generate
|
|
// information about file and line. Ignore black listed functions.
|
|
$blacklist = array('debug', '_drupal_error_handler', '_drupal_exception_handler');
|
|
while (($backtrace && !isset($backtrace[0]['line'])) ||
|
|
(isset($backtrace[1]['function']) && in_array($backtrace[1]['function'], $blacklist))) {
|
|
array_shift($backtrace);
|
|
}
|
|
|
|
// The first trace is the call itself.
|
|
// It gives us the line and the file of the last call.
|
|
$call = $backtrace[0];
|
|
|
|
// The second call give us the function where the call originated.
|
|
if (isset($backtrace[1])) {
|
|
if (isset($backtrace[1]['class'])) {
|
|
$call['function'] = $backtrace[1]['class'] . $backtrace[1]['type'] . $backtrace[1]['function'] . '()';
|
|
}
|
|
else {
|
|
$call['function'] = $backtrace[1]['function'] . '()';
|
|
}
|
|
}
|
|
else {
|
|
$call['function'] = 'main()';
|
|
}
|
|
return $call;
|
|
}
|