vendor/symfony/config/Util/XmlUtils.php line 45

  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\Config\Util;
  14. use Symfony\Component\Config\Util\Exception\InvalidXmlException;
  15. use Symfony\Component\Config\Util\Exception\XmlParsingException;
  17. /**
  18.  * XMLUtils is a bunch of utility methods to XML operations.
  19.  *
  20.  * This class contains static methods only and is not meant to be instantiated.
  21.  *
  22.  * @author Fabien Potencier <fabien@symfony.com>
  23.  * @author Martin Hasoň <martin.hason@gmail.com>
  24.  * @author Ole Rößner <ole@roessner.it>
  25.  */
  26. class XmlUtils
  27. {
  28.     /**
  29.      * This class should not be instantiated.
  30.      */
  31.     private function __construct()
  32.     {
  33.     }
  35.     /**
  36.      * Parses an XML string.
  37.      *
  38.      * @param string               $content          An XML string
  39.      * @param string|callable|null $schemaOrCallable An XSD schema file path, a callable, or null to disable validation
  40.      *
  41.      * @throws XmlParsingException When parsing of XML file returns error
  42.      * @throws InvalidXmlException When parsing of XML with schema or callable produces any errors unrelated to the XML parsing itself
  43.      * @throws \RuntimeException   When DOM extension is missing
  44.      */
  45.     public static function parse(string $content, string|callable $schemaOrCallable = null): \DOMDocument
  46.     {
  47.         if (!\extension_loaded('dom')) {
  48.             throw new \LogicException('Extension DOM is required.');
  49.         }
  51.         $internalErrors = libxml_use_internal_errors(true);
  52.         libxml_clear_errors();
  54.         $dom = new \DOMDocument();
  55.         $dom->validateOnParse = true;
  56.         if (!$dom->loadXML($content, \LIBXML_NONET | \LIBXML_COMPACT)) {
  57.             throw new XmlParsingException(implode("\n", static::getXmlErrors($internalErrors)));
  58.         }
  60.         $dom->normalizeDocument();
  62.         libxml_use_internal_errors($internalErrors);
  64.         foreach ($dom->childNodes as $child) {
  65.             if (\XML_DOCUMENT_TYPE_NODE === $child->nodeType) {
  66.                 throw new XmlParsingException('Document types are not allowed.');
  67.             }
  68.         }
  70.         if (null !== $schemaOrCallable) {
  71.             $internalErrors = libxml_use_internal_errors(true);
  72.             libxml_clear_errors();
  74.             $e = null;
  75.             if (\is_callable($schemaOrCallable)) {
  76.                 try {
  77.                     $valid = $schemaOrCallable($dom, $internalErrors);
  78.                 } catch (\Exception $e) {
  79.                     $valid = false;
  80.                 }
  81.             } elseif (is_file($schemaOrCallable)) {
  82.                 $schemaSource = file_get_contents((string) $schemaOrCallable);
  83.                 $valid = @$dom->schemaValidateSource($schemaSource);
  84.             } else {
  85.                 libxml_use_internal_errors($internalErrors);
  87.                 throw new XmlParsingException(sprintf('Invalid XSD file: "%s".', $schemaOrCallable));
  88.             }
  90.             if (!$valid) {
  91.                 $messages = static::getXmlErrors($internalErrors);
  92.                 if (!$messages) {
  93.                     throw new InvalidXmlException('The XML is not valid.', 0, $e);
  94.                 }
  95.                 throw new XmlParsingException(implode("\n", $messages), 0, $e);
  96.             }
  97.         }
  99.         libxml_clear_errors();
  100.         libxml_use_internal_errors($internalErrors);
  102.         return $dom;
  103.     }
  105.     /**
  106.      * Loads an XML file.
  107.      *
  108.      * @param string               $file             An XML file path
  109.      * @param string|callable|null $schemaOrCallable An XSD schema file path, a callable, or null to disable validation
  110.      *
  111.      * @throws \InvalidArgumentException When loading of XML file returns error
  112.      * @throws XmlParsingException       When XML parsing returns any errors
  113.      * @throws \RuntimeException         When DOM extension is missing
  114.      */
  115.     public static function loadFile(string $file, string|callable $schemaOrCallable = null): \DOMDocument
  116.     {
  117.         if (!is_file($file)) {
  118.             throw new \InvalidArgumentException(sprintf('Resource "%s" is not a file.', $file));
  119.         }
  121.         if (!is_readable($file)) {
  122.             throw new \InvalidArgumentException(sprintf('File "%s" is not readable.', $file));
  123.         }
  125.         $content = @file_get_contents($file);
  127.         if ('' === trim($content)) {
  128.             throw new \InvalidArgumentException(sprintf('File "%s" does not contain valid XML, it is empty.', $file));
  129.         }
  131.         try {
  132.             return static::parse($content, $schemaOrCallable);
  133.         } catch (InvalidXmlException $e) {
  134.             throw new XmlParsingException(sprintf('The XML file "%s" is not valid.', $file), 0, $e->getPrevious());
  135.         }
  136.     }
  138.     /**
  139.      * Converts a \DOMElement object to a PHP array.
  140.      *
  141.      * The following rules applies during the conversion:
  142.      *
  143.      *  * Each tag is converted to a key value or an array
  144.      *    if there is more than one "value"
  145.      *
  146.      *  * The content of a tag is set under a "value" key (<foo>bar</foo>)
  147.      *    if the tag also has some nested tags
  148.      *
  149.      *  * The attributes are converted to keys (<foo foo="bar"/>)
  150.      *
  151.      *  * The nested-tags are converted to keys (<foo><foo>bar</foo></foo>)
  152.      *
  153.      * @param \DOMElement $element     A \DOMElement instance
  154.      * @param bool        $checkPrefix Check prefix in an element or an attribute name
  155.      */
  156.     public static function convertDomElementToArray(\DOMElement $element, bool $checkPrefix = true): mixed
  157.     {
  158.         $prefix = (string) $element->prefix;
  159.         $empty = true;
  160.         $config = [];
  161.         foreach ($element->attributes as $name => $node) {
  162.             if ($checkPrefix && !\in_array((string) $node->prefix, ['', $prefix], true)) {
  163.                 continue;
  164.             }
  165.             $config[$name] = static::phpize($node->value);
  166.             $empty = false;
  167.         }
  169.         $nodeValue = false;
  170.         foreach ($element->childNodes as $node) {
  171.             if ($node instanceof \DOMText) {
  172.                 if ('' !== trim($node->nodeValue)) {
  173.                     $nodeValue = trim($node->nodeValue);
  174.                     $empty = false;
  175.                 }
  176.             } elseif ($checkPrefix && $prefix != (string) $node->prefix) {
  177.                 continue;
  178.             } elseif (!$node instanceof \DOMComment) {
  179.                 $value = static::convertDomElementToArray($node, $checkPrefix);
  181.                 $key = $node->localName;
  182.                 if (isset($config[$key])) {
  183.                     if (!\is_array($config[$key]) || !\is_int(key($config[$key]))) {
  184.                         $config[$key] = [$config[$key]];
  185.                     }
  186.                     $config[$key][] = $value;
  187.                 } else {
  188.                     $config[$key] = $value;
  189.                 }
  191.                 $empty = false;
  192.             }
  193.         }
  195.         if (false !== $nodeValue) {
  196.             $value = static::phpize($nodeValue);
  197.             if (\count($config)) {
  198.                 $config['value'] = $value;
  199.             } else {
  200.                 $config = $value;
  201.             }
  202.         }
  204.         return !$empty ? $config : null;
  205.     }
  207.     /**
  208.      * Converts an xml value to a PHP type.
  209.      */
  210.     public static function phpize(string|\Stringable $value): mixed
  211.     {
  212.         $value = (string) $value;
  213.         $lowercaseValue = strtolower($value);
  215.         switch (true) {
  216.             case 'null' === $lowercaseValue:
  217.                 return null;
  218.             case ctype_digit($value):
  219.             case isset($value[1]) && '-' === $value[0] && ctype_digit(substr($value, 1)):
  220.                 $raw = $value;
  221.                 $cast = (int) $value;
  223.                 return self::isOctal($value) ? \intval($value, 8) : (($raw === (string) $cast) ? $cast : $raw);
  224.             case 'true' === $lowercaseValue:
  225.                 return true;
  226.             case 'false' === $lowercaseValue:
  227.                 return false;
  228.             case isset($value[1]) && '0b' == $value[0].$value[1] && preg_match('/^0b[01]*$/', $value):
  229.                 return bindec($value);
  230.             case is_numeric($value):
  231.                 return '0x' === $value[0].$value[1] ? hexdec($value) : (float) $value;
  232.             case preg_match('/^0x[0-9a-f]++$/i', $value):
  233.                 return hexdec($value);
  234.             case preg_match('/^[+-]?[0-9]+(\.[0-9]+)?$/', $value):
  235.                 return (float) $value;
  236.             default:
  237.                 return $value;
  238.         }
  239.     }
  241.     protected static function getXmlErrors(bool $internalErrors)
  242.     {
  243.         $errors = [];
  244.         foreach (libxml_get_errors() as $error) {
  245.             $errors[] = sprintf('[%s %s] %s (in %s - line %d, column %d)',
  246.                 \LIBXML_ERR_WARNING == $error->level ? 'WARNING' : 'ERROR',
  247.                 $error->code,
  248.                 trim($error->message),
  249.                 $error->file ?: 'n/a',
  250.                 $error->line,
  251.                 $error->column
  252.             );
  253.         }
  255.         libxml_clear_errors();
  256.         libxml_use_internal_errors($internalErrors);
  258.         return $errors;
  259.     }
  261.     private static function isOctal(string $str): bool
  262.     {
  263.         if ('-' === $str[0]) {
  264.             $str = substr($str, 1);
  265.         }
  267.         return $str === '0'.decoct(\intval($str, 8));
  268.     }
  269. }