vendor/shopware/core/Content/Category/SalesChannel/CachedCategoryRoute.php line 76

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Category\SalesChannel;
  5. use Shopware\Core\Content\Category\Event\CategoryRouteCacheKeyEvent;
  6. use Shopware\Core\Content\Category\Event\CategoryRouteCacheTagsEvent;
  7. use Shopware\Core\Content\Cms\Aggregate\CmsSlot\CmsSlotEntity;
  8. use Shopware\Core\Content\Cms\SalesChannel\Struct\ProductBoxStruct;
  9. use Shopware\Core\Content\Cms\SalesChannel\Struct\ProductSliderStruct;
  10. use Shopware\Core\Framework\Adapter\Cache\AbstractCacheTracer;
  11. use Shopware\Core\Framework\Adapter\Cache\CacheValueCompressor;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Cache\EntityCacheKeyGenerator;
  13. use Shopware\Core\Framework\DataAbstractionLayer\Field\Flag\RuleAreas;
  14. use Shopware\Core\Framework\Log\Package;
  15. use Shopware\Core\Framework\Util\Json;
  16. use Shopware\Core\Profiling\Profiler;
  17. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  18. use Symfony\Component\HttpFoundation\Request;
  19. use Symfony\Component\Routing\Annotation\Route;
  20. use Symfony\Contracts\Cache\CacheInterface;
  21. use Symfony\Contracts\Cache\ItemInterface;
  22. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  24. #[Route(defaults: ['_routeScope' => ['store-api']])]
  25. #[Package('content')]
  26. class CachedCategoryRoute extends AbstractCategoryRoute
  27. {
  28.     /**
  29.      * @internal
  30.      *
  31.      * @param AbstractCacheTracer<CategoryRouteResponse> $tracer
  32.      * @param array<string> $states
  33.      */
  34.     public function __construct(
  35.         private readonly AbstractCategoryRoute $decorated,
  36.         private readonly CacheInterface $cache,
  37.         private readonly EntityCacheKeyGenerator $generator,
  38.         private readonly AbstractCacheTracer $tracer,
  39.         private readonly EventDispatcherInterface $dispatcher,
  40.         private readonly array $states
  41.     ) {
  42.     }
  44.     public static function buildName(string $id): string
  45.     {
  46.         return 'category-route-' . $id;
  47.     }
  49.     public function getDecorated(): AbstractCategoryRoute
  50.     {
  51.         return $this->decorated;
  52.     }
  54.     #[Route(path: '/store-api/category/{navigationId}', name: 'store-api.category.detail', methods: ['GET', 'POST'])]
  55.     public function load(string $navigationId, Request $request, SalesChannelContext $context): CategoryRouteResponse
  56.     {
  57.         return Profiler::trace('category-route', function () use ($navigationId, $request, $context) {
  58.             if ($context->hasState(...$this->states)) {
  59.                 return $this->getDecorated()->load($navigationId, $request, $context);
  60.             }
  62.             $key = $this->generateKey($navigationId, $request, $context);
  64.             if ($key === null) {
  65.                 return $this->getDecorated()->load($navigationId, $request, $context);
  66.             }
  68.             $value = $this->cache->get($key, function (ItemInterface $item) use ($navigationId, $request, $context) {
  69.                 $name = self::buildName($navigationId);
  71.                 $response = $this->tracer->trace($name, fn () => $this->getDecorated()->load($navigationId, $request, $context));
  73.                 $item->tag($this->generateTags($navigationId, $response, $request, $context));
  75.                 return CacheValueCompressor::compress($response);
  76.             });
  78.             return CacheValueCompressor::uncompress($value);
  79.         });
  80.     }
  82.     private function generateKey(string $navigationId, Request $request, SalesChannelContext $context): ?string
  83.     {
  84.         $parts = [...$request->query->all(), ...$request->request->all(), ...[$this->generator->getSalesChannelContextHash($context, [RuleAreas::CATEGORY_AREA, RuleAreas::PRODUCT_AREA])]];
  86.         $event = new CategoryRouteCacheKeyEvent($navigationId, $parts, $request, $context, null);
  87.         $this->dispatcher->dispatch($event);
  89.         if (!$event->shouldCache()) {
  90.             return null;
  91.         }
  93.         return self::buildName($navigationId) . '-' . md5(Json::encode($event->getParts()));
  94.     }
  96.     /**
  97.      * @return array<string>
  98.      */
  99.     private function generateTags(string $navigationId, CategoryRouteResponse $response, Request $request, SalesChannelContext $context): array
  100.     {
  101.         $tags = array_merge(
  102.             $this->tracer->get(self::buildName($navigationId)),
  103.             $this->extractProductIds($response),
  104.             [self::buildName($navigationId)]
  105.         );
  107.         $event = new CategoryRouteCacheTagsEvent($navigationId, $tags, $request, $response, $context, null);
  108.         $this->dispatcher->dispatch($event);
  110.         return array_unique(array_filter($event->getTags()));
  111.     }
  113.     /**
  114.      * @return array<string>
  115.      */
  116.     private function extractProductIds(CategoryRouteResponse $response): array
  117.     {
  118.         $page = $response->getCategory()->getCmsPage();
  120.         if ($page === null) {
  121.             return [];
  122.         }
  124.         $ids = [];
  125.         $streamIds = [];
  127.         $slots = $page->getElementsOfType('product-slider');
  128.         /** @var CmsSlotEntity $slot */
  129.         foreach ($slots as $slot) {
  130.             $slider = $slot->getData();
  132.             if (!$slider instanceof ProductSliderStruct) {
  133.                 continue;
  134.             }
  136.             if ($slider->getStreamId() !== null) {
  137.                 $streamIds[] = $slider->getStreamId();
  138.             }
  140.             if ($slider->getProducts() === null) {
  141.                 continue;
  142.             }
  143.             foreach ($slider->getProducts() as $product) {
  144.                 $ids[] = $product->getId();
  145.                 $ids[] = $product->getParentId();
  146.             }
  147.         }
  149.         $slots = $page->getElementsOfType('product-box');
  150.         /** @var CmsSlotEntity $slot */
  151.         foreach ($slots as $slot) {
  152.             $box = $slot->getData();
  154.             if (!$box instanceof ProductBoxStruct) {
  155.                 continue;
  156.             }
  157.             if ($box->getProduct() === null) {
  158.                 continue;
  159.             }
  161.             $ids[] = $box->getProduct()->getId();
  162.             $ids[] = $box->getProduct()->getParentId();
  163.         }
  165.         $ids = array_values(array_unique(array_filter($ids)));
  167.         return [...array_map(EntityCacheKeyGenerator::buildProductTag(...), $ids), ...array_map(EntityCacheKeyGenerator::buildStreamTag(...), $streamIds), ...[EntityCacheKeyGenerator::buildCmsTag($page->getId())]];
  168.     }
  169. }