Initial commit

application/Espo/Tools/App/Metadata/AclDependencyItem.php

@@ -0,0 +1,70 @@
+<?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\Tools\App\Metadata;
+
+class AclDependencyItem
+{
+    /**
+     * @param ?string[] $anyScopeList
+     */
+    public function __construct(
+        private string $target,
+        private ?string $scope,
+        private ?string $field,
+        private ?array $anyScopeList = null,
+    ) {}
+
+    /**
+     * A metadata path to be allowed if a user has access to a specific scope/field.
+     */
+    public function getTarget(): string
+    {
+        return $this->target;
+    }
+
+    public function getScope(): ?string
+    {
+        return $this->scope;
+    }
+
+    public function getField(): ?string
+    {
+        return $this->field;
+    }
+
+    /**
+     * @return ?string[]
+     * @since 9.2.5
+     */
+    public function getAnyScopeList(): ?array
+    {
+        return $this->anyScopeList;
+    }
+}

application/Espo/Tools/App/Metadata/AclDependencyProvider.php

@@ -0,0 +1,209 @@
+<?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\Tools\App\Metadata;
+
+use Espo\Core\ORM\Type\FieldType;
+use Espo\Core\Utils\Config;
+use Espo\Core\Utils\DataCache;
+use Espo\Core\Utils\Metadata;
+use Espo\ORM\Defs;
+
+class AclDependencyProvider
+{
+    private const CACHE_KEY = 'metadataAclDependency';
+
+    /** @var string[] */
+    private array $enumFieldTypeList = [
+        FieldType::ENUM,
+        FieldType::MULTI_ENUM,
+        FieldType::ARRAY,
+        FieldType::CHECKLIST,
+    ];
+
+    /** @var ?AclDependencyItem[] */
+    private ?array $data = null;
+    private bool $useCache;
+
+    public function __construct(
+        private DataCache $dataCache,
+        private Metadata $metadata,
+        private Defs $ormDefs,
+        Config\SystemConfig $systemConfig,
+    ) {
+        $this->useCache = $systemConfig->useCache();
+    }
+
+    /**
+     * @return AclDependencyItem[]
+     */
+    public function get(): array
+    {
+        if ($this->data === null) {
+            $this->data = $this->loadData();
+        }
+
+        return $this->data;
+    }
+
+    /**
+     * @return AclDependencyItem[]
+     */
+    private function loadData(): array
+    {
+        if ($this->useCache && $this->dataCache->has(self::CACHE_KEY)) {
+            /** @var array<string, mixed>[] $raw */
+            $raw = $this->dataCache->get(self::CACHE_KEY);
+
+            return $this->buildFromRaw($raw);
+        }
+
+        return $this->buildData();
+    }
+
+    /**
+     * @return AclDependencyItem[]
+     */
+    private function buildData(): array
+    {
+        $data = [];
+
+        foreach (($this->metadata->get(['app', 'metadata', 'aclDependencies']) ?? []) as $target => $item) {
+            $anyScopeList = $item['anyScopeList'] ?? null;
+            $scope = $item['scope'] ?? null;
+            $field = $item['field'] ?? null;
+
+            $data[] = [
+                'target' => $target,
+                'anyScopeList' => $anyScopeList,
+                'scope' => $scope,
+                'field' => $field,
+            ];
+        }
+
+        foreach ($this->ormDefs->getEntityList() as $entityDefs) {
+            if (!$this->metadata->get(['scopes', $entityDefs->getName(), 'object'])) {
+                continue;
+            }
+
+            foreach ($entityDefs->getFieldList() as $fieldDefs) {
+                $item = $this->getDataFromField($entityDefs->getName(), $fieldDefs);
+
+                if ($item) {
+                    $data[] = $item;
+                }
+            }
+        }
+
+        if ($this->useCache) {
+            $this->dataCache->store(self::CACHE_KEY, $data);
+        }
+
+        return $this->buildFromRaw($data);
+    }
+
+    /**
+     * @return ?array<string, mixed>
+     */
+    private function getDataFromField(string $entityType, Defs\FieldDefs $fieldDefs): ?array
+    {
+        if ($fieldDefs->getType() === FieldType::FOREIGN) {
+            $refEntityType = $fieldDefs->getParam('link') ?
+                $this->ormDefs
+                    ->getEntity($entityType)
+                    ->tryGetRelation($fieldDefs->getParam('link'))
+                    ?->tryGetForeignEntityType() :
+                    null;
+
+            $refField = $fieldDefs->getParam('field');
+
+            if (!$refEntityType || !$refField) {
+                return null;
+            }
+
+            return [
+                'target' => "entityDefs.$refEntityType.fields.$refField",
+                'scope' => $entityType,
+                'field' => $fieldDefs->getName(),
+            ];
+        }
+
+        if (!in_array($fieldDefs->getType(), $this->enumFieldTypeList)) {
+            return null;
+        }
+
+        $optionsPath = $fieldDefs->getParam('optionsPath');
+        $optionsReference = $fieldDefs->getParam('optionsReference');
+
+        if (
+            !$optionsPath &&
+            $optionsReference &&
+            str_contains($optionsReference, '.')
+        ) {
+            [$refEntityType, $refField] = explode('.', $optionsReference);
+
+            $optionsPath = "entityDefs.$refEntityType.fields.$refField.options";
+        }
+
+        if (!$optionsPath) {
+            return null;
+        }
+
+        return [
+            'target' => $optionsPath,
+            'scope' => $entityType,
+            'field' => $fieldDefs->getName(),
+        ];
+    }
+
+    /**
+     * @param array<string, mixed>[] $raw
+     * @return AclDependencyItem[]
+     */
+    private function buildFromRaw(array $raw): array
+    {
+        $list = [];
+
+        foreach ($raw as $rawItem) {
+            $target = $rawItem['target'] ?? null;
+            $scope = $rawItem['scope'] ?? null;
+            $field = $rawItem['field'] ?? null;
+            $anyScopeList = $rawItem['anyScopeList'] ?? null;
+
+            $list[] = new AclDependencyItem(
+                target: $target,
+                scope: $scope,
+                field: $field,
+                anyScopeList: $anyScopeList,
+            );
+        }
+
+        return $list;
+    }
+}