class.ilLoggerFactory.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use Monolog\Logger;
use Monolog\Handler\StreamHandler;
use Monolog\Handler\BrowserConsoleHandler;
use Monolog\Formatter\LineFormatter;
use Monolog\Handler\FingersCrossedHandler;
use Monolog\Handler\NullHandler;
use Monolog\Handler\FingersCrossed\ErrorLevelActivationStrategy;
use ILIAS\DI\Container;
use Monolog\Processor\PsrLogMessageProcessor;

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

    protected const ROOT_LOGGER = 'root';
    protected const COMPONENT_ROOT = 'log_root';
    protected const SETUP_LOGGER = 'setup';

    private static ?ilLoggerFactory $instance = null;

    private ilLoggingSettings $settings;
    protected Container $dic;

    private bool $enabled = false; //ToDo PHP8 Review: This is a private var never read only written and should probably be removed.

    private array $loggers = array();

    protected function __construct(ilLoggingSettings $settings)
    {
        global $DIC;

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

    public static function getInstance(): ilLoggerFactory
    {
        if (!static::$instance instanceof ilLoggerFactory) {
            $settings = ilLoggingDBSettings::getInstance();
            static::$instance = new ilLoggerFactory($settings);
        }
        return static::$instance;
    }

    public static function newInstance(ilLoggingSettings $settings): ilLoggerFactory
    {
        return static::$instance = new self($settings);
    }

    public function isLoggingEnabled(): bool
    {
        return $this->enabled;
    }


    public static function getLogger(string $a_component_id): ilLogger
    {
        $factory = self::getInstance();
        return $factory->getComponentLogger($a_component_id);
    }

    public static function getRootLogger(): ilLogger
    {
        $factory = self::getInstance();
        return $factory->getComponentLogger(self::ROOT_LOGGER);
    }


    public function initUser(string $a_login): void
    {
        if (!$this->getSettings()->isBrowserLogEnabledForUser($a_login)) {
            return;
        }

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

    protected function isConsoleAvailable(): bool
    {
        if (ilContext::getType() != ilContext::CONTEXT_WEB) {
            return false;
        }
        if (
            $this->dic->isDependencyAvailable('ctrl') && $this->dic->ctrl()->isAsynch() ||
            (
                $this->dic->isDependencyAvailable('http') &&
                strtolower($this->dic->http()->request()->getServerParams()['HTTP_X_REQUESTED_WITH'] ?? '') === 'xmlhttprequest'
            )
        ) {
            return false;
        }

        if (
            $this->dic->isDependencyAvailable('http') &&
            strpos($this->dic->http()->request()->getServerParams()['HTTP_ACCEPT'], 'text/html') !== false
        ) {
            return true;
        }
        if (
            $this->dic->isDependencyAvailable('http') &&
            strpos($this->dic->http()->request()->getServerParams()['HTTP_ACCEPT'], 'application/json') !== false
        ) {
            return false;
        }
        return true;
    }

    public function getSettings(): ilLoggingSettings
    {
        return $this->settings;
    }

    protected function getLoggers(): array
    {
        return $this->loggers;
    }

    public function getComponentLogger(string $a_component_id): ilLogger
    {
        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->isLoggingEnabled()) {
            $null_handler = new NullHandler();
            $logger->pushHandler($null_handler);

            return $this->loggers[$a_component_id] = new ilComponentLogger($logger);
        }


        // standard stream handler
        $stream_handler = new StreamHandler(
            $this->getSettings()->getLogDir() . '/' . $this->getSettings()->getLogFile(),
            Logger::DEBUG, // default minimum level, will be overwritten by component log level
            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
        $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 (
            $this->dic->offsetExists('ilUser') &&
            $this->dic->user() instanceof ilObjUser
        ) {
            if ($this->getSettings()->isBrowserLogEnabledForUser($this->dic->user()->getLogin())) {
                if ($this->isConsoleAvailable()) {
                    $browser_handler = new BrowserConsoleHandler();
                    $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
        $logger->pushProcessor(new ilTraceProcessor(ilLogLevel::DEBUG));

        // Interpolate context variables.
        $logger->pushProcessor(new PsrLogMessageProcessor());

        // register new logger
        $this->loggers[$a_component_id] = new ilComponentLogger($logger);

        return $this->loggers[$a_component_id];
    }
}