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

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.         $this->loadXml($xml, $path);
  56.         if ($this->env) {
  57.             $xpath = new \DOMXPath($xml);
  58.             $xpath->registerNamespace('container', self::NS);
  59.             foreach ($xpath->query(sprintf('//container:when[@env="%s"]', $this->env)) ?: [] as $root) {
  60.                 $env = $this->env;
  61.                 $this->env = null;
  62.                 try {
  63.                     $this->loadXml($xml, $path, $root);
  64.                 } finally {
  65.                     $this->env = $env;
  66.                 }
  67.             }
  68.         }
  69.     }
  71.     private function loadXml(\DOMDocument $xml, string $path, \DOMNode $root = null): void
  72.     {
  73.         $defaults = $this->getServiceDefaults($xml, $path, $root);
  75.         // anonymous services
  76.         $this->processAnonymousServices($xml, $path, $root);
  78.         // imports
  79.         $this->parseImports($xml, $path, $root);
  81.         // parameters
  82.         $this->parseParameters($xml, $path, $root);
  84.         // extensions
  85.         $this->loadFromExtensions($xml, $root);
  87.         // services
  88.         try {
  89.             $this->parseDefinitions($xml, $path, $defaults, $root);
  90.         } finally {
  91.             $this->instanceof = [];
  92.             $this->registerAliasesForSinglyImplementedInterfaces();
  93.         }
  94.     }
  96.     /**
  97.      * {@inheritdoc}
  98.      */
  99.     public function supports($resource, string $type = null)
  100.     {
  101.         if (!\is_string($resource)) {
  102.             return false;
  103.         }
  105.         if (null === $type && 'xml' === pathinfo($resource, \PATHINFO_EXTENSION)) {
  106.             return true;
  107.         }
  109.         return 'xml' === $type;
  110.     }
  112.     private function parseParameters(\DOMDocument $xml, string $file, \DOMNode $root = null)
  113.     {
  114.         if ($parameters = $this->getChildren($root ?? $xml->documentElement, 'parameters')) {
  115.             $this->container->getParameterBag()->add($this->getArgumentsAsPhp($parameters[0], 'parameter', $file));
  116.         }
  117.     }
  119.     private function parseImports(\DOMDocument $xml, string $file, \DOMNode $root = null)
  120.     {
  121.         $xpath = new \DOMXPath($xml);
  122.         $xpath->registerNamespace('container', self::NS);
  124.         if (false === $imports = $xpath->query('.//container:imports/container:import', $root)) {
  125.             return;
  126.         }
  128.         $defaultDirectory = \dirname($file);
  129.         foreach ($imports as $import) {
  130.             $this->setCurrentDir($defaultDirectory);
  131.             $this->import($import->getAttribute('resource'), XmlUtils::phpize($import->getAttribute('type')) ?: null, XmlUtils::phpize($import->getAttribute('ignore-errors')) ?: false, $file);
  132.         }
  133.     }
  135.     private function parseDefinitions(\DOMDocument $xml, string $file, Definition $defaults, \DOMNode $root = null)
  136.     {
  137.         $xpath = new \DOMXPath($xml);
  138.         $xpath->registerNamespace('container', self::NS);
  140.         if (false === $services = $xpath->query('.//container:services/container:service|.//container:services/container:prototype|.//container:services/container:stack', $root)) {
  141.             return;
  142.         }
  143.         $this->setCurrentDir(\dirname($file));
  145.         $this->instanceof = [];
  146.         $this->isLoadingInstanceof = true;
  147.         $instanceof = $xpath->query('.//container:services/container:instanceof', $root);
  148.         foreach ($instanceof as $service) {
  149.             $this->setDefinition((string) $service->getAttribute('id'), $this->parseDefinition($service, $file, new Definition()));
  150.         }
  152.         $this->isLoadingInstanceof = false;
  153.         foreach ($services as $service) {
  154.             if ('stack' === $service->tagName) {
  155.                 $service->setAttribute('parent', '-');
  156.                 $definition = $this->parseDefinition($service, $file, $defaults)
  157.                     ->setTags(array_merge_recursive(['container.stack' => [[]]], $defaults->getTags()))
  158.                 ;
  159.                 $this->setDefinition($id = (string) $service->getAttribute('id'), $definition);
  160.                 $stack = [];
  162.                 foreach ($this->getChildren($service, 'service') as $k => $frame) {
  163.                     $k = $frame->getAttribute('id') ?: $k;
  164.                     $frame->setAttribute('id', $id.'" at index "'.$k);
  166.                     if ($alias = $frame->getAttribute('alias')) {
  167.                         $this->validateAlias($frame, $file);
  168.                         $stack[$k] = new Reference($alias);
  169.                     } else {
  170.                         $stack[$k] = $this->parseDefinition($frame, $file, $defaults)
  171.                             ->setInstanceofConditionals($this->instanceof);
  172.                     }
  173.                 }
  175.                 $definition->setArguments($stack);
  176.             } elseif (null !== $definition = $this->parseDefinition($service, $file, $defaults)) {
  177.                 if ('prototype' === $service->tagName) {
  178.                     $excludes = array_column($this->getChildren($service, 'exclude'), 'nodeValue');
  179.                     if ($service->hasAttribute('exclude')) {
  180.                         if (\count($excludes) > 0) {
  181.                             throw new InvalidArgumentException('You cannot use both the attribute "exclude" and <exclude> tags at the same time.');
  182.                         }
  183.                         $excludes = [$service->getAttribute('exclude')];
  184.                     }
  185.                     $this->registerClasses($definition, (string) $service->getAttribute('namespace'), (string) $service->getAttribute('resource'), $excludes);
  186.                 } else {
  187.                     $this->setDefinition((string) $service->getAttribute('id'), $definition);
  188.                 }
  189.             }
  190.         }
  191.     }
  193.     private function getServiceDefaults(\DOMDocument $xml, string $file, \DOMNode $root = null): Definition
  194.     {
  195.         $xpath = new \DOMXPath($xml);
  196.         $xpath->registerNamespace('container', self::NS);
  198.         if (null === $defaultsNode = $xpath->query('.//container:services/container:defaults', $root)->item(0)) {
  199.             return new Definition();
  200.         }
  202.         $defaultsNode->setAttribute('id', '<defaults>');
  204.         return $this->parseDefinition($defaultsNode, $file, new Definition());
  205.     }
  207.     /**
  208.      * Parses an individual Definition.
  209.      */
  210.     private function parseDefinition(\DOMElement $service, string $file, Definition $defaults): ?Definition
  211.     {
  212.         if ($alias = $service->getAttribute('alias')) {
  213.             $this->validateAlias($service, $file);
  215.             $this->container->setAlias((string) $service->getAttribute('id'), $alias = new Alias($alias));
  216.             if ($publicAttr = $service->getAttribute('public')) {
  217.                 $alias->setPublic(XmlUtils::phpize($publicAttr));
  218.             } elseif ($defaults->getChanges()['public'] ?? false) {
  219.                 $alias->setPublic($defaults->isPublic());
  220.             }
  222.             if ($deprecated = $this->getChildren($service, 'deprecated')) {
  223.                 $message = $deprecated[0]->nodeValue ?: '';
  224.                 $package = $deprecated[0]->getAttribute('package') ?: '';
  225.                 $version = $deprecated[0]->getAttribute('version') ?: '';
  227.                 if (!$deprecated[0]->hasAttribute('package')) {
  228.                     trigger_deprecation('symfony/dependency-injection', '5.1', 'Not setting the attribute "package" of the node "deprecated" in "%s" is deprecated.', $file);
  229.                 }
  231.                 if (!$deprecated[0]->hasAttribute('version')) {
  232.                     trigger_deprecation('symfony/dependency-injection', '5.1', 'Not setting the attribute "version" of the node "deprecated" in "%s" is deprecated.', $file);
  233.                 }
  235.                 $alias->setDeprecated($package, $version, $message);
  236.             }
  238.             return null;
  239.         }
  241.         if ($this->isLoadingInstanceof) {
  242.             $definition = new ChildDefinition('');
  243.         } elseif ($parent = $service->getAttribute('parent')) {
  244.             $definition = new ChildDefinition($parent);
  245.         } else {
  246.             $definition = new Definition();
  247.         }
  249.         if ($defaults->getChanges()['public'] ?? false) {
  250.             $definition->setPublic($defaults->isPublic());
  251.         }
  252.         $definition->setAutowired($defaults->isAutowired());
  253.         $definition->setAutoconfigured($defaults->isAutoconfigured());
  254.         $definition->setChanges([]);
  256.         foreach (['class', 'public', 'shared', 'synthetic', 'abstract'] as $key) {
  257.             if ($value = $service->getAttribute($key)) {
  258.                 $method = 'set'.$key;
  259.                 $definition->$method($value = XmlUtils::phpize($value));
  260.             }
  261.         }
  263.         if ($value = $service->getAttribute('lazy')) {
  264.             $definition->setLazy((bool) $value = XmlUtils::phpize($value));
  265.             if (\is_string($value)) {
  266.                 $definition->addTag('proxy', ['interface' => $value]);
  267.             }
  268.         }
  270.         if ($value = $service->getAttribute('autowire')) {
  271.             $definition->setAutowired(XmlUtils::phpize($value));
  272.         }
  274.         if ($value = $service->getAttribute('autoconfigure')) {
  275.             $definition->setAutoconfigured(XmlUtils::phpize($value));
  276.         }
  278.         if ($files = $this->getChildren($service, 'file')) {
  279.             $definition->setFile($files[0]->nodeValue);
  280.         }
  282.         if ($deprecated = $this->getChildren($service, 'deprecated')) {
  283.             $message = $deprecated[0]->nodeValue ?: '';
  284.             $package = $deprecated[0]->getAttribute('package') ?: '';
  285.             $version = $deprecated[0]->getAttribute('version') ?: '';
  287.             if ('' === $package) {
  288.                 trigger_deprecation('symfony/dependency-injection', '5.1', 'Not setting the attribute "package" of the node "deprecated" in "%s" is deprecated.', $file);
  289.             }
  291.             if ('' === $version) {
  292.                 trigger_deprecation('symfony/dependency-injection', '5.1', 'Not setting the attribute "version" of the node "deprecated" in "%s" is deprecated.', $file);
  293.             }
  295.             $definition->setDeprecated($package, $version, $message);
  296.         }
  298.         $definition->setArguments($this->getArgumentsAsPhp($service, 'argument', $file, $definition instanceof ChildDefinition));
  299.         $definition->setProperties($this->getArgumentsAsPhp($service, 'property', $file));
  301.         if ($factories = $this->getChildren($service, 'factory')) {
  302.             $factory = $factories[0];
  303.             if ($function = $factory->getAttribute('function')) {
  304.                 $definition->setFactory($function);
  305.             } else {
  306.                 if ($childService = $factory->getAttribute('service')) {
  307.                     $class = new Reference($childService, ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE);
  308.                 } else {
  309.                     $class = $factory->hasAttribute('class') ? $factory->getAttribute('class') : null;
  310.                 }
  312.                 $definition->setFactory([$class, $factory->getAttribute('method') ?: '__invoke']);
  313.             }
  314.         }
  316.         if ($configurators = $this->getChildren($service, 'configurator')) {
  317.             $configurator = $configurators[0];
  318.             if ($function = $configurator->getAttribute('function')) {
  319.                 $definition->setConfigurator($function);
  320.             } else {
  321.                 if ($childService = $configurator->getAttribute('service')) {
  322.                     $class = new Reference($childService, ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE);
  323.                 } else {
  324.                     $class = $configurator->getAttribute('class');
  325.                 }
  327.                 $definition->setConfigurator([$class, $configurator->getAttribute('method') ?: '__invoke']);
  328.             }
  329.         }
  331.         foreach ($this->getChildren($service, 'call') as $call) {
  332.             $definition->addMethodCall($call->getAttribute('method'), $this->getArgumentsAsPhp($call, 'argument', $file), XmlUtils::phpize($call->getAttribute('returns-clone')));
  333.         }
  335.         $tags = $this->getChildren($service, 'tag');
  337.         foreach ($tags as $tag) {
  338.             $parameters = [];
  339.             $tagName = $tag->nodeValue;
  340.             foreach ($tag->attributes as $name => $node) {
  341.                 if ('name' === $name && '' === $tagName) {
  342.                     continue;
  343.                 }
  345.                 if (str_contains($name, '-') && !str_contains($name, '_') && !\array_key_exists($normalizedName = str_replace('-', '_', $name), $parameters)) {
  346.                     $parameters[$normalizedName] = XmlUtils::phpize($node->nodeValue);
  347.                 }
  348.                 // keep not normalized key
  349.                 $parameters[$name] = XmlUtils::phpize($node->nodeValue);
  350.             }
  352.             if ('' === $tagName && '' === $tagName = $tag->getAttribute('name')) {
  353.                 throw new InvalidArgumentException(sprintf('The tag name for service "%s" in "%s" must be a non-empty string.', (string) $service->getAttribute('id'), $file));
  354.             }
  356.             $definition->addTag($tagName, $parameters);
  357.         }
  359.         $definition->setTags(array_merge_recursive($definition->getTags(), $defaults->getTags()));
  361.         $bindings = $this->getArgumentsAsPhp($service, 'bind', $file);
  362.         $bindingType = $this->isLoadingInstanceof ? BoundArgument::INSTANCEOF_BINDING : BoundArgument::SERVICE_BINDING;
  363.         foreach ($bindings as $argument => $value) {
  364.             $bindings[$argument] = new BoundArgument($value, true, $bindingType, $file);
  365.         }
  367.         // deep clone, to avoid multiple process of the same instance in the passes
  368.         $bindings = array_merge(unserialize(serialize($defaults->getBindings())), $bindings);
  370.         if ($bindings) {
  371.             $definition->setBindings($bindings);
  372.         }
  374.         if ($decorates = $service->getAttribute('decorates')) {
  375.             $decorationOnInvalid = $service->getAttribute('decoration-on-invalid') ?: 'exception';
  376.             if ('exception' === $decorationOnInvalid) {
  377.                 $invalidBehavior = ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE;
  378.             } elseif ('ignore' === $decorationOnInvalid) {
  379.                 $invalidBehavior = ContainerInterface::IGNORE_ON_INVALID_REFERENCE;
  380.             } elseif ('null' === $decorationOnInvalid) {
  381.                 $invalidBehavior = ContainerInterface::NULL_ON_INVALID_REFERENCE;
  382.             } else {
  383.                 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));
  384.             }
  386.             $renameId = $service->hasAttribute('decoration-inner-name') ? $service->getAttribute('decoration-inner-name') : null;
  387.             $priority = $service->hasAttribute('decoration-priority') ? $service->getAttribute('decoration-priority') : 0;
  389.             $definition->setDecoratedService($decorates, $renameId, $priority, $invalidBehavior);
  390.         }
  392.         return $definition;
  393.     }
  395.     /**
  396.      * Parses an XML file to a \DOMDocument.
  397.      *
  398.      * @throws InvalidArgumentException When loading of XML file returns error
  399.      */
  400.     private function parseFileToDOM(string $file): \DOMDocument
  401.     {
  402.         try {
  403.             $dom = XmlUtils::loadFile($file, [$this, 'validateSchema']);
  404.         } catch (\InvalidArgumentException $e) {
  405.             throw new InvalidArgumentException(sprintf('Unable to parse file "%s": ', $file).$e->getMessage(), $e->getCode(), $e);
  406.         }
  408.         $this->validateExtensions($dom, $file);
  410.         return $dom;
  411.     }
  413.     /**
  414.      * Processes anonymous services.
  415.      */
  416.     private function processAnonymousServices(\DOMDocument $xml, string $file, \DOMNode $root = null)
  417.     {
  418.         $definitions = [];
  419.         $count = 0;
  420.         $suffix = '~'.ContainerBuilder::hash($file);
  422.         $xpath = new \DOMXPath($xml);
  423.         $xpath->registerNamespace('container', self::NS);
  425.         // anonymous services as arguments/properties
  426.         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)) {
  427.             foreach ($nodes as $node) {
  428.                 if ($services = $this->getChildren($node, 'service')) {
  429.                     // give it a unique name
  430.                     $id = sprintf('.%d_%s', ++$count, preg_replace('/^.*\\\\/', '', $services[0]->getAttribute('class')).$suffix);
  431.                     $node->setAttribute('id', $id);
  432.                     $node->setAttribute('service', $id);
  434.                     $definitions[$id] = [$services[0], $file];
  435.                     $services[0]->setAttribute('id', $id);
  437.                     // anonymous services are always private
  438.                     // we could not use the constant false here, because of XML parsing
  439.                     $services[0]->setAttribute('public', 'false');
  440.                 }
  441.             }
  442.         }
  444.         // anonymous services "in the wild"
  445.         if (false !== $nodes = $xpath->query('.//container:services/container:service[not(@id)]', $root)) {
  446.             foreach ($nodes as $node) {
  447.                 throw new InvalidArgumentException(sprintf('Top-level services must have "id" attribute, none found in "%s" at line %d.', $file, $node->getLineNo()));
  448.             }
  449.         }
  451.         // resolve definitions
  452.         uksort($definitions, 'strnatcmp');
  453.         foreach (array_reverse($definitions) as $id => [$domElement, $file]) {
  454.             if (null !== $definition = $this->parseDefinition($domElement, $file, new Definition())) {
  455.                 $this->setDefinition($id, $definition);
  456.             }
  457.         }
  458.     }
  460.     private function getArgumentsAsPhp(\DOMElement $node, string $name, string $file, bool $isChildDefinition = false): array
  461.     {
  462.         $arguments = [];
  463.         foreach ($this->getChildren($node, $name) as $arg) {
  464.             if ($arg->hasAttribute('name')) {
  465.                 $arg->setAttribute('key', $arg->getAttribute('name'));
  466.             }
  468.             // this is used by ChildDefinition to overwrite a specific
  469.             // argument of the parent definition
  470.             if ($arg->hasAttribute('index')) {
  471.                 $key = ($isChildDefinition ? 'index_' : '').$arg->getAttribute('index');
  472.             } elseif (!$arg->hasAttribute('key')) {
  473.                 // Append an empty argument, then fetch its key to overwrite it later
  474.                 $arguments[] = null;
  475.                 $keys = array_keys($arguments);
  476.                 $key = array_pop($keys);
  477.             } else {
  478.                 $key = $arg->getAttribute('key');
  479.             }
  481.             $onInvalid = $arg->getAttribute('on-invalid');
  482.             $invalidBehavior = ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE;
  483.             if ('ignore' == $onInvalid) {
  484.                 $invalidBehavior = ContainerInterface::IGNORE_ON_INVALID_REFERENCE;
  485.             } elseif ('ignore_uninitialized' == $onInvalid) {
  486.                 $invalidBehavior = ContainerInterface::IGNORE_ON_UNINITIALIZED_REFERENCE;
  487.             } elseif ('null' == $onInvalid) {
  488.                 $invalidBehavior = ContainerInterface::NULL_ON_INVALID_REFERENCE;
  489.             }
  491.             switch ($arg->getAttribute('type')) {
  492.                 case 'service':
  493.                     if ('' === $arg->getAttribute('id')) {
  494.                         throw new InvalidArgumentException(sprintf('Tag "<%s>" with type="service" has no or empty "id" attribute in "%s".', $name, $file));
  495.                     }
  497.                     $arguments[$key] = new Reference($arg->getAttribute('id'), $invalidBehavior);
  498.                     break;
  499.                 case 'expression':
  500.                     if (!class_exists(Expression::class)) {
  501.                         throw new \LogicException('The type="expression" attribute cannot be used without the ExpressionLanguage component. Try running "composer require symfony/expression-language".');
  502.                     }
  504.                     $arguments[$key] = new Expression($arg->nodeValue);
  505.                     break;
  506.                 case 'collection':
  507.                     $arguments[$key] = $this->getArgumentsAsPhp($arg, $name, $file);
  508.                     break;
  509.                 case 'iterator':
  510.                     $arg = $this->getArgumentsAsPhp($arg, $name, $file);
  511.                     try {
  512.                         $arguments[$key] = new IteratorArgument($arg);
  513.                     } catch (InvalidArgumentException $e) {
  514.                         throw new InvalidArgumentException(sprintf('Tag "<%s>" with type="iterator" only accepts collections of type="service" references in "%s".', $name, $file));
  515.                     }
  516.                     break;
  517.                 case 'service_closure':
  518.                     if ('' === $arg->getAttribute('id')) {
  519.                         throw new InvalidArgumentException(sprintf('Tag "<%s>" with type="service_closure" has no or empty "id" attribute in "%s".', $name, $file));
  520.                     }
  522.                     $arguments[$key] = new ServiceClosureArgument(new Reference($arg->getAttribute('id'), $invalidBehavior));
  523.                     break;
  524.                 case 'service_locator':
  525.                     $arg = $this->getArgumentsAsPhp($arg, $name, $file);
  526.                     try {
  527.                         $arguments[$key] = new ServiceLocatorArgument($arg);
  528.                     } catch (InvalidArgumentException $e) {
  529.                         throw new InvalidArgumentException(sprintf('Tag "<%s>" with type="service_locator" only accepts maps of type="service" references in "%s".', $name, $file));
  530.                     }
  531.                     break;
  532.                 case 'tagged':
  533.                 case 'tagged_iterator':
  534.                 case 'tagged_locator':
  535.                     $type = $arg->getAttribute('type');
  536.                     $forLocator = 'tagged_locator' === $type;
  538.                     if (!$arg->getAttribute('tag')) {
  539.                         throw new InvalidArgumentException(sprintf('Tag "<%s>" with type="%s" has no or empty "tag" attribute in "%s".', $name, $type, $file));
  540.                     }
  542.                     $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);
  544.                     if ($forLocator) {
  545.                         $arguments[$key] = new ServiceLocatorArgument($arguments[$key]);
  546.                     }
  547.                     break;
  548.                 case 'binary':
  549.                     if (false === $value = base64_decode($arg->nodeValue)) {
  550.                         throw new InvalidArgumentException(sprintf('Tag "<%s>" with type="binary" is not a valid base64 encoded string.', $name));
  551.                     }
  552.                     $arguments[$key] = $value;
  553.                     break;
  554.                 case 'abstract':
  555.                     $arguments[$key] = new AbstractArgument($arg->nodeValue);
  556.                     break;
  557.                 case 'string':
  558.                     $arguments[$key] = $arg->nodeValue;
  559.                     break;
  560.                 case 'constant':
  561.                     $arguments[$key] = \constant(trim($arg->nodeValue));
  562.                     break;
  563.                 default:
  564.                     $arguments[$key] = XmlUtils::phpize($arg->nodeValue);
  565.             }
  566.         }
  568.         return $arguments;
  569.     }
  571.     /**
  572.      * Get child elements by name.
  573.      *
  574.      * @return \DOMElement[]
  575.      */
  576.     private function getChildren(\DOMNode $node, string $name): array
  577.     {
  578.         $children = [];
  579.         foreach ($node->childNodes as $child) {
  580.             if ($child instanceof \DOMElement && $child->localName === $name && self::NS === $child->namespaceURI) {
  581.                 $children[] = $child;
  582.             }
  583.         }
  585.         return $children;
  586.     }
  588.     /**
  589.      * Validates a documents XML schema.
  590.      *
  591.      * @return bool
  592.      *
  593.      * @throws RuntimeException When extension references a non-existent XSD file
  594.      */
  595.     public function validateSchema(\DOMDocument $dom)
  596.     {
  597.         $schemaLocations = ['http://symfony.com/schema/dic/services' => str_replace('\\', '/', __DIR__.'/schema/dic/services/services-1.0.xsd')];
  599.         if ($element = $dom->documentElement->getAttributeNS('http://www.w3.org/2001/XMLSchema-instance', 'schemaLocation')) {
  600.             $items = preg_split('/\s+/', $element);
  601.             for ($i = 0, $nb = \count($items); $i < $nb; $i += 2) {
  602.                 if (!$this->container->hasExtension($items[$i])) {
  603.                     continue;
  604.                 }
  606.                 if (($extension = $this->container->getExtension($items[$i])) && false !== $extension->getXsdValidationBasePath()) {
  607.                     $ns = $extension->getNamespace();
  608.                     $path = str_replace([$ns, str_replace('http://', 'https://', $ns)], str_replace('\\', '/', $extension->getXsdValidationBasePath()).'/', $items[$i + 1]);
  610.                     if (!is_file($path)) {
  611.                         throw new RuntimeException(sprintf('Extension "%s" references a non-existent XSD file "%s".', get_debug_type($extension), $path));
  612.                     }
  614.                     $schemaLocations[$items[$i]] = $path;
  615.                 }
  616.             }
  617.         }
  619.         $tmpfiles = [];
  620.         $imports = '';
  621.         foreach ($schemaLocations as $namespace => $location) {
  622.             $parts = explode('/', $location);
  623.             $locationstart = 'file:///';
  624.             if (0 === stripos($location, 'phar://')) {
  625.                 $tmpfile = tempnam(sys_get_temp_dir(), 'symfony');
  626.                 if ($tmpfile) {
  627.                     copy($location, $tmpfile);
  628.                     $tmpfiles[] = $tmpfile;
  629.                     $parts = explode('/', str_replace('\\', '/', $tmpfile));
  630.                 } else {
  631.                     array_shift($parts);
  632.                     $locationstart = 'phar:///';
  633.                 }
  634.             } elseif ('\\' === \DIRECTORY_SEPARATOR && str_starts_with($location, '\\\\')) {
  635.                 $locationstart = '';
  636.             }
  637.             $drive = '\\' === \DIRECTORY_SEPARATOR ? array_shift($parts).'/' : '';
  638.             $location = $locationstart.$drive.implode('/', array_map('rawurlencode', $parts));
  640.             $imports .= sprintf('  <xsd:import namespace="%s" schemaLocation="%s" />'."\n", $namespace, $location);
  641.         }
  643.         $source = <<<EOF
  644. <?xml version="1.0" encoding="utf-8" ?>
  645. <xsd:schema xmlns="http://symfony.com/schema"
  646.     xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  647.     targetNamespace="http://symfony.com/schema"
  648.     elementFormDefault="qualified">
  650.     <xsd:import namespace="http://www.w3.org/XML/1998/namespace"/>
  651. $imports
  652. </xsd:schema>
  653. EOF
  654.         ;
  656.         if ($this->shouldEnableEntityLoader()) {
  657.             $disableEntities = libxml_disable_entity_loader(false);
  658.             $valid = @$dom->schemaValidateSource($source);
  659.             libxml_disable_entity_loader($disableEntities);
  660.         } else {
  661.             $valid = @$dom->schemaValidateSource($source);
  662.         }
  663.         foreach ($tmpfiles as $tmpfile) {
  664.             @unlink($tmpfile);
  665.         }
  667.         return $valid;
  668.     }
  670.     private function shouldEnableEntityLoader(): bool
  671.     {
  672.         // Version prior to 8.0 can be enabled without deprecation
  673.         if (\PHP_VERSION_ID < 80000) {
  674.             return true;
  675.         }
  677.         static $dom, $schema;
  678.         if (null === $dom) {
  679.             $dom = new \DOMDocument();
  680.             $dom->loadXML('<?xml version="1.0"?><test/>');
  682.             $tmpfile = tempnam(sys_get_temp_dir(), 'symfony');
  683.             register_shutdown_function(static function () use ($tmpfile) {
  684.                 @unlink($tmpfile);
  685.             });
  686.             $schema = '<?xml version="1.0" encoding="utf-8"?>
  687. <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  688.   <xsd:include schemaLocation="file:///'.str_replace('\\', '/', $tmpfile).'" />
  689. </xsd:schema>';
  690.             file_put_contents($tmpfile, '<?xml version="1.0" encoding="utf-8"?>
  691. <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  692.   <xsd:element name="test" type="testType" />
  693.   <xsd:complexType name="testType"/>
  694. </xsd:schema>');
  695.         }
  697.         return !@$dom->schemaValidateSource($schema);
  698.     }
  700.     private function validateAlias(\DOMElement $alias, string $file)
  701.     {
  702.         foreach ($alias->attributes as $name => $node) {
  703.             if (!\in_array($name, ['alias', 'id', 'public'])) {
  704.                 throw new InvalidArgumentException(sprintf('Invalid attribute "%s" defined for alias "%s" in "%s".', $name, $alias->getAttribute('id'), $file));
  705.             }
  706.         }
  708.         foreach ($alias->childNodes as $child) {
  709.             if (!$child instanceof \DOMElement || self::NS !== $child->namespaceURI) {
  710.                 continue;
  711.             }
  712.             if (!\in_array($child->localName, ['deprecated'], true)) {
  713.                 throw new InvalidArgumentException(sprintf('Invalid child element "%s" defined for alias "%s" in "%s".', $child->localName, $alias->getAttribute('id'), $file));
  714.             }
  715.         }
  716.     }
  718.     /**
  719.      * Validates an extension.
  720.      *
  721.      * @throws InvalidArgumentException When no extension is found corresponding to a tag
  722.      */
  723.     private function validateExtensions(\DOMDocument $dom, string $file)
  724.     {
  725.         foreach ($dom->documentElement->childNodes as $node) {
  726.             if (!$node instanceof \DOMElement || 'http://symfony.com/schema/dic/services' === $node->namespaceURI) {
  727.                 continue;
  728.             }
  730.             // can it be handled by an extension?
  731.             if (!$this->container->hasExtension($node->namespaceURI)) {
  732.                 $extensionNamespaces = array_filter(array_map(function (ExtensionInterface $ext) { return $ext->getNamespace(); }, $this->container->getExtensions()));
  733.                 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'));
  734.             }
  735.         }
  736.     }
  738.     /**
  739.      * Loads from an extension.
  740.      */
  741.     private function loadFromExtensions(\DOMDocument $xml)
  742.     {
  743.         foreach ($xml->documentElement->childNodes as $node) {
  744.             if (!$node instanceof \DOMElement || self::NS === $node->namespaceURI) {
  745.                 continue;
  746.             }
  748.             $values = static::convertDomElementToArray($node);
  749.             if (!\is_array($values)) {
  750.                 $values = [];
  751.             }
  753.             $this->container->loadFromExtension($node->namespaceURI, $values);
  754.         }
  755.     }
  757.     /**
  758.      * Converts a \DOMElement object to a PHP array.
  759.      *
  760.      * The following rules applies during the conversion:
  761.      *
  762.      *  * Each tag is converted to a key value or an array
  763.      *    if there is more than one "value"
  764.      *
  765.      *  * The content of a tag is set under a "value" key (<foo>bar</foo>)
  766.      *    if the tag also has some nested tags
  767.      *
  768.      *  * The attributes are converted to keys (<foo foo="bar"/>)
  769.      *
  770.      *  * The nested-tags are converted to keys (<foo><foo>bar</foo></foo>)
  771.      *
  772.      * @param \DOMElement $element A \DOMElement instance
  773.      *
  774.      * @return mixed
  775.      */
  776.     public static function convertDomElementToArray(\DOMElement $element)
  777.     {
  778.         return XmlUtils::convertDomElementToArray($element);
  779.     }
  780. }