src/Command/TwigLintCommand.php

   1 <?php
   2
   3 declare(strict_types=1);
   4
   5 namespace PhpMyAdmin\Command;
   6
   7 use PhpMyAdmin\Template;
   8 use Symfony\Component\Console\Attribute\AsCommand;
   9 use Symfony\Component\Console\Command\Command;
  10 use Symfony\Component\Console\Input\InputInterface;
  11 use Symfony\Component\Console\Input\InputOption;
  12 use Symfony\Component\Console\Output\OutputInterface;
  13 use Symfony\Component\Console\Style\SymfonyStyle;
  14 use Twig\Error\Error;
  15 use Twig\Loader\ArrayLoader;
  16 use Twig\Source;
  17
  18 use function array_push;
  19 use function closedir;
  20 use function count;
  21 use function explode;
  22 use function file_get_contents;
  23 use function is_dir;
  24 use function is_file;
  25 use function max;
  26 use function min;
  27 use function opendir;
  28 use function preg_match;
  29 use function readdir;
  30 use function restore_error_handler;
  31 use function set_error_handler;
  32 use function sprintf;
  33
  34 use const DIRECTORY_SEPARATOR;
  35 use const E_USER_DEPRECATED;
  36
  37 /**
  38  * Command that will validate your template syntax and output encountered errors.
  39  * Author: Marc Weistroff <marc.weistroff@sensiolabs.com>
  40  * Author: Jérôme Tamarelle <jerome@tamarelle.net>
  41  *
  42  * Copyright (c) 2013-2021 Fabien Potencier
  43  *
  44  * Permission is hereby granted, free of charge, to any person obtaining a copy
  45  * of this software and associated documentation files (the "Software"), to deal
  46  * in the Software without restriction, including without limitation the rights
  47  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  48  * copies of the Software, and to permit persons to whom the Software is furnished
  49  * to do so, subject to the following conditions:
  50  *
  51  * The above copyright notice and this permission notice shall be included in all
  52  * copies or substantial portions of the Software.
  53  *
  54  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  55  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  56  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  57  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  58  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  59  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  60  * THE SOFTWARE.
  61  */
  62 #[AsCommand(name: 'lint:twig', description: 'Lint a Twig template and outputs encountered errors.')]
  63 class TwigLintCommand extends Command
  64 {
  65     protected function configure(): void
  66     {
  67         $this->addOption('show-deprecations', null, InputOption::VALUE_NONE, 'Show deprecations as errors');
  68     }
  69
  70     /** @return string[] */
  71     protected function findFiles(string $baseFolder): array
  72     {
  73         /* Open the handle */
  74         $handle = @opendir($baseFolder);
  75         if ($handle === false) {
  76             return [];
  77         }
  78
  79         $foundFiles = [];
  80
  81         /** @infection-ignore-all */
  82         while (($file = readdir($handle)) !== false) {
  83             if ($file === '.' || $file === '..') {
  84                 continue;
  85             }
  86
  87             $itemPath = $baseFolder . DIRECTORY_SEPARATOR . $file;
  88
  89             if (is_dir($itemPath)) {
  90                 array_push($foundFiles, ...$this->findFiles($itemPath));
  91                 continue;
  92             }
  93
  94             if (! is_file($itemPath)) {
  95                 continue;
  96             }
  97
  98             $foundFiles[] = $itemPath;
  99         }
 100
 101         /* Close the handle */
 102         closedir($handle);
 103
 104         return $foundFiles;
 105     }
 106
 107     protected function execute(InputInterface $input, OutputInterface $output): int
 108     {
 109         $io = new SymfonyStyle($input, $output);
 110         $showDeprecations = $input->getOption('show-deprecations');
 111
 112         if ($showDeprecations) {
 113             $prevErrorHandler = set_error_handler(
 114                 static function (int $level, string $message, string $file, int $line) use (&$prevErrorHandler) {
 115                     if ($level === E_USER_DEPRECATED) {
 116                         $templateLine = 0;
 117                         if (preg_match('/ at line (\d+)[ .]/', $message, $matches)) {
 118                             $templateLine = (int) $matches[1];
 119                         }
 120
 121                         throw new Error($message, $templateLine);
 122                     }
 123
 124                     return $prevErrorHandler ? $prevErrorHandler($level, $message, $file, $line) : false;
 125                 },
 126             );
 127         }
 128
 129         try {
 130             $filesInfo = $this->getFilesInfo(ROOT_PATH . 'resources/templates');
 131         } finally {
 132             if ($showDeprecations) {
 133                 restore_error_handler();
 134             }
 135         }
 136
 137         return $this->display($output, $io, $filesInfo);
 138     }
 139
 140     /** @return mixed[] */
 141     protected function getFilesInfo(string $templatesPath): array
 142     {
 143         $filesInfo = [];
 144         $filesFound = $this->findFiles($templatesPath);
 145         foreach ($filesFound as $file) {
 146             $filesInfo[] = $this->validate($this->getTemplateContents($file), $file);
 147         }
 148
 149         return $filesInfo;
 150     }
 151
 152     /**
 153      * Allows easier testing
 154      */
 155     protected function getTemplateContents(string $filePath): string
 156     {
 157         return (string) file_get_contents($filePath);
 158     }
 159
 160     /** @return mixed[] */
 161     private function validate(string $template, string $file): array
 162     {
 163         $twig = Template::getTwigEnvironment(null, false);
 164
 165         $realLoader = $twig->getLoader();
 166         try {
 167             $temporaryLoader = new ArrayLoader([$file => $template]);
 168             $twig->setLoader($temporaryLoader);
 169             $nodeTree = $twig->parse($twig->tokenize(new Source($template, $file)));
 170             $twig->compile($nodeTree);
 171             $twig->setLoader($realLoader);
 172         } catch (Error $e) {
 173             $twig->setLoader($realLoader);
 174
 175             return [
 176                 'template' => $template,
 177                 'file' => $file,
 178                 'line' => $e->getTemplateLine(),
 179                 'valid' => false,
 180                 'exception' => $e,
 181             ];
 182         }
 183
 184         return ['template' => $template, 'file' => $file, 'valid' => true];
 185     }
 186
 187     /** @param mixed[] $filesInfo */
 188     private function display(OutputInterface $output, SymfonyStyle $io, array $filesInfo): int
 189     {
 190         $errors = 0;
 191
 192         foreach ($filesInfo as $info) {
 193             if ($info['valid'] && $output->isVerbose()) {
 194                 $io->comment('<info>OK</info>' . ($info['file'] ? sprintf(' in %s', $info['file']) : ''));
 195             } elseif (! $info['valid']) {
 196                 ++$errors;
 197                 $this->renderException($io, $info['template'], $info['exception'], $info['file']);
 198             }
 199         }
 200
 201         if ($errors === 0) {
 202             $io->success(sprintf('All %d Twig files contain valid syntax.', count($filesInfo)));
 203
 204             return Command::SUCCESS;
 205         }
 206
 207         $io->warning(
 208             sprintf(
 209                 '%d Twig files have valid syntax and %d contain errors.',
 210                 count($filesInfo) - $errors,
 211                 $errors,
 212             ),
 213         );
 214
 215         return Command::FAILURE;
 216     }
 217
 218     private function renderException(
 219         SymfonyStyle $output,
 220         string $template,
 221         Error $exception,
 222         string|null $file = null,
 223     ): void {
 224         $line = $exception->getTemplateLine();
 225
 226         if ($file !== null && $file !== '') {
 227             $output->text(sprintf('<error> ERROR </error> in %s (line %s)', $file, $line));
 228         } else {
 229             $output->text(sprintf('<error> ERROR </error> (line %s)', $line));
 230         }
 231
 232         // If the line is not known (this might happen for deprecations if we fail at detecting the line for instance),
 233         // we render the message without context, to ensure the message is displayed.
 234         if ($line <= 0) {
 235             $output->text(sprintf('<error> >> %s</error> ', $exception->getRawMessage()));
 236
 237             return;
 238         }
 239
 240         foreach ($this->getContext($template, $line) as $lineNumber => $code) {
 241             $output->text(sprintf(
 242                 '%s %-6s %s',
 243                 $lineNumber === $line ? '<error> >> </error>' : '    ',
 244                 $lineNumber,
 245                 $code,
 246             ));
 247             if ($lineNumber !== $line) {
 248                 continue;
 249             }
 250
 251             $output->text(sprintf('<error> >> %s</error> ', $exception->getRawMessage()));
 252         }
 253     }
 254
 255     /** @return string[] */
 256     private function getContext(string $template, int $line, int $context = 3): array
 257     {
 258         $lines = explode("\n", $template);
 259
 260         $position = max(0, $line - $context);
 261         $max = min(count($lines), $line - 1 + $context);
 262
 263         $result = [];
 264         while ($position < $max) {
 265             $result[$position + 1] = $lines[$position];
 266             /** @infection-ignore-all */
 267             ++$position;
 268         }
 269
 270         return $result;
 271     }
 272 }