Initial commit

application/Espo/Modules/Crm/Tools/Meeting/Service.php

@@ -0,0 +1,268 @@
+<?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\Modules\Crm\Tools\Meeting;
+
+use Espo\Core\Acl;
+use Espo\Core\Exceptions\BadRequest;
+use Espo\Core\Exceptions\Forbidden;
+use Espo\Core\Exceptions\NotFound;
+use Espo\Core\HookManager;
+use Espo\Core\Name\Field;
+use Espo\Core\ORM\Entity as CoreEntity;
+use Espo\Core\Record\Collection as RecordCollection;
+use Espo\Core\Utils\Metadata;
+use Espo\Entities\Note;
+use Espo\Entities\User;
+use Espo\Modules\Crm\Entities\Call;
+use Espo\Modules\Crm\Entities\Meeting;
+use Espo\ORM\Collection;
+use Espo\ORM\Entity;
+use Espo\ORM\EntityManager;
+use Espo\ORM\Name\Attribute;
+use LogicException;
+
+class Service
+{
+    private const NOTE_TYPE_EVENT_CONFIRMATION = 'EventConfirmation';
+
+    public function __construct(
+        private User $user,
+        private EntityManager $entityManager,
+        private HookManager $hookManager,
+        private Acl $acl,
+        private Metadata $metadata
+    ) {}
+
+    /**
+     * Set an acceptance for a current user.
+     *
+     * @throws BadRequest
+     * @throws NotFound
+     * @throws Forbidden
+     */
+    public function setAcceptance(string $entityType, string $id, string $status): void
+    {
+        /** @var string[] $statusList */
+        $statusList = $this->entityManager
+            ->getDefs()
+            ->getEntity($entityType)
+            ->getField('acceptanceStatus')
+            ->getParam('options') ?? [];
+
+        if (!in_array($status, $statusList) || $status === Meeting::ATTENDEE_STATUS_NONE) {
+            throw new BadRequest("Acceptance status not allowed.");
+        }
+
+        $entity = $this->entityManager->getEntityById($entityType, $id);
+
+        if (!$entity) {
+            throw new NotFound();
+        }
+
+        if (!$entity instanceof CoreEntity) {
+            throw new LogicException();
+        }
+
+        if (!$entity->hasLinkMultipleId('users', $this->user->getId())) {
+            throw new Forbidden();
+        }
+
+        $currentStatus = $this->entityManager
+            ->getRDBRepository($entityType)
+            ->getRelation($entity, 'users')
+            ->getColumn($this->user, 'status');
+
+        if ($currentStatus === $status) {
+            return;
+        }
+
+        $this->entityManager
+            ->getRDBRepository($entityType)
+            ->getRelation($entity, 'users')
+            ->updateColumnsById($this->user->getId(), ['status' => $status]);
+
+        if ($this->metadata->get(['scopes', $entityType, 'stream'])) {
+            $this->createEventConfirmationNote($entity, $status);
+        }
+
+        $actionData = [
+            'eventName' => $entity->get(Field::NAME),
+            'eventType' => $entity->getEntityType(),
+            'eventId' => $entity->getId(),
+            'dateStart' => $entity->get('dateStart'),
+            'status' => $status,
+            'link' => 'users',
+            'inviteeType' => User::ENTITY_TYPE,
+            'inviteeId' => $this->user->getId(),
+        ];
+
+        $this->hookManager->process($entityType, 'afterConfirmation', $entity, [], $actionData);
+    }
+
+    private function createEventConfirmationNote(CoreEntity $entity, string $status): void
+    {
+        $options = ['createdById' => $this->user->getId()];
+
+        $style = $this->metadata
+            ->get(['entityDefs', $entity->getEntityType(), 'fields', 'acceptanceStatus', 'style', $status]);
+
+        $this->entityManager->createEntity(Note::ENTITY_TYPE, [
+            'type' => self::NOTE_TYPE_EVENT_CONFIRMATION,
+            'parentId' => $entity->getId(),
+            'parentType' => $entity->getEntityType(),
+            'relatedId' => $this->user->getId(),
+            'relatedType' => $this->user->getEntityType(),
+            'data' => [
+                'status' => $status,
+                'style' => $style,
+            ],
+        ], $options);
+    }
+
+    /**
+     * @param string[] $ids
+     * @throws Forbidden
+     */
+    public function massSetHeld(string $entityType, array $ids): void
+    {
+        if (!$this->acl->checkScope($entityType, Acl\Table::ACTION_EDIT)) {
+            throw new Forbidden();
+        }
+
+        if (!$this->acl->checkField($entityType, 'status', Acl\Table::ACTION_EDIT)) {
+            throw new Forbidden("No edit access to 'status' field.");
+        }
+
+        foreach ($ids as $id) {
+            $entity = $this->entityManager->getEntityById($entityType, $id);
+
+            if (!$entity || !$this->acl->checkEntityEdit($entity)) {
+                continue;
+            }
+
+            $entity->set('status', Meeting::STATUS_HELD);
+
+            $this->entityManager->saveEntity($entity);
+        }
+    }
+
+    /**
+     * @param string[] $ids
+     * @throws Forbidden
+     */
+    public function massSetNotHeld(string $entityType, array $ids): void
+    {
+        if (!$this->acl->checkScope($entityType, Acl\Table::ACTION_EDIT)) {
+            throw new Forbidden();
+        }
+
+        if (!$this->acl->checkField($entityType, 'status', Acl\Table::ACTION_EDIT)) {
+            throw new Forbidden("No edit access to 'status' field.");
+        }
+
+        foreach ($ids as $id) {
+            $entity = $this->entityManager->getEntityById($entityType, $id);
+
+            if (!$entity || !$this->acl->checkEntityEdit($entity)) {
+                continue;
+            }
+
+            $entity->set('status', Meeting::STATUS_NOT_HELD);
+
+            $this->entityManager->saveEntity($entity);
+        }
+    }
+
+    /**
+     * Get all attendees.
+     *
+     * @throws Forbidden
+     * @throws NotFound
+     * @return RecordCollection<Entity>
+     */
+    public function getAttendees(string $entityType, string $id): RecordCollection
+    {
+        $entity = $this->entityManager->getEntityById($entityType, $id);
+
+        if (!in_array($entityType, [Meeting::ENTITY_TYPE, Call::ENTITY_TYPE])) {
+            throw new LogicException();
+        }
+
+        if (!$entity) {
+            throw new NotFound();
+        }
+
+        if (!$this->acl->checkEntityRead($entity)) {
+            throw new Forbidden();
+        }
+
+        $linkList = [
+            'users',
+            'contacts',
+            'leads',
+        ];
+
+        $linkList = array_filter($linkList, function ($item) use ($entityType) {
+            return $this->acl->checkField($item, $entityType);
+        });
+
+        $linkList = array_values($linkList);
+
+        $list = [];
+
+        foreach ($linkList as $link) {
+            $itemCollection = $this->entityManager
+                ->getRDBRepository($entityType)
+                ->getRelation($entity, $link)
+                ->select([Attribute::ID, Field::NAME, 'acceptanceStatus', 'emailAddress'])
+                ->order('name')
+                ->find();
+
+            $list = array_merge($list, [...$itemCollection]);
+        }
+
+        /** @var Collection<Entity> $collection */
+        $collection = $this->entityManager->getCollectionFactory()->create(null, $list);
+
+        foreach ($collection as $e) {
+            if ($this->acl->checkEntityRead($e) && $this->acl->checkField($entityType, 'emailAddress')) {
+                continue;
+            }
+
+            if (!$e->get('emailAddress')) {
+                continue;
+            }
+
+            $e->set('emailAddress', 'dummy@dummy.dummy');
+        }
+
+        return RecordCollection::create($collection);
+    }
+}