123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405 |
- <?php
- // @codingStandardsIgnoreFile
- namespace Drupal\Core\DependencyInjection;
- use Drupal\Component\FileCache\FileCacheFactory;
- use Drupal\Core\Serialization\Yaml;
- use Symfony\Component\DependencyInjection\Alias;
- use Symfony\Component\DependencyInjection\ContainerInterface;
- use Symfony\Component\DependencyInjection\Definition;
- use Symfony\Component\DependencyInjection\ChildDefinition;
- use Symfony\Component\DependencyInjection\Reference;
- use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
- /**
- * YamlFileLoader loads YAML files service definitions.
- *
- * Drupal does not use Symfony's Config component, and Symfony's dependency on
- * it cannot be removed easily. Therefore, this is a partial but mostly literal
- * copy of upstream, which does not depend on the Config component.
- *
- * @see \Symfony\Component\DependencyInjection\Loader\YamlFileLoader
- * @see https://github.com/symfony/symfony/pull/10920
- *
- * NOTE: 98% of this code is a literal copy of Symfony's YamlFileLoader.
- *
- * This file does NOT follow Drupal coding standards, so as to simplify future
- * synchronizations.
- */
- class YamlFileLoader
- {
- /**
- * @var \Drupal\Core\DependencyInjection\ContainerBuilder $container
- */
- protected $container;
- /**
- * File cache object.
- *
- * @var \Drupal\Component\FileCache\FileCacheInterface
- */
- protected $fileCache;
- public function __construct(ContainerBuilder $container)
- {
- $this->container = $container;
- $this->fileCache = FileCacheFactory::get('container_yaml_loader');
- }
- /**
- * Loads a Yaml file.
- *
- * @param mixed $file
- * The resource
- */
- public function load($file)
- {
- // Load from the file cache, fall back to loading the file.
- $content = $this->fileCache->get($file);
- if (!$content) {
- $content = $this->loadFile($file);
- $this->fileCache->set($file, $content);
- }
- // Not supported.
- //$this->container->addResource(new FileResource($path));
- // empty file
- if (null === $content) {
- return;
- }
- // imports
- // Not supported.
- //$this->parseImports($content, $file);
- // parameters
- if (isset($content['parameters'])) {
- if (!is_array($content['parameters'])) {
- throw new InvalidArgumentException(sprintf('The "parameters" key should contain an array in %s. Check your YAML syntax.', $file));
- }
- foreach ($content['parameters'] as $key => $value) {
- $this->container->setParameter($key, $this->resolveServices($value));
- }
- }
- // extensions
- // Not supported.
- //$this->loadFromExtensions($content);
- // services
- $this->parseDefinitions($content, $file);
- }
- /**
- * Parses definitions
- *
- * @param array $content
- * @param string $file
- */
- private function parseDefinitions($content, $file)
- {
- if (!isset($content['services'])) {
- return;
- }
- if (!is_array($content['services'])) {
- throw new InvalidArgumentException(sprintf('The "services" key should contain an array in %s. Check your YAML syntax.', $file));
- }
- // Some extensions split up their dependencies into multiple files.
- if (isset($content['_provider'])) {
- $provider = $content['_provider'];
- }
- else {
- $basename = basename($file);
- list($provider, ) = explode('.', $basename, 2);
- }
- foreach ($content['services'] as $id => $service) {
- $service['tags'][] = ['name' => '_provider', 'provider' => $provider];
- $this->parseDefinition($id, $service, $file);
- }
- }
- /**
- * Parses a definition.
- *
- * @param string $id
- * @param array $service
- * @param string $file
- *
- * @throws InvalidArgumentException
- * When tags are invalid.
- */
- private function parseDefinition($id, $service, $file)
- {
- if (is_string($service) && 0 === strpos($service, '@')) {
- $this->container->setAlias($id, substr($service, 1));
- return;
- }
- if (!is_array($service)) {
- throw new InvalidArgumentException(sprintf('A service definition must be an array or a string starting with "@" but %s found for service "%s" in %s. Check your YAML syntax.', gettype($service), $id, $file));
- }
- if (isset($service['alias'])) {
- $public = !array_key_exists('public', $service) || (bool) $service['public'];
- $this->container->setAlias($id, new Alias($service['alias'], $public));
- return;
- }
- if (isset($service['parent'])) {
- $definition = new ChildDefinition($service['parent']);
- } else {
- $definition = new Definition();
- }
- if (isset($service['class'])) {
- $definition->setClass($service['class']);
- }
- if (isset($service['shared'])) {
- $definition->setShared($service['shared']);
- }
- if (isset($service['synthetic'])) {
- $definition->setSynthetic($service['synthetic']);
- }
- if (isset($service['lazy'])) {
- $definition->setLazy($service['lazy']);
- }
- if (isset($service['public'])) {
- $definition->setPublic($service['public']);
- }
- if (isset($service['abstract'])) {
- $definition->setAbstract($service['abstract']);
- }
- if (array_key_exists('deprecated', $service)) {
- $definition->setDeprecated(true, $service['deprecated']);
- }
- if (isset($service['factory'])) {
- if (is_string($service['factory'])) {
- if (strpos($service['factory'], ':') !== false && strpos($service['factory'], '::') === false) {
- $parts = explode(':', $service['factory']);
- $definition->setFactory(array($this->resolveServices('@'.$parts[0]), $parts[1]));
- } else {
- $definition->setFactory($service['factory']);
- }
- } else {
- $definition->setFactory(array($this->resolveServices($service['factory'][0]), $service['factory'][1]));
- }
- }
- if (isset($service['factory_class'])) {
- $definition->setFactory($service['factory_class']);
- }
- if (isset($service['factory_method'])) {
- $definition->setFactory($service['factory_method']);
- }
- if (isset($service['factory_service'])) {
- $definition->setFactory($service['factory_service']);
- }
- if (isset($service['file'])) {
- $definition->setFile($service['file']);
- }
- if (isset($service['arguments'])) {
- $definition->setArguments($this->resolveServices($service['arguments']));
- }
- if (isset($service['properties'])) {
- $definition->setProperties($this->resolveServices($service['properties']));
- }
- if (isset($service['configurator'])) {
- if (is_string($service['configurator'])) {
- $definition->setConfigurator($service['configurator']);
- } else {
- $definition->setConfigurator(array($this->resolveServices($service['configurator'][0]), $service['configurator'][1]));
- }
- }
- if (isset($service['calls'])) {
- if (!is_array($service['calls'])) {
- throw new InvalidArgumentException(sprintf('Parameter "calls" must be an array for service "%s" in %s. Check your YAML syntax.', $id, $file));
- }
- foreach ($service['calls'] as $call) {
- if (isset($call['method'])) {
- $method = $call['method'];
- $args = isset($call['arguments']) ? $this->resolveServices($call['arguments']) : array();
- } else {
- $method = $call[0];
- $args = isset($call[1]) ? $this->resolveServices($call[1]) : array();
- }
- $definition->addMethodCall($method, $args);
- }
- }
- if (isset($service['tags'])) {
- if (!is_array($service['tags'])) {
- throw new InvalidArgumentException(sprintf('Parameter "tags" must be an array for service "%s" in %s. Check your YAML syntax.', $id, $file));
- }
- foreach ($service['tags'] as $tag) {
- if (!is_array($tag)) {
- throw new InvalidArgumentException(sprintf('A "tags" entry must be an array for service "%s" in %s. Check your YAML syntax.', $id, $file));
- }
- if (!isset($tag['name'])) {
- throw new InvalidArgumentException(sprintf('A "tags" entry is missing a "name" key for service "%s" in %s.', $id, $file));
- }
- $name = $tag['name'];
- unset($tag['name']);
- foreach ($tag as $attribute => $value) {
- if (!is_scalar($value) && null !== $value) {
- throw new InvalidArgumentException(sprintf('A "tags" attribute must be of a scalar-type for service "%s", tag "%s", attribute "%s" in %s. Check your YAML syntax.', $id, $name, $attribute, $file));
- }
- }
- $definition->addTag($name, $tag);
- }
- }
- if (isset($service['decorates'])) {
- $renameId = isset($service['decoration_inner_name']) ? $service['decoration_inner_name'] : null;
- $priority = isset($service['decoration_priority']) ? $service['decoration_priority'] : 0;
- $definition->setDecoratedService($service['decorates'], $renameId, $priority);
- }
- if (isset($service['autowire'])) {
- $definition->setAutowired($service['autowire']);
- }
- if (isset($service['autowiring_types'])) {
- if (is_string($service['autowiring_types'])) {
- $definition->addAutowiringType($service['autowiring_types']);
- } else {
- if (!is_array($service['autowiring_types'])) {
- throw new InvalidArgumentException(sprintf('Parameter "autowiring_types" must be a string or an array for service "%s" in %s. Check your YAML syntax.', $id, $file));
- }
- foreach ($service['autowiring_types'] as $autowiringType) {
- if (!is_string($autowiringType)) {
- throw new InvalidArgumentException(sprintf('A "autowiring_types" attribute must be of type string for service "%s" in %s. Check your YAML syntax.', $id, $file));
- }
- $definition->addAutowiringType($autowiringType);
- }
- }
- }
- $this->container->setDefinition($id, $definition);
- }
- /**
- * Loads a YAML file.
- *
- * @param string $file
- *
- * @return array The file content
- *
- * @throws InvalidArgumentException
- * When the given file is not a local file or when it does not exist.
- */
- protected function loadFile($file)
- {
- if (!stream_is_local($file)) {
- throw new InvalidArgumentException(sprintf('This is not a local file "%s".', $file));
- }
- if (!file_exists($file)) {
- throw new InvalidArgumentException(sprintf('The service file "%s" is not valid.', $file));
- }
- return $this->validate(Yaml::decode(file_get_contents($file)), $file);
- }
- /**
- * Validates a YAML file.
- *
- * @param mixed $content
- * @param string $file
- *
- * @return array
- *
- * @throws InvalidArgumentException
- * When service file is not valid.
- */
- private function validate($content, $file)
- {
- if (null === $content) {
- return $content;
- }
- if (!is_array($content)) {
- throw new InvalidArgumentException(sprintf('The service file "%s" is not valid. It should contain an array. Check your YAML syntax.', $file));
- }
- if ($invalid_keys = array_diff_key($content, array('parameters' => 1, 'services' => 1))) {
- throw new InvalidArgumentException(sprintf('The service file "%s" is not valid: it contains invalid keys %s. Services have to be added under "services" and Parameters under "parameters".', $file, $invalid_keys));
- }
- return $content;
- }
- /**
- * Resolves services.
- *
- * @param string|array $value
- *
- * @return array|string|Reference
- */
- private function resolveServices($value)
- {
- if (is_array($value)) {
- $value = array_map(array($this, 'resolveServices'), $value);
- } elseif (is_string($value) && 0 === strpos($value, '@=')) {
- // Not supported.
- //return new Expression(substr($value, 2));
- throw new InvalidArgumentException(sprintf("'%s' is an Expression, but expressions are not supported.", $value));
- } elseif (is_string($value) && 0 === strpos($value, '@')) {
- if (0 === strpos($value, '@@')) {
- $value = substr($value, 1);
- $invalidBehavior = null;
- } elseif (0 === strpos($value, '@?')) {
- $value = substr($value, 2);
- $invalidBehavior = ContainerInterface::IGNORE_ON_INVALID_REFERENCE;
- } else {
- $value = substr($value, 1);
- $invalidBehavior = ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE;
- }
- if ('=' === substr($value, -1)) {
- $value = substr($value, 0, -1);
- $strict = false;
- } else {
- $strict = true;
- }
- if (null !== $invalidBehavior) {
- $value = new Reference($value, $invalidBehavior, $strict);
- }
- }
- return $value;
- }
- }
|