Deprecated: Constant E_STRICT is deprecated in /home/pastorz/old-espace-client/vendor/symfony/error-handler/ErrorHandler.php on line 58

Deprecated: Constant E_STRICT is deprecated in /home/pastorz/old-espace-client/vendor/symfony/error-handler/ErrorHandler.php on line 76
Symfony Profiler

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

Open in your IDE?
  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\Component\Translation\Command;
  14. use Symfony\Component\Console\CI\GithubActionReporter;
  15. use Symfony\Component\Console\Command\Command;
  16. use Symfony\Component\Console\Completion\CompletionInput;
  17. use Symfony\Component\Console\Completion\CompletionSuggestions;
  18. use Symfony\Component\Console\Exception\RuntimeException;
  19. use Symfony\Component\Console\Input\InputArgument;
  20. use Symfony\Component\Console\Input\InputInterface;
  21. use Symfony\Component\Console\Input\InputOption;
  22. use Symfony\Component\Console\Output\OutputInterface;
  23. use Symfony\Component\Console\Style\SymfonyStyle;
  24. use Symfony\Component\Translation\Exception\InvalidArgumentException;
  25. use Symfony\Component\Translation\Util\XliffUtils;
  27. /**
  28.  * Validates XLIFF files syntax and outputs encountered errors.
  29.  *
  30.  * @author Grégoire Pineau <lyrixx@lyrixx.info>
  31.  * @author Robin Chalas <robin.chalas@gmail.com>
  32.  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  33.  */
  34. class XliffLintCommand extends Command
  35. {
  36.     protected static $defaultName = 'lint:xliff';
  37.     protected static $defaultDescription = 'Lint an XLIFF file and outputs encountered errors';
  39.     private $format;
  40.     private $displayCorrectFiles;
  41.     private $directoryIteratorProvider;
  42.     private $isReadableProvider;
  43.     private $requireStrictFileNames;
  45.     public function __construct(string $name = null, callable $directoryIteratorProvider = null, callable $isReadableProvider = null, bool $requireStrictFileNames = true)
  46.     {
  47.         parent::__construct($name);
  49.         $this->directoryIteratorProvider = $directoryIteratorProvider;
  50.         $this->isReadableProvider = $isReadableProvider;
  51.         $this->requireStrictFileNames = $requireStrictFileNames;
  52.     }
  54.     /**
  55.      * {@inheritdoc}
  56.      */
  57.     protected function configure()
  58.     {
  59.         $this
  60.             ->setDescription(self::$defaultDescription)
  61.             ->addArgument('filename', InputArgument::IS_ARRAY, 'A file, a directory or "-" for reading from STDIN')
  62.             ->addOption('format', null, InputOption::VALUE_REQUIRED, 'The output format')
  63.             ->setHelp(<<<EOF
  64. The <info>%command.name%</info> command lints an XLIFF file and outputs to STDOUT
  65. the first encountered syntax error.
  67. You can validates XLIFF contents passed from STDIN:
  69.   <info>cat filename | php %command.full_name% -</info>
  71. You can also validate the syntax of a file:
  73.   <info>php %command.full_name% filename</info>
  75. Or of a whole directory:
  77.   <info>php %command.full_name% dirname</info>
  78.   <info>php %command.full_name% dirname --format=json</info>
  80. EOF
  81.             )
  82.         ;
  83.     }
  85.     protected function execute(InputInterface $input, OutputInterface $output)
  86.     {
  87.         $io = new SymfonyStyle($input, $output);
  88.         $filenames = (array) $input->getArgument('filename');
  89.         $this->format = $input->getOption('format') ?? (GithubActionReporter::isGithubActionEnvironment() ? 'github' : 'txt');
  90.         $this->displayCorrectFiles = $output->isVerbose();
  92.         if (['-'] === $filenames) {
  93.             return $this->display($io, [$this->validate(file_get_contents('php://stdin'))]);
  94.         }
  96.         if (!$filenames) {
  97.             throw new RuntimeException('Please provide a filename or pipe file content to STDIN.');
  98.         }
  100.         $filesInfo = [];
  101.         foreach ($filenames as $filename) {
  102.             if (!$this->isReadable($filename)) {
  103.                 throw new RuntimeException(sprintf('File or directory "%s" is not readable.', $filename));
  104.             }
  106.             foreach ($this->getFiles($filename) as $file) {
  107.                 $filesInfo[] = $this->validate(file_get_contents($file), $file);
  108.             }
  109.         }
  111.         return $this->display($io, $filesInfo);
  112.     }
  114.     private function validate(string $content, string $file = null): array
  115.     {
  116.         $errors = [];
  118.         // Avoid: Warning DOMDocument::loadXML(): Empty string supplied as input
  119.         if ('' === trim($content)) {
  120.             return ['file' => $file, 'valid' => true];
  121.         }
  123.         $internal = libxml_use_internal_errors(true);
  125.         $document = new \DOMDocument();
  126.         $document->loadXML($content);
  128.         if (null !== $targetLanguage = $this->getTargetLanguageFromFile($document)) {
  129.             $normalizedLocalePattern = sprintf('(%s|%s)', preg_quote($targetLanguage, '/'), preg_quote(str_replace('-', '_', $targetLanguage), '/'));
  130.             // strict file names require translation files to be named '____.locale.xlf'
  131.             // otherwise, both '____.locale.xlf' and 'locale.____.xlf' are allowed
  132.             // also, the regexp matching must be case-insensitive, as defined for 'target-language' values
  133.             // http://docs.oasis-open.org/xliff/v1.2/os/xliff-core.html#target-language
  134.             $expectedFilenamePattern = $this->requireStrictFileNames ? sprintf('/^.*\.(?i:%s)\.(?:xlf|xliff)/', $normalizedLocalePattern) : sprintf('/^(?:.*\.(?i:%s)|(?i:%s)\..*)\.(?:xlf|xliff)/', $normalizedLocalePattern, $normalizedLocalePattern);
  136.             if (0 === preg_match($expectedFilenamePattern, basename($file))) {
  137.                 $errors[] = [
  138.                     'line' => -1,
  139.                     'column' => -1,
  140.                     '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),
  141.                 ];
  142.             }
  143.         }
  145.         foreach (XliffUtils::validateSchema($document) as $xmlError) {
  146.             $errors[] = [
  147.                 'line' => $xmlError['line'],
  148.                 'column' => $xmlError['column'],
  149.                 'message' => $xmlError['message'],
  150.             ];
  151.         }
  153.         libxml_clear_errors();
  154.         libxml_use_internal_errors($internal);
  156.         return ['file' => $file, 'valid' => 0 === \count($errors), 'messages' => $errors];
  157.     }
  159.     private function display(SymfonyStyle $io, array $files)
  160.     {
  161.         switch ($this->format) {
  162.             case 'txt':
  163.                 return $this->displayTxt($io, $files);
  164.             case 'json':
  165.                 return $this->displayJson($io, $files);
  166.             case 'github':
  167.                 return $this->displayTxt($io, $files, true);
  168.             default:
  169.                 throw new InvalidArgumentException(sprintf('The format "%s" is not supported.', $this->format));
  170.         }
  171.     }
  173.     private function displayTxt(SymfonyStyle $io, array $filesInfo, bool $errorAsGithubAnnotations = false)
  174.     {
  175.         $countFiles = \count($filesInfo);
  176.         $erroredFiles = 0;
  177.         $githubReporter = $errorAsGithubAnnotations ? new GithubActionReporter($io) : null;
  179.         foreach ($filesInfo as $info) {
  180.             if ($info['valid'] && $this->displayCorrectFiles) {
  181.                 $io->comment('<info>OK</info>'.($info['file'] ? sprintf(' in %s', $info['file']) : ''));
  182.             } elseif (!$info['valid']) {
  183.                 ++$erroredFiles;
  184.                 $io->text('<error> ERROR </error>'.($info['file'] ? sprintf(' in %s', $info['file']) : ''));
  185.                 $io->listing(array_map(function ($error) use ($info, $githubReporter) {
  186.                     // general document errors have a '-1' line number
  187.                     $line = -1 === $error['line'] ? null : $error['line'];
  189.                     if ($githubReporter) {
  190.                         $githubReporter->error($error['message'], $info['file'], $line, null !== $line ? $error['column'] : null);
  191.                     }
  193.                     return null === $line ? $error['message'] : sprintf('Line %d, Column %d: %s', $line, $error['column'], $error['message']);
  194.                 }, $info['messages']));
  195.             }
  196.         }
  198.         if (0 === $erroredFiles) {
  199.             $io->success(sprintf('All %d XLIFF files contain valid syntax.', $countFiles));
  200.         } else {
  201.             $io->warning(sprintf('%d XLIFF files have valid syntax and %d contain errors.', $countFiles - $erroredFiles, $erroredFiles));
  202.         }
  204.         return min($erroredFiles, 1);
  205.     }
  207.     private function displayJson(SymfonyStyle $io, array $filesInfo)
  208.     {
  209.         $errors = 0;
  211.         array_walk($filesInfo, function (&$v) use (&$errors) {
  212.             $v['file'] = (string) $v['file'];
  213.             if (!$v['valid']) {
  214.                 ++$errors;
  215.             }
  216.         });
  218.         $io->writeln(json_encode($filesInfo, \JSON_PRETTY_PRINT | \JSON_UNESCAPED_SLASHES));
  220.         return min($errors, 1);
  221.     }
  223.     private function getFiles(string $fileOrDirectory)
  224.     {
  225.         if (is_file($fileOrDirectory)) {
  226.             yield new \SplFileInfo($fileOrDirectory);
  228.             return;
  229.         }
  231.         foreach ($this->getDirectoryIterator($fileOrDirectory) as $file) {
  232.             if (!\in_array($file->getExtension(), ['xlf', 'xliff'])) {
  233.                 continue;
  234.             }
  236.             yield $file;
  237.         }
  238.     }
  240.     private function getDirectoryIterator(string $directory)
  241.     {
  242.         $default = function ($directory) {
  243.             return new \RecursiveIteratorIterator(
  244.                 new \RecursiveDirectoryIterator($directory, \FilesystemIterator::SKIP_DOTS | \FilesystemIterator::FOLLOW_SYMLINKS),
  245.                 \RecursiveIteratorIterator::LEAVES_ONLY
  246.             );
  247.         };
  249.         if (null !== $this->directoryIteratorProvider) {
  250.             return ($this->directoryIteratorProvider)($directory, $default);
  251.         }
  253.         return $default($directory);
  254.     }
  256.     private function isReadable(string $fileOrDirectory)
  257.     {
  258.         $default = function ($fileOrDirectory) {
  259.             return is_readable($fileOrDirectory);
  260.         };
  262.         if (null !== $this->isReadableProvider) {
  263.             return ($this->isReadableProvider)($fileOrDirectory, $default);
  264.         }
  266.         return $default($fileOrDirectory);
  267.     }
  269.     private function getTargetLanguageFromFile(\DOMDocument $xliffContents): ?string
  270.     {
  271.         foreach ($xliffContents->getElementsByTagName('file')[0]->attributes ?? [] as $attribute) {
  272.             if ('target-language' === $attribute->nodeName) {
  273.                 return $attribute->nodeValue;
  274.             }
  275.         }
  277.         return null;
  278.     }
  280.     public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void
  281.     {
  282.         if ($input->mustSuggestOptionValuesFor('format')) {
  283.             $suggestions->suggestValues(['txt', 'json', 'github']);
  284.         }
  285.     }
  286. }