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;
+    }
+}

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

@@ -0,0 +1,139 @@
+<?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\Name\Field;
+use Espo\Core\ORM\Type\FieldType;
+use Espo\Core\Utils\FieldUtil;
+use Espo\Entities\Note;
+use Espo\ORM\EntityManager;
+use Espo\ORM\Name\Attribute;
+use stdClass;
+
+class NoteHelper
+{
+    public function __construct(
+        private EntityManager $entityManager,
+        private FieldUtil $fieldUtil
+    ) {}
+
+    public function prepare(Note $note): void
+    {
+        if ($note->getType() === Note::TYPE_UPDATE) {
+            $this->prepareNoteUpdate($note);
+        }
+    }
+
+    private function prepareNoteUpdate(Note $note): void
+    {
+        $data = $note->getData();
+
+        /** @var ?string[] $fieldList */
+        $fieldList = $data->fields ?? null;
+        $attributes = $data->attributes ?? null;
+
+        if (!$attributes instanceof stdClass) {
+            return;
+        }
+
+        $was = $attributes->was ?? null;
+
+        if (!$was instanceof stdClass) {
+            return;
+        }
+
+        if (!is_array($fieldList)) {
+            return;
+        }
+
+        foreach ($fieldList as $field) {
+            if ($this->loadNoteUpdateWasForField($note, $field, $was)) {
+                $note->setData($data);
+            }
+        }
+    }
+
+    private function loadNoteUpdateWasForField(Note $note, string $field, stdClass $was): bool
+    {
+        if (!$note->getParentType() || !$note->getParentId()) {
+            return false;
+        }
+
+        $type = $this->fieldUtil->getFieldType($note->getParentType(), $field);
+
+        if ($type === FieldType::LINK_MULTIPLE) {
+            $this->loadNoteUpdateWasForFieldLinkMultiple($note, $field, $was);
+
+            return true;
+        }
+
+        return false;
+    }
+
+    private function loadNoteUpdateWasForFieldLinkMultiple(Note $note, string $field, stdClass $was): void
+    {
+        /** @var ?string[] $ids */
+        $ids = $was->{$field . 'Ids'} ?? null;
+
+        $names = (object) [];
+
+        if (!is_array($ids)) {
+            return;
+        }
+
+        $entityType = $note->getParentType();
+
+        if (!$entityType) {
+            return;
+        }
+
+        $foreignEntityType = $this->entityManager
+            ->getDefs()
+            ->getEntity($entityType)
+            ->tryGetRelation($field)
+            ?->tryGetForeignEntityType();
+
+        if (!$foreignEntityType) {
+            return;
+        }
+
+        $collection = $this->entityManager
+            ->getRDBRepository($foreignEntityType)
+            ->select([Attribute::ID, Field::NAME])
+            ->where([Attribute::ID => $ids])
+            ->find();
+
+        foreach ($collection as $entity) {
+            $names->{$entity->getId()} = $entity->get(Field::NAME);
+        }
+
+        $was->{$field . 'Names'} = $names;
+    }
+}

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

@@ -0,0 +1,237 @@
+<?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\Permission;
+use Espo\Core\Acl\Table;
+use Espo\Core\AclManager;
+use Espo\Core\Exceptions\BadRequest;
+use Espo\Core\Exceptions\Forbidden;
+use Espo\Core\Name\Field;
+use Espo\Core\Select\SearchParams;
+use Espo\Core\Select\SelectBuilderFactory;
+use Espo\Entities\Note;
+use Espo\Entities\User;
+use Espo\ORM\EntityManager;
+use Espo\ORM\Query\Part\Condition as Cond;
+use Espo\ORM\Query\Part\Expression as Expr;
+use Espo\ORM\Query\Select;
+use Espo\ORM\Query\SelectBuilder;
+
+class QueryHelper
+{
+    public function __construct(
+        private EntityManager $entityManager,
+        private SelectBuilderFactory $selectBuilderFactory,
+        private AclManager $aclManager
+    ) {}
+
+    /**
+     * @throws BadRequest
+     * @throws Forbidden
+     */
+    public function buildBaseQueryBuilder(SearchParams $searchParams): SelectBuilder
+    {
+        $builder = $this->entityManager
+            ->getQueryBuilder()
+            ->select()
+            ->from(Note::ENTITY_TYPE);
+
+        if (
+            $searchParams->getWhere() ||
+            $searchParams->getTextFilter() ||
+            $searchParams->getPrimaryFilter() ||
+            $searchParams->getBoolFilterList() !== []
+        ) {
+            $builder = $this->selectBuilderFactory
+                ->create()
+                ->from(Note::ENTITY_TYPE)
+                ->withComplexExpressionsForbidden()
+                ->withWherePermissionCheck()
+                ->withSearchParams(
+                    $searchParams
+                        ->withOffset(null)
+                        ->withMaxSize(null)
+                )
+                ->buildQueryBuilder()
+                ->order([]);
+        }
+
+        return $builder;
+    }
+
+    /**
+     * @return string[]
+     */
+    public function getUserQuerySelect(): array
+    {
+        return [
+            'id',
+            'number',
+            'type',
+            'post',
+            'data',
+            'parentType',
+            'parentId',
+            'relatedType',
+            'relatedId',
+            'targetType',
+            Field::CREATED_AT,
+            'createdById',
+            'createdByName',
+            'isGlobal',
+            'isInternal',
+            'createdByGender',
+        ];
+    }
+
+    public function buildPostedToUserQuery(User $user, SelectBuilder $baseBuilder): Select
+    {
+        return (clone $baseBuilder)
+            ->where([
+                'type' => Note::TYPE_POST,
+                'targetType' => Note::TARGET_USERS,
+                'parentId' => null,
+                'createdById!=' => $user->getId(),
+                'isGlobal' => false,
+            ])
+            ->where(
+                Cond::in(
+                    Expr::column('id'),
+                    SelectBuilder::create()
+                        ->select('noteId')
+                        ->from('NoteUser')
+                        ->where(['userId' => $user->getId()])
+                        ->build()
+                )
+            )
+            ->build();
+    }
+
+    public function buildPostedToPortalQuery(User $user, SelectBuilder $baseBuilder): ?Select
+    {
+        if (!$user->isPortal()) {
+            if ($this->aclManager->getPermissionLevel($user, Permission::PORTAL) !== Table::LEVEL_YES) {
+                return null;
+            }
+
+            return (clone $baseBuilder)
+                ->where([
+                    'parentId' => null,
+                    'type' => Note::TYPE_POST,
+                    'targetType' => Note::TARGET_PORTALS,
+                    'createdById!=' => $user->getId(),
+                    'isGlobal' => false,
+                ])
+                ->build();
+        }
+
+        $portalIdList = $user->getPortals()->getIdList();
+
+        if ($portalIdList === []) {
+            return null;
+        }
+
+        return (clone $baseBuilder)
+            ->where([
+                'parentId' => null,
+                'type' => Note::TYPE_POST,
+                'targetType' => Note::TARGET_PORTALS,
+                'createdById!=' => $user->getId(),
+                'isGlobal' => false,
+            ])
+            ->where(
+                Cond::in(
+                    Expr::column('id'),
+                    SelectBuilder::create()
+                        ->select('noteId')
+                        ->from('NotePortal')
+                        ->where(['portalId' => $portalIdList])
+                        ->build()
+                )
+            )
+            ->build();
+    }
+
+    public function buildPostedToTeamsQuery(User $user, SelectBuilder $baseBuilder): ?Select
+    {
+        if ($user->getTeamIdList() === []) {
+            return null;
+        }
+
+        return (clone $baseBuilder)
+            ->where([
+                'parentId' => null,
+                'type' => Note::TYPE_POST,
+                'targetType' => Note::TARGET_TEAMS,
+                'createdById!=' => $user->getId(),
+                'isGlobal' => false,
+            ])
+            ->where(
+                Cond::in(
+                    Expr::column('id'),
+                    SelectBuilder::create()
+                        ->select('noteId')
+                        ->from('NoteTeam')
+                        ->where(['teamId' => $user->getTeamIdList()])
+                        ->build()
+                )
+            )
+            ->build();
+    }
+
+    public function buildPostedByUserQuery(User $user, SelectBuilder $baseBuilder): Select
+    {
+        return (clone $baseBuilder)
+            ->where([
+                'parentId' => null,
+                'type' => Note::TYPE_POST,
+                'createdById' => $user->getId(),
+            ])
+            ->build();
+    }
+
+    public function buildPostedToGlobalQuery(User $user, SelectBuilder $baseBuilder): ?Select
+    {
+        if ($user->isPortal() || $user->isApi()) {
+            return null;
+        }
+
+        return (clone $baseBuilder)
+            ->where([
+                'type' => Note::TYPE_POST,
+                'targetType' => Note::TARGET_ALL,
+                'parentId' => null,
+                'createdById!=' => $user->getId(),
+                'isGlobal' => true,
+            ])
+            ->build();
+    }
+}