Logger.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\LoggerInterface;
use Psr\Log\LoggerTrait;
use ‪TYPO3\CMS\Core\Log\Processor\ProcessorInterface;
use ‪TYPO3\CMS\Core\Log\Writer\WriterInterface;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪Logger implements LoggerInterface
{
    use LoggerTrait;
 
    protected string ‪$name = '';
 
    protected string ‪$requestId = '';
 
    protected int ‪$minimumLogLevel;
 
    protected array ‪$writers = [];
 
    protected array ‪$processors = [];
 
    public function ‪__construct(string ‪$name, string ‪$requestId = '')
    {
        $this->name = ‪$name;
        $this->requestId = ‪$requestId;
        $this->minimumLogLevel = ‪LogLevel::normalizeLevel(LogLevel::EMERGENCY);
    }
 
    public function ‪__wakeup()
    {
        $newLogger = GeneralUtility::makeInstance(LogManager::class)->getLogger($this->name);
        $this->requestId = $newLogger->requestId;
        $this->minimumLogLevel = $newLogger->minimumLogLevel;
        $this->writers = $newLogger->writers;
        $this->processors = $newLogger->processors;
    }
 
    public function ‪__sleep(): array
    {
        return ['name'];
    }
 
    protected function ‪setMinimumLogLevel($level)
    {
        ‪LogLevel::validateLevel($level);
        $this->minimumLogLevel = $level;
        return $this;
    }
 
    protected function ‪getMinimumLogLevel()
    {
        return ‪$this->minimumLogLevel;
    }
 
    public function ‪getName()
    {
        return ‪$this->name;
    }
 
    public function ‪addWriter(string $minimumLevel, ‪WriterInterface $writer)
    {
        $minLevelAsNumber = ‪LogLevel::normalizeLevel($minimumLevel);
        // Cycle through all the log levels which are as severe as or higher
        // than $minimumLevel and add $writer to each severity level
        foreach (‪LogLevel::atLeast($minLevelAsNumber) as $levelName) {
            $this->writers[$levelName] ??= [];
            $this->writers[$levelName][] = $writer;
        }
        if ($minLevelAsNumber > $this->‪getMinimumLogLevel()) {
            $this->‪setMinimumLogLevel($minLevelAsNumber);
        }
        return $this;
    }
 
    public function ‪getWriters()
    {
        return ‪$this->writers;
    }
 
    public function ‪addProcessor(string $minimumLevel, ‪ProcessorInterface $processor)
    {
        $minLevelAsNumber = ‪LogLevel::normalizeLevel($minimumLevel);
        ‪LogLevel::validateLevel($minLevelAsNumber);
        // Cycle through all the log levels which are as severe as or higher
        // than $minimumLevel and add $processor to each severity level
        for ($logLevelWhichTriggersProcessor = ‪LogLevel::normalizeLevel(\Psr\Log\LogLevel::EMERGENCY); $logLevelWhichTriggersProcessor <= $minLevelAsNumber; $logLevelWhichTriggersProcessor++) {
            $logLevelName = ‪LogLevel::getInternalName($logLevelWhichTriggersProcessor);
            $this->processors[$logLevelName] ??= [];
            $this->processors[$logLevelName][] = $processor;
        }
        if ($minLevelAsNumber > $this->‪getMinimumLogLevel()) {
            $this->‪setMinimumLogLevel($minLevelAsNumber);
        }
    }
 
    public function ‪getProcessors()
    {
        return ‪$this->processors;
    }
 
    public function ‪log($level, string|\Stringable $message, array $data = []): void
    {
        $level = ‪LogLevel::normalizeLevel($level);
        ‪LogLevel::validateLevel($level);
        if ($level > $this->minimumLogLevel) {
            return;
        }
        ‪$record = GeneralUtility::makeInstance(LogRecord::class, $this->name, ‪LogLevel::getInternalName($level), $message, $data, $this->requestId);
        ‪$record = $this->‪callProcessors(‪$record);
        $this->‪writeLog(‪$record);
    }
 
    protected function ‪callProcessors(‪LogRecord ‪$record)
    {
        foreach ($this->processors[‪$record->getLevel()] ?? [] as $processor) {
            $processedRecord = $processor->processLogRecord(‪$record);
            if (!$processedRecord instanceof ‪LogRecord) {
                throw new \RuntimeException('Processor ' . get_class($processor) . ' returned invalid data. Instance of TYPO3\\CMS\\Core\\Log\\LogRecord expected', 1343593398);
            }
            ‪$record = $processedRecord;
        }
        return ‪$record;
    }
 
    protected function ‪writeLog(‪LogRecord ‪$record)
    {
        foreach ($this->writers[‪$record->getLevel()] ?? [] as $writer) {
            $writer->writeLog(‪$record);
        }
    }
}