Initial commit

application/Espo/Tools/Stream/MyReactionsService.php

@@ -0,0 +1,155 @@
+<?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;
+
+use Espo\Core\Exceptions\Forbidden;
+use Espo\Core\Utils\Config;
+use Espo\Core\WebSocket\Submission as WebSocketSubmission;
+use Espo\Entities\Note;
+use Espo\Entities\User;
+use Espo\Entities\UserReaction;
+use Espo\ORM\EntityManager;
+use Espo\ORM\Query\DeleteBuilder;
+use Espo\Tools\UserReaction\NotificationService;
+
+class MyReactionsService
+{
+    public function __construct(
+        private Config $config,
+        private EntityManager $entityManager,
+        private User $user,
+        private WebSocketSubmission $webSocketSubmission,
+        private NotificationService $notificationService,
+    ) {}
+
+    /**
+     * @throws Forbidden
+     */
+    public function react(Note $note, string $type): void
+    {
+        if (!$this->isReactionAllowed($type)) {
+            throw new Forbidden("Not allowed reaction '$type'.");
+        }
+
+        if ($note->getType() !== Note::TYPE_POST) {
+            throw new Forbidden("Cannot react on non-post note.");
+        }
+
+        $this->entityManager->getTransactionManager()->run(function () use ($type, $note) {
+            $repository = $this->entityManager->getRDBRepositoryByClass(UserReaction::class);
+
+            $found = $repository
+                ->forUpdate()
+                ->where([
+                    'userId' => $this->user->getId(),
+                    'parentType' => Note::ENTITY_TYPE,
+                    'parentId' => $note->getId(),
+                    'type' => $type,
+                ])
+                ->findOne();
+
+            if ($found) {
+                return;
+            }
+
+            $this->deleteAll($note);
+            $this->notificationService->removeNoteUnread($note, $this->user);
+
+            $reaction = $repository->getNew();
+
+            $reaction
+                ->setParent($note)
+                ->setUser($this->user)
+                ->setType($type);
+
+            $this->entityManager->saveEntity($reaction);
+        });
+
+        $this->webSocketSubmit($note);
+        $this->notificationService->notifyNote($note, $type);
+    }
+
+    public function unReact(Note $note, string $type): void
+    {
+        $repository = $this->entityManager->getRDBRepositoryByClass(UserReaction::class);
+
+        $reaction = $repository
+            ->where([
+                'userId' => $this->user->getId(),
+                'parentType' => $note->getEntityType(),
+                'parentId' => $note->getId(),
+                'type' => $type,
+            ])
+            ->findOne();
+
+        if (!$reaction) {
+            return;
+        }
+
+        $this->notificationService->removeNoteUnread($note, $this->user, $type);
+
+        $this->entityManager->removeEntity($reaction);
+
+        $this->webSocketSubmit($note);
+    }
+
+    private function isReactionAllowed(string $type): bool
+    {
+        /** @var string[] $allowedReactions */
+        $allowedReactions = $this->config->get('availableReactions') ?? [];
+
+        return in_array($type, $allowedReactions);
+    }
+
+    private function deleteAll(Note $note): void
+    {
+        $deleteQuery = DeleteBuilder::create()
+            ->from(UserReaction::ENTITY_TYPE)
+            ->where([
+                'userId' => $this->user->getId(),
+                'parentType' => Note::ENTITY_TYPE,
+                'parentId' => $note->getId(),
+            ])
+            ->build();
+
+        $this->entityManager->getQueryExecutor()->execute($deleteQuery);
+    }
+
+    private function webSocketSubmit(Note $note): void
+    {
+        $topic = "streamUpdate.{$note->getParentType()}.{$note->getParentId()}";
+
+        $this->webSocketSubmission->submit($topic, null, ['noteId' => $note->getId()]);
+
+        $topicUpdate = "recordUpdate.Note.{$note->getId()}";
+
+        $this->webSocketSubmission->submit($topicUpdate);
+    }
+}