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

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