MonologSpi.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Logger;
 
use MediaWiki\Logger\Monolog\BufferHandler;
use Monolog\Handler\NullHandler;
use Monolog\Handler\StreamHandler;
use Monolog\Logger;
use Wikimedia\ObjectFactory;
 
class MonologSpi implements Spi {
 
    protected $singletons;
 
    protected $config;
 
    public function __construct( array $config ) {
        $this->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' ],
            ];
            if ( !isset( $this->config['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 explict
            // 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 ) {
        $obj = new Logger( $channel );
 
        if ( isset( $spec['calls'] ) ) {
            foreach ( $spec['calls'] as $method => $margs ) {
                $obj->$method( ...$margs );
            }
        }
 
        if ( isset( $spec['processors'] ) ) {
            foreach ( $spec['processors'] as $processor ) {
                $obj->pushProcessor( $this->getProcessor( $processor ) );
            }
        }
 
        if ( isset( $spec['handlers'] ) && $spec['handlers'] ) {
            foreach ( $spec['handlers'] as $handler ) {
                $obj->pushHandler( $this->getHandler( $handler ) );
            }
        } else {
            // When no handlers are registered Monolog 1.x sends logs to stderr,
            // which could be not expected: avoid this behaviour
            $obj->pushHandler( new NullHandler() );
        }
        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'] ) &&
                is_subclass_of( $handler, 'Monolog\Handler\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];
    }
}