[TASK] CGL violation "CharacterAfterPHPClosingTag"
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Classes / Error / ErrorHandler.php
1 <?php
2 namespace TYPO3\CMS\Core\Error;
3
4 /***************************************************************
5 * Copyright notice
6 *
7 * (c) 2009-2011 Ingo Renner <ingo@typo3.org>
8 * All rights reserved
9 *
10 * This script is part of the TYPO3 project. The TYPO3 project is
11 * free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
15 *
16 * The GNU General Public License can be found at
17 * http://www.gnu.org/copyleft/gpl.html.
18 *
19 * This script is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
23 *
24 * This copyright notice MUST APPEAR in all copies of the script!
25 ***************************************************************/
26 /**
27 * Global error handler for TYPO3
28 *
29 * This file is a backport from FLOW3
30 *
31 * @author Rupert Germann <rupi@gmx.li>
32 * @package TYPO3
33 * @subpackage error
34 */
35 class ErrorHandler implements \TYPO3\CMS\Core\Error\ErrorHandlerInterface {
36
37 /**
38 * Error levels which should result in an exception thrown.
39 *
40 * @var array
41 */
42 protected $exceptionalErrors = array();
43
44 /**
45 * Registers this class as default error handler
46 *
47 * @param integer $errorHandlerErrors The integer representing the E_* error level which should be
48 * @return void
49 */
50 public function __construct($errorHandlerErrors) {
51 // reduces error types to those a custom error handler can process
52 $errorHandlerErrors = $errorHandlerErrors & ~(E_COMPILE_WARNING | E_COMPILE_ERROR | E_CORE_WARNING | E_CORE_ERROR | E_PARSE | E_ERROR);
53 set_error_handler(array($this, 'handleError'), $errorHandlerErrors);
54 }
55
56 /**
57 * Defines which error levels should result in an exception thrown.
58 *
59 * @param integer $exceptionalErrors The integer representing the E_* error level to handle as exceptions
60 * @return void
61 */
62 public function setExceptionalErrors($exceptionalErrors) {
63 $this->exceptionalErrors = (int) $exceptionalErrors;
64 }
65
66 /**
67 * Handles an error.
68 * If the error is registered as exceptionalError it will by converted into an exception, to be handled
69 * by the configured exceptionhandler. Additionall the error message is written to the configured logs.
70 * If TYPO3_MODE is 'BE' the error message is also added to the flashMessageQueue, in FE the error message
71 * is displayed in the admin panel (as TsLog message)
72 *
73 * @param integer $errorLevel The error level - one of the E_* constants
74 * @param string $errorMessage The error message
75 * @param string $errorFile Name of the file the error occurred in
76 * @param integer $errorLine Line number where the error occurred
77 * @return void
78 * @throws \TYPO3\CMS\Core\Error\Exception with the data passed to this method if the error is registered as exceptionalError
79 */
80 public function handleError($errorLevel, $errorMessage, $errorFile, $errorLine) {
81 // Don't do anything if error_reporting is disabled by an @ sign
82 if (error_reporting() == 0) {
83 return TRUE;
84 }
85 $errorLevels = array(
86 E_WARNING => 'Warning',
87 E_NOTICE => 'Notice',
88 E_USER_ERROR => 'User Error',
89 E_USER_WARNING => 'User Warning',
90 E_USER_NOTICE => 'User Notice',
91 E_STRICT => 'Runtime Notice',
92 E_RECOVERABLE_ERROR => 'Catchable Fatal Error',
93 E_DEPRECATED => 'Runtime Deprecation Notice'
94 );
95 $message = 'PHP ' . $errorLevels[$errorLevel] . ': ' . $errorMessage . ' in ' . $errorFile . ' line ' . $errorLine;
96 if ($errorLevel & $this->exceptionalErrors) {
97 // handle error raised at early parse time
98 // autoloader not available & built-in classes not resolvable
99 if (!class_exists('stdClass', FALSE)) {
100 $message = 'PHP ' . $errorLevels[$errorLevel] . ': ' . $errorMessage . ' in ' . basename($errorFile) .
101 'line ' . $errorLine;
102 die($message);
103 }
104 // We need to manually require the exception classes in case the autoloader is not available at this point yet.
105 // @see http://forge.typo3.org/issues/23444
106 if (!class_exists('TYPO3\\CMS\\Core\\Error\\Exception', FALSE)) {
107 require_once PATH_t3lib . 'class.t3lib_exception.php';
108 require_once PATH_t3lib . 'error/class.t3lib_error_exception.php';
109 }
110 throw new \TYPO3\CMS\Core\Error\Exception($message, 1);
111 } else {
112 switch ($errorLevel) {
113 case E_USER_ERROR:
114
115 case E_RECOVERABLE_ERROR:
116 $severity = 2;
117 break;
118 case E_USER_WARNING:
119
120 case E_WARNING:
121 $severity = 1;
122 break;
123 default:
124 $severity = 0;
125 break;
126 }
127 $logTitle = 'Core: Error handler (' . TYPO3_MODE . ')';
128 // Write error message to the configured syslogs,
129 // see: $TYPO3_CONF_VARS['SYS']['systemLog']
130 if ($errorLevel & $GLOBALS['TYPO3_CONF_VARS']['SYS']['syslogErrorReporting']) {
131 \TYPO3\CMS\Core\Utility\GeneralUtility::sysLog($message, $logTitle, $severity);
132 }
133 // In case an error occurs before a database connection exists, try
134 // to connect to the DB to be able to write an entry to devlog/sys_log
135 if (is_object($GLOBALS['TYPO3_DB']) && empty($GLOBALS['TYPO3_DB']->link)) {
136 try {
137 $GLOBALS['TYPO3_DB']->connectDB();
138 } catch (\Exception $e) {
139
140 }
141 }
142 // Write error message to devlog extension(s),
143 // see: $TYPO3_CONF_VARS['SYS']['enable_errorDLOG']
144 if (TYPO3_ERROR_DLOG) {
145 \TYPO3\CMS\Core\Utility\GeneralUtility::devLog($message, $logTitle, $severity + 1);
146 }
147 // Write error message to TSlog (admin panel)
148 if (is_object($GLOBALS['TT'])) {
149 $GLOBALS['TT']->setTSlogMessage($logTitle . ': ' . $message, $severity + 1);
150 }
151 // Write error message to sys_log table (ext: belog, Tools->Log)
152 if ($errorLevel & $GLOBALS['TYPO3_CONF_VARS']['SYS']['belogErrorReporting']) {
153 $this->writeLog($logTitle . ': ' . $message, $severity);
154 }
155 // Add error message to the flashmessageQueue
156 if (defined('TYPO3_ERRORHANDLER_MODE') && TYPO3_ERRORHANDLER_MODE == 'debug') {
157 $flashMessage = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Messaging\\FlashMessage', $message, 'PHP ' . $errorLevels[$errorLevel], $severity);
158 \TYPO3\CMS\Core\Messaging\FlashMessageQueue::addMessage($flashMessage);
159 }
160 }
161 // Don't execute PHP internal error handler
162 return TRUE;
163 }
164
165 /**
166 * Writes an error in the sys_log table
167 *
168 * @param string $logMessage Default text that follows the message (in english!).
169 * @param integer $severity The eror level of the message (0 = OK, 1 = warning, 2 = error)
170 * @return void
171 */
172 protected function writeLog($logMessage, $severity) {
173 if (is_object($GLOBALS['TYPO3_DB']) && !empty($GLOBALS['TYPO3_DB']->link)) {
174 $userId = 0;
175 $workspace = 0;
176 if (is_object($GLOBALS['BE_USER'])) {
177 if (isset($GLOBALS['BE_USER']->user['uid'])) {
178 $userId = $GLOBALS['BE_USER']->user['uid'];
179 }
180 if (isset($GLOBALS['BE_USER']->workspace)) {
181 $workspace = $GLOBALS['BE_USER']->workspace;
182 }
183 }
184 $fields_values = array(
185 'userid' => $userId,
186 'type' => 5,
187 'action' => 0,
188 'error' => $severity,
189 'details_nr' => 0,
190 'details' => $logMessage,
191 'IP' => \TYPO3\CMS\Core\Utility\GeneralUtility::getIndpEnv('REMOTE_ADDR'),
192 'tstamp' => $GLOBALS['EXEC_TIME'],
193 'workspace' => $workspace
194 );
195 $GLOBALS['TYPO3_DB']->exec_INSERTquery('sys_log', $fields_values);
196 }
197 }
198
199 }
200
201
202 ?>