src/Core/Content/Sitemap/Provider/ProductUrlProvider.php line 53

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Sitemap\Provider;
  5. use Doctrine\DBAL\Connection;
  6. use Shopware\Core\Content\Product\ProductDefinition;
  7. use Shopware\Core\Content\Product\ProductEntity;
  8. use Shopware\Core\Content\Sitemap\Service\ConfigHandler;
  9. use Shopware\Core\Content\Sitemap\Struct\Url;
  10. use Shopware\Core\Content\Sitemap\Struct\UrlResult;
  11. use Shopware\Core\Defaults;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Dbal\Common\IteratorFactory;
  13. use Shopware\Core\Framework\DataAbstractionLayer\Doctrine\FetchModeHelper;
  14. use Shopware\Core\Framework\Log\Package;
  15. use Shopware\Core\Framework\Plugin\Exception\DecorationPatternException;
  16. use Shopware\Core\Framework\Uuid\Uuid;
  17. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  18. use Shopware\Core\System\SystemConfig\SystemConfigService;
  19. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  20. use Symfony\Component\Routing\RouterInterface;
  22. #[Package('sales-channel')]
  23. class ProductUrlProvider extends AbstractUrlProvider
  24. {
  25.     final public const CHANGE_FREQ = 'hourly';
  27.     private const CONFIG_HIDE_AFTER_CLOSEOUT = 'core.listing.hideCloseoutProductsWhenOutOfStock';
  29.     /**
  30.      * @internal
  31.      */
  32.     public function __construct(private readonly ConfigHandler $configHandler, private readonly Connection $connection, private readonly ProductDefinition $definition, private readonly IteratorFactory $iteratorFactory, private readonly RouterInterface $router, private readonly SystemConfigService $systemConfigService)
  33.     {
  34.     }
  36.     public function getDecorated(): AbstractUrlProvider
  37.     {
  38.         throw new DecorationPatternException(self::class);
  39.     }
  41.     public function getName(): string
  42.     {
  43.         return 'product';
  44.     }
  46.     /**
  47.      * {@inheritdoc}
  48.      *
  49.      * @throws \Exception
  50.      */
  51.     public function getUrls(SalesChannelContext $context, int $limit, ?int $offset = null): UrlResult
  52.     {
  53.         $products = $this->getProducts($context, $limit, $offset);
  55.         if (empty($products)) {
  56.             return new UrlResult([], null);
  57.         }
  59.         $keys = FetchModeHelper::keyPair($products);
  61.         $seoUrls = $this->getSeoUrls(array_values($keys), 'frontend.detail.page', $context, $this->connection);
  63.         $seoUrls = FetchModeHelper::groupUnique($seoUrls);
  65.         $urls = [];
  66.         $url = new Url();
  68.         foreach ($products as $product) {
  69.             $lastMod = $product['updated_at'] ?: $product['created_at'];
  71.             $lastMod = (new \DateTime($lastMod))->format(Defaults::STORAGE_DATE_TIME_FORMAT);
  73.             $newUrl = clone $url;
  75.             if (isset($seoUrls[$product['id']])) {
  76.                 $newUrl->setLoc($seoUrls[$product['id']]['seo_path_info']);
  77.             } else {
  78.                 $newUrl->setLoc($this->router->generate('frontend.detail.page', ['productId' => $product['id']], UrlGeneratorInterface::ABSOLUTE_PATH));
  79.             }
  81.             $newUrl->setLastmod(new \DateTime($lastMod));
  82.             $newUrl->setChangefreq(self::CHANGE_FREQ);
  83.             $newUrl->setResource(ProductEntity::class);
  84.             $newUrl->setIdentifier($product['id']);
  86.             $urls[] = $newUrl;
  87.         }
  89.         $keys = array_keys($keys);
  90.         /** @var int|null $nextOffset */
  91.         $nextOffset = array_pop($keys);
  93.         return new UrlResult($urls, $nextOffset);
  94.     }
  96.     private function getProducts(SalesChannelContext $context, int $limit, ?int $offset): array
  97.     {
  98.         $lastId = null;
  99.         if ($offset) {
  100.             $lastId = ['offset' => $offset];
  101.         }
  103.         $iterator = $this->iteratorFactory->createIterator($this->definition, $lastId);
  104.         $query = $iterator->getQuery();
  105.         $query->setMaxResults($limit);
  107.         $showAfterCloseout = !$this->systemConfigService->get(self::CONFIG_HIDE_AFTER_CLOSEOUT, $context->getSalesChannelId());
  109.         $query->addSelect([
  110.             '`product`.created_at as created_at',
  111.             '`product`.updated_at as updated_at',
  112.         ]);
  114.         $query->leftJoin('`product`', '`product`', 'parent', '`product`.parent_id = parent.id');
  115.         $query->innerJoin('`product`', 'product_visibility', 'visibilities', 'product.visibilities = visibilities.product_id');
  117.         $query->andWhere('`product`.version_id = :versionId');
  119.         if ($showAfterCloseout) {
  120.             $query->andWhere('(`product`.available = 1 OR `product`.is_closeout)');
  121.         } else {
  122.             $query->andWhere('`product`.available = 1');
  123.         }
  125.         $query->andWhere('IFNULL(`product`.active, parent.active) = 1');
  126.         $query->andWhere('(`product`.child_count = 0 OR `product`.parent_id IS NOT NULL)');
  127.         $query->andWhere('(`product`.parent_id IS NULL OR parent.canonical_product_id IS NULL OR parent.canonical_product_id = `product`.id)');
  128.         $query->andWhere('visibilities.product_version_id = :versionId');
  129.         $query->andWhere('visibilities.sales_channel_id = :salesChannelId');
  131.         $excludedProductIds = $this->getExcludedProductIds($context);
  132.         if (!empty($excludedProductIds)) {
  133.             $query->andWhere('`product`.id NOT IN (:productIds)');
  134.             $query->setParameter('productIds', Uuid::fromHexToBytesList($excludedProductIds), Connection::PARAM_STR_ARRAY);
  135.         }
  137.         $query->setParameter('versionId', Uuid::fromHexToBytes(Defaults::LIVE_VERSION));
  138.         $query->setParameter('salesChannelId', Uuid::fromHexToBytes($context->getSalesChannelId()));
  140.         return $query->executeQuery()->fetchAllAssociative();
  141.     }
  143.     private function getExcludedProductIds(SalesChannelContext $salesChannelContext): array
  144.     {
  145.         $salesChannelId = $salesChannelContext->getSalesChannel()->getId();
  147.         $excludedUrls = $this->configHandler->get(ConfigHandler::EXCLUDED_URLS_KEY);
  148.         if (empty($excludedUrls)) {
  149.             return [];
  150.         }
  152.         $excludedUrls = array_filter($excludedUrls, static function (array $excludedUrl) use ($salesChannelId) {
  153.             if ($excludedUrl['resource'] !== ProductEntity::class) {
  154.                 return false;
  155.             }
  157.             if ($excludedUrl['salesChannelId'] !== $salesChannelId) {
  158.                 return false;
  159.             }
  161.             return true;
  162.         });
  164.         return array_column($excludedUrls, 'identifier');
  165.     }
  166. }