Error Handling & global info handling. More...

Collaboration diagram for ilErrorHandling:

Public Member Functions
	__construct ()

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

	raiseError (string $message, ?int $code=null)

	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...

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...

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

	getIlRuntime ()

	getWhoops ()

	isDevmodeActive ()

	defaultHandler ()

	devmodeHandler ()

	addEditorSupport (PrettyPageHandler $handler)

	applyEditorPathTranslations (string &$file, array $pathTranslations)

	parseEditorPathTranslation (string $pathTranslationConfig)

Protected Attributes
RunInterface	$whoops

string	$message

bool	$DEBUG_ENV

Static Protected Attributes
static bool	$whoops_handlers_registered = false

Private Member Functions
	errorHandler (string $message, int $code, array $backtrace)

Private Attributes
const	SENSTIVE_PARAMETER_NAMES

Detailed Description

Error Handling & global info handling.

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

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 37 of file class.ilErrorHandling.php.

Constructor & Destructor Documentation

◆ __construct()

ilErrorHandling::__construct ( )

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

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

References initWhoopsHandlers().

Here is the call graph for this function:

Member Function Documentation

◆ addEditorSupport()

ilErrorHandling::addEditorSupport ( PrettyPageHandler $handler )

protected

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

                                                                   : 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
            );
        });
    }

References $handler.

◆ appendMessage()

ilErrorHandling::appendMessage ( string $a_message )

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

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

◆ applyEditorPathTranslations()

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

protected

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

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

◆ defaultHandler()

ilErrorHandling::defaultHandler ( )

protected

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

                                       : HandlerInterface
    {
        return new CallbackHandler(function ($exception, Inspector $inspector, Run $run) {
            global $DIC;
 
            $session_id = substr(session_id(), 0, 5);
            $r = new \Random\Randomizer();
            $err_num = $r->getInt(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;
            }
        });
    }

References $DIC, exit, ilLoggingErrorSettings\getInstance(), ILIAS\UI\examples\Symbol\Glyph\Header\header(), and ilSession\set().

Referenced by getHandler().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ devmodeHandler()

ilErrorHandling::devmodeHandler ( )

protected

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

                                       : 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;
        }
    }

References $param.

Referenced by getHandler().

Here is the caller graph for this function:

◆ errorHandler()

ilErrorHandling::errorHandler	(	string	$message,
		int	$code,
		array	$backtrace
	)

private

Parameters

list<array{"function" string, "line"?: int, "file"?: string, "class"?: class-string,"type"?: "->"|"::", "object"?: object, "args"?: list<mixed>}> $backtrace

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

                                                                               : void
    {
        global $log;
 
        $session_failure = ilSession::get('failure');
        if ($session_failure && !str_starts_with($message, 'Cannot find this block')) {
            $m = 'Fatal Error: Called raise error two times.<br>' .
                'First error: ' . $session_failure . '<br>' .
                'Last Error:' . $message;
            $log->write($m);
            ilSession::clear('failure');
            die($m);
        }
 
        if (str_starts_with($message, 'Cannot find this block')) {
            if ($this->isDevmodeActive()) {
                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>' . $message . '</b><br>';
                echo 'Backtrace:<br>';
                foreach ($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($message);
        }
        if ($code === $this->FATAL) {
            throw new RuntimeException(stripslashes($message));
        }
 
        if ($code === $this->WARNING) {
            if (!$this->DEBUG_ENV) {
                $message = 'Under Construction';
            }
 
            ilSession::set('failure', $message);
 
            if (!defined('ILIAS_MODULE')) {
                ilUtil::redirect('error.php');
            } else {
                ilUtil::redirect('../error.php');
            }
        }
        $updir = '';
        if ($code === $this->MESSAGE) {
            ilSession::set('failure', $message);
            // 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(ilUtil::_getHttpPath());
 
                $subdir = '';
                if (is_array($ilurl) && array_key_exists('path', $ilurl) && $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']);
        }
    }

References $_POST, $_SERVER, Vendor\Package\$b, $log, ilUtil\_getHttpPath(), ilSession\clear(), exit, ilSession\get(), ilUtil\redirect(), and ilSession\set().

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 115 of file class.ilErrorHandling.php.

                                : HandlerInterface
    {
        if (ilContext::getType() === ilContext::CONTEXT_SOAP &&
            strcasecmp($_SERVER['REQUEST_METHOD'] ?? '', 'post') === 0) {
            return new ilSoapExceptionHandler();
        }
 
        // TODO: There might be more specific execution contexts (WebDAV, REST, etc.) that need specific error handling.
 
        if ($this->isDevmodeActive()) {
            return $this->devmodeHandler();
        }
 
        return $this->defaultHandler();
    }

References $_SERVER, ilContext\CONTEXT_SOAP, defaultHandler(), devmodeHandler(), ilContext\getType(), and isDevmodeActive().

Here is the call graph for this function:

◆ getIlRuntime()

ilErrorHandling::getIlRuntime ( )

protected

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

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

References ilRuntime\getInstance().

Referenced by initWhoopsHandlers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMessage()

ilErrorHandling::getMessage ( )

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

                                : string
    {
        return $this->message;
    }

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

Here is the caller graph for this function:

◆ getWhoops()

ilErrorHandling::getWhoops ( )

protected

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

                                  : RunInterface
    {
        return new Run();
    }

Referenced by initWhoopsHandlers().

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

Whoops\Exception\ErrorException

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

                                                                                         : 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;
                }
            }
 
            if ($level === E_USER_DEPRECATED) {
                if ($ilLog) {
                    $severity = Whoops\Util\Misc::translateErrorCode($level);
                    $ilLog->write("\n\n" . $severity . ' - ' . $message . "\n" . $file . ' - line ' . $line . "\n");
                }
 
                return true;
            }
 
            if ($this->whoops instanceof RunInterface) {
                return $this->whoops->handleError($level, $message, $file, $line);
            }
        }
 
        return true;
    }

◆ 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 95 of file class.ilErrorHandling.php.

                                           : 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, self::SENSTIVE_PARAMETER_NAMES));
        if ($ilRuntime->shouldLogErrors()) {
            $this->whoops->pushHandler($this->loggingHandler());
        }
        $this->whoops->register();
        self::$whoops_handlers_registered = true;
    }

References getIlRuntime(), and getWhoops().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isDevmodeActive()

ilErrorHandling::isDevmodeActive ( )

protected

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

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

References ILIAS\Repository\int().

Referenced by getHandler().

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 378 of file class.ilErrorHandling.php.

                                                                                : 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;
    }

References $parts.

◆ raiseError()

ilErrorHandling::raiseError	(	string	$message,
		?int	$code = `null`
	)

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

     : void {
        $backtrace = debug_backtrace();
        if (isset($backtrace[0], $backtrace[0]['object'])) {
            unset($backtrace[0]['object']);
        }
 
        // 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)
        $this->errorHandler($message, $code ?? $this->WARNING, $backtrace);
    }

◆ setMessage()

ilErrorHandling::setMessage ( string $a_message )

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

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

Field Documentation

◆ $DEBUG_ENV

bool ilErrorHandling::$DEBUG_ENV

protected

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

◆ $FATAL

int ilErrorHandling::$FATAL = 1

Error level 1: exit application immedietly.

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

◆ $message

string ilErrorHandling::$message

protected

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

◆ $MESSAGE

int ilErrorHandling::$MESSAGE = 3

Error level 3: show message in recent page.

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

◆ $WARNING

int ilErrorHandling::$WARNING = 2

Error level 2: show warning page.

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

◆ $whoops

RunInterface ilErrorHandling::$whoops

protected

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

◆ $whoops_handlers_registered

bool ilErrorHandling::$whoops_handlers_registered = false

staticprotected

Definition at line 74 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 39 of file class.ilErrorHandling.php.

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

components/ILIAS/Init/classes/class.ilErrorHandling.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addEditorSupport()

◆ appendMessage()

◆ applyEditorPathTranslations()

◆ defaultHandler()

◆ devmodeHandler()

◆ errorHandler()

◆ getHandler()

◆ getIlRuntime()

◆ getMessage()

◆ getWhoops()

◆ handlePreWhoops()

◆ initWhoopsHandlers()

◆ isDevmodeActive()

◆ parseEditorPathTranslation()

◆ raiseError()

◆ setMessage()

Field Documentation

◆ $DEBUG_ENV

◆ $FATAL

◆ $message

◆ $MESSAGE

◆ $WARNING

◆ $whoops

◆ $whoops_handlers_registered

◆ SENSTIVE_PARAMETER_NAMES