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

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. }
  70. return null;
  71. }
  73. private function loadXml(\DOMDocument $xml, string $path, ?\DOMNode $root = null): void
  74. {
  75. $defaults = $this->getServiceDefaults($xml, $path, $root);
  77. // anonymous services
  78. $this->processAnonymousServices($xml, $path, $root);
  80. // imports
  81. $this->parseImports($xml, $path, $root);
  83. // parameters
  84. $this->parseParameters($xml, $path, $root);
  86. // extensions
  87. $this->loadFromExtensions($xml, $root);
  89. // services
  90. try {
  91. $this->parseDefinitions($xml, $path, $defaults, $root);
  92. } finally {
  93. $this->instanceof = [];
  94. $this->registerAliasesForSinglyImplementedInterfaces();
  95. }
  96. }
  98. /**
  99. * {@inheritdoc}
  100. */
  101. public function supports($resource, ?string $type = null)
  102. {
  103. if (!\is_string($resource)) {
  104. return false;
  105. }
  107. if (null === $type && 'xml' === pathinfo($resource, \PATHINFO_EXTENSION)) {
  108. return true;
  109. }
  111. return 'xml' === $type;
  112. }
  114. private function parseParameters(\DOMDocument $xml, string $file, ?\DOMNode $root = null)
  115. {
  116. if ($parameters = $this->getChildren($root ?? $xml->documentElement, 'parameters')) {
  117. $this->container->getParameterBag()->add($this->getArgumentsAsPhp($parameters[0], 'parameter', $file));
  118. }
  119. }
  121. private function parseImports(\DOMDocument $xml, string $file, ?\DOMNode $root = null)
  122. {
  123. $xpath = new \DOMXPath($xml);
  124. $xpath->registerNamespace('container', self::NS);
  126. if (false === $imports = $xpath->query('./container:imports/container:import', $root)) {
  127. return;
  128. }
  130. $defaultDirectory = \dirname($file);
  131. foreach ($imports as $import) {
  132. $this->setCurrentDir($defaultDirectory);
  133. $this->import($import->getAttribute('resource'), XmlUtils::phpize($import->getAttribute('type')) ?: null, XmlUtils::phpize($import->getAttribute('ignore-errors')) ?: false, $file);
  134. }
  135. }
  137. private function parseDefinitions(\DOMDocument $xml, string $file, Definition $defaults, ?\DOMNode $root = null)
  138. {
  139. $xpath = new \DOMXPath($xml);
  140. $xpath->registerNamespace('container', self::NS);
  142. if (false === $services = $xpath->query('./container:services/container:service|./container:services/container:prototype|./container:services/container:stack', $root)) {
  143. return;
  144. }
  145. $this->setCurrentDir(\dirname($file));
  147. $this->instanceof = [];
  148. $this->isLoadingInstanceof = true;
  149. $instanceof = $xpath->query('./container:services/container:instanceof', $root);
  150. foreach ($instanceof as $service) {
  151. $this->setDefinition((string) $service->getAttribute('id'), $this->parseDefinition($service, $file, new Definition()));
  152. }
  154. $this->isLoadingInstanceof = false;
  155. foreach ($services as $service) {
  156. if ('stack' === $service->tagName) {
  157. $service->setAttribute('parent', '-');
  158. $definition = $this->parseDefinition($service, $file, $defaults)
  159. ->setTags(array_merge_recursive(['container.stack' => [[]]], $defaults->getTags()))
  160. ;
  161. $this->setDefinition($id = (string) $service->getAttribute('id'), $definition);
  162. $stack = [];
  164. foreach ($this->getChildren($service, 'service') as $k => $frame) {
  165. $k = $frame->getAttribute('id') ?: $k;
  166. $frame->setAttribute('id', $id.'" at index "'.$k);
  168. if ($alias = $frame->getAttribute('alias')) {
  169. $this->validateAlias($frame, $file);
  170. $stack[$k] = new Reference($alias);
  171. } else {
  172. $stack[$k] = $this->parseDefinition($frame, $file, $defaults)
  173. ->setInstanceofConditionals($this->instanceof);
  174. }
  175. }
  177. $definition->setArguments($stack);
  178. } elseif (null !== $definition = $this->parseDefinition($service, $file, $defaults)) {
  179. if ('prototype' === $service->tagName) {
  180. $excludes = array_column($this->getChildren($service, 'exclude'), 'nodeValue');
  181. if ($service->hasAttribute('exclude')) {
  182. if (\count($excludes) > 0) {
  183. throw new InvalidArgumentException('You cannot use both the attribute "exclude" and <exclude> tags at the same time.');
  184. }
  185. $excludes = [$service->getAttribute('exclude')];
  186. }
  187. $this->registerClasses($definition, (string) $service->getAttribute('namespace'), (string) $service->getAttribute('resource'), $excludes);
  188. } else {
  189. $this->setDefinition((string) $service->getAttribute('id'), $definition);
  190. }
  191. }
  192. }
  193. }
  195. private function getServiceDefaults(\DOMDocument $xml, string $file, ?\DOMNode $root = null): Definition
  196. {
  197. $xpath = new \DOMXPath($xml);
  198. $xpath->registerNamespace('container', self::NS);
  200. if (null === $defaultsNode = $xpath->query('./container:services/container:defaults', $root)->item(0)) {
  201. return new Definition();
  202. }
  204. $defaultsNode->setAttribute('id', '<defaults>');
  206. return $this->parseDefinition($defaultsNode, $file, new Definition());
  207. }
  209. /**
  210. * Parses an individual Definition.
  211. */
  212. private function parseDefinition(\DOMElement $service, string $file, Definition $defaults): ?Definition
  213. {
  214. if ($alias = $service->getAttribute('alias')) {
  215. $this->validateAlias($service, $file);
  217. $this->container->setAlias($service->getAttribute('id'), $alias = new Alias($alias));
  218. if ($publicAttr = $service->getAttribute('public')) {
  219. $alias->setPublic(XmlUtils::phpize($publicAttr));
  220. } elseif ($defaults->getChanges()['public'] ?? false) {
  221. $alias->setPublic($defaults->isPublic());
  222. }
  224. if ($deprecated = $this->getChildren($service, 'deprecated')) {
  225. $message = $deprecated[0]->nodeValue ?: '';
  226. $package = $deprecated[0]->getAttribute('package') ?: '';
  227. $version = $deprecated[0]->getAttribute('version') ?: '';
  229. if (!$deprecated[0]->hasAttribute('package')) {
  230. trigger_deprecation('symfony/dependency-injection', '5.1', 'Not setting the attribute "package" of the node "deprecated" in "%s" is deprecated.', $file);
  231. }
  233. if (!$deprecated[0]->hasAttribute('version')) {
  234. trigger_deprecation('symfony/dependency-injection', '5.1', 'Not setting the attribute "version" of the node "deprecated" in "%s" is deprecated.', $file);
  235. }
  237. $alias->setDeprecated($package, $version, $message);
  238. }
  240. return null;
  241. }
  243. if ($this->isLoadingInstanceof) {
  244. $definition = new ChildDefinition('');
  245. } elseif ($parent = $service->getAttribute('parent')) {
  246. $definition = new ChildDefinition($parent);
  247. } else {
  248. $definition = new Definition();
  249. }
  251. if ($defaults->getChanges()['public'] ?? false) {
  252. $definition->setPublic($defaults->isPublic());
  253. }
  254. $definition->setAutowired($defaults->isAutowired());
  255. $definition->setAutoconfigured($defaults->isAutoconfigured());
  256. $definition->setChanges([]);
  258. foreach (['class', 'public', 'shared', 'synthetic', 'abstract'] as $key) {
  259. if ($value = $service->getAttribute($key)) {
  260. $method = 'set'.$key;
  261. $definition->$method($value = XmlUtils::phpize($value));
  262. }
  263. }
  265. if ($value = $service->getAttribute('lazy')) {
  266. $definition->setLazy((bool) $value = XmlUtils::phpize($value));
  267. if (\is_string($value)) {
  268. $definition->addTag('proxy', ['interface' => $value]);
  269. }
  270. }
  272. if ($value = $service->getAttribute('autowire')) {
  273. $definition->setAutowired(XmlUtils::phpize($value));
  274. }
  276. if ($value = $service->getAttribute('autoconfigure')) {
  277. $definition->setAutoconfigured(XmlUtils::phpize($value));
  278. }
  280. if ($files = $this->getChildren($service, 'file')) {
  281. $definition->setFile($files[0]->nodeValue);
  282. }
  284. if ($deprecated = $this->getChildren($service, 'deprecated')) {
  285. $message = $deprecated[0]->nodeValue ?: '';
  286. $package = $deprecated[0]->getAttribute('package') ?: '';
  287. $version = $deprecated[0]->getAttribute('version') ?: '';
  289. if ('' === $package) {
  290. trigger_deprecation('symfony/dependency-injection', '5.1', 'Not setting the attribute "package" of the node "deprecated" in "%s" is deprecated.', $file);
  291. }
  293. if ('' === $version) {
  294. trigger_deprecation('symfony/dependency-injection', '5.1', 'Not setting the attribute "version" of the node "deprecated" in "%s" is deprecated.', $file);
  295. }
  297. $definition->setDeprecated($package, $version, $message);
  298. }
  300. $definition->setArguments($this->getArgumentsAsPhp($service, 'argument', $file, $definition instanceof ChildDefinition));
  301. $definition->setProperties($this->getArgumentsAsPhp($service, 'property', $file));
  303. if ($factories = $this->getChildren($service, 'factory')) {
  304. $factory = $factories[0];
  305. if ($function = $factory->getAttribute('function')) {
  306. $definition->setFactory($function);
  307. } else {
  308. if ($childService = $factory->getAttribute('service')) {
  309. $class = new Reference($childService, ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE);
  310. } else {
  311. $class = $factory->hasAttribute('class') ? $factory->getAttribute('class') : null;
  312. }
  314. $definition->setFactory([$class, $factory->getAttribute('method') ?: '__invoke']);
  315. }
  316. }
  318. if ($configurators = $this->getChildren($service, 'configurator')) {
  319. $configurator = $configurators[0];
  320. if ($function = $configurator->getAttribute('function')) {
  321. $definition->setConfigurator($function);
  322. } else {
  323. if ($childService = $configurator->getAttribute('service')) {
  324. $class = new Reference($childService, ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE);
  325. } else {
  326. $class = $configurator->getAttribute('class');
  327. }
  329. $definition->setConfigurator([$class, $configurator->getAttribute('method') ?: '__invoke']);
  330. }
  331. }
  333. foreach ($this->getChildren($service, 'call') as $call) {
  334. $definition->addMethodCall($call->getAttribute('method'), $this->getArgumentsAsPhp($call, 'argument', $file), XmlUtils::phpize($call->getAttribute('returns-clone')));
  335. }
  337. $tags = $this->getChildren($service, 'tag');
  339. foreach ($tags as $tag) {
  340. $parameters = [];
  341. $tagName = $tag->nodeValue;
  342. foreach ($tag->attributes as $name => $node) {
  343. if ('name' === $name && '' === $tagName) {
  344. continue;
  345. }
  347. if (str_contains($name, '-') && !str_contains($name, '_') && !\array_key_exists($normalizedName = str_replace('-', '_', $name), $parameters)) {
  348. $parameters[$normalizedName] = XmlUtils::phpize($node->nodeValue);
  349. }
  350. // keep not normalized key
  351. $parameters[$name] = XmlUtils::phpize($node->nodeValue);
  352. }
  354. if ('' === $tagName && '' === $tagName = $tag->getAttribute('name')) {
  355. throw new InvalidArgumentException(sprintf('The tag name for service "%s" in "%s" must be a non-empty string.', $service->getAttribute('id'), $file));
  356. }
  358. $definition->addTag($tagName, $parameters);
  359. }
  361. $definition->setTags(array_merge_recursive($definition->getTags(), $defaults->getTags()));
  363. $bindings = $this->getArgumentsAsPhp($service, 'bind', $file);
  364. $bindingType = $this->isLoadingInstanceof ? BoundArgument::INSTANCEOF_BINDING : BoundArgument::SERVICE_BINDING;
  365. foreach ($bindings as $argument => $value) {
  366. $bindings[$argument] = new BoundArgument($value, true, $bindingType, $file);
  367. }
  369. // deep clone, to avoid multiple process of the same instance in the passes
  370. $bindings = array_merge(unserialize(serialize($defaults->getBindings())), $bindings);
  372. if ($bindings) {
  373. $definition->setBindings($bindings);
  374. }
  376. if ($decorates = $service->getAttribute('decorates')) {
  377. $decorationOnInvalid = $service->getAttribute('decoration-on-invalid') ?: 'exception';
  378. if ('exception' === $decorationOnInvalid) {
  379. $invalidBehavior = ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE;
  380. } elseif ('ignore' === $decorationOnInvalid) {
  381. $invalidBehavior = ContainerInterface::IGNORE_ON_INVALID_REFERENCE;
  382. } elseif ('null' === $decorationOnInvalid) {
  383. $invalidBehavior = ContainerInterface::NULL_ON_INVALID_REFERENCE;
  384. } else {
  385. 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));
  386. }
  388. $renameId = $service->hasAttribute('decoration-inner-name') ? $service->getAttribute('decoration-inner-name') : null;
  389. $priority = $service->hasAttribute('decoration-priority') ? $service->getAttribute('decoration-priority') : 0;
  391. $definition->setDecoratedService($decorates, $renameId, $priority, $invalidBehavior);
  392. }
  394. return $definition;
  395. }
  397. /**
  398. * Parses an XML file to a \DOMDocument.
  399. *
  400. * @throws InvalidArgumentException When loading of XML file returns error
  401. */
  402. private function parseFileToDOM(string $file): \DOMDocument
  403. {
  404. try {
  405. $dom = XmlUtils::loadFile($file, [$this, 'validateSchema']);
  406. } catch (\InvalidArgumentException $e) {
  407. $invalidSecurityElements = [];
  408. $errors = explode("\n", $e->getMessage());
  409. foreach ($errors as $i => $error) {
  410. if (preg_match("#^\[ERROR 1871] Element '\{http://symfony\.com/schema/dic/security}([^']+)'#", $error, $matches)) {
  411. $invalidSecurityElements[$i] = $matches[1];
  412. }
  413. }
  414. if ($invalidSecurityElements) {
  415. $dom = XmlUtils::loadFile($file);
  417. foreach ($invalidSecurityElements as $errorIndex => $tagName) {
  418. foreach ($dom->getElementsByTagNameNS('http://symfony.com/schema/dic/security', $tagName) as $element) {
  419. if (!$parent = $element->parentNode) {
  420. continue;
  421. }
  422. if ('http://symfony.com/schema/dic/security' !== $parent->namespaceURI) {
  423. continue;
  424. }
  425. if ('provider' === $parent->localName || 'firewall' === $parent->localName) {
  426. unset($errors[$errorIndex]);
  427. }
  428. }
  429. }
  430. }
  431. if ($errors) {
  432. throw new InvalidArgumentException(sprintf('Unable to parse file "%s": ', $file).implode("\n", $errors), $e->getCode(), $e);
  433. }
  434. }
  436. $this->validateExtensions($dom, $file);
  438. return $dom;
  439. }
  441. /**
  442. * Processes anonymous services.
  443. */
  444. private function processAnonymousServices(\DOMDocument $xml, string $file, ?\DOMNode $root = null)
  445. {
  446. $definitions = [];
  447. $count = 0;
  448. $suffix = '~'.ContainerBuilder::hash($file);
  450. $xpath = new \DOMXPath($xml);
  451. $xpath->registerNamespace('container', self::NS);
  453. // anonymous services as arguments/properties
  454. 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)) {
  455. foreach ($nodes as $node) {
  456. if ($services = $this->getChildren($node, 'service')) {
  457. // give it a unique name
  458. $id = sprintf('.%d_%s', ++$count, preg_replace('/^.*\\\\/', '', $services[0]->getAttribute('class')).$suffix);
  459. $node->setAttribute('id', $id);
  460. $node->setAttribute('service', $id);
  462. $definitions[$id] = [$services[0], $file];
  463. $services[0]->setAttribute('id', $id);
  465. // anonymous services are always private
  466. // we could not use the constant false here, because of XML parsing
  467. $services[0]->setAttribute('public', 'false');
  468. }
  469. }
  470. }
  472. // anonymous services "in the wild"
  473. if (false !== $nodes = $xpath->query('.//container:services/container:service[not(@id)]', $root)) {
  474. foreach ($nodes as $node) {
  475. throw new InvalidArgumentException(sprintf('Top-level services must have "id" attribute, none found in "%s" at line %d.', $file, $node->getLineNo()));
  476. }
  477. }
  479. // resolve definitions
  480. uksort($definitions, 'strnatcmp');
  481. foreach (array_reverse($definitions) as $id => [$domElement, $file]) {
  482. if (null !== $definition = $this->parseDefinition($domElement, $file, new Definition())) {
  483. $this->setDefinition($id, $definition);
  484. }
  485. }
  486. }
  488. private function getArgumentsAsPhp(\DOMElement $node, string $name, string $file, bool $isChildDefinition = false): array
  489. {
  490. $arguments = [];
  491. foreach ($this->getChildren($node, $name) as $arg) {
  492. if ($arg->hasAttribute('name')) {
  493. $arg->setAttribute('key', $arg->getAttribute('name'));
  494. }
  496. // this is used by ChildDefinition to overwrite a specific
  497. // argument of the parent definition
  498. if ($arg->hasAttribute('index')) {
  499. $key = ($isChildDefinition ? 'index_' : '').$arg->getAttribute('index');
  500. } elseif (!$arg->hasAttribute('key')) {
  501. // Append an empty argument, then fetch its key to overwrite it later
  502. $arguments[] = null;
  503. $keys = array_keys($arguments);
  504. $key = array_pop($keys);
  505. } else {
  506. $key = $arg->getAttribute('key');
  507. }
  509. $onInvalid = $arg->getAttribute('on-invalid');
  510. $invalidBehavior = ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE;
  511. if ('ignore' == $onInvalid) {
  512. $invalidBehavior = ContainerInterface::IGNORE_ON_INVALID_REFERENCE;
  513. } elseif ('ignore_uninitialized' == $onInvalid) {
  514. $invalidBehavior = ContainerInterface::IGNORE_ON_UNINITIALIZED_REFERENCE;
  515. } elseif ('null' == $onInvalid) {
  516. $invalidBehavior = ContainerInterface::NULL_ON_INVALID_REFERENCE;
  517. }
  519. switch ($arg->getAttribute('type')) {
  520. case 'service':
  521. if ('' === $arg->getAttribute('id')) {
  522. throw new InvalidArgumentException(sprintf('Tag "<%s>" with type="service" has no or empty "id" attribute in "%s".', $name, $file));
  523. }
  525. $arguments[$key] = new Reference($arg->getAttribute('id'), $invalidBehavior);
  526. break;
  527. case 'expression':
  528. if (!class_exists(Expression::class)) {
  529. throw new \LogicException('The type="expression" attribute cannot be used without the ExpressionLanguage component. Try running "composer require symfony/expression-language".');
  530. }
  532. $arguments[$key] = new Expression($arg->nodeValue);
  533. break;
  534. case 'collection':
  535. $arguments[$key] = $this->getArgumentsAsPhp($arg, $name, $file);
  536. break;
  537. case 'iterator':
  538. $arg = $this->getArgumentsAsPhp($arg, $name, $file);
  539. try {
  540. $arguments[$key] = new IteratorArgument($arg);
  541. } catch (InvalidArgumentException $e) {
  542. throw new InvalidArgumentException(sprintf('Tag "<%s>" with type="iterator" only accepts collections of type="service" references in "%s".', $name, $file));
  543. }
  544. break;
  545. case 'service_closure':
  546. if ('' === $arg->getAttribute('id')) {
  547. throw new InvalidArgumentException(sprintf('Tag "<%s>" with type="service_closure" has no or empty "id" attribute in "%s".', $name, $file));
  548. }
  550. $arguments[$key] = new ServiceClosureArgument(new Reference($arg->getAttribute('id'), $invalidBehavior));
  551. break;
  552. case 'service_locator':
  553. $arg = $this->getArgumentsAsPhp($arg, $name, $file);
  554. try {
  555. $arguments[$key] = new ServiceLocatorArgument($arg);
  556. } catch (InvalidArgumentException $e) {
  557. throw new InvalidArgumentException(sprintf('Tag "<%s>" with type="service_locator" only accepts maps of type="service" references in "%s".', $name, $file));
  558. }
  559. break;
  560. case 'tagged':
  561. case 'tagged_iterator':
  562. case 'tagged_locator':
  563. $type = $arg->getAttribute('type');
  564. $forLocator = 'tagged_locator' === $type;
  566. if (!$arg->getAttribute('tag')) {
  567. throw new InvalidArgumentException(sprintf('Tag "<%s>" with type="%s" has no or empty "tag" attribute in "%s".', $name, $type, $file));
  568. }
  570. $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);
  572. if ($forLocator) {
  573. $arguments[$key] = new ServiceLocatorArgument($arguments[$key]);
  574. }
  575. break;
  576. case 'binary':
  577. if (false === $value = base64_decode($arg->nodeValue)) {
  578. throw new InvalidArgumentException(sprintf('Tag "<%s>" with type="binary" is not a valid base64 encoded string.', $name));
  579. }
  580. $arguments[$key] = $value;
  581. break;
  582. case 'abstract':
  583. $arguments[$key] = new AbstractArgument($arg->nodeValue);
  584. break;
  585. case 'string':
  586. $arguments[$key] = $arg->nodeValue;
  587. break;
  588. case 'constant':
  589. $arguments[$key] = \constant(trim($arg->nodeValue));
  590. break;
  591. default:
  592. $arguments[$key] = XmlUtils::phpize($arg->nodeValue);
  593. }
  594. }
  596. return $arguments;
  597. }
  599. /**
  600. * Get child elements by name.
  601. *
  602. * @return \DOMElement[]
  603. */
  604. private function getChildren(\DOMNode $node, string $name): array
  605. {
  606. $children = [];
  607. foreach ($node->childNodes as $child) {
  608. if ($child instanceof \DOMElement && $child->localName === $name && self::NS === $child->namespaceURI) {
  609. $children[] = $child;
  610. }
  611. }
  613. return $children;
  614. }
  616. /**
  617. * Validates a documents XML schema.
  618. *
  619. * @return bool
  620. *
  621. * @throws RuntimeException When extension references a non-existent XSD file
  622. */
  623. public function validateSchema(\DOMDocument $dom)
  624. {
  625. $schemaLocations = ['http://symfony.com/schema/dic/services' => str_replace('\\', '/', __DIR__.'/schema/dic/services/services-1.0.xsd')];
  627. if ($element = $dom->documentElement->getAttributeNS('http://www.w3.org/2001/XMLSchema-instance', 'schemaLocation')) {
  628. $items = preg_split('/\s+/', $element);
  629. for ($i = 0, $nb = \count($items); $i < $nb; $i += 2) {
  630. if (!$this->container->hasExtension($items[$i])) {
  631. continue;
  632. }
  634. if (($extension = $this->container->getExtension($items[$i])) && false !== $extension->getXsdValidationBasePath()) {
  635. $ns = $extension->getNamespace();
  636. $path = str_replace([$ns, str_replace('http://', 'https://', $ns)], str_replace('\\', '/', $extension->getXsdValidationBasePath()).'/', $items[$i + 1]);
  638. if (!is_file($path)) {
  639. throw new RuntimeException(sprintf('Extension "%s" references a non-existent XSD file "%s".', get_debug_type($extension), $path));
  640. }
  642. $schemaLocations[$items[$i]] = $path;
  643. }
  644. }
  645. }
  647. $tmpfiles = [];
  648. $imports = '';
  649. foreach ($schemaLocations as $namespace => $location) {
  650. $parts = explode('/', $location);
  651. $locationstart = 'file:///';
  652. if (0 === stripos($location, 'phar://')) {
  653. $tmpfile = tempnam(sys_get_temp_dir(), 'symfony');
  654. if ($tmpfile) {
  655. copy($location, $tmpfile);
  656. $tmpfiles[] = $tmpfile;
  657. $parts = explode('/', str_replace('\\', '/', $tmpfile));
  658. } else {
  659. array_shift($parts);
  660. $locationstart = 'phar:///';
  661. }
  662. } elseif ('\\' === \DIRECTORY_SEPARATOR && str_starts_with($location, '\\\\')) {
  663. $locationstart = '';
  664. }
  665. $drive = '\\' === \DIRECTORY_SEPARATOR ? array_shift($parts).'/' : '';
  666. $location = $locationstart.$drive.implode('/', array_map('rawurlencode', $parts));
  668. $imports .= sprintf(' <xsd:import namespace="%s" schemaLocation="%s" />'."\n", $namespace, $location);
  669. }
  671. $source = <<<EOF
  672. <?xml version="1.0" encoding="utf-8" ?>
  673. <xsd:schema xmlns="http://symfony.com/schema"
  674. xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  675. targetNamespace="http://symfony.com/schema"
  676. elementFormDefault="qualified">
  678. <xsd:import namespace="http://www.w3.org/XML/1998/namespace"/>
  679. $imports
  680. </xsd:schema>
  681. EOF
  682. ;
  684. if ($this->shouldEnableEntityLoader()) {
  685. $disableEntities = libxml_disable_entity_loader(false);
  686. $valid = @$dom->schemaValidateSource($source);
  687. libxml_disable_entity_loader($disableEntities);
  688. } else {
  689. $valid = @$dom->schemaValidateSource($source);
  690. }
  691. foreach ($tmpfiles as $tmpfile) {
  692. @unlink($tmpfile);
  693. }
  695. return $valid;
  696. }
  698. private function shouldEnableEntityLoader(): bool
  699. {
  700. // Version prior to 8.0 can be enabled without deprecation
  701. if (\PHP_VERSION_ID < 80000) {
  702. return true;
  703. }
  705. static $dom, $schema;
  706. if (null === $dom) {
  707. $dom = new \DOMDocument();
  708. $dom->loadXML('<?xml version="1.0"?><test/>');
  710. $tmpfile = tempnam(sys_get_temp_dir(), 'symfony');
  711. register_shutdown_function(static function () use ($tmpfile) {
  712. @unlink($tmpfile);
  713. });
  714. $schema = '<?xml version="1.0" encoding="utf-8"?>
  715. <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  716. <xsd:include schemaLocation="file:///'.rawurlencode(str_replace('\\', '/', $tmpfile)).'" />
  717. </xsd:schema>';
  718. file_put_contents($tmpfile, '<?xml version="1.0" encoding="utf-8"?>
  719. <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  720. <xsd:element name="test" type="testType" />
  721. <xsd:complexType name="testType"/>
  722. </xsd:schema>');
  723. }
  725. return !@$dom->schemaValidateSource($schema);
  726. }
  728. private function validateAlias(\DOMElement $alias, string $file)
  729. {
  730. foreach ($alias->attributes as $name => $node) {
  731. if (!\in_array($name, ['alias', 'id', 'public'])) {
  732. throw new InvalidArgumentException(sprintf('Invalid attribute "%s" defined for alias "%s" in "%s".', $name, $alias->getAttribute('id'), $file));
  733. }
  734. }
  736. foreach ($alias->childNodes as $child) {
  737. if (!$child instanceof \DOMElement || self::NS !== $child->namespaceURI) {
  738. continue;
  739. }
  740. if (!\in_array($child->localName, ['deprecated'], true)) {
  741. throw new InvalidArgumentException(sprintf('Invalid child element "%s" defined for alias "%s" in "%s".', $child->localName, $alias->getAttribute('id'), $file));
  742. }
  743. }
  744. }
  746. /**
  747. * Validates an extension.
  748. *
  749. * @throws InvalidArgumentException When no extension is found corresponding to a tag
  750. */
  751. private function validateExtensions(\DOMDocument $dom, string $file)
  752. {
  753. foreach ($dom->documentElement->childNodes as $node) {
  754. if (!$node instanceof \DOMElement || 'http://symfony.com/schema/dic/services' === $node->namespaceURI) {
  755. continue;
  756. }
  758. // can it be handled by an extension?
  759. if (!$this->container->hasExtension($node->namespaceURI)) {
  760. $extensionNamespaces = array_filter(array_map(function (ExtensionInterface $ext) { return $ext->getNamespace(); }, $this->container->getExtensions()));
  761. 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'));
  762. }
  763. }
  764. }
  766. /**
  767. * Loads from an extension.
  768. */
  769. private function loadFromExtensions(\DOMDocument $xml)
  770. {
  771. foreach ($xml->documentElement->childNodes as $node) {
  772. if (!$node instanceof \DOMElement || self::NS === $node->namespaceURI) {
  773. continue;
  774. }
  776. $values = static::convertDomElementToArray($node);
  777. if (!\is_array($values)) {
  778. $values = [];
  779. }
  781. $this->container->loadFromExtension($node->namespaceURI, $values);
  782. }
  783. }
  785. /**
  786. * Converts a \DOMElement object to a PHP array.
  787. *
  788. * The following rules applies during the conversion:
  789. *
  790. * * Each tag is converted to a key value or an array
  791. * if there is more than one "value"
  792. *
  793. * * The content of a tag is set under a "value" key (<foo>bar</foo>)
  794. * if the tag also has some nested tags
  795. *
  796. * * The attributes are converted to keys (<foo foo="bar"/>)
  797. *
  798. * * The nested-tags are converted to keys (<foo><foo>bar</foo></foo>)
  799. *
  800. * @param \DOMElement $element A \DOMElement instance
  801. *
  802. * @return mixed
  803. */
  804. public static function convertDomElementToArray(\DOMElement $element)
  805. {
  806. return XmlUtils::convertDomElementToArray($element, false);
  807. }
  808. }