XliffLintCommand.php 9.3 KB

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