Menu.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\TagManager;

use Piwik\API\Request;
use Piwik\Container\StaticContainer;
use Piwik\Menu\MenuTop;
use Piwik\Piwik;
use Piwik\Plugins\TagManager\Input\AccessValidator;
use Piwik\Plugins\TagManager\Model\Environment;

class Menu extends \Piwik\Plugin\Menu
{
    private const CONTAINER_MENU_ITEM_KEY_PREFIX = 'TagManager_Container_';

    /**
     * @var AccessValidator
     */
    private $accessValidator;

    public function __construct(AccessValidator $accessValidator)
    {
        $this->accessValidator = $accessValidator;
    }

    public function configureTopMenu(MenuTop $menu)
    {
        // Check whether to show the MTM top menu. If not, simply return early
        $idSite = \Piwik\Request::fromRequest()->getIntegerParameter('idSite', 0);
        if (!StaticContainer::get(SystemSettings::class)->doesCurrentUserHaveTagManagerAccess($idSite)) {
            return;
        }

        list($defaultAction, $defaultParams) = self::getDefaultAction();
        if ($defaultAction) {
            $menu->addItem('TagManager_TagManager', null, $this->urlForAction($defaultAction, $defaultParams), $orderId = 30);
        }
    }

    public static function getDefaultAction()
    {
        $idSite = \Piwik\Request::fromRequest()->getIntegerParameter('idSite', 0);
        if (!$idSite || !Piwik::isUserHasViewAccess($idSite)) {
            return array(null, null);
        }

        $defaultAction = 'manageContainers';
        $defaultParams = array('idContainer' => false);

        // for better performance we go here directly on to the DAO and avoid formatting the containers as this
        // makes initial pageview slower otherwise
        $containers = StaticContainer::get('Piwik\Plugins\TagManager\Dao\ContainersDao')->getContainersForSite($idSite);

        if (count($containers) == 1) {
            $firstContainer = array_shift($containers);

            $accessValidator = StaticContainer::get('Piwik\Plugins\TagManager\Input\AccessValidator');
            if ($accessValidator->hasWriteCapability($idSite)) {
                $defaultAction = 'dashboard';
            } else {
                $defaultAction = 'manageTags';
            }
            $defaultParams = array('idContainer' => $firstContainer['idcontainer']);
        }

        return array($defaultAction, $defaultParams);
    }

    private function configureContainerSubMenu($menu, $idContainer)
    {
        try {
            $idSite = \Piwik\Request::fromRequest()->getIntegerParameter('idSite', 0);

            if (!$idSite || !Piwik::isUserHasViewAccess($idSite)) {
                return;
            }

            $container = Request::processRequest('TagManager.getContainer', ['idSite' => $idSite, 'idContainer' => $idContainer]);
        } catch (\Exception $e) {
            // the container might be deleted by now
            return;
        }

        $params = array('idContainer' => $idContainer); // not needed as it is already present in url but we make sure the id is set

        if ($this->accessValidator->hasWriteCapability($idSite)) {
            $menu->addItem('TagManager_TagManager', 'Dashboard', $this->urlForAction('dashboard', $params), $orderId = 104);
        }

        $menu->addItem('TagManager_TagManager', 'TagManager_Tags', $this->urlForAction('manageTags', $params), $orderId = 105);
        $menu->addItem('TagManager_TagManager', 'TagManager_Triggers', $this->urlForAction('manageTriggers', $params), $orderId = 110);
        $menu->addItem('TagManager_TagManager', 'TagManager_Variables', $this->urlForAction('manageVariables', $params), $orderId = 115);

        $previewEnabled = false;

        foreach ($container['releases'] as $release) {
            if ($release['environment'] === Environment::ENVIRONMENT_PREVIEW) {
                $previewEnabled = true;
            }
        }

        if ($this->accessValidator->hasWriteCapability($idSite)) {
            $menu->addItem('TagManager_TagManager', 'TagManager_Versions', $this->urlForAction('manageVersions', $params), $orderId = 115);
            if ($previewEnabled) {
                $menu->addItem('TagManager_TagManager', 'TagManager_DisablePreview', array(), $orderId = 130, false, 'icon-bug', "tagManagerHelper.disablePreviewMode(" . json_encode($container['idcontainer']) . ")");
            } else {
                $menu->addItem('TagManager_TagManager', 'TagManager_EnablePreviewDebug', array(), $orderId = 130, false, 'icon-bug', "tagManagerHelper.enablePreviewMode(" . json_encode($container['idcontainer']) . ")");
            }

            if (
                $this->accessValidator->hasUseCustomTemplatesCapability($idSite) ||
                (
                    $this->accessValidator->hasWriteCapability($idSite) && $this->accessValidator->hasPublishLiveEnvironmentCapability($idSite)
                )
            ) {
                $menu->addItem('TagManager_TagManager', 'TagManager_Publish', array(), $orderId = 135, false, 'icon-rocket', "tagManagerHelper.editVersion(" . json_encode($container['idcontainer']) . ", 0, '')");
            }
        }

        $menu->addItem('TagManager_TagManager', 'TagManager_InstallCode', $this->urlForAction('releases', $params), $orderId = 140, false, 'icon-embed', "tagManagerHelper.showInstallCode(" . json_encode($container['idcontainer']) . ")");
    }

    private function addContainerMenuItems(MenuTagManager $menu, array $containers, string $action): void
    {
        foreach ($containers as $container) {
            $params = array(
                'idContainer' => $container['idcontainer'],
            );

            $menu->addItem(
                'TagManager_TagManager',
                self::CONTAINER_MENU_ITEM_KEY_PREFIX . $container['idcontainer'],
                $this->urlForAction($action, $params),
                100,
                $container['name'],
                false,
                false,
                false,
                false,
                0,
                'container-menu-item'
            );
        }
    }

    public function configureTagManagerMenu(MenuTagManager $menu)
    {
        $idSite = \Piwik\Request::fromRequest()->getIntegerParameter('idSite', 0);

        if (!$idSite || !Piwik::isUserHasViewAccess($idSite)) {
            return;
        }

        $menu->registerMenuIcon('TagManager_TagManager', 'tag-manager-menu-icon');

        $manageContainers = Piwik::translate('TagManager_ManageX', Piwik::translate('TagManager_Containers'));

        $currentIdContainer = \Piwik\Request::fromRequest()->getStringParameter('idContainer', '');
        $manageContainersParams = array(
            'idContainer' => $currentIdContainer ?: null,
        );// keeps the current container context when navigating back to manage containers
        $menu->addItem('TagManager_TagManager', null, $this->urlForAction('manageContainers', $manageContainersParams), $orderId = 50);
        $menu->addItem('TagManager_TagManager', $manageContainers, $this->urlForAction('manageContainers', $manageContainersParams), $orderId = 50);

        $containers = StaticContainer::get('Piwik\Plugins\TagManager\Dao\ContainersDao')->getContainersForSite($idSite);

        $action = \Piwik\Request::fromRequest()->getStringParameter('action', '');

        if (!$action || $action === 'manageContainers') {
            $action = $this->accessValidator->hasWriteCapability($idSite)
                ? 'dashboard'
                : 'manageTags';
        }

        $this->addContainerMenuItems($menu, $containers, $action);

        $idContainer = \Piwik\Request::fromRequest()->getStringParameter('idContainer', '');

        if ($idContainer) {
            $this->configureContainerSubMenu($menu, $idContainer);
        }
    }
}