ILIAS  release_6 Revision v6.24-5-g0c8bfefb3b8
class.ilErrorHandling.php
Go to the documentation of this file.
1<?php
2/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */
3/* Copyright (c) 2015 Richard Klees, Extended GPL, see docs/LICENSE */
4/* Copyright (c) 2016 Stefan Hecken, Extended GPL, see docs/LICENSE */
5
6require_once 'Services/Environment/classes/class.ilRuntime.php';
7
22require_once("Services/Exceptions/classes/class.ilDelegatingHandler.php");
23require_once("Services/Exceptions/classes/class.ilPlainTextHandler.php");
24require_once("Services/Exceptions/classes/class.ilTestingHandler.php");
25
26use Whoops\Run;
27use Whoops\Handler\PrettyPageHandler;
28use Whoops\Handler\CallbackHandler;
29use Whoops\Exception\Inspector;
30
31class ilErrorHandling extends PEAR
32{
38 public $DEBUG_ENV;
39
45 public $FATAL;
46
52 public $WARNING;
53
59 public $MESSAGE;
60
65 protected static $whoops_handlers_registered = false;
66
71 public function __construct()
72 {
74
75 // init vars
76 $this->DEBUG_ENV = true;
77 $this->FATAL = 1;
78 $this->WARNING = 2;
79 $this->MESSAGE = 3;
80
81 $this->error_obj = false;
82
83 $this->initWhoopsHandlers();
84
85 // somehow we need to get rid of the whoops error handler
86 restore_error_handler();
87 set_error_handler(array($this, "handlePreWhoops"));
88 }
89
98 protected function initWhoopsHandlers()
99 {
100 if (self::$whoops_handlers_registered) {
101 // Only register whoops error handlers once.
102 return;
103 }
104
105 $ilRuntime = $this->getIlRuntime();
106 $this->whoops = $this->getWhoops();
107
108 $this->whoops->pushHandler(new ilDelegatingHandler($this));
109
110 if ($ilRuntime->shouldLogErrors()) {
111 $this->whoops->pushHandler($this->loggingHandler());
112 }
113
114 $this->whoops->register();
115
116 self::$whoops_handlers_registered = true;
117 }
118
126 public function getHandler()
127 {
128 // TODO: * Use Whoops in production mode? This would require an appropriate
129 // error-handler.
130 // * Check for context? The current implementation e.g. would output HTML for
131 // for SOAP.
132
133 if ($this->isDevmodeActive()) {
134 return $this->devmodeHandler();
135 }
136
137 return $this->defaultHandler();
138 }
139
140 public function getLastError()
141 {
142 return $this->error_obj;
143 }
144
150 public function errorHandler($a_error_obj)
151 {
152 global $log;
153
154 // see bug 18499 (some calls to raiseError do not pass a code, which leads to security issues, if these calls
155 // are done due to permission checks)
156 if ($a_error_obj->getCode() == null) {
157 $a_error_obj->code = $this->WARNING;
158 }
159
160 $this->error_obj = &$a_error_obj;
161 //echo "-".$_SESSION["referer"]."-";
162 if ($_SESSION["failure"] && substr($a_error_obj->getMessage(), 0, 22) != "Cannot find this block") {
163 $m = "Fatal Error: Called raise error two times.<br>" .
164 "First error: " . $_SESSION["failure"] . '<br>' .
165 "Last Error:" . $a_error_obj->getMessage();
166 //return;
167 $log->write($m);
168 #$log->writeWarning($m);
169 #$log->logError($a_error_obj->getCode(), $m);
170 unset($_SESSION["failure"]);
171 die($m);
172 }
173
174 if (substr($a_error_obj->getMessage(), 0, 22) == "Cannot find this block") {
175 if (DEVMODE == 1) {
176 echo "<b>DEVMODE</b><br><br>";
177 echo "<b>Template Block not found.</b><br>";
178 echo "You used a template block in your code that is not available.<br>";
179 echo "Native Messge: <b>" . $a_error_obj->getMessage() . "</b><br>";
180 if (is_array($a_error_obj->backtrace)) {
181 echo "Backtrace:<br>";
182 foreach ($a_error_obj->backtrace as $b) {
183 if ($b["function"] == "setCurrentBlock" &&
184 basename($b["file"]) != "class.ilTemplate.php") {
185 echo "<b>";
186 }
187 echo "File: " . $b["file"] . ", ";
188 echo "Line: " . $b["line"] . ", ";
189 echo $b["function"] . "()<br>";
190 if ($b["function"] == "setCurrentBlock" &&
191 basename($b["file"]) != "class.ilTemplate.php") {
192 echo "</b>";
193 }
194 }
195 }
196 exit;
197 }
198 return;
199 }
200
201 if (is_object($log) and $log->enabled == true) {
202 $log->write($a_error_obj->getMessage());
203 #$log->logError($a_error_obj->getCode(),$a_error_obj->getMessage());
204 }
205
206 //echo $a_error_obj->getCode().":"; exit;
207 if ($a_error_obj->getCode() == $this->FATAL) {
208 trigger_error(stripslashes($a_error_obj->getMessage()), E_USER_ERROR);
209 exit();
210 }
211
212 if ($a_error_obj->getCode() == $this->WARNING) {
213 if ($this->DEBUG_ENV) {
214 $message = $a_error_obj->getMessage();
215 } else {
216 $message = "Under Construction";
217 }
218
219 $_SESSION["failure"] = $message;
220
221 if (!defined("ILIAS_MODULE")) {
222 ilUtil::redirect("error.php");
223 } else {
224 ilUtil::redirect("../error.php");
225 }
226 }
227
228 if ($a_error_obj->getCode() == $this->MESSAGE) {
229 $_SESSION["failure"] = $a_error_obj->getMessage();
230 // save post vars to session in case of error
231 $_SESSION["error_post_vars"] = $_POST;
232
233 if (empty($_SESSION["referer"])) {
234 $dirname = dirname($_SERVER["PHP_SELF"]);
235 $ilurl = parse_url(ILIAS_HTTP_PATH);
236
237 $subdir = '';
238 if (is_array($ilurl) && array_key_exists('path', $ilurl) && strlen($ilurl['path'])) {
239 $subdir = substr(strstr($dirname, (string) $ilurl["path"]), strlen((string) $ilurl["path"]));
240 $updir = "";
241 }
242 if ($subdir) {
243 $num_subdirs = substr_count($subdir, "/");
244
245 for ($i = 1;$i <= $num_subdirs;$i++) {
246 $updir .= "../";
247 }
248 }
249 ilUtil::redirect($updir . "index.php");
250 }
251
252 /* #12104
253 check if already GET-Parameters exists in Referer-URI
254 if (substr($_SESSION["referer"],-4) == ".php")
255 {
256 $glue = "?";
257 }
258 else
259 {
260 // this did break permanent links (".html&")
261 $glue = "&";
262 }
263 */
264 ilUtil::redirect($_SESSION["referer"]);
265 }
266 }
267
268 public function getMessage()
269 {
270 return $this->message;
271 }
272 public function setMessage($a_message)
273 {
274 $this->message = $a_message;
275 }
276 public function appendMessage($a_message)
277 {
278 if ($this->getMessage()) {
279 $this->message .= "<br /> ";
280 }
281 $this->message .= $a_message;
282 }
283
293 public static function _ilErrorWriter($errno, $errstr, $errfile, $errline)
294 {
295 global $ilLog;
296
297 switch ($errno) {
298 case E_USER_ERROR:
299 $ilLog->write('PHP errror: ' . $errstr . '. FATAL error on line ' . $errline . ' in file ' . $errfile);
300 unset($ilLog);
301 exit(1);
302
303 case E_USER_WARNING:
304 $ilLog->write('PHP warning: [' . $errno . '] ' . $errstr . ' on line ' . $errline . ' in file ' . $errfile);
305 break;
306
307 }
308 return true;
309 }
310
315 protected function getIlRuntime()
316 {
317 return ilRuntime::getInstance();
318 }
319
324 protected function getWhoops()
325 {
326 return new Run();
327 }
328
333 protected function isDevmodeActive()
334 {
335 return defined("DEVMODE") && (int) DEVMODE === 1;
336 }
337
342 protected function defaultHandler()
343 {
344 // php7-todo : alex, 1.3.2016: Exception -> Throwable, please check
345 return new CallbackHandler(function ($exception, Inspector $inspector, Run $run) {
346 global $lng;
347
348 require_once("Services/Logging/classes/error/class.ilLoggingErrorSettings.php");
349 require_once("Services/Logging/classes/error/class.ilLoggingErrorFileStorage.php");
350 require_once("Services/Utilities/classes/class.ilUtil.php");
351
352 $session_id = substr(session_id(), 0, 5);
353 $random = new \ilRandom();
354 $err_num = $random->int(1, 9999);
355 $file_name = $session_id . "_" . $err_num;
356
358 if (!empty($logger->folder())) {
359 $lwriter = new ilLoggingErrorFileStorage($inspector, $logger->folder(), $file_name);
360 $lwriter->write();
361 }
362
363 //Use $lng if defined or fallback to english
364 if ($lng !== null) {
365 $lng->loadLanguageModule('logging');
366 $message = sprintf($lng->txt("log_error_message"), $file_name);
367
368 if ($logger->mail()) {
369 $message .= " " . sprintf($lng->txt("log_error_message_send_mail"), $logger->mail(), $file_name, $logger->mail());
370 }
371 } else {
372 $message = 'Sorry, an error occured. A logfile has been created which can be identified via the code "' . $file_name . '"';
373
374 if ($logger->mail()) {
375 $message .= ' ' . 'Please send a mail to <a href="mailto:' . $logger->mail() . '?subject=code: ' . $file_name . '">' . $logger->mail() . '</a>';
376 }
377 }
378
380 ilUtil::redirect("error.php");
381 });
382 }
383
388 protected function devmodeHandler()
389 {
390 global $ilLog;
391
392 switch (ERROR_HANDLER) {
393 case "TESTING":
394 return new ilTestingHandler();
395 case "PLAIN_TEXT":
396 return new ilPlainTextHandler();
397 case "PRETTY_PAGE":
398 // fallthrough
399 default:
400 if ((!defined('ERROR_HANDLER') || ERROR_HANDLER != 'PRETTY_PAGE') && $ilLog) {
401 $ilLog->write(
402 "Unknown or undefined error handler '" . ERROR_HANDLER . "'. " .
403 "Falling back to PrettyPageHandler."
404 );
405 }
406
407 $prettyPageHandler = new PrettyPageHandler();
408
409 $this->addEditorSupport($prettyPageHandler);
410
411 return $prettyPageHandler;
412 }
413 }
414
418 protected function addEditorSupport(PrettyPageHandler $handler)
419 {
420 $editorUrl = defined('ERROR_EDITOR_URL') ? ERROR_EDITOR_URL : '';
421 if (!is_string($editorUrl) || 0 === strlen($editorUrl)) {
422 return;
423 }
424
425 $pathTranslationConfig = defined('ERROR_EDITOR_PATH_TRANSLATIONS') ? ERROR_EDITOR_PATH_TRANSLATIONS : '';
426
427 $pathTranslations = $this->parseEditorPathTranslation($pathTranslationConfig);
428
429 $handler->setEditor(function ($file, $line) use ($editorUrl, $pathTranslations) {
430 $this->applyEditorPathTranslations($file, $pathTranslations);
431
432 return str_ireplace(
433 ['[FILE]', '[LINE]'],
434 [$file, $line],
435 $editorUrl
436 );
437 });
438 }
439
444 protected function applyEditorPathTranslations(string &$file, array $pathTranslations)
445 {
446 foreach ($pathTranslations as $from => $to) {
447 $file = preg_replace('@' . $from . '@', $to, $file);
448 }
449 }
450
451
456 protected function parseEditorPathTranslation(string $pathTranslationConfig)
457 {
458 $pathTranslations = [];
459
460 $mappings = explode('|', $pathTranslationConfig);
461 foreach ($mappings as $mapping) {
462 $parts = explode(',', $mapping);
463 $pathTranslations[trim($parts[0])] = trim($parts[1]);
464 }
465
466 return $pathTranslations;
467 }
468
473 protected function loggingHandler()
474 {
475 // php7-todo : alex, 1.3.2016: Exception -> Throwable, please check
476 return new CallbackHandler(function ($exception, Inspector $inspector, Run $run) {
481 global $ilLog;
482
483 if (is_object($ilLog)) {
484 $message = $exception->getMessage() . ' in ' . $exception->getFile() . ":" . $exception->getLine() ;
485 $message .= $exception->getTraceAsString();
486 $ilLog->error($exception->getCode() . ' ' . $message);
487 }
488
489 // Send to system logger
490 error_log($exception->getMessage());
491 });
492 }
493
494 public function handlePreWhoops($level, $message, $file, $line)
495 {
496 global $ilLog;
497
498 if ($level & error_reporting()) {
499
500 // correct-with-php5-removal JL start
501 // ignore all E_STRICT that are E_NOTICE (or nothing at all) in PHP7
502 if (version_compare(PHP_VERSION, '7.0.0', '<')) {
503 if ($level == E_STRICT) {
504 if (!stristr($message, "should be compatible") &&
505 !stristr($message, "should not be called statically") &&
506 !stristr($message, "should not be abstract")) {
507 return true;
508 };
509 }
510 }
511 // correct-with-php5-removal end
512
513 if (!$this->isDevmodeActive()) {
514 // log E_USER_NOTICE, E_STRICT, E_DEPRECATED, E_USER_DEPRECATED only
515 if ($level >= E_USER_NOTICE) {
516 if ($ilLog) {
517 $severity = Whoops\Util\Misc::TranslateErrorCode($level);
518 $ilLog->write("\n\n" . $severity . " - " . $message . "\n" . $file . " - line " . $line . "\n");
519 }
520 return true;
521 }
522 }
523
524 // trigger whoops error handling
525 if ($this->whoops) {
526 return $this->whoops->handleError($level, $message, $file, $line);
527 }
528 }
529
530 return false;
531 }
532} // END class.ilErrorHandling
$_POST["username"]
$_SESSION["AccountId"]
An exception for terminatinating execution or to throw for unit testing.
initWhoopsHandlers()
Initialize Error and Exception Handlers.
handlePreWhoops($level, $message, $file, $line)
parseEditorPathTranslation(string $pathTranslationConfig)
errorHandler($a_error_obj)
defines what has to happen in case of error @access private
devmodeHandler()
Get the handler to be used in DEVMODE.
__construct()
Constructor @access public.
getWhoops()
Get an instance of Whoops/Run.
static _ilErrorWriter($errno, $errstr, $errfile, $errline)
This is used in Soap calls to write PHP error in ILIAS Logfile Not used yet!!!
addEditorSupport(PrettyPageHandler $handler)
getIlRuntime()
Get ilRuntime.
isDevmodeActive()
Is the DEVMODE switched on?
getHandler()
Get a handler for an error or exception.
defaultHandler()
Get a default error handler.
applyEditorPathTranslations(string &$file, array $pathTranslations)
Saves error informations into file.
static getInstance()
A Whoops error handler for testing.
static redirect($a_script)
static sendFailure($a_info="", $a_keep=false)
Send Failure Message to Screen.
exit
Definition: login.php:29
$i
Definition: metadata.php:24
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc
$_SERVER['HTTP_HOST']
Definition: raiseError.php:10
$log
Definition: result.php:15
$lng
$message
Definition: xapiexit.php:14