Initial commit

application/Espo/Tools/Stream/Api/DeleteNotePin.php

@@ -0,0 +1,114 @@
+<?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\Api;
+
+use Espo\Core\Acl;
+use Espo\Core\Api\Action;
+use Espo\Core\Api\Request;
+use Espo\Core\Api\Response;
+use Espo\Core\Api\ResponseComposer;
+use Espo\Core\Exceptions\BadRequest;
+use Espo\Core\Exceptions\Forbidden;
+use Espo\Core\Exceptions\NotFound;
+use Espo\Entities\Note;
+use Espo\ORM\EntityManager;
+
+/**
+ * @noinspection PhpUnused
+ */
+class DeleteNotePin implements Action
+{
+    public function __construct(
+        private EntityManager $entityManager,
+        private Acl $acl
+    ) {}
+
+    /**
+     * @inheritDoc
+     */
+    public function process(Request $request): Response
+    {
+        $id = $request->getRouteParam('id');
+
+        if (!$id) {
+            throw new BadRequest();
+        }
+
+        $note = $this->getNote($id);
+
+        $this->checkParent($note);
+
+        if ($note->isPinned()) {
+            $note->setIsPinned(false);
+            $this->entityManager->saveEntity($note);
+        }
+
+        return ResponseComposer::json(true);
+    }
+
+    /**
+     * @throws Forbidden
+     * @throws NotFound
+     */
+    private function getNote(string $id): Note
+    {
+        $note = $this->entityManager->getRDBRepositoryByClass(Note::class)->getById($id);
+
+        if (!$note) {
+            throw new NotFound();
+        }
+
+        if (!$this->acl->checkEntityRead($note)) {
+            throw new Forbidden("No read access.");
+        }
+
+        return $note;
+    }
+
+    /**
+     * @throws Forbidden
+     */
+    private function checkParent(Note $note): void
+    {
+        if (!$note->getParentType() || !$note->getParentId()) {
+            throw new Forbidden("No parent.");
+        }
+
+        $parent = $this->entityManager->getEntityById($note->getParentType(), $note->getParentId());
+
+        if (!$parent) {
+            throw new Forbidden("Parent not found.");
+        }
+
+        if (!$this->acl->checkEntityEdit($parent)) {
+            throw new Forbidden("No parent edit access.");
+        }
+    }
+}