nystudio107\seomatic\models\SitemapTemplate::render()

Complexity

Conditions	23
Paths	339

Size

Total Lines	134
Code Lines	88

Duplication

Lines	0
Ratio	0 %

Importance

Changes

0

<?php
    public function render(array $params = []): string
    {
        $groupId = $params['groupId'];
        $type = $params['type'];
        $handle = $params['handle'];
        $siteId = $params['siteId'];
        // If $throwException === false it means we're trying to regenerate the sitemap due to an invalidation
        // rather than a request for the actual sitemap, so don't try to run the queue immediately
        $throwException = $params['throwException'] ?? true;
        // Only regenerate the sitemap via queue job if it's via an invalidation of the sitemap cache
        $immediately = $params['immediately'] ?? $throwException;
        $request = Craft::$app->getRequest();
        $metaBundle = Seomatic::$plugin->metaBundles->getMetaBundleBySourceHandle($type, $handle, $siteId);
        // If it doesn't exist, throw a 404
        if ($metaBundle === null) {
            if ($request->isCpRequest || $request->isConsoleRequest) {
                return '';
            }
            if ($throwException) {
                throw new NotFoundHttpException(Craft::t('seomatic', 'Page not found.'));
            }
            return '';
        }
        // Check to see if robots is `none` or `no index`
        $robotsEnabled = true;
        if (!empty($metaBundle->metaGlobalVars->robots)) {
            $robotsEnabled = $metaBundle->metaGlobalVars->robots !== 'none' &&
                $metaBundle->metaGlobalVars->robots !== 'noindex';
        }
        $sitemapUrls = $metaBundle->metaSitemapVars->sitemapUrls;
        if (Seomatic::$plugin->sitemaps->anyEntryTypeHasSitemapUrls($metaBundle)) {
            $robotsEnabled = true;
            $sitemapUrls = true;
        }
        if ($sitemapUrls && !SiteHelper::siteEnabledWithUrls($siteId)) {
            $sitemapUrls = false;
        }
        // If it's disabled, just throw a 404
        if (!$sitemapUrls || !$robotsEnabled) {
            if ($request->isCpRequest || $request->isConsoleRequest) {
                return '';
            }
            if ($throwException) {
                throw new NotFoundHttpException(Craft::t('seomatic', 'Page not found.'));
            }
        }

        $cache = Craft::$app->getCache();
        $uniqueKey = $groupId . $type . $handle . $siteId;
        $cacheKey = self::CACHE_KEY . $uniqueKey;
        $queueJobCacheKey = self::QUEUE_JOB_CACHE_KEY . $uniqueKey;
        $result = $cache->get($cacheKey);
        // If the sitemap isn't cached, start a job to create it
        // Even if it is cached, if $throwException === false we should regenerate it, as it is part of
        // an invalidation
        if ($result === false || $throwException === false) {
            $queue = Craft::$app->getQueue();
            // If there's an existing queue job, release it so queue jobs don't stack
            $existingJobId = $cache->get($queueJobCacheKey);
            // Make sure the queue uses the Craft web interface
            if ($existingJobId && $queue instanceof QueueInterface) {
                $queue->release($existingJobId);
                $cache->delete($queueJobCacheKey);
            }
            // See if we should regenerate this sitemap immediately, or via queue job
            if ($immediately) {
                Sitemap::generateSitemap([
                    'groupId' => $groupId,
                    'type' => $type,
                    'handle' => $handle,
                    'siteId' => $siteId,
                    'queueJobCacheKey' => $queueJobCacheKey,
                ]);
            } else {
                // Push a new queue job
                $jobId = $queue->push(new GenerateSitemap([
                    'groupId' => $groupId,
                    'type' => $type,
                    'handle' => $handle,
                    'siteId' => $siteId,
                    'queueJobCacheKey' => $queueJobCacheKey,
                ]));

                // Stash the queue job id in the cache for future reference
                $cacheDuration = 3600;
                $dependency = new TagDependency([
                    'tags' => [
                        self::GLOBAL_SITEMAP_CACHE_TAG,
                        self::CACHE_KEY . $uniqueKey,
                    ],
                ]);
                $cache->set($queueJobCacheKey, $jobId, $cacheDuration, $dependency);
                Craft::debug(
                    Craft::t(
                        'seomatic',
                        'Started GenerateSitemap queue job id: {jobId} with cache key {cacheKey}',
                        [
                            'jobId' => $jobId,
                            'cacheKey' => $cacheKey,
                        ]
                    ),
                    __METHOD__
                );
            }

            // Try it again now
            $result = $cache->get($cacheKey);
            if ($result !== false) {
                return $result;
            }
            // Return a 503 Service Unavailable an a Retry-After so bots will try back later
            $lines = [];
            $response = Craft::$app->getResponse();
            if (!$request->isConsoleRequest && $throwException) {
                $response->setStatusCode(503);
                $response->headers->add('Retry-After', '60');
                $response->headers->add('Cache-Control', 'no-cache, no-store');
                // Return an empty XML document
                $lines[] = '<?xml version="1.0" encoding="UTF-8"?>';
                $lines[] = '<?xml-stylesheet type="text/xsl" href="sitemap-empty.xsl"?>';
                $lines[] = '<!-- ' . Craft::t('seomatic', 'This sitemap has not been generated yet.') . ' -->';
                $lines[] = '<!-- ' . Craft::t('seomatic', 'If you are seeing this in local dev or an') . ' -->';
                $lines[] = '<!-- ' . Craft::t('seomatic', 'environment with `devMode` on, caches only') . ' -->';
                $lines[] = '<!-- ' . Craft::t('seomatic', 'last for 30 seconds in local dev, so it is') . ' -->';
                $lines[] = '<!-- ' . Craft::t('seomatic', 'normal for the sitemap to not be cached.') . ' -->';
                $lines[] = '<urlset>';
                $lines[] = '</urlset>';
            }
            $lines = implode("\r\n", $lines);

            return $lines;
        }

        return $result;
    }