Sitemaps::invalidateSitemapIndexCache() - Code Metrics - Inspection of "Fix caching and infrastructure to support per-entr..." - nystudio107/craft-seomatic - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( 421797...7f10a1 )

by Andrew

created 2021-07-19 17:53 UTC

Sitemaps::invalidateSitemapIndexCache() A

↳ Parent: Sitemaps

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	5
nc	1
nop	0
dl	0
loc	7
ccs	0
cts	6
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?php
/**
 * SEOmatic plugin for Craft CMS 3.x
 *
 * A turnkey SEO implementation for Craft CMS that is comprehensive, powerful,
 * and flexible
 *
 * @link      https://nystudio107.com
 * @copyright Copyright (c) 2017 nystudio107
 */

namespace nystudio107\seomatic\services;

use nystudio107\seomatic\jobs\GenerateSitemap;
use nystudio107\seomatic\models\MetaBundle;
use nystudio107\seomatic\Seomatic;
use nystudio107\seomatic\base\FrontendTemplate;
use nystudio107\seomatic\base\SitemapInterface;
use nystudio107\seomatic\helpers\UrlHelper;
use nystudio107\seomatic\models\FrontendTemplateContainer;
use nystudio107\seomatic\models\SitemapIndexTemplate;
use nystudio107\seomatic\models\SitemapTemplate;
use nystudio107\seomatic\models\SitemapCustomTemplate;

use Craft;
use craft\base\Component;
use craft\base\Element;
use craft\base\ElementInterface;
use craft\errors\SiteNotFoundException;
use craft\events\RegisterUrlRulesEvent;
use craft\web\UrlManager;

use yii\base\Event;
use yii\base\Exception;
use yii\base\InvalidConfigException;
use yii\caching\TagDependency;

/**
 * @author    nystudio107

 * @package   Seomatic
 * @since     3.0.0
 */
class Sitemaps extends Component implements SitemapInterface
{
    // Constants
    // =========================================================================

    const SEOMATIC_SITEMAPINDEX_CONTAINER = Seomatic::SEOMATIC_HANDLE.SitemapIndexTemplate::TEMPLATE_TYPE;

    const SEOMATIC_SITEMAP_CONTAINER = Seomatic::SEOMATIC_HANDLE.SitemapTemplate::TEMPLATE_TYPE;

    const SEOMATIC_SITEMAPCUSTOM_CONTAINER = Seomatic::SEOMATIC_HANDLE.SitemapCustomTemplate::TEMPLATE_TYPE;

    const SEARCH_ENGINE_SUBMISSION_URLS = [
        'google' => 'https://www.google.com/ping?sitemap=',
        'bing' => 'https://www.bing.com/ping?sitemap=',
    ];

    // Protected Properties
    // =========================================================================

    /**
     * @var FrontendTemplateContainer
     */
    protected $sitemapTemplateContainer;

    // Public Methods
    // =========================================================================

    /**

     *
     */
    public function init()
    {
        parent::init();
    }

    /**
     * Load in the sitemap frontend template containers
     */
    public function loadSitemapContainers()
    {
        if (Seomatic::$settings->sitemapsEnabled) {
            $this->sitemapTemplateContainer = FrontendTemplateContainer::create();
            // The Sitemap Index
            $sitemapIndexTemplate = SitemapIndexTemplate::create();
            $this->sitemapTemplateContainer->addData($sitemapIndexTemplate, self::SEOMATIC_SITEMAPINDEX_CONTAINER);
            // A custom sitemap
            $sitemapCustomTemplate = SitemapCustomTemplate::create();
            $this->sitemapTemplateContainer->addData($sitemapCustomTemplate, self::SEOMATIC_SITEMAPCUSTOM_CONTAINER);
            // A generic sitemap
            $sitemapTemplate = SitemapTemplate::create();
            $this->sitemapTemplateContainer->addData($sitemapTemplate, self::SEOMATIC_SITEMAP_CONTAINER);
            // Handler: UrlManager::EVENT_REGISTER_SITE_URL_RULES
            Event::on(
                UrlManager::class,
                UrlManager::EVENT_REGISTER_SITE_URL_RULES,
                function (RegisterUrlRulesEvent $event) {
                    Craft::debug(
                        'UrlManager::EVENT_REGISTER_SITE_URL_RULES',
                        __METHOD__
                    );
                    // Register our sitemap routes
                    $event->rules = array_merge(
                        $event->rules,
                        $this->sitemapRouteRules()
                    );
                }
            );
        }
    }

    /**
     * @return array
     */
    public function sitemapRouteRules(): array
    {
        $rules = [];
        $groups = Craft::$app->getSites()->getAllGroups();
        $groupId = $groups[0]->id;

        $currentSite = null;

        try {
            $currentSite = Craft::$app->getSites()->getCurrentSite();
        } catch (SiteNotFoundException $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }
        if ($currentSite) {
            try {
                $groupId = $currentSite->getGroup()->id;
            } catch (InvalidConfigException $e) {
                Craft::error($e->getMessage(), __METHOD__);
            }
        }
        // Add the route to redirect sitemap.xml to the actual sitemap
        $route =

            Seomatic::$plugin->handle
            .'/'
            .'sitemap'
            .'/'
            .'sitemap-index-redirect';
        $rules['sitemap.xml'] = [
            'route' => $route,
        ];
        // Add the route for the sitemap.xsl styles
        $route =

            Seomatic::$plugin->handle
            .'/'
            .'sitemap'
            .'/'
            .'sitemap-styles';
        $rules['sitemap.xsl'] = [
            'route' => $route,
        ];
        // Add the route for the sitemap-empty.xsl styles
        $route =

            Seomatic::$plugin->handle
            .'/'
            .'sitemap'
            .'/'
            .'sitemap-empty-styles';
        $rules['sitemap-empty.xsl'] = [
            'route' => $route,
        ];
        // Add all of the frontend container routes
        foreach ($this->sitemapTemplateContainer->data as $sitemapTemplate) {
            /** @var $sitemapTemplate FrontendTemplate */

            $rules = array_merge(
                $rules,
                $sitemapTemplate->routeRules()
            );
        }

        return $rules;
    }

    /**
     * See if any of the entry types have robots enable and sitemap urls enabled
     *
     * @param MetaBundle $metaBundle

     * @return bool

     */
    public function anyEntryTypeHasSitemapUrls(MetaBundle $metaBundle): bool
    {
        $result = false;
        $seoElement = Seomatic::$plugin->seoElements->getSeoElementByMetaBundleType($metaBundle->sourceBundleType);
        if ($seoElement) {
            if (!empty($seoElement::typeMenuFromHandle($metaBundle->sourceHandle))) {
                $section = $seoElement::sourceModelFromHandle($metaBundle->sourceHandle);
                if ($section !== null) {
                    $entryTypes = $section->getEntryTypes();
                    // Fetch each meta bundle for each entry type to see if _any_ of them have sitemap URLs
                    foreach ($entryTypes as $entryType) {
                        $entryTypeBundle = Seomatic::$plugin->metaBundles->getMetaBundleBySourceId(
                            $metaBundle->sourceBundleType,
                            $metaBundle->sourceId,
                            $metaBundle->sourceSiteId,
                            $entryType->id
                        );
                        if ($entryTypeBundle) {
                            $robotsEnabled = true;
                            if (!empty($entryTypeBundle->metaGlobalVars->robots)) {
                                $robotsEnabled = $entryTypeBundle->metaGlobalVars->robots !== 'none' &&
                                    $entryTypeBundle->metaGlobalVars->robots !== 'noindex';
                            }
                            if ($entryTypeBundle->metaSitemapVars->sitemapUrls && $robotsEnabled) {
                                $result = true;
                            }
                        }
                    }
                }
            }
        }

        return $result;
    }

    /**
     * @param string $template

     * @param array  $params

     *
     * @return string
     */
    public function renderTemplate(string $template, array $params = []): string
    {
        $html = '';
        if (!empty($this->sitemapTemplateContainer->data[$template])) {
            /** @var FrontendTemplate $sitemapTemplate */

            $sitemapTemplate = $this->sitemapTemplateContainer->data[$template];
            $html = $sitemapTemplate->render($params);
        }

        return $html;
    }

    /**
     * Submit the sitemap index to the search engine services
     */
    public function submitSitemapIndex()
    {
        if (Seomatic::$settings->sitemapsEnabled && Seomatic::$environment === 'live' && Seomatic::$settings->submitSitemaps) {
            // Submit the sitemap to each search engine
            $searchEngineUrls = self::SEARCH_ENGINE_SUBMISSION_URLS;
            foreach ($searchEngineUrls as &$url) {
                $groups = Craft::$app->getSites()->getAllGroups();
                foreach ($groups as $group) {
                    $groupSiteIds = $group->getSiteIds();
                    if (!empty($groupSiteIds)) {
                        $siteId = $groupSiteIds[0];
                        $sitemapIndexUrl = $this->sitemapIndexUrlForSiteId($siteId);
                        if (!empty($sitemapIndexUrl)) {
                            $submissionUrl = $url.urlencode($sitemapIndexUrl);
                            // create new guzzle client
                            $guzzleClient = Craft::createGuzzleClient(['timeout' => 120, 'connect_timeout' => 120]);
                            // Submit the sitemap index to each search engine
                            try {
                                $guzzleClient->post($submissionUrl);
                                Craft::info(
                                    'Sitemap index submitted to: '.$submissionUrl,
                                    __METHOD__
                                );
                            } catch (\Exception $e) {
                                Craft::error(
                                    'Error submitting sitemap index to: '.$submissionUrl.' - '.$e->getMessage(),
                                    __METHOD__
                                );
                            }
                        }
                    }
                }
            }
        }
    }

    /**
     * Submit the bundle sitemap to the search engine services
     *
     * @param ElementInterface $element

     */
    public function submitSitemapForElement(ElementInterface $element)
    {
        if (Seomatic::$settings->sitemapsEnabled && Seomatic::$environment === 'live' && Seomatic::$settings->submitSitemaps) {
            /** @var Element $element */

            list($sourceId, $sourceBundleType, $sourceHandle, $sourceSiteId, $typeId)
                = Seomatic::$plugin->metaBundles->getMetaSourceFromElement($element);
            // Submit the sitemap to each search engine
            $searchEngineUrls = self::SEARCH_ENGINE_SUBMISSION_URLS;
            foreach ($searchEngineUrls as &$url) {
                $sitemapUrl = $this->sitemapUrlForBundle($sourceBundleType, $sourceHandle, $sourceSiteId);
                if (!empty($sitemapUrl)) {
                    $submissionUrl = $url.urlencode($sitemapUrl);
                    // create new guzzle client
                    $guzzleClient = Craft::createGuzzleClient(['timeout' => 120, 'connect_timeout' => 120]);
                    // Submit the sitemap index to each search engine
                    try {
                        $guzzleClient->post($submissionUrl);
                        Craft::info(
                            'Sitemap index submitted to: '.$submissionUrl,
                            __METHOD__
                        );
                    } catch (\Exception $e) {
                        Craft::error(
                            'Error submitting sitemap index to: '.$submissionUrl.' - '.$e->getMessage(),
                            __METHOD__
                        );
                    }
                }
            }
        }
    }

    /**
     * Submit the bundle sitemap to the search engine services
     *
     * @param int $siteId

     */
    public function submitCustomSitemap(int $siteId)
    {
        if (Seomatic::$settings->sitemapsEnabled && Seomatic::$environment === 'live' && Seomatic::$settings->submitSitemaps) {
            // Submit the sitemap to each search engine
            $searchEngineUrls = self::SEARCH_ENGINE_SUBMISSION_URLS;
            foreach ($searchEngineUrls as &$url) {
                $sitemapUrl = $this->sitemapCustomUrlForSiteId($siteId);
                if (!empty($sitemapUrl)) {
                    $submissionUrl = $url.urlencode($sitemapUrl);
                    // create new guzzle client
                    $guzzleClient = Craft::createGuzzleClient(['timeout' => 120, 'connect_timeout' => 120]);
                    // Submit the sitemap index to each search engine
                    try {
                        $guzzleClient->post($submissionUrl);
                        Craft::info(
                            'Sitemap Custom submitted to: '.$submissionUrl,
                            __METHOD__
                        );
                    } catch (\Exception $e) {
                        Craft::error(
                            'Error submitting sitemap index to: '.$submissionUrl.' - '.$e->getMessage(),
                            __METHOD__
                        );
                    }
                }
            }
        }
    }

    /**
     * Get the URL to the $siteId's sitemap index
     *
     * @param int|null $siteId

     *
     * @return string
     */
    public function sitemapIndexUrlForSiteId(int $siteId = null): string
    {
        $url = '';
        $sites = Craft::$app->getSites();
        if ($siteId === null) {
            $siteId = $sites->currentSite->id ?? 1;
        }
        $site = $sites->getSiteById($siteId);
        if ($site !== null) {
            try {
                $url = UrlHelper::siteUrl(
                    '/sitemaps-'
                    .$site->groupId
                    .'-sitemap.xml',
                    null,
                    null,
                    $siteId
                );
            } catch (Exception $e) {
                Craft::error($e->getMessage(), __METHOD__);
            }
        }

        return $url;
    }

    /**
     * Return all of the sitemap indexes the current group of sites
     *
     * @return string
     */
    public function sitemapIndex(): string
    {
        $result = '';
        $sites = [];
        // If sitemaps aren't enabled globally, return nothing for the sitemap index
        if (!Seomatic::$settings->sitemapsEnabled) {
            return '';
        }
        if (Seomatic::$settings->siteGroupsSeparate) {
            // Get only the sites that are in the current site's group
            try {
                $siteGroup = Craft::$app->getSites()->getCurrentSite()->getGroup();
            } catch (InvalidConfigException $e) {
                $siteGroup = null;
                Craft::error($e->getMessage(), __METHOD__);
            }
            // If we can't get a group, just use the current site
            if ($siteGroup === null) {
                $sites = [Craft::$app->getSites()->getCurrentSite()];
            } else  {

                $sites = $siteGroup->getSites();
            }
        } else {
            $sites = Craft::$app->getSites()->getAllSites();
        }

        foreach($sites as $site) {

            $result .= 'sitemap: ' . $this->sitemapIndexUrlForSiteId($site->id) . PHP_EOL;
        }

        return rtrim($result, PHP_EOL);
    }

    /**
     * @param int|null $siteId

     *
     * @return string
     */
    public function sitemapCustomUrlForSiteId(int $siteId = null)
    {
        $url = '';
        $sites = Craft::$app->getSites();
        if ($siteId === null) {
            $siteId = $sites->currentSite->id ?? 1;
        }
        $site = $sites->getSiteById($siteId);
        if ($site) {
            try {
                $url = UrlHelper::siteUrl(
                    '/sitemaps-'
                    .$site->groupId
                    .'-'
                    .SitemapCustomTemplate::CUSTOM_SCOPE
                    .'-'
                    .SitemapCustomTemplate::CUSTOM_HANDLE
                    .'-'
                    .$siteId
                    .'-sitemap.xml',
                    null,
                    null,
                    $siteId
                );
            } catch (Exception $e) {
                Craft::error($e->getMessage(), __METHOD__);
            }
        }

        return $url;
    }

    /**
     * @param string   $sourceBundleType

     * @param string   $sourceHandle

     * @param int|null $siteId

     *
     * @return string
     */
    public function sitemapUrlForBundle(string $sourceBundleType, string $sourceHandle, int $siteId = null): string
    {
        $url = '';
        $sites = Craft::$app->getSites();
        if ($siteId === null) {
            $siteId = $sites->currentSite->id ?? 1;
        }
        $site = $sites->getSiteById($siteId);
        $metaBundle = Seomatic::$plugin->metaBundles->getMetaBundleBySourceHandle(
            $sourceBundleType,
            $sourceHandle,
            $siteId
        );
        if ($site && $metaBundle) {
            try {
                $url = UrlHelper::siteUrl(
                    '/sitemaps-'
                    .$site->groupId
                    .'-'
                    .$metaBundle->sourceBundleType
                    .'-'
                    .$metaBundle->sourceHandle
                    .'-'
                    .$metaBundle->sourceSiteId
                    .'-sitemap.xml',
                    null,
                    null,
                    $siteId
                );
            } catch (Exception $e) {
                Craft::error($e->getMessage(), __METHOD__);
            }
        }

        return $url;
    }

    /**
     * Invalidate all of the sitemap caches
     */
    public function invalidateCaches()
    {
        $cache = Craft::$app->getCache();
        TagDependency::invalidate($cache, self::GLOBAL_SITEMAP_CACHE_TAG);
        Craft::info(
            'All sitemap caches cleared',
            __METHOD__
        );
    }

    /**
     * Invalidate the sitemap cache passed in $handle
     *
     * @param string $handle

     * @param int    $siteId

     * @param string $type

     */
    public function invalidateSitemapCache(string $handle, int $siteId, string $type)
    {
        $cache = Craft::$app->getCache();
        // If the queue should be run automatically, do it now
        TagDependency::invalidate($cache, SitemapTemplate::SITEMAP_CACHE_TAG.$handle.$siteId);
        Craft::info(
            'Sitemap cache cleared: '.$handle,
            __METHOD__
        );
        $sites = Craft::$app->getSites();
        if ($siteId === null) {

            $siteId = $sites->currentSite->id ?? 1;
        }
        $site = $sites->getSiteById($siteId);
        // Start up a job to generate the sitemap
        $queue = Craft::$app->getQueue();
        $jobId = $queue->push(new GenerateSitemap([
            'groupId' => $site->groupId,
            'type' => $type,
            'handle' => $handle,
            'siteId' => $siteId,
        ]));
        Craft::debug(
            Craft::t(
                'seomatic',
                'Started GenerateSitemap queue job id: {jobId}',
                [
                    'jobId' => $jobId,
                ]
            ),
            __METHOD__
        );
    }

    /**
     * Invalidate the sitemap index cache
     */
    public function invalidateSitemapIndexCache()
    {
        $cache = Craft::$app->getCache();
        TagDependency::invalidate($cache, SitemapIndexTemplate::SITEMAP_INDEX_CACHE_TAG);
        Craft::info(
            'Sitemap index cache cleared',
            __METHOD__
        );
    }
}


1			<?php
2			/**
3			* SEOmatic plugin for Craft CMS 3.x
4			*
5			* A turnkey SEO implementation for Craft CMS that is comprehensive, powerful,
6			* and flexible
7			*
8			* @link https://nystudio107.com
9			* @copyright Copyright (c) 2017 nystudio107
10			*/
11
12			namespace nystudio107\seomatic\services;
13
14			use nystudio107\seomatic\jobs\GenerateSitemap;
15			use nystudio107\seomatic\models\MetaBundle;
16			use nystudio107\seomatic\Seomatic;
17			use nystudio107\seomatic\base\FrontendTemplate;
18			use nystudio107\seomatic\base\SitemapInterface;
19			use nystudio107\seomatic\helpers\UrlHelper;
20			use nystudio107\seomatic\models\FrontendTemplateContainer;
21			use nystudio107\seomatic\models\SitemapIndexTemplate;
22			use nystudio107\seomatic\models\SitemapTemplate;
23			use nystudio107\seomatic\models\SitemapCustomTemplate;
24
25			use Craft;
26			use craft\base\Component;
27			use craft\base\Element;
28			use craft\base\ElementInterface;
29			use craft\errors\SiteNotFoundException;
30			use craft\events\RegisterUrlRulesEvent;
31			use craft\web\UrlManager;
32
33			use yii\base\Event;
34			use yii\base\Exception;
35			use yii\base\InvalidConfigException;
36			use yii\caching\TagDependency;
37
38			/**
39			* @author nystudio107
			0 ignored issues – show Coding Style introduced 2018-08-22 20:27 UTC by Report Bug Copy Issue Report The tag in position 1 should be the @package tag Loading history... Coding Style introduced 2018-08-22 20:27 UTC by Report Bug Copy Issue Report Content of the @author tag must be in the form "Display Name <[email protected]>" Loading history...
40			* @package Seomatic
41			* @since 3.0.0
42			*/
43			class Sitemaps extends Component implements SitemapInterface
44			{
45			// Constants
46			// =========================================================================
47
48			const SEOMATIC_SITEMAPINDEX_CONTAINER = Seomatic::SEOMATIC_HANDLE.SitemapIndexTemplate::TEMPLATE_TYPE;
49
50			const SEOMATIC_SITEMAP_CONTAINER = Seomatic::SEOMATIC_HANDLE.SitemapTemplate::TEMPLATE_TYPE;
51
52			const SEOMATIC_SITEMAPCUSTOM_CONTAINER = Seomatic::SEOMATIC_HANDLE.SitemapCustomTemplate::TEMPLATE_TYPE;
53
54			const SEARCH_ENGINE_SUBMISSION_URLS = [
55			'google' => 'https://www.google.com/ping?sitemap=',
56			'bing' => 'https://www.bing.com/ping?sitemap=',
57			];
58
59			// Protected Properties
60			// =========================================================================
61
62			/**
63			* @var FrontendTemplateContainer
64			*/
65			protected $sitemapTemplateContainer;
66
67			// Public Methods
68			// =========================================================================
69
70			/**
			0 ignored issues – show Coding Style introduced 2018-08-22 20:26 UTC by Report Bug Copy Issue Report Doc comment is empty Loading history...
71			*
72			*/
73			public function init()
74			{
75			parent::init();
76			}
77
78			/**
79			* Load in the sitemap frontend template containers
80			*/
81			public function loadSitemapContainers()
82			{
83			if (Seomatic::$settings->sitemapsEnabled) {
84			$this->sitemapTemplateContainer = FrontendTemplateContainer::create();
85			// The Sitemap Index
86			$sitemapIndexTemplate = SitemapIndexTemplate::create();
87			$this->sitemapTemplateContainer->addData($sitemapIndexTemplate, self::SEOMATIC_SITEMAPINDEX_CONTAINER);
88			// A custom sitemap
89			$sitemapCustomTemplate = SitemapCustomTemplate::create();
90			$this->sitemapTemplateContainer->addData($sitemapCustomTemplate, self::SEOMATIC_SITEMAPCUSTOM_CONTAINER);
91			// A generic sitemap
92			$sitemapTemplate = SitemapTemplate::create();
93			$this->sitemapTemplateContainer->addData($sitemapTemplate, self::SEOMATIC_SITEMAP_CONTAINER);
94			// Handler: UrlManager::EVENT_REGISTER_SITE_URL_RULES
95			Event::on(
96			UrlManager::class,
97			UrlManager::EVENT_REGISTER_SITE_URL_RULES,
98			function (RegisterUrlRulesEvent $event) {
99			Craft::debug(
100			'UrlManager::EVENT_REGISTER_SITE_URL_RULES',
101			__METHOD__
102			);
103			// Register our sitemap routes
104			$event->rules = array_merge(
105			$event->rules,
106			$this->sitemapRouteRules()
107			);
108			}
109			);
110			}
111			}
112
113			/**
114			* @return array
115			*/
116			public function sitemapRouteRules(): array
117			{
118			$rules = [];
119			$groups = Craft::$app->getSites()->getAllGroups();
120			$groupId = $groups[0]->id;
			0 ignored issues – show Unused Code introduced 2020-08-29 02:52 UTC by Report Bug Copy Issue Report The assignment to `$groupId` is dead and can be removed. Loading history...
121			$currentSite = null;
			0 ignored issues – show Unused Code introduced 2018-10-09 15:10 UTC by Report Bug Copy Issue Report The assignment to `$currentSite` is dead and can be removed. Loading history...
122			try {
123			$currentSite = Craft::$app->getSites()->getCurrentSite();
124			} catch (SiteNotFoundException $e) {
125			Craft::error($e->getMessage(), __METHOD__);
126			}
127			if ($currentSite) {
128			try {
129			$groupId = $currentSite->getGroup()->id;
130			} catch (InvalidConfigException $e) {
131			Craft::error($e->getMessage(), __METHOD__);
132			}
133			}
134			// Add the route to redirect sitemap.xml to the actual sitemap
135			$route =
			0 ignored issues – show Coding Style introduced 2020-09-01 02:59 UTC by Report Bug Copy Issue Report Multi-line assignments must have the equal sign on the second line Loading history...
136			Seomatic::$plugin->handle
137			.'/'
138			.'sitemap'
139			.'/'
140			.'sitemap-index-redirect';
141			$rules['sitemap.xml'] = [
142			'route' => $route,
143			];
144			// Add the route for the sitemap.xsl styles
145			$route =
			0 ignored issues – show Coding Style introduced 2020-09-01 02:59 UTC by Report Bug Copy Issue Report Multi-line assignments must have the equal sign on the second line Loading history...
146			Seomatic::$plugin->handle
147			.'/'
148			.'sitemap'
149			.'/'
150			.'sitemap-styles';
151			$rules['sitemap.xsl'] = [
152			'route' => $route,
153			];
154			// Add the route for the sitemap-empty.xsl styles
155			$route =
			0 ignored issues – show Coding Style introduced 2020-09-01 02:59 UTC by Report Bug Copy Issue Report Multi-line assignments must have the equal sign on the second line Loading history...
156			Seomatic::$plugin->handle
157			.'/'
158			.'sitemap'
159			.'/'
160			.'sitemap-empty-styles';
161			$rules['sitemap-empty.xsl'] = [
162			'route' => $route,
163			];
164			// Add all of the frontend container routes
165			foreach ($this->sitemapTemplateContainer->data as $sitemapTemplate) {
166			/** @var $sitemapTemplate FrontendTemplate */
			0 ignored issues – show Coding Style introduced 2018-08-22 20:26 UTC by Report Bug Copy Issue Report The open comment tag must be the only content on the line Loading history... Coding Style introduced 2018-08-22 20:26 UTC by Report Bug Copy Issue Report The close comment tag must be the only content on the line Loading history...
167			$rules = array_merge(
168			$rules,
169			$sitemapTemplate->routeRules()
170			);
171			}
172
173			return $rules;
174			}
175
176			/**
177			* See if any of the entry types have robots enable and sitemap urls enabled
178			*
179			* @param MetaBundle $metaBundle
			0 ignored issues – show Coding Style introduced 2018-08-22 20:26 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
180			* @return bool
			0 ignored issues – show Coding Style introduced 2021-07-19 18:01 UTC by Report Bug Copy Issue Report Tag @return cannot be grouped with parameter tags in a doc comment Loading history...
181			*/
182			public function anyEntryTypeHasSitemapUrls(MetaBundle $metaBundle): bool
183			{
184			$result = false;
185			$seoElement = Seomatic::$plugin->seoElements->getSeoElementByMetaBundleType($metaBundle->sourceBundleType);
186			if ($seoElement) {
187			if (!empty($seoElement::typeMenuFromHandle($metaBundle->sourceHandle))) {
188			$section = $seoElement::sourceModelFromHandle($metaBundle->sourceHandle);
189			if ($section !== null) {
190			$entryTypes = $section->getEntryTypes();
191			// Fetch each meta bundle for each entry type to see if _any_ of them have sitemap URLs
192			foreach ($entryTypes as $entryType) {
193			$entryTypeBundle = Seomatic::$plugin->metaBundles->getMetaBundleBySourceId(
194			$metaBundle->sourceBundleType,
195			$metaBundle->sourceId,
196			$metaBundle->sourceSiteId,
197			$entryType->id
198			);
199			if ($entryTypeBundle) {
200			$robotsEnabled = true;
201			if (!empty($entryTypeBundle->metaGlobalVars->robots)) {
202			$robotsEnabled = $entryTypeBundle->metaGlobalVars->robots !== 'none' &&
203			$entryTypeBundle->metaGlobalVars->robots !== 'noindex';
204			}
205			if ($entryTypeBundle->metaSitemapVars->sitemapUrls && $robotsEnabled) {
206			$result = true;
207			}
208			}
209			}
210			}
211			}
212			}
213
214			return $result;
215			}
216
217			/**
218			* @param string $template
			0 ignored issues – show Coding Style introduced 2018-08-22 20:26 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
219			* @param array $params
			0 ignored issues – show Coding Style introduced 2018-08-22 20:26 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
220			*
221			* @return string
222			*/
223			public function renderTemplate(string $template, array $params = []): string
224			{
225			$html = '';
226			if (!empty($this->sitemapTemplateContainer->data[$template])) {
227			/** @var FrontendTemplate $sitemapTemplate */
			0 ignored issues – show Coding Style introduced 2018-08-22 20:26 UTC by Report Bug Copy Issue Report The open comment tag must be the only content on the line Loading history... Coding Style introduced 2018-08-22 20:26 UTC by Report Bug Copy Issue Report The close comment tag must be the only content on the line Loading history...
228			$sitemapTemplate = $this->sitemapTemplateContainer->data[$template];
229			$html = $sitemapTemplate->render($params);
230			}
231
232			return $html;
233			}
234
235			/**
236			* Submit the sitemap index to the search engine services
237			*/
238			public function submitSitemapIndex()
239			{
240			if (Seomatic::$settings->sitemapsEnabled && Seomatic::$environment === 'live' && Seomatic::$settings->submitSitemaps) {
241			// Submit the sitemap to each search engine
242			$searchEngineUrls = self::SEARCH_ENGINE_SUBMISSION_URLS;
243			foreach ($searchEngineUrls as &$url) {
244			$groups = Craft::$app->getSites()->getAllGroups();
245			foreach ($groups as $group) {
246			$groupSiteIds = $group->getSiteIds();
247			if (!empty($groupSiteIds)) {
248			$siteId = $groupSiteIds[0];
249			$sitemapIndexUrl = $this->sitemapIndexUrlForSiteId($siteId);
250			if (!empty($sitemapIndexUrl)) {
251			$submissionUrl = $url.urlencode($sitemapIndexUrl);
252			// create new guzzle client
253			$guzzleClient = Craft::createGuzzleClient(['timeout' => 120, 'connect_timeout' => 120]);
254			// Submit the sitemap index to each search engine
255			try {
256			$guzzleClient->post($submissionUrl);
257			Craft::info(
258			'Sitemap index submitted to: '.$submissionUrl,
259			__METHOD__
260			);
261			} catch (\Exception $e) {
262			Craft::error(
263			'Error submitting sitemap index to: '.$submissionUrl.' - '.$e->getMessage(),
264			__METHOD__
265			);
266			}
267			}
268			}
269			}
270			}
271			}
272			}
273
274			/**
275			* Submit the bundle sitemap to the search engine services
276			*
277			* @param ElementInterface $element
			0 ignored issues – show Coding Style introduced 2018-08-22 20:26 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
278			*/
279			public function submitSitemapForElement(ElementInterface $element)
280			{
281			if (Seomatic::$settings->sitemapsEnabled && Seomatic::$environment === 'live' && Seomatic::$settings->submitSitemaps) {
282			/** @var Element $element */
			0 ignored issues – show Coding Style introduced 2018-08-22 20:26 UTC by Report Bug Copy Issue Report The close comment tag must be the only content on the line Loading history... Coding Style introduced 2018-08-22 20:26 UTC by Report Bug Copy Issue Report The open comment tag must be the only content on the line Loading history...
283			list($sourceId, $sourceBundleType, $sourceHandle, $sourceSiteId, $typeId)
284			= Seomatic::$plugin->metaBundles->getMetaSourceFromElement($element);
285			// Submit the sitemap to each search engine
286			$searchEngineUrls = self::SEARCH_ENGINE_SUBMISSION_URLS;
287			foreach ($searchEngineUrls as &$url) {
288			$sitemapUrl = $this->sitemapUrlForBundle($sourceBundleType, $sourceHandle, $sourceSiteId);
289			if (!empty($sitemapUrl)) {
290			$submissionUrl = $url.urlencode($sitemapUrl);
291			// create new guzzle client
292			$guzzleClient = Craft::createGuzzleClient(['timeout' => 120, 'connect_timeout' => 120]);
293			// Submit the sitemap index to each search engine
294			try {
295			$guzzleClient->post($submissionUrl);
296			Craft::info(
297			'Sitemap index submitted to: '.$submissionUrl,
298			__METHOD__
299			);
300			} catch (\Exception $e) {
301			Craft::error(
302			'Error submitting sitemap index to: '.$submissionUrl.' - '.$e->getMessage(),
303			__METHOD__
304			);
305			}
306			}
307			}
308			}
309			}
310
311			/**
312			* Submit the bundle sitemap to the search engine services
313			*
314			* @param int $siteId
			0 ignored issues – show Coding Style introduced 2018-08-22 20:26 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
315			*/
316			public function submitCustomSitemap(int $siteId)
317			{
318			if (Seomatic::$settings->sitemapsEnabled && Seomatic::$environment === 'live' && Seomatic::$settings->submitSitemaps) {
319			// Submit the sitemap to each search engine
320			$searchEngineUrls = self::SEARCH_ENGINE_SUBMISSION_URLS;
321			foreach ($searchEngineUrls as &$url) {
322			$sitemapUrl = $this->sitemapCustomUrlForSiteId($siteId);
323			if (!empty($sitemapUrl)) {
324			$submissionUrl = $url.urlencode($sitemapUrl);
325			// create new guzzle client
326			$guzzleClient = Craft::createGuzzleClient(['timeout' => 120, 'connect_timeout' => 120]);
327			// Submit the sitemap index to each search engine
328			try {
329			$guzzleClient->post($submissionUrl);
330			Craft::info(
331			'Sitemap Custom submitted to: '.$submissionUrl,
332			__METHOD__
333			);
334			} catch (\Exception $e) {
335			Craft::error(
336			'Error submitting sitemap index to: '.$submissionUrl.' - '.$e->getMessage(),
337			__METHOD__
338			);
339			}
340			}
341			}
342			}
343			}
344
345			/**
346			* Get the URL to the $siteId's sitemap index
347			*
348			* @param int\|null $siteId
			0 ignored issues – show Coding Style introduced 2018-08-22 20:26 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
349			*
350			* @return string
351			*/
352			public function sitemapIndexUrlForSiteId(int $siteId = null): string
353			{
354			$url = '';
355			$sites = Craft::$app->getSites();
356			if ($siteId === null) {
357			$siteId = $sites->currentSite->id ?? 1;
358			}
359			$site = $sites->getSiteById($siteId);
360			if ($site !== null) {
361			try {
362			$url = UrlHelper::siteUrl(
363			'/sitemaps-'
364			.$site->groupId
365			.'-sitemap.xml',
366			null,
367			null,
368			$siteId
369			);
370			} catch (Exception $e) {
371			Craft::error($e->getMessage(), __METHOD__);
372			}
373			}
374
375			return $url;
376			}
377
378			/**
379			* Return all of the sitemap indexes the current group of sites
380			*
381			* @return string
382			*/
383			public function sitemapIndex(): string
384			{
385			$result = '';
386			$sites = [];
387			// If sitemaps aren't enabled globally, return nothing for the sitemap index
388			if (!Seomatic::$settings->sitemapsEnabled) {
389			return '';
390			}
391			if (Seomatic::$settings->siteGroupsSeparate) {
392			// Get only the sites that are in the current site's group
393			try {
394			$siteGroup = Craft::$app->getSites()->getCurrentSite()->getGroup();
395			} catch (InvalidConfigException $e) {
396			$siteGroup = null;
397			Craft::error($e->getMessage(), __METHOD__);
398			}
399			// If we can't get a group, just use the current site
400			if ($siteGroup === null) {
401			$sites = [Craft::$app->getSites()->getCurrentSite()];
402			} else {
			0 ignored issues – show Coding Style introduced 2021-03-23 23:56 UTC by Report Bug Copy Issue Report Expected "} else \n"; found " else {\n" Loading history...
403			$sites = $siteGroup->getSites();
404			}
405			} else {
406			$sites = Craft::$app->getSites()->getAllSites();
407			}
408
409			foreach($sites as $site) {
			0 ignored issues – show Coding Style introduced 2021-03-23 23:56 UTC by Report Bug Copy Issue Report Expected "foreach (...) {\n"; found "foreach(...) {\n" Loading history...
410			$result .= 'sitemap: ' . $this->sitemapIndexUrlForSiteId($site->id) . PHP_EOL;
411			}
412
413			return rtrim($result, PHP_EOL);
414			}
415
416			/**
417			* @param int\|null $siteId
			0 ignored issues – show Coding Style introduced 2018-08-22 20:26 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
418			*
419			* @return string
420			*/
421			public function sitemapCustomUrlForSiteId(int $siteId = null)
422			{
423			$url = '';
424			$sites = Craft::$app->getSites();
425			if ($siteId === null) {
426			$siteId = $sites->currentSite->id ?? 1;
427			}
428			$site = $sites->getSiteById($siteId);
429			if ($site) {
430			try {
431			$url = UrlHelper::siteUrl(
432			'/sitemaps-'
433			.$site->groupId
434			.'-'
435			.SitemapCustomTemplate::CUSTOM_SCOPE
436			.'-'
437			.SitemapCustomTemplate::CUSTOM_HANDLE
438			.'-'
439			.$siteId
440			.'-sitemap.xml',
441			null,
442			null,
443			$siteId
444			);
445			} catch (Exception $e) {
446			Craft::error($e->getMessage(), __METHOD__);
447			}
448			}
449
450			return $url;
451			}
452
453			/**
454			* @param string $sourceBundleType
			0 ignored issues – show Coding Style introduced 2018-08-22 20:26 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
455			* @param string $sourceHandle
			0 ignored issues – show Coding Style introduced 2018-08-22 20:26 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
456			* @param int\|null $siteId
			0 ignored issues – show Coding Style introduced 2018-11-03 05:03 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
457			*
458			* @return string
459			*/
460			public function sitemapUrlForBundle(string $sourceBundleType, string $sourceHandle, int $siteId = null): string
461			{
462			$url = '';
463			$sites = Craft::$app->getSites();
464			if ($siteId === null) {
465			$siteId = $sites->currentSite->id ?? 1;
466			}
467			$site = $sites->getSiteById($siteId);
468			$metaBundle = Seomatic::$plugin->metaBundles->getMetaBundleBySourceHandle(
469			$sourceBundleType,
470			$sourceHandle,
471			$siteId
472			);
473			if ($site && $metaBundle) {
474			try {
475			$url = UrlHelper::siteUrl(
476			'/sitemaps-'
477			.$site->groupId
478			.'-'
479			.$metaBundle->sourceBundleType
480			.'-'
481			.$metaBundle->sourceHandle
482			.'-'
483			.$metaBundle->sourceSiteId
484			.'-sitemap.xml',
485			null,
486			null,
487			$siteId
488			);
489			} catch (Exception $e) {
490			Craft::error($e->getMessage(), __METHOD__);
491			}
492			}
493
494			return $url;
495			}
496
497			/**
498			* Invalidate all of the sitemap caches
499			*/
500			public function invalidateCaches()
501			{
502			$cache = Craft::$app->getCache();
503			TagDependency::invalidate($cache, self::GLOBAL_SITEMAP_CACHE_TAG);
504			Craft::info(
505			'All sitemap caches cleared',
506			__METHOD__
507			);
508			}
509
510			/**
511			* Invalidate the sitemap cache passed in $handle
512			*
513			* @param string $handle
			0 ignored issues – show Coding Style introduced 2018-08-22 20:26 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
514			* @param int $siteId
			0 ignored issues – show Coding Style introduced 2018-11-03 05:03 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
515			* @param string $type
			0 ignored issues – show Coding Style introduced 2021-07-19 18:01 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
516			*/
517			public function invalidateSitemapCache(string $handle, int $siteId, string $type)
518			{
519			$cache = Craft::$app->getCache();
520			// If the queue should be run automatically, do it now
521			TagDependency::invalidate($cache, SitemapTemplate::SITEMAP_CACHE_TAG.$handle.$siteId);
522			Craft::info(
523			'Sitemap cache cleared: '.$handle,
524			__METHOD__
525			);
526			$sites = Craft::$app->getSites();
527			if ($siteId === null) {
			0 ignored issues – show introduced 2018-11-03 05:03 UTC by Report Bug Copy Issue Report The condition `$siteId === null` is always `false`. Loading history...
528			$siteId = $sites->currentSite->id ?? 1;
529			}
530			$site = $sites->getSiteById($siteId);
531			// Start up a job to generate the sitemap
532			$queue = Craft::$app->getQueue();
533			$jobId = $queue->push(new GenerateSitemap([
534			'groupId' => $site->groupId,
535			'type' => $type,
536			'handle' => $handle,
537			'siteId' => $siteId,
538			]));
539			Craft::debug(
540			Craft::t(
541			'seomatic',
542			'Started GenerateSitemap queue job id: {jobId}',
543			[
544			'jobId' => $jobId,
545			]
546			),
547			__METHOD__
548			);
549			}
550
551			/**
552			* Invalidate the sitemap index cache
553			*/
554			public function invalidateSitemapIndexCache()
555			{
556			$cache = Craft::$app->getCache();
557			TagDependency::invalidate($cache, SitemapIndexTemplate::SITEMAP_INDEX_CACHE_TAG);
558			Craft::info(
559			'Sitemap index cache cleared',
560			__METHOD__
561			);
562			}
563			}
564

nystudio107 / craft-seomatic

Push — develop ( 421797...7f10a1 )

Sitemaps::invalidateSitemapIndexCache() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like