ilErrorHandling Class Reference

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...
	getLastError ()
	errorHandler ($a_error_obj)
	defines what has to happen in case of error private More...
	getMessage ()
	setMessage ($a_message)
	appendMessage ($a_message)
	handlePreWhoops ($level, $message, $file, $line)
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...

Static Public Member Functions
static	_ilErrorWriter ($errno, $errstr, $errfile, $errline)
	This is used in Soap calls to write PHP error in ILIAS Logfile Not used yet!!! More...
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...

Data Fields
	$DEBUG_ENV
	$FATAL
	$WARNING
	$MESSAGE
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 ()
	Get ilRuntime. More...
	getWhoops ()
	Get an instance of Whoops/Run. More...
	isDevmodeActive ()
	Is the DEVMODE switched on? More...
	defaultHandler ()
	Get a default error handler. More...
	devmodeHandler ()
	Get the handler to be used in DEVMODE. More...

Static Protected Attributes
static	$whoops_handlers_registered = false

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilErrorHandling::__construct

(

)

Constructor public.

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

References initWhoopsHandlers().

    {
        parent::__construct();

        // init vars
        $this->DEBUG_ENV = true;
        $this->FATAL = 1;
        $this->WARNING = 2;
        $this->MESSAGE = 3;

        $this->error_obj = false;
        
        $this->initWhoopsHandlers();
        
        // somehow we need to get rid of the whoops error handler
        restore_error_handler();
        set_error_handler(array($this, "handlePreWhoops"));
    }

Here is the call graph for this function:

Member Function Documentation

_ilErrorWriter()

static ilErrorHandling::_ilErrorWriter (   $errno,   $errstr,   $errfile,   $errline  )

static

This is used in Soap calls to write PHP error in ILIAS Logfile Not used yet!!!

public

Parameters

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

References $ilLog, and exit.

    {
        global $ilLog;
        
        switch ($errno) {
            case E_USER_ERROR:
                $ilLog->write('PHP errror: ' . $errstr . '. FATAL error on line ' . $errline . ' in file ' . $errfile);
                unset($ilLog);
                exit(1);
            
            case E_USER_WARNING:
                $ilLog->write('PHP warning: [' . $errno . '] ' . $errstr . ' on line ' . $errline . ' in file ' . $errfile);
                break;
            
        }
        return true;
    }

appendMessage()

ilErrorHandling::appendMessage

(

$a_message

)

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

References getMessage().

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

Here is the call graph for this function:

defaultHandler()

ilErrorHandling::defaultHandler ( )

protected

Get a default error handler.

Returns

Whoops

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

References $lng, $message, ilLoggingErrorSettings\getInstance(), ilUtil\redirect(), ilUtil\sendFailure(), and ilLoggingErrorFileStorage\write().

Referenced by getHandler().

    {
        // php7-todo : alex, 1.3.2016: Exception -> Throwable, please check
        return new CallbackHandler(function ($exception, Inspector $inspector, Run $run) {
            global $lng;

            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->write();
            }

            //Use $lng if defined or fallback to english
            if ($lng !== null) {
                $lng->loadLanguageModule('logging');
                $message = sprintf($lng->txt("log_error_message"), $file_name);

                if ($logger->mail()) {
                    $message .= " " . sprintf($lng->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>';
                }
            }

            ilUtil::sendFailure($message, true);
            ilUtil::redirect("error.php");
        });
    }

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.

Returns

Whoops

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

References $ilLog, $message, and Monolog\Handler\error_log().

Referenced by getHandler().

    {
        global $ilLog;
        
        switch (ERROR_HANDLER) {
            case "TESTING":
                return new ilTestingHandler();
            case "PLAIN_TEXT":
                return new ilPlainTextHandler();
            case "PRETTY_PAGE":
                return new PrettyPageHandler();
            default:
                if ($ilLog) {
                    $ilLog->write("Unknown or undefined error handler '" . ERROR_HANDLER . "'. "
                                 . "Falling back to PrettyPageHandler.");
                }
                return new 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 private

Parameters

object

Error

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

References $_POST, $_SERVER, $_SESSION, $FATAL, $i, $log, $m, $message, $MESSAGE, $WARNING, exit, and ilUtil\redirect().

    {
        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"]."-";
        if ($_SESSION["failure"] && substr($a_error_obj->getMessage(), 0, 22) != "Cannot find this block") {
            $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);
            unset($_SESSION["failure"]);
            die($m);
        }

        if (substr($a_error_obj->getMessage(), 0, 22) == "Cannot find this block") {
            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 (is_object($log) and $log->enabled == true) {
            $log->write($a_error_obj->getMessage());
            #$log->logError($a_error_obj->getCode(),$a_error_obj->getMessage());
        }

        //echo $a_error_obj->getCode().":"; exit;
        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";
            }

            $_SESSION["failure"] = $message;

            if (!defined("ILIAS_MODULE")) {
                ilUtil::redirect("error.php");
            } else {
                ilUtil::redirect("../error.php");
            }
        }

        if ($a_error_obj->getCode() == $this->MESSAGE) {
            $_SESSION["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 = substr(strstr($dirname, $ilurl["path"]), strlen($ilurl["path"]));
                $updir = "";

                if ($subdir) {
                    $num_subdirs = substr_count($subdir, "/");

                    for ($i = 1;$i <= $num_subdirs;$i++) {
                        $updir .= "../";
                    }
                }
                ilUtil::redirect($updir . "index.php");
            }

            /* #12104
            check if already GET-Parameters exists in Referer-URI
            if (substr($_SESSION["referer"],-4) == ".php")
            {
                $glue = "?";
            }
            else
            {
                // this did break permanent links (".html&")
                $glue = "&";
            }
            */
            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.

Returns

Whoops

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

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

    {
        // 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

Get ilRuntime.

Returns

ilRuntime

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

References ilRuntime\getInstance().

Referenced by initWhoopsHandlers().

    {
        return ilRuntime::getInstance();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLastError()

ilErrorHandling::getLastError

(

)

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

    {
        return $this->error_obj;
    }

getMessage()

ilErrorHandling::getMessage

(

)

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

References $message.

Referenced by appendMessage().

    {
        return $this->message;
    }

Here is the caller graph for this function:

getWhoops()

ilErrorHandling::getWhoops ( )

protected

Get an instance of Whoops/Run.

Returns

Whoops

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

Referenced by initWhoopsHandlers().

    {
        return new Run();
    }

Here is the caller graph for this function:

handlePreWhoops()

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

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

References $ilLog, $message, and isDevmodeActive().

    {
        global $ilLog;
        
        if ($level & error_reporting()) {
            
            // correct-with-php5-removal JL start
            // ignore all E_STRICT that are E_NOTICE (or nothing at all) in PHP7
            if (version_compare(PHP_VERSION, '7.0.0', '<')) {
                if ($level == E_STRICT) {
                    if (!stristr($message, "should be compatible") &&
                        !stristr($message, "should not be called statically") &&
                        !stristr($message, "should not be abstract")) {
                        return true;
                    };
                }
            }
            // correct-with-php5-removal end

            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) {
                return $this->whoops->handleError($level, $message, $file, $line);
            }
        }
        
        return false;
    }

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.

Returns

void

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

References getIlRuntime(), and getWhoops().

Referenced by __construct().

    {
        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

Is the DEVMODE switched on?

Returns

bool

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

Referenced by getHandler(), and handlePreWhoops().

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

Here is the caller graph for this function:

setMessage()

ilErrorHandling::setMessage

(

$a_message

)

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

    {
        $this->message = $a_message;
    }

Field Documentation

$DEBUG_ENV

ilErrorHandling::$DEBUG_ENV

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

$FATAL

ilErrorHandling::$FATAL

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

Referenced by errorHandler().

$MESSAGE

ilErrorHandling::$MESSAGE

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

Referenced by errorHandler().

$WARNING

ilErrorHandling::$WARNING

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

Referenced by errorHandler().

$whoops_handlers_registered

ilErrorHandling::$whoops_handlers_registered = false

staticprotected

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

---

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

• Services/Init/classes/class.ilErrorHandling.php