Initial commit

application/Espo/Core/Utils/Client/ActionRenderer.php

@@ -0,0 +1,106 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 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;
+
+/**
+ * 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(),
+        );
+
+        $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,
+    ): string {
+
+        $encodedData = Json::encode($data);
+
+        $initAuthPart = $initAuth ? "app.initAuth();" : '';
+
+        $script =
+            "
+                {$initAuthPart}
+                app.doAction({
+                    controllerClassName: '$controller',
+                    action: '$action',
+                    options: $encodedData,
+                });
+            ";
+
+        $params = new RenderParams(
+            runScript: $script,
+            scripts: $scripts,
+            pageTitle: $pageTitle,
+            theme: $theme,
+        );
+
+        return $this->clientManager->render($params);
+    }
+}