vendor/ibexa/solr/src/bundle/DependencyInjection/IbexaSolrExtension.php line 296

Open in your IDE?
  1. <?php
  3. /**
  4.  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  5.  * @license For full copyright and license information view LICENSE file distributed with this source code.
  6.  */
  7. namespace Ibexa\Bundle\Solr\DependencyInjection;
  9. use Ibexa\Bundle\Solr\ApiLoader\BoostFactorProviderFactory;
  10. use Ibexa\Bundle\Solr\ApiLoader\SolrEngineFactory;
  11. use Ibexa\Solr\FieldMapper\BoostFactorProvider;
  12. use Ibexa\Solr\Gateway\DistributionStrategy\CloudDistributionStrategy;
  13. use Ibexa\Solr\Gateway\UpdateSerializerInterface;
  14. use Ibexa\Solr\Handler;
  15. use Symfony\Component\Config\FileLocator;
  16. use Symfony\Component\DependencyInjection\ChildDefinition;
  17. use Symfony\Component\DependencyInjection\ContainerBuilder;
  18. use Symfony\Component\DependencyInjection\Definition;
  19. use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
  20. use Symfony\Component\DependencyInjection\Reference;
  21. use Symfony\Component\HttpKernel\DependencyInjection\Extension;
  23. /**
  24.  * @phpstan-type SolrHttpClientConfigArray = array{timeout: int, max_retries: int}
  25.  */
  26. class IbexaSolrExtension extends Extension
  27. {
  28.     /**
  29.      * Main Solr search handler service ID.
  30.      *
  31.      * @var string
  32.      */
  33.     public const ENGINE_ID = Handler::class;
  35.     /**
  36.      * Configured core gateway service ID.
  37.      *
  38.      * Not using service alias since alias can't be passed for decoration.
  39.      *
  40.      * @var string
  41.      */
  42.     public const GATEWAY_ID = 'ibexa.solr.gateway.native';
  44.     /**
  45.      * Configured core filter service ID.
  46.      *
  47.      * Not using service alias since alias can't be passed for decoration.
  48.      *
  49.      * @var string
  50.      */
  51.     public const CORE_FILTER_ID = 'ibexa.solr.core_filter.native';
  53.     /**
  54.      * Configured core endpoint resolver service ID.
  55.      *
  56.      * Not using service alias since alias can't be passed for decoration.
  57.      *
  58.      * @var string
  59.      */
  60.     public const ENDPOINT_RESOLVER_ID = 'ibexa.solr.gateway.endpoint_resolver.native';
  62.     /**
  63.      * Endpoint class.
  64.      *
  65.      * @var string
  66.      */
  67.     public const ENDPOINT_CLASS = 'Ibexa\\Solr\\Gateway\\Endpoint';
  69.     /**
  70.      * Endpoint service tag.
  71.      *
  72.      * @var string
  73.      */
  74.     public const ENDPOINT_TAG = 'ibexa.search.solr.endpoint';
  76.     /**
  77.      * @var string
  78.      */
  79.     public const BOOST_FACTOR_PROVIDER_ID = BoostFactorProvider::class;
  81.     /**
  82.      * @var string
  83.      */
  84.     public const STANDALONE_DISTRIBUTION_STRATEGY_ID = 'ibexa.solr.gateway.distribution_strategy.abstract_standalone';
  86.     /**
  87.      * @var string
  88.      */
  89.     public const CLOUD_DISTRIBUTION_STRATEGY_ID = CloudDistributionStrategy::class;
  91.     public const GATEWAY_UPDATE_SERIALIZER_TAG = 'ibexa.solr.gateway.serializer.update';
  93.     public function getAlias()
  94.     {
  95.         return 'ibexa_solr';
  96.     }
  98.     public function getServicePrefix(): string
  99.     {
  100.         return 'ibexa.solr';
  101.     }
  103.     /**
  104.      * Loads a specific configuration.
  105.      *
  106.      * @param array $configs An array of configuration values
  107.      * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container A ContainerBuilder instance
  108.      *
  109.      * @throws \InvalidArgumentException When provided tag is not defined in this extension
  110.      *
  111.      * @api
  112.      */
  113.     public function load(array $configs, ContainerBuilder $container)
  114.     {
  115.         $configuration = $this->getConfiguration($configs, $container);
  116.         $config = $this->processConfiguration($configuration, $configs);
  118.         // Loading configuration from lib/Resources/config/container
  119.         $loader = new YamlFileLoader(
  120.             $container,
  121.             new FileLocator(__DIR__ . '/../../lib/Resources/config/container')
  122.         );
  123.         $loader->load('solr.yml');
  125.         $loader = new YamlFileLoader(
  126.             $container,
  127.             new FileLocator(__DIR__ . '/../Resources/config')
  128.         );
  129.         $loader->load('services.yml');
  131.         $this->processConnectionConfiguration($container, $config);
  133.         $container
  134.             ->registerForAutoconfiguration(UpdateSerializerInterface::class)
  135.             ->addTag(self::GATEWAY_UPDATE_SERIALIZER_TAG);
  136.     }
  138.     /**
  139.      * Processes connection configuration by flattening connection parameters
  140.      * and setting them to the container as parameters.
  141.      *
  142.      * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
  143.      * @param array $config
  144.      */
  145.     protected function processConnectionConfiguration(ContainerBuilder $container, array $config)
  146.     {
  147.         $alias = $this->getServicePrefix();
  149.         if (isset($config['default_connection'])) {
  150.             $container->setParameter(
  151.                 "{$alias}.default_connection",
  152.                 $config['default_connection']
  153.             );
  154.         } elseif (!empty($config['connections'])) {
  155.             reset($config['connections']);
  156.             $container->setParameter(
  157.                 "{$alias}.default_connection",
  158.                 key($config['connections'])
  159.             );
  160.         }
  162.         foreach ($config['connections'] as $name => $params) {
  163.             $this->configureSearchServices($container, $name, $params);
  164.             $this->configureBoostMap($container, $name, $params);
  165.             $this->configureIndexingDepth($container, $name, $params);
  167.             $container->setParameter("$alias.connection.$name", $params);
  168.         }
  170.         foreach ($config['endpoints'] as $name => $params) {
  171.             $this->defineEndpoint($container, $name, $params);
  172.         }
  174.         // Search engine itself, for given connection name
  175.         $searchEngineDef = $container->findDefinition(self::ENGINE_ID);
  176.         $searchEngineDef->setFactory([new Reference(SolrEngineFactory::class), 'buildEngine']);
  178.         // Factory for BoostFactorProvider uses mapping configured for the connection in use
  179.         $boostFactorProviderDef = $container->findDefinition(self::BOOST_FACTOR_PROVIDER_ID);
  180.         $boostFactorProviderDef->setFactory([new Reference(BoostFactorProviderFactory::class), 'buildService']);
  182.         if (isset($config['http_client'])) {
  183.             $this->configureHttpClient($container, $config['http_client']);
  184.         }
  185.     }
  187.     /**
  188.      * Creates needed search services for given connection name and parameters.
  189.      *
  190.      * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
  191.      * @param string $connectionName
  192.      * @param array $connectionParams
  193.      */
  194.     private function configureSearchServices(ContainerBuilder $container, $connectionName, $connectionParams)
  195.     {
  196.         $alias = $this->getServicePrefix();
  198.         // Endpoint resolver
  199.         $endpointResolverDefinition = new ChildDefinition(self::ENDPOINT_RESOLVER_ID);
  200.         $endpointResolverDefinition->replaceArgument(0, $connectionParams['entry_endpoints']);
  201.         $endpointResolverDefinition->replaceArgument(1, $connectionParams['mapping']['translations']);
  202.         $endpointResolverDefinition->replaceArgument(2, $connectionParams['mapping']['default']);
  203.         $endpointResolverDefinition->replaceArgument(3, $connectionParams['mapping']['main_translations']);
  204.         $endpointResolverId = "$alias.connection.$connectionName.endpoint_resolver_id";
  205.         $container->setDefinition($endpointResolverId, $endpointResolverDefinition);
  207.         // Core filter
  208.         $coreFilterDefinition = new ChildDefinition(self::CORE_FILTER_ID);
  209.         $coreFilterDefinition->replaceArgument(0, new Reference($endpointResolverId));
  210.         $coreFilterDefinition->addTag('ibexa.search.solr.core.filter', ['connection' => $connectionName]);
  211.         $coreFilterId = "$alias.connection.$connectionName.core_filter_id";
  212.         $container->setDefinition($coreFilterId, $coreFilterDefinition);
  214.         // Distribution Strategy
  215.         $distributionStrategyId = "$alias.connection.$connectionName.distribution_strategy";
  217.         switch ($connectionParams['distribution_strategy']) {
  218.             case 'standalone':
  219.                 $distributionStrategyDefinition = new ChildDefinition(self::STANDALONE_DISTRIBUTION_STRATEGY_ID);
  220.                 $distributionStrategyDefinition->setArgument(1, new Reference($endpointResolverId));
  221.                 break;
  222.             case 'cloud':
  223.                 $distributionStrategyDefinition = new ChildDefinition(self::CLOUD_DISTRIBUTION_STRATEGY_ID);
  224.                 $distributionStrategyDefinition->setArgument(1, new Reference($endpointResolverId));
  225.                 break;
  226.             default:
  227.                 throw new \RuntimeException('Unknown distribution strategy');
  228.         }
  230.         $container->setDefinition($distributionStrategyId, $distributionStrategyDefinition);
  232.         // Gateway
  233.         $gatewayDefinition = new ChildDefinition(self::GATEWAY_ID);
  234.         $gatewayDefinition->replaceArgument('$endpointResolver', new Reference($endpointResolverId));
  235.         $gatewayDefinition->replaceArgument('$distributionStrategy', new Reference($distributionStrategyId));
  236.         $gatewayDefinition->addTag('ibexa.search.solr.gateway', ['connection' => $connectionName]);
  238.         $gatewayId = "$alias.connection.$connectionName.gateway_id";
  239.         $container->setDefinition($gatewayId, $gatewayDefinition);
  240.     }
  242.     /**
  243.      * Creates boost factor map parameter for a given $connectionName.
  244.      *
  245.      * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
  246.      * @param string $connectionName
  247.      * @param array $connectionParams
  248.      */
  249.     private function configureBoostMap(ContainerBuilder $container, $connectionName, $connectionParams)
  250.     {
  251.         $alias = $this->getServicePrefix();
  252.         $boostFactorMap = $this->buildBoostFactorMap($connectionParams['boost_factors']);
  253.         $boostFactorMapId = "{$alias}.connection.{$connectionName}.boost_factor_map_id";
  255.         $container->setParameter($boostFactorMapId, $boostFactorMap);
  256.     }
  258.     /**
  259.      * Creates indexing depth map parameter for a given $connectionName.
  260.      *
  261.      * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
  262.      * @param string $connectionName
  263.      * @param array $connectionParams
  264.      */
  265.     private function configureIndexingDepth(ContainerBuilder $container, $connectionName, $connectionParams)
  266.     {
  267.         $alias = $this->getServicePrefix();
  269.         $defaultIndexingDepthId = "{$alias}.connection.{$connectionName}.indexing_depth.default";
  270.         $contentTypeIndexingDepthMapId = "{$alias}.connection.{$connectionName}.indexing_depth.map";
  272.         $container->setParameter($defaultIndexingDepthId, $connectionParams['indexing_depth']['default']);
  273.         $container->setParameter($contentTypeIndexingDepthMapId, $connectionParams['indexing_depth']['content_type']);
  274.     }
  276.     /**
  277.      * Creates Endpoint definition in the service container.
  278.      *
  279.      * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
  280.      * @param string $alias
  281.      * @param array $params
  282.      */
  283.     protected function defineEndpoint(ContainerBuilder $container, $alias, $params)
  284.     {
  285.         $definition = new Definition(self::ENDPOINT_CLASS, [$params]);
  286.         $definition->addTag(self::ENDPOINT_TAG, ['alias' => $alias]);
  288.         $container->setDefinition(
  289.             sprintf($this->getServicePrefix() . '.endpoints.%s', $alias),
  290.             $definition
  291.         );
  292.     }
  294.     public function getConfiguration(array $config, ContainerBuilder $container)
  295.     {
  296.         return new Configuration($this->getAlias());
  297.     }
  299.     /**
  300.      * Builds boost factor map from the given $config.
  301.      *
  302.      * @see \Ibexa\Solr\FieldMapper\BoostFactorProvider::$map
  303.      *
  304.      * @param array $config
  305.      *
  306.      * @return array
  307.      */
  308.     protected function buildBoostFactorMap(array $config)
  309.     {
  310.         $boostFactorMap = [];
  312.         foreach ($config['content_type'] as $typeIdentifier => $factor) {
  313.             $boostFactorMap['content-fields'][$typeIdentifier]['*'] = $factor;
  314.             $boostFactorMap['meta-fields'][$typeIdentifier]['*'] = $factor;
  315.         }
  317.         foreach ($config['field_definition'] as $typeIdentifier => $mapping) {
  318.             foreach ($mapping as $fieldIdentifier => $factor) {
  319.                 $boostFactorMap['content-fields'][$typeIdentifier][$fieldIdentifier] = $factor;
  320.             }
  321.         }
  323.         foreach ($config['meta_field'] as $typeIdentifier => $mapping) {
  324.             foreach ($mapping as $fieldIdentifier => $factor) {
  325.                 $boostFactorMap['meta-fields'][$typeIdentifier][$fieldIdentifier] = $factor;
  326.             }
  327.         }
  329.         return $boostFactorMap;
  330.     }
  332.     /**
  333.      * @phpstan-param SolrHttpClientConfigArray $httpClientConfig
  334.      */
  335.     private function configureHttpClient(ContainerBuilder $container, array $httpClientConfig): void
  336.     {
  337.         $container->setParameter('ibexa.solr.http_client.timeout', $httpClientConfig['timeout']);
  338.         $container->setParameter(
  339.             'ibexa.solr.http_client.max_retries',
  340.             $httpClientConfig['max_retries']
  341.         );
  342.     }
  343. }
  345. class_alias(IbexaSolrExtension::class, 'EzSystems\EzPlatformSolrSearchEngineBundle\DependencyInjection\EzSystemsEzPlatformSolrSearchEngineExtension');