LogManager.php

Go to the documentation of this file.

<?php
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Log;
 
use Psr\Log\InvalidArgumentException;
use Psr\Log\LoggerInterface;
use ‪TYPO3\CMS\Core\Log\Exception\InvalidLogProcessorConfigurationException;
use ‪TYPO3\CMS\Core\Log\Exception\InvalidLogWriterConfigurationException;
use ‪TYPO3\CMS\Core\Log\Processor\ProcessorInterface;
use ‪TYPO3\CMS\Core\Log\Writer\WriterInterface;
use ‪TYPO3\CMS\Core\SingletonInterface;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪LogManager implements ‪SingletonInterface, ‪LogManagerInterface
{
    public const ‪CONFIGURATION_TYPE_WRITER = 'writer';
 
    public const ‪CONFIGURATION_TYPE_PROCESSOR = 'processor';
 
    protected array ‪$loggers = [];
 
    protected ‪Logger ‪$rootLogger;
 
    protected string ‪$requestId = '';
 
    public function ‪__construct(string ‪$requestId = '')
    {
        $this->requestId = ‪$requestId;
        $this->rootLogger = GeneralUtility::makeInstance(Logger::class, '', ‪$requestId);
        $this->loggers[''] = ‪$this->rootLogger;
    }
 
    public function ‪reset()
    {
        $this->loggers = [];
    }
 
    public function ‪getLogger(string $name = ''): LoggerInterface
    {
        // Transform namespaces and underscore class names to the dot-name style
        $separators = ['_', '\\'];
        $name = str_replace($separators, '.', $name);
 
        return $this->loggers[$name] ??= $this->‪makeLogger($name, $this->requestId);
    }
 
    protected function ‪makeLogger(string $name, string ‪$requestId): ‪Logger
    {
        $logger = GeneralUtility::makeInstance(Logger::class, $name, ‪$requestId);
        $this->‪setWritersForLogger($logger);
        $this->‪setProcessorsForLogger($logger);
        return $logger;
    }
 
    public function ‪registerLogger($name)
    {
        $this->loggers[$name] = null;
    }
 
    public function ‪getLoggerNames()
    {
        return array_keys($this->loggers);
    }
 
    protected function ‪setWritersForLogger(‪Logger $logger)
    {
        $configuration = $this->‪getConfigurationForLogger(self::CONFIGURATION_TYPE_WRITER, $logger->‪getName());
        foreach ($configuration as $severityLevel => $writer) {
            $writer = array_filter($writer, static fn(array $options): bool => !($options['disabled'] ?? false));
            foreach ($writer as $logWriterClassName => $logWriterOptions) {
                try {
                    unset($logWriterOptions['disabled']);
                    $logWriter = GeneralUtility::makeInstance($logWriterClassName, $logWriterOptions);
                    $logger->‪addWriter($severityLevel, $logWriter);
                } catch (InvalidArgumentException|‪InvalidLogWriterConfigurationException $e) {
                    $logger->warning('Instantiation of LogWriter "{class_name}" failed for logger {name}', [
                        'class_name' => $logWriterClassName,
                        'name' => $logger->‪getName(),
                        'exception' => $e,
                    ]);
                }
            }
        }
    }
 
    protected function ‪setProcessorsForLogger(‪Logger $logger)
    {
        $configuration = $this->‪getConfigurationForLogger(self::CONFIGURATION_TYPE_PROCESSOR, $logger->‪getName());
        foreach ($configuration as $severityLevel => $processor) {
            foreach ($processor as $logProcessorClassName => $logProcessorOptions) {
                try {
                    $logProcessor = GeneralUtility::makeInstance($logProcessorClassName, $logProcessorOptions);
                    $logger->‪addProcessor($severityLevel, $logProcessor);
                } catch (InvalidArgumentException|‪InvalidLogProcessorConfigurationException $e) {
                    $logger->warning('Instantiation of LogProcessor "{class_name}" failed for logger {name}', [
                        'class_name' => $logProcessorClassName,
                        'name' => $logger->‪getName(),
                        'exception' => $e,
                    ]);
                }
            }
        }
    }
 
    protected function ‪getConfigurationForLogger($configurationType, $loggerName)
    {
        // Split up the logger name (dot-separated) into its parts
        $explodedName = explode('.', $loggerName);
        // Search in the $TYPO3_CONF_VARS['LOG'] array
        // for these keys, for example "writerConfiguration"
        $configurationKey = $configurationType . 'Configuration';
        $configuration = ‪$GLOBALS['TYPO3_CONF_VARS']['LOG'] ?? [];
        $result = $configuration[$configurationKey] ?? [];
        // Walk from general to special (t3lib, t3lib.db, t3lib.db.foo)
        // and search for the most specific configuration
        foreach ($explodedName as $partOfClassName) {
            if (!isset($configuration[$partOfClassName])) {
                break;
            }
            if (!empty($configuration[$partOfClassName][$configurationKey])) {
                $result = $configuration[$partOfClassName][$configurationKey];
            }
            $configuration = $configuration[$partOfClassName];
        }
        // Validate the config
        foreach ($result as $level => $unused) {
            try {
                ‪LogLevel::validateLevel(‪LogLevel::normalizeLevel($level));
            } catch (InvalidArgumentException $e) {
                throw new InvalidArgumentException('The given severity level "' . htmlspecialchars($level) . '" for ' . $configurationKey . ' of logger "' . $loggerName . '" is not valid.', 1326406447);
            }
        }
        return $result;
    }
}