Skip to content

EspoCRM – Open Source CRM Application

4.9 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\Controllers;

use Espo\Core\Exceptions\Error;
use Espo\Core\Exceptions\Forbidden;
use Espo\Core\Exceptions\BadRequest;
use Espo\Core\Api\Request;
use Espo\Core\Api\Response;
use Espo\Core\Controllers\RecordBase;
use Espo\Core\Upgrades\ExtensionManager;

use stdClass;

class Extension extends RecordBase
{
    protected function checkAccess(): bool
    {
        return $this->user->isEffectiveAdmin();
    }

    /**
     * @throws BadRequest
     * @throws Forbidden
     * @throws Error
     */
    public function postActionUpload(Request $request): stdClass
    {
        $this->assertUploadAllowed();

        $body = $request->getBodyContents();

        if ($body === null) {
            throw new BadRequest();
        }

        $manager = $this->createManager();

        $id = $manager->upload($body);

        $manifest = $manager->getManifest();

        return (object) [
            'id' => $id,
            'version' => $manifest['version'],
            'name' => $manifest['name'],
            'description' => $manifest['description'],
        ];
    }

    /**
     * @throws Forbidden
     * @throws Error
     */
    public function postActionInstall(Request $request): bool
    {
        $this->assertInstallAllowed();

        $data = $request->getParsedBody();

        $manager = $this->createManager();

        $manager->install(get_object_vars($data));

        return true;
    }

    /**
     * @throws Forbidden
     * @throws Error
     */
    public function postActionUninstall(Request $request): bool
    {
        $this->assertInstallAllowed();

        $data = $request->getParsedBody();

        $manager = $this->createManager();

        $manager->uninstall(get_object_vars($data));

        return true;
    }

    /**
     * @throws Forbidden
     * @throws Error
     */
    public function deleteActionDelete(Request $request, Response $response): bool
    {
        $params = $request->getRouteParams();

        $this->assertUploadAllowed();

        $manager = $this->createManager();

        $manager->delete($params);

        return true;
    }

    public function postActionCreate(Request $request, Response $response): stdClass
    {
        throw new Forbidden();
    }

    public function putActionUpdate(Request $request, Response $response): stdClass
    {
        throw new Forbidden();
    }

    private function createManager(): ExtensionManager
    {
        return $this->injectableFactory->create(ExtensionManager::class);
    }

    /**
     * @throws Forbidden
     */
    private function assertInstallAllowed(): void
    {
        if ($this->config->get('restrictedMode')) {
            throw new Forbidden("Not allowed in restricted mode.");
        }

        if ($this->config->get('adminExtensionManage') !== true) {
            throw new Forbidden("Cannot manage extensions as `adminExtensionManage` is not enabled.");
        }
    }

    /**
     * @throws Forbidden
     */
    private function assertUploadAllowed(): void
    {
        if ($this->config->get('restrictedMode')) {
            throw new Forbidden("Not allowed in restricted mode.");
        }

        if ($this->config->get('adminExtensionUpload') !== true) {
            throw new Forbidden("Cannot upload extensions as `adminExtensionUpload` is not enabled.");
        }

        if ($this->config->get('adminExtensionManage') !== true) {
            throw new Forbidden("Cannot manage extensions as `adminExtensionManage` is not enabled.");
        }

        if ($this->config->get('adminUpgradeDisabled')) {
            throw new Forbidden("Disabled with `adminUpgradeDisabled` parameter.");
        }
    }
}