Initial commit

application/Espo/Tools/Stream/RecordService/Helper.php

@@ -0,0 +1,202 @@
+<?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\Stream\RecordService;
+
+use Espo\Core\Acl\Exceptions\NotAvailable;
+use Espo\Core\Acl\Exceptions\NotImplemented as AclNotImplemented;
+use Espo\Core\Acl\Table;
+use Espo\Core\AclManager;
+use Espo\Core\Utils\Acl\UserAclManagerProvider;
+use Espo\Core\Utils\Metadata;
+use Espo\Entities\User;
+
+class Helper
+{
+    public function __construct(
+        private Metadata $metadata,
+        private AclManager $aclManager,
+        private UserAclManagerProvider $userAclManagerProvider
+    ) {}
+
+    /**
+     * @return string[]
+     */
+    public function getOnlyTeamEntityTypeList(User $user): array
+    {
+        if ($user->isPortal()) {
+            return [];
+        }
+
+        $list = [];
+
+        $scopes = $this->metadata->get('scopes', []);
+
+        foreach ($scopes as $scope => $item) {
+            if ($scope === User::ENTITY_TYPE) {
+                continue;
+            }
+
+            if (empty($item['entity'])) {
+                continue;
+            }
+
+            if (empty($item['object'])) {
+                continue;
+            }
+
+            if (
+                $this->aclManager->checkReadOnlyTeam($user, $scope)
+            ) {
+                $list[] = $scope;
+            }
+        }
+
+        return $list;
+    }
+
+    /**
+     * @return string[]
+     */
+    public function getOnlyOwnEntityTypeList(User $user): array
+    {
+        if ($user->isPortal()) {
+            return [];
+        }
+
+        $list = [];
+
+        $scopes = $this->metadata->get('scopes', []);
+
+        foreach ($scopes as $scope => $item) {
+            if ($scope === User::ENTITY_TYPE) {
+                continue;
+            }
+
+            if (empty($item['entity'])) {
+                continue;
+            }
+
+            if (empty($item['object'])) {
+                continue;
+            }
+
+            if ($this->aclManager->checkReadOnlyOwn($user, $scope)) {
+                $list[] = $scope;
+            }
+        }
+
+        return $list;
+    }
+
+    /**
+     * @return string[]
+     */
+    public function getIgnoreScopeList(User $user, bool $forParent = false): array
+    {
+        $ignoreScopeList = [];
+
+        $scopes = $this->metadata->get('scopes', []);
+
+        $aclManager = $this->getUserAclManager($user);
+
+        foreach ($scopes as $scope => $item) {
+            if (empty($item['entity'])) {
+                continue;
+            }
+
+            if (empty($item['object'])) {
+                continue;
+            }
+
+            try {
+                $hasAccess =
+                    $aclManager &&
+                    $aclManager->checkScope($user, $scope, Table::ACTION_READ) &&
+                    (!$forParent || $aclManager->checkScope($user, $scope, Table::ACTION_STREAM));
+            } catch (AclNotImplemented) {
+                $hasAccess = false;
+            }
+
+            if (!$hasAccess) {
+                $ignoreScopeList[] = $scope;
+            }
+        }
+
+        return $ignoreScopeList;
+    }
+
+    private function getUserAclManager(User $user): ?AclManager
+    {
+        try {
+            return $this->userAclManagerProvider->get($user);
+        } catch (NotAvailable) {
+            return null;
+        }
+    }
+
+    /**
+     * @return string[]
+     */
+    public function getNotAllEntityTypeList(User $user): array
+    {
+        if (!$user->isPortal()) {
+            return [];
+        }
+
+        $aclManager = $this->getUserAclManager($user);
+
+        $list = [];
+
+        $scopes = $this->metadata->get('scopes', []);
+
+        foreach ($scopes as $scope => $item) {
+            if ($scope === User::ENTITY_TYPE) {
+                continue;
+            }
+
+            if (empty($item['entity'])) {
+                continue;
+            }
+
+            if (empty($item['object'])) {
+                continue;
+            }
+
+            if (
+                !$aclManager ||
+                $aclManager->getLevel($user, $scope, Table::ACTION_READ) !== Table::LEVEL_ALL
+            ) {
+                $list[] = $scope;
+            }
+        }
+
+        return $list;
+    }
+}