XliffUtils.php 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196
  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\Util;
  11. use Symfony\Component\Translation\Exception\InvalidArgumentException;
  12. use Symfony\Component\Translation\Exception\InvalidResourceException;
  13. /**
  14. * Provides some utility methods for XLIFF translation files, such as validating
  15. * their contents according to the XSD schema.
  16. *
  17. * @author Fabien Potencier <fabien@symfony.com>
  18. */
  19. class XliffUtils
  20. {
  21. /**
  22. * Gets xliff file version based on the root "version" attribute.
  23. *
  24. * Defaults to 1.2 for backwards compatibility.
  25. *
  26. * @throws InvalidArgumentException
  27. */
  28. public static function getVersionNumber(\DOMDocument $dom): string
  29. {
  30. /** @var \DOMNode $xliff */
  31. foreach ($dom->getElementsByTagName('xliff') as $xliff) {
  32. $version = $xliff->attributes->getNamedItem('version');
  33. if ($version) {
  34. return $version->nodeValue;
  35. }
  36. $namespace = $xliff->attributes->getNamedItem('xmlns');
  37. if ($namespace) {
  38. if (0 !== substr_compare('urn:oasis:names:tc:xliff:document:', $namespace->nodeValue, 0, 34)) {
  39. throw new InvalidArgumentException(sprintf('Not a valid XLIFF namespace "%s".', $namespace));
  40. }
  41. return substr($namespace, 34);
  42. }
  43. }
  44. // Falls back to v1.2
  45. return '1.2';
  46. }
  47. /**
  48. * Validates and parses the given file into a DOMDocument.
  49. *
  50. * @throws InvalidResourceException
  51. */
  52. public static function validateSchema(\DOMDocument $dom): array
  53. {
  54. $xliffVersion = static::getVersionNumber($dom);
  55. $internalErrors = libxml_use_internal_errors(true);
  56. if ($shouldEnable = self::shouldEnableEntityLoader()) {
  57. $disableEntities = libxml_disable_entity_loader(false);
  58. }
  59. try {
  60. $isValid = @$dom->schemaValidateSource(self::getSchema($xliffVersion));
  61. if (!$isValid) {
  62. return self::getXmlErrors($internalErrors);
  63. }
  64. } finally {
  65. if ($shouldEnable) {
  66. libxml_disable_entity_loader($disableEntities);
  67. }
  68. }
  69. $dom->normalizeDocument();
  70. libxml_clear_errors();
  71. libxml_use_internal_errors($internalErrors);
  72. return [];
  73. }
  74. private static function shouldEnableEntityLoader(): bool
  75. {
  76. // Version prior to 8.0 can be enabled without deprecation
  77. if (\PHP_VERSION_ID < 80000) {
  78. return true;
  79. }
  80. static $dom, $schema;
  81. if (null === $dom) {
  82. $dom = new \DOMDocument();
  83. $dom->loadXML('<?xml version="1.0"?><test/>');
  84. $tmpfile = tempnam(sys_get_temp_dir(), 'symfony');
  85. register_shutdown_function(static function () use ($tmpfile) {
  86. @unlink($tmpfile);
  87. });
  88. $schema = '<?xml version="1.0" encoding="utf-8"?>
  89. <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  90. <xsd:include schemaLocation="file:///'.str_replace('\\', '/', $tmpfile).'" />
  91. </xsd:schema>';
  92. file_put_contents($tmpfile, '<?xml version="1.0" encoding="utf-8"?>
  93. <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  94. <xsd:element name="test" type="testType" />
  95. <xsd:complexType name="testType"/>
  96. </xsd:schema>');
  97. }
  98. return !@$dom->schemaValidateSource($schema);
  99. }
  100. public static function getErrorsAsString(array $xmlErrors): string
  101. {
  102. $errorsAsString = '';
  103. foreach ($xmlErrors as $error) {
  104. $errorsAsString .= sprintf("[%s %s] %s (in %s - line %d, column %d)\n",
  105. \LIBXML_ERR_WARNING === $error['level'] ? 'WARNING' : 'ERROR',
  106. $error['code'],
  107. $error['message'],
  108. $error['file'],
  109. $error['line'],
  110. $error['column']
  111. );
  112. }
  113. return $errorsAsString;
  114. }
  115. private static function getSchema(string $xliffVersion): string
  116. {
  117. if ('1.2' === $xliffVersion) {
  118. $schemaSource = file_get_contents(__DIR__.'/../Resources/schemas/xliff-core-1.2-strict.xsd');
  119. $xmlUri = 'http://www.w3.org/2001/xml.xsd';
  120. } elseif ('2.0' === $xliffVersion) {
  121. $schemaSource = file_get_contents(__DIR__.'/../Resources/schemas/xliff-core-2.0.xsd');
  122. $xmlUri = 'informativeCopiesOf3rdPartySchemas/w3c/xml.xsd';
  123. } else {
  124. throw new InvalidArgumentException(sprintf('No support implemented for loading XLIFF version "%s".', $xliffVersion));
  125. }
  126. return self::fixXmlLocation($schemaSource, $xmlUri);
  127. }
  128. /**
  129. * Internally changes the URI of a dependent xsd to be loaded locally.
  130. */
  131. private static function fixXmlLocation(string $schemaSource, string $xmlUri): string
  132. {
  133. $newPath = str_replace('\\', '/', __DIR__).'/../Resources/schemas/xml.xsd';
  134. $parts = explode('/', $newPath);
  135. $locationstart = 'file:///';
  136. if (0 === stripos($newPath, 'phar://')) {
  137. $tmpfile = tempnam(sys_get_temp_dir(), 'symfony');
  138. if ($tmpfile) {
  139. copy($newPath, $tmpfile);
  140. $parts = explode('/', str_replace('\\', '/', $tmpfile));
  141. } else {
  142. array_shift($parts);
  143. $locationstart = 'phar:///';
  144. }
  145. }
  146. $drive = '\\' === \DIRECTORY_SEPARATOR ? array_shift($parts).'/' : '';
  147. $newPath = $locationstart.$drive.implode('/', array_map('rawurlencode', $parts));
  148. return str_replace($xmlUri, $newPath, $schemaSource);
  149. }
  150. /**
  151. * Returns the XML errors of the internal XML parser.
  152. */
  153. private static function getXmlErrors(bool $internalErrors): array
  154. {
  155. $errors = [];
  156. foreach (libxml_get_errors() as $error) {
  157. $errors[] = [
  158. 'level' => \LIBXML_ERR_WARNING == $error->level ? 'WARNING' : 'ERROR',
  159. 'code' => $error->code,
  160. 'message' => trim($error->message),
  161. 'file' => $error->file ?: 'n/a',
  162. 'line' => $error->line,
  163. 'column' => $error->column,
  164. ];
  165. }
  166. libxml_clear_errors();
  167. libxml_use_internal_errors($internalErrors);
  168. return $errors;
  169. }
  170. }