class.ilErrorHandling.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

require_once 'Services/Environment/classes/class.ilRuntime.php';

include_once 'PEAR.php';

class ilErrorHandling extends PEAR
{
        var $DEBUG_ENV;

        var $FATAL;

        var $WARNING;

        var $MESSAGE;

        function ilErrorHandling()
        {
                $this->PEAR();

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

                $this->error_obj = false;

                // Runtime errors currently only handled for HHVM
                if(ilRuntime::getInstance()->isHHVM())
                {
                        set_error_handler(
                                array($this, 'handleRuntimeErrors'),
                                ilRuntime::getInstance()->getReportedErrorLevels()
                        );
                }
                set_exception_handler(array($this, 'handleUncaughtException'));
        }

        function getLastError()
        {
                return $this->error_obj;
        }

        function errorHandler($a_error_obj)
        {
                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->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->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"]);                 
                }
        }

        function getMessage()
        {
                return $this->message;
        }
        function setMessage($a_message)
        {
                $this->message = $a_message;
        }
        function appendMessage($a_message)
        {
                if($this->getMessage())
                {
                        $this->message .= "<br /> ";
                }
                $this->message .= $a_message;
        }
        
        public static function _ilErrorWriter($errno, $errstr, $errfile, $errline)
        {
                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;
        }
        
        public function handleUncaughtException(Exception $e)
        {
                $error = $e->getMessage();
                if (DEVMODE)
                {
                        $error.= '<br /><br />';
                        $error.= nl2br($e->getTraceAsString());
                }
                $this->raiseError($error,$this->WARNING);
        }

        public function handleRuntimeErrors($a_error_code, $a_error_message, $a_error_file, $a_error_line)
        {
                // #15641 - the silence operator should suppress the error completely
                if(error_reporting() === 0)
                {
                        return;
                }
                
                $backtrace_array = $this->formatBacktraceArray(debug_backtrace());
                $error_code      = $this->translateErrorCode($a_error_code);

                if(ilRuntime::getInstance()->shouldLogErrors())
                {
                        error_log($error_code . ': ' . $a_error_message . ' in '.$a_error_file . ' on line ' . $a_error_line . PHP_EOL . implode(PHP_EOL, $backtrace_array));
                }

                if(ilRuntime::getInstance()->shouldDisplayErrors())
                {
                        print '<br /><b>' . $error_code . '</b>: ' . $a_error_message . ' in <b>'.$a_error_file . '</b> on line <b>' . $a_error_line . '</b><br/>' . implode('<br />', $backtrace_array);
                }

                return true;
        }

        protected function formatBacktraceArray(array $a_backtrace)
        {
                $stack = array();
                $i     = 1;

                unset($a_backtrace[0]); // remove first call from stack trace
                foreach($a_backtrace as $item)
                {
                        $stack_line = "#$i " . $item['file'] . "(" . $item['line'] . "): ";
                        if(isset($item['class']))
                        {
                                $stack_line .= $item['class'] . "->";
                        }
                        $stack_line .= $item['function'] . "()";
                        array_push($stack, $stack_line);
                        $i++;
                }

                return $stack;
        }

        protected function translateErrorCode($error_code)
        {
                $constants = get_defined_constants(true);
                foreach($constants['Core'] as $constant => $value)
                {
                        if(substr($constant, 0, 2) == 'E_' && $value == $error_code)
                        {
                                return $constant;
                        }
                }

                return 'E_UNKNOWN';
        }
} // END class.ilErrorHandling
?>