Error Handling & global info handling uses PEAR error class. More...

Inheritance diagram for ilErrorHandling:

Collaboration diagram for ilErrorHandling:

Public Member Functions
	__construct ()
	Constructor public. More...

	getHandler ()
	Get a handler for an error or exception. More...

	errorHandler ($a_error_obj)
	Defines what has to happen in case of error. More...

	getMessage ()

	setMessage (string $a_message)

	appendMessage (string $a_message)

	handlePreWhoops (int $level, string $message, string $file, int $line)
	Parameter types according to PHP doc: set_error_handler. More...

Public Member Functions inherited from PEAR
	__construct ($error_class=null)
	Constructor. More...

	_PEAR ()
	Destructor (the emulated type of...). More...

	registerShutdownFunc ($func, $args=array())
	Use this function to register a shutdown method for static classes. More...

	isError ($data, $code=null)
	Tell whether a value is a PEAR error. More...

	expectError ($code=' *')
	This method is used to tell which errors you expect to get. More...

	popExpect ()
	This method pops one element off the expected error codes stack. More...

	_checkDelExpect ($error_code)
	This method checks unsets an error code if available. More...

	delExpect ($error_code)
	This method deletes all occurences of the specified element from the expected error codes stack. More...

&	raiseError ($message=null, $code=null, $mode=null, $options=null, $userinfo=null, $error_class=null, $skipmsg=false)
	This method is a wrapper that returns an instance of the configured error class with this object's default error handling applied. More...

&	throwError ($message=null, $code=null, $userinfo=null)
	Simpler form of raiseError with fewer options. More...

	staticPushErrorHandling ($mode, $options=null)

	staticPopErrorHandling ()

	pushErrorHandling ($mode, $options=null)
	Push a new error handler on top of the error handler options stack. More...

	popErrorHandling ()
	Pop the last error handler used. More...

	loadExtension ($ext)
	OS independant PHP extension load. More...

Data Fields
int	$FATAL = 1
	Error level 1: exit application immedietly. More...

int	$WARNING = 2
	Error level 2: show warning page. More...

int	$MESSAGE = 3
	Error level 3: show message in recent page. More...

Data Fields inherited from PEAR
	$_debug = false

	$_default_error_mode = null

	$_default_error_options = null

	$_default_error_handler = ''

	$_error_class = 'PEAR_Error'

	$_expected_errors = array()

Protected Member Functions
	initWhoopsHandlers ()
	Initialize Error and Exception Handlers. More...

	getIlRuntime ()

	getWhoops ()

	isDevmodeActive ()

	defaultHandler ()

	devmodeHandler ()
	Get the handler to be used in DEVMODE. More...

	addEditorSupport (PrettyPageHandler $handler)

	applyEditorPathTranslations (string &$file, array $pathTranslations)

	parseEditorPathTranslation (string $pathTranslationConfig)

Protected Attributes
RunInterface	$whoops

string	$message

bool	$DEBUG_ENV

	$error_obj = null

Static Protected Attributes
static bool	$whoops_handlers_registered = false

Private Attributes
const	SENSTIVE_PARAMETER_NAMES

Additional Inherited Members
Static Public Member Functions inherited from PEAR
static &	getStaticProperty ($class, $var)
	If you have a class that's mostly/entirely static, and you need static properties, you can use this method to simulate them. More...

static	setErrorHandling ($mode=null, $options=null)
	Sets how errors generated by this object should be handled. More...

Detailed Description

Error Handling & global info handling uses PEAR error class.

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om; Sascha Hofmann shofm.nosp@m.ann@.nosp@m.datab.nosp@m.ay.d.nosp@m.e; Richard Klees richa.nosp@m.rd.k.nosp@m.lees@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de; Stefan Hecken stefa.nosp@m.n.he.nosp@m.cken@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

Version: $Id$

Todo:

when an error occured and clicking the back button to return to previous page the referer-var in session is deleted -> server error

This class is a candidate for a singleton. initHandlers could only be called once per process anyways, as it checks for static $handlers_registered.

Definition at line 38 of file class.ilErrorHandling.php.

Constructor & Destructor Documentation

◆ __construct()

ilErrorHandling::__construct ( )

Constructor public.

Definition at line 86 of file class.ilErrorHandling.php.

References ILIAS\GlobalScreen\Provider\__construct(), and initWhoopsHandlers().

     {
         parent::__construct();
 
         // init vars
         $this->DEBUG_ENV = true;
         $this->FATAL = 1;
         $this->WARNING = 2;
         $this->MESSAGE = 3;
 
         $this->error_obj = null;
 
         $this->initWhoopsHandlers();
 
         // somehow we need to get rid of the whoops error handler
         restore_error_handler();
         set_error_handler([$this, "handlePreWhoops"]);
     }

Here is the call graph for this function:

Member Function Documentation

◆ addEditorSupport()

ilErrorHandling::addEditorSupport ( PrettyPageHandler $handler )

protected

Definition at line 372 of file class.ilErrorHandling.php.

References applyEditorPathTranslations(), and parseEditorPathTranslation().

Referenced by devmodeHandler().

                                                                    : void
     {
         $editorUrl = defined('ERROR_EDITOR_URL') ? ERROR_EDITOR_URL : '';
         if (!is_string($editorUrl) || $editorUrl === '') {
             return;
         }
 
         $pathTranslationConfig = defined('ERROR_EDITOR_PATH_TRANSLATIONS') ? ERROR_EDITOR_PATH_TRANSLATIONS : '';
 
         $pathTranslations = $this->parseEditorPathTranslation($pathTranslationConfig);
 
         $handler->setEditor(function ($file, $line) use ($editorUrl, $pathTranslations) {
             $this->applyEditorPathTranslations($file, $pathTranslations);
 
             return str_ireplace(
                 ['[FILE]', '[LINE]'],
                 [$file, $line],
                 $editorUrl
             );
         });
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ appendMessage()

ilErrorHandling::appendMessage ( string $a_message )

Definition at line 260 of file class.ilErrorHandling.php.

References getMessage().

                                                     : void
     {
         if ($this->getMessage()) {
             $this->message .= "<br /> ";
         }
         $this->message .= $a_message;
     }

Here is the call graph for this function:

◆ applyEditorPathTranslations()

ilErrorHandling::applyEditorPathTranslations	(	string &	$file,
		array	$pathTranslations
	)

protected

Definition at line 394 of file class.ilErrorHandling.php.

Referenced by addEditorSupport().

                                                                                           : void
     {
         foreach ($pathTranslations as $from => $to) {
             $file = preg_replace('@' . $from . '@', $to, $file);
         }
     }

Here is the caller graph for this function:

◆ defaultHandler()

ilErrorHandling::defaultHandler ( )

protected

Definition at line 283 of file class.ilErrorHandling.php.

References $DIC, exit, ilLoggingErrorSettings\getInstance(), ilSession\set(), ilLoggingErrorFileStorage\withExclusionList(), and ilLoggingErrorFileStorage\write().

Referenced by getHandler().

                                        : HandlerInterface
     {
         // php7-todo : alex, 1.3.2016: Exception -> Throwable, please check
         return new CallbackHandler(function ($exception, Inspector $inspector, Run $run) {
             global $DIC;
 
             require_once("Services/Logging/classes/error/class.ilLoggingErrorSettings.php");
             require_once("Services/Logging/classes/error/class.ilLoggingErrorFileStorage.php");
             require_once("Services/Utilities/classes/class.ilUtil.php");
 
             $session_id = substr(session_id(), 0, 5);
             $random = new \ilRandom();
             $err_num = $random->int(1, 9999);
             $file_name = $session_id . "_" . $err_num;
 
             $logger = ilLoggingErrorSettings::getInstance();
             if (!empty($logger->folder())) {
                 $lwriter = new ilLoggingErrorFileStorage($inspector, $logger->folder(), $file_name);
                 $lwriter = $lwriter->withExclusionList(self::SENSTIVE_PARAMETER_NAMES);
                 $lwriter->write();
             }
 
             //Use $lng if defined or fallback to english
             if ($DIC->isDependencyAvailable('language')) {
                 $DIC->language()->loadLanguageModule('logging');
                 $message = sprintf($DIC->language()->txt("log_error_message"), $file_name);
 
                 if ($logger->mail()) {
                     $message .= " " . sprintf(
                         $DIC->language()->txt("log_error_message_send_mail"),
                         $logger->mail(),
                         $file_name,
                         $logger->mail()
                     );
                 }
             } else {
                 $message = 'Sorry, an error occured. A logfile has been created which can be identified via the code "' . $file_name . '"';
 
                 if ($logger->mail()) {
                     $message .= ' ' . 'Please send a mail to <a href="mailto:' . $logger->mail() . '?subject=code: ' . $file_name . '">' . $logger->mail() . '</a>';
                 }
             }
             if ($DIC->isDependencyAvailable('ui') && isset($DIC['tpl']) && $DIC->isDependencyAvailable('ctrl')) {
                 $DIC->ui()->mainTemplate()->setOnScreenMessage('failure', $message, true);
                 $DIC->ctrl()->redirectToURL("error.php");
             } else {
                 ilSession::set('failure', $message);
                 header("Location: error.php");
                 exit;
             }
         });
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ devmodeHandler()

ilErrorHandling::devmodeHandler ( )

protected

Get the handler to be used in DEVMODE.

Definition at line 339 of file class.ilErrorHandling.php.

References $param, and addEditorSupport().

Referenced by getHandler().

                                        : HandlerInterface
     {
         global $ilLog;
 
         switch (ERROR_HANDLER) {
             case "TESTING":
                 return (new ilTestingHandler())->withExclusionList(self::SENSTIVE_PARAMETER_NAMES);
 
             case "PLAIN_TEXT":
                 return (new ilPlainTextHandler())->withExclusionList(self::SENSTIVE_PARAMETER_NAMES);
 
             case "PRETTY_PAGE":
                 // fallthrough
             default:
                 if ((!defined('ERROR_HANDLER') || ERROR_HANDLER !== 'PRETTY_PAGE') && $ilLog) {
                     $ilLog->write(
                         "Unknown or undefined error handler '" . ERROR_HANDLER . "'. " .
                         "Falling back to PrettyPageHandler."
                     );
                 }
 
                 $prettyPageHandler = new PrettyPageHandler();
 
                 $this->addEditorSupport($prettyPageHandler);
 
                 foreach (self::SENSTIVE_PARAMETER_NAMES as $param) {
                     $prettyPageHandler->blacklist('_POST', $param);
                 }
 
                 return $prettyPageHandler;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ errorHandler()

ilErrorHandling::errorHandler ( $a_error_obj )

Defines what has to happen in case of error.

Parameters

PEAR_Error $a_error_obj PEAR Error object

Definition at line 147 of file class.ilErrorHandling.php.

References $_SERVER, Vendor\Package\$b, $FATAL, $i, $log, $MESSAGE, $WARNING, ilSession\clear(), exit, ilSession\get(), ilUtil\redirect(), and ilSession\set().

                                               : void
     {
         global $log;
 
         // see bug 18499 (some calls to raiseError do not pass a code, which leads to security issues, if these calls
         // are done due to permission checks)
         if ($a_error_obj->getCode() == null) {
             $a_error_obj->code = $this->WARNING;
         }
 
         $this->error_obj = &$a_error_obj;
         //echo "-".$_SESSION["referer"]."-";
         $session_failure = ilSession::get('failure');
         if ($session_failure && strpos($a_error_obj->getMessage(), "Cannot find this block") !== 0) {
             $m = "Fatal Error: Called raise error two times.<br>" .
                 "First error: " . $session_failure . '<br>' .
                 "Last Error:" . $a_error_obj->getMessage();
             //return;
             $log->write($m);
             #$log->writeWarning($m);
             #$log->logError($a_error_obj->getCode(), $m);
             ilSession::clear('failure');
             die($m);
         }
 
         if (strpos($a_error_obj->getMessage(), "Cannot find this block") === 0) {
             if (DEVMODE == 1) {
                 echo "<b>DEVMODE</b><br><br>";
                 echo "<b>Template Block not found.</b><br>";
                 echo "You used a template block in your code that is not available.<br>";
                 echo "Native Messge: <b>" . $a_error_obj->getMessage() . "</b><br>";
                 if (is_array($a_error_obj->backtrace)) {
                     echo "Backtrace:<br>";
                     foreach ($a_error_obj->backtrace as $b) {
                         if ($b["function"] === "setCurrentBlock" &&
                             basename($b["file"]) !== "class.ilTemplate.php") {
                             echo "<b>";
                         }
                         echo "File: " . $b["file"] . ", ";
                         echo "Line: " . $b["line"] . ", ";
                         echo $b["function"] . "()<br>";
                         if ($b["function"] === "setCurrentBlock" &&
                             basename($b["file"]) !== "class.ilTemplate.php") {
                             echo "</b>";
                         }
                     }
                 }
                 exit;
             }
             return;
         }
 
         if ($log instanceof ilLogger) {
             $log->write($a_error_obj->getMessage());
         }
         if ($a_error_obj->getCode() == $this->FATAL) {
             trigger_error(stripslashes($a_error_obj->getMessage()), E_USER_ERROR);
             exit();
         }
 
         if ($a_error_obj->getCode() == $this->WARNING) {
             if ($this->DEBUG_ENV) {
                 $message = $a_error_obj->getMessage();
             } else {
                 $message = "Under Construction";
             }
 
             ilSession::set('failure', $message);
 
             if (!defined("ILIAS_MODULE")) {
                 ilUtil::redirect("error.php");
             } else {
                 ilUtil::redirect("../error.php");
             }
         }
         $updir = '';
         if ($a_error_obj->getCode() == $this->MESSAGE) {
             ilSession::set('failure', $a_error_obj->getMessage());
             // save post vars to session in case of error
             $_SESSION["error_post_vars"] = $_POST;
 
             if (empty($_SESSION["referer"])) {
                 $dirname = dirname($_SERVER["PHP_SELF"]);
                 $ilurl = parse_url(ILIAS_HTTP_PATH);
 
                 $subdir = '';
                 if (is_array($ilurl) && array_key_exists('path', $ilurl) && strlen($ilurl['path'])) {
                     $subdir = substr(strstr($dirname, (string) $ilurl["path"]), strlen((string) $ilurl["path"]));
                     $updir = "";
                 }
                 if ($subdir) {
                     $num_subdirs = substr_count($subdir, "/");
 
                     for ($i = 1; $i <= $num_subdirs; $i++) {
                         $updir .= "../";
                     }
                 }
                 ilUtil::redirect($updir . "index.php");
             }
             ilUtil::redirect($_SESSION["referer"]);
         }
     }

Here is the call graph for this function:

◆ getHandler()

ilErrorHandling::getHandler ( )

Get a handler for an error or exception.

Uses Whoops Pretty Page Handler in DEVMODE and the legacy ILIAS-Error handlers otherwise.

Definition at line 130 of file class.ilErrorHandling.php.

References defaultHandler(), devmodeHandler(), and isDevmodeActive().

                                 : HandlerInterface
     {
         // TODO: * Use Whoops in production mode? This would require an appropriate
         //                 error-handler.
         //               * Check for context? The current implementation e.g. would output HTML for
         //                 for SOAP.
         if ($this->isDevmodeActive()) {
             return $this->devmodeHandler();
         }
 
         return $this->defaultHandler();
     }

Here is the call graph for this function:

◆ getIlRuntime()

ilErrorHandling::getIlRuntime ( )

protected

Definition at line 268 of file class.ilErrorHandling.php.

References ilRuntime\getInstance().

Referenced by initWhoopsHandlers().

                                      : ilRuntime
     {
         return ilRuntime::getInstance();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMessage()

ilErrorHandling::getMessage ( )

Definition at line 250 of file class.ilErrorHandling.php.

References $message.

Referenced by appendMessage(), ilObjCourseGUI\updateInfoObject(), and ILIAS\UI\Implementation\Component\Input\Field\FormInput\withInput().

                                 : string
     {
         return $this->message;
     }

Here is the caller graph for this function:

◆ getWhoops()

ilErrorHandling::getWhoops ( )

protected

Definition at line 273 of file class.ilErrorHandling.php.

Referenced by initWhoopsHandlers().

                                   : RunInterface
     {
         return new Run();
     }

Here is the caller graph for this function:

◆ handlePreWhoops()

ilErrorHandling::handlePreWhoops	(	int	$level,
		string	$message,
		string	$file,
		int	$line
	)

Parameter types according to PHP doc: set_error_handler.

Exceptions

Definition at line 441 of file class.ilErrorHandling.php.

References isDevmodeActive().

                                                                                          : bool
     {
         global $ilLog;
 
         if ($level & error_reporting()) {
             if (!$this->isDevmodeActive()) {
                 // log E_USER_NOTICE, E_STRICT, E_DEPRECATED, E_USER_DEPRECATED only
                 if ($level >= E_USER_NOTICE) {
                     if ($ilLog) {
                         $severity = Whoops\Util\Misc::translateErrorCode($level);
                         $ilLog->write("\n\n" . $severity . " - " . $message . "\n" . $file . " - line " . $line . "\n");
                     }
                     return true;
                 }
             }
 
             // trigger whoops error handling
             if ($this->whoops instanceof RunInterface) {
                 return $this->whoops->handleError($level, $message, $file, $line);
             }
             if ($this->whoops) {
                 return $this->whoops->handleError($level, $message, $file, $line);
             }
         }
         return true;
     }

Here is the call graph for this function:

◆ initWhoopsHandlers()

ilErrorHandling::initWhoopsHandlers ( )

protected

Initialize Error and Exception Handlers.

Initializes Whoops, a logging handler and a delegate handler for the late initialisation of an appropriate error handler.

Definition at line 110 of file class.ilErrorHandling.php.

References getIlRuntime(), and getWhoops().

Referenced by __construct().

                                            : void
     {
         if (self::$whoops_handlers_registered) {
             // Only register whoops error handlers once.
             return;
         }
         $ilRuntime = $this->getIlRuntime();
         $this->whoops = $this->getWhoops();
         $this->whoops->pushHandler(new ilDelegatingHandler($this));
         if ($ilRuntime->shouldLogErrors()) {
             $this->whoops->pushHandler($this->loggingHandler());
         }
         $this->whoops->register();
         self::$whoops_handlers_registered = true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isDevmodeActive()

ilErrorHandling::isDevmodeActive ( )

protected

Definition at line 278 of file class.ilErrorHandling.php.

References ILIAS\Repository\int().

Referenced by getHandler(), and handlePreWhoops().

                                         : bool
     {
         return defined("DEVMODE") && (int) DEVMODE === 1;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseEditorPathTranslation()

ilErrorHandling::parseEditorPathTranslation ( string $pathTranslationConfig )

protected

Definition at line 401 of file class.ilErrorHandling.php.

References $message, and $parts.

Referenced by addEditorSupport().

                                                                                 : array
     {
         $pathTranslations = [];
 
         $mappings = explode('|', $pathTranslationConfig);
         foreach ($mappings as $mapping) {
             $parts = explode(',', $mapping);
             if (count($parts) === 2) {
                 $pathTranslations[trim($parts[0])] = trim($parts[1]);
             }
         }
 
         return $pathTranslations;
     }

Here is the caller graph for this function:

◆ setMessage()

ilErrorHandling::setMessage ( string $a_message )

Definition at line 255 of file class.ilErrorHandling.php.

Referenced by ilObjCourseGUI\updateInfoObject().

                                                  : void
     {
         $this->message = $a_message;
     }

Here is the caller graph for this function:

Field Documentation

◆ $DEBUG_ENV

bool ilErrorHandling::$DEBUG_ENV

protected

Definition at line 54 of file class.ilErrorHandling.php.

◆ $error_obj

ilErrorHandling::$error_obj = null

protected

Definition at line 80 of file class.ilErrorHandling.php.

◆ $FATAL

int ilErrorHandling::$FATAL = 1

Error level 1: exit application immedietly.

Definition at line 59 of file class.ilErrorHandling.php.

Referenced by errorHandler().

◆ $message

string ilErrorHandling::$message

protected

Definition at line 53 of file class.ilErrorHandling.php.

Referenced by getMessage(), and parseEditorPathTranslation().

◆ $MESSAGE

int ilErrorHandling::$MESSAGE = 3

Error level 3: show message in recent page.

Definition at line 69 of file class.ilErrorHandling.php.

Referenced by errorHandler().

◆ $WARNING

int ilErrorHandling::$WARNING = 2

Error level 2: show warning page.

Definition at line 64 of file class.ilErrorHandling.php.

Referenced by errorHandler().

◆ $whoops

RunInterface ilErrorHandling::$whoops

protected

Definition at line 51 of file class.ilErrorHandling.php.

◆ $whoops_handlers_registered

bool ilErrorHandling::$whoops_handlers_registered = false

staticprotected

Definition at line 75 of file class.ilErrorHandling.php.

◆ SENSTIVE_PARAMETER_NAMES

const ilErrorHandling::SENSTIVE_PARAMETER_NAMES

private

Initial value:

= [
        'password',
        'passwd',
        'passwd_retype',
        'current_password',
        'usr_password',
        'usr_password_retype',
        'new_password',
        'new_password_retype',
    ]

Definition at line 40 of file class.ilErrorHandling.php.

The documentation for this class was generated from the following file:

Services/Init/classes/class.ilErrorHandling.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addEditorSupport()

◆ appendMessage()

◆ applyEditorPathTranslations()

◆ defaultHandler()

◆ devmodeHandler()

◆ errorHandler()

◆ getHandler()

◆ getIlRuntime()

◆ getMessage()

◆ getWhoops()

◆ handlePreWhoops()

◆ initWhoopsHandlers()

◆ isDevmodeActive()

◆ parseEditorPathTranslation()

◆ setMessage()

Field Documentation

◆ $DEBUG_ENV

◆ $error_obj

◆ $FATAL

◆ $message

◆ $MESSAGE

◆ $WARNING

◆ $whoops

◆ $whoops_handlers_registered

◆ SENSTIVE_PARAMETER_NAMES