* Dariusz RumiƄski * * This source file is subject to the MIT license that is bundled * with this source code in the file LICENSE. */ namespace PhpCsFixer\Console\Output\Progress; use PhpCsFixer\Console\Output\OutputContext; use PhpCsFixer\FixerFileProcessedEvent; use Symfony\Component\Console\Output\OutputInterface; /** * Output writer to show the progress of a FixCommand using dots and meaningful letters. * * @internal */ final class DotsOutput implements ProgressOutputInterface { /** * File statuses map. * * @var array */ private static array $eventStatusMap = [ FixerFileProcessedEvent::STATUS_NO_CHANGES => ['symbol' => '.', 'format' => '%s', 'description' => 'no changes'], FixerFileProcessedEvent::STATUS_FIXED => ['symbol' => 'F', 'format' => '%s', 'description' => 'fixed'], FixerFileProcessedEvent::STATUS_SKIPPED => ['symbol' => 'S', 'format' => '%s', 'description' => 'skipped (cached or empty file)'], FixerFileProcessedEvent::STATUS_INVALID => ['symbol' => 'I', 'format' => '%s', 'description' => 'invalid file syntax (file ignored)'], FixerFileProcessedEvent::STATUS_EXCEPTION => ['symbol' => 'E', 'format' => '%s', 'description' => 'error'], FixerFileProcessedEvent::STATUS_LINT => ['symbol' => 'E', 'format' => '%s', 'description' => 'error'], ]; /** @readonly */ private OutputContext $context; private int $processedFiles = 0; /** * @var int */ private $symbolsPerLine; public function __construct(OutputContext $context) { $this->context = $context; // max number of characters per line // - total length x 2 (e.g. " 1 / 123" => 6 digits and padding spaces) // - 11 (extra spaces, parentheses and percentage characters, e.g. " x / x (100%)") $this->symbolsPerLine = max(1, $context->getTerminalWidth() - \strlen((string) $context->getFilesCount()) * 2 - 11); } /** * This class is not intended to be serialized, * and cannot be deserialized (see __wakeup method). */ public function __sleep(): array { throw new \BadMethodCallException('Cannot serialize '.self::class); } /** * Disable the deserialization of the class to prevent attacker executing * code by leveraging the __destruct method. * * @see https://owasp.org/www-community/vulnerabilities/PHP_Object_Injection */ public function __wakeup(): void { throw new \BadMethodCallException('Cannot unserialize '.self::class); } public function onFixerFileProcessed(FixerFileProcessedEvent $event): void { $status = self::$eventStatusMap[$event->getStatus()]; $this->getOutput()->write($this->getOutput()->isDecorated() ? \sprintf($status['format'], $status['symbol']) : $status['symbol']); ++$this->processedFiles; $symbolsOnCurrentLine = $this->processedFiles % $this->symbolsPerLine; $isLast = $this->processedFiles === $this->context->getFilesCount(); if (0 === $symbolsOnCurrentLine || $isLast) { $this->getOutput()->write(\sprintf( '%s %'.\strlen((string) $this->context->getFilesCount()).'d / %d (%3d%%)', $isLast && 0 !== $symbolsOnCurrentLine ? str_repeat(' ', $this->symbolsPerLine - $symbolsOnCurrentLine) : '', $this->processedFiles, $this->context->getFilesCount(), round($this->processedFiles / $this->context->getFilesCount() * 100) )); if (!$isLast) { $this->getOutput()->writeln(''); } } } public function printLegend(): void { $symbols = []; foreach (self::$eventStatusMap as $status) { $symbol = $status['symbol']; if ('' === $symbol || isset($symbols[$symbol])) { continue; } $symbols[$symbol] = \sprintf('%s-%s', $this->getOutput()->isDecorated() ? \sprintf($status['format'], $symbol) : $symbol, $status['description']); } $this->getOutput()->write(\sprintf("\nLegend: %s\n", implode(', ', $symbols))); } private function getOutput(): OutputInterface { return $this->context->getOutput(); } }