Files
espocrm/application/Espo/SelectManagers/Email.php
2019-10-08 13:43:31 +03:00

461 lines
13 KiB
PHP

<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM - Open Source CRM application.
* Copyright (C) 2014-2019 Yuri Kuznetsov, Taras Machyshyn, Oleksiy 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\SelectManagers;
class Email extends \Espo\Core\SelectManagers\Base
{
protected $textFilterUseContainsAttributeList = ['name'];
protected $fullTextSearchForceOrderOnlyByRelevance = true;
protected $selectAttributesDependancyMap = [
'subject' => ['name'],
'personStringData' => ['fromString', 'fromEmailAddressId'],
];
public function applyAdditional(array $params, array &$result)
{
parent::applyAdditional($params, $result);
$folderId = $params['folderId'] ?? null;
if ($folderId) {
$this->applyFolder($folderId, $result);
}
if (empty($params['textFilter']) && !empty($result['orderBy']) && $result['orderBy'] === 'dateSent') {
$skipIndex = false;
if (isset($params['where'])) {
foreach ($params['where'] as $item) {
if ($item['type'] === 'textFilter') {
$skipIndex = true;
break;
} else {
if (isset($item['attribute'])) {
if (!in_array($item['attribute'], ['teams', 'users', 'status'])) {
$skipIndex = true;
break;
}
}
}
}
}
if ($folderId === 'important' || $folderId === 'drafts') {
$skipIndex = true;
}
if (!$skipIndex) {
$result['useIndex'] = 'dateSent';
}
}
if ($folderId === 'drafts') {
$result['useIndex'] = 'createdById';
}
if ($folderId !== 'drafts') {
$this->addUsersJoin($result);
}
return $result;
}
public function applyFolder(?string $folderId, array &$result)
{
switch ($folderId) {
case 'all':
break;
case 'inbox':
$this->filterInbox($result);
break;
case 'important':
$this->filterImportant($result);
break;
case 'sent':
$this->filterSent($result);
break;
case 'trash':
$this->filterTrash($result);
break;
case 'drafts':
$this->filterDrafts($result);
break;
default:
$this->applyEmailFolder($folderId, $result);
}
}
public function addUsersJoin(array &$result)
{
if (!$this->hasJoin('users', $result) && !$this->hasLeftJoin('users', $result)) {
$this->addLeftJoin('users', $result);
}
$this->setJoinCondition('users', [
'userId' => $this->getUser()->id
], $result);
$this->addUsersColumns($result);
}
protected function applyEmailFolder($folderId, &$result)
{
$result['whereClause'][] = [
'usersMiddle.inTrash' => false,
'usersMiddle.folderId' => $folderId
];
$this->filterOnlyMy($result);
}
protected function filterOnlyMy(&$result)
{
if (!$this->hasJoin('users', $result) && !$this->hasLeftJoin('users', $result)) {
$this->addJoin('users', $result);
}
$result['whereClause'][] = [
'usersMiddle.userId' => $this->getUser()->id
];
$this->addUsersColumns($result);
}
protected function boolFilterOnlyMy(&$result)
{
$this->addLeftJoin(['users', 'usersOnlyMyFilter'], $result);
$this->setDistinct(true, $result);
return [
'usersOnlyMyFilterMiddle.userId' => $this->getUser()->id
];
}
protected function addUsersColumns(&$result)
{
if (!isset($result['select'])) {
$result['additionalSelectColumns']['usersMiddle.is_read'] = 'isRead';
$result['additionalSelectColumns']['usersMiddle.is_important'] = 'isImportant';
$result['additionalSelectColumns']['usersMiddle.in_trash'] = 'inTrash';
$result['additionalSelectColumns']['usersMiddle.folder_id'] = 'folderId';
}
}
protected function filterInbox(&$result)
{
$eaList = $this->getUser()->get('emailAddresses');
$idList = [];
foreach ($eaList as $ea) {
$idList[] = $ea->id;
}
$group = [
'usersMiddle.inTrash=' => false,
'usersMiddle.folderId' => null,
[
'status' => ['Archived', 'Sent']
]
];
if (!empty($idList)) {
$group['fromEmailAddressId!='] = $idList;
$group[] = [
'OR' => [
'status' => 'Archived',
'createdById!=' => $this->getUser()->id
]
];
} else {
$group[] = [
'status' => 'Archived',
'createdById!=' => $this->getUser()->id
];
}
$result['whereClause'][] = $group;
$this->filterOnlyMy($result);
}
protected function filterImportant(&$result)
{
$result['whereClause'][] = $this->getWherePartIsImportantIsTrue();
$this->filterOnlyMy($result);
}
protected function filterSent(&$result)
{
$eaList = $this->getUser()->get('emailAddresses');
$idList = [];
foreach ($eaList as $ea) {
$idList[] = $ea->id;
}
$result['whereClause'][] = [
'OR' => [
'fromEmailAddressId=' => $idList,
[
'status' => 'Sent',
'createdById' => $this->getUser()->id
]
],
[
'status!=' => 'Draft'
],
'usersMiddle.inTrash=' => false
];
}
protected function filterTrash(&$result)
{
$result['whereClause'][] = [
'usersMiddle.inTrash=' => true
];
$this->filterOnlyMy($result);
}
protected function filterDrafts(&$result)
{
$result['whereClause'][] = [
'status' => 'Draft',
'createdById' => $this->getUser()->id
];
}
protected function filterArchived(&$result)
{
$result['whereClause'][] = [
'status' => 'Archived'
];
}
protected function accessOnlyOwn(&$result)
{
$this->filterOnlyMy($result);
}
protected function accessPortalOnlyOwn(&$result)
{
$this->filterOnlyMy($result);
}
protected function accessOnlyTeam(&$result)
{
$this->setDistinct(true, $result);
$this->addLeftJoin(['teams', 'teamsAccess'], $result);
if (!$this->hasJoin('users', $result) && !$this->hasLeftJoin('users', $result)) {
$this->addLeftJoin(['users', 'users'], $result);
}
$result['whereClause'][] = [
'OR' => [
'teamsAccessMiddle.teamId' => $this->getUser()->getLinkMultipleIdList('teams'),
'usersMiddle.userId' => $this->getUser()->id,
]
];
}
protected function accessPortalOnlyAccount(&$result)
{
$this->setDistinct(true, $result);
$this->addLeftJoin(['users', 'usersAccess'], $result);
$orGroup = [
'usersAccess.id' => $this->getUser()->id
];
$accountIdList = $this->getUser()->getLinkMultipleIdList('accounts');
if (count($accountIdList)) {
$orGroup['accountId'] = $accountIdList;
}
$contactId = $this->getUser()->get('contactId');
if ($contactId) {
$orGroup[] = [
'parentId' => $contactId,
'parentType' => 'Contact'
];
}
$result['whereClause'][] = [
'OR' => $orGroup
];
}
protected function accessPortalOnlyContact(&$result)
{
$this->setDistinct(true, $result);
$this->addLeftJoin(['users', 'usersAccess'], $result);
$orGroup = [
'usersAccess.id' => $this->getUser()->id
];
$contactId = $this->getUser()->get('contactId');
if ($contactId) {
$orGroup[] = [
'parentId' => $contactId,
'parentType' => 'Contact'
];
}
$result['whereClause'][] = [
'OR' => $orGroup
];
}
protected function applyAdditionalToTextFilterGroup(string $textFilter, array &$group, array &$result)
{
if (strlen($textFilter) >= self::MIN_LENGTH_FOR_CONTENT_SEARCH) {
$emailAddressId = $this->getEmailAddressIdByValue($textFilter);
if ($emailAddressId) {
$this->leftJoinEmailAddress($result);
$group['fromEmailAddressId'] = $emailAddressId;
$group['emailEmailAddress.emailAddressId'] = $emailAddressId;
}
}
}
protected function getEmailAddressIdByValue($value)
{
$pdo = $this->getEntityManager()->getPDO();
$emailAddress = $this->getEntityManager()->getRepository('EmailAddress')->where([
'lower' => strtolower($value)
])->findOne();
$emailAddressId = null;
if ($emailAddress) {
$emailAddressId = $emailAddress->id;
}
return $emailAddressId;
}
protected function leftJoinEmailAddress(&$result)
{
if (empty($result['customJoin'])) {
$result['customJoin'] = '';
}
if (stripos($result['customJoin'], 'emailEmailAddress') === false) {
$result['customJoin'] .= "
LEFT JOIN email_email_address AS `emailEmailAddress`
ON
emailEmailAddress.email_id = email.id AND
emailEmailAddress.deleted = 0
";
}
}
public function whereEmailAddress(string $value, array &$result)
{
$orItem = [];
$emailAddressId = $this->getEmailAddressIdByValue($value);
if ($emailAddressId) {
$this->leftJoinEmailAddress($result);
$orItem['fromEmailAddressId'] = $emailAddressId;
$orItem['emailEmailAddress.emailAddressId'] = $emailAddressId;
$result['whereClause'][] = [
'OR' => $orItem
];
} else {
if (empty($result['customWhere'])) {
$result['customWhere'] = '';
}
$result['customWhere'] .= ' AND 0';
}
}
protected function getWherePartIsNotRepliedIsTrue()
{
return array(
'isReplied' => false
);
}
protected function getWherePartIsNotRepliedIsFalse()
{
return array(
'isReplied' => true
);
}
public function getWherePartIsNotReadIsTrue()
{
return array(
'usersMiddle.isRead' => false,
'OR' => array(
'sentById' => null,
'sentById!=' => $this->getUser()->id
)
);
}
protected function getWherePartIsNotReadIsFalse()
{
return array(
'usersMiddle.isRead' => true
);
}
protected function getWherePartIsReadIsTrue()
{
return array(
'usersMiddle.isRead' => true
);
}
protected function getWherePartIsReadIsFalse()
{
return array(
'usersMiddle.isRead' => false,
'OR' => array(
'sentById' => null,
'sentById!=' => $this->getUser()->id
)
);
}
protected function getWherePartIsImportantIsTrue()
{
return array(
'usersMiddle.isImportant' => true
);
}
protected function getWherePartIsImportantIsFalse()
{
return array(
'usersMiddle.isImportant' => false
);
}
}