class.ilLoggingActivity.php

Go to the documentation of this file.

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

require_once './Services/WorkflowEngine/interfaces/ilActivity.php';
require_once './Services/WorkflowEngine/interfaces/ilWorkflowEngineElement.php';
require_once './Services/WorkflowEngine/interfaces/ilNode.php';

class ilLoggingActivity implements ilActivity, ilWorkflowEngineElement
{
        private $context;

        private $log_file = 'none.log';

        private $log_message = 'no message set';

        private $log_level = 'MESSAGE';

        protected $name;

        public function __construct(ilNode $a_context)
        {
                $this->context = $a_context;
        }

        public function setLogFile($a_log_file)
        {
                $extension = substr($a_log_file, strlen($a_log_file)-4, 4);
                $this->checkExtensionValidity( $extension );
                $this->checkFileWriteability( $a_log_file );
                $this->log_file = $a_log_file;
        }

        private function checkFileWriteability( $a_log_file )
        {
                @$file_handle = fopen( $a_log_file, 'a+' );
                if ( $file_handle == null )
                {
                        require_once './Services/WorkflowEngine/exceptions/ilWorkflowFilesystemException.php';
                        throw new ilWorkflowFilesystemException( 'Could not write to filesystem - no pointer returned.', 1002 );
                }
                fclose( $file_handle );
        }

        private function checkExtensionValidity( $extension )
        {
                if ( $extension != '.log' && $extension != '.txt' )
                {
                        require_once './Services/WorkflowEngine/exceptions/ilWorkflowObjectStateException.php';
                        throw new ilWorkflowObjectStateException( 'Illegal extension. Log file must be either .txt or .log.', 1002 );
                }
        }

        public function getLogFile()
        {
                return $this->log_file;
        }

        public function setLogMessage($a_log_message)
        {
                $this->checkForExistingLogMessageContent( $a_log_message );
                $this->log_message = $a_log_message;
        }

        private function checkForExistingLogMessageContent( $a_log_message )
        {
                if ( $a_log_message == null || $a_log_message == '' )
                {
                        require_once './Services/WorkflowEngine/exceptions/ilWorkflowObjectStateException.php';
                        throw new ilWorkflowObjectStateException( 'Log message must not be null or empty.', 1002 );
                }
        }

        public function getLogMessage()
        {
                return $this->log_message;
        }

        public function setLogLevel($a_log_level)
        {
                $valid = $this->determineValidityOfLogLevel( $a_log_level );
                if ($valid == false)
                {
                        require_once './Services/WorkflowEngine/exceptions/ilWorkflowObjectStateException.php';
                        throw new ilWorkflowObjectStateException('Log level must be one of: message, warning, debug, info, fatal.', 1002);
                }
                $this->log_level = strtoupper($a_log_level);
        }

        private function determineValidityOfLogLevel( $a_log_level )
        {
                switch ( strtolower( $a_log_level ) )
                {
                        case 'trace':
                        case 'message':
                        case 'warning':
                        case 'debug':
                        case 'info':
                        case 'fatal':
                                $valid = true;
                                break;
                        default:
                                $valid = false;
                                return $valid;
                }
                return $valid;
        }

        public function getLogLevel()
        {
                return $this->log_level;
        }

        public function getContext()
        {
                return $this->context;
        }

        public function execute()
        {
                $file_pointer = null;
                $file_pointer = $this->acquireFilePointer();
                $this->writeLogMessage( $file_pointer );
                $this->closeFilePointer( $file_pointer );
        }

        private function closeFilePointer( $file_pointer )
        {
                if ( !fclose( $file_pointer ) )
                {
                        require_once './Services/WorkflowEngine/exceptions/ilWorkflowFilesystemException.php';
                        throw new ilWorkflowFilesystemException( 'Cannot write to filesystem - pointer returned did not close.', 1001 );
                }
        }

        private function writeLogMessage( $file_pointer )
        {
                require_once './Services/WorkflowEngine/classes/utils/class.ilWorkflowUtils.php';
                fwrite( $file_pointer, date( 'Y/m/d H:i:s' ).substr( (string)ilWorkflowUtils::microtime(), 1, 6 ).' :: ' );
                fwrite( $file_pointer, $this->log_level.' :: ' );
                fwrite( $file_pointer, $this->log_message."\r\n" );
        }

        private function acquireFilePointer()
        {
                $file_pointer = fopen( $this->log_file, 'a' );
                if ( $file_pointer == null )
                {
                        require_once './Services/WorkflowEngine/exceptions/ilWorkflowFilesystemException.php';
                        throw new ilWorkflowFilesystemException( 'Cannot write to filesystem - no pointer returned.', 1000 );
                }
                return $file_pointer;
        }

        public function setName($name)
        {
                $this->name = $name;
        }

        public function getName()
        {
                return $this->name;
        }
}