vendor/symfony/translation/Command/XliffLintCommand.php line 112

Open in your IDE?
  1. <?php
  2. /*
  3.  * This file is part of the Symfony package.
  4.  *
  5.  * (c) Fabien Potencier <fabien@symfony.com>
  6.  *
  7.  * For the full copyright and license information, please view the LICENSE
  8.  * file that was distributed with this source code.
  9.  */
  10. namespace Symfony\Component\Translation\Command;
  11. use Symfony\Component\Console\Attribute\AsCommand;
  12. use Symfony\Component\Console\CI\GithubActionReporter;
  13. use Symfony\Component\Console\Command\Command;
  14. use Symfony\Component\Console\Completion\CompletionInput;
  15. use Symfony\Component\Console\Completion\CompletionSuggestions;
  16. use Symfony\Component\Console\Exception\RuntimeException;
  17. use Symfony\Component\Console\Input\InputArgument;
  18. use Symfony\Component\Console\Input\InputInterface;
  19. use Symfony\Component\Console\Input\InputOption;
  20. use Symfony\Component\Console\Output\OutputInterface;
  21. use Symfony\Component\Console\Style\SymfonyStyle;
  22. use Symfony\Component\Translation\Exception\InvalidArgumentException;
  23. use Symfony\Component\Translation\Util\XliffUtils;
  24. /**
  25.  * Validates XLIFF files syntax and outputs encountered errors.
  26.  *
  27.  * @author GrĂ©goire Pineau <lyrixx@lyrixx.info>
  28.  * @author Robin Chalas <robin.chalas@gmail.com>
  29.  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  30.  */
  31. #[AsCommand(name: 'lint:xliff', description: 'Lint an XLIFF file and outputs encountered errors')]
  32. class XliffLintCommand extends Command
  33. {
  34.     private string $format;
  35.     private bool $displayCorrectFiles;
  36.     private ?\Closure $directoryIteratorProvider;
  37.     private ?\Closure $isReadableProvider;
  38.     private bool $requireStrictFileNames;
  39.     public function __construct(string $name = null, callable $directoryIteratorProvider = null, callable $isReadableProvider = null, bool $requireStrictFileNames = true)
  40.     {
  41.         parent::__construct($name);
  42.         $this->directoryIteratorProvider = null === $directoryIteratorProvider || $directoryIteratorProvider instanceof \Closure ? $directoryIteratorProvider : \Closure::fromCallable($directoryIteratorProvider);
  43.         $this->isReadableProvider = null === $isReadableProvider || $isReadableProvider instanceof \Closure ? $isReadableProvider : \Closure::fromCallable($isReadableProvider);
  44.         $this->requireStrictFileNames = $requireStrictFileNames;
  45.     }
  46.     /**
  47.      * {@inheritdoc}
  48.      */
  49.     protected function configure()
  50.     {
  51.         $this
  52.             ->addArgument('filename', InputArgument::IS_ARRAY, 'A file, a directory or "-" for reading from STDIN')
  53.             ->addOption('format', null, InputOption::VALUE_REQUIRED, 'The output format')
  54.             ->setHelp(<<<EOF
  55. The <info>%command.name%</info> command lints an XLIFF file and outputs to STDOUT
  56. the first encountered syntax error.
  57. You can validates XLIFF contents passed from STDIN:
  58.   <info>cat filename | php %command.full_name% -</info>
  59. You can also validate the syntax of a file:
  60.   <info>php %command.full_name% filename</info>
  61. Or of a whole directory:
  62.   <info>php %command.full_name% dirname</info>
  63.   <info>php %command.full_name% dirname --format=json</info>
  64. EOF
  65.             )
  66.         ;
  67.     }
  68.     protected function execute(InputInterface $input, OutputInterface $output): int
  69.     {
  70.         $io = new SymfonyStyle($input, $output);
  71.         $filenames = (array) $input->getArgument('filename');
  72.         $this->format = $input->getOption('format') ?? (GithubActionReporter::isGithubActionEnvironment() ? 'github' : 'txt');
  73.         $this->displayCorrectFiles = $output->isVerbose();
  74.         if (['-'] === $filenames) {
  75.             return $this->display($io, [$this->validate(file_get_contents('php://stdin'))]);
  76.         }
  77.         if (!$filenames) {
  78.             throw new RuntimeException('Please provide a filename or pipe file content to STDIN.');
  79.         }
  80.         $filesInfo = [];
  81.         foreach ($filenames as $filename) {
  82.             if (!$this->isReadable($filename)) {
  83.                 throw new RuntimeException(sprintf('File or directory "%s" is not readable.', $filename));
  84.             }
  85.             foreach ($this->getFiles($filename) as $file) {
  86.                 $filesInfo[] = $this->validate(file_get_contents($file), $file);
  87.             }
  88.         }
  89.         return $this->display($io, $filesInfo);
  90.     }
  91.     private function validate(string $content, string $file = null): array
  92.     {
  93.         $errors = [];
  94.         // Avoid: Warning DOMDocument::loadXML(): Empty string supplied as input
  95.         if ('' === trim($content)) {
  96.             return ['file' => $file, 'valid' => true];
  97.         }
  98.         $internal = libxml_use_internal_errors(true);
  99.         $document = new \DOMDocument();
  100.         $document->loadXML($content);
  101.         if (null !== $targetLanguage = $this->getTargetLanguageFromFile($document)) {
  102.             $normalizedLocalePattern = sprintf('(%s|%s)', preg_quote($targetLanguage, '/'), preg_quote(str_replace('-', '_', $targetLanguage), '/'));
  103.             // strict file names require translation files to be named '____.locale.xlf'
  104.             // otherwise, both '____.locale.xlf' and 'locale.____.xlf' are allowed
  105.             // also, the regexp matching must be case-insensitive, as defined for 'target-language' values
  106.             // http://docs.oasis-open.org/xliff/v1.2/os/xliff-core.html#target-language
  107.             $expectedFilenamePattern = $this->requireStrictFileNames ? sprintf('/^.*\.(?i:%s)\.(?:xlf|xliff)/', $normalizedLocalePattern) : sprintf('/^(?:.*\.(?i:%s)|(?i:%s)\..*)\.(?:xlf|xliff)/', $normalizedLocalePattern, $normalizedLocalePattern);
  108.             if (0 === preg_match($expectedFilenamePattern, basename($file))) {
  109.                 $errors[] = [
  110.                     'line' => -1,
  111.                     'column' => -1,
  112.                     'message' => sprintf('There is a mismatch between the language included in the file name ("%s") and the "%s" value used in the "target-language" attribute of the file.', basename($file), $targetLanguage),
  113.                 ];
  114.             }
  115.         }
  116.         foreach (XliffUtils::validateSchema($document) as $xmlError) {
  117.             $errors[] = [
  118.                 'line' => $xmlError['line'],
  119.                 'column' => $xmlError['column'],
  120.                 'message' => $xmlError['message'],
  121.             ];
  122.         }
  123.         libxml_clear_errors();
  124.         libxml_use_internal_errors($internal);
  125.         return ['file' => $file, 'valid' => 0 === \count($errors), 'messages' => $errors];
  126.     }
  127.     private function display(SymfonyStyle $io, array $files)
  128.     {
  129.         switch ($this->format) {
  130.             case 'txt':
  131.                 return $this->displayTxt($io, $files);
  132.             case 'json':
  133.                 return $this->displayJson($io, $files);
  134.             case 'github':
  135.                 return $this->displayTxt($io, $files, true);
  136.             default:
  137.                 throw new InvalidArgumentException(sprintf('The format "%s" is not supported.', $this->format));
  138.         }
  139.     }
  140.     private function displayTxt(SymfonyStyle $io, array $filesInfo, bool $errorAsGithubAnnotations = false)
  141.     {
  142.         $countFiles = \count($filesInfo);
  143.         $erroredFiles = 0;
  144.         $githubReporter = $errorAsGithubAnnotations ? new GithubActionReporter($io) : null;
  145.         foreach ($filesInfo as $info) {
  146.             if ($info['valid'] && $this->displayCorrectFiles) {
  147.                 $io->comment('<info>OK</info>'.($info['file'] ? sprintf(' in %s', $info['file']) : ''));
  148.             } elseif (!$info['valid']) {
  149.                 ++$erroredFiles;
  150.                 $io->text('<error> ERROR </error>'.($info['file'] ? sprintf(' in %s', $info['file']) : ''));
  151.                 $io->listing(array_map(function ($error) use ($info, $githubReporter) {
  152.                     // general document errors have a '-1' line number
  153.                     $line = -1 === $error['line'] ? null : $error['line'];
  154.                     if ($githubReporter) {
  155.                         $githubReporter->error($error['message'], $info['file'], $line, null !== $line ? $error['column'] : null);
  156.                     }
  157.                     return null === $line ? $error['message'] : sprintf('Line %d, Column %d: %s', $line, $error['column'], $error['message']);
  158.                 }, $info['messages']));
  159.             }
  160.         }
  161.         if (0 === $erroredFiles) {
  162.             $io->success(sprintf('All %d XLIFF files contain valid syntax.', $countFiles));
  163.         } else {
  164.             $io->warning(sprintf('%d XLIFF files have valid syntax and %d contain errors.', $countFiles - $erroredFiles, $erroredFiles));
  165.         }
  166.         return min($erroredFiles, 1);
  167.     }
  168.     private function displayJson(SymfonyStyle $io, array $filesInfo)
  169.     {
  170.         $errors = 0;
  171.         array_walk($filesInfo, function (&$v) use (&$errors) {
  172.             $v['file'] = (string) $v['file'];
  173.             if (!$v['valid']) {
  174.                 ++$errors;
  175.             }
  176.         });
  177.         $io->writeln(json_encode($filesInfo, \JSON_PRETTY_PRINT | \JSON_UNESCAPED_SLASHES));
  178.         return min($errors, 1);
  179.     }
  180.     private function getFiles(string $fileOrDirectory)
  181.     {
  182.         if (is_file($fileOrDirectory)) {
  183.             yield new \SplFileInfo($fileOrDirectory);
  184.             return;
  185.         }
  186.         foreach ($this->getDirectoryIterator($fileOrDirectory) as $file) {
  187.             if (!\in_array($file->getExtension(), ['xlf', 'xliff'])) {
  188.                 continue;
  189.             }
  190.             yield $file;
  191.         }
  192.     }
  193.     private function getDirectoryIterator(string $directory)
  194.     {
  195.         $default = function ($directory) {
  196.             return new \RecursiveIteratorIterator(
  197.                 new \RecursiveDirectoryIterator($directory, \FilesystemIterator::SKIP_DOTS | \FilesystemIterator::FOLLOW_SYMLINKS),
  198.                 \RecursiveIteratorIterator::LEAVES_ONLY
  199.             );
  200.         };
  201.         if (null !== $this->directoryIteratorProvider) {
  202.             return ($this->directoryIteratorProvider)($directory, $default);
  203.         }
  204.         return $default($directory);
  205.     }
  206.     private function isReadable(string $fileOrDirectory)
  207.     {
  208.         $default = function ($fileOrDirectory) {
  209.             return is_readable($fileOrDirectory);
  210.         };
  211.         if (null !== $this->isReadableProvider) {
  212.             return ($this->isReadableProvider)($fileOrDirectory, $default);
  213.         }
  214.         return $default($fileOrDirectory);
  215.     }
  216.     private function getTargetLanguageFromFile(\DOMDocument $xliffContents): ?string
  217.     {
  218.         foreach ($xliffContents->getElementsByTagName('file')[0]->attributes ?? [] as $attribute) {
  219.             if ('target-language' === $attribute->nodeName) {
  220.                 return $attribute->nodeValue;
  221.             }
  222.         }
  223.         return null;
  224.     }
  225.     public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void
  226.     {
  227.         if ($input->mustSuggestOptionValuesFor('format')) {
  228.             $suggestions->suggestValues(['txt', 'json', 'github']);
  229.         }
  230.     }
  231. }