vendor/shopware/elasticsearch/Framework/DataAbstractionLayer/ElasticsearchEntitySearcher.php line 44

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Elasticsearch\Framework\DataAbstractionLayer;
  5. use OpenSearch\Client;
  6. use OpenSearchDSL\Aggregation\AbstractAggregation;
  7. use OpenSearchDSL\Aggregation\Bucketing\FilterAggregation;
  8. use OpenSearchDSL\Aggregation\Metric\CardinalityAggregation;
  9. use OpenSearchDSL\Search;
  10. use Shopware\Core\Framework\Context;
  11. use Shopware\Core\Framework\DataAbstractionLayer\EntityDefinition;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  13. use Shopware\Core\Framework\DataAbstractionLayer\Search\EntitySearcherInterface;
  14. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\MultiFilter;
  15. use Shopware\Core\Framework\DataAbstractionLayer\Search\Grouping\FieldGrouping;
  16. use Shopware\Core\Framework\DataAbstractionLayer\Search\IdSearchResult;
  17. use Shopware\Core\Framework\Log\Package;
  18. use Shopware\Elasticsearch\Framework\DataAbstractionLayer\Event\ElasticsearchEntitySearcherSearchEvent;
  19. use Shopware\Elasticsearch\Framework\ElasticsearchHelper;
  20. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  22. #[Package('core')]
  23. class ElasticsearchEntitySearcher implements EntitySearcherInterface
  24. {
  25.     final public const MAX_LIMIT = 10000;
  26.     final public const RESULT_STATE = 'loaded-by-elastic';
  28.     /**
  29.      * @internal
  30.      */
  31.     public function __construct(
  32.         private readonly Client $client,
  33.         private readonly EntitySearcherInterface $decorated,
  34.         private readonly ElasticsearchHelper $helper,
  35.         private readonly CriteriaParser $criteriaParser,
  36.         private readonly AbstractElasticsearchSearchHydrator $hydrator,
  37.         private readonly EventDispatcherInterface $eventDispatcher
  38.     ) {
  39.     }
  41.     public function search(EntityDefinition $definition, Criteria $criteria, Context $context): IdSearchResult
  42.     {
  43.         if (!$this->helper->allowSearch($definition, $context, $criteria)) {
  44.             return $this->decorated->search($definition, $criteria, $context);
  45.         }
  47.         if ($criteria->getLimit() === 0) {
  48.             return new IdSearchResult(0, [], $criteria, $context);
  49.         }
  51.         $search = $this->createSearch($criteria, $definition, $context);
  53.         $this->eventDispatcher->dispatch(
  54.             new ElasticsearchEntitySearcherSearchEvent(
  55.                 $search,
  56.                 $definition,
  57.                 $criteria,
  58.                 $context
  59.             )
  60.         );
  62.         $search = $this->convertSearch($criteria, $definition, $context, $search);
  64.         try {
  65.             $result = $this->client->search([
  66.                 'index' => $this->helper->getIndexName($definition, $context->getLanguageId()),
  67.                 'track_total_hits' => true,
  68.                 'body' => $search,
  69.             ]);
  70.         } catch (\Throwable $e) {
  71.             $this->helper->logAndThrowException($e);
  73.             return $this->decorated->search($definition, $criteria, $context);
  74.         }
  76.         $result = $this->hydrator->hydrate($definition, $criteria, $context, $result);
  78.         $result->addState(self::RESULT_STATE);
  80.         return $result;
  81.     }
  83.     private function createSearch(Criteria $criteria, EntityDefinition $definition, Context $context): Search
  84.     {
  85.         $search = new Search();
  87.         $this->helper->handleIds($definition, $criteria, $search, $context);
  88.         $this->helper->addFilters($definition, $criteria, $search, $context);
  89.         $this->helper->addPostFilters($definition, $criteria, $search, $context);
  90.         $this->helper->addQueries($definition, $criteria, $search, $context);
  91.         $this->helper->addSortings($definition, $criteria, $search, $context);
  92.         $this->helper->addTerm($criteria, $search, $context, $definition);
  94.         $search->setSize(self::MAX_LIMIT);
  95.         $limit = $criteria->getLimit();
  96.         if ($limit !== null) {
  97.             $search->setSize($limit);
  98.         }
  99.         $search->setFrom((int) $criteria->getOffset());
  101.         return $search;
  102.     }
  104.     /**
  105.      * @return array<string, mixed>
  106.      */
  107.     private function convertSearch(Criteria $criteria, EntityDefinition $definition, Context $context, Search $search): array
  108.     {
  109.         if (!$criteria->getGroupFields()) {
  110.             return $search->toArray();
  111.         }
  113.         $aggregation = $this->buildTotalCountAggregation($criteria, $definition, $context);
  115.         $search->addAggregation($aggregation);
  117.         $array = $search->toArray();
  118.         $array['collapse'] = $this->parseGrouping($criteria->getGroupFields(), $definition, $context);
  120.         return $array;
  121.     }
  123.     /**
  124.      * @param FieldGrouping[] $groupings
  125.      *
  126.      * @return array{field: string, inner_hits?: array{name: string}}
  127.      */
  128.     private function parseGrouping(array $groupings, EntityDefinition $definition, Context $context): array
  129.     {
  130.         /** @var FieldGrouping $grouping */
  131.         $grouping = array_shift($groupings);
  133.         $accessor = $this->criteriaParser->buildAccessor($definition, $grouping->getField(), $context);
  134.         if (empty($groupings)) {
  135.             return ['field' => $accessor];
  136.         }
  138.         return [
  139.             'field' => $accessor,
  140.             'inner_hits' => [
  141.                 'name' => 'inner',
  142.                 'collapse' => $this->parseGrouping($groupings, $definition, $context),
  143.             ],
  144.         ];
  145.     }
  147.     private function buildTotalCountAggregation(Criteria $criteria, EntityDefinition $definition, Context $context): AbstractAggregation
  148.     {
  149.         $groupings = $criteria->getGroupFields();
  151.         if (\count($groupings) === 1) {
  152.             $first = array_shift($groupings);
  154.             $accessor = $this->criteriaParser->buildAccessor($definition, $first->getField(), $context);
  156.             $aggregation = new CardinalityAggregation('total-count');
  157.             $aggregation->setField($accessor);
  159.             return $this->addPostFilterAggregation($criteria, $definition, $context, $aggregation);
  160.         }
  162.         $fields = [];
  163.         foreach ($groupings as $grouping) {
  164.             $accessor = $this->criteriaParser->buildAccessor($definition, $grouping->getField(), $context);
  166.             $fields[] = sprintf(
  167.                 '
  168.                 if (doc[\'%s\'].size()==0) {
  169.                     value = value + \'empty\';
  170.                 } else {
  171.                     value = value + doc[\'%s\'].value;
  172.                 }',
  173.                 $accessor,
  174.                 $accessor
  175.             );
  176.         }
  178.         $script = '
  179.             def value = \'\';
  181.             ' . implode(' ', $fields) . '
  183.             return value;
  184.         ';
  186.         $aggregation = new CardinalityAggregation('total-count');
  187.         $aggregation->setScript($script);
  189.         return $this->addPostFilterAggregation($criteria, $definition, $context, $aggregation);
  190.     }
  192.     private function addPostFilterAggregation(Criteria $criteria, EntityDefinition $definition, Context $context, CardinalityAggregation $aggregation): AbstractAggregation
  193.     {
  194.         if (!$criteria->getPostFilters()) {
  195.             return $aggregation;
  196.         }
  198.         $query = $this->criteriaParser->parseFilter(
  199.             new MultiFilter(MultiFilter::CONNECTION_AND, $criteria->getPostFilters()),
  200.             $definition,
  201.             $definition->getEntityName(),
  202.             $context
  203.         );
  205.         $filterAgg = new FilterAggregation('total-filtered-count', $query);
  206.         $filterAgg->addAggregation($aggregation);
  208.         return $filterAgg;
  209.     }
  210. }