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

  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.     public function load(mixed $resource, string $type = null): mixed
  44.     {
  45.         $path = $this->locator->locate($resource);
  47.         $xml = $this->parseFileToDOM($path);
  49.         $this->container->fileExists($path);
  51.         $this->loadXml($xml, $path);
  53.         if ($this->env) {
  54.             $xpath = new \DOMXPath($xml);
  55.             $xpath->registerNamespace('container', self::NS);
  56.             foreach ($xpath->query(sprintf('//container:when[@env="%s"]', $this->env)) ?: [] as $root) {
  57.                 $env = $this->env;
  58.                 $this->env = null;
  59.                 try {
  60.                     $this->loadXml($xml, $path, $root);
  61.                 } finally {
  62.                     $this->env = $env;
  63.                 }
  64.             }
  65.         }
  67.         return null;
  68.     }
  70.     private function loadXml(\DOMDocument $xml, string $path, \DOMNode $root = null): void
  71.     {
  72.         $defaults = $this->getServiceDefaults($xml, $path, $root);
  74.         // anonymous services
  75.         $this->processAnonymousServices($xml, $path, $root);
  77.         // imports
  78.         $this->parseImports($xml, $path, $root);
  80.         // parameters
  81.         $this->parseParameters($xml, $path, $root);
  83.         // extensions
  84.         $this->loadFromExtensions($xml, $root);
  86.         // services
  87.         try {
  88.             $this->parseDefinitions($xml, $path, $defaults, $root);
  89.         } finally {
  90.             $this->instanceof = [];
  91.             $this->registerAliasesForSinglyImplementedInterfaces();
  92.         }
  93.     }
  95.     public function supports(mixed $resource, string $type = null): bool
  96.     {
  97.         if (!\is_string($resource)) {
  98.             return false;
  99.         }
  101.         if (null === $type && 'xml' === pathinfo($resource, \PATHINFO_EXTENSION)) {
  102.             return true;
  103.         }
  105.         return 'xml' === $type;
  106.     }
  108.     private function parseParameters(\DOMDocument $xml, string $file, \DOMNode $root = null)
  109.     {
  110.         if ($parameters = $this->getChildren($root ?? $xml->documentElement, 'parameters')) {
  111.             $this->container->getParameterBag()->add($this->getArgumentsAsPhp($parameters[0], 'parameter', $file));
  112.         }
  113.     }
  115.     private function parseImports(\DOMDocument $xml, string $file, \DOMNode $root = null)
  116.     {
  117.         $xpath = new \DOMXPath($xml);
  118.         $xpath->registerNamespace('container', self::NS);
  120.         if (false === $imports = $xpath->query('.//container:imports/container:import', $root)) {
  121.             return;
  122.         }
  124.         $defaultDirectory = \dirname($file);
  125.         foreach ($imports as $import) {
  126.             $this->setCurrentDir($defaultDirectory);
  127.             $this->import($import->getAttribute('resource'), XmlUtils::phpize($import->getAttribute('type')) ?: null, XmlUtils::phpize($import->getAttribute('ignore-errors')) ?: false, $file);
  128.         }
  129.     }
  131.     private function parseDefinitions(\DOMDocument $xml, string $file, Definition $defaults, \DOMNode $root = null)
  132.     {
  133.         $xpath = new \DOMXPath($xml);
  134.         $xpath->registerNamespace('container', self::NS);
  136.         if (false === $services = $xpath->query('.//container:services/container:service|.//container:services/container:prototype|.//container:services/container:stack', $root)) {
  137.             return;
  138.         }
  139.         $this->setCurrentDir(\dirname($file));
  141.         $this->instanceof = [];
  142.         $this->isLoadingInstanceof = true;
  143.         $instanceof = $xpath->query('.//container:services/container:instanceof', $root);
  144.         foreach ($instanceof as $service) {
  145.             $this->setDefinition((string) $service->getAttribute('id'), $this->parseDefinition($service, $file, new Definition()));
  146.         }
  148.         $this->isLoadingInstanceof = false;
  149.         foreach ($services as $service) {
  150.             if ('stack' === $service->tagName) {
  151.                 $service->setAttribute('parent', '-');
  152.                 $definition = $this->parseDefinition($service, $file, $defaults)
  153.                     ->setTags(array_merge_recursive(['container.stack' => [[]]], $defaults->getTags()))
  154.                 ;
  155.                 $this->setDefinition($id = (string) $service->getAttribute('id'), $definition);
  156.                 $stack = [];
  158.                 foreach ($this->getChildren($service, 'service') as $k => $frame) {
  159.                     $k = $frame->getAttribute('id') ?: $k;
  160.                     $frame->setAttribute('id', $id.'" at index "'.$k);
  162.                     if ($alias = $frame->getAttribute('alias')) {
  163.                         $this->validateAlias($frame, $file);
  164.                         $stack[$k] = new Reference($alias);
  165.                     } else {
  166.                         $stack[$k] = $this->parseDefinition($frame, $file, $defaults)
  167.                             ->setInstanceofConditionals($this->instanceof);
  168.                     }
  169.                 }
  171.                 $definition->setArguments($stack);
  172.             } elseif (null !== $definition = $this->parseDefinition($service, $file, $defaults)) {
  173.                 if ('prototype' === $service->tagName) {
  174.                     $excludes = array_column($this->getChildren($service, 'exclude'), 'nodeValue');
  175.                     if ($service->hasAttribute('exclude')) {
  176.                         if (\count($excludes) > 0) {
  177.                             throw new InvalidArgumentException('You cannot use both the attribute "exclude" and <exclude> tags at the same time.');
  178.                         }
  179.                         $excludes = [$service->getAttribute('exclude')];
  180.                     }
  181.                     $this->registerClasses($definition, (string) $service->getAttribute('namespace'), (string) $service->getAttribute('resource'), $excludes, $file);
  182.                 } else {
  183.                     $this->setDefinition((string) $service->getAttribute('id'), $definition);
  184.                 }
  185.             }
  186.         }
  187.     }
  189.     private function getServiceDefaults(\DOMDocument $xml, string $file, \DOMNode $root = null): Definition
  190.     {
  191.         $xpath = new \DOMXPath($xml);
  192.         $xpath->registerNamespace('container', self::NS);
  194.         if (null === $defaultsNode = $xpath->query('.//container:services/container:defaults', $root)->item(0)) {
  195.             return new Definition();
  196.         }
  198.         $defaultsNode->setAttribute('id', '<defaults>');
  200.         return $this->parseDefinition($defaultsNode, $file, new Definition());
  201.     }
  203.     /**
  204.      * Parses an individual Definition.
  205.      */
  206.     private function parseDefinition(\DOMElement $service, string $file, Definition $defaults): ?Definition
  207.     {
  208.         if ($alias = $service->getAttribute('alias')) {
  209.             $this->validateAlias($service, $file);
  211.             $this->container->setAlias($service->getAttribute('id'), $alias = new Alias($alias));
  212.             if ($publicAttr = $service->getAttribute('public')) {
  213.                 $alias->setPublic(XmlUtils::phpize($publicAttr));
  214.             } elseif ($defaults->getChanges()['public'] ?? false) {
  215.                 $alias->setPublic($defaults->isPublic());
  216.             }
  218.             if ($deprecated = $this->getChildren($service, 'deprecated')) {
  219.                 $message = $deprecated[0]->nodeValue ?: '';
  220.                 $package = $deprecated[0]->getAttribute('package') ?: '';
  221.                 $version = $deprecated[0]->getAttribute('version') ?: '';
  223.                 if (!$deprecated[0]->hasAttribute('package')) {
  224.                     throw new InvalidArgumentException(sprintf('Missing attribute "package" at node "deprecated" in "%s".', $file));
  225.                 }
  227.                 if (!$deprecated[0]->hasAttribute('version')) {
  228.                     throw new InvalidArgumentException(sprintf('Missing attribute "version" at node "deprecated" in "%s".', $file));
  229.                 }
  231.                 $alias->setDeprecated($package, $version, $message);
  232.             }
  234.             return null;
  235.         }
  237.         if ($this->isLoadingInstanceof) {
  238.             $definition = new ChildDefinition('');
  239.         } elseif ($parent = $service->getAttribute('parent')) {
  240.             $definition = new ChildDefinition($parent);
  241.         } else {
  242.             $definition = new Definition();
  243.         }
  245.         if ($defaults->getChanges()['public'] ?? false) {
  246.             $definition->setPublic($defaults->isPublic());
  247.         }
  248.         $definition->setAutowired($defaults->isAutowired());
  249.         $definition->setAutoconfigured($defaults->isAutoconfigured());
  250.         $definition->setChanges([]);
  252.         foreach (['class', 'public', 'shared', 'synthetic', 'abstract'] as $key) {
  253.             if ($value = $service->getAttribute($key)) {
  254.                 $method = 'set'.$key;
  255.                 $definition->$method($value = XmlUtils::phpize($value));
  256.             }
  257.         }
  259.         if ($value = $service->getAttribute('lazy')) {
  260.             $definition->setLazy((bool) $value = XmlUtils::phpize($value));
  261.             if (\is_string($value)) {
  262.                 $definition->addTag('proxy', ['interface' => $value]);
  263.             }
  264.         }
  266.         if ($value = $service->getAttribute('autowire')) {
  267.             $definition->setAutowired(XmlUtils::phpize($value));
  268.         }
  270.         if ($value = $service->getAttribute('autoconfigure')) {
  271.             $definition->setAutoconfigured(XmlUtils::phpize($value));
  272.         }
  274.         if ($files = $this->getChildren($service, 'file')) {
  275.             $definition->setFile($files[0]->nodeValue);
  276.         }
  278.         if ($deprecated = $this->getChildren($service, 'deprecated')) {
  279.             $message = $deprecated[0]->nodeValue ?: '';
  280.             $package = $deprecated[0]->getAttribute('package') ?: '';
  281.             $version = $deprecated[0]->getAttribute('version') ?: '';
  283.             if (!$deprecated[0]->hasAttribute('package')) {
  284.                 throw new InvalidArgumentException(sprintf('Missing attribute "package" at node "deprecated" in "%s".', $file));
  285.             }
  287.             if (!$deprecated[0]->hasAttribute('version')) {
  288.                 throw new InvalidArgumentException(sprintf('Missing attribute "version" at node "deprecated" in "%s".', $file));
  289.             }
  291.             $definition->setDeprecated($package, $version, $message);
  292.         }
  294.         $definition->setArguments($this->getArgumentsAsPhp($service, 'argument', $file, $definition instanceof ChildDefinition));
  295.         $definition->setProperties($this->getArgumentsAsPhp($service, 'property', $file));
  297.         if ($factories = $this->getChildren($service, 'factory')) {
  298.             $factory = $factories[0];
  299.             if ($function = $factory->getAttribute('function')) {
  300.                 $definition->setFactory($function);
  301.             } elseif ($expression = $factory->getAttribute('expression')) {
  302.                 if (!class_exists(Expression::class)) {
  303.                     throw new \LogicException('The "expression" attribute cannot be used on factories without the ExpressionLanguage component. Try running "composer require symfony/expression-language".');
  304.                 }
  305.                 $definition->setFactory('@='.$expression);
  306.             } else {
  307.                 if ($childService = $factory->getAttribute('service')) {
  308.                     $class = new Reference($childService, ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE);
  309.                 } else {
  310.                     $class = $factory->hasAttribute('class') ? $factory->getAttribute('class') : null;
  311.                 }
  313.                 $definition->setFactory([$class, $factory->getAttribute('method') ?: '__invoke']);
  314.             }
  315.         }
  317.         if ($configurators = $this->getChildren($service, 'configurator')) {
  318.             $configurator = $configurators[0];
  319.             if ($function = $configurator->getAttribute('function')) {
  320.                 $definition->setConfigurator($function);
  321.             } else {
  322.                 if ($childService = $configurator->getAttribute('service')) {
  323.                     $class = new Reference($childService, ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE);
  324.                 } else {
  325.                     $class = $configurator->getAttribute('class');
  326.                 }
  328.                 $definition->setConfigurator([$class, $configurator->getAttribute('method') ?: '__invoke']);
  329.             }
  330.         }
  332.         foreach ($this->getChildren($service, 'call') as $call) {
  333.             $definition->addMethodCall($call->getAttribute('method'), $this->getArgumentsAsPhp($call, 'argument', $file), XmlUtils::phpize($call->getAttribute('returns-clone')));
  334.         }
  336.         $tags = $this->getChildren($service, 'tag');
  338.         foreach ($tags as $tag) {
  339.             $tagNameComesFromAttribute = $tag->childElementCount || '' === $tag->nodeValue;
  340.             if ('' === $tagName = $tagNameComesFromAttribute ? $tag->getAttribute('name') : $tag->nodeValue) {
  341.                 throw new InvalidArgumentException(sprintf('The tag name for service "%s" in "%s" must be a non-empty string.', (string) $service->getAttribute('id'), $file));
  342.             }
  344.             $parameters = $this->getTagAttributes($tag, sprintf('The attribute name of tag "%s" for service "%s" in %s must be a non-empty string.', $tagName, (string) $service->getAttribute('id'), $file));
  345.             foreach ($tag->attributes as $name => $node) {
  346.                 if ($tagNameComesFromAttribute && 'name' === $name) {
  347.                     continue;
  348.                 }
  350.                 if (str_contains($name, '-') && !str_contains($name, '_') && !\array_key_exists($normalizedName = str_replace('-', '_', $name), $parameters)) {
  351.                     $parameters[$normalizedName] = XmlUtils::phpize($node->nodeValue);
  352.                 }
  353.                 // keep not normalized key
  354.                 $parameters[$name] = XmlUtils::phpize($node->nodeValue);
  355.             }
  357.             $definition->addTag($tagName, $parameters);
  358.         }
  360.         $definition->setTags(array_merge_recursive($definition->getTags(), $defaults->getTags()));
  362.         $bindings = $this->getArgumentsAsPhp($service, 'bind', $file);
  363.         $bindingType = $this->isLoadingInstanceof ? BoundArgument::INSTANCEOF_BINDING : BoundArgument::SERVICE_BINDING;
  364.         foreach ($bindings as $argument => $value) {
  365.             $bindings[$argument] = new BoundArgument($value, true, $bindingType, $file);
  366.         }
  368.         // deep clone, to avoid multiple process of the same instance in the passes
  369.         $bindings = array_merge(unserialize(serialize($defaults->getBindings())), $bindings);
  371.         if ($bindings) {
  372.             $definition->setBindings($bindings);
  373.         }
  375.         if ($decorates = $service->getAttribute('decorates')) {
  376.             $decorationOnInvalid = $service->getAttribute('decoration-on-invalid') ?: 'exception';
  377.             if ('exception' === $decorationOnInvalid) {
  378.                 $invalidBehavior = ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE;
  379.             } elseif ('ignore' === $decorationOnInvalid) {
  380.                 $invalidBehavior = ContainerInterface::IGNORE_ON_INVALID_REFERENCE;
  381.             } elseif ('null' === $decorationOnInvalid) {
  382.                 $invalidBehavior = ContainerInterface::NULL_ON_INVALID_REFERENCE;
  383.             } else {
  384.                 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, $service->getAttribute('id'), $file));
  385.             }
  387.             $renameId = $service->hasAttribute('decoration-inner-name') ? $service->getAttribute('decoration-inner-name') : null;
  388.             $priority = $service->hasAttribute('decoration-priority') ? $service->getAttribute('decoration-priority') : 0;
  390.             $definition->setDecoratedService($decorates, $renameId, $priority, $invalidBehavior);
  391.         }
  393.         return $definition;
  394.     }
  396.     /**
  397.      * Parses an XML file to a \DOMDocument.
  398.      *
  399.      * @throws InvalidArgumentException When loading of XML file returns error
  400.      */
  401.     private function parseFileToDOM(string $file): \DOMDocument
  402.     {
  403.         try {
  404.             $dom = XmlUtils::loadFile($file, $this->validateSchema(...));
  405.         } catch (\InvalidArgumentException $e) {
  406.             throw new InvalidArgumentException(sprintf('Unable to parse file "%s": ', $file).$e->getMessage(), $e->getCode(), $e);
  407.         }
  409.         $this->validateExtensions($dom, $file);
  411.         return $dom;
  412.     }
  414.     /**
  415.      * Processes anonymous services.
  416.      */
  417.     private function processAnonymousServices(\DOMDocument $xml, string $file, \DOMNode $root = null)
  418.     {
  419.         $definitions = [];
  420.         $count = 0;
  421.         $suffix = '~'.ContainerBuilder::hash($file);
  423.         $xpath = new \DOMXPath($xml);
  424.         $xpath->registerNamespace('container', self::NS);
  426.         // anonymous services as arguments/properties
  427.         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)]', $root)) {
  428.             foreach ($nodes as $node) {
  429.                 if ($services = $this->getChildren($node, 'service')) {
  430.                     // give it a unique name
  431.                     $id = sprintf('.%d_%s', ++$count, preg_replace('/^.*\\\\/', '', $services[0]->getAttribute('class')).$suffix);
  432.                     $node->setAttribute('id', $id);
  433.                     $node->setAttribute('service', $id);
  435.                     $definitions[$id] = [$services[0], $file];
  436.                     $services[0]->setAttribute('id', $id);
  438.                     // anonymous services are always private
  439.                     // we could not use the constant false here, because of XML parsing
  440.                     $services[0]->setAttribute('public', 'false');
  441.                 }
  442.             }
  443.         }
  445.         // anonymous services "in the wild"
  446.         if (false !== $nodes = $xpath->query('.//container:services/container:service[not(@id)]', $root)) {
  447.             foreach ($nodes as $node) {
  448.                 throw new InvalidArgumentException(sprintf('Top-level services must have "id" attribute, none found in "%s" at line %d.', $file, $node->getLineNo()));
  449.             }
  450.         }
  452.         // resolve definitions
  453.         uksort($definitions, 'strnatcmp');
  454.         foreach (array_reverse($definitions) as $id => [$domElement, $file]) {
  455.             if (null !== $definition = $this->parseDefinition($domElement, $file, new Definition())) {
  456.                 $this->setDefinition($id, $definition);
  457.             }
  458.         }
  459.     }
  461.     private function getArgumentsAsPhp(\DOMElement $node, string $name, string $file, bool $isChildDefinition = false): array
  462.     {
  463.         $arguments = [];
  464.         foreach ($this->getChildren($node, $name) as $arg) {
  465.             if ($arg->hasAttribute('name')) {
  466.                 $arg->setAttribute('key', $arg->getAttribute('name'));
  467.             }
  469.             // this is used by ChildDefinition to overwrite a specific
  470.             // argument of the parent definition
  471.             if ($arg->hasAttribute('index')) {
  472.                 $key = ($isChildDefinition ? 'index_' : '').$arg->getAttribute('index');
  473.             } elseif (!$arg->hasAttribute('key')) {
  474.                 // Append an empty argument, then fetch its key to overwrite it later
  475.                 $arguments[] = null;
  476.                 $keys = array_keys($arguments);
  477.                 $key = array_pop($keys);
  478.             } else {
  479.                 $key = $arg->getAttribute('key');
  480.             }
  482.             $onInvalid = $arg->getAttribute('on-invalid');
  483.             $invalidBehavior = ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE;
  484.             if ('ignore' == $onInvalid) {
  485.                 $invalidBehavior = ContainerInterface::IGNORE_ON_INVALID_REFERENCE;
  486.             } elseif ('ignore_uninitialized' == $onInvalid) {
  487.                 $invalidBehavior = ContainerInterface::IGNORE_ON_UNINITIALIZED_REFERENCE;
  488.             } elseif ('null' == $onInvalid) {
  489.                 $invalidBehavior = ContainerInterface::NULL_ON_INVALID_REFERENCE;
  490.             }
  492.             switch ($type = $arg->getAttribute('type')) {
  493.                 case 'service':
  494.                     if ('' === $arg->getAttribute('id')) {
  495.                         throw new InvalidArgumentException(sprintf('Tag "<%s>" with type="service" has no or empty "id" attribute in "%s".', $name, $file));
  496.                     }
  498.                     $arguments[$key] = new Reference($arg->getAttribute('id'), $invalidBehavior);
  499.                     break;
  500.                 case 'expression':
  501.                     if (!class_exists(Expression::class)) {
  502.                         throw new \LogicException('The type="expression" attribute cannot be used without the ExpressionLanguage component. Try running "composer require symfony/expression-language".');
  503.                     }
  505.                     $arguments[$key] = new Expression($arg->nodeValue);
  506.                     break;
  507.                 case 'collection':
  508.                     $arguments[$key] = $this->getArgumentsAsPhp($arg, $name, $file);
  509.                     break;
  510.                 case 'iterator':
  511.                     $arg = $this->getArgumentsAsPhp($arg, $name, $file);
  512.                     $arguments[$key] = new IteratorArgument($arg);
  513.                     break;
  514.                 case 'closure':
  515.                 case 'service_closure':
  516.                     if ('' !== $arg->getAttribute('id')) {
  517.                         $arg = new Reference($arg->getAttribute('id'), $invalidBehavior);
  518.                     } else {
  519.                         $arg = $this->getArgumentsAsPhp($arg, $name, $file);
  520.                     }
  521.                     $arguments[$key] = match ($type) {
  522.                         'service_closure' => new ServiceClosureArgument($arg),
  523.                         'closure' => (new Definition('Closure'))
  524.                             ->setFactory(['Closure', 'fromCallable'])
  525.                             ->addArgument($arg),
  526.                     };
  527.                     break;
  528.                 case 'service_locator':
  529.                     $arg = $this->getArgumentsAsPhp($arg, $name, $file);
  530.                     $arguments[$key] = new ServiceLocatorArgument($arg);
  531.                     break;
  532.                 case 'tagged':
  533.                 case 'tagged_iterator':
  534.                 case 'tagged_locator':
  535.                     $forLocator = 'tagged_locator' === $type;
  537.                     if (!$arg->getAttribute('tag')) {
  538.                         throw new InvalidArgumentException(sprintf('Tag "<%s>" with type="%s" has no or empty "tag" attribute in "%s".', $name, $type, $file));
  539.                     }
  541.                     $excludes = array_column($this->getChildren($arg, 'exclude'), 'nodeValue');
  542.                     if ($arg->hasAttribute('exclude')) {
  543.                         if (\count($excludes) > 0) {
  544.                             throw new InvalidArgumentException('You cannot use both the attribute "exclude" and <exclude> tags at the same time.');
  545.                         }
  546.                         $excludes = [$arg->getAttribute('exclude')];
  547.                     }
  549.                     $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, $excludes);
  551.                     if ($forLocator) {
  552.                         $arguments[$key] = new ServiceLocatorArgument($arguments[$key]);
  553.                     }
  554.                     break;
  555.                 case 'binary':
  556.                     if (false === $value = base64_decode($arg->nodeValue)) {
  557.                         throw new InvalidArgumentException(sprintf('Tag "<%s>" with type="binary" is not a valid base64 encoded string.', $name));
  558.                     }
  559.                     $arguments[$key] = $value;
  560.                     break;
  561.                 case 'abstract':
  562.                     $arguments[$key] = new AbstractArgument($arg->nodeValue);
  563.                     break;
  564.                 case 'string':
  565.                     $arguments[$key] = $arg->nodeValue;
  566.                     break;
  567.                 case 'constant':
  568.                     $arguments[$key] = \constant(trim($arg->nodeValue));
  569.                     break;
  570.                 default:
  571.                     $arguments[$key] = XmlUtils::phpize($arg->nodeValue);
  572.             }
  573.         }
  575.         return $arguments;
  576.     }
  578.     /**
  579.      * Get child elements by name.
  580.      *
  581.      * @return \DOMElement[]
  582.      */
  583.     private function getChildren(\DOMNode $node, string $name): array
  584.     {
  585.         $children = [];
  586.         foreach ($node->childNodes as $child) {
  587.             if ($child instanceof \DOMElement && $child->localName === $name && self::NS === $child->namespaceURI) {
  588.                 $children[] = $child;
  589.             }
  590.         }
  592.         return $children;
  593.     }
  595.     private function getTagAttributes(\DOMNode $node, string $missingName): array
  596.     {
  597.         $parameters = [];
  598.         $children = $this->getChildren($node, 'attribute');
  600.         foreach ($children as $childNode) {
  601.             if ('' === $name = $childNode->getAttribute('name')) {
  602.                 throw new InvalidArgumentException($missingName);
  603.             }
  605.             if ($this->getChildren($childNode, 'attribute')) {
  606.                 $parameters[$name] = $this->getTagAttributes($childNode, $missingName);
  607.             } else {
  608.                 if (str_contains($name, '-') && !str_contains($name, '_') && !\array_key_exists($normalizedName = str_replace('-', '_', $name), $parameters)) {
  609.                     $parameters[$normalizedName] = XmlUtils::phpize($childNode->nodeValue);
  610.                 }
  611.                 // keep not normalized key
  612.                 $parameters[$name] = XmlUtils::phpize($childNode->nodeValue);
  613.             }
  614.         }
  616.         return $parameters;
  617.     }
  619.     /**
  620.      * Validates a documents XML schema.
  621.      *
  622.      * @throws RuntimeException When extension references a non-existent XSD file
  623.      */
  624.     public function validateSchema(\DOMDocument $dom): bool
  625.     {
  626.         $schemaLocations = ['http://symfony.com/schema/dic/services' => str_replace('\\', '/', __DIR__.'/schema/dic/services/services-1.0.xsd')];
  628.         if ($element = $dom->documentElement->getAttributeNS('http://www.w3.org/2001/XMLSchema-instance', 'schemaLocation')) {
  629.             $items = preg_split('/\s+/', $element);
  630.             for ($i = 0, $nb = \count($items); $i < $nb; $i += 2) {
  631.                 if (!$this->container->hasExtension($items[$i])) {
  632.                     continue;
  633.                 }
  635.                 if (($extension = $this->container->getExtension($items[$i])) && false !== $extension->getXsdValidationBasePath()) {
  636.                     $ns = $extension->getNamespace();
  637.                     $path = str_replace([$ns, str_replace('http://', 'https://', $ns)], str_replace('\\', '/', $extension->getXsdValidationBasePath()).'/', $items[$i + 1]);
  639.                     if (!is_file($path)) {
  640.                         throw new RuntimeException(sprintf('Extension "%s" references a non-existent XSD file "%s".', get_debug_type($extension), $path));
  641.                     }
  643.                     $schemaLocations[$items[$i]] = $path;
  644.                 }
  645.             }
  646.         }
  648.         $tmpfiles = [];
  649.         $imports = '';
  650.         foreach ($schemaLocations as $namespace => $location) {
  651.             $parts = explode('/', $location);
  652.             $locationstart = 'file:///';
  653.             if (0 === stripos($location, 'phar://')) {
  654.                 $tmpfile = tempnam(sys_get_temp_dir(), 'symfony');
  655.                 if ($tmpfile) {
  656.                     copy($location, $tmpfile);
  657.                     $tmpfiles[] = $tmpfile;
  658.                     $parts = explode('/', str_replace('\\', '/', $tmpfile));
  659.                 } else {
  660.                     array_shift($parts);
  661.                     $locationstart = 'phar:///';
  662.                 }
  663.             } elseif ('\\' === \DIRECTORY_SEPARATOR && str_starts_with($location, '\\\\')) {
  664.                 $locationstart = '';
  665.             }
  666.             $drive = '\\' === \DIRECTORY_SEPARATOR ? array_shift($parts).'/' : '';
  667.             $location = $locationstart.$drive.implode('/', array_map('rawurlencode', $parts));
  669.             $imports .= sprintf('  <xsd:import namespace="%s" schemaLocation="%s" />'."\n", $namespace, $location);
  670.         }
  672.         $source = <<<EOF
  673. <?xml version="1.0" encoding="utf-8" ?>
  674. <xsd:schema xmlns="http://symfony.com/schema"
  675.     xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  676.     targetNamespace="http://symfony.com/schema"
  677.     elementFormDefault="qualified">
  679.     <xsd:import namespace="http://www.w3.org/XML/1998/namespace"/>
  680. $imports
  681. </xsd:schema>
  682. EOF
  683.         ;
  685.         if ($this->shouldEnableEntityLoader()) {
  686.             $disableEntities = libxml_disable_entity_loader(false);
  687.             $valid = @$dom->schemaValidateSource($source);
  688.             libxml_disable_entity_loader($disableEntities);
  689.         } else {
  690.             $valid = @$dom->schemaValidateSource($source);
  691.         }
  692.         foreach ($tmpfiles as $tmpfile) {
  693.             @unlink($tmpfile);
  694.         }
  696.         return $valid;
  697.     }
  699.     private function shouldEnableEntityLoader(): bool
  700.     {
  701.         static $dom, $schema;
  702.         if (null === $dom) {
  703.             $dom = new \DOMDocument();
  704.             $dom->loadXML('<?xml version="1.0"?><test/>');
  706.             $tmpfile = tempnam(sys_get_temp_dir(), 'symfony');
  707.             register_shutdown_function(static function () use ($tmpfile) {
  708.                 @unlink($tmpfile);
  709.             });
  710.             $schema = '<?xml version="1.0" encoding="utf-8"?>
  711. <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  712.   <xsd:include schemaLocation="file:///'.rawurlencode(str_replace('\\', '/', $tmpfile)).'" />
  713. </xsd:schema>';
  714.             file_put_contents($tmpfile, '<?xml version="1.0" encoding="utf-8"?>
  715. <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  716.   <xsd:element name="test" type="testType" />
  717.   <xsd:complexType name="testType"/>
  718. </xsd:schema>');
  719.         }
  721.         return !@$dom->schemaValidateSource($schema);
  722.     }
  724.     private function validateAlias(\DOMElement $alias, string $file)
  725.     {
  726.         foreach ($alias->attributes as $name => $node) {
  727.             if (!\in_array($name, ['alias', 'id', 'public'])) {
  728.                 throw new InvalidArgumentException(sprintf('Invalid attribute "%s" defined for alias "%s" in "%s".', $name, $alias->getAttribute('id'), $file));
  729.             }
  730.         }
  732.         foreach ($alias->childNodes as $child) {
  733.             if (!$child instanceof \DOMElement || self::NS !== $child->namespaceURI) {
  734.                 continue;
  735.             }
  736.             if (!\in_array($child->localName, ['deprecated'], true)) {
  737.                 throw new InvalidArgumentException(sprintf('Invalid child element "%s" defined for alias "%s" in "%s".', $child->localName, $alias->getAttribute('id'), $file));
  738.             }
  739.         }
  740.     }
  742.     /**
  743.      * Validates an extension.
  744.      *
  745.      * @throws InvalidArgumentException When no extension is found corresponding to a tag
  746.      */
  747.     private function validateExtensions(\DOMDocument $dom, string $file)
  748.     {
  749.         foreach ($dom->documentElement->childNodes as $node) {
  750.             if (!$node instanceof \DOMElement || 'http://symfony.com/schema/dic/services' === $node->namespaceURI) {
  751.                 continue;
  752.             }
  754.             // can it be handled by an extension?
  755.             if (!$this->container->hasExtension($node->namespaceURI)) {
  756.                 $extensionNamespaces = array_filter(array_map(function (ExtensionInterface $ext) { return $ext->getNamespace(); }, $this->container->getExtensions()));
  757.                 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'));
  758.             }
  759.         }
  760.     }
  762.     /**
  763.      * Loads from an extension.
  764.      */
  765.     private function loadFromExtensions(\DOMDocument $xml)
  766.     {
  767.         foreach ($xml->documentElement->childNodes as $node) {
  768.             if (!$node instanceof \DOMElement || self::NS === $node->namespaceURI) {
  769.                 continue;
  770.             }
  772.             $values = static::convertDomElementToArray($node);
  773.             if (!\is_array($values)) {
  774.                 $values = [];
  775.             }
  777.             $this->container->loadFromExtension($node->namespaceURI, $values);
  778.         }
  779.     }
  781.     /**
  782.      * Converts a \DOMElement object to a PHP array.
  783.      *
  784.      * The following rules applies during the conversion:
  785.      *
  786.      *  * Each tag is converted to a key value or an array
  787.      *    if there is more than one "value"
  788.      *
  789.      *  * The content of a tag is set under a "value" key (<foo>bar</foo>)
  790.      *    if the tag also has some nested tags
  791.      *
  792.      *  * The attributes are converted to keys (<foo foo="bar"/>)
  793.      *
  794.      *  * The nested-tags are converted to keys (<foo><foo>bar</foo></foo>)
  795.      *
  796.      * @param \DOMElement $element A \DOMElement instance
  797.      */
  798.     public static function convertDomElementToArray(\DOMElement $element): mixed
  799.     {
  800.         return XmlUtils::convertDomElementToArray($element);
  801.     }
  802. }