TagManagerExtended.php

<?php
/**
 * Matomo - free/libre analytics platform
 *
 * @link https://matomo.org
 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 */

namespace Piwik\Plugins\TagManagerExtended;

class TagManagerExtended extends \Piwik\Plugin
{
    public function registerEvents()
    {
        return array(
            'Template.afterEventsReport' => 'renderOpenmostCommunicationAfterEvents',
            'Widget.filterWidgets' => 'addOpenmostCommunicationWidgets',
            'Template.beforeContent' => 'renderOpenmostCommunication',
            'AssetManager.getStylesheetFiles' => 'getStylesheetFiles',
            'AssetManager.getJavaScriptFiles' => 'getJavaScriptFiles',
            'TagManager.filterTags' => 'filterTags',
            'TagManager.filterVariables' => 'filterVariables',
            'TagManager.filterTriggers' => 'filterTriggers',
            'Translate.getClientSideTranslationKeys' => 'getClientSideTranslationKeys',
            'API.TagManager.getContainerTags.end' => 'fillMissingTypeMetadata',
            'API.TagManager.getContainerTag.end' => 'fillMissingTypeMetadata',
            'API.TagManager.getContainerTriggers.end' => 'fillMissingTypeMetadata',
            'API.TagManager.getContainerTrigger.end' => 'fillMissingTypeMetadata',
            'API.TagManager.getContainerVariables.end' => 'fillMissingTypeMetadata',
            'API.TagManager.getContainerVariable.end' => 'fillMissingTypeMetadata',
        );
    }

    /**
     * When an entity (tag, trigger, variable) references a type that is no longer
     * registered (plugin removed/disabled, or a built-in type filtered out), the
     * core sets typeMetadata to null. The Vue frontend then crashes while rendering
     * the list because it reads typeMetadata.description / .name unguarded.
     *
     * Inject a minimal placeholder typeMetadata so the row renders gracefully and
     * the user can still see, edit or delete the orphan entity.
     */
    public function fillMissingTypeMetadata(&$returnedValue, $extraInfo)
    {
        if (empty($returnedValue)) {
            return;
        }

        if ($this->isEntityArray($returnedValue)) {
            $this->ensureTypeMetadata($returnedValue);
            return;
        }

        if (is_array($returnedValue)) {
            foreach ($returnedValue as &$entity) {
                if ($this->isEntityArray($entity)) {
                    $this->ensureTypeMetadata($entity);
                }
            }
        }
    }

    private function isEntityArray($value): bool
    {
        return is_array($value) && array_key_exists('typeMetadata', $value) && array_key_exists('type', $value);
    }

    private function ensureTypeMetadata(array &$entity): void
    {
        if (!empty($entity['typeMetadata'])) {
            return;
        }

        $missingType = isset($entity['type']) ? (string) $entity['type'] : '';
        $label = \Piwik\Piwik::translate('TagManagerExtended_MissingType', [$missingType !== '' ? $missingType : '?']);

        $entity['typeMetadata'] = array(
            'id' => $missingType,
            'name' => $label,
            'description' => $label,
            'category' => '',
            'icon' => '',
            'help' => '',
            'order' => 9999,
            'contexts' => array(),
            'hasAdvancedSettings' => false,
            'isCustomTemplate' => false,
            'parameters' => array(),
        );
    }

    public function getClientSideTranslationKeys(&$translationKeys)
    {
        $translationKeys[] = 'TagManagerExtended_BulkActions';
        $translationKeys[] = 'TagManagerExtended_SelectAll';
        $translationKeys[] = 'TagManagerExtended_DeselectAll';
        $translationKeys[] = 'TagManagerExtended_Selected';
        $translationKeys[] = 'TagManagerExtended_BulkDelete';
        $translationKeys[] = 'TagManagerExtended_BulkPause';
        $translationKeys[] = 'TagManagerExtended_BulkResume';
        $translationKeys[] = 'TagManagerExtended_ConfirmBulkDelete';
        $translationKeys[] = 'TagManagerExtended_ConfirmBulkPause';
        $translationKeys[] = 'TagManagerExtended_ConfirmBulkResume';
        $translationKeys[] = 'TagManagerExtended_BulkSuccess';
        $translationKeys[] = 'TagManagerExtended_BulkPartialSuccess';
        $translationKeys[] = 'TagManagerExtended_BulkMissingContainer';
        $translationKeys[] = 'TagManagerExtended_JavaScriptSyntaxError';
        $translationKeys[] = 'TagManagerExtended_JsonSyntaxError';
        $translationKeys[] = 'TagManagerExtended_SyntaxValid';
        $translationKeys[] = 'TagManagerExtended_SyntaxMayContainErrors';
        $translationKeys[] = 'General_Yes';
        $translationKeys[] = 'General_No';
    }

    public function getStylesheetFiles(&$files)
    {
        $files[] = "plugins/TagManagerExtended/stylesheets/style.less";
    }

    public function getJavaScriptFiles(&$files)
    {
        // Loads the Vue UMD (bulk actions, code editor) on Tag Manager pages only
        $files[] = "plugins/TagManagerExtended/javascripts/loader.js";
    }

    public function shouldLoadUmdOnDemand()
    {
        // The UMD bundles the code editor, keep it out of the global Matomo assets
        return true;
    }

    public function filterTags(&$tags)
    {
        $found = false;
        foreach ($tags as $key => &$tag) {
            if (in_array($tag->getId(), ['Axeptio', 'CookieYes', 'Cookiebot', 'OneTrust', 'Hotjar', 'GoogleAdsConversion', 'GoogleAnalytics4Event', 'GoogleTag', 'GoogleConsentModeV2']) && $this->isPartOfTagManagerPlugin($tag)) {
                $found = true;
                unset($tags[$key]);
            }
        }

        if ($found) {
            $tags = array_values($tags);
        }
    }

    public function filterVariables(&$variables)
    {
        $found = false;
        foreach ($variables as $key => &$variable) {
            if (in_array($variable->getId(), ['ClickDataAttribute']) && $this->isPartOfTagManagerPlugin($variable)) {
                $found = true;
                unset($variables[$key]);
            }
        }

        if ($found) {
            $variables = array_values($variables);
        }
    }

    public function filterTriggers(&$triggers)
    {
        $found = false;
        foreach ($triggers as $key => &$trigger) {
            if (in_array($trigger->getId(), ['CustomEvent']) && $this->isPartOfTagManagerPlugin($trigger)) {
                $found = true;
                unset($triggers[$key]);
            }
        }

        if ($found) {
            $triggers = array_values($triggers);
        }
    }

    private function isPartOfTagManagerPlugin($object): bool
    {
        $classname = get_class($object);
        $parts = explode('\\', $classname);
        $pluginName = 'TagManager';

        if (count($parts) >= 4 && $parts[1] === 'Plugins') {
            $pluginName = $parts[2];
        }

        return $pluginName === 'TagManager';
    }

    public function renderOpenmostCommunication(&$out, $layout, $module = '', $action = '')
    {
        OpenmostCommunication::beforeContent($out, (string) $layout, (string) $module, (string) $action, $this->getPluginName());
    }

    public function addOpenmostCommunicationWidgets($list)
    {
        OpenmostCommunication::filterWidgets($list, $this->getPluginName());
    }

    public function renderOpenmostCommunicationAfterEvents(&$out, $dataTable = null)
    {
        OpenmostCommunication::afterEventsReport($out, $this->getPluginName());
    }
}