class.t3lib_error_errorhandler.php

Go to the documentation of this file.

<?php
/***************************************************************
 *  Copyright notice
 *
 *  (c) 2009-2011 Ingo Renner <ingo@typo3.org>
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project is
 *  free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
 *
 *  This script is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/


/**
 * Global error handler for TYPO3
 *
 * This file is a backport from FLOW3
 *
 * @package TYPO3
 * @subpackage t3lib_error
 * @author Rupert Germann <rupi@gmx.li>
 * @version $Id: class.t3lib_error_errorhandler.php 10121 2011-01-18 20:15:30Z ohader $
 */
class t3lib_error_ErrorHandler implements t3lib_error_ErrorHandlerInterface {

    /**
     * Error levels which should result in an exception thrown.
     *
     * @var integer
     */
    protected $exceptionalErrors = array();

    /**
     * Registers this class as default error handler
     *
     * @param integer    The integer representing the E_* error level which should be
     *                   handled by the registered error handler.
     * @return void
     */
    public function __construct($errorHandlerErrors) {
        set_error_handler(array($this, 'handleError'), $errorHandlerErrors);
    }


    /**
     * Defines which error levels should result in an exception thrown.
     *
     * @param integer    The integer representing the E_* error level to handle as exceptions
     * @return void
     */
    public function setExceptionalErrors($exceptionalErrors) {
        $this->exceptionalErrors = (int) $exceptionalErrors;

    }

    /**
     * Handles an error.
     * If the error is registered as exceptionalError it will by converted into an exception, to be handled
     * by the configured exceptionhandler. Additionall the error message is written to the configured logs.
     * If TYPO3_MODE is 'BE' the error message is also added to the flashMessageQueue, in FE the error message
     * is displayed in the admin panel (as TsLog message)
     *
     * @param integer    The error level - one of the E_* constants
     * @param string     The error message
     * @param string     Name of the file the error occurred in
     * @param integer    Line number where the error occurred
     * @return void
     * @throws t3lib_error_Exception with the data passed to this method if the error is registered as exceptionalError
     */
    public function handleError($errorLevel, $errorMessage, $errorFile, $errorLine) {
            // don't do anything if error_reporting is disabled by an @ sign
        if (error_reporting() == 0) {
            return TRUE;
        }

        $errorLevels = array(
            E_WARNING => 'Warning',
            E_NOTICE => 'Notice',
            E_USER_ERROR => 'User Error',
            E_USER_WARNING => 'User Warning',
            E_USER_NOTICE => 'User Notice',
            E_STRICT => 'Runtime Notice',
            E_RECOVERABLE_ERROR => 'Catchable Fatal Error'
        );

        $message = 'PHP ' . $errorLevels[$errorLevel] . ': ' . $errorMessage . ' in ' . $errorFile . ' line ' . $errorLine;

        if ($errorLevel & $this->exceptionalErrors) {
            if (!class_exists('t3lib_error_Exception', FALSE)) {
                require_once(PATH_t3lib . 'class.t3lib_exception.php');
                require_once(PATH_t3lib . 'error/class.t3lib_error_exception.php');
            }

            throw new t3lib_error_Exception($message, 1);
        } else {

            switch ($errorLevel) {
                case E_USER_ERROR:
                case E_RECOVERABLE_ERROR:
                    $severity = 2;
                    break;
                case E_USER_WARNING:
                case E_WARNING:
                    $severity = 1;
                    break;
                default:
                    $severity = 0;
                    break;
            }

            $logTitle = 'Core: Error handler (' . TYPO3_MODE . ')';

                // Write error message to the configured syslogs,
                // see: $TYPO3_CONF_VARS['SYS']['systemLog']
            if ($errorLevel & $GLOBALS['TYPO3_CONF_VARS']['SYS']['syslogErrorReporting']) {
                t3lib_div::sysLog($message, $logTitle, $severity);
            }

                // In case an error occurs before a database connection exists, try
                // to connect to the DB to be able to write an entry to devlog/sys_log
            if (is_object($GLOBALS['TYPO3_DB']) && empty($GLOBALS['TYPO3_DB']->link)) {
                try {
                    $GLOBALS['TYPO3_DB']->connectDB();
                }
                catch (Exception $e) {
                    // There's nothing more we can do at this point if the
                    // database failed. It is up to the various log writers
                    // to check for themselves whether the have a DB connection
                    // available or not.
                }
            }

                // Write error message to devlog extension(s),
                // see: $TYPO3_CONF_VARS['SYS']['enable_errorDLOG']
            if (TYPO3_ERROR_DLOG) {
                t3lib_div::devLog($message, $logTitle, $severity + 1);
            }
                // Write error message to TSlog (admin panel)
            if (is_object($GLOBALS['TT'])) {
                $GLOBALS['TT']->setTSlogMessage($logTitle . ': ' . $message, $severity + 1);
            }
                // Write error message to sys_log table (ext: belog, Tools->Log)
            if ($errorLevel & $GLOBALS['TYPO3_CONF_VARS']['SYS']['belogErrorReporting']) {
                $this->writeLog($logTitle . ': ' . $message, $severity);
            }

                // Add error message to the flashmessageQueue
            if (defined('TYPO3_ERRORHANDLER_MODE') && TYPO3_ERRORHANDLER_MODE == 'debug') {
                $flashMessage = t3lib_div::makeInstance(
                    't3lib_FlashMessage',
                    $message,
                    'PHP ' . $errorLevels[$errorLevel],
                    $severity
                );
                t3lib_FlashMessageQueue::addMessage($flashMessage);
            }
        }

            // Don't execute PHP internal error handler
        return TRUE;
    }

    /**
     * Writes an error in the sys_log table
     *
     * @param   string      Default text that follows the message (in english!).
     * @param   integer     The eror level of the message (0 = OK, 1 = warning, 2 = error)
     * @return  void
     */
    protected function writeLog($logMessage, $severity) {
        if (is_object($GLOBALS['TYPO3_DB']) && !empty($GLOBALS['TYPO3_DB']->link)) {
            $userId = 0;
            $workspace = 0;
            if (is_object($GLOBALS['BE_USER'])) {
                if (isset($GLOBALS['BE_USER']->user['uid'])) {
                    $userId = $GLOBALS['BE_USER']->user['uid'];
                }
                if (isset($GLOBALS['BE_USER']->workspace)) {
                    $workspace = $GLOBALS['BE_USER']->workspace;
                }
            }

            $fields_values = Array(
                'userid' => $userId,
                'type' => 5,
                'action' => 0,
                'error' => $severity,
                'details_nr' => 0,
                'details' => $logMessage,
                'IP' => t3lib_div::getIndpEnv('REMOTE_ADDR'),
                'tstamp' => $GLOBALS['EXEC_TIME'],
                'workspace' => $workspace
            );
            $GLOBALS['TYPO3_DB']->exec_INSERTquery('sys_log', $fields_values);
        }
    }

}


if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['t3lib/error/class.t3lib_error_errorhandler.php'])) {
    include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['t3lib/error/class.t3lib_error_errorhandler.php']);
}

?>