Skip to content

EspoCRM – Open Source CRM Application

4.1 KB
Raw Blame
<?php
/************************************************************************
 * This file is part of EspoCRM.
 *
 * EspoCRM – Open Source CRM application.
 * Copyright (C) 2014-2026 EspoCRM, Inc.
 * Website: https://www.espocrm.com
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * 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 <https://www.gnu.org/licenses/>.
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License version 3.
 *
 * 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 "EspoCRM" word.
 ************************************************************************/

namespace Espo\Core\Utils\Client;

use Espo\Core\Api\Response;
use Espo\Core\Utils\Client\ActionRenderer\Params;
use Espo\Core\Utils\Json;
use Espo\Core\Utils\ClientManager;
use Espo\Core\Utils\Theme\Direction;

/**
 * Renders a front-end page that executes a controller action. Utilized by entry points.
 */
class ActionRenderer
{

    public function __construct(private ClientManager $clientManager)
    {}

    /**
     * Writes to a body.
     */
    public function write(Response $response, Params $params): void
    {
        $body = $this->render(
            controller: $params->getController(),
            action: $params->getAction(),
            data: $params->getData(),
            initAuth: $params->initAuth(),
            scripts: $params->getScripts(),
            pageTitle: $params->getPageTitle(),
            theme: $params->getTheme(),
            direction: $params->getDirection(),
            login: $params->login(),
            useRouter: $params->useRouter(),
        );

        $securityParams = $params->getSecurityParams();

        if (!$securityParams && $params->getFrameAncestors()) {
            $securityParams = new SecurityParams(
                frameAncestors: $params->getFrameAncestors(),
            );
        }

        $this->clientManager->writeHeaders($response, $securityParams);

        $response->writeBody($body);
    }

    /**
     * @param ?array<string, mixed> $data
     * @param Script[] $scripts
     */
    private function render(
        string $controller,
        string $action,
        ?array $data,
        bool $initAuth,
        array $scripts,
        ?string $pageTitle,
        ?string $theme,
        ?Direction $direction,
        bool $login,
        bool $useRouter,
    ): string {

        $encodedData = Json::encode($data);

        $doActionPart = <<<EOF
                        app.doAction({
                            controllerClassName: '$controller',
                            action: '$action',
                            options: $encodedData,
                        });
        EOF;

        if ($login) {
            $script = <<<EOF
            app.start({
                            onAuth: () => {
            $doActionPart
                                },
                            });
            EOF;
        } else {
            $initAuthPart = $initAuth ? "app.initAuth();\n" : '';

            $script = <<<EOF
            {$initAuthPart}
            EOF . "\n" . $doActionPart;
        }

        $params = new RenderParams(
            runScript: $script,
            scripts: $scripts,
            pageTitle: $pageTitle,
            theme: $theme,
            direction: $direction,
            useRouter: $useRouter,
        );

        return $this->clientManager->render($params);
    }
}