[TASK] Remove closing PHP tags
[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-2013 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 */
33 class ErrorHandler implements \TYPO3\CMS\Core\Error\ErrorHandlerInterface {
34
35 /**
36 * Error levels which should result in an exception thrown.
37 *
38 * @var array
39 */
40 protected $exceptionalErrors = array();
41
42 /**
43 * Registers this class as default error handler
44 *
45 * @param integer $errorHandlerErrors The integer representing the E_* error level which should be
46 * @return void
47 */
48 public function __construct($errorHandlerErrors) {
49 // reduces error types to those a custom error handler can process
50 $errorHandlerErrors = $errorHandlerErrors & ~(E_COMPILE_WARNING | E_COMPILE_ERROR | E_CORE_WARNING | E_CORE_ERROR | E_PARSE | E_ERROR);
51 set_error_handler(array($this, 'handleError'), $errorHandlerErrors);
52 }
53
54 /**
55 * Defines which error levels should result in an exception thrown.
56 *
57 * @param integer $exceptionalErrors The integer representing the E_* error level to handle as exceptions
58 * @return void
59 */
60 public function setExceptionalErrors($exceptionalErrors) {
61 $this->exceptionalErrors = (int) $exceptionalErrors;
62 }
63
64 /**
65 * Handles an error.
66 * If the error is registered as exceptionalError it will by converted into an exception, to be handled
67 * by the configured exceptionhandler. Additionall the error message is written to the configured logs.
68 * If TYPO3_MODE is 'BE' the error message is also added to the flashMessageQueue, in FE the error message
69 * is displayed in the admin panel (as TsLog message)
70 *
71 * @param integer $errorLevel The error level - one of the E_* constants
72 * @param string $errorMessage The error message
73 * @param string $errorFile Name of the file the error occurred in
74 * @param integer $errorLine Line number where the error occurred
75 * @return void
76 * @throws \TYPO3\CMS\Core\Error\Exception with the data passed to this method if the error is registered as exceptionalError
77 */
78 public function handleError($errorLevel, $errorMessage, $errorFile, $errorLine) {
79 // Don't do anything if error_reporting is disabled by an @ sign
80 if (error_reporting() == 0) {
81 return TRUE;
82 }
83 $errorLevels = array(
84 E_WARNING => 'Warning',
85 E_NOTICE => 'Notice',
86 E_USER_ERROR => 'User Error',
87 E_USER_WARNING => 'User Warning',
88 E_USER_NOTICE => 'User Notice',
89 E_STRICT => 'Runtime Notice',
90 E_RECOVERABLE_ERROR => 'Catchable Fatal Error',
91 E_DEPRECATED => 'Runtime Deprecation Notice'
92 );
93 $message = 'PHP ' . $errorLevels[$errorLevel] . ': ' . $errorMessage . ' in ' . $errorFile . ' line ' . $errorLine;
94 if ($errorLevel & $this->exceptionalErrors) {
95 // handle error raised at early parse time
96 // autoloader not available & built-in classes not resolvable
97 if (!class_exists('stdClass', FALSE)) {
98 $message = 'PHP ' . $errorLevels[$errorLevel] . ': ' . $errorMessage . ' in ' . basename($errorFile) .
99 'line ' . $errorLine;
100 die($message);
101 }
102 // We need to manually require the exception classes in case the autoloader is not available at this point yet.
103 // @see http://forge.typo3.org/issues/23444
104 if (!class_exists('TYPO3\\CMS\\Core\\Error\\Exception', FALSE)) {
105 require_once PATH_site . 'typo3/sysext/core/Classes/Exception.php';
106 require_once PATH_site . 'typo3/sysext/core/Classes/Error/Exception.php';
107 }
108 throw new \TYPO3\CMS\Core\Error\Exception($message, 1);
109 } else {
110 switch ($errorLevel) {
111 case E_USER_ERROR:
112
113 case E_RECOVERABLE_ERROR:
114 $severity = 2;
115 break;
116 case E_USER_WARNING:
117
118 case E_WARNING:
119 $severity = 1;
120 break;
121 default:
122 $severity = 0;
123 }
124 $logTitle = 'Core: Error handler (' . TYPO3_MODE . ')';
125 // Write error message to the configured syslogs,
126 // see: $TYPO3_CONF_VARS['SYS']['systemLog']
127 if ($errorLevel & $GLOBALS['TYPO3_CONF_VARS']['SYS']['syslogErrorReporting']) {
128 \TYPO3\CMS\Core\Utility\GeneralUtility::sysLog($message, $logTitle, $severity);
129 }
130 // Write error message to devlog extension(s),
131 // see: $TYPO3_CONF_VARS['SYS']['enable_errorDLOG']
132 if (TYPO3_ERROR_DLOG) {
133 \TYPO3\CMS\Core\Utility\GeneralUtility::devLog($message, $logTitle, $severity + 1);
134 }
135 // Write error message to TSlog (admin panel)
136 if (is_object($GLOBALS['TT'])) {
137 $GLOBALS['TT']->setTSlogMessage($logTitle . ': ' . $message, $severity + 1);
138 }
139 // Write error message to sys_log table (ext: belog, Tools->Log)
140 if ($errorLevel & $GLOBALS['TYPO3_CONF_VARS']['SYS']['belogErrorReporting']) {
141 // Silently catch in case an error occurs before a database connection exists,
142 // but DatabaseConnection fails to connect.
143 try {
144 $this->writeLog($logTitle . ': ' . $message, $severity);
145 } catch (\Exception $e) {
146 }
147 }
148 // Add error message to the flashmessageQueue
149 if (defined('TYPO3_ERRORHANDLER_MODE') && TYPO3_ERRORHANDLER_MODE == 'debug') {
150 $flashMessage = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Messaging\\FlashMessage', $message, 'PHP ' . $errorLevels[$errorLevel], $severity);
151 /** @var $flashMessageService \TYPO3\CMS\Core\Messaging\FlashMessageService */
152 $flashMessageService = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Messaging\\FlashMessageService');
153 /** @var $defaultFlashMessageQueue \TYPO3\CMS\Core\Messaging\FlashMessageQueue */
154 $defaultFlashMessageQueue = $flashMessageService->getMessageQueueByIdentifier();
155 $defaultFlashMessageQueue->enqueue($flashMessage);
156 }
157 }
158 // Don't execute PHP internal error handler
159 return TRUE;
160 }
161
162 /**
163 * Writes an error in the sys_log table
164 *
165 * @param string $logMessage Default text that follows the message (in english!).
166 * @param integer $severity The eror level of the message (0 = OK, 1 = warning, 2 = error)
167 * @return void
168 */
169 protected function writeLog($logMessage, $severity) {
170 if (is_object($GLOBALS['TYPO3_DB']) && $GLOBALS['TYPO3_DB']->isConnected()) {
171 $userId = 0;
172 $workspace = 0;
173 if (is_object($GLOBALS['BE_USER'])) {
174 if (isset($GLOBALS['BE_USER']->user['uid'])) {
175 $userId = $GLOBALS['BE_USER']->user['uid'];
176 }
177 if (isset($GLOBALS['BE_USER']->workspace)) {
178 $workspace = $GLOBALS['BE_USER']->workspace;
179 }
180 }
181 $fields_values = array(
182 'userid' => $userId,
183 'type' => 5,
184 'action' => 0,
185 'error' => $severity,
186 'details_nr' => 0,
187 'details' => $logMessage,
188 'IP' => \TYPO3\CMS\Core\Utility\GeneralUtility::getIndpEnv('REMOTE_ADDR'),
189 'tstamp' => $GLOBALS['EXEC_TIME'],
190 'workspace' => $workspace
191 );
192 $GLOBALS['TYPO3_DB']->exec_INSERTquery('sys_log', $fields_values);
193 }
194 }
195
196 }