class.ilLog.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2011 ILIAS open source, Extended GPL, see docs/LICENSE */


class ilLog
{

        var $path;
        var $filename;
        var $tag;
        var $log_format;
 
        var $FATAL;

        var $WARNING;

        var $MESSAGE;
        
        var $fp = false;

        function __construct($a_log_path, $a_log_file, $a_tag = "", $a_enabled = true, $a_log_level = NULL)
        {
                // init vars
                include_once './Services/Logging/classes/public/class.ilLogLevel.php';
                
                $this->FATAL     = ilLogLevel::CRITICAL;
                $this->WARNING   = ilLogLevel::WARNING;
                $this->MESSAGE   = ilLogLevel::INFO;
  
        $this->default_log_level= $this->WARNING;
        $this->current_log_level = $this->setLogLevel($a_log_level);

                $this->path = ($a_log_path) ? $a_log_path : ILIAS_ABSOLUTE_PATH;
                $this->filename = ($a_log_file) ? $a_log_file : "ilias.log";
                $this->tag = ($a_tag == "") ? "unknown" : $a_tag;
                $this->enabled = (bool) $a_enabled;

                $this->setLogFormat(@date("[y-m-d H:i:s] ")."[".$this->tag."] ");
                
                $this->open();

        }
 
    function setLogLevel($a_log_level)
    {
        switch (strtolower($a_log_level))
        {
            case "fatal":
                return $this->FATAL;
            case "warning":
                return $this->WARNING;
            case "message":
                return $this->MESSAGE;
            default:
                return $this->default_log_level;
        }
    }

    function checkLogLevel($a_log_level)
    {
        if (empty($a_log_level))
            return $this->default_log_level;

        $level = (int) $a_log_level;
        
        if ($a_log_level != (int) $a_log_level)
            return $this->default_log_level;
        
        return $level;
    }

        function setLogFormat($a_format)
        {
                $this->log_format = $a_format;
        }
        
        function getLogFormat()
        {
                return $this->log_format;
        }

        function setPath($a_str)
        {
                $this->path = $a_str;

                // on filename change reload close current file
                if($this->fp)
                {
                        fclose($this->fp);
                        $this->fp = null;
                }
        }

        function setFilename($a_str)
        {
                $this->filename = $a_str;
                
                // on filename change reload close current file
                if($this->fp)
                {
                        fclose($this->fp);
                        $this->fp = null;
                }
        }

        function setTag($a_str)
        {
                $this->tag = $a_str;
        }
        
        function writeLanguageLog($a_topic,$a_lang_key)
        {
                //TODO: go through logfile and search for the topic
                //only write the log if the error wasn't reported yet
                $this->write("Language (".$a_lang_key."): topic -".$a_topic."- not present",$this->MESSAGE);
        }

        function writeWarning($a_message)
        {
                $this->write("WARNING: ".$a_message);
        }
        
        function logError($a_code,$a_msg)
        {
                switch ($a_code)
                {
                        case "3":
                                return; // don't log messages
                                $error_level = "message";
                                break;

                        case "2":
                                $error_level = "warning";
                                break;

                        case "1":
                                $error_level = "fatal";
                                break;
                                
                        default:
                                $error_level = "unknown";
                                break;
                }
                
                $this->write("ERROR (".$error_level."): ".$a_msg);      
        }

        function write($a_msg, $a_log_level = NULL)
        {
                if ($this->enabled and $this->current_log_level >= $this->checkLogLevel($a_log_level))
                {
                        $this->open();
                        
                        if ($this->fp == false)
                        {
                                //die("Logfile: cannot open file. Please give Logfile Writepermissions.");
                        }

                        if (fwrite($this->fp,$this->getLogFormat().$a_msg."\n") == -1)
                        {
                                //die("Logfile: cannot write to file. Please give Logfile Writepermissions.");
                        }
                        
                        // note: logStack() calls write() again, so do not make this call
                        // if no log level is given
                        if ($a_log_level == $this->FATAL)
                        {
                                $this->logStack();
                        }
                }
        }
        
        public function logStack($a_message = '')
        {
                try
                {
                        throw new Exception($a_message);
                }
                catch(Exception $e)
                {
                        $this->write($e->getTraceAsString());
                }
        }

        function dump($a_var, $a_log_level = NULL)
        {
                $this->write(print_r($a_var, true), $a_log_level);
        }
        
        private function open()
        {
                if(!$this->fp)
                {
                    $this->fp = @fopen ($this->path."/".$this->filename, "a");
                }

                if (!$this->fp && $this->enabled)
                {
                        include_once("./Services/Logging/exceptions/class.ilLogException.php");
                        throw new ilLogException('Unable to open log file for writing. Please check setup path to log file and possible write access.');
                }
        }
        
        public function __destruct()
        {
                @fclose($this->fp);
        }

        

        function delete()
        {
                if (@is_file($this->path."/".$this->filename))
                {
                        @unlink($this->path."/".$this->filename);
                }
        }
} // END class.ilLog
?>