SuiteCRM-Core/core/backend/Process/Service/SubpanelTopActionDefinitionProvider.php

<?php
/**
 * SuiteCRM is a customer relationship management program developed by SuiteCRM Ltd.
 * Copyright (C) 2021 SuiteCRM Ltd.
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License version 3 as published by the
 * Free Software Foundation with the addition of the following permission added
 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
 * IN WHICH THE COPYRIGHT IS OWNED BY SUITECRM, SUITECRM DISCLAIMS THE
 * WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * In accordance with Section 7(b) of the GNU Affero General Public License
 * version 3, these Appropriate Legal Notices must retain the display of the
 * "Supercharged by SuiteCRM" logo. If the display of the logos is not reasonably
 * feasible for technical reasons, the Appropriate Legal Notices must display
 * the words "Supercharged by SuiteCRM".
 */


namespace App\Process\Service;

use App\Engine\Service\ActionAvailabilityChecker\ActionAvailabilityChecker;

class SubpanelTopActionDefinitionProvider extends ActionDefinitionProvider implements SubpanelTopActionDefinitionProviderInterface
{
    /**
     * SubpanelTopActionDefinitionProvider constructor.
     * @param array $subpanelTopActions
     * @param array $subpanelTopButtons
     * @param ActionAvailabilityChecker $actionChecker
     */
    public function __construct(
        protected array $subpanelTopActions,
        protected array $subpanelTopButtons, ActionAvailabilityChecker $actionChecker,
        protected $actionAclModuleOverride
    )
    {
        parent::__construct($actionChecker, $this->actionAclModuleOverride);
    }

    /**
     * @inheritDoc
     */
    public function getActions(string $module): array
    {
        return $this->filterActions($module, $this->subpanelTopActions);
    }

    /**
     * Checks if the action is defined on base actions
     * @param string $action
     * @return bool
     */
    public function isActionDefined(string $action): bool
    {
        $config = $this->subpanelTopActions;
        $defaults = $config['default'] ?? [];
        $defaultActions = $defaults['actions'] ?? [];

        return array_key_exists($action, $defaultActions);
    }

    /**
     * Get list of modules the user has access to
     * @param string $module
     * @param string $actionKey
     * @return bool
     */
    public function isActionAvailable(string $module, string $actionKey): bool
    {
        $actions = $this->getActions($module);

        return !(empty($actions) || !array_key_exists($actionKey, $actions));
    }

    /**
     * Get list of modules the user has access to
     * @param string $module
     * @param string $actionKey
     * @return bool
     */
    protected function isActionAccessible(string $module, string $actionKey): bool
    {
        return $this->isActionDefined($actionKey)
            && $this->isActionAvailable($module, $actionKey);
    }

    /**
     * Get list of modules the user has access to
     * @param string $module
     * @param array $topButton
     * @return array
     */
    public function getTopAction(string $module, array $topButton): array
    {

        if (array_key_exists($topButton['widget_class'], $this->subpanelTopButtons)) {
            $widgetClass = $topButton['widget_class'];
        }

        if (empty($widgetClass)) {
            //check if the button class name contains the create or select string
            if (stripos($topButton['widget_class'], 'create')) {
                $widgetClass = 'SubPanelTopCreateButton';
            }

            if (stripos($topButton['widget_class'], 'select')) {
                $widgetClass = 'SubPanelTopSelectButton';
            }

        }

        if (empty($widgetClass)) {
            return [];
        }

        $mappedButton = $this->subpanelTopButtons[$widgetClass];
        if (empty($mappedButton)) {
            return [];
        }

        $mappedModule = $mappedButton['module'] ?? $module;

        $actions = $this->getActions($mappedModule);

        if (empty($actions[$mappedButton['action'] ?? ''])) {
            return [];
        }

        $mappedButton['additionalFields'] = $topButton['additionalFields'] ?? [];
        $mappedButton['extraParams'] = $topButton['extraParams'] ?? [];
        $mappedButton['widget_class'] = $topButton['widget_class'] ?? [];

        return $mappedButton;
    }
}