Initial commit

application/Espo/Core/Acl/AccessChecker/AccessCheckerFactory.php

@@ -0,0 +1,103 @@
+<?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\Acl\AccessChecker;
+
+use Espo\Core\Acl\AccessChecker;
+use Espo\Core\Acl\DefaultAccessChecker;
+use Espo\Core\Acl\Exceptions\NotImplemented;
+use Espo\Core\AclManager;
+use Espo\Core\Binding\Binder;
+use Espo\Core\Binding\BindingContainer;
+use Espo\Core\Binding\BindingData;
+use Espo\Core\InjectableFactory;
+use Espo\Core\Utils\Metadata;
+
+class AccessCheckerFactory
+{
+    /** @var class-string<AccessChecker> */
+    private string $defaultClassName = DefaultAccessChecker::class;
+
+    public function __construct(
+        private Metadata $metadata,
+        private InjectableFactory $injectableFactory
+    ) {}
+
+    /**
+     * Create an access checker.
+     *
+     * @throws NotImplemented
+     */
+    public function create(string $scope, AclManager $aclManager): AccessChecker
+    {
+        $className = $this->getClassName($scope);
+
+        $bindingContainer = $this->createBindingContainer($className, $aclManager, $scope);
+
+        return $this->injectableFactory->createWithBinding($className, $bindingContainer);
+    }
+
+    /**
+     * @return class-string<AccessChecker>
+     * @throws NotImplemented
+     */
+    private function getClassName(string $scope): string
+    {
+        /** @var ?class-string<AccessChecker> $className1 */
+        $className1 = $this->metadata->get(['aclDefs', $scope, 'accessCheckerClassName']);
+
+        if ($className1) {
+            return $className1;
+        }
+
+        if (!$this->metadata->get(['scopes', $scope])) {
+            throw new NotImplemented("Access checker is not implemented for '$scope'.");
+        }
+
+        return $this->defaultClassName;
+    }
+
+    /**
+     * @param class-string<AccessChecker> $className
+     */
+    private function createBindingContainer(string $className, AclManager $aclManager, string $scope): BindingContainer
+    {
+        $bindingData = new BindingData();
+
+        $binder = new Binder($bindingData);
+
+        $binder->bindInstance(AclManager::class, $aclManager);
+
+        $binder
+            ->for($className)
+            ->bindValue('$entityType', $scope);
+
+        return new BindingContainer($bindingData);
+    }
+}

application/Espo/Core/Acl/AccessChecker/AccessCheckers/Foreign.php

@@ -0,0 +1,168 @@
+<?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\Acl\AccessChecker\AccessCheckers;
+
+use Espo\Entities\User;
+use Espo\ORM\Entity;
+use Espo\Core\Utils\Metadata;
+use Espo\Core\Acl\DefaultAccessChecker;
+use Espo\Core\Acl\Traits\DefaultAccessCheckerDependency;
+use Espo\Core\Acl\AccessEntityCreateChecker;
+use Espo\Core\Acl\AccessEntityReadChecker;
+use Espo\Core\Acl\AccessEntityEditChecker;
+use Espo\Core\Acl\AccessEntityDeleteChecker;
+use Espo\Core\Acl\AccessEntityStreamChecker;
+use Espo\Core\Acl\ScopeData;
+
+use Espo\ORM\EntityManager;
+
+use LogicException;
+
+/**
+ * Access is determined by access to a foreign entity.
+ *
+ * @implements AccessEntityCreateChecker<Entity>
+ * @implements AccessEntityReadChecker<Entity>
+ * @implements AccessEntityEditChecker<Entity>
+ * @implements AccessEntityDeleteChecker<Entity>
+ * @implements AccessEntityStreamChecker<Entity>
+ */
+class Foreign implements
+
+    AccessEntityCreateChecker,
+    AccessEntityReadChecker,
+    AccessEntityEditChecker,
+    AccessEntityDeleteChecker,
+    AccessEntityStreamChecker
+{
+    use DefaultAccessCheckerDependency;
+
+    public function __construct(
+        private Metadata $metadata,
+        DefaultAccessChecker $defaultAccessChecker,
+        private EntityManager $entityManager
+    ) {
+        $this->defaultAccessChecker = $defaultAccessChecker;
+    }
+
+    private function getForeignEntity(Entity $entity): ?Entity
+    {
+        $entityType = $entity->getEntityType();
+
+        $link = $this->metadata->get(['aclDefs', $entityType, 'link']);
+
+        if (!$link) {
+            throw new LogicException("No `link` in aclDefs for {$entityType}.");
+        }
+
+        if ($entity->isNew()) {
+            $foreignEntityType = $this->entityManager
+                ->getDefs()
+                ->getEntity($entityType)
+                ->getRelation($link)
+                ->getForeignEntityType();
+
+            /** @var ?string $id */
+            $id = $entity->get($link . 'Id');
+
+            if (!$id) {
+                return null;
+            }
+
+            return $this->entityManager->getEntityById($foreignEntityType, $id);
+        }
+
+        return $this->entityManager
+            ->getRDBRepository($entityType)
+            ->getRelation($entity, $link)
+            ->findOne();
+    }
+
+    public function checkEntityCreate(User $user, Entity $entity, ScopeData $data): bool
+    {
+        $foreign = $this->getForeignEntity($entity);
+
+        if (!$foreign) {
+            return false;
+        }
+
+        // @todo Check parent 'edit' access.
+
+        return $this->defaultAccessChecker->checkEntityCreate($user, $foreign, $data);
+    }
+
+    public function checkEntityRead(User $user, Entity $entity, ScopeData $data): bool
+    {
+        $foreign = $this->getForeignEntity($entity);
+
+        if (!$foreign) {
+            return false;
+        }
+
+        return $this->defaultAccessChecker->checkEntityRead($user, $foreign, $data);
+    }
+
+    public function checkEntityEdit(User $user, Entity $entity, ScopeData $data): bool
+    {
+        $foreign = $this->getForeignEntity($entity);
+
+        if (!$foreign) {
+            return false;
+        }
+
+        return $this->defaultAccessChecker->checkEntityEdit($user, $foreign, $data);
+    }
+
+    public function checkEntityDelete(User $user, Entity $entity, ScopeData $data): bool
+    {
+        $foreign = $this->getForeignEntity($entity);
+
+        if (!$foreign) {
+            if ($user->isAdmin()) {
+                return true;
+            }
+
+            return false;
+        }
+
+        return $this->defaultAccessChecker->checkEntityDelete($user, $foreign, $data);
+    }
+
+    public function checkEntityStream(User $user, Entity $entity, ScopeData $data): bool
+    {
+        $foreign = $this->getForeignEntity($entity);
+
+        if (!$foreign) {
+            return false;
+        }
+
+        return $this->defaultAccessChecker->checkEntityStream($user, $foreign, $data);
+    }
+}

application/Espo/Core/Acl/AccessChecker/ScopeChecker.php

@@ -0,0 +1,91 @@
+<?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\Acl\AccessChecker;
+
+use Espo\Core\Acl\ScopeData;
+use Espo\Core\Acl\Table;
+
+/**
+ * Checks scope access.
+ */
+class ScopeChecker
+{
+    public function __construct()
+    {}
+
+    public function check(ScopeData $data, ?string $action = null, ?ScopeCheckerData $checkerData = null): bool
+    {
+        if ($data->isFalse()) {
+            return false;
+        }
+
+        if ($data->isTrue()) {
+            return true;
+        }
+
+        if ($action === null) {
+            return true;
+        }
+
+        $level = $data->get($action);
+
+        if ($level === Table::LEVEL_ALL || $level === Table::LEVEL_YES) {
+            return true;
+        }
+
+        if ($level === Table::LEVEL_NO) {
+            return false;
+        }
+
+        if (!$checkerData) {
+            return false;
+        }
+
+        if ($level === Table::LEVEL_OWN || $level === Table::LEVEL_TEAM) {
+            if ($checkerData->isOwn()) {
+                return true;
+            }
+        }
+
+        if ($level === Table::LEVEL_OWN || $level === Table::LEVEL_TEAM) {
+            if ($checkerData->isShared()) {
+                return true;
+            }
+        }
+
+        if ($level === Table::LEVEL_TEAM) {
+            if ($checkerData->inTeam()) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+}

application/Espo/Core/Acl/AccessChecker/ScopeCheckerData.php

@@ -0,0 +1,64 @@
+<?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\Acl\AccessChecker;
+
+use Closure;
+
+/**
+ * Scope checker data.
+ */
+class ScopeCheckerData
+{
+    public function __construct(
+        private Closure $isOwnChecker,
+        private Closure $inTeamChecker,
+        private Closure $isSharedChecker,
+    ) {}
+
+    public function isOwn(): bool
+    {
+        return ($this->isOwnChecker)();
+    }
+
+    public function inTeam(): bool
+    {
+        return ($this->inTeamChecker)();
+    }
+
+    public function isShared(): bool
+    {
+        return ($this->isSharedChecker)();
+    }
+
+    public static function createBuilder(): ScopeCheckerDataBuilder
+    {
+        return new ScopeCheckerDataBuilder();
+    }
+}

application/Espo/Core/Acl/AccessChecker/ScopeCheckerDataBuilder.php

@@ -0,0 +1,131 @@
+<?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\Acl\AccessChecker;
+
+use Closure;
+
+/**
+ * Builds scope checker data.
+ */
+class ScopeCheckerDataBuilder
+{
+    private Closure $isOwnChecker;
+    private Closure $inTeamChecker;
+    private Closure $isSharedChecker;
+
+    public function __construct()
+    {
+        $this->isOwnChecker = fn(): bool => false;
+        $this->inTeamChecker = fn(): bool => false;
+        $this->isSharedChecker = fn(): bool => false;
+    }
+
+    public function setIsOwn(bool $value): self
+    {
+        if ($value) {
+            $this->isOwnChecker = function (): bool {
+                return true;
+            };
+
+            return $this;
+        }
+
+        $this->isOwnChecker = function (): bool {
+            return false;
+        };
+
+        return $this;
+    }
+
+    public function setInTeam(bool $value): self
+    {
+        if ($value) {
+            $this->inTeamChecker = function (): bool {
+                return true;
+            };
+
+            return $this;
+        }
+
+        $this->inTeamChecker = function (): bool {
+            return false;
+        };
+
+        return $this;
+    }
+
+    public function setIsShared(bool $value): self
+    {
+        if ($value) {
+            $this->isSharedChecker = fn(): bool => true;
+
+            return $this;
+        }
+
+        $this->isSharedChecker = fn(): bool => false;
+
+        return $this;
+    }
+
+    /**
+     * @param Closure(): bool $checker
+     */
+    public function setIsOwnChecker(Closure $checker): self
+    {
+        $this->isOwnChecker = $checker;
+
+        return $this;
+    }
+
+    /**
+     * @param Closure(): bool $checker
+     */
+    public function setInTeamChecker(Closure $checker): self
+    {
+        $this->inTeamChecker = $checker;
+
+        return $this;
+    }
+
+    /**
+     * @param Closure(): bool $checker
+     */
+    public function setIsSharedChecker(Closure $checker): self
+    {
+        $this->isSharedChecker = $checker;
+
+        return $this;
+    }
+
+    public function build(): ScopeCheckerData
+    {
+        return new ScopeCheckerData($this->isOwnChecker, $this->inTeamChecker, $this->isSharedChecker);
+    }
+}