MetaBundles::mergeMetaBundleSettings() - Code Metrics - Inspection of "chore: Version 4.0.33" - nystudio107/craft-seomatic - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — develop-v4 ( 2d4983...bb740f )

by Andrew
created 2023-10-22 21:57 UTC
MetaBundles::mergeMetaBundleSettings() C

↳ Parent: MetaBundles
Complexity

Conditions	12
Paths	120
Size

Total Lines	40
Code Lines	26
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	156
Importance

Changes	1
Bugs	1	Features	0
Metric	Value
eloc	26
c	1
b	1
f	0
dl	0
loc	40
ccs	0
cts	27
cp	0
rs	6.8
cc	12
nc	120
nop	2
crap	156
How to fix Complexity

<?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 Craft;
use craft\base\Component;
use craft\base\Element;
use craft\base\Model;
use craft\commerce\models\ProductType;
use craft\db\Query;
use craft\models\CategoryGroup;
use craft\models\Section;
use craft\models\Section_SiteSettings;
use craft\models\Site;
use DateTime;
use Exception;
use nystudio107\seomatic\base\SeoElementInterface;
use nystudio107\seomatic\fields\SeoSettings;
use nystudio107\seomatic\helpers\ArrayHelper;
use nystudio107\seomatic\helpers\Config as ConfigHelper;
use nystudio107\seomatic\helpers\MetaValue as MetaValueHelper;
use nystudio107\seomatic\helpers\Migration as MigrationHelper;
use nystudio107\seomatic\helpers\SiteHelper;
use nystudio107\seomatic\models\MetaBundle;
use nystudio107\seomatic\models\MetaScriptContainer;
use nystudio107\seomatic\models\MetaTagContainer;
use nystudio107\seomatic\records\MetaBundle as MetaBundleRecord;
use nystudio107\seomatic\Seomatic;
use nystudio107\seomatic\services\Tag as TagService;
use Throwable;
use function in_array;

/**
 * Meta bundle functions for SEOmatic
 * An instance of the service is available via [[`Seomatic::$plugin->metaBundles`|`seomatic.bundles`]]
 *
 * @author    nystudio107Meta bundle failed validation
 * @package   Seomatic
 * @since     3.0.0
 */
class MetaBundles extends Component
{
    // Constants
    // =========================================================================

    const GLOBAL_META_BUNDLE = '__GLOBAL_BUNDLE__';
    const FIELD_META_BUNDLE = 'field';

    const IGNORE_DB_ATTRIBUTES = [
        'id',
        'dateCreated',
        'dateUpdated',
        'uid',
    ];

    const ALWAYS_INCLUDED_SEO_SETTINGS_FIELDS = [
        'twitterTitle',
        'twitterDescription',
        'twitterImage',
        'twitterImageDescription',

        'ogTitle',
        'ogDescription',
        'ogImage',
        'ogImageDescription',
    ];

    const COMPOSITE_INHERITANCE_CHILDREN = [
        'seoImage' => [
            'metaBundleSettings.seoImageTransformMode',
            'metaBundleSettings.seoImageTransform',
            'metaBundleSettings.seoImageSource',
            'metaBundleSettings.seoImageField',
            'metaBundleSettings.seoImageIds',
        ],
        'ogImage' => [
            'metaBundleSettings.ogImageTransformMode',
            'metaBundleSettings.ogImageTransform',
            'metaBundleSettings.ogImageSource',
            'metaBundleSettings.ogImageField',
            'metaBundleSettings.ogImageIds',
        ],
        'twitterImage' => [
            'metaBundleSettings.twitterImageTransformMode',
            'metaBundleSettings.twitterImageTransform',
            'metaBundleSettings.twitterImageSource',
            'metaBundleSettings.twitterImageField',
            'metaBundleSettings.twitterImageIds',
        ],
    ];

    const PRESERVE_SCRIPT_SETTINGS = [
        'include',
        'tagAttrs',
        'templateString',
        'position',
        'bodyTemplateString',
        'bodyPosition',
        'vars',
    ];

    const PRESERVE_FRONTEND_TEMPLATE_SETTINGS = [
        'include',
        'templateString',
    ];

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

    /**
     * @var MetaBundle[] indexed by [id]
     */
    protected $metaBundles = [];

    /**
     * @var array indexed by [sourceId][sourceSiteId] = id
     */
    protected $metaBundlesBySourceId = [];

    /**
     * @var array indexed by [sourceHandle][sourceSiteId] = id
     */
    protected $metaBundlesBySourceHandle = [];

    /**
     * @var array indexed by [sourceSiteId] = id
     */
    protected $globalMetaBundles = [];

    /**
     * @var array parent meta bundles for elements
     */
    protected $elementContentMetaBundles = [];

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

    /**
     * Get the global meta bundle for the site
     *
     * @param int $sourceSiteId
     * @param bool $parse Whether the resulting metabundle should be parsed
     *
     * @return null|MetaBundle
     */
    public function getGlobalMetaBundle(int $sourceSiteId, $parse = true)
    {
        $metaBundle = null;
        // See if we have the meta bundle cached
        if (!empty($this->globalMetaBundles[$sourceSiteId])) {
            return $this->globalMetaBundles[$sourceSiteId];
        }
        $metaBundleArray = (new Query())
            ->from(['{{%seomatic_metabundles}}'])
            ->where([
                'sourceBundleType' => self::GLOBAL_META_BUNDLE,
                'sourceSiteId' => $sourceSiteId,
            ])
            ->one();
        if (!empty($metaBundleArray)) {
            // Get the attributes from the db
            $metaBundleArray = array_diff_key($metaBundleArray, array_flip(self::IGNORE_DB_ATTRIBUTES));
            $metaBundle = MetaBundle::create($metaBundleArray, $parse);
            if ($parse) {
                $this->syncBundleWithConfig($metaBundle);
            }
        } else {
            // If it doesn't exist, create it
            $metaBundle = $this->createGlobalMetaBundleForSite($sourceSiteId);
        }
        if ($parse) {
            // Cache it for future accesses
            $this->globalMetaBundles[$sourceSiteId] = $metaBundle;
        }

        return $metaBundle;
    }

    /**
     * Synchronize the passed in metaBundle with the seomatic-config files if
     * there is a newer version of the MetaBundle bundleVersion in the config
     * file
     *
     * @param MetaBundle $metaBundle
     * @param bool $forceUpdate
     */
    public function syncBundleWithConfig(MetaBundle &$metaBundle, bool $forceUpdate = false)
    {
        $prevMetaBundle = $metaBundle;
        $config = [];
        $sourceBundleType = $metaBundle->sourceBundleType;
        if ($sourceBundleType === self::GLOBAL_META_BUNDLE) {
            $config = ConfigHelper::getConfigFromFile('globalmeta/Bundle');
        }
        $seoElement = Seomatic::$plugin->seoElements->getSeoElementByMetaBundleType($sourceBundleType);
        if ($seoElement) {
            $configPath = $seoElement::configFilePath();
            $config = ConfigHelper::getConfigFromFile($configPath);
        }
        // If the config file has a newer version than the $metaBundleArray, merge them
        $shouldUpdate = !empty($config) && version_compare($config['bundleVersion'], $metaBundle->bundleVersion, '>');
        if ($shouldUpdate || $forceUpdate) {
            // Create a new meta bundle
            if ($sourceBundleType === self::GLOBAL_META_BUNDLE) {
                $metaBundle = $this->createGlobalMetaBundleForSite(
                    $metaBundle->sourceSiteId,
                    $metaBundle
                );
            } else {
                $sourceModel = $seoElement::sourceModelFromId($metaBundle->sourceId);
                if ($sourceModel) {
                    $metaBundle = $this->createMetaBundleFromSeoElement(
                        $seoElement,
                        $sourceModel,
                        $metaBundle->sourceSiteId,
                        $metaBundle
                    );
                }
            }
        }

        // If for some reason we were unable to sync this meta bundle, return the old one
        if ($metaBundle === null) {
            $metaBundle = $prevMetaBundle;
        }
    }

    /**
     * @param int $siteId
     * @param MetaBundle|null $baseConfig
     *
     * @return MetaBundle
     */
    public function createGlobalMetaBundleForSite(int $siteId, $baseConfig = null): MetaBundle
    {
        // Create a new meta bundle with propagated defaults
        $metaBundleDefaults = ArrayHelper::merge(
            ConfigHelper::getConfigFromFile('globalmeta/Bundle'),
            [
                'sourceSiteId' => $siteId,
            ]
        );
        // The computedType must be set before creating the bundle
        if ($baseConfig !== null) {
            $metaBundleDefaults['metaGlobalVars']['mainEntityOfPage'] = $baseConfig->metaGlobalVars->mainEntityOfPage;
            $metaBundleDefaults['metaSiteVars']['identity']['computedType'] =
                $baseConfig->metaSiteVars->identity->computedType;
            $metaBundleDefaults['metaSiteVars']['creator']['computedType'] =
                $baseConfig->metaSiteVars->creator->computedType;
        }
        $metaBundle = MetaBundle::create($metaBundleDefaults);
        if ($metaBundle !== null) {
            if ($baseConfig !== null) {
                $this->mergeMetaBundleSettings($metaBundle, $baseConfig);
            }
            $this->updateMetaBundle($metaBundle, $siteId);
        }

        return $metaBundle;
    }

    /**
     * @param MetaBundle $metaBundle
     * @param int $siteId
     */
    public function updateMetaBundle(MetaBundle $metaBundle, int $siteId)
    {
        $metaBundle->sourceName = (string)$metaBundle->sourceName;
        $metaBundle->sourceTemplate = (string)$metaBundle->sourceTemplate;
        // Make sure it validates
        if ($metaBundle->validate(null, true)) {
            // Save it out to a record
            $params = [
                'sourceBundleType' => $metaBundle->sourceBundleType,
                'sourceId' => $metaBundle->sourceId,
                'sourceSiteId' => $siteId,
            ];
            if ($metaBundle->typeId !== null) {
                $metaBundle->typeId = (int)$metaBundle->typeId;
            }
            if (!empty($metaBundle->typeId)) {
                $params['typeId'] = $metaBundle->typeId;
            } else {
                $metaBundle->typeId = null;
            }
            $metaBundleRecord = MetaBundleRecord::findOne($params);

            if (!$metaBundleRecord) {

                $metaBundleRecord = new MetaBundleRecord();
            }

            // @TODO remove this hack that doesn't allow environment-transformed settings to be saved in a meta bundle with a proper system to address it
            // The issue was that the containers were getting saved to the db with a hard-coded setting in them, because they'd
            // been set that way by the environment, whereas to be changeable via the GUI, it needs to be set to {seomatic.meta.robots}
            $robotsTag = $metaBundle->metaContainers[MetaTagContainer::CONTAINER_TYPE . TagService::GENERAL_HANDLE]->data['robots'] ?? null;
            if (!empty($robotsTag)) {
                $robotsTag->content = $robotsTag->environment['live']['content'] ?? '{{ seomatic.meta.robots }}';
            }

            $metaBundleRecord->setAttributes($metaBundle->getAttributes(), false);

            if ($metaBundleRecord->save()) {
                Craft::info(
                    'Meta bundle updated: '
                    . $metaBundle->sourceBundleType
                    . ' id: '
                    . $metaBundle->sourceId
                    . ' from siteId: '
                    . $metaBundle->sourceSiteId,
                    __METHOD__
                );
            }
        } else {
            Craft::error(
                'Meta bundle failed validation: '
                . print_r($metaBundle->getErrors(), true)
                . ' type: '
                . $metaBundle->sourceType
                . ' id: '
                . $metaBundle->sourceId
                . ' from siteId: '
                . $metaBundle->sourceSiteId,
                __METHOD__
            );
        }
    }

    /**
     * @param SeoElementInterface $seoElement
     * @param Model $sourceModel
     * @param int $sourceSiteId
     * @param MetaBundle|null $baseConfig
     *
     * @return MetaBundle|null
     */
    public function createMetaBundleFromSeoElement(
        $seoElement,
        $sourceModel,
        int $sourceSiteId,
        $baseConfig = null
    )
    {
        $metaBundle = null;
        // Get the site settings and turn them into arrays
        /** @var Section|CategoryGroup|ProductType $sourceModel */
        $siteSettings = $sourceModel->getSiteSettings();
        if (!empty($siteSettings[$sourceSiteId])) {
            $siteSettingsArray = [];
            /** @var Section_SiteSettings $siteSetting */
            foreach ($siteSettings as $siteSetting) {
                if ($siteSetting->hasUrls && SiteHelper::siteEnabledWithUrls($sourceSiteId)) {
                    $siteSettingArray = $siteSetting->toArray();
                    // Get the site language
                    $siteSettingArray['language'] = MetaValueHelper::getSiteLanguage($siteSetting->siteId);
                    $siteSettingsArray[] = $siteSettingArray;
                }
            }
            $siteSettingsArray = ArrayHelper::index($siteSettingsArray, 'siteId');
            // Create a MetaBundle for this site
            $siteSetting = $siteSettings[$sourceSiteId];
            if ($siteSetting->hasUrls && SiteHelper::siteEnabledWithUrls($sourceSiteId)) {
                // Get the most recent dateUpdated
                $element = $seoElement::mostRecentElement($sourceModel, $sourceSiteId);
                /** @var Element $element */
                if ($element) {

                    $dateUpdated = $element->dateUpdated ?? $element->dateCreated;
                } else {
                    try {
                        $dateUpdated = new DateTime();
                    } catch (Exception $e) {
                    }
                }
                // Create a new meta bundle with propagated defaults
                $metaBundleDefaults = ArrayHelper::merge(
                    $seoElement::metaBundleConfig($sourceModel),
                    [
                        'sourceTemplate' => (string)$siteSetting->template,
                        'sourceSiteId' => $siteSetting->siteId,
                        'sourceAltSiteSettings' => $siteSettingsArray,
                        'sourceDateUpdated' => $dateUpdated,
                    ]
                );
                // The mainEntityOfPage computedType must be set before creating the bundle
                if ($baseConfig !== null && !empty($baseConfig->metaGlobalVars->mainEntityOfPage)) {
                    $metaBundleDefaults['metaGlobalVars']['mainEntityOfPage'] =
                        $baseConfig->metaGlobalVars->mainEntityOfPage;
                }
                // Merge in any migrated settings from an old Seomatic_Meta Field
                if ($element !== null) {
                    /** @var Element $elementFromSite */
                    $elementFromSite = Craft::$app->getElements()->getElementById($element->id, null, $sourceSiteId);
                    if ($element instanceof Element) {
                        $config = MigrationHelper::configFromSeomaticMeta(
                            $elementFromSite,
                            MigrationHelper::SECTION_MIGRATION_CONTEXT
                        );
                        $metaBundleDefaults = ArrayHelper::merge(
                            $metaBundleDefaults,
                            $config
                        );
                    }
                }
                $metaBundle = MetaBundle::create($metaBundleDefaults);
                if ($baseConfig !== null) {
                    $this->mergeMetaBundleSettings($metaBundle, $baseConfig);
                }
                $this->updateMetaBundle($metaBundle, $sourceSiteId);
            }
        }

        return $metaBundle;
    }

    /**
     * @param string $sourceBundleType
     * @param string $sourceHandle
     * @param int $sourceSiteId
     * @param int|null $typeId
     *
     * @return null|MetaBundle
     */
    public function getMetaBundleBySourceHandle(string $sourceBundleType, string $sourceHandle, int $sourceSiteId, $typeId = null)
    {
        $metaBundle = null;
        $typeId = (int)$typeId;
        // See if we have the meta bundle cached
        if (!empty($this->metaBundlesBySourceHandle[$sourceBundleType][$sourceHandle][$sourceSiteId][$typeId])) {
            $id = $this->metaBundlesBySourceHandle[$sourceBundleType][$sourceHandle][$sourceSiteId][$typeId];
            if (!empty($this->metaBundles[$id])) {
                return $this->metaBundles[$id];
            }
        }
        // Look for a matching meta bundle in the db
        $query = (new Query())
            ->from(['{{%seomatic_metabundles}}'])
            ->where([
                'sourceBundleType' => $sourceBundleType,
                'sourceHandle' => $sourceHandle,
                'sourceSiteId' => $sourceSiteId,
            ]);
        if (!empty($typeId)) {
            $query
                ->andWhere([
                    'typeId' => $typeId,
                ]);
        }
        $metaBundleArray = $query
            ->one();
        // If the specific query with a `typeId` returned nothing, try a more general query without `typeId`
        if (empty($metaBundleArray)) {
            $metaBundleArray = (new Query())
                ->from(['{{%seomatic_metabundles}}'])
                ->where([
                    'sourceBundleType' => $sourceBundleType,
                    'sourceHandle' => $sourceHandle,
                    'sourceSiteId' => $sourceSiteId,
                ])
                ->one();
        }
        if (!empty($metaBundleArray)) {
            $metaBundleArray = array_diff_key($metaBundleArray, array_flip(self::IGNORE_DB_ATTRIBUTES));
            $metaBundle = MetaBundle::create($metaBundleArray);
            $id = count($this->metaBundles);
            $this->metaBundles[$id] = $metaBundle;
            $this->metaBundlesBySourceHandle[$sourceBundleType][$sourceHandle][$sourceSiteId][$typeId] = $id;
        } else {
            // If it doesn't exist, create it
            $seoElement = Seomatic::$plugin->seoElements->getSeoElementByMetaBundleType($sourceBundleType);
            if ($seoElement !== null) {
                $sourceModel = $seoElement::sourceModelFromHandle($sourceHandle);
                if ($sourceModel) {
                    $metaBundle = $this->createMetaBundleFromSeoElement($seoElement, $sourceModel, $sourceSiteId);
                }
            }
        }

        return $metaBundle;
    }

    /**
     * Invalidate the caches and data structures associated with this MetaBundle
     *
     * @param string $sourceBundleType
     * @param int|null $sourceId
     * @param bool $isNew
     */
    public function invalidateMetaBundleById(string $sourceBundleType, int $sourceId, bool $isNew = false)
    {
        $metaBundleInvalidated = false;
        $sites = Craft::$app->getSites()->getAllSites();
        foreach ($sites as $site) {
            // See if this is a section we are tracking
            $metaBundle = $this->getMetaBundleBySourceId($sourceBundleType, $sourceId, $site->id);
            if ($metaBundle) {
                Craft::info(
                    'Invalidating meta bundle: '
                    . $metaBundle->sourceHandle
                    . ' from siteId: '
                    . $site->id,
                    __METHOD__
                );
                // Is this a new source?
                if (!$isNew) {
                    $metaBundleInvalidated = true;
                    // Handle syncing up the sourceHandle
                    if ($sourceBundleType !== self::GLOBAL_META_BUNDLE) {
                        $seoElement = Seomatic::$plugin->seoElements->getSeoElementByMetaBundleType($sourceBundleType);
                        if ($seoElement !== null) {
                            /** @var Section|CategoryGroup|ProductType $sourceModel */
                            $sourceModel = $seoElement::sourceModelFromId($sourceId);
                            if ($sourceModel !== null) {
                                $metaBundle->sourceName = (string)$sourceModel->name;
                                $metaBundle->sourceHandle = $sourceModel->handle;
                            }
                        }
                    }
                    // Invalidate caches after an existing section is saved
                    Seomatic::$plugin->metaContainers->invalidateContainerCacheById(
                        $sourceId,
                        $sourceBundleType,
                        $metaBundle->sourceSiteId
                    );
                    if (Seomatic::$settings->regenerateSitemapsAutomatically) {
                        Seomatic::$plugin->sitemaps->invalidateSitemapCache(
                            $metaBundle->sourceHandle,
                            $metaBundle->sourceSiteId,
                            $metaBundle->sourceBundleType,
                            false
                        );
                    }
                    // Update the meta bundle data
                    $this->updateMetaBundle($metaBundle, $site->id);
                }
            }
        }
        // If we've invalidated a meta bundle, we need to invalidate the sitemap index, too
        if ($metaBundleInvalidated) {
            Seomatic::$plugin->sitemaps->invalidateSitemapIndexCache();
        }
    }

    /**
     * @param string $sourceBundleType
     * @param int $sourceId
     * @param int|null $sourceSiteId
     * @param int|null $typeId
     *
     * @return null|MetaBundle
     */
    public function getMetaBundleBySourceId(string $sourceBundleType, int $sourceId, int $sourceSiteId, $typeId = null)
    {
        $metaBundle = null;
        $typeId = (int)$typeId;
        // See if we have the meta bundle cached
        if (!empty($this->metaBundlesBySourceId[$sourceBundleType][$sourceId][$sourceSiteId][$typeId])) {
            $id = $this->metaBundlesBySourceId[$sourceBundleType][$sourceId][$sourceSiteId][$typeId];
            if (!empty($this->metaBundles[$id])) {
                return $this->metaBundles[$id];
            }
        }
        // Look for a matching meta bundle in the db
        $query = (new Query())
            ->from(['{{%seomatic_metabundles}}'])
            ->where([
                'sourceBundleType' => $sourceBundleType,
                'sourceId' => $sourceId,
                'sourceSiteId' => $sourceSiteId,
            ]);
        if (!empty($typeId)) {
            $query
                ->andWhere([
                    'typeId' => $typeId,
                ]);
        }
        $metaBundleArray = $query
            ->one();
        // If the specific query with a `typeId` returned nothing, try a more general query without `typeId`
        if (empty($metaBundleArray)) {
            $metaBundleArray = (new Query())
                ->from(['{{%seomatic_metabundles}}'])
                ->where([
                    'sourceBundleType' => $sourceBundleType,
                    'sourceId' => $sourceId,
                    'sourceSiteId' => $sourceSiteId,
                ])
                ->one();
        }
        if (!empty($metaBundleArray)) {
            // Get the attributes from the db
            $metaBundleArray = array_diff_key($metaBundleArray, array_flip(self::IGNORE_DB_ATTRIBUTES));
            $metaBundle = MetaBundle::create($metaBundleArray);
            $this->syncBundleWithConfig($metaBundle);
            $id = count($this->metaBundles);
            $this->metaBundles[$id] = $metaBundle;
            $this->metaBundlesBySourceId[$sourceBundleType][$sourceId][$sourceSiteId][$typeId] = $id;
        } else {
            // If it doesn't exist, create it
            $seoElement = Seomatic::$plugin->seoElements->getSeoElementByMetaBundleType($sourceBundleType);
            if ($seoElement !== null) {
                $sourceModel = $seoElement::sourceModelFromId($sourceId);
                if ($sourceModel) {
                    $metaBundle = $this->createMetaBundleFromSeoElement($seoElement, $sourceModel, $sourceSiteId);
                }
            }
        }

        return $metaBundle;
    }

    /**
     * Resave all the meta bundles of a given type.
     *
     * @param string $metaBundleType
     */
    public function resaveMetaBundles(string $metaBundleType)
    {
        // For all meta bundles of a given type
        $metaBundleRows = (new Query())
            ->from(['{{%seomatic_metabundles}}'])
            ->where(['sourceBundleType' => $metaBundleType])
            ->all();

        foreach ($metaBundleRows as $metaBundleRow) {
            // Create it from the DB data
            $metaBundleData = array_diff_key($metaBundleRow, array_flip(self::IGNORE_DB_ATTRIBUTES));
            $metaBundle = MetaBundle::create($metaBundleData);
            if (!$metaBundle) {
                continue;
            }
            // Sync it and update it.
            Seomatic::$plugin->metaBundles->syncBundleWithConfig($metaBundle, true);
            Seomatic::$plugin->metaBundles->updateMetaBundle($metaBundle, $metaBundle->sourceSiteId);
        }
    }

    /**
     * Invalidate the caches and data structures associated with this MetaBundle
     *
     * @param Element $element
     * @param bool $isNew
     */
    public function invalidateMetaBundleByElement($element, bool $isNew = false)
    {
        $metaBundleInvalidated = false;
        $invalidateMetaBundle = true;
        $sitemapInvalidated = false;
        if ($element->getIsDraft() || $element->getIsRevision()) {
            $invalidateMetaBundle = false;
        }
        if ($element && $invalidateMetaBundle) {
            $uri = $element->uri ?? '';
            // Normalize the incoming URI to account for `__home__`
            if ($element->slug) {
                $uri = ($element->slug === '__home__') ? '' : $uri;
            }
            // Invalidate sitemap caches after an existing element is saved
            list($sourceId, $sourceBundleType, $sourceHandle, $sourceSiteId, $typeId)
                = $this->getMetaSourceFromElement($element);
            if ($sourceId) {
                Craft::info(
                    'Invalidating meta bundle: '
                    . $uri
                    . '/'
                    . $sourceSiteId,
                    __METHOD__
                );
                $metaBundleInvalidated = true;
                Seomatic::$plugin->metaContainers->invalidateContainerCacheByPath($uri, $sourceSiteId);
                // Invalidate the sitemap cache
                $metaBundle = $this->getMetaBundleBySourceId($sourceBundleType, $sourceId, $sourceSiteId);
                if ($metaBundle) {
                    if ($element) {
                        $dateUpdated = $element->dateUpdated ?? $element->dateCreated;
                    } else {
                        try {
                            $dateUpdated = new DateTime();
                        } catch (Exception $e) {
                        }
                    }
                    $metaBundle->sourceDateUpdated = $dateUpdated;
                    // Update the meta bundle data
                    $this->updateMetaBundle($metaBundle, $sourceSiteId);
                    if ($metaBundle
                        && $metaBundle->metaSitemapVars->sitemapUrls
                        && $element->scenario !== Element::SCENARIO_ESSENTIALS
                        && Seomatic::$settings->regenerateSitemapsAutomatically) {
                        $sitemapInvalidated = true;
                        Seomatic::$plugin->sitemaps->invalidateSitemapCache(
                            $metaBundle->sourceHandle,
                            $metaBundle->sourceSiteId,
                            $metaBundle->sourceBundleType,
                            false
                        );
                    }
                }
            }
            // If we've invalidated a meta bundle, we need to invalidate the sitemap index, too
            if ($metaBundleInvalidated
                && $sitemapInvalidated
                && $element->scenario !== Element::SCENARIO_ESSENTIALS) {
                Seomatic::$plugin->sitemaps->invalidateSitemapIndexCache();
            }
        }
    }

    /**
     * @param Element $element
     *
     * @return array
     */
    public function getMetaSourceFromElement(Element $element): array
    {
        $sourceId = 0;
        $typeId = null;
        $sourceSiteId = 0;
        $sourceHandle = '';
        // See if this is a section we are tracking
        $sourceBundleType = Seomatic::$plugin->seoElements->getMetaBundleTypeFromElement($element);
        if ($sourceBundleType) {
            $seoElement = Seomatic::$plugin->seoElements->getSeoElementByMetaBundleType($sourceBundleType);
            if ($seoElement) {
                $sourceId = $seoElement::sourceIdFromElement($element);
                $typeId = $seoElement::typeIdFromElement($element);
                $sourceHandle = $seoElement::sourceHandleFromElement($element);
                $sourceSiteId = $element->siteId;
            }
        } else {
            $sourceBundleType = '';
        }

        return [$sourceId, $sourceBundleType, $sourceHandle, $sourceSiteId, $typeId];
    }

    /**
     * Get all of the meta bundles for a given $sourceSiteId
     *
     * @param int|null $sourceSiteId
     *
     * @return array
     */
    public function getContentMetaBundlesForSiteId($sourceSiteId, $filter = ''): array
    {
        $metaBundles = [];
        $bundles = [];
        // Since sectionIds, CategoryIds, etc. are not unique, we need to do separate queries and combine them
        $seoElements = Seomatic::$plugin->seoElements->getAllSeoElementTypes();
        foreach ($seoElements as $seoElement) {

            $subQuery = (new Query())
                ->from(['{{%seomatic_metabundles}}'])
                ->where(['=', 'sourceBundleType', $seoElement::META_BUNDLE_TYPE]);

            if ((int)$sourceSiteId !== 0) {
                $subQuery->andWhere(['sourceSiteId' => $sourceSiteId]);
            }
            if ($filter !== '') {
                $subQuery->andWhere(['like', 'sourceName', $filter]);
            }
            $bundleQuery = (new Query())
                ->select(['mb.*'])
                ->from(['mb' => $subQuery])
                ->leftJoin(['mb2' => $subQuery], [
                    'and',
                    '[[mb.sourceId]] = [[mb2.sourceId]]',
                    '[[mb.id]] < [[mb2.id]]'
                ])
                ->where(['mb2.id' => null]);
            $bundles = array_merge($bundles, $bundleQuery->all());
        }
        foreach ($bundles as $bundle) {
            $bundle = array_diff_key($bundle, array_flip(self::IGNORE_DB_ATTRIBUTES));
            $metaBundle = MetaBundle::create($bundle);
            if ($metaBundle) {
                $metaBundles[] = $metaBundle;
            }
        }

        return $metaBundles;
    }

    /**
     * Get the parent content meta bundle for a given element.
     *
     * @param Element $element
     * @return mixed|MetaBundle|null
     */
    public function getContentMetaBundleForElement(Element $element)
    {
        $source = $this->getMetaSourceFromElement($element);
        $key = implode(".", $source) . '.' . $element->siteId;

        if (empty($this->elementContentMetaBundles[$key])) {
            $this->elementContentMetaBundles[$key] = $this->getMetaBundleBySourceId($source[1], $source[0], $element->siteId, $source[4]);
        }

        return $this->elementContentMetaBundles[$key];
    }

    /**
     * Set fields the user is unable to edit to an empty string, so they are
     * filtered out when meta containers are combined
     *
     * @param MetaBundle $metaBundle
     * @param string $fieldHandle
     */
    public function pruneFieldMetaBundleSettings(MetaBundle $metaBundle, string $fieldHandle)
    {
        /** @var SeoSettings $seoSettingsField */
        $seoSettingsField = Craft::$app->getFields()->getFieldByHandle($fieldHandle);
        if ($seoSettingsField) {
            $seoSettingsEnabledFields = array_flip(array_merge(
                (array)$seoSettingsField->generalEnabledFields,
                (array)$seoSettingsField->twitterEnabledFields,
                (array)$seoSettingsField->facebookEnabledFields,
                (array)$seoSettingsField->sitemapEnabledFields
            ));
            // Always include some fields, as they are calculated even if not explicitly included
            $seoSettingsEnabledFields = array_merge(
                $seoSettingsEnabledFields,
                array_flip(self::ALWAYS_INCLUDED_SEO_SETTINGS_FIELDS)
            );
            // metaGlobalVars
            $attributes = $metaBundle->metaGlobalVars->getAttributes();

            // Get a list of explicitly inherited values
            $inherited = array_keys(ArrayHelper::remove($attributes, 'inherited', []));
            $emptyValues = array_fill_keys(array_keys(array_diff_key($attributes, $seoSettingsEnabledFields)), '');

            // Nullify the inherited values
            $emptyValues = array_merge($emptyValues, array_fill_keys($inherited, ''));
            foreach ($inherited as $inheritedAttribute) {
                foreach (self::COMPOSITE_INHERITANCE_CHILDREN[$inheritedAttribute] ?? [] as $child) {
                    list ($model, $attribute) = explode('.', $child);
                    $metaBundle->{$model}->$attribute = '';
                }
            }

            $attributes = array_merge($attributes, $emptyValues);
            $metaBundle->metaGlobalVars->setAttributes($attributes, false);


            // Handle the mainEntityOfPage
            if (!in_array('mainEntityOfPage', (array)$seoSettingsField->generalEnabledFields, false)) {
                $metaBundle->metaGlobalVars->mainEntityOfPage = '';
            }
            // metaSiteVars
            $attributes = $metaBundle->metaSiteVars->getAttributes();
            $emptyValues = array_fill_keys(array_keys(array_diff_key($attributes, $seoSettingsEnabledFields)), '');
            $attributes = array_merge($attributes, $emptyValues);
            $metaBundle->metaSiteVars->setAttributes($attributes, false);
            // metaSitemapVars
            $attributes = $metaBundle->metaSitemapVars->getAttributes();

            // Get a list of explicitly inherited values
            $inherited = array_keys(ArrayHelper::remove($attributes, 'inherited', []));
            $emptyValues = array_fill_keys(array_keys(array_diff_key($attributes, $seoSettingsEnabledFields)), '');

            // Nullify the inherited values
            $emptyValues = array_merge($emptyValues, array_fill_keys($inherited, ''));

            $attributes = array_merge($attributes, $emptyValues);
            $metaBundle->metaSitemapVars->setAttributes($attributes, false);
        }
    }

    /**
     * Remove any meta bundles from the $metaBundles array that no longer
     * correspond with an SeoElement
     *
     * @param array $metaBundles
     */
    public function pruneVestigialMetaBundles(array &$metaBundles)
    {
        foreach ($metaBundles as $key => $metaBundle) {
            $prune = $this->pruneVestigialMetaBundle($metaBundle);
            /** @var MetaBundle $metaBundle */
            if ($prune) {
                unset($metaBundles[$key]);
            }
        }
        ArrayHelper::multisort($metaBundles, 'sourceName');
    }

    /**
     * Determine whether a given MetaBundle is vestigial or not
     *
     * @param $metaBundle
     *
     * @return bool
     */
    public function pruneVestigialMetaBundle($metaBundle): bool
    {
        $prune = false;
        $sourceBundleType = $metaBundle->sourceBundleType;
        if ($sourceBundleType && $sourceBundleType !== self::GLOBAL_META_BUNDLE) {
            $seoElement = Seomatic::$plugin->seoElements->getSeoElementByMetaBundleType($sourceBundleType);
            if ($seoElement) {
                $sourceModel = $seoElement::sourceModelFromHandle($metaBundle->sourceHandle);
                /** @var Section|CategoryGroup|ProductType $sourceModel */
                if ($sourceModel === null) {
                    $prune = true;
                } else {
                    $prune = true;
                    $siteSettings = $sourceModel->getSiteSettings();
                    if (!empty($siteSettings)) {
                        /** @var Section_SiteSettings $siteSetting */
                        foreach ($siteSettings as $siteSetting) {
                            if ($siteSetting->siteId == $metaBundle->sourceSiteId && $siteSetting->hasUrls && SiteHelper::siteEnabledWithUrls($siteSetting->siteId)) {
                                $prune = false;
                            }
                        }
                    }
                }
            } else {
                $prune = true;
            }
        }

        return $prune;
    }

    /**
     * Delete any meta bundles from the $metaBundles array that no longer
     * correspond with an SeoElement
     *
     * @param array $metaBundles
     */
    public function deleteVestigialMetaBundles(array $metaBundles)
    {
        foreach ($metaBundles as $key => $metaBundle) {
            $prune = $this->pruneVestigialMetaBundle($metaBundle);
            /** @var MetaBundle $metaBundle */
            if ($prune) {
                $this->deleteMetaBundleBySourceId(
                    $metaBundle->sourceBundleType,
                    $metaBundle->sourceId,
                    $metaBundle->sourceSiteId
                );
            }
        }
    }

    /**
     * Delete a meta bundle by $sourceId
     *
     * @param string $sourceBundleType
     * @param int $sourceId
     * @param null $siteId

     */
    public function deleteMetaBundleBySourceId(string $sourceBundleType, int $sourceId, $siteId = null)
    {
        $sites = [];
        if ($siteId === null) {
            $sites = Craft::$app->getSites()->getAllSites();
        } else {
            $sites[] = Craft::$app->getSites()->getSiteById($siteId);
        }
        /** @var  $site Site */
        foreach ($sites as $site) {
            // Look for a matching meta bundle in the db
            $metaBundleRecord = MetaBundleRecord::findOne([
                'sourceBundleType' => $sourceBundleType,
                'sourceId' => $sourceId,
                'sourceSiteId' => $site->id,
            ]);

            if ($metaBundleRecord) {
                try {
                    $metaBundleRecord->delete();
                } catch (Throwable $e) {
                    Craft::error($e->getMessage(), __METHOD__);
                }
                Craft::info(
                    'Meta bundle deleted: '
                    . $sourceId
                    . ' from siteId: '
                    . $site->id,
                    __METHOD__
                );
            }
        }
    }

    /**
     * Get all of the data from $bundle in containers of $type
     *
     * @param MetaBundle $bundle
     * @param string $type
     *
     * @return array
     */
    public function getContainerDataFromBundle(MetaBundle $bundle, string $type): array
    {
        $containerData = [];
        foreach ($bundle->metaContainers as $metaContainer) {
            if ($metaContainer::CONTAINER_TYPE === $type) {
                foreach ($metaContainer->data as $dataHandle => $data) {
                    $containerData[$dataHandle] = $data;
                }
            }
        }

        return $containerData;
    }

    /**
     * Create all of the content meta bundles
     */
    public function createContentMetaBundles()
    {
        $seoElements = Seomatic::$plugin->seoElements->getAllSeoElementTypes();
        foreach ($seoElements as $seoElement) {
            /** @var SeoElementInterface $seoElement */
            $seoElement::createAllContentMetaBundles();
        }
    }

    /**
     * Create the default global meta bundles
     */
    public function createGlobalMetaBundles()
    {
        $sites = Craft::$app->getSites()->getAllSites();
        foreach ($sites as $site) {
            $this->createGlobalMetaBundleForSite($site->id);
        }
    }

    // Protected Methods
    // =========================================================================

    /**
     * Preserve user settings from the meta bundle when updating it from the
     * config
     *
     * @param MetaBundle $metaBundle The new meta bundle
     * @param MetaBundle $baseConfig The existing meta bundle to preserve
     *                               settings from
     */
    protected function mergeMetaBundleSettings(MetaBundle $metaBundle, MetaBundle $baseConfig)
    {
        // Preserve the metaGlobalVars
        $attributes = $baseConfig->metaGlobalVars->getAttributes();
        $metaBundle->metaGlobalVars->setAttributes($attributes);
        // Preserve the metaSiteVars
        if ($baseConfig->metaSiteVars !== null) {
            $attributes = $baseConfig->metaSiteVars->getAttributes();
            $metaBundle->metaSiteVars->setAttributes($attributes);
            if ($baseConfig->metaSiteVars->identity !== null) {
                $attributes = $baseConfig->metaSiteVars->identity->getAttributes();
                $metaBundle->metaSiteVars->identity->setAttributes($attributes);
            }
            if ($baseConfig->metaSiteVars->creator !== null) {
                $attributes = $baseConfig->metaSiteVars->creator->getAttributes();
                $metaBundle->metaSiteVars->creator->setAttributes($attributes);
            }
        }
        // Preserve the Frontend Templates container user settings, but update everything else
        foreach ($baseConfig->frontendTemplatesContainer->data as $baseMetaContainerName => $baseMetaContainer) {
            $attributes = $baseMetaContainer->getAttributes();
            if (!empty($metaBundle->frontendTemplatesContainer->data[$baseMetaContainerName])) {
                foreach (self::PRESERVE_FRONTEND_TEMPLATE_SETTINGS as $frontendTemplateSetting) {
                    $metaBundle->frontendTemplatesContainer->data[$baseMetaContainerName]->$frontendTemplateSetting = $attributes[$frontendTemplateSetting] ?? '';
                }
            }
        }
        // Preserve the metaSitemapVars
        $attributes = $baseConfig->metaSitemapVars->getAttributes();
        $metaBundle->metaSitemapVars->setAttributes($attributes);
        // Preserve the metaBundleSettings
        $attributes = $baseConfig->metaBundleSettings->getAttributes();
        $metaBundle->metaBundleSettings->setAttributes($attributes);
        // Preserve the Script container user settings, but update everything else
        foreach ($baseConfig->metaContainers as $baseMetaContainerName => $baseMetaContainer) {
            if ($baseMetaContainer::CONTAINER_TYPE === MetaScriptContainer::CONTAINER_TYPE) {
                foreach ($baseMetaContainer->data as $key => $value) {
                    if (!empty($metaBundle->metaContainers[$baseMetaContainerName])) {
                        foreach (self::PRESERVE_SCRIPT_SETTINGS as $scriptSetting) {
                            $metaBundle->metaContainers[$baseMetaContainerName]->data[$key][$scriptSetting] = $value[$scriptSetting] ?? '';
                        }
                    }
                }
            }
        }
    }
}

nystudio107 / craft-seomatic

Push — develop-v4 ( 2d4983...bb740f )

MetaBundles::mergeMetaBundleSettings() C

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like
