vendor/symfony/monolog-bridge/Formatter/ConsoleFormatter.php line 188

  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\Formatter;
  14. use Monolog\Formatter\FormatterInterface;
  15. use Monolog\Logger;
  16. use Monolog\LogRecord;
  17. use Symfony\Component\Console\Formatter\OutputFormatter;
  18. use Symfony\Component\VarDumper\Cloner\Data;
  19. use Symfony\Component\VarDumper\Cloner\Stub;
  20. use Symfony\Component\VarDumper\Cloner\VarCloner;
  21. use Symfony\Component\VarDumper\Dumper\CliDumper;
  23. /**
  24.  * Formats incoming records for console output by coloring them depending on log level.
  25.  *
  26.  * @author Tobias Schultze <http://tobion.de>
  27.  * @author Grégoire Pineau <lyrixx@lyrixx.info>
  28.  *
  29.  * @final since Symfony 6.1
  30.  */
  31. class ConsoleFormatter implements FormatterInterface
  32. {
  33.     use CompatibilityFormatter;
  35.     public const SIMPLE_FORMAT = "%datetime% %start_tag%%level_name%%end_tag% <comment>[%channel%]</> %message%%context%%extra%\n";
  36.     public const SIMPLE_DATE = 'H:i:s';
  38.     private const LEVEL_COLOR_MAP = [
  39.         Logger::DEBUG => 'fg=white',
  40.         Logger::INFO => 'fg=green',
  41.         Logger::NOTICE => 'fg=blue',
  42.         Logger::WARNING => 'fg=cyan',
  43.         Logger::ERROR => 'fg=yellow',
  44.         Logger::CRITICAL => 'fg=red',
  45.         Logger::ALERT => 'fg=red',
  46.         Logger::EMERGENCY => 'fg=white;bg=red',
  47.     ];
  49.     private array $options;
  50.     private VarCloner $cloner;
  52.     /**
  53.      * @var resource|null
  54.      */
  55.     private $outputBuffer;
  57.     private CliDumper $dumper;
  59.     /**
  60.      * Available options:
  61.      *   * format: The format of the outputted log string. The following placeholders are supported: %datetime%, %start_tag%, %level_name%, %end_tag%, %channel%, %message%, %context%, %extra%;
  62.      *   * date_format: The format of the outputted date string;
  63.      *   * colors: If true, the log string contains ANSI code to add color;
  64.      *   * multiline: If false, "context" and "extra" are dumped on one line.
  65.      */
  66.     public function __construct(array $options = [])
  67.     {
  68.         $this->options = array_replace([
  69.             'format' => self::SIMPLE_FORMAT,
  70.             'date_format' => self::SIMPLE_DATE,
  71.             'colors' => true,
  72.             'multiline' => false,
  73.             'level_name_format' => '%-9s',
  74.             'ignore_empty_context_and_extra' => true,
  75.         ], $options);
  77.         if (class_exists(VarCloner::class)) {
  78.             $this->cloner = new VarCloner();
  79.             $this->cloner->addCasters([
  80.                 '*' => $this->castObject(...),
  81.             ]);
  83.             $this->outputBuffer = fopen('php://memory', 'r+');
  84.             if ($this->options['multiline']) {
  85.                 $output = $this->outputBuffer;
  86.             } else {
  87.                 $output = $this->echoLine(...);
  88.             }
  90.             $this->dumper = new CliDumper($output, null, CliDumper::DUMP_LIGHT_ARRAY | CliDumper::DUMP_COMMA_SEPARATOR);
  91.         }
  92.     }
  94.     public function formatBatch(array $records): mixed
  95.     {
  96.         foreach ($records as $key => $record) {
  97.             $records[$key] = $this->format($record);
  98.         }
  100.         return $records;
  101.     }
  103.     private function doFormat(array|LogRecord $record): mixed
  104.     {
  105.         if ($record instanceof LogRecord) {
  106.             $record = $record->toArray();
  107.         }
  108.         $record = $this->replacePlaceHolder($record);
  110.         if (!$this->options['ignore_empty_context_and_extra'] || !empty($record['context'])) {
  111.             $context = ($this->options['multiline'] ? "\n" : ' ').$this->dumpData($record['context']);
  112.         } else {
  113.             $context = '';
  114.         }
  116.         if (!$this->options['ignore_empty_context_and_extra'] || !empty($record['extra'])) {
  117.             $extra = ($this->options['multiline'] ? "\n" : ' ').$this->dumpData($record['extra']);
  118.         } else {
  119.             $extra = '';
  120.         }
  122.         $formatted = strtr($this->options['format'], [
  123.             '%datetime%' => $record['datetime'] instanceof \DateTimeInterface
  124.                 ? $record['datetime']->format($this->options['date_format'])
  125.                 : $record['datetime'],
  126.             '%start_tag%' => sprintf('<%s>', self::LEVEL_COLOR_MAP[$record['level']]),
  127.             '%level_name%' => sprintf($this->options['level_name_format'], $record['level_name']),
  128.             '%end_tag%' => '</>',
  129.             '%channel%' => $record['channel'],
  130.             '%message%' => $this->replacePlaceHolder($record)['message'],
  131.             '%context%' => $context,
  132.             '%extra%' => $extra,
  133.         ]);
  135.         return $formatted;
  136.     }
  138.     /**
  139.      * @internal
  140.      */
  141.     public function echoLine(string $line, int $depth, string $indentPad)
  142.     {
  143.         if (-1 !== $depth) {
  144.             fwrite($this->outputBuffer, $line);
  145.         }
  146.     }
  148.     /**
  149.      * @internal
  150.      */
  151.     public function castObject(mixed $v, array $a, Stub $s, bool $isNested): array
  152.     {
  153.         if ($this->options['multiline']) {
  154.             return $a;
  155.         }
  157.         if ($isNested && !$v instanceof \DateTimeInterface) {
  158.             $s->cut = -1;
  159.             $a = [];
  160.         }
  162.         return $a;
  163.     }
  165.     private function replacePlaceHolder(array $record): array
  166.     {
  167.         $message = $record['message'];
  169.         if (!str_contains($message, '{')) {
  170.             return $record;
  171.         }
  173.         $context = $record['context'];
  175.         $replacements = [];
  176.         foreach ($context as $k => $v) {
  177.             // Remove quotes added by the dumper around string.
  178.             $v = trim($this->dumpData($v, false), '"');
  179.             $v = OutputFormatter::escape($v);
  180.             $replacements['{'.$k.'}'] = sprintf('<comment>%s</>', $v);
  181.         }
  183.         $record['message'] = strtr($message, $replacements);
  185.         return $record;
  186.     }
  188.     private function dumpData(mixed $data, bool $colors = null): string
  189.     {
  190.         if (!isset($this->dumper)) {
  191.             return '';
  192.         }
  194.         if (null === $colors) {
  195.             $this->dumper->setColors($this->options['colors']);
  196.         } else {
  197.             $this->dumper->setColors($colors);
  198.         }
  200.         if (!$data instanceof Data) {
  201.             $data = $this->cloner->cloneVar($data);
  202.         }
  203.         $data = $data->withRefHandles(false);
  204.         $this->dumper->dump($data);
  206.         $dump = stream_get_contents($this->outputBuffer, -1, 0);
  207.         rewind($this->outputBuffer);
  208.         ftruncate($this->outputBuffer, 0);
  210.         return rtrim($dump);
  211.     }
  212. }