Skip to content

EspoCRM – Open Source CRM Application

2.5 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\Tools\OAuthServer\Scope;

use Espo\Core\Acl\Scope;
use Espo\Core\Utils\Metadata;

/**
 * @since 10.1.0
 */
class ScopesProvider
{
    /**
     * @var string[]
     */
    private array $commonScopes = [
        Scope::ADMIN,
        Scope::GLOBAL,
    ];

    public function __construct(
        private Metadata $metadata,
    ) {}

    /**
     * @return string[]
     */
    public function get(): array
    {
        return [
            ...$this->commonScopes,
            ...$this->getAclScopes(),
        ];
    }

    /**
     * @return string[]
     */
    private function getAclScopes(): array
    {
        /**
         * @var array<string, array{
         *     disabled?: bool,
         *     acl?: mixed,
         * }> $scopesDefs
         */
        $scopesDefs = $this->metadata->get("scopes", []);

        $list = [];

        foreach ($scopesDefs as $scope => $defs) {
            if (
                ($defs['disabled'] ?? false) ||
                !($defs['acl'] ?? false) ||
                in_array($scope, $this->commonScopes)
            ) {
                continue;
            }

            $list[] = $scope;
        }

        sort($list);

        return $list;
    }
}