/lib/Cake/Error/ErrorHandler.php - pictcode - Redmine

pictcode / lib / Cake / Error / ErrorHandler.php @ 0b1b8047

       <?php
       /**
        * ErrorHandler class
+       *
        * Provides Error Capturing for Framework errors.
+       *
        * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
        * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
+       *
        * Licensed under The MIT License
        * For full copyright and license information, please see the LICENSE.txt
        * Redistributions of files must retain the above copyright notice.
+       *
        * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
        * @link          http://cakephp.org CakePHP(tm) Project
        * @package       Cake.Error
        * @since         CakePHP(tm) v 0.10.5.1732
        * @license       http://www.opensource.org/licenses/mit-license.php MIT License
        */
       App::uses('Debugger', 'Utility');
       App::uses('CakeLog', 'Log');
       App::uses('ExceptionRenderer', 'Error');
       App::uses('Router', 'Routing');
       /**
        * Error Handler provides basic error and exception handling for your application. It captures and
        * handles all unhandled exceptions and errors. Displays helpful framework errors when debug > 1.
+       *
        * ### Uncaught exceptions
+       *
        * 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.
+       *
        * ### Implementing application specific exception handling
+       *
        * You can implement application specific exception handling in one of a few ways. Each approach
        * gives you different amounts of control over the exception handling process.
+       *
        * - Set Configure::write('Exception.handler', 'YourClass::yourMethod');
        * - Create AppController::appError();
        * - Set Configure::write('Exception.renderer', 'YourClass');
+       *
        * #### Create your own Exception handler with `Exception.handler`
+       *
        * This gives you full control over the exception handling process. The class you choose should be
        * loaded in your app/Config/bootstrap.php, so its available to handle any exceptions. You can
        * define the handler as any callback type. Using Exception.handler overrides all other exception
        * handling settings and logic.
+       *
        * #### Using `AppController::appError();`
+       *
        * This controller method is called instead of the default exception rendering. It receives the
        * thrown exception as its only argument. You should implement your error handling in that method.
        * Using AppController::appError(), will supersede any configuration for Exception.renderer.
+       *
        * #### Using a custom renderer with `Exception.renderer`
+       *
        * If you don't want to take control of the exception handling, but want to change how exceptions are
        * rendered you can use `Exception.renderer` to choose a class to render exception pages. By default
        * `ExceptionRenderer` is used. Your custom exception renderer class should be placed in app/Lib/Error.
+       *
        * Your custom renderer should expect an exception in its constructor, and implement a render method.
        * Failing to do so will cause additional errors.
+       *
        * #### Logging exceptions
+       *
        * Using the built-in exception handling, you can log all the exceptions
        * that are dealt with by ErrorHandler by setting `Exception.log` to true in your core.php.
        * Enabling this will log every exception to CakeLog and the configured loggers.
+       *
        * ### PHP errors
+       *
        * Error handler also provides the built in features for handling php errors (trigger_error).
        * While in debug mode, errors will be output to the screen using debugger. While in production mode,
        * errors will be logged to CakeLog. You can control which errors are logged by setting
        * `Error.level` in your core.php.
+       *
        * #### Logging errors
+       *
        * When ErrorHandler is used for handling errors, you can enable error logging by setting `Error.log` to true.
        * This will log all errors to the configured log handlers.
+       *
        * #### Controlling what errors are logged/displayed
+       *
        * You can control which errors are logged / displayed by ErrorHandler by setting `Error.level`. Setting this
        * to one or a combination of a few of the E_* constants will only enable the specified errors.
+       *
        * e.g. `Configure::write('Error.level', E_ALL & ~E_NOTICE);`
+       *
        * Would enable handling for all non Notice errors.
+       *
        * @package       Cake.Error
        * @see ExceptionRenderer for more information on how to customize exception rendering.
        */
       class ErrorHandler {
       /**
        * Whether to give up rendering an exception, if the renderer itself is
        * throwing exceptions.
+       *
        * @var bool
        */
               protected static $_bailExceptionRendering = false;
       /**
        * Set as the default exception handler by the CakePHP bootstrap process.
+       *
        * This will either use custom exception renderer class if configured,
        * or use the default ExceptionRenderer.
+       *
        * @param Exception $exception The exception to render.
        * @return void
        * @see http://php.net/manual/en/function.set-exception-handler.php
        */
               public static function handleException(Exception $exception) {
                       $config = Configure::read('Exception');
                       static::_log($exception, $config);
                       $renderer = isset($config['renderer']) ? $config['renderer'] : 'ExceptionRenderer';
                       if ($renderer !== 'ExceptionRenderer') {
                               list($plugin, $renderer) = pluginSplit($renderer, true);
                               App::uses($renderer, $plugin . 'Error');
+                      }
                       try {
                               $error = new $renderer($exception);
                               $error->render();
                       } catch (Exception $e) {
                               set_error_handler(Configure::read('Error.handler')); // Should be using configured ErrorHandler
                               Configure::write('Error.trace', false); // trace is useless here since it's internal
                               $message = sprintf("[%s] %s\n%s", // Keeping same message format
                                       get_class($e),
                                       $e->getMessage(),
                                       $e->getTraceAsString()
                               );
                               static::$_bailExceptionRendering = true;
                               trigger_error($message, E_USER_ERROR);
+                      }
+              }
       /**
        * Generates a formatted error message
+       *
        * @param Exception $exception Exception instance
        * @return string Formatted message
        */
               protected static function _getMessage($exception) {
                       $message = sprintf("[%s] %s",
                               get_class($exception),
                               $exception->getMessage()
                       );
                       if (method_exists($exception, 'getAttributes')) {
                               $attributes = $exception->getAttributes();
                               if ($attributes) {
                                       $message .= "\nException Attributes: " . var_export($exception->getAttributes(), true);
+                              }
+                      }
                       if (PHP_SAPI !== 'cli') {
                               $request = Router::getRequest();
                               if ($request) {
                                       $message .= "\nRequest URL: " . $request->here();
+                              }
+                      }
                       $message .= "\nStack Trace:\n" . $exception->getTraceAsString();
                       return $message;
+              }
       /**
        * Handles exception logging
+       *
        * @param Exception $exception The exception to render.
        * @param array $config An array of configuration for logging.
        * @return bool
        */
               protected static function _log(Exception $exception, $config) {
                       if (empty($config['log'])) {
                               return false;
+                      }
                       if (!empty($config['skipLog'])) {
                               foreach ((array)$config['skipLog'] as $class) {
                                       if ($exception instanceof $class) {
                                               return false;
+                                      }
+                              }
+                      }
                       return CakeLog::write(LOG_ERR, static::_getMessage($exception));
+              }
       /**
        * 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.
        * Stack traces for errors can be enabled with Configure::write('Error.trace', true);
+       *
        * @param int $code Code of error
        * @param string $description Error description
        * @param string $file File on which error occurred
        * @param int $line Line that triggered the error
        * @param array $context Context
        * @return bool true if error was handled
        */
               public static function handleError($code, $description, $file = null, $line = null, $context = null) {
                       if (error_reporting() === 0) {
                               return false;
+                      }
                       $errorConfig = Configure::read('Error');
                       list($error, $log) = static::mapErrorCode($code);
                       if ($log === LOG_ERR) {
                               return static::handleFatalError($code, $description, $file, $line);
+                      }
                       $debug = Configure::read('debug');
                       if ($debug) {
                               $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);
+                      }
                       $message = $error . ' (' . $code . '): ' . $description . ' in [' . $file . ', line ' . $line . ']';
                       if (!empty($errorConfig['trace'])) {
                               // https://bugs.php.net/bug.php?id=65322
                               if (version_compare(PHP_VERSION, '5.4.21', '<')) {
                                       if (!class_exists('Debugger')) {
                                               App::load('Debugger');
+                                      }
                                       if (!class_exists('CakeText')) {
                                               App::uses('CakeText', 'Utility');
                                               App::load('CakeText');
+                                      }
+                              }
                               $trace = Debugger::trace(array('start' => 1, 'format' => 'log'));
                               $message .= "\nTrace:\n" . $trace . "\n";
+                      }
                       return CakeLog::write($log, $message);
+              }
       /**
        * Generate an error page when some fatal error happens.
+       *
        * @param int $code Code of error
        * @param string $description Error description
        * @param string $file File on which error occurred
        * @param int $line Line that triggered the error
        * @return bool
        * @throws FatalErrorException If the Exception renderer threw an exception during rendering, and debug > 0.
        * @throws InternalErrorException If the Exception renderer threw an exception during rendering, and debug is 0.
        */
               public static function handleFatalError($code, $description, $file, $line) {
                       $logMessage = 'Fatal Error (' . $code . '): ' . $description . ' in [' . $file . ', line ' . $line . ']';
                       CakeLog::write(LOG_ERR, $logMessage);
                       $exceptionHandler = Configure::read('Exception.handler');
                       if (!is_callable($exceptionHandler)) {
                               return false;
+                      }
                       if (ob_get_level()) {
                               ob_end_clean();
+                      }
                       if (Configure::read('debug')) {
                               $exception = new FatalErrorException($description, 500, $file, $line);
                       } else {
                               $exception = new InternalErrorException();
+                      }
                       if (static::$_bailExceptionRendering) {
                               static::$_bailExceptionRendering = false;
                               throw $exception;
+                      }
                       call_user_func($exceptionHandler, $exception);
                       return false;
+              }
       /**
        * 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.
        */
               public static function mapErrorCode($code) {
                       $error = $log = null;
                       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_ERR;
                                       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;
                               case E_DEPRECATED:
                               case E_USER_DEPRECATED:
                                       $error = 'Deprecated';
                                       $log = LOG_NOTICE;
                                       break;
+                      }
                       return array($error, $log);
+              }
+      }