2008-05-30 11:40:08 +00:00
|
|
|
<?php
|
|
|
|
/**
|
2008-08-22 01:52:37 +00:00
|
|
|
* Error handler
|
2008-05-30 11:40:08 +00:00
|
|
|
*
|
2008-08-22 01:52:37 +00:00
|
|
|
* Provides Error Capturing for Framework errors.
|
2008-05-30 11:40:08 +00:00
|
|
|
*
|
2010-09-03 14:30:35 +00:00
|
|
|
* PHP 5
|
2008-05-30 11:40:08 +00:00
|
|
|
*
|
2009-11-06 06:46:59 +00:00
|
|
|
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
|
2010-01-26 19:18:20 +00:00
|
|
|
* Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
|
2008-05-30 11:40:08 +00:00
|
|
|
*
|
|
|
|
* Licensed under The MIT License
|
|
|
|
* Redistributions of files must retain the above copyright notice.
|
|
|
|
*
|
2010-01-26 19:18:20 +00:00
|
|
|
* @copyright Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
|
2009-11-06 06:00:11 +00:00
|
|
|
* @link http://cakephp.org CakePHP(tm) Project
|
2008-10-30 17:30:26 +00:00
|
|
|
* @package cake
|
|
|
|
* @subpackage cake.cake.libs
|
|
|
|
* @since CakePHP(tm) v 0.10.5.1732
|
2009-11-06 06:51:51 +00:00
|
|
|
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
|
2008-05-30 11:40:08 +00:00
|
|
|
*/
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
2008-11-08 02:54:07 +00:00
|
|
|
* Error Handler.
|
2008-05-30 11:40:08 +00:00
|
|
|
*
|
2010-09-02 20:39:09 +00:00
|
|
|
* Captures and handles all unhandled exceptions. Displays helpful framework errors when debug > 1.
|
2010-09-04 05:34:45 +00:00
|
|
|
* When debug < 1 a CakeException will render 404 or 500 errors. If an uncaught exception is thrown
|
|
|
|
* and it is a type that ErrorHandler does not know about it will be treated as a 500 error.
|
2010-09-02 20:39:09 +00:00
|
|
|
*
|
|
|
|
* ### Implementing application specific exception handling
|
|
|
|
*
|
|
|
|
* You can implement application specific exception handling in one of a few ways:
|
|
|
|
*
|
|
|
|
* - Create a AppController::appError();
|
|
|
|
* - Create an AppError class.
|
|
|
|
*
|
|
|
|
* #### Using AppController::appError();
|
|
|
|
*
|
|
|
|
* This controller method is called instead of the default exception handling. It receives the
|
|
|
|
* thrown exception as its only argument. You should implement your error handling in that method.
|
|
|
|
*
|
|
|
|
* #### Using an AppError class
|
|
|
|
*
|
|
|
|
* This approach gives more flexibility and power in how you handle exceptions. You can create
|
|
|
|
* `app/libs/app_error.php` and create a class called `AppError`. The core ErrorHandler class
|
|
|
|
* will attempt to construct this class and let it handle the exception. This provides a more
|
|
|
|
* flexible way to handle exceptions in your application.
|
|
|
|
*
|
|
|
|
* Finally, in your `app/config/bootstrap.php` you can configure use `set_exception_handler()`
|
|
|
|
* to take total control over application exception handling.
|
2008-05-30 11:40:08 +00:00
|
|
|
*
|
2008-10-30 17:30:26 +00:00
|
|
|
* @package cake
|
|
|
|
* @subpackage cake.cake.libs
|
2008-05-30 11:40:08 +00:00
|
|
|
*/
|
2010-08-28 05:39:02 +00:00
|
|
|
class ErrorHandler {
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2010-08-28 05:39:02 +00:00
|
|
|
/**
|
|
|
|
* Set as the default exception handler by the CakePHP bootstrap process.
|
2010-09-03 19:03:33 +00:00
|
|
|
*
|
|
|
|
* This will either use an AppError class if your application has one,
|
2010-11-15 03:20:29 +00:00
|
|
|
* or use the default ExceptionRenderer.
|
2010-08-28 05:39:02 +00:00
|
|
|
*
|
|
|
|
* @return void
|
|
|
|
* @see http://php.net/manual/en/function.set-exception-handler.php
|
|
|
|
*/
|
|
|
|
public static function handleException(Exception $exception) {
|
2010-11-15 03:20:29 +00:00
|
|
|
App::import('Core', 'ExceptionRenderer');
|
2010-09-03 19:03:33 +00:00
|
|
|
if (file_exists(APP . 'app_error.php') || class_exists('AppError')) {
|
|
|
|
if (!class_exists('AppError')) {
|
|
|
|
require(APP . 'app_error.php');
|
|
|
|
}
|
|
|
|
$AppError = new AppError($exception);
|
|
|
|
return $AppError->render();
|
|
|
|
}
|
2010-11-15 04:33:46 +00:00
|
|
|
if (Configure::read('Exception.log')) {
|
|
|
|
if (!class_exists('CakeLog')) {
|
|
|
|
require LIBS . 'cake_log.php';
|
|
|
|
}
|
|
|
|
CakeLog::write(LOG_ERR, '[' . get_class($exception) . '] ' . $exception->getMessage());
|
|
|
|
}
|
2010-11-15 03:20:29 +00:00
|
|
|
$error = new ExceptionRenderer($exception);
|
2010-08-28 23:53:21 +00:00
|
|
|
$error->render();
|
|
|
|
}
|
|
|
|
|
2010-11-15 01:00:27 +00:00
|
|
|
/**
|
|
|
|
* Set as the default error handler by CakePHP. Use Configure::write('Error.handler', $callback), to use your own
|
|
|
|
* error handling methods. This function will use Debugger to display errors when debug > 0. And
|
|
|
|
* will log errors to CakeLog, when debug == 0.
|
|
|
|
*
|
|
|
|
* You can use Configure::write('Error.level', $value); to set what type of errors will be handled here.
|
2010-11-15 03:06:18 +00:00
|
|
|
* Stack traces for errors can be enabled with Configure::write('Error.trace', true);
|
2010-11-15 01:00:27 +00:00
|
|
|
*
|
|
|
|
* @param integer $code Code of error
|
|
|
|
* @param string $description Error description
|
|
|
|
* @param string $file File on which error occurred
|
|
|
|
* @param integer $line Line that triggered the error
|
|
|
|
* @param array $context Context
|
|
|
|
* @return boolean true if error was handled
|
|
|
|
*/
|
|
|
|
public static function handleError($code, $description, $file = null, $line = null, $context = null) {
|
2010-11-15 03:06:18 +00:00
|
|
|
$errorConfig = Configure::read('Error');
|
2010-11-15 03:48:13 +00:00
|
|
|
if (isset($errorConfig['level']) && ($code & ~$errorConfig['level'])) {
|
2010-11-15 03:06:18 +00:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
list($error, $log) = self::_mapErrorCode($code);
|
|
|
|
|
2010-11-15 01:00:27 +00:00
|
|
|
$debug = Configure::read('debug');
|
|
|
|
if ($debug) {
|
2010-11-15 01:32:44 +00:00
|
|
|
if (!class_exists('Debugger')) {
|
|
|
|
require LIBS . 'debugger.php';
|
|
|
|
}
|
2010-11-15 03:06:18 +00:00
|
|
|
$data = array(
|
|
|
|
'level' => $log,
|
|
|
|
'code' => $code,
|
|
|
|
'error' => $error,
|
|
|
|
'description' => $description,
|
|
|
|
'file' => $file,
|
|
|
|
'line' => $line,
|
|
|
|
'context' => $context,
|
|
|
|
'start' => 2,
|
|
|
|
'path' => Debugger::trimPath($file)
|
|
|
|
);
|
|
|
|
return Debugger::getInstance()->outputError($data);
|
2010-11-15 01:00:27 +00:00
|
|
|
} else {
|
2010-11-15 01:32:44 +00:00
|
|
|
if (!class_exists('CakeLog')) {
|
|
|
|
require LIBS . 'cake_log.php';
|
|
|
|
}
|
2010-11-15 03:06:18 +00:00
|
|
|
$message = $error . ' (' . $code . '): ' . $description . ' in [' . $file . ', line ' . $line . ']';
|
|
|
|
if (!empty($errorConfig['trace'])) {
|
|
|
|
if (!class_exists('Debugger')) {
|
|
|
|
require LIBS . 'debugger.php';
|
|
|
|
}
|
|
|
|
$trace = Debugger::trace(array('start' => 1, 'format' => 'log'));
|
|
|
|
$message .= "\nTrace:\n" . $trace . "\n";
|
|
|
|
}
|
|
|
|
return CakeLog::write($log, $message);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Map an error code into an Error word, and log location.
|
|
|
|
*
|
|
|
|
* @param int $code Error code to map
|
|
|
|
* @return array Array of error word, and log location.
|
|
|
|
*/
|
|
|
|
protected static function _mapErrorCode($code) {
|
|
|
|
switch ($code) {
|
|
|
|
case E_PARSE:
|
|
|
|
case E_ERROR:
|
|
|
|
case E_CORE_ERROR:
|
|
|
|
case E_COMPILE_ERROR:
|
|
|
|
case E_USER_ERROR:
|
|
|
|
$error = 'Fatal Error';
|
|
|
|
$log = LOG_ERROR;
|
|
|
|
break;
|
|
|
|
case E_WARNING:
|
|
|
|
case E_USER_WARNING:
|
|
|
|
case E_COMPILE_WARNING:
|
|
|
|
case E_RECOVERABLE_ERROR:
|
|
|
|
$error = 'Warning';
|
|
|
|
$log = LOG_WARNING;
|
|
|
|
break;
|
|
|
|
case E_NOTICE:
|
|
|
|
case E_USER_NOTICE:
|
|
|
|
$error = 'Notice';
|
|
|
|
$log = LOG_NOTICE;
|
|
|
|
break;
|
|
|
|
case E_STRICT:
|
|
|
|
$error = 'Strict';
|
|
|
|
$log = LOG_NOTICE;
|
|
|
|
break;
|
|
|
|
default:
|
|
|
|
return array();
|
|
|
|
break;
|
2010-11-15 01:00:27 +00:00
|
|
|
}
|
2010-11-15 03:06:18 +00:00
|
|
|
return array($error, $log);
|
2010-11-15 01:00:27 +00:00
|
|
|
}
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|