vendor/symfony/monolog-bridge/Handler/ConsoleHandler.php line 165

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Bridge\Monolog\Handler;
  14. use Monolog\Formatter\FormatterInterface;
  15. use Monolog\Formatter\LineFormatter;
  16. use Monolog\Handler\AbstractProcessingHandler;
  17. use Monolog\Logger;
  18. use Monolog\LogRecord;
  19. use Symfony\Bridge\Monolog\Formatter\ConsoleFormatter;
  20. use Symfony\Component\Console\ConsoleEvents;
  21. use Symfony\Component\Console\Event\ConsoleCommandEvent;
  22. use Symfony\Component\Console\Event\ConsoleTerminateEvent;
  23. use Symfony\Component\Console\Output\ConsoleOutputInterface;
  24. use Symfony\Component\Console\Output\OutputInterface;
  25. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  26. use Symfony\Component\VarDumper\Dumper\CliDumper;
  28. if (Logger::API >= 3) {
  29.     /**
  30.      * The base class for compatibility between Monolog 3 LogRecord and Monolog 1/2 array records.
  31.      *
  32.      * @author Jordi Boggiano <j.boggiano@seld.be>
  33.      *
  34.      * @internal
  35.      */
  36.     trait CompatibilityIsHandlingHandler
  37.     {
  38.         abstract private function doIsHandling(array|LogRecord $record): bool;
  40.         public function isHandling(LogRecord $record): bool
  41.         {
  42.             return $this->doIsHandling($record);
  43.         }
  44.     }
  45. } else {
  46.     /**
  47.      * The base class for compatibility between Monolog 3 LogRecord and Monolog 1/2 array records.
  48.      *
  49.      * @author Jordi Boggiano <j.boggiano@seld.be>
  50.      *
  51.      * @internal
  52.      */
  53.     trait CompatibilityIsHandlingHandler
  54.     {
  55.         abstract private function doIsHandling(array|LogRecord $record): bool;
  57.         public function isHandling(array $record): bool
  58.         {
  59.             return $this->doIsHandling($record);
  60.         }
  61.     }
  62. }
  64. /**
  65.  * Writes logs to the console output depending on its verbosity setting.
  66.  *
  67.  * It is disabled by default and gets activated as soon as a command is executed.
  68.  * Instead of listening to the console events, the output can also be set manually.
  69.  *
  70.  * The minimum logging level at which this handler will be triggered depends on the
  71.  * verbosity setting of the console output. The default mapping is:
  72.  * - OutputInterface::VERBOSITY_NORMAL will show all WARNING and higher logs
  73.  * - OutputInterface::VERBOSITY_VERBOSE (-v) will show all NOTICE and higher logs
  74.  * - OutputInterface::VERBOSITY_VERY_VERBOSE (-vv) will show all INFO and higher logs
  75.  * - OutputInterface::VERBOSITY_DEBUG (-vvv) will show all DEBUG and higher logs, i.e. all logs
  76.  *
  77.  * This mapping can be customized with the $verbosityLevelMap constructor parameter.
  78.  *
  79.  * @author Tobias Schultze <http://tobion.de>
  80.  *
  81.  * @final since Symfony 6.1
  82.  */
  83. class ConsoleHandler extends AbstractProcessingHandler implements EventSubscriberInterface
  84. {
  85.     use CompatibilityHandler;
  86.     use CompatibilityIsHandlingHandler;
  87.     use CompatibilityProcessingHandler;
  89.     private ?OutputInterface $output;
  90.     private array $verbosityLevelMap = [
  91.         OutputInterface::VERBOSITY_QUIET => Logger::ERROR,
  92.         OutputInterface::VERBOSITY_NORMAL => Logger::WARNING,
  93.         OutputInterface::VERBOSITY_VERBOSE => Logger::NOTICE,
  94.         OutputInterface::VERBOSITY_VERY_VERBOSE => Logger::INFO,
  95.         OutputInterface::VERBOSITY_DEBUG => Logger::DEBUG,
  96.     ];
  97.     private array $consoleFormatterOptions;
  99.     /**
  100.      * @param OutputInterface|null $output            The console output to use (the handler remains disabled when passing null
  101.      *                                                until the output is set, e.g. by using console events)
  102.      * @param bool                 $bubble            Whether the messages that are handled can bubble up the stack
  103.      * @param array                $verbosityLevelMap Array that maps the OutputInterface verbosity to a minimum logging
  104.      *                                                level (leave empty to use the default mapping)
  105.      */
  106.     public function __construct(OutputInterface $output = null, bool $bubble = true, array $verbosityLevelMap = [], array $consoleFormatterOptions = [])
  107.     {
  108.         parent::__construct(Logger::DEBUG, $bubble);
  109.         $this->output = $output;
  111.         if ($verbosityLevelMap) {
  112.             $this->verbosityLevelMap = $verbosityLevelMap;
  113.         }
  115.         $this->consoleFormatterOptions = $consoleFormatterOptions;
  116.     }
  118.     private function doIsHandling(array|LogRecord $record): bool
  119.     {
  120.         return $this->updateLevel() && parent::isHandling($record);
  121.     }
  123.     private function doHandle(array|LogRecord $record): bool
  124.     {
  125.         // we have to update the logging level each time because the verbosity of the
  126.         // console output might have changed in the meantime (it is not immutable)
  127.         return $this->updateLevel() && parent::handle($record);
  128.     }
  130.     /**
  131.      * Sets the console output to use for printing logs.
  132.      */
  133.     public function setOutput(OutputInterface $output)
  134.     {
  135.         $this->output = $output;
  136.     }
  138.     /**
  139.      * Disables the output.
  140.      */
  141.     public function close(): void
  142.     {
  143.         $this->output = null;
  145.         parent::close();
  146.     }
  148.     /**
  149.      * Before a command is executed, the handler gets activated and the console output
  150.      * is set in order to know where to write the logs.
  151.      */
  152.     public function onCommand(ConsoleCommandEvent $event)
  153.     {
  154.         $output = $event->getOutput();
  155.         if ($output instanceof ConsoleOutputInterface) {
  156.             $output = $output->getErrorOutput();
  157.         }
  159.         $this->setOutput($output);
  160.     }
  162.     /**
  163.      * After a command has been executed, it disables the output.
  164.      */
  165.     public function onTerminate(ConsoleTerminateEvent $event)
  166.     {
  167.         $this->close();
  168.     }
  170.     public static function getSubscribedEvents(): array
  171.     {
  172.         return [
  173.             ConsoleEvents::COMMAND => ['onCommand', 255],
  174.             ConsoleEvents::TERMINATE => ['onTerminate', -255],
  175.         ];
  176.     }
  178.     private function doWrite(array|LogRecord $record): void
  179.     {
  180.         // at this point we've determined for sure that we want to output the record, so use the output's own verbosity
  181.         $this->output->write((string) $record['formatted'], false, $this->output->getVerbosity());
  182.     }
  184.     protected function getDefaultFormatter(): FormatterInterface
  185.     {
  186.         if (!class_exists(CliDumper::class)) {
  187.             return new LineFormatter();
  188.         }
  189.         if (!$this->output) {
  190.             return new ConsoleFormatter($this->consoleFormatterOptions);
  191.         }
  193.         return new ConsoleFormatter(array_replace([
  194.             'colors' => $this->output->isDecorated(),
  195.             'multiline' => OutputInterface::VERBOSITY_DEBUG <= $this->output->getVerbosity(),
  196.         ], $this->consoleFormatterOptions));
  197.     }
  199.     /**
  200.      * Updates the logging level based on the verbosity setting of the console output.
  201.      *
  202.      * @return bool Whether the handler is enabled and verbosity is not set to quiet
  203.      */
  204.     private function updateLevel(): bool
  205.     {
  206.         if (null === $this->output) {
  207.             return false;
  208.         }
  210.         $verbosity = $this->output->getVerbosity();
  211.         if (isset($this->verbosityLevelMap[$verbosity])) {
  212.             $this->setLevel($this->verbosityLevelMap[$verbosity]);
  213.         } else {
  214.             $this->setLevel(Logger::DEBUG);
  215.         }
  217.         return true;
  218.     }
  219. }