Initial commit

application/Espo/Core/Controllers/RecordBase.php

@@ -0,0 +1,348 @@
+<?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\Controllers;
+
+use Espo\Core\Exceptions\Conflict;
+use Espo\Core\Exceptions\Error;
+use Espo\Core\Exceptions\Forbidden;
+use Espo\Core\Exceptions\BadRequest;
+use Espo\Core\Exceptions\ForbiddenSilent;
+use Espo\Core\Exceptions\NotFound;
+use Espo\Core\Exceptions\NotFoundSilent;
+use Espo\Core\Record\ServiceContainer as RecordServiceContainer;
+use Espo\Core\Record\SearchParamsFetcher;
+use Espo\Core\Record\CreateParamsFetcher;
+use Espo\Core\Record\ReadParamsFetcher;
+use Espo\Core\Record\UpdateContext;
+use Espo\Core\Record\UpdateParamsFetcher;
+use Espo\Core\Record\DeleteParamsFetcher;
+use Espo\Core\Record\FindParamsFetcher;
+use Espo\Core\Record\Service as RecordService;
+use Espo\Core\Container;
+use Espo\Core\Acl;
+use Espo\Core\AclManager;
+use Espo\Core\Utils\Config;
+use Espo\Core\Utils\Metadata;
+use Espo\Core\ServiceFactory;
+use Espo\Core\Api\Request;
+use Espo\Core\Api\Response;
+use Espo\Core\Select\SearchParams;
+use Espo\Core\Di;
+use Espo\Entities\User;
+use Espo\Entities\Preferences;
+use Espo\ORM\Entity;
+use Espo\ORM\EntityManager;
+
+use stdClass;
+
+class RecordBase extends Base implements
+
+    Di\EntityManagerAware,
+    Di\InjectableFactoryAware
+{
+    use Di\EntityManagerSetter;
+    use Di\InjectableFactorySetter;
+
+    /** @var string */
+    public static $defaultAction = 'list';
+
+    /** @var RecordServiceContainer */
+    protected $recordServiceContainer;
+    /** @var Config */
+    protected $config;
+    /** @var User */
+    protected $user;
+    /** @var Acl */
+    protected $acl;
+
+    /**
+     * @deprecated
+     * @var EntityManager
+     */
+    protected $entityManager;
+
+    public function __construct(
+        protected SearchParamsFetcher $searchParamsFetcher,
+        protected CreateParamsFetcher $createParamsFetcher,
+        protected ReadParamsFetcher $readParamsFetcher,
+        protected UpdateParamsFetcher $updateParamsFetcher,
+        protected DeleteParamsFetcher $deleteParamsFetcher,
+        RecordServiceContainer $recordServiceContainer,
+        protected FindParamsFetcher $findParamsFetcher,
+        Config $config,
+        User $user,
+        Acl $acl,
+        // Parameters below are for backward compatibility.
+        Container $container,
+        AclManager $aclManager,
+        Preferences $preferences,
+        Metadata $metadata,
+        ServiceFactory $serviceFactory
+    ) {
+        $this->recordServiceContainer = $recordServiceContainer;
+        $this->config = $config;
+        $this->user = $user;
+        $this->acl = $acl;
+
+        parent::__construct(
+            $container,
+            $user,
+            $acl,
+            $aclManager,
+            $config,
+            $preferences,
+            $metadata,
+            $serviceFactory
+        );
+    }
+
+    protected function getEntityType(): string
+    {
+        return $this->name;
+    }
+
+    /**
+     * @return RecordService<Entity>
+     */
+    protected function getRecordService(?string $entityType = null): RecordService
+    {
+        return $this->recordServiceContainer->get($entityType ?? $this->getEntityType());
+    }
+
+    /**
+     * Read a record.
+     *
+     * @throws NotFoundSilent
+     * @throws ForbiddenSilent
+     * @throws BadRequest
+     * @throws Forbidden
+     * @noinspection PhpUnusedParameterInspection
+     */
+    public function getActionRead(Request $request, Response $response): stdClass
+    {
+        if (method_exists($this, 'actionRead')) {
+            // For backward compatibility.
+            return (object) $this->actionRead($request->getRouteParams(), $request->getParsedBody(), $request);
+        }
+
+        $id = $request->getRouteParam('id');
+        $params = $this->readParamsFetcher->fetch($request);
+
+        if (!$id) {
+            throw new BadRequest("No ID.");
+        }
+
+        $entity = $this->getRecordService()->read($id, $params);
+
+        return $entity->getValueMap();
+    }
+
+    /**
+     * Create a record.
+     *
+     * @throws Forbidden
+     * @throws Conflict
+     * @throws BadRequest
+     */
+    public function postActionCreate(Request $request, Response $response): stdClass
+    {
+        if (method_exists($this, 'actionCreate')) {
+            // For backward compatibility.
+            return (object) $this->actionCreate($request->getRouteParams(), $request->getParsedBody(), $request);
+        }
+
+        $data = $request->getParsedBody();
+        $params = $this->createParamsFetcher->fetch($request);
+
+        $entity = $this->getRecordService()->create($data, $params);
+
+        return $entity->getValueMap();
+    }
+
+    /**
+     * @throws BadRequest
+     * @throws NotFound
+     * @throws Forbidden
+     * @throws Conflict
+     * @noinspection PhpUnused
+     */
+    public function patchActionUpdate(Request $request, Response $response): stdClass
+    {
+        return $this->putActionUpdate($request, $response);
+    }
+
+    /**
+     * Update a record.
+     *
+     * @throws BadRequest
+     * @throws NotFound
+     * @throws Forbidden
+     * @throws Conflict
+     * @noinspection PhpUnusedParameterInspection
+     */
+    public function putActionUpdate(Request $request, Response $response): stdClass
+    {
+        if (method_exists($this, 'actionUpdate')) {
+            // For backward compatibility.
+            return (object) $this->actionUpdate($request->getRouteParams(), $request->getParsedBody(), $request);
+        }
+
+        $id = $request->getRouteParam('id');
+        $data = $request->getParsedBody();
+
+        if (!$id) {
+            throw new BadRequest("No ID.");
+        }
+
+        $params = $this->updateParamsFetcher->fetch($request);
+
+        $context = new UpdateContext();
+
+        $params = $params->withContext($context);
+
+        $entity = $this->getRecordService()->update($id, $data, $params);
+
+        if ($context->linkUpdated) {
+            $response->setHeader('X-Record-Link-Updated', 'true');
+        }
+
+        return $entity->getValueMap();
+    }
+
+    /**
+     * List records.
+     *
+     * @throws Forbidden
+     * @throws BadRequest
+     * @throws Error
+     */
+    public function getActionList(Request $request, Response $response): stdClass
+    {
+        if (method_exists($this, 'actionList')) {
+            // For backward compatibility.
+            return (object) $this->actionList($request->getRouteParams(), $request->getParsedBody(), $request);
+        }
+
+        $searchParams = $this->fetchSearchParamsFromRequest($request);
+        $findParams = $this->findParamsFetcher->fetch($request);
+
+        $recordCollection = $this->getRecordService()->find($searchParams, $findParams);
+
+        return $recordCollection->toApiOutput();
+    }
+
+    /**
+     * Delete a record.
+     *
+     * @throws Forbidden
+     * @throws BadRequest
+     * @throws NotFound
+     * @throws Conflict
+     * @noinspection PhpUnusedParameterInspection
+     */
+    public function deleteActionDelete(Request $request, Response $response): bool
+    {
+        if (method_exists($this, 'actionDelete')) {
+            // For backward compatibility.
+            return $this->actionDelete($request->getRouteParams(), $request->getParsedBody(), $request);
+        }
+
+        $id = $request->getRouteParam('id');
+        $params = $this->deleteParamsFetcher->fetch($request);
+
+        if (!$id) {
+            throw new BadRequest("No ID.");
+        }
+
+        $this->getRecordService()->delete($id, $params);
+
+        return true;
+    }
+
+    /**
+     * @throws BadRequest
+     * @throws Forbidden
+     */
+    protected function fetchSearchParamsFromRequest(Request $request): SearchParams
+    {
+        return $this->searchParamsFetcher->fetch($request);
+    }
+
+    /**
+     * @throws BadRequest
+     * @throws Forbidden
+     * @throws NotFound
+     * @throws ForbiddenSilent
+     * @noinspection PhpUnused
+     */
+    public function postActionGetDuplicateAttributes(Request $request): stdClass
+    {
+        $id = $request->getParsedBody()->id ?? null;
+
+        if (!$id) {
+            throw new BadRequest();
+        }
+
+        return $this->getRecordService()->getDuplicateAttributes($id);
+    }
+
+    /**
+     * @throws BadRequest
+     * @throws Forbidden
+     * @throws NotFound
+     * @throws Conflict
+     * @noinspection PhpUnused
+     */
+    public function postActionRestoreDeleted(Request $request): bool
+    {
+        if (!$this->user->isAdmin()) {
+            throw new Forbidden();
+        }
+
+        $id = $request->getParsedBody()->id ?? null;
+
+        if (!$id) {
+            throw new BadRequest();
+        }
+
+        $this->getRecordService()->restoreDeleted($id);
+
+        return true;
+    }
+
+    /**
+     * @deprecated
+     * @return EntityManager
+     */
+    protected function getEntityManager()
+    {
+        return $this->entityManager;
+    }
+}