yuri
415 lines
14 KiB
PHP
415 lines
14 KiB
PHP
<?php
|
|
/************************************************************************
|
|
* This file is part of EspoCRM.
|
|
*
|
|
* EspoCRM - Open Source CRM application.
|
|
* Copyright (C) 2014-2018 Yuri Kuznetsov, Taras Machyshyn, Oleksiy Avramenko
|
|
* Website: http://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\Modules\Crm\Services;
|
|
|
|
use \Espo\ORM\Entity;
|
|
|
|
use \Espo\Core\Exceptions\NotFound;
|
|
use \Espo\Core\Exceptions\BadRequest;
|
|
use \Espo\Core\Exceptions\Forbidden;
|
|
|
|
class TargetList extends \Espo\Services\Record
|
|
{
|
|
protected $noEditAccessRequiredLinkList = ['accounts', 'contacts', 'leads', 'users'];
|
|
|
|
protected $duplicatingLinkList = ['accounts', 'contacts', 'leads', 'users'];
|
|
|
|
protected $entityTypeLinkMap = array(
|
|
'Lead' => 'leads',
|
|
'Account' => 'accounts',
|
|
'Contact' => 'contacts',
|
|
'User' => 'users'
|
|
);
|
|
|
|
protected $linkSelectParams = [
|
|
'accounts' => [
|
|
'additionalColumns' => [
|
|
'optedOut' => 'targetListIsOptedOut'
|
|
]
|
|
],
|
|
'contacts' => [
|
|
'additionalColumns' => [
|
|
'optedOut' => 'targetListIsOptedOut'
|
|
]
|
|
],
|
|
'leads' => [
|
|
'additionalColumns' => [
|
|
'optedOut' => 'targetListIsOptedOut'
|
|
]
|
|
],
|
|
'users' => [
|
|
'additionalColumns' => [
|
|
'optedOut' => 'targetListIsOptedOut'
|
|
]
|
|
]
|
|
];
|
|
|
|
protected function init()
|
|
{
|
|
parent::init();
|
|
$this->addDependencyList([
|
|
'hookManager'
|
|
]);
|
|
}
|
|
|
|
public function loadAdditionalFields(Entity $entity)
|
|
{
|
|
parent::loadAdditionalFields($entity);
|
|
$this->loadEntryCountField($entity);
|
|
$this->loadOptedOutCountField($entity);
|
|
}
|
|
|
|
public function loadAdditionalFieldsForList(Entity $entity)
|
|
{
|
|
parent::loadAdditionalFields($entity);
|
|
$this->loadEntryCountField($entity);
|
|
}
|
|
|
|
protected function loadEntryCountField(Entity $entity)
|
|
{
|
|
$count = 0;
|
|
$count += $this->getEntityManager()->getRepository('TargetList')->countRelated($entity, 'contacts');
|
|
$count += $this->getEntityManager()->getRepository('TargetList')->countRelated($entity, 'leads');
|
|
$count += $this->getEntityManager()->getRepository('TargetList')->countRelated($entity, 'users');
|
|
$count += $this->getEntityManager()->getRepository('TargetList')->countRelated($entity, 'accounts');
|
|
$entity->set('entryCount', $count);
|
|
}
|
|
|
|
protected function loadOptedOutCountField(Entity $entity)
|
|
{
|
|
$count = 0;
|
|
|
|
|
|
$count += $this->getEntityManager()->getRepository('Contact')->join(['targetLists'])->where([
|
|
'targetListsMiddle.targetListId' => $entity->id,
|
|
'targetListsMiddle.optedOut' => 1
|
|
])->count();
|
|
|
|
$count += $this->getEntityManager()->getRepository('Lead')->join(['targetLists'])->where([
|
|
'targetListsMiddle.targetListId' => $entity->id,
|
|
'targetListsMiddle.optedOut' => 1
|
|
])->count();
|
|
|
|
$count += $this->getEntityManager()->getRepository('Account')->join(['targetLists'])->where([
|
|
'targetListsMiddle.targetListId' => $entity->id,
|
|
'targetListsMiddle.optedOut' => 1
|
|
])->count();
|
|
|
|
$count += $this->getEntityManager()->getRepository('User')->join(['targetLists'])->where([
|
|
'targetListsMiddle.targetListId' => $entity->id,
|
|
'targetListsMiddle.optedOut' => 1
|
|
])->count();
|
|
|
|
$entity->set('optedOutCount', $count);
|
|
}
|
|
|
|
protected function afterCreate(Entity $entity, array $data = array())
|
|
{
|
|
if (array_key_exists('sourceCampaignId', $data) && !empty($data['includingActionList'])) {
|
|
$excludingActionList = [];
|
|
if (!empty($data['excludingActionList'])) {
|
|
$excludingActionList = $data['excludingActionList'];
|
|
}
|
|
$this->populateFromCampaignLog($entity, $data['sourceCampaignId'], $data['includingActionList'], $excludingActionList);
|
|
}
|
|
}
|
|
|
|
protected function populateFromCampaignLog(Entity $entity, $sourceCampaignId, $includingActionList, $excludingActionList)
|
|
{
|
|
if (empty($sourceCampaignId)) {
|
|
throw new BadRequest();
|
|
}
|
|
$campaign = $this->getEntityManager()->getEntity('Campaign', $sourceCampaignId);
|
|
if (!$campaign) {
|
|
throw new NotFound();
|
|
}
|
|
if (!$this->getAcl()->check($campaign, 'read')) {
|
|
throw new Forbidden();
|
|
}
|
|
|
|
$selectManager = $this->getSelectManagerFactory()->create('CampaignLogRecord');
|
|
$selectParams = $selectManager->getEmptySelectParams();
|
|
|
|
|
|
$selectParams['whereClause'][] = array(
|
|
'isTest' => false
|
|
);
|
|
$selectParams['whereClause'][] = array(
|
|
'campaignId' => $sourceCampaignId
|
|
);
|
|
|
|
$selectParams['select'] = ['id', 'parentId', 'parentType'];
|
|
|
|
$notSelectParams = $selectParams;
|
|
|
|
$selectParams['whereClause'][] = array(
|
|
'action=' => $includingActionList
|
|
);
|
|
$selectParams['groupBy'] = ['parentId', 'parentType', 'id'];
|
|
|
|
$notSelectParams['whereClause'][] = array(
|
|
'action=' => $excludingActionList
|
|
);
|
|
$notSelectParams['select'] = ['id'];
|
|
|
|
$list = $this->getEntityManager()->getRepository('CampaignLogRecord')->find($selectParams);
|
|
|
|
foreach ($list as $logRecord) {
|
|
if (!$logRecord->get('parentType')) continue;
|
|
if (empty($this->entityTypeLinkMap[$logRecord->get('parentType')])) continue;
|
|
|
|
if (!empty($excludingActionList)) {
|
|
$clonedSelectParams = $notSelectParams;
|
|
$clonedSelectParams['whereClause'][] = [
|
|
'parentType' => $logRecord->get('parentType'),
|
|
'parentId' => $logRecord->get('parentId'),
|
|
];
|
|
if ($this->getEntityManager()->getRepository('CampaignLogRecord')->findOne($clonedSelectParams)) continue;
|
|
}
|
|
|
|
$relation = $this->entityTypeLinkMap[$logRecord->get('parentType')];
|
|
$this->getRepository()->relate($entity, $relation, $logRecord->get('parentId'));
|
|
}
|
|
}
|
|
|
|
public function unlinkAll($id, $link)
|
|
{
|
|
$entity = $this->getRepository()->get($id);
|
|
if (!$entity) {
|
|
throw new NotFound();
|
|
}
|
|
if (!$this->getAcl()->check($entity, 'edit')) {
|
|
throw new Forbidden();
|
|
}
|
|
|
|
$foreignEntityType = $entity->getRelationParam($link, 'entity');
|
|
if (!$foreignEntityType) {
|
|
throw new Error();
|
|
}
|
|
|
|
if (empty($foreignEntityType)) {
|
|
throw new Error();
|
|
}
|
|
|
|
$pdo = $this->getEntityManager()->getPDO();
|
|
$query = $this->getEntityManager()->getQuery();
|
|
$sql = null;
|
|
|
|
switch ($link) {
|
|
case 'contacts':
|
|
$sql = "UPDATE contact_target_list SET deleted = 1 WHERE target_list_id = " . $query->quote($entity->id);
|
|
break;
|
|
case 'leads':
|
|
$sql = "UPDATE lead_target_list SET deleted = 1 WHERE target_list_id = " . $query->quote($entity->id);
|
|
break;
|
|
case 'accounts':
|
|
$sql = "UPDATE account_target_list SET deleted = 1 WHERE target_list_id = " . $query->quote($entity->id);
|
|
break;
|
|
case 'users':
|
|
$sql = "UPDATE target_list_user SET deleted = 1 WHERE target_list_id = " . $query->quote($entity->id);
|
|
break;
|
|
}
|
|
if ($sql) {
|
|
if ($pdo->query($sql)) {
|
|
$this->getInjection('hookManager')->process('TargetList', 'afterUnlinkAll', $entity, array(), array('link' => $link));
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
|
|
protected function findLinkedEntitiesOptedOut($id, $params)
|
|
{
|
|
$pdo = $this->getEntityManager()->getPDO();
|
|
$query = $this->getEntityManager()->getQuery();
|
|
|
|
$sqlContact = $query->createSelectQuery('Contact', array(
|
|
'select' => ['id', 'name', 'createdAt', ['VALUE:Contact', '_scope']],
|
|
'customJoin' => 'JOIN contact_target_list AS j ON j.contact_id = contact.id AND j.deleted = 0 AND j.opted_out = 1',
|
|
'whereClause' => array(
|
|
'j.targetListId' => $id
|
|
)
|
|
));
|
|
|
|
$sqlLead = $query->createSelectQuery('Lead', array(
|
|
'select' => ['id', 'name', 'createdAt', ['VALUE:Lead', '_scope']],
|
|
'customJoin' => 'JOIN lead_target_list AS j ON j.lead_id = lead.id AND j.deleted = 0 AND j.opted_out = 1',
|
|
'whereClause' => array(
|
|
'j.targetListId' => $id
|
|
)
|
|
));
|
|
|
|
$sqlUser = $query->createSelectQuery('User', array(
|
|
'select' => ['id', 'name', 'createdAt', ['VALUE:User', '_scope']],
|
|
'customJoin' => 'JOIN target_list_user AS j ON j.user_id = user.id AND j.deleted = 0 AND j.opted_out = 1',
|
|
'whereClause' => array(
|
|
'j.targetListId' => $id
|
|
)
|
|
));
|
|
|
|
$sqlAccount = $query->createSelectQuery('Account', array(
|
|
'select' => ['id', 'name', 'createdAt', ['VALUE:Account', '_scope']],
|
|
'customJoin' => 'JOIN account_target_list AS j ON j.account_id = account.id AND j.deleted = 0 AND j.opted_out = 1',
|
|
'whereClause' => array(
|
|
'j.targetListId' => $id
|
|
)
|
|
));
|
|
|
|
$sql = "
|
|
{$sqlContact}
|
|
UNION
|
|
{$sqlLead}
|
|
UNION
|
|
{$sqlUser}
|
|
UNION
|
|
{$sqlAccount}
|
|
ORDER BY createdAt DESC
|
|
";
|
|
|
|
$sqlCount = "SELECT COUNT(*) AS 'count' FROM ({$sql}) AS c";
|
|
|
|
$sql = $query->limit($sql, $params['offset'], $params['maxSize']);
|
|
|
|
$sth = $pdo->prepare($sql);
|
|
$sth->execute();
|
|
$arr = [];
|
|
while ($row = $sth->fetch(\PDO::FETCH_ASSOC)) {
|
|
$arr[] = $row;
|
|
}
|
|
|
|
$sth = $pdo->prepare($sqlCount);
|
|
$sth->execute();
|
|
|
|
$row = $sth->fetch(\PDO::FETCH_ASSOC);
|
|
$count = $row['count'];
|
|
|
|
return array(
|
|
'total' => $count,
|
|
'list' => $arr
|
|
);
|
|
}
|
|
|
|
public function optOut($id, $targetType, $targetId)
|
|
{
|
|
$targetList = $this->getEntityManager()->getEntity('TargetList', $id);
|
|
if (!$targetList) {
|
|
throw new NotFound();
|
|
}
|
|
$target = $this->getEntityManager()->getEntity($targetType, $targetId);
|
|
if (!$target) {
|
|
throw new NotFound();
|
|
}
|
|
$map = array(
|
|
'Account' => 'accounts',
|
|
'Contact' => 'contacts',
|
|
'Lead' => 'leads',
|
|
'User' => 'users'
|
|
);
|
|
|
|
if (empty($map[$targetType])) {
|
|
throw new Error();
|
|
}
|
|
$link = $map[$targetType];
|
|
|
|
$result = $this->getEntityManager()->getRepository('TargetList')->relate($targetList, $link, $targetId, array(
|
|
'optedOut' => true
|
|
));
|
|
|
|
if ($result) {
|
|
$hookData = [
|
|
'link' => $link,
|
|
'targetId' => $targetId,
|
|
'targetType' => $targetType
|
|
];
|
|
|
|
$this->getInjection('hookManager')->process('TargetList', 'afterOptOut', $targetList, [], $hookData);
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
public function cancelOptOut($id, $targetType, $targetId)
|
|
{
|
|
$targetList = $this->getEntityManager()->getEntity('TargetList', $id);
|
|
if (!$targetList) {
|
|
throw new NotFound();
|
|
}
|
|
$target = $this->getEntityManager()->getEntity($targetType, $targetId);
|
|
if (!$target) {
|
|
throw new NotFound();
|
|
}
|
|
$map = array(
|
|
'Account' => 'accounts',
|
|
'Contact' => 'contacts',
|
|
'Lead' => 'leads',
|
|
'User' => 'users'
|
|
);
|
|
|
|
if (empty($map[$targetType])) {
|
|
throw new Error();
|
|
}
|
|
$link = $map[$targetType];
|
|
|
|
$result = $this->getEntityManager()->getRepository('TargetList')->updateRelation($targetList, $link, $targetId, array(
|
|
'optedOut' => false
|
|
));
|
|
|
|
if ($result) {
|
|
$hookData = [
|
|
'link' => $link,
|
|
'targetId' => $targetId,
|
|
'targetType' => $targetType
|
|
];
|
|
|
|
$this->getInjection('hookManager')->process('TargetList', 'afterCancelOptOut', $targetList, [], $hookData);
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
protected function duplicateLinks(Entity $entity, Entity $duplicatingEntity)
|
|
{
|
|
$repository = $this->getRepository();
|
|
|
|
foreach ($this->duplicatingLinkList as $link) {
|
|
$linkedList = $repository->findRelated($duplicatingEntity, $link, array(
|
|
'additionalColumnsConditions' => array(
|
|
'optedOut' => false
|
|
)
|
|
));
|
|
foreach ($linkedList as $linked) {
|
|
$repository->relate($entity, $link, $linked, array(
|
|
'optedOut' => false
|
|
));
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|