src/Core/Content/Sitemap/Service/SitemapExporter.php line 54

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Sitemap\Service;
  5. use League\Flysystem\FilesystemOperator;
  6. use Psr\Cache\CacheItemPoolInterface;
  7. use Shopware\Core\Content\Sitemap\Event\SitemapGeneratedEvent;
  8. use Shopware\Core\Content\Sitemap\Exception\AlreadyLockedException;
  9. use Shopware\Core\Content\Sitemap\Provider\AbstractUrlProvider;
  10. use Shopware\Core\Content\Sitemap\Struct\SitemapGenerationResult;
  11. use Shopware\Core\Content\Sitemap\Struct\Url;
  12. use Shopware\Core\Content\Sitemap\Struct\UrlResult;
  13. use Shopware\Core\Framework\Log\Package;
  14. use Shopware\Core\System\SalesChannel\Aggregate\SalesChannelDomain\SalesChannelDomainCollection;
  15. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  16. use Shopware\Core\System\SystemConfig\Exception\InvalidDomainException;
  17. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  19. #[Package('sales-channel')]
  20. class SitemapExporter implements SitemapExporterInterface
  21. {
  22.     /**
  23.      * @var array<string, SitemapHandleInterface>
  24.      */
  25.     private array $sitemapHandles = [];
  27.     /**
  28.      * @internal
  29.      *
  30.      * @param iterable<AbstractUrlProvider> $urlProvider
  31.      */
  32.     public function __construct(
  33.         private readonly iterable $urlProvider,
  34.         private readonly CacheItemPoolInterface $cache,
  35.         private readonly int $batchSize,
  36.         private readonly FilesystemOperator $filesystem,
  37.         private readonly SitemapHandleFactoryInterface $sitemapHandleFactory,
  38.         private readonly EventDispatcherInterface $dispatcher
  39.     ) {
  40.     }
  42.     /**
  43.      * {@inheritdoc}
  44.      */
  45.     public function generate(SalesChannelContext $context, bool $force = false, ?string $lastProvider = null, ?int $offset = null): SitemapGenerationResult
  46.     {
  47.         $this->lock($context, $force);
  49.         try {
  50.             $this->initSitemapHandles($context);
  52.             foreach ($this->urlProvider as $urlProvider) {
  53.                 do {
  54.                     $result = $urlProvider->getUrls($context, $this->batchSize, $offset);
  56.                     $this->processSiteMapHandles($result);
  58.                     $needRun = $result->getNextOffset() !== null;
  59.                     $offset = $result->getNextOffset();
  60.                 } while ($needRun);
  61.             }
  63.             $this->finishSitemapHandles();
  64.         } finally {
  65.             $this->unlock($context);
  66.         }
  68.         $this->dispatcher->dispatch(new SitemapGeneratedEvent($context));
  70.         return new SitemapGenerationResult(
  71.             true,
  72.             $lastProvider,
  73.             null,
  74.             $context->getSalesChannel()->getId(),
  75.             $context->getLanguageId()
  76.         );
  77.     }
  79.     private function lock(SalesChannelContext $salesChannelContext, bool $force): void
  80.     {
  81.         $key = $this->generateCacheKeyForSalesChannel($salesChannelContext);
  82.         $item = $this->cache->getItem($key);
  83.         if ($item->isHit() && !$force) {
  84.             throw new AlreadyLockedException($salesChannelContext);
  85.         }
  87.         $item->set(true);
  88.         $this->cache->save($item);
  89.     }
  91.     private function unlock(SalesChannelContext $salesChannelContext): void
  92.     {
  93.         $this->cache->deleteItem($this->generateCacheKeyForSalesChannel($salesChannelContext));
  94.     }
  96.     private function generateCacheKeyForSalesChannel(SalesChannelContext $salesChannelContext): string
  97.     {
  98.         return sprintf('sitemap-exporter-running-%s-%s', $salesChannelContext->getSalesChannel()->getId(), $salesChannelContext->getLanguageId());
  99.     }
  101.     private function initSitemapHandles(SalesChannelContext $context): void
  102.     {
  103.         $languageId = $context->getLanguageId();
  104.         $domainsEntity = $context->getSalesChannel()->getDomains();
  106.         $sitemapDomains = [];
  107.         if ($domainsEntity instanceof SalesChannelDomainCollection) {
  108.             foreach ($domainsEntity as $domain) {
  109.                 if ($domain->getLanguageId() === $languageId) {
  110.                     $urlParts = \parse_url($domain->getUrl());
  112.                     if ($urlParts === false) {
  113.                         continue;
  114.                     }
  116.                     $arrayKey = ($urlParts['host'] ?? '') . ($urlParts['path'] ?? '');
  118.                     if (\array_key_exists($arrayKey, $sitemapDomains) && $sitemapDomains[$arrayKey]['scheme'] === 'https') {
  119.                         // NEXT-21735 - does not execute on every test run
  120.                         continue;
  121.                     }
  123.                     $sitemapDomains[$arrayKey] = [
  124.                         'url' => $domain->getUrl(),
  125.                         'scheme' => $urlParts['scheme'] ?? '',
  126.                     ];
  127.                 }
  128.             }
  129.         }
  131.         $sitemapHandles = [];
  132.         foreach ($sitemapDomains as $sitemapDomain) {
  133.             $sitemapHandles[$sitemapDomain['url']] = $this->sitemapHandleFactory->create($this->filesystem, $context, $sitemapDomain['url']);
  134.         }
  136.         if (empty($sitemapHandles)) {
  137.             throw new InvalidDomainException('Empty domain');
  138.         }
  140.         $this->sitemapHandles = $sitemapHandles;
  141.     }
  143.     private function processSiteMapHandles(UrlResult $result): void
  144.     {
  145.         /** @var SitemapHandle $sitemapHandle */
  146.         foreach ($this->sitemapHandles as $host => $sitemapHandle) {
  147.             /** @var Url[] $urls */
  148.             $urls = [];
  150.             foreach ($result->getUrls() as $url) {
  151.                 $newUrl = clone $url;
  152.                 $newUrl->setLoc(empty($newUrl->getLoc()) ? $host : $host . '/' . $newUrl->getLoc());
  153.                 $urls[] = $newUrl;
  154.             }
  156.             $sitemapHandle->write($urls);
  157.         }
  158.     }
  160.     private function finishSitemapHandles(): void
  161.     {
  162.         /** @var SitemapHandle $sitemapHandle */
  163.         foreach ($this->sitemapHandles as $index => $sitemapHandle) {
  164.             if ($index === array_key_first($this->sitemapHandles)) {
  165.                 $sitemapHandle->finish();
  167.                 continue;
  168.             }
  170.             $sitemapHandle->finish(false);
  171.         }
  172.     }
  173. }