MonologSpi.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Logger;
 
use DateTimeZone;
use MediaWiki\Logger\Monolog\BufferHandler;
use Monolog\Formatter\FormatterInterface;
use Monolog\Handler\FormattableHandlerInterface;
use Monolog\Handler\HandlerInterface;
use Monolog\Handler\PsrHandler;
use Monolog\Handler\StreamHandler;
use Monolog\Logger;
use Psr\Log\LoggerInterface;
use Wikimedia\ObjectFactory\ObjectFactory;
 
class MonologSpi implements Spi {
 
    protected $singletons;
 
    protected array $config = [];
 
    public function __construct( array $config ) {
        $this->mergeConfig( $config );
    }
 
    public function mergeConfig( array $config ) {
        foreach ( $config as $key => $value ) {
            if ( isset( $this->config[$key] ) ) {
                $this->config[$key] = array_merge( $this->config[$key], $value );
            } else {
                $this->config[$key] = $value;
            }
        }
        if ( !isset( $this->config['loggers']['@default'] ) ) {
            $this->config['loggers']['@default'] = [
                'handlers' => [ '@default' ],
            ];
            $this->config['handlers']['@default'] ??= [
                'class' => StreamHandler::class,
                'args' => [ 'php://stderr', Logger::ERROR ],
            ];
        }
        $this->reset();
    }
 
    public function reset() {
        $this->singletons = [
            'loggers'    => [],
            'handlers'   => [],
            'formatters' => [],
            'processors' => [],
        ];
    }
 
    public function getLogger( $channel ) {
        if ( !isset( $this->singletons['loggers'][$channel] ) ) {
            // Fallback to using the '@default' configuration if an explicit
            // configuration for the requested channel isn't found.
            $spec = $this->config['loggers'][$channel] ?? $this->config['loggers']['@default'];
 
            $monolog = $this->createLogger( $channel, $spec );
            $this->singletons['loggers'][$channel] = $monolog;
        }
 
        return $this->singletons['loggers'][$channel];
    }
 
    protected function createLogger( $channel, $spec ): LoggerInterface {
        global $wgShowDebug, $wgDebugToolbar;
 
        $handlers = [];
        if ( isset( $spec['handlers'] ) && $spec['handlers'] ) {
            foreach ( $spec['handlers'] as $handler ) {
                $handlers[] = $this->getHandler( $handler );
            }
        }
 
        $processors = [];
        if ( isset( $spec['processors'] ) ) {
            foreach ( $spec['processors'] as $processor ) {
                $processors[] = $this->getProcessor( $processor );
            }
        }
 
        // Use UTC for logs instead of Monolog's default, which asks the
        // PHP runtime, which MediaWiki sets to $wgLocaltimezone (T99581)
        $obj = new Logger( $channel, $handlers, $processors, new DateTimeZone( 'UTC' ) );
 
        if ( $wgShowDebug || $wgDebugToolbar ) {
            $legacyLogger = new LegacyLogger( $channel );
            $legacyPsrHandler = new PsrHandler( $legacyLogger );
            $obj->pushHandler( $legacyPsrHandler );
        }
 
        if ( isset( $spec['calls'] ) ) {
            foreach ( $spec['calls'] as $method => $margs ) {
                $obj->$method( ...$margs );
            }
        }
 
        return $obj;
    }
 
    public function getProcessor( $name ) {
        if ( !isset( $this->singletons['processors'][$name] ) ) {
            $spec = $this->config['processors'][$name];
            $processor = ObjectFactory::getObjectFromSpec( $spec );
            $this->singletons['processors'][$name] = $processor;
        }
        return $this->singletons['processors'][$name];
    }
 
    public function getHandler( $name ) {
        if ( !isset( $this->singletons['handlers'][$name] ) ) {
            $spec = $this->config['handlers'][$name];
            $handler = ObjectFactory::getObjectFromSpec( $spec );
            if (
                isset( $spec['formatter'] ) &&
                $handler instanceof FormattableHandlerInterface
            ) {
                $handler->setFormatter(
                    $this->getFormatter( $spec['formatter'] )
                );
            }
            if ( isset( $spec['buffer'] ) && $spec['buffer'] ) {
                $handler = new BufferHandler( $handler );
            }
            $this->singletons['handlers'][$name] = $handler;
        }
        return $this->singletons['handlers'][$name];
    }
 
    public function getFormatter( $name ) {
        if ( !isset( $this->singletons['formatters'][$name] ) ) {
            $spec = $this->config['formatters'][$name];
            $formatter = ObjectFactory::getObjectFromSpec( $spec );
            $this->singletons['formatters'][$name] = $formatter;
        }
        return $this->singletons['formatters'][$name];
    }
}