Logging factory. More...

Collaboration diagram for ilLoggerFactory:

Public Member Functions
	initUser ($a_login)
	Init user specific log options. More...

	getSettings ()
	Get settigns. More...

	getComponentLogger ($a_component_id)
	Get component logger. More...

Static Public Member Functions
static	getInstance ()

static	newInstance (ilLoggingSettings $settings)
	get new instance More...

static	getLogger ($a_component_id)
	Get component logger. More...

static	getRootLogger ()
	The unique root logger has a fixed error level. More...

Data Fields
const	DEFAULT_FORMAT = "[%suid%] [%datetime%] %channel%.%level_name%: %message% %context% %extra%\n"

const	ROOT_LOGGER = 'root'

const	COMPONENT_ROOT = 'log_root'

const	SETUP_LOGGER = 'setup'

Protected Member Functions
	__construct (ilLoggingSettings $settings)

	isConsoleAvailable ()
	Check if console handler is available. More...

	getLoggers ()

Private Attributes
	$settings = null

	$enabled = false

	$loggers = array()

Static Private Attributes
static	$instance = null

Detailed Description

Logging factory.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 21 of file class.ilLoggerFactory.php.

Constructor & Destructor Documentation

◆ __construct()

ilLoggerFactory::__construct ( ilLoggingSettings $settings )

protected

Definition at line 36 of file class.ilLoggerFactory.php.

    {
        $this->settings = $settings;
        $this->enabled = $this->getSettings()->isEnabled();
    }

References $settings, getSettings(), and settings().

Here is the call graph for this function:

Member Function Documentation

◆ getComponentLogger()

ilLoggerFactory::getComponentLogger ( $a_component_id )

Get component logger.

Parameters

type $a_component_id

Returns: \Logger

Definition at line 167 of file class.ilLoggerFactory.php.

    {
        if (isset($this->loggers[$a_component_id])) {
            return $this->loggers[$a_component_id];
        }
 
        $loggerNamePrefix = '';
        if (defined('CLIENT_ID')) {
            $loggerNamePrefix = CLIENT_ID . '_';
        }
 
        switch ($a_component_id) {
            case 'root':
                $logger = new Logger($loggerNamePrefix . 'root');
                break;
                
            default:
                $logger = new Logger($loggerNamePrefix . $a_component_id);
                break;
                
        }
        
        if (!$this->getSettings()->isEnabled()) {
            $null_handler = new NullHandler();
            $logger->pushHandler($null_handler);
            
            include_once './Services/Logging/classes/class.ilComponentLogger.php';
            return $this->loggers[$a_component_id] = new ilComponentLogger($logger);
        }
        
        
        // standard stream handler
        $stream_handler = new StreamHandler(
            $this->getSettings()->getLogDir() . '/' . $this->getSettings()->getLogFile(),
            true
        );
        
        if ($a_component_id == self::ROOT_LOGGER) {
            $stream_handler->setLevel($this->getSettings()->getLevelByComponent(self::COMPONENT_ROOT));
        } else {
            $stream_handler->setLevel($this->getSettings()->getLevelByComponent($a_component_id));
        }
        
        // format lines
        include_once("./Services/Logging/classes/extensions/class.ilLineFormatter.php");
        $line_formatter = new ilLineFormatter(static::DEFAULT_FORMAT, 'Y-m-d H:i:s.u', true, true);
        $stream_handler->setFormatter($line_formatter);
        
        if ($this->getSettings()->isCacheEnabled()) {
            // add new finger crossed handler
            $finger_crossed_handler = new FingersCrossedHandler(
                $stream_handler,
                new ErrorLevelActivationStrategy($this->getSettings()->getCacheLevel()),
                1000
            );
            $logger->pushHandler($finger_crossed_handler);
        } else {
            $logger->pushHandler($stream_handler);
        }
 
        if (
            $GLOBALS['DIC']->offsetExists('ilUser') &&
            $GLOBALS['DIC']['ilUser'] instanceof ilObjUser
        ) {
            if ($this->getSettings()->isBrowserLogEnabledForUser($GLOBALS['DIC']->user()->getLogin())) {
                if ($this->isConsoleAvailable()) {
                    $browser_handler = new BrowserConsoleHandler();
                    #$browser_handler->setLevel($this->getSettings()->getLevelByComponent($a_component_id));
                    $browser_handler->setLevel($this->getSettings()->getLevel());
                    $browser_handler->setFormatter($line_formatter);
                    $logger->pushHandler($browser_handler);
                }
            }
        }
        
 
        // suid log
        $logger->pushProcessor(function ($record) {
            $record['suid'] = substr(session_id(), 0, 5);
            return $record;
        });
 
        // append trace
        include_once './Services/Logging/classes/extensions/class.ilTraceProcessor.php';
        $logger->pushProcessor(new ilTraceProcessor(ilLogLevel::DEBUG));
        
                
        // register new logger
        include_once './Services/Logging/classes/class.ilComponentLogger.php';
        $this->loggers[$a_component_id] = new ilComponentLogger($logger);
        
        return $this->loggers[$a_component_id];
    }

References $GLOBALS, CLIENT_ID, ilLogLevel\DEBUG, getSettings(), isConsoleAvailable(), and user().

Here is the call graph for this function:

◆ getInstance()

static ilLoggerFactory::getInstance ( )

static

Returns: ilLoggerFactory

Definition at line 46 of file class.ilLoggerFactory.php.

    {
        if (!static::$instance) {
            include_once './Services/Logging/classes/class.ilLoggingDBSettings.php';
            $settings = ilLoggingDBSettings::getInstance();
            static::$instance = new ilLoggerFactory($settings);
        }
        return static::$instance;
    }

References $settings, and ilLoggingDBSettings\getInstance().

Referenced by ilCourseAppEventListener\__construct(), ilGroupAppEventListener\__construct(), ilOpenIdConnectAppEventListener\__construct(), ilRbacAdmin\assignUser(), ilRbacAdmin\deassignUser(), getLogger(), getRootLogger(), ilCourseAppEventListener\handleUserAssignments(), ilGroupAppEventListener\handleUserAssignments(), ilInitialisation\initILIAS(), and ilInitialisation\initUserAccount().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLogger()

static ilLoggerFactory::getLogger ( $a_component_id )

static

Get component logger.

See also: mudules.xml or service.xml

Parameters

string $a_component_id

Returns: ilLogger

Definition at line 74 of file class.ilLoggerFactory.php.

    {
        $factory = self::getInstance();
        return $factory->getComponentLogger($a_component_id);
    }

References $factory, and getInstance().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLoggers()

ilLoggerFactory::getLoggers ( )

protected

Returns: ilComponentLogger[]

Definition at line 157 of file class.ilLoggerFactory.php.

    {
        return $this->loggers;
    }

References $loggers.

◆ getRootLogger()

static ilLoggerFactory::getRootLogger ( )

static

The unique root logger has a fixed error level.

Returns: ilLogger

Definition at line 84 of file class.ilLoggerFactory.php.

    {
        $factory = self::getInstance();
        return $factory->getComponentLogger(self::ROOT_LOGGER);
    }

References $factory, and getInstance().

Referenced by ilAssFileUploadUploadsExporter\createFileUploadCollectionZipFile(), ilInitialisation\initLog(), and assFlashQuestion\saveAdditionalQuestionDataToDb().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSettings()

ilLoggerFactory::getSettings ( )

Get settigns.

Returns: ilLoggingSettings

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

    {
        return $this->settings;
    }

References $settings.

Referenced by __construct(), getComponentLogger(), and initUser().

Here is the caller graph for this function:

◆ initUser()

ilLoggerFactory::initUser ( $a_login )

Init user specific log options.

Parameters

type $a_login

Returns: boolean

Definition at line 96 of file class.ilLoggerFactory.php.

    {
        if (!$this->getSettings()->isBrowserLogEnabledForUser($a_login)) {
            return true;
        }
 
        include_once("./Services/Logging/classes/extensions/class.ilLineFormatter.php");
 
        foreach ($this->loggers as $a_component_id => $logger) {
            if ($this->isConsoleAvailable()) {
                $browser_handler = new BrowserConsoleHandler();
                $browser_handler->setLevel($this->getSettings()->getLevelByComponent($a_component_id));
                $browser_handler->setFormatter(new ilLineFormatter(static::DEFAULT_FORMAT, 'Y-m-d H:i:s.u', true, true));
                $logger->getLogger()->pushHandler($browser_handler);
            }
        }
    }

References getSettings(), and isConsoleAvailable().

Here is the call graph for this function:

◆ isConsoleAvailable()

ilLoggerFactory::isConsoleAvailable ( )

protected

Check if console handler is available.

Returns: bool

Definition at line 118 of file class.ilLoggerFactory.php.

                                            : bool
    {
        if (ilContext::getType() != ilContext::CONTEXT_WEB) {
            return false;
        }
 
        if (isset($_SERVER['HTTP_ACCEPT']) && strpos($_SERVER['HTTP_ACCEPT'], 'text/html') !== false) {
            // If the client expects HTML, allow console logging
            return true;
        }
 
        if (isset($_SERVER['HTTP_ACCEPT']) && strpos($_SERVER['HTTP_ACCEPT'], 'application/json') !== false) {
            // If the client expects JSON, don't use console logging: https://mantis.ilias.de/view.php?id=37167
            return false;
        }
 
        if ((isset($_GET['cmdMode']) && $_GET['cmdMode'] === 'asynch') || (
            isset($GLOBALS['DIC']['http']) &&
            strtolower($GLOBALS['DIC']->http()->request()->getServerParams()['HTTP_X_REQUESTED_WITH'] ?? '') === 'xmlhttprequest'
        )) {
            return false;
        }
 
        return true;
    }

References $_GET, $_SERVER, $GLOBALS, ilContext\CONTEXT_WEB, ilContext\getType(), and ILIAS\FileDelivery\http().

Referenced by getComponentLogger(), and initUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ newInstance()

static ilLoggerFactory::newInstance ( ilLoggingSettings $settings )

static

get new instance

Parameters

ilLoggingSettings $settings

Returns: \self

Definition at line 61 of file class.ilLoggerFactory.php.

    {
        return static::$instance = new self($settings);
    }

References $settings.

Field Documentation

◆ $enabled

ilLoggerFactory::$enabled = false

private

Definition at line 33 of file class.ilLoggerFactory.php.

◆ $instance

ilLoggerFactory::$instance = null

staticprivate

Definition at line 29 of file class.ilLoggerFactory.php.

◆ $loggers

ilLoggerFactory::$loggers = array()

private

Definition at line 34 of file class.ilLoggerFactory.php.

Referenced by getLoggers().

◆ $settings

ilLoggerFactory::$settings = null

private

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

Referenced by __construct(), getInstance(), getSettings(), and newInstance().

◆ COMPONENT_ROOT

const ilLoggerFactory::COMPONENT_ROOT = 'log_root'

Definition at line 26 of file class.ilLoggerFactory.php.

◆ DEFAULT_FORMAT

const ilLoggerFactory::DEFAULT_FORMAT = "[%suid%] [%datetime%] %channel%.%level_name%: %message% %context% %extra%\n"

Definition at line 23 of file class.ilLoggerFactory.php.

◆ ROOT_LOGGER

const ilLoggerFactory::ROOT_LOGGER = 'root'

Definition at line 25 of file class.ilLoggerFactory.php.

◆ SETUP_LOGGER

const ilLoggerFactory::SETUP_LOGGER = 'setup'

Definition at line 27 of file class.ilLoggerFactory.php.

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

Services/Logging/classes/public/class.ilLoggerFactory.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getComponentLogger()

◆ getInstance()

◆ getLogger()

◆ getLoggers()

◆ getRootLogger()

◆ getSettings()

◆ initUser()

◆ isConsoleAvailable()

◆ newInstance()

Field Documentation

◆ $enabled

◆ $instance

◆ $loggers

◆ $settings

◆ COMPONENT_ROOT

◆ DEFAULT_FORMAT

◆ ROOT_LOGGER

◆ SETUP_LOGGER