yaffs.net Git - yaffs-website/blob - vendor/symfony/dependency-injection/Loader/XmlFileLoader.php

   1 <?php
   2
   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  */
  11
  12 namespace Symfony\Component\DependencyInjection\Loader;
  13
  14 use Symfony\Component\Config\Resource\FileResource;
  15 use Symfony\Component\Config\Util\XmlUtils;
  16 use Symfony\Component\DependencyInjection\DefinitionDecorator;
  17 use Symfony\Component\DependencyInjection\ContainerInterface;
  18 use Symfony\Component\DependencyInjection\Alias;
  19 use Symfony\Component\DependencyInjection\Definition;
  20 use Symfony\Component\DependencyInjection\Reference;
  21 use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
  22 use Symfony\Component\DependencyInjection\Exception\RuntimeException;
  23 use Symfony\Component\ExpressionLanguage\Expression;
  24
  25 /**
  26  * XmlFileLoader loads XML files service definitions.
  27  *
  28  * @author Fabien Potencier <fabien@symfony.com>
  29  */
  30 class XmlFileLoader extends FileLoader
  31 {
  32     const NS = 'http://symfony.com/schema/dic/services';
  33
  34     /**
  35      * {@inheritdoc}
  36      */
  37     public function load($resource, $type = null)
  38     {
  39         $path = $this->locator->locate($resource);
  40
  41         $xml = $this->parseFileToDOM($path);
  42
  43         $this->container->addResource(new FileResource($path));
  44
  45         // anonymous services
  46         $this->processAnonymousServices($xml, $path);
  47
  48         // imports
  49         $this->parseImports($xml, $path);
  50
  51         // parameters
  52         $this->parseParameters($xml);
  53
  54         // extensions
  55         $this->loadFromExtensions($xml);
  56
  57         // services
  58         $this->parseDefinitions($xml, $path);
  59     }
  60
  61     /**
  62      * {@inheritdoc}
  63      */
  64     public function supports($resource, $type = null)
  65     {
  66         return is_string($resource) && 'xml' === pathinfo($resource, PATHINFO_EXTENSION);
  67     }
  68
  69     /**
  70      * Parses parameters.
  71      *
  72      * @param \DOMDocument $xml
  73      */
  74     private function parseParameters(\DOMDocument $xml)
  75     {
  76         if ($parameters = $this->getChildren($xml->documentElement, 'parameters')) {
  77             $this->container->getParameterBag()->add($this->getArgumentsAsPhp($parameters[0], 'parameter'));
  78         }
  79     }
  80
  81     /**
  82      * Parses imports.
  83      *
  84      * @param \DOMDocument $xml
  85      * @param string       $file
  86      */
  87     private function parseImports(\DOMDocument $xml, $file)
  88     {
  89         $xpath = new \DOMXPath($xml);
  90         $xpath->registerNamespace('container', self::NS);
  91
  92         if (false === $imports = $xpath->query('//container:imports/container:import')) {
  93             return;
  94         }
  95
  96         $defaultDirectory = dirname($file);
  97         foreach ($imports as $import) {
  98             $this->setCurrentDir($defaultDirectory);
  99             $this->import($import->getAttribute('resource'), null, (bool) XmlUtils::phpize($import->getAttribute('ignore-errors')), $file);
 100         }
 101     }
 102
 103     /**
 104      * Parses multiple definitions.
 105      *
 106      * @param \DOMDocument $xml
 107      * @param string       $file
 108      */
 109     private function parseDefinitions(\DOMDocument $xml, $file)
 110     {
 111         $xpath = new \DOMXPath($xml);
 112         $xpath->registerNamespace('container', self::NS);
 113
 114         if (false === $services = $xpath->query('//container:services/container:service')) {
 115             return;
 116         }
 117
 118         foreach ($services as $service) {
 119             if (null !== $definition = $this->parseDefinition($service, $file)) {
 120                 $this->container->setDefinition((string) $service->getAttribute('id'), $definition);
 121             }
 122         }
 123     }
 124
 125     /**
 126      * Parses an individual Definition.
 127      *
 128      * @param \DOMElement $service
 129      * @param string      $file
 130      *
 131      * @return Definition|null
 132      */
 133     private function parseDefinition(\DOMElement $service, $file)
 134     {
 135         if ($alias = $service->getAttribute('alias')) {
 136             $public = true;
 137             if ($publicAttr = $service->getAttribute('public')) {
 138                 $public = XmlUtils::phpize($publicAttr);
 139             }
 140             $this->container->setAlias((string) $service->getAttribute('id'), new Alias($alias, $public));
 141
 142             return;
 143         }
 144
 145         if ($parent = $service->getAttribute('parent')) {
 146             $definition = new DefinitionDecorator($parent);
 147         } else {
 148             $definition = new Definition();
 149         }
 150
 151         foreach (array('class', 'shared', 'public', 'factory-class', 'factory-method', 'factory-service', 'synthetic', 'lazy', 'abstract') as $key) {
 152             if ($value = $service->getAttribute($key)) {
 153                 if (in_array($key, array('factory-class', 'factory-method', 'factory-service'))) {
 154                     @trigger_error(sprintf('The "%s" attribute of service "%s" in file "%s" is deprecated since version 2.6 and will be removed in 3.0. Use the "factory" element instead.', $key, (string) $service->getAttribute('id'), $file), E_USER_DEPRECATED);
 155                 }
 156                 $method = 'set'.str_replace('-', '', $key);
 157                 $definition->$method(XmlUtils::phpize($value));
 158             }
 159         }
 160
 161         if ($value = $service->getAttribute('autowire')) {
 162             $definition->setAutowired(XmlUtils::phpize($value));
 163         }
 164
 165         if ($value = $service->getAttribute('scope')) {
 166             $triggerDeprecation = 'request' !== (string) $service->getAttribute('id');
 167
 168             if ($triggerDeprecation) {
 169                 @trigger_error(sprintf('The "scope" attribute of service "%s" in file "%s" is deprecated since version 2.8 and will be removed in 3.0.', (string) $service->getAttribute('id'), $file), E_USER_DEPRECATED);
 170             }
 171
 172             $definition->setScope(XmlUtils::phpize($value), false);
 173         }
 174
 175         if ($value = $service->getAttribute('synchronized')) {
 176             $triggerDeprecation = 'request' !== (string) $service->getAttribute('id');
 177
 178             if ($triggerDeprecation) {
 179                 @trigger_error(sprintf('The "synchronized" attribute of service "%s" in file "%s" is deprecated since version 2.7 and will be removed in 3.0.', (string) $service->getAttribute('id'), $file), E_USER_DEPRECATED);
 180             }
 181
 182             $definition->setSynchronized(XmlUtils::phpize($value), $triggerDeprecation);
 183         }
 184
 185         if ($files = $this->getChildren($service, 'file')) {
 186             $definition->setFile($files[0]->nodeValue);
 187         }
 188
 189         if ($deprecated = $this->getChildren($service, 'deprecated')) {
 190             $definition->setDeprecated(true, $deprecated[0]->nodeValue ?: null);
 191         }
 192
 193         $definition->setArguments($this->getArgumentsAsPhp($service, 'argument'));
 194         $definition->setProperties($this->getArgumentsAsPhp($service, 'property'));
 195
 196         if ($factories = $this->getChildren($service, 'factory')) {
 197             $factory = $factories[0];
 198             if ($function = $factory->getAttribute('function')) {
 199                 $definition->setFactory($function);
 200             } else {
 201                 $factoryService = $this->getChildren($factory, 'service');
 202
 203                 if (isset($factoryService[0])) {
 204                     $class = $this->parseDefinition($factoryService[0], $file);
 205                 } elseif ($childService = $factory->getAttribute('service')) {
 206                     $class = new Reference($childService, ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE, false);
 207                 } else {
 208                     $class = $factory->getAttribute('class');
 209                 }
 210
 211                 $definition->setFactory(array($class, $factory->getAttribute('method')));
 212             }
 213         }
 214
 215         if ($configurators = $this->getChildren($service, 'configurator')) {
 216             $configurator = $configurators[0];
 217             if ($function = $configurator->getAttribute('function')) {
 218                 $definition->setConfigurator($function);
 219             } else {
 220                 $configuratorService = $this->getChildren($configurator, 'service');
 221
 222                 if (isset($configuratorService[0])) {
 223                     $class = $this->parseDefinition($configuratorService[0], $file);
 224                 } elseif ($childService = $configurator->getAttribute('service')) {
 225                     $class = new Reference($childService, ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE, false);
 226                 } else {
 227                     $class = $configurator->getAttribute('class');
 228                 }
 229
 230                 $definition->setConfigurator(array($class, $configurator->getAttribute('method')));
 231             }
 232         }
 233
 234         foreach ($this->getChildren($service, 'call') as $call) {
 235             $definition->addMethodCall($call->getAttribute('method'), $this->getArgumentsAsPhp($call, 'argument'));
 236         }
 237
 238         foreach ($this->getChildren($service, 'tag') as $tag) {
 239             $parameters = array();
 240             foreach ($tag->attributes as $name => $node) {
 241                 if ('name' === $name) {
 242                     continue;
 243                 }
 244
 245                 if (false !== strpos($name, '-') && false === strpos($name, '_') && !array_key_exists($normalizedName = str_replace('-', '_', $name), $parameters)) {
 246                     $parameters[$normalizedName] = XmlUtils::phpize($node->nodeValue);
 247                 }
 248                 // keep not normalized key for BC too
 249                 $parameters[$name] = XmlUtils::phpize($node->nodeValue);
 250             }
 251
 252             if ('' === $tag->getAttribute('name')) {
 253                 throw new InvalidArgumentException(sprintf('The tag name for service "%s" in %s must be a non-empty string.', (string) $service->getAttribute('id'), $file));
 254             }
 255
 256             $definition->addTag($tag->getAttribute('name'), $parameters);
 257         }
 258
 259         foreach ($this->getChildren($service, 'autowiring-type') as $type) {
 260             $definition->addAutowiringType($type->textContent);
 261         }
 262
 263         if ($value = $service->getAttribute('decorates')) {
 264             $renameId = $service->hasAttribute('decoration-inner-name') ? $service->getAttribute('decoration-inner-name') : null;
 265             $priority = $service->hasAttribute('decoration-priority') ? $service->getAttribute('decoration-priority') : 0;
 266             $definition->setDecoratedService($value, $renameId, $priority);
 267         }
 268
 269         return $definition;
 270     }
 271
 272     /**
 273      * Parses a XML file to a \DOMDocument.
 274      *
 275      * @param string $file Path to a file
 276      *
 277      * @return \DOMDocument
 278      *
 279      * @throws InvalidArgumentException When loading of XML file returns error
 280      */
 281     private function parseFileToDOM($file)
 282     {
 283         try {
 284             $dom = XmlUtils::loadFile($file, array($this, 'validateSchema'));
 285         } catch (\InvalidArgumentException $e) {
 286             throw new InvalidArgumentException(sprintf('Unable to parse file "%s".', $file), $e->getCode(), $e);
 287         }
 288
 289         $this->validateExtensions($dom, $file);
 290
 291         return $dom;
 292     }
 293
 294     /**
 295      * Processes anonymous services.
 296      *
 297      * @param \DOMDocument $xml
 298      * @param string       $file
 299      */
 300     private function processAnonymousServices(\DOMDocument $xml, $file)
 301     {
 302         $definitions = array();
 303         $count = 0;
 304
 305         $xpath = new \DOMXPath($xml);
 306         $xpath->registerNamespace('container', self::NS);
 307
 308         // anonymous services as arguments/properties
 309         if (false !== $nodes = $xpath->query('//container:argument[@type="service"][not(@id)]|//container:property[@type="service"][not(@id)]')) {
 310             foreach ($nodes as $node) {
 311                 // give it a unique name
 312                 $id = sprintf('%s_%d', hash('sha256', $file), ++$count);
 313                 $node->setAttribute('id', $id);
 314
 315                 if ($services = $this->getChildren($node, 'service')) {
 316                     $definitions[$id] = array($services[0], $file, false);
 317                     $services[0]->setAttribute('id', $id);
 318
 319                     // anonymous services are always private
 320                     // we could not use the constant false here, because of XML parsing
 321                     $services[0]->setAttribute('public', 'false');
 322                 }
 323             }
 324         }
 325
 326         // anonymous services "in the wild"
 327         if (false !== $nodes = $xpath->query('//container:services/container:service[not(@id)]')) {
 328             foreach ($nodes as $node) {
 329                 // give it a unique name
 330                 $id = sprintf('%s_%d', hash('sha256', $file), ++$count);
 331                 $node->setAttribute('id', $id);
 332                 $definitions[$id] = array($node, $file, true);
 333             }
 334         }
 335
 336         // resolve definitions
 337         krsort($definitions);
 338         foreach ($definitions as $id => $def) {
 339             list($domElement, $file, $wild) = $def;
 340
 341             if (null !== $definition = $this->parseDefinition($domElement, $file)) {
 342                 $this->container->setDefinition($id, $definition);
 343             }
 344
 345             if (true === $wild) {
 346                 $tmpDomElement = new \DOMElement('_services', null, self::NS);
 347                 $domElement->parentNode->replaceChild($tmpDomElement, $domElement);
 348                 $tmpDomElement->setAttribute('id', $id);
 349             } else {
 350                 $domElement->parentNode->removeChild($domElement);
 351             }
 352         }
 353     }
 354
 355     /**
 356      * Returns arguments as valid php types.
 357      *
 358      * @param \DOMElement $node
 359      * @param string      $name
 360      * @param bool        $lowercase
 361      *
 362      * @return mixed
 363      */
 364     private function getArgumentsAsPhp(\DOMElement $node, $name, $lowercase = true)
 365     {
 366         $arguments = array();
 367         foreach ($this->getChildren($node, $name) as $arg) {
 368             if ($arg->hasAttribute('name')) {
 369                 $arg->setAttribute('key', $arg->getAttribute('name'));
 370             }
 371
 372             // this is used by DefinitionDecorator to overwrite a specific
 373             // argument of the parent definition
 374             if ($arg->hasAttribute('index')) {
 375                 $key = 'index_'.$arg->getAttribute('index');
 376             } elseif (!$arg->hasAttribute('key')) {
 377                 // Append an empty argument, then fetch its key to overwrite it later
 378                 $arguments[] = null;
 379                 $keys = array_keys($arguments);
 380                 $key = array_pop($keys);
 381             } else {
 382                 $key = $arg->getAttribute('key');
 383
 384                 // parameter keys are case insensitive
 385                 if ('parameter' == $name && $lowercase) {
 386                     $key = strtolower($key);
 387                 }
 388             }
 389
 390             switch ($arg->getAttribute('type')) {
 391                 case 'service':
 392                     $onInvalid = $arg->getAttribute('on-invalid');
 393                     $invalidBehavior = ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE;
 394                     if ('ignore' == $onInvalid) {
 395                         $invalidBehavior = ContainerInterface::IGNORE_ON_INVALID_REFERENCE;
 396                     } elseif ('null' == $onInvalid) {
 397                         $invalidBehavior = ContainerInterface::NULL_ON_INVALID_REFERENCE;
 398                     }
 399
 400                     if ($strict = $arg->getAttribute('strict')) {
 401                         $strict = XmlUtils::phpize($strict);
 402                     } else {
 403                         $strict = true;
 404                     }
 405
 406                     $arguments[$key] = new Reference($arg->getAttribute('id'), $invalidBehavior, $strict);
 407                     break;
 408                 case 'expression':
 409                     $arguments[$key] = new Expression($arg->nodeValue);
 410                     break;
 411                 case 'collection':
 412                     $arguments[$key] = $this->getArgumentsAsPhp($arg, $name, false);
 413                     break;
 414                 case 'string':
 415                     $arguments[$key] = $arg->nodeValue;
 416                     break;
 417                 case 'constant':
 418                     $arguments[$key] = constant(trim($arg->nodeValue));
 419                     break;
 420                 default:
 421                     $arguments[$key] = XmlUtils::phpize($arg->nodeValue);
 422             }
 423         }
 424
 425         return $arguments;
 426     }
 427
 428     /**
 429      * Get child elements by name.
 430      *
 431      * @param \DOMNode $node
 432      * @param mixed    $name
 433      *
 434      * @return array
 435      */
 436     private function getChildren(\DOMNode $node, $name)
 437     {
 438         $children = array();
 439         foreach ($node->childNodes as $child) {
 440             if ($child instanceof \DOMElement && $child->localName === $name && $child->namespaceURI === self::NS) {
 441                 $children[] = $child;
 442             }
 443         }
 444
 445         return $children;
 446     }
 447
 448     /**
 449      * Validates a documents XML schema.
 450      *
 451      * @param \DOMDocument $dom
 452      *
 453      * @return bool
 454      *
 455      * @throws RuntimeException When extension references a non-existent XSD file
 456      */
 457     public function validateSchema(\DOMDocument $dom)
 458     {
 459         $schemaLocations = array('http://symfony.com/schema/dic/services' => str_replace('\\', '/', __DIR__.'/schema/dic/services/services-1.0.xsd'));
 460
 461         if ($element = $dom->documentElement->getAttributeNS('http://www.w3.org/2001/XMLSchema-instance', 'schemaLocation')) {
 462             $items = preg_split('/\s+/', $element);
 463             for ($i = 0, $nb = count($items); $i < $nb; $i += 2) {
 464                 if (!$this->container->hasExtension($items[$i])) {
 465                     continue;
 466                 }
 467
 468                 if (($extension = $this->container->getExtension($items[$i])) && false !== $extension->getXsdValidationBasePath()) {
 469                     $path = str_replace($extension->getNamespace(), str_replace('\\', '/', $extension->getXsdValidationBasePath()).'/', $items[$i + 1]);
 470
 471                     if (!is_file($path)) {
 472                         throw new RuntimeException(sprintf('Extension "%s" references a non-existent XSD file "%s"', get_class($extension), $path));
 473                     }
 474
 475                     $schemaLocations[$items[$i]] = $path;
 476                 }
 477             }
 478         }
 479
 480         $tmpfiles = array();
 481         $imports = '';
 482         foreach ($schemaLocations as $namespace => $location) {
 483             $parts = explode('/', $location);
 484             if (0 === stripos($location, 'phar://')) {
 485                 $tmpfile = tempnam(sys_get_temp_dir(), 'sf2');
 486                 if ($tmpfile) {
 487                     copy($location, $tmpfile);
 488                     $tmpfiles[] = $tmpfile;
 489                     $parts = explode('/', str_replace('\\', '/', $tmpfile));
 490                 }
 491             }
 492             $drive = '\\' === DIRECTORY_SEPARATOR ? array_shift($parts).'/' : '';
 493             $location = 'file:///'.$drive.implode('/', array_map('rawurlencode', $parts));
 494
 495             $imports .= sprintf('  <xsd:import namespace="%s" schemaLocation="%s" />'."\n", $namespace, $location);
 496         }
 497
 498         $source = <<<EOF
 499 <?xml version="1.0" encoding="utf-8" ?>
 500 <xsd:schema xmlns="http://symfony.com/schema"
 501     xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 502     targetNamespace="http://symfony.com/schema"
 503     elementFormDefault="qualified">
 504
 505     <xsd:import namespace="http://www.w3.org/XML/1998/namespace"/>
 506 $imports
 507 </xsd:schema>
 508 EOF
 509         ;
 510
 511         $disableEntities = libxml_disable_entity_loader(false);
 512         $valid = @$dom->schemaValidateSource($source);
 513         libxml_disable_entity_loader($disableEntities);
 514
 515         foreach ($tmpfiles as $tmpfile) {
 516             @unlink($tmpfile);
 517         }
 518
 519         return $valid;
 520     }
 521
 522     /**
 523      * Validates an extension.
 524      *
 525      * @param \DOMDocument $dom
 526      * @param string       $file
 527      *
 528      * @throws InvalidArgumentException When no extension is found corresponding to a tag
 529      */
 530     private function validateExtensions(\DOMDocument $dom, $file)
 531     {
 532         foreach ($dom->documentElement->childNodes as $node) {
 533             if (!$node instanceof \DOMElement || 'http://symfony.com/schema/dic/services' === $node->namespaceURI) {
 534                 continue;
 535             }
 536
 537             // can it be handled by an extension?
 538             if (!$this->container->hasExtension($node->namespaceURI)) {
 539                 $extensionNamespaces = array_filter(array_map(function ($ext) { return $ext->getNamespace(); }, $this->container->getExtensions()));
 540                 throw new InvalidArgumentException(sprintf(
 541                     'There is no extension able to load the configuration for "%s" (in %s). Looked for namespace "%s", found %s',
 542                     $node->tagName,
 543                     $file,
 544                     $node->namespaceURI,
 545                     $extensionNamespaces ? sprintf('"%s"', implode('", "', $extensionNamespaces)) : 'none'
 546                 ));
 547             }
 548         }
 549     }
 550
 551     /**
 552      * Loads from an extension.
 553      *
 554      * @param \DOMDocument $xml
 555      */
 556     private function loadFromExtensions(\DOMDocument $xml)
 557     {
 558         foreach ($xml->documentElement->childNodes as $node) {
 559             if (!$node instanceof \DOMElement || $node->namespaceURI === self::NS) {
 560                 continue;
 561             }
 562
 563             $values = static::convertDomElementToArray($node);
 564             if (!is_array($values)) {
 565                 $values = array();
 566             }
 567
 568             $this->container->loadFromExtension($node->namespaceURI, $values);
 569         }
 570     }
 571
 572     /**
 573      * Converts a \DomElement object to a PHP array.
 574      *
 575      * The following rules applies during the conversion:
 576      *
 577      *  * Each tag is converted to a key value or an array
 578      *    if there is more than one "value"
 579      *
 580      *  * The content of a tag is set under a "value" key (<foo>bar</foo>)
 581      *    if the tag also has some nested tags
 582      *
 583      *  * The attributes are converted to keys (<foo foo="bar"/>)
 584      *
 585      *  * The nested-tags are converted to keys (<foo><foo>bar</foo></foo>)
 586      *
 587      * @param \DomElement $element A \DomElement instance
 588      *
 589      * @return array A PHP array
 590      */
 591     public static function convertDomElementToArray(\DOMElement $element)
 592     {
 593         return XmlUtils::convertDomElementToArray($element);
 594     }
 595 }