espocrm-base/application/Espo/Modules/Crm/EntryPoints/Unsubscribe.php

<?php
/************************************************************************
 * This file is part of EspoCRM.
 *
 * EspoCRM - Open Source CRM application.
 * Copyright (C) 2014-2022 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
 * Website: https://www.espocrm.com
 *
 * EspoCRM is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * EspoCRM 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with EspoCRM. If not, see http://www.gnu.org/licenses/.phpppph
 *
 * 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 General Public License version 3.
 *
 * In accordance with Section 7(b) of the GNU General Public License version 3,
 * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
 ************************************************************************/

namespace Espo\Modules\Crm\EntryPoints;

use Espo\Modules\Crm\Services\Campaign as Service;
use Espo\Repositories\EmailAddress as EmailAddressRepository;

use Espo\Modules\Crm\Tools\MassEmail\Util as MassEmailUtil;

use Espo\Core\{
    Exceptions\NotFound,
    Exceptions\BadRequest,
    EntryPoint\EntryPoint,
    EntryPoint\Traits\NoAuth,
    Api\Request,
    Api\Response,
    ORM\EntityManager,
    Utils\ClientManager,
    HookManager,
    Utils\Config,
    Utils\Metadata,
    Utils\Hasher,
};

class Unsubscribe implements EntryPoint
{
    use NoAuth;

    protected EntityManager $entityManager;

    protected ClientManager $clientManager;

    protected HookManager $hookManager;

    protected Config $config;

    protected Metadata $metadata;

    protected Hasher $hasher;

    protected Service $service;

    private MassEmailUtil $util;

    public function __construct(
        EntityManager $entityManager,
        ClientManager $clientManager,
        HookManager $hookManager,
        Config $config,
        Metadata $metadata,
        Hasher $hasher,
        Service $service,
        MassEmailUtil $util
    ) {
        $this->entityManager = $entityManager;
        $this->clientManager = $clientManager;
        $this->hookManager = $hookManager;
        $this->config = $config;
        $this->metadata = $metadata;
        $this->hasher = $hasher;
        $this->service = $service;
        $this->util = $util;
    }

    public function run(Request $request, Response $response): void
    {
        $id = $request->getQueryParam('id') ?? null;
        $emailAddress = $request->getQueryParam('emailAddress') ?? null;
        $hash = $request->getQueryParam('hash') ?? null;

        if ($emailAddress && $hash) {
            $this->processWithHash($emailAddress, $hash);

            return;
        }

        if (!$id) {
            throw new BadRequest();
        }

        $queueItemId = $id;

        $queueItem = $this->entityManager->getEntity('EmailQueueItem', $queueItemId);

        if (!$queueItem) {
            throw new NotFound();
        }

        $campaign = null;
        $target = null;

        $campaignId = null;

        $massEmailId = $queueItem->get('massEmailId');

        if ($massEmailId) {
            $massEmail = $this->entityManager->getEntity('MassEmail', $massEmailId);

            if ($massEmail) {
                $campaignId = $massEmail->get('campaignId');

                if ($campaignId) {
                    $campaign = $this->entityManager->getEntity('Campaign', $campaignId);
                }

                $targetType = $queueItem->get('targetType');
                $targetId = $queueItem->get('targetId');

                if ($targetType && $targetId) {
                    $target = $this->entityManager->getEntity($targetType, $targetId);

                    if (!$target) {
                        throw new NotFound();
                    }

                    if ($massEmail->get('optOutEntirely')) {
                        $emailAddress = $target->get('emailAddress');

                        if ($emailAddress) {
                            $ea = $this->getEmailAddressRepository()->getByAddress($emailAddress);

                            if ($ea) {
                                $ea->set('optOut', true);
                                $this->entityManager->saveEntity($ea);
                            }
                        }
                    }

                    $link = $this->util->getLinkByEntityType($target->getEntityType());

                    $targetListList = $this->entityManager
                        ->getRDBRepository('MassEmail')
                        ->getRelation($massEmail, 'targetLists')
                        ->find();

                    foreach ($targetListList as $targetList) {
                        $optedOutResult = $this->entityManager
                            ->getRDBRepository('TargetList')
                            ->updateRelation($targetList, $link, $target->getId(), ['optedOut' => true]);

                        if ($optedOutResult) {
                            $hookData = [
                               'link' => $link,
                               'targetId' => $targetId,
                               'targetType' => $targetType,
                            ];

                            $this->hookManager->process('TargetList', 'afterOptOut', $targetList, [], $hookData);
                        }
                    }

                    $this->hookManager->process($target->getEntityType(), 'afterOptOut', $target, [], []);

                    $this->display(['queueItemId' => $queueItemId]);
                }
            }
        }

        if ($campaign && $target) {
            $this->service->logOptedOut(
                $campaignId,
                $queueItemId,
                $target,
                $queueItem->get('emailAddress'),
                null,
                $queueItem->get('isTest')
            );
        }
    }

    /**
     * @param array<string,mixed> $actionData
     */
    protected function display(array $actionData): void
    {
        $data = [
            'actionData' => $actionData,
            'view' => $this->metadata->get(['clientDefs', 'Campaign', 'unsubscribeView']),
            'template' => $this->metadata->get(['clientDefs', 'Campaign', 'unsubscribeTemplate']),
        ];

        $runScript = "
            Espo.require('crm:controllers/unsubscribe', function (Controller) {
                var controller = new Controller(app.baseController.params, app.getControllerInjection());
                controller.masterView = app.masterView;
                controller.doAction('unsubscribe', ".json_encode($data).");
            });
        ";

        $this->clientManager->display($runScript);
    }

    protected function processWithHash(string $emailAddress, string $hash): void
    {
        $hash2 = $this->hasher->hash($emailAddress);

        if ($hash2 !== $hash) {
            throw new NotFound();
        }

        $repository = $this->getEmailAddressRepository();

        $ea = $repository->getByAddress($emailAddress);

        if ($ea) {
            $entityList = $repository->getEntityListByAddressId($ea->id);

            if (!$ea->get('optOut')) {
                $ea->set('optOut', true);
                $this->entityManager->saveEntity($ea);

                foreach ($entityList as $entity) {
                    $this->hookManager->process($entity->getEntityType(), 'afterOptOut', $entity, [], []);
                }
            }

            $this->display([
                'emailAddress' => $emailAddress,
                'hash' => $hash,
            ]);
        }
        else {
            throw new NotFound();
        }
    }

    private function getEmailAddressRepository(): EmailAddressRepository
    {
        /** @var EmailAddressRepository */
        return $this->entityManager->getRepository('EmailAddress');
    }
}