vendor/symfony/dependency-injection/Loader/XmlFileLoader.php line 269

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\DependencyInjection\Loader;
  14. use Symfony\Component\Config\Util\XmlUtils;
  15. use Symfony\Component\DependencyInjection\Alias;
  16. use Symfony\Component\DependencyInjection\Argument\AbstractArgument;
  17. use Symfony\Component\DependencyInjection\Argument\BoundArgument;
  18. use Symfony\Component\DependencyInjection\Argument\IteratorArgument;
  19. use Symfony\Component\DependencyInjection\Argument\ServiceClosureArgument;
  20. use Symfony\Component\DependencyInjection\Argument\ServiceLocatorArgument;
  21. use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
  22. use Symfony\Component\DependencyInjection\ChildDefinition;
  23. use Symfony\Component\DependencyInjection\ContainerBuilder;
  24. use Symfony\Component\DependencyInjection\ContainerInterface;
  25. use Symfony\Component\DependencyInjection\Definition;
  26. use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
  27. use Symfony\Component\DependencyInjection\Exception\RuntimeException;
  28. use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
  29. use Symfony\Component\DependencyInjection\Reference;
  30. use Symfony\Component\ExpressionLanguage\Expression;
  32. /**
  33.  * XmlFileLoader loads XML files service definitions.
  34.  *
  35.  * @author Fabien Potencier <fabien@symfony.com>
  36.  */
  37. class XmlFileLoader extends FileLoader
  38. {
  39.     public const NS = 'http://symfony.com/schema/dic/services';
  41.     protected $autoRegisterAliasesForSinglyImplementedInterfaces = false;
  43.     /**
  44.      * {@inheritdoc}
  45.      */
  46.     public function load($resource, string $type = null)
  47.     {
  48.         $path = $this->locator->locate($resource);
  50.         $xml = $this->parseFileToDOM($path);
  52.         $this->container->fileExists($path);
  54.         $defaults = $this->getServiceDefaults($xml, $path);
  56.         // anonymous services
  57.         $this->processAnonymousServices($xml, $path);
  59.         // imports
  60.         $this->parseImports($xml, $path);
  62.         // parameters
  63.         $this->parseParameters($xml, $path);
  65.         // extensions
  66.         $this->loadFromExtensions($xml);
  68.         // services
  69.         try {
  70.             $this->parseDefinitions($xml, $path, $defaults);
  71.         } finally {
  72.             $this->instanceof = [];
  73.             $this->registerAliasesForSinglyImplementedInterfaces();
  74.         }
  75.     }
  77.     /**
  78.      * {@inheritdoc}
  79.      */
  80.     public function supports($resource, string $type = null)
  81.     {
  82.         if (!\is_string($resource)) {
  83.             return false;
  84.         }
  86.         if (null === $type && 'xml' === pathinfo($resource, \PATHINFO_EXTENSION)) {
  87.             return true;
  88.         }
  90.         return 'xml' === $type;
  91.     }
  93.     private function parseParameters(\DOMDocument $xml, string $file)
  94.     {
  95.         if ($parameters = $this->getChildren($xml->documentElement, 'parameters')) {
  96.             $this->container->getParameterBag()->add($this->getArgumentsAsPhp($parameters[0], 'parameter', $file));
  97.         }
  98.     }
  100.     private function parseImports(\DOMDocument $xml, string $file)
  101.     {
  102.         $xpath = new \DOMXPath($xml);
  103.         $xpath->registerNamespace('container', self::NS);
  105.         if (false === $imports = $xpath->query('//container:imports/container:import')) {
  106.             return;
  107.         }
  109.         $defaultDirectory = \dirname($file);
  110.         foreach ($imports as $import) {
  111.             $this->setCurrentDir($defaultDirectory);
  112.             $this->import($import->getAttribute('resource'), XmlUtils::phpize($import->getAttribute('type')) ?: null, XmlUtils::phpize($import->getAttribute('ignore-errors')) ?: false, $file);
  113.         }
  114.     }
  116.     private function parseDefinitions(\DOMDocument $xml, string $file, Definition $defaults)
  117.     {
  118.         $xpath = new \DOMXPath($xml);
  119.         $xpath->registerNamespace('container', self::NS);
  121.         if (false === $services = $xpath->query('//container:services/container:service|//container:services/container:prototype|//container:services/container:stack')) {
  122.             return;
  123.         }
  124.         $this->setCurrentDir(\dirname($file));
  126.         $this->instanceof = [];
  127.         $this->isLoadingInstanceof = true;
  128.         $instanceof = $xpath->query('//container:services/container:instanceof');
  129.         foreach ($instanceof as $service) {
  130.             $this->setDefinition((string) $service->getAttribute('id'), $this->parseDefinition($service, $file, new Definition()));
  131.         }
  133.         $this->isLoadingInstanceof = false;
  134.         foreach ($services as $service) {
  135.             if ('stack' === $service->tagName) {
  136.                 $service->setAttribute('parent', '-');
  137.                 $definition = $this->parseDefinition($service, $file, $defaults)
  138.                     ->setTags(array_merge_recursive(['container.stack' => [[]]], $defaults->getTags()))
  139.                 ;
  140.                 $this->setDefinition($id = (string) $service->getAttribute('id'), $definition);
  141.                 $stack = [];
  143.                 foreach ($this->getChildren($service, 'service') as $k => $frame) {
  144.                     $k = $frame->getAttribute('id') ?: $k;
  145.                     $frame->setAttribute('id', $id.'" at index "'.$k);
  147.                     if ($alias = $frame->getAttribute('alias')) {
  148.                         $this->validateAlias($frame, $file);
  149.                         $stack[$k] = new Reference($alias);
  150.                     } else {
  151.                         $stack[$k] = $this->parseDefinition($frame, $file, $defaults)
  152.                             ->setInstanceofConditionals($this->instanceof);
  153.                     }
  154.                 }
  156.                 $definition->setArguments($stack);
  157.             } elseif (null !== $definition = $this->parseDefinition($service, $file, $defaults)) {
  158.                 if ('prototype' === $service->tagName) {
  159.                     $excludes = array_column($this->getChildren($service, 'exclude'), 'nodeValue');
  160.                     if ($service->hasAttribute('exclude')) {
  161.                         if (\count($excludes) > 0) {
  162.                             throw new InvalidArgumentException('You cannot use both the attribute "exclude" and <exclude> tags at the same time.');
  163.                         }
  164.                         $excludes = [$service->getAttribute('exclude')];
  165.                     }
  166.                     $this->registerClasses($definition, (string) $service->getAttribute('namespace'), (string) $service->getAttribute('resource'), $excludes);
  167.                 } else {
  168.                     $this->setDefinition((string) $service->getAttribute('id'), $definition);
  169.                 }
  170.             }
  171.         }
  172.     }
  174.     private function getServiceDefaults(\DOMDocument $xml, string $file): Definition
  175.     {
  176.         $xpath = new \DOMXPath($xml);
  177.         $xpath->registerNamespace('container', self::NS);
  179.         if (null === $defaultsNode = $xpath->query('//container:services/container:defaults')->item(0)) {
  180.             return new Definition();
  181.         }
  183.         $defaultsNode->setAttribute('id', '<defaults>');
  185.         return $this->parseDefinition($defaultsNode, $file, new Definition());
  186.     }
  188.     /**
  189.      * Parses an individual Definition.
  190.      */
  191.     private function parseDefinition(\DOMElement $service, string $file, Definition $defaults): ?Definition
  192.     {
  193.         if ($alias = $service->getAttribute('alias')) {
  194.             $this->validateAlias($service, $file);
  196.             $this->container->setAlias((string) $service->getAttribute('id'), $alias = new Alias($alias));
  197.             if ($publicAttr = $service->getAttribute('public')) {
  198.                 $alias->setPublic(XmlUtils::phpize($publicAttr));
  199.             } elseif ($defaults->getChanges()['public'] ?? false) {
  200.                 $alias->setPublic($defaults->isPublic());
  201.             }
  203.             if ($deprecated = $this->getChildren($service, 'deprecated')) {
  204.                 $message = $deprecated[0]->nodeValue ?: '';
  205.                 $package = $deprecated[0]->getAttribute('package') ?: '';
  206.                 $version = $deprecated[0]->getAttribute('version') ?: '';
  208.                 if (!$deprecated[0]->hasAttribute('package')) {
  209.                     trigger_deprecation('symfony/dependency-injection', '5.1', 'Not setting the attribute "package" of the node "deprecated" in "%s" is deprecated.', $file);
  210.                 }
  212.                 if (!$deprecated[0]->hasAttribute('version')) {
  213.                     trigger_deprecation('symfony/dependency-injection', '5.1', 'Not setting the attribute "version" of the node "deprecated" in "%s" is deprecated.', $file);
  214.                 }
  216.                 $alias->setDeprecated($package, $version, $message);
  217.             }
  219.             return null;
  220.         }
  222.         if ($this->isLoadingInstanceof) {
  223.             $definition = new ChildDefinition('');
  224.         } elseif ($parent = $service->getAttribute('parent')) {
  225.             $definition = new ChildDefinition($parent);
  226.         } else {
  227.             $definition = new Definition();
  228.         }
  230.         if ($defaults->getChanges()['public'] ?? false) {
  231.             $definition->setPublic($defaults->isPublic());
  232.         }
  233.         $definition->setAutowired($defaults->isAutowired());
  234.         $definition->setAutoconfigured($defaults->isAutoconfigured());
  235.         $definition->setChanges([]);
  237.         foreach (['class', 'public', 'shared', 'synthetic', 'abstract'] as $key) {
  238.             if ($value = $service->getAttribute($key)) {
  239.                 $method = 'set'.$key;
  240.                 $definition->$method($value = XmlUtils::phpize($value));
  241.             }
  242.         }
  244.         if ($value = $service->getAttribute('lazy')) {
  245.             $definition->setLazy((bool) $value = XmlUtils::phpize($value));
  246.             if (\is_string($value)) {
  247.                 $definition->addTag('proxy', ['interface' => $value]);
  248.             }
  249.         }
  251.         if ($value = $service->getAttribute('autowire')) {
  252.             $definition->setAutowired(XmlUtils::phpize($value));
  253.         }
  255.         if ($value = $service->getAttribute('autoconfigure')) {
  256.             $definition->setAutoconfigured(XmlUtils::phpize($value));
  257.         }
  259.         if ($files = $this->getChildren($service, 'file')) {
  260.             $definition->setFile($files[0]->nodeValue);
  261.         }
  263.         if ($deprecated = $this->getChildren($service, 'deprecated')) {
  264.             $message = $deprecated[0]->nodeValue ?: '';
  265.             $package = $deprecated[0]->getAttribute('package') ?: '';
  266.             $version = $deprecated[0]->getAttribute('version') ?: '';
  268.             if ('' === $package) {
  269.                 trigger_deprecation('symfony/dependency-injection', '5.1', 'Not setting the attribute "package" of the node "deprecated" in "%s" is deprecated.', $file);
  270.             }
  272.             if ('' === $version) {
  273.                 trigger_deprecation('symfony/dependency-injection', '5.1', 'Not setting the attribute "version" of the node "deprecated" in "%s" is deprecated.', $file);
  274.             }
  276.             $definition->setDeprecated($package, $version, $message);
  277.         }
  279.         $definition->setArguments($this->getArgumentsAsPhp($service, 'argument', $file, $definition instanceof ChildDefinition));
  280.         $definition->setProperties($this->getArgumentsAsPhp($service, 'property', $file));
  282.         if ($factories = $this->getChildren($service, 'factory')) {
  283.             $factory = $factories[0];
  284.             if ($function = $factory->getAttribute('function')) {
  285.                 $definition->setFactory($function);
  286.             } else {
  287.                 if ($childService = $factory->getAttribute('service')) {
  288.                     $class = new Reference($childService, ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE);
  289.                 } else {
  290.                     $class = $factory->hasAttribute('class') ? $factory->getAttribute('class') : null;
  291.                 }
  293.                 $definition->setFactory([$class, $factory->getAttribute('method') ?: '__invoke']);
  294.             }
  295.         }
  297.         if ($configurators = $this->getChildren($service, 'configurator')) {
  298.             $configurator = $configurators[0];
  299.             if ($function = $configurator->getAttribute('function')) {
  300.                 $definition->setConfigurator($function);
  301.             } else {
  302.                 if ($childService = $configurator->getAttribute('service')) {
  303.                     $class = new Reference($childService, ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE);
  304.                 } else {
  305.                     $class = $configurator->getAttribute('class');
  306.                 }
  308.                 $definition->setConfigurator([$class, $configurator->getAttribute('method') ?: '__invoke']);
  309.             }
  310.         }
  312.         foreach ($this->getChildren($service, 'call') as $call) {
  313.             $definition->addMethodCall($call->getAttribute('method'), $this->getArgumentsAsPhp($call, 'argument', $file), XmlUtils::phpize($call->getAttribute('returns-clone')));
  314.         }
  316.         $tags = $this->getChildren($service, 'tag');
  318.         foreach ($tags as $tag) {
  319.             $parameters = [];
  320.             $tagName = $tag->nodeValue;
  321.             foreach ($tag->attributes as $name => $node) {
  322.                 if ('name' === $name && '' === $tagName) {
  323.                     continue;
  324.                 }
  326.                 if (false !== strpos($name, '-') && false === strpos($name, '_') && !\array_key_exists($normalizedName = str_replace('-', '_', $name), $parameters)) {
  327.                     $parameters[$normalizedName] = XmlUtils::phpize($node->nodeValue);
  328.                 }
  329.                 // keep not normalized key
  330.                 $parameters[$name] = XmlUtils::phpize($node->nodeValue);
  331.             }
  333.             if ('' === $tagName && '' === $tagName = $tag->getAttribute('name')) {
  334.                 throw new InvalidArgumentException(sprintf('The tag name for service "%s" in "%s" must be a non-empty string.', (string) $service->getAttribute('id'), $file));
  335.             }
  337.             $definition->addTag($tagName, $parameters);
  338.         }
  340.         $definition->setTags(array_merge_recursive($definition->getTags(), $defaults->getTags()));
  342.         $bindings = $this->getArgumentsAsPhp($service, 'bind', $file);
  343.         $bindingType = $this->isLoadingInstanceof ? BoundArgument::INSTANCEOF_BINDING : BoundArgument::SERVICE_BINDING;
  344.         foreach ($bindings as $argument => $value) {
  345.             $bindings[$argument] = new BoundArgument($value, true, $bindingType, $file);
  346.         }
  348.         // deep clone, to avoid multiple process of the same instance in the passes
  349.         $bindings = array_merge(unserialize(serialize($defaults->getBindings())), $bindings);
  351.         if ($bindings) {
  352.             $definition->setBindings($bindings);
  353.         }
  355.         if ($decorates = $service->getAttribute('decorates')) {
  356.             $decorationOnInvalid = $service->getAttribute('decoration-on-invalid') ?: 'exception';
  357.             if ('exception' === $decorationOnInvalid) {
  358.                 $invalidBehavior = ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE;
  359.             } elseif ('ignore' === $decorationOnInvalid) {
  360.                 $invalidBehavior = ContainerInterface::IGNORE_ON_INVALID_REFERENCE;
  361.             } elseif ('null' === $decorationOnInvalid) {
  362.                 $invalidBehavior = ContainerInterface::NULL_ON_INVALID_REFERENCE;
  363.             } else {
  364.                 throw new InvalidArgumentException(sprintf('Invalid value "%s" for attribute "decoration-on-invalid" on service "%s". Did you mean "exception", "ignore" or "null" in "%s"?', $decorationOnInvalid, (string) $service->getAttribute('id'), $file));
  365.             }
  367.             $renameId = $service->hasAttribute('decoration-inner-name') ? $service->getAttribute('decoration-inner-name') : null;
  368.             $priority = $service->hasAttribute('decoration-priority') ? $service->getAttribute('decoration-priority') : 0;
  370.             $definition->setDecoratedService($decorates, $renameId, $priority, $invalidBehavior);
  371.         }
  373.         return $definition;
  374.     }
  376.     /**
  377.      * Parses an XML file to a \DOMDocument.
  378.      *
  379.      * @throws InvalidArgumentException When loading of XML file returns error
  380.      */
  381.     private function parseFileToDOM(string $file): \DOMDocument
  382.     {
  383.         try {
  384.             $dom = XmlUtils::loadFile($file, [$this, 'validateSchema']);
  385.         } catch (\InvalidArgumentException $e) {
  386.             throw new InvalidArgumentException(sprintf('Unable to parse file "%s": ', $file).$e->getMessage(), $e->getCode(), $e);
  387.         }
  389.         $this->validateExtensions($dom, $file);
  391.         return $dom;
  392.     }
  394.     /**
  395.      * Processes anonymous services.
  396.      */
  397.     private function processAnonymousServices(\DOMDocument $xml, string $file)
  398.     {
  399.         $definitions = [];
  400.         $count = 0;
  401.         $suffix = '~'.ContainerBuilder::hash($file);
  403.         $xpath = new \DOMXPath($xml);
  404.         $xpath->registerNamespace('container', self::NS);
  406.         // anonymous services as arguments/properties
  407.         if (false !== $nodes = $xpath->query('//container:argument[@type="service"][not(@id)]|//container:property[@type="service"][not(@id)]|//container:bind[not(@id)]|//container:factory[not(@service)]|//container:configurator[not(@service)]')) {
  408.             foreach ($nodes as $node) {
  409.                 if ($services = $this->getChildren($node, 'service')) {
  410.                     // give it a unique name
  411.                     $id = sprintf('.%d_%s', ++$count, preg_replace('/^.*\\\\/', '', $services[0]->getAttribute('class')).$suffix);
  412.                     $node->setAttribute('id', $id);
  413.                     $node->setAttribute('service', $id);
  415.                     $definitions[$id] = [$services[0], $file];
  416.                     $services[0]->setAttribute('id', $id);
  418.                     // anonymous services are always private
  419.                     // we could not use the constant false here, because of XML parsing
  420.                     $services[0]->setAttribute('public', 'false');
  421.                 }
  422.             }
  423.         }
  425.         // anonymous services "in the wild"
  426.         if (false !== $nodes = $xpath->query('//container:services/container:service[not(@id)]')) {
  427.             foreach ($nodes as $node) {
  428.                 throw new InvalidArgumentException(sprintf('Top-level services must have "id" attribute, none found in "%s" at line %d.', $file, $node->getLineNo()));
  429.             }
  430.         }
  432.         // resolve definitions
  433.         uksort($definitions, 'strnatcmp');
  434.         foreach (array_reverse($definitions) as $id => [$domElement, $file]) {
  435.             if (null !== $definition = $this->parseDefinition($domElement, $file, new Definition())) {
  436.                 $this->setDefinition($id, $definition);
  437.             }
  438.         }
  439.     }
  441.     private function getArgumentsAsPhp(\DOMElement $node, string $name, string $file, bool $isChildDefinition = false): array
  442.     {
  443.         $arguments = [];
  444.         foreach ($this->getChildren($node, $name) as $arg) {
  445.             if ($arg->hasAttribute('name')) {
  446.                 $arg->setAttribute('key', $arg->getAttribute('name'));
  447.             }
  449.             // this is used by ChildDefinition to overwrite a specific
  450.             // argument of the parent definition
  451.             if ($arg->hasAttribute('index')) {
  452.                 $key = ($isChildDefinition ? 'index_' : '').$arg->getAttribute('index');
  453.             } elseif (!$arg->hasAttribute('key')) {
  454.                 // Append an empty argument, then fetch its key to overwrite it later
  455.                 $arguments[] = null;
  456.                 $keys = array_keys($arguments);
  457.                 $key = array_pop($keys);
  458.             } else {
  459.                 $key = $arg->getAttribute('key');
  460.             }
  462.             $onInvalid = $arg->getAttribute('on-invalid');
  463.             $invalidBehavior = ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE;
  464.             if ('ignore' == $onInvalid) {
  465.                 $invalidBehavior = ContainerInterface::IGNORE_ON_INVALID_REFERENCE;
  466.             } elseif ('ignore_uninitialized' == $onInvalid) {
  467.                 $invalidBehavior = ContainerInterface::IGNORE_ON_UNINITIALIZED_REFERENCE;
  468.             } elseif ('null' == $onInvalid) {
  469.                 $invalidBehavior = ContainerInterface::NULL_ON_INVALID_REFERENCE;
  470.             }
  472.             switch ($arg->getAttribute('type')) {
  473.                 case 'service':
  474.                     if ('' === $arg->getAttribute('id')) {
  475.                         throw new InvalidArgumentException(sprintf('Tag "<%s>" with type="service" has no or empty "id" attribute in "%s".', $name, $file));
  476.                     }
  478.                     $arguments[$key] = new Reference($arg->getAttribute('id'), $invalidBehavior);
  479.                     break;
  480.                 case 'expression':
  481.                     if (!class_exists(Expression::class)) {
  482.                         throw new \LogicException('The type="expression" attribute cannot be used without the ExpressionLanguage component. Try running "composer require symfony/expression-language".');
  483.                     }
  485.                     $arguments[$key] = new Expression($arg->nodeValue);
  486.                     break;
  487.                 case 'collection':
  488.                     $arguments[$key] = $this->getArgumentsAsPhp($arg, $name, $file);
  489.                     break;
  490.                 case 'iterator':
  491.                     $arg = $this->getArgumentsAsPhp($arg, $name, $file);
  492.                     try {
  493.                         $arguments[$key] = new IteratorArgument($arg);
  494.                     } catch (InvalidArgumentException $e) {
  495.                         throw new InvalidArgumentException(sprintf('Tag "<%s>" with type="iterator" only accepts collections of type="service" references in "%s".', $name, $file));
  496.                     }
  497.                     break;
  498.                 case 'service_closure':
  499.                     if ('' === $arg->getAttribute('id')) {
  500.                         throw new InvalidArgumentException(sprintf('Tag "<%s>" with type="service_closure" has no or empty "id" attribute in "%s".', $name, $file));
  501.                     }
  503.                     $arguments[$key] = new ServiceClosureArgument(new Reference($arg->getAttribute('id'), $invalidBehavior));
  504.                     break;
  505.                 case 'service_locator':
  506.                     $arg = $this->getArgumentsAsPhp($arg, $name, $file);
  507.                     try {
  508.                         $arguments[$key] = new ServiceLocatorArgument($arg);
  509.                     } catch (InvalidArgumentException $e) {
  510.                         throw new InvalidArgumentException(sprintf('Tag "<%s>" with type="service_locator" only accepts maps of type="service" references in "%s".', $name, $file));
  511.                     }
  512.                     break;
  513.                 case 'tagged':
  514.                 case 'tagged_iterator':
  515.                 case 'tagged_locator':
  516.                     $type = $arg->getAttribute('type');
  517.                     $forLocator = 'tagged_locator' === $type;
  519.                     if (!$arg->getAttribute('tag')) {
  520.                         throw new InvalidArgumentException(sprintf('Tag "<%s>" with type="%s" has no or empty "tag" attribute in "%s".', $name, $type, $file));
  521.                     }
  523.                     $arguments[$key] = new TaggedIteratorArgument($arg->getAttribute('tag'), $arg->getAttribute('index-by') ?: null, $arg->getAttribute('default-index-method') ?: null, $forLocator, $arg->getAttribute('default-priority-method') ?: null);
  525.                     if ($forLocator) {
  526.                         $arguments[$key] = new ServiceLocatorArgument($arguments[$key]);
  527.                     }
  528.                     break;
  529.                 case 'binary':
  530.                     if (false === $value = base64_decode($arg->nodeValue)) {
  531.                         throw new InvalidArgumentException(sprintf('Tag "<%s>" with type="binary" is not a valid base64 encoded string.', $name));
  532.                     }
  533.                     $arguments[$key] = $value;
  534.                     break;
  535.                 case 'abstract':
  536.                     $arguments[$key] = new AbstractArgument($arg->nodeValue);
  537.                     break;
  538.                 case 'string':
  539.                     $arguments[$key] = $arg->nodeValue;
  540.                     break;
  541.                 case 'constant':
  542.                     $arguments[$key] = \constant(trim($arg->nodeValue));
  543.                     break;
  544.                 default:
  545.                     $arguments[$key] = XmlUtils::phpize($arg->nodeValue);
  546.             }
  547.         }
  549.         return $arguments;
  550.     }
  552.     /**
  553.      * Get child elements by name.
  554.      *
  555.      * @return \DOMElement[]
  556.      */
  557.     private function getChildren(\DOMNode $node, string $name): array
  558.     {
  559.         $children = [];
  560.         foreach ($node->childNodes as $child) {
  561.             if ($child instanceof \DOMElement && $child->localName === $name && self::NS === $child->namespaceURI) {
  562.                 $children[] = $child;
  563.             }
  564.         }
  566.         return $children;
  567.     }
  569.     /**
  570.      * Validates a documents XML schema.
  571.      *
  572.      * @return bool
  573.      *
  574.      * @throws RuntimeException When extension references a non-existent XSD file
  575.      */
  576.     public function validateSchema(\DOMDocument $dom)
  577.     {
  578.         $schemaLocations = ['http://symfony.com/schema/dic/services' => str_replace('\\', '/', __DIR__.'/schema/dic/services/services-1.0.xsd')];
  580.         if ($element = $dom->documentElement->getAttributeNS('http://www.w3.org/2001/XMLSchema-instance', 'schemaLocation')) {
  581.             $items = preg_split('/\s+/', $element);
  582.             for ($i = 0, $nb = \count($items); $i < $nb; $i += 2) {
  583.                 if (!$this->container->hasExtension($items[$i])) {
  584.                     continue;
  585.                 }
  587.                 if (($extension = $this->container->getExtension($items[$i])) && false !== $extension->getXsdValidationBasePath()) {
  588.                     $ns = $extension->getNamespace();
  589.                     $path = str_replace([$ns, str_replace('http://', 'https://', $ns)], str_replace('\\', '/', $extension->getXsdValidationBasePath()).'/', $items[$i + 1]);
  591.                     if (!is_file($path)) {
  592.                         throw new RuntimeException(sprintf('Extension "%s" references a non-existent XSD file "%s".', get_debug_type($extension), $path));
  593.                     }
  595.                     $schemaLocations[$items[$i]] = $path;
  596.                 }
  597.             }
  598.         }
  600.         $tmpfiles = [];
  601.         $imports = '';
  602.         foreach ($schemaLocations as $namespace => $location) {
  603.             $parts = explode('/', $location);
  604.             $locationstart = 'file:///';
  605.             if (0 === stripos($location, 'phar://')) {
  606.                 $tmpfile = tempnam(sys_get_temp_dir(), 'symfony');
  607.                 if ($tmpfile) {
  608.                     copy($location, $tmpfile);
  609.                     $tmpfiles[] = $tmpfile;
  610.                     $parts = explode('/', str_replace('\\', '/', $tmpfile));
  611.                 } else {
  612.                     array_shift($parts);
  613.                     $locationstart = 'phar:///';
  614.                 }
  615.             } elseif ('\\' === \DIRECTORY_SEPARATOR && 0 === strpos($location, '\\\\')) {
  616.                 $locationstart = '';
  617.             }
  618.             $drive = '\\' === \DIRECTORY_SEPARATOR ? array_shift($parts).'/' : '';
  619.             $location = $locationstart.$drive.implode('/', array_map('rawurlencode', $parts));
  621.             $imports .= sprintf('  <xsd:import namespace="%s" schemaLocation="%s" />'."\n", $namespace, $location);
  622.         }
  624.         $source = <<<EOF
  625. <?xml version="1.0" encoding="utf-8" ?>
  626. <xsd:schema xmlns="http://symfony.com/schema"
  627.     xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  628.     targetNamespace="http://symfony.com/schema"
  629.     elementFormDefault="qualified">
  631.     <xsd:import namespace="http://www.w3.org/XML/1998/namespace"/>
  632. $imports
  633. </xsd:schema>
  634. EOF
  635.         ;
  637.         if ($this->shouldEnableEntityLoader()) {
  638.             $disableEntities = libxml_disable_entity_loader(false);
  639.             $valid = @$dom->schemaValidateSource($source);
  640.             libxml_disable_entity_loader($disableEntities);
  641.         } else {
  642.             $valid = @$dom->schemaValidateSource($source);
  643.         }
  644.         foreach ($tmpfiles as $tmpfile) {
  645.             @unlink($tmpfile);
  646.         }
  648.         return $valid;
  649.     }
  651.     private function shouldEnableEntityLoader(): bool
  652.     {
  653.         // Version prior to 8.0 can be enabled without deprecation
  654.         if (\PHP_VERSION_ID < 80000) {
  655.             return true;
  656.         }
  658.         static $dom, $schema;
  659.         if (null === $dom) {
  660.             $dom = new \DOMDocument();
  661.             $dom->loadXML('<?xml version="1.0"?><test/>');
  663.             $tmpfile = tempnam(sys_get_temp_dir(), 'symfony');
  664.             register_shutdown_function(static function () use ($tmpfile) {
  665.                 @unlink($tmpfile);
  666.             });
  667.             $schema = '<?xml version="1.0" encoding="utf-8"?>
  668. <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  669.   <xsd:include schemaLocation="file:///'.str_replace('\\', '/', $tmpfile).'" />
  670. </xsd:schema>';
  671.             file_put_contents($tmpfile, '<?xml version="1.0" encoding="utf-8"?>
  672. <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  673.   <xsd:element name="test" type="testType" />
  674.   <xsd:complexType name="testType"/>
  675. </xsd:schema>');
  676.         }
  678.         return !@$dom->schemaValidateSource($schema);
  679.     }
  681.     private function validateAlias(\DOMElement $alias, string $file)
  682.     {
  683.         foreach ($alias->attributes as $name => $node) {
  684.             if (!\in_array($name, ['alias', 'id', 'public'])) {
  685.                 throw new InvalidArgumentException(sprintf('Invalid attribute "%s" defined for alias "%s" in "%s".', $name, $alias->getAttribute('id'), $file));
  686.             }
  687.         }
  689.         foreach ($alias->childNodes as $child) {
  690.             if (!$child instanceof \DOMElement || self::NS !== $child->namespaceURI) {
  691.                 continue;
  692.             }
  693.             if (!\in_array($child->localName, ['deprecated'], true)) {
  694.                 throw new InvalidArgumentException(sprintf('Invalid child element "%s" defined for alias "%s" in "%s".', $child->localName, $alias->getAttribute('id'), $file));
  695.             }
  696.         }
  697.     }
  699.     /**
  700.      * Validates an extension.
  701.      *
  702.      * @throws InvalidArgumentException When no extension is found corresponding to a tag
  703.      */
  704.     private function validateExtensions(\DOMDocument $dom, string $file)
  705.     {
  706.         foreach ($dom->documentElement->childNodes as $node) {
  707.             if (!$node instanceof \DOMElement || 'http://symfony.com/schema/dic/services' === $node->namespaceURI) {
  708.                 continue;
  709.             }
  711.             // can it be handled by an extension?
  712.             if (!$this->container->hasExtension($node->namespaceURI)) {
  713.                 $extensionNamespaces = array_filter(array_map(function (ExtensionInterface $ext) { return $ext->getNamespace(); }, $this->container->getExtensions()));
  714.                 throw new InvalidArgumentException(sprintf('There is no extension able to load the configuration for "%s" (in "%s"). Looked for namespace "%s", found "%s".', $node->tagName, $file, $node->namespaceURI, $extensionNamespaces ? implode('", "', $extensionNamespaces) : 'none'));
  715.             }
  716.         }
  717.     }
  719.     /**
  720.      * Loads from an extension.
  721.      */
  722.     private function loadFromExtensions(\DOMDocument $xml)
  723.     {
  724.         foreach ($xml->documentElement->childNodes as $node) {
  725.             if (!$node instanceof \DOMElement || self::NS === $node->namespaceURI) {
  726.                 continue;
  727.             }
  729.             $values = static::convertDomElementToArray($node);
  730.             if (!\is_array($values)) {
  731.                 $values = [];
  732.             }
  734.             $this->container->loadFromExtension($node->namespaceURI, $values);
  735.         }
  736.     }
  738.     /**
  739.      * Converts a \DOMElement object to a PHP array.
  740.      *
  741.      * The following rules applies during the conversion:
  742.      *
  743.      *  * Each tag is converted to a key value or an array
  744.      *    if there is more than one "value"
  745.      *
  746.      *  * The content of a tag is set under a "value" key (<foo>bar</foo>)
  747.      *    if the tag also has some nested tags
  748.      *
  749.      *  * The attributes are converted to keys (<foo foo="bar"/>)
  750.      *
  751.      *  * The nested-tags are converted to keys (<foo><foo>bar</foo></foo>)
  752.      *
  753.      * @param \DOMElement $element A \DOMElement instance
  754.      *
  755.      * @return mixed
  756.      */
  757.     public static function convertDomElementToArray(\DOMElement $element)
  758.     {
  759.         return XmlUtils::convertDomElementToArray($element);
  760.     }
  761. }