espocrm/application/Espo/Services/EmailAddress.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/.
 *
 * 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\Services;

use Espo\Repositories\EmailAddress as Repository;
use Espo\Entities\EmailAddress as EmailAddressEntity;

use Espo\ORM\Query\SelectBuilder as QueryBuilder;

class EmailAddress extends Record
{
    const ERASED_PREFIX = 'ERASED:';

    /**
     * @param array<int,array<string,mixed>> $result
     */
    protected function findInAddressBookByEntityType(
        string $filter,
        int $limit,
        string $entityType,
        array &$result,
        bool $onlyActual = false
    ): void {

        $whereClause = [
            'OR' => [
                [
                    'name*' => $filter . '%',
                ],
                [
                    'emailAddress*' => $filter . '%',
                ],
            ],
            [
                'emailAddress!=' => null,
            ],
        ];

        $builder = $this->selectBuilderFactory
            ->create()
            ->from($entityType)
            ->withAccessControlFilter()
            ->buildQueryBuilder()
            ->where($whereClause)
            ->order('name')
            ->limit(0, $limit);

        $handleMethodName = 'handleQueryBuilder' . $entityType;

        if (method_exists($this, $handleMethodName)) {
            $this->$handleMethodName($filter, $builder);
        }


        $select = ['id', 'emailAddress', 'name'];

        if (
            $this->metadata->get(
                ['entityDefs', $entityType, 'fields', 'name', 'type']
            ) === 'personName'
        ) {
            $select[] = 'firstName';
            $select[] = 'lastName';
        }

        $builder->select($select);

        $collection = $this->entityManager
            ->getRDBRepository($entityType)
            ->clone($builder->build())
            ->find();

        foreach ($collection as $entity) {
            $emailAddress = $entity->get('emailAddress');

            $emailAddressData = $this->getEmailAddressRepository()->getEmailAddressData($entity);

            $skipPrimaryEmailAddress = false;

            if ($emailAddress) {
                if (strpos($emailAddress, self::ERASED_PREFIX) === 0) {
                    $skipPrimaryEmailAddress = true;
                }

                if ($onlyActual) {
                    if ($entity->get('emailAddressIsOptedOut')) {
                        $skipPrimaryEmailAddress = true;
                    }

                    foreach ($emailAddressData as $item) {
                        if ($emailAddress !== $item->emailAddress) {
                            continue;
                        }

                        if (!empty($item->invalid)) {
                            $skipPrimaryEmailAddress = true;
                        }
                    }
                }
            }

            if (!$skipPrimaryEmailAddress) {
                $result[] = [
                    'emailAddress' => $emailAddress,
                    'entityName' => $entity->get('name'),
                    'entityType' => $entityType,
                    'entityId' => $entity->getId(),
                ];
            }

            foreach ($emailAddressData as $item) {
                if ($emailAddress === $item->emailAddress) {
                    continue;
                }

                if (strpos($item->emailAddress, self::ERASED_PREFIX) === 0) {
                    continue;
                }

                if ($onlyActual) {
                    if (!empty($item->invalid)) {
                        continue;
                    }

                    if (!empty($item->optOut)) {
                        continue;
                    }
                }

                $result[] = [
                    'emailAddress' => $item->emailAddress,
                    'entityName' => $entity->get('name'),
                    'entityType' => $entityType,
                    'entityId' => $entity->getId(),
                ];
            }
        }
    }

    protected function handleQueryBuilderUser(string $filter, QueryBuilder $queryBuilder): void
    {
        if ($this->acl->get('portalPermission') === 'no') {
            $queryBuilder->where([
                'type!=' => 'portal',
            ]);
        }

        $queryBuilder->where([
            'type!=' => ['api', 'system', 'super-admin'],
        ]);
    }

    /**
     * @param array<int,array<string,mixed>> $result
     */
    protected function findInInboundEmail(string $query, int $limit, array &$result): void
    {
        if ($this->user->isPortal()) {
            return;
        }

        $list = $this->entityManager
            ->getRDBRepository('InboundEmail')
            ->select(['id', 'name', 'emailAddress'])
            ->where([
                'emailAddress*' => $query . '%',
            ])
            ->order('name')
            ->find();

        foreach ($list as $item) {
            $result[] = [
                'emailAddress' => $item->get('emailAddress'),
                'entityName' => $item->get('name'),
                'entityType' => 'InboundEmail',
                'entityId' => $item->get('id'),
            ];
        }
    }

    /**
     * @return array<int,array<string,mixed>>
     */
    public function searchInAddressBook(string $query, int $limit, bool $onlyActual = false): array
    {
        $result = [];

        $entityTypeList = $this->config->get('emailAddressLookupEntityTypeList') ?? [];

        $allEntityTypeList = $this->getHavingEmailAddressEntityTypeList();

        foreach ($entityTypeList as $entityType) {
            if (!in_array($entityType, $allEntityTypeList)) {
                continue;
            }

            if (!$this->acl->checkScope($entityType)) {
                continue;
            }

            $this->findInAddressBookByEntityType($query, $limit, $entityType, $result, $onlyActual);
        }

        $this->findInInboundEmail($query, $limit, $result);

        $finalResult = [];

        foreach ($result as $item) {
            foreach ($finalResult as $item1) {
                if ($item['emailAddress'] == $item1['emailAddress']) {
                    continue 2;
                }
            }

            $finalResult[] = $item;
        }

        usort($finalResult, function ($item1, $item2) use ($query) {
            if (strpos($query, '@') === false) {
                return 0;
            }

            $p1 = strpos($item1['emailAddress'], $query);
            $p2 = strpos($item2['emailAddress'], $query);

            if ($p1 === 0 && $p2 !== 0) {
                return -1;
            }

            if ($p1 !== 0 && $p2 !== 0) {
                return 0;
            }

            if ($p1 !== 0 && $p2 === 0) {
                return 1;
            }

            return 0;
        });

        return $finalResult;
    }

    /**
     * @return string[]
     */
    protected function getHavingEmailAddressEntityTypeList(): array
    {
        $list = ['Account', 'Contact', 'Lead', 'User'];

        $scopeDefs = $this->metadata->get(['scopes']);

        foreach ($scopeDefs as $scope => $defs) {
            if (
                empty($defs['disabled']) &&
                !empty($defs['type']) &&
                ($defs['type'] === 'Person' || $defs['type'] === 'Company')
            ) {
                $list[] = $scope;
            }
        }

        return $list;
    }

    private function getEmailAddressRepository(): Repository
    {
        /** @var Repository */
        return $this->entityManager->getRepository(EmailAddressEntity::ENTITY_TYPE);
    }
}