ConsoleLogger.php
97 lines
| 1 | <?php |
| 2 | |
| 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 | */ |
| 11 | namespace Matomo\Dependencies\Symfony\Component\Console\Logger; |
| 12 | |
| 13 | use Matomo\Dependencies\Psr\Log\AbstractLogger; |
| 14 | use Matomo\Dependencies\Psr\Log\InvalidArgumentException; |
| 15 | use Matomo\Dependencies\Psr\Log\LogLevel; |
| 16 | use Matomo\Dependencies\Symfony\Component\Console\Output\ConsoleOutputInterface; |
| 17 | use Matomo\Dependencies\Symfony\Component\Console\Output\OutputInterface; |
| 18 | /** |
| 19 | * PSR-3 compliant console logger. |
| 20 | * |
| 21 | * @author Kévin Dunglas <dunglas@gmail.com> |
| 22 | * |
| 23 | * @see https://www.php-fig.org/psr/psr-3/ |
| 24 | */ |
| 25 | class ConsoleLogger extends AbstractLogger |
| 26 | { |
| 27 | public const INFO = 'info'; |
| 28 | public const ERROR = 'error'; |
| 29 | private $output; |
| 30 | private $verbosityLevelMap = [LogLevel::EMERGENCY => OutputInterface::VERBOSITY_NORMAL, LogLevel::ALERT => OutputInterface::VERBOSITY_NORMAL, LogLevel::CRITICAL => OutputInterface::VERBOSITY_NORMAL, LogLevel::ERROR => OutputInterface::VERBOSITY_NORMAL, LogLevel::WARNING => OutputInterface::VERBOSITY_NORMAL, LogLevel::NOTICE => OutputInterface::VERBOSITY_VERBOSE, LogLevel::INFO => OutputInterface::VERBOSITY_VERY_VERBOSE, LogLevel::DEBUG => OutputInterface::VERBOSITY_DEBUG]; |
| 31 | private $formatLevelMap = [LogLevel::EMERGENCY => self::ERROR, LogLevel::ALERT => self::ERROR, LogLevel::CRITICAL => self::ERROR, LogLevel::ERROR => self::ERROR, LogLevel::WARNING => self::INFO, LogLevel::NOTICE => self::INFO, LogLevel::INFO => self::INFO, LogLevel::DEBUG => self::INFO]; |
| 32 | private $errored = \false; |
| 33 | public function __construct(OutputInterface $output, array $verbosityLevelMap = [], array $formatLevelMap = []) |
| 34 | { |
| 35 | $this->output = $output; |
| 36 | $this->verbosityLevelMap = $verbosityLevelMap + $this->verbosityLevelMap; |
| 37 | $this->formatLevelMap = $formatLevelMap + $this->formatLevelMap; |
| 38 | } |
| 39 | /** |
| 40 | * {@inheritdoc} |
| 41 | * |
| 42 | * @return void |
| 43 | */ |
| 44 | public function log($level, $message, array $context = []) |
| 45 | { |
| 46 | if (!isset($this->verbosityLevelMap[$level])) { |
| 47 | throw new InvalidArgumentException(sprintf('The log level "%s" does not exist.', $level)); |
| 48 | } |
| 49 | $output = $this->output; |
| 50 | // Write to the error output if necessary and available |
| 51 | if (self::ERROR === $this->formatLevelMap[$level]) { |
| 52 | if ($this->output instanceof ConsoleOutputInterface) { |
| 53 | $output = $output->getErrorOutput(); |
| 54 | } |
| 55 | $this->errored = \true; |
| 56 | } |
| 57 | // the if condition check isn't necessary -- it's the same one that $output will do internally anyway. |
| 58 | // We only do it for efficiency here as the message formatting is relatively expensive. |
| 59 | if ($output->getVerbosity() >= $this->verbosityLevelMap[$level]) { |
| 60 | $output->writeln(sprintf('<%1$s>[%2$s] %3$s</%1$s>', $this->formatLevelMap[$level], $level, $this->interpolate($message, $context)), $this->verbosityLevelMap[$level]); |
| 61 | } |
| 62 | } |
| 63 | /** |
| 64 | * Returns true when any messages have been logged at error levels. |
| 65 | * |
| 66 | * @return bool |
| 67 | */ |
| 68 | public function hasErrored() |
| 69 | { |
| 70 | return $this->errored; |
| 71 | } |
| 72 | /** |
| 73 | * Interpolates context values into the message placeholders. |
| 74 | * |
| 75 | * @author PHP Framework Interoperability Group |
| 76 | */ |
| 77 | private function interpolate(string $message, array $context) : string |
| 78 | { |
| 79 | if (!str_contains($message, '{')) { |
| 80 | return $message; |
| 81 | } |
| 82 | $replacements = []; |
| 83 | foreach ($context as $key => $val) { |
| 84 | if (null === $val || \is_scalar($val) || \is_object($val) && method_exists($val, '__toString')) { |
| 85 | $replacements["{{$key}}"] = $val; |
| 86 | } elseif ($val instanceof \DateTimeInterface) { |
| 87 | $replacements["{{$key}}"] = $val->format(\DateTime::RFC3339); |
| 88 | } elseif (\is_object($val)) { |
| 89 | $replacements["{{$key}}"] = '[object ' . \get_class($val) . ']'; |
| 90 | } else { |
| 91 | $replacements["{{$key}}"] = '[' . \gettype($val) . ']'; |
| 92 | } |
| 93 | } |
| 94 | return strtr($message, $replacements); |
| 95 | } |
| 96 | } |
| 97 |