vendor/shopware/core/Content/Sitemap/SalesChannel/CachedSitemapRoute.php line 89

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Sitemap\SalesChannel;
  5. use Shopware\Core\Content\Sitemap\Event\SitemapRouteCacheKeyEvent;
  6. use Shopware\Core\Content\Sitemap\Event\SitemapRouteCacheTagsEvent;
  7. use Shopware\Core\Content\Sitemap\Service\SitemapExporterInterface;
  8. use Shopware\Core\Framework\Adapter\Cache\AbstractCacheTracer;
  9. use Shopware\Core\Framework\Adapter\Cache\CacheValueCompressor;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Cache\EntityCacheKeyGenerator;
  11. use Shopware\Core\Framework\DataAbstractionLayer\FieldSerializer\JsonFieldSerializer;
  12. use Shopware\Core\Framework\Log\Package;
  13. use Shopware\Core\Framework\Routing\Annotation\RouteScope;
  14. use Shopware\Core\Framework\Routing\Annotation\Since;
  15. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  16. use Shopware\Core\System\SystemConfig\SystemConfigService;
  17. use Symfony\Component\HttpFoundation\Request;
  18. use Symfony\Component\Routing\Annotation\Route;
  19. use Symfony\Contracts\Cache\CacheInterface;
  20. use Symfony\Contracts\Cache\ItemInterface;
  21. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  23. /**
  24.  * @Route(defaults={"_routeScope"={"store-api"}})
  25.  */
  26. #[Package('sales-channel')]
  27. class CachedSitemapRoute extends AbstractSitemapRoute
  28. {
  29.     public const ALL_TAG = 'sitemap-route';
  31.     private AbstractSitemapRoute $decorated;
  33.     private CacheInterface $cache;
  35.     private EntityCacheKeyGenerator $generator;
  37.     /**
  38.      * @var AbstractCacheTracer<SitemapRouteResponse>
  39.      */
  40.     private AbstractCacheTracer $tracer;
  42.     /**
  43.      * @var array<string>
  44.      */
  45.     private array $states;
  47.     private EventDispatcherInterface $dispatcher;
  49.     private SystemConfigService $config;
  51.     /**
  52.      * @internal
  53.      *
  54.      *  @param AbstractCacheTracer<SitemapRouteResponse> $tracer
  55.      *  @param array<string> $states
  56.      */
  57.     public function __construct(
  58.         AbstractSitemapRoute $decorated,
  59.         CacheInterface $cache,
  60.         EntityCacheKeyGenerator $generator,
  61.         AbstractCacheTracer $tracer,
  62.         EventDispatcherInterface $dispatcher,
  63.         array $states,
  64.         SystemConfigService $config
  65.     ) {
  66.         $this->decorated = $decorated;
  67.         $this->cache = $cache;
  68.         $this->generator = $generator;
  69.         $this->tracer = $tracer;
  70.         $this->states = $states;
  71.         $this->dispatcher = $dispatcher;
  72.         $this->config = $config;
  73.     }
  75.     public static function buildName(string $id): string
  76.     {
  77.         return 'sitemap-route-' . $id;
  78.     }
  80.     public function getDecorated(): AbstractSitemapRoute
  81.     {
  82.         return $this->decorated;
  83.     }
  85.     /**
  86.      * @Since("6.3.2.0")
  87.      * @Route(path="/store-api/sitemap", name="store-api.sitemap", methods={"GET", "POST"})
  88.      */
  89.     public function load(Request $request, SalesChannelContext $context): SitemapRouteResponse
  90.     {
  91.         if ($context->hasState(...$this->states)) {
  92.             return $this->getDecorated()->load($request, $context);
  93.         }
  95.         $strategy = $this->config->getInt('core.sitemap.sitemapRefreshStrategy');
  96.         if ($strategy === SitemapExporterInterface::STRATEGY_LIVE) {
  97.             return $this->getDecorated()->load($request, $context);
  98.         }
  100.         $key = $this->generateKey($request, $context);
  102.         if ($key === null) {
  103.             return $this->getDecorated()->load($request, $context);
  104.         }
  106.         $value = $this->cache->get($key, function (ItemInterface $item) use ($request, $context) {
  107.             $name = self::buildName($context->getSalesChannelId());
  109.             $response = $this->tracer->trace($name, function () use ($request, $context) {
  110.                 return $this->getDecorated()->load($request, $context);
  111.             });
  113.             $item->tag($this->generateTags($response, $request, $context));
  115.             return CacheValueCompressor::compress($response);
  116.         });
  118.         return CacheValueCompressor::uncompress($value);
  119.     }
  121.     private function generateKey(Request $request, SalesChannelContext $context): ?string
  122.     {
  123.         $parts = [$this->generator->getSalesChannelContextHash($context)];
  125.         $event = new SitemapRouteCacheKeyEvent($parts, $request, $context, null);
  126.         $this->dispatcher->dispatch($event);
  128.         if (!$event->shouldCache()) {
  129.             return null;
  130.         }
  132.         return self::buildName($context->getSalesChannelId()) . '-' . md5(JsonFieldSerializer::encodeJson($event->getParts()));
  133.     }
  135.     /**
  136.      * @return array<string>
  137.      */
  138.     private function generateTags(SitemapRouteResponse $response, Request $request, SalesChannelContext $context): array
  139.     {
  140.         $tags = array_merge(
  141.             $this->tracer->get(self::buildName($context->getSalesChannelId())),
  142.             [self::buildName($context->getSalesChannelId()), self::ALL_TAG]
  143.         );
  145.         $event = new SitemapRouteCacheTagsEvent($tags, $request, $response, $context, null);
  146.         $this->dispatcher->dispatch($event);
  148.         return array_unique(array_filter($event->getTags()));
  149.     }
  150. }