162 lines
5.8 KiB
PHP
162 lines
5.8 KiB
PHP
|
<?php
|
||
|
|
||
|
/*
|
||
|
* This file is part of the Symfony package.
|
||
|
*
|
||
|
* (c) Fabien Potencier <fabien@symfony.com>
|
||
|
*
|
||
|
* For the full copyright and license information, please view the LICENSE
|
||
|
* file that was distributed with this source code.
|
||
|
*/
|
||
|
|
||
|
namespace Symfony\Bundle\MonologBundle\DependencyInjection\Compiler;
|
||
|
|
||
|
use Psr\Log\LoggerInterface;
|
||
|
use Symfony\Component\DependencyInjection\Argument\BoundArgument;
|
||
|
use Symfony\Component\DependencyInjection\ChildDefinition;
|
||
|
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
|
||
|
use Symfony\Component\DependencyInjection\ContainerBuilder;
|
||
|
use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
|
||
|
use Symfony\Component\DependencyInjection\Reference;
|
||
|
|
||
|
/**
|
||
|
* Replaces the default logger by another one with its own channel for tagged services.
|
||
|
*
|
||
|
* @author Christophe Coevoet <stof@notk.org>
|
||
|
*
|
||
|
* @internalsince 3.9.0
|
||
|
*/
|
||
|
class LoggerChannelPass implements CompilerPassInterface
|
||
|
{
|
||
|
protected $channels = ['app'];
|
||
|
|
||
|
/**
|
||
|
* {@inheritDoc}
|
||
|
*/
|
||
|
public function process(ContainerBuilder $container)
|
||
|
{
|
||
|
if (!$container->hasDefinition('monolog.logger')) {
|
||
|
return;
|
||
|
}
|
||
|
|
||
|
// create channels necessary for the handlers
|
||
|
foreach ($container->findTaggedServiceIds('monolog.logger') as $id => $tags) {
|
||
|
foreach ($tags as $tag) {
|
||
|
if (empty($tag['channel']) || 'app' === $tag['channel']) {
|
||
|
continue;
|
||
|
}
|
||
|
|
||
|
$resolvedChannel = $container->getParameterBag()->resolveValue($tag['channel']);
|
||
|
|
||
|
$definition = $container->getDefinition($id);
|
||
|
$loggerId = sprintf('monolog.logger.%s', $resolvedChannel);
|
||
|
$this->createLogger($resolvedChannel, $loggerId, $container);
|
||
|
|
||
|
foreach ($definition->getArguments() as $index => $argument) {
|
||
|
if ($argument instanceof Reference && 'logger' === (string) $argument) {
|
||
|
$definition->replaceArgument($index, $this->changeReference($argument, $loggerId));
|
||
|
}
|
||
|
}
|
||
|
|
||
|
$calls = $definition->getMethodCalls();
|
||
|
foreach ($calls as $i => $call) {
|
||
|
foreach ($call[1] as $index => $argument) {
|
||
|
if ($argument instanceof Reference && 'logger' === (string) $argument) {
|
||
|
$calls[$i][1][$index] = $this->changeReference($argument, $loggerId);
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
$definition->setMethodCalls($calls);
|
||
|
|
||
|
$binding = new BoundArgument(new Reference($loggerId));
|
||
|
|
||
|
// Mark the binding as used already, to avoid reporting it as unused if the service does not use a
|
||
|
// logger injected through the LoggerInterface alias.
|
||
|
$values = $binding->getValues();
|
||
|
$values[2] = true;
|
||
|
$binding->setValues($values);
|
||
|
|
||
|
$bindings = $definition->getBindings();
|
||
|
$bindings['Psr\Log\LoggerInterface'] = $binding;
|
||
|
$definition->setBindings($bindings);
|
||
|
}
|
||
|
}
|
||
|
|
||
|
// create additional channels
|
||
|
foreach ($container->getParameter('monolog.additional_channels') as $chan) {
|
||
|
if ($chan === 'app') {
|
||
|
continue;
|
||
|
}
|
||
|
$loggerId = sprintf('monolog.logger.%s', $chan);
|
||
|
$this->createLogger($chan, $loggerId, $container);
|
||
|
$container->getDefinition($loggerId)->setPublic(true);
|
||
|
}
|
||
|
$container->getParameterBag()->remove('monolog.additional_channels');
|
||
|
|
||
|
// wire handlers to channels
|
||
|
$handlersToChannels = $container->getParameter('monolog.handlers_to_channels');
|
||
|
foreach ($handlersToChannels as $handler => $channels) {
|
||
|
foreach ($this->processChannels($channels) as $channel) {
|
||
|
try {
|
||
|
$logger = $container->getDefinition($channel === 'app' ? 'monolog.logger' : 'monolog.logger.'.$channel);
|
||
|
} catch (InvalidArgumentException $e) {
|
||
|
$msg = 'Monolog configuration error: The logging channel "'.$channel.'" assigned to the "'.substr($handler, 16).'" handler does not exist.';
|
||
|
throw new \InvalidArgumentException($msg, 0, $e);
|
||
|
}
|
||
|
$logger->addMethodCall('pushHandler', [new Reference($handler)]);
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* @return array
|
||
|
*/
|
||
|
public function getChannels()
|
||
|
{
|
||
|
return $this->channels;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* @return array
|
||
|
*/
|
||
|
protected function processChannels(?array $configuration)
|
||
|
{
|
||
|
if (null === $configuration) {
|
||
|
return $this->channels;
|
||
|
}
|
||
|
|
||
|
if ('inclusive' === $configuration['type']) {
|
||
|
return $configuration['elements'] ?: $this->channels;
|
||
|
}
|
||
|
|
||
|
return array_diff($this->channels, $configuration['elements']);
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Create new logger from the monolog.logger_prototype
|
||
|
*
|
||
|
* @return void
|
||
|
*/
|
||
|
protected function createLogger(string $channel, string $loggerId, ContainerBuilder $container)
|
||
|
{
|
||
|
if (!in_array($channel, $this->channels)) {
|
||
|
$logger = new ChildDefinition('monolog.logger_prototype');
|
||
|
$logger->replaceArgument(0, $channel);
|
||
|
$container->setDefinition($loggerId, $logger);
|
||
|
$this->channels[] = $channel;
|
||
|
}
|
||
|
|
||
|
$parameterName = $channel . 'Logger';
|
||
|
|
||
|
$container->registerAliasForArgument($loggerId, LoggerInterface::class, $parameterName);
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Creates a copy of a reference and alters the service ID.
|
||
|
*/
|
||
|
private function changeReference(Reference $reference, string $serviceId): Reference
|
||
|
{
|
||
|
return new Reference($serviceId, $reference->getInvalidBehavior());
|
||
|
}
|
||
|
}
|