Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/mautic.corals.io/app/bundles/LeadBundle/EventListener/ |
<?php
namespace Mautic\LeadBundle\EventListener;
use Doctrine\DBAL\Exception;
use Doctrine\ORM\EntityManager;
use Mautic\CoreBundle\EventListener\ChannelTrait;
use Mautic\CoreBundle\Factory\ModelFactory;
use Mautic\CoreBundle\Helper\CoreParametersHelper;
use Mautic\CoreBundle\Helper\IpLookupHelper;
use Mautic\CoreBundle\Model\AuditLogModel;
use Mautic\LeadBundle\Entity\CompanyLeadRepository;
use Mautic\LeadBundle\Entity\DoNotContact;
use Mautic\LeadBundle\Entity\Lead;
use Mautic\LeadBundle\Entity\LeadDevice;
use Mautic\LeadBundle\Entity\LeadEventLog;
use Mautic\LeadBundle\Entity\LeadEventLogRepository;
use Mautic\LeadBundle\Entity\LeadNote;
use Mautic\LeadBundle\Entity\ListLead;
use Mautic\LeadBundle\Entity\PointsChangeLog;
use Mautic\LeadBundle\Entity\UtmTag;
use Mautic\LeadBundle\Event as Events;
use Mautic\LeadBundle\Event\LeadChangeCompanyEvent;
use Mautic\LeadBundle\Helper\LeadChangeEventDispatcher;
use Mautic\LeadBundle\LeadEvents;
use Mautic\LeadBundle\Model\ChannelTimelineInterface;
use Mautic\LeadBundle\Twig\Helper\DncReasonHelper;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\Routing\RouterInterface;
use Symfony\Contracts\Translation\TranslatorInterface;
class LeadSubscriber implements EventSubscriberInterface
{
use ChannelTrait;
/**
* @var RouterInterface
*/
private $router;
/**
* @var string[]
*/
private $preventLoop = [];
/**
* @var int|null
*/
private $lastContactId;
/**
* @param ModelFactory<object> $modelFactory
* @param bool $isTest whether or not we're running in a test environment
*/
public function __construct(
private IpLookupHelper $ipLookupHelper,
private AuditLogModel $auditLogModel,
private LeadChangeEventDispatcher $leadEventDispatcher,
private DncReasonHelper $dncReasonHelper,
private EntityManager $entityManager,
private TranslatorInterface $translator,
RouterInterface $router,
ModelFactory $modelFactory,
private CoreParametersHelper $coreParametersHelper,
private CompanyLeadRepository $companyLeadRepository,
private $isTest = false
) {
$this->router = $router;
$this->setModelFactory($modelFactory);
}
public static function getSubscribedEvents(): array
{
return [
LeadEvents::LEAD_POST_SAVE => ['onLeadPostSave', 0],
LeadEvents::LEAD_POST_DELETE => ['onLeadDelete', 0],
LeadEvents::LEAD_PRE_MERGE => ['preLeadMerge', 0],
LeadEvents::LEAD_POST_MERGE => ['onLeadMerge', 0],
LeadEvents::FIELD_POST_SAVE => ['onFieldPostSave', 0],
LeadEvents::FIELD_POST_DELETE => ['onFieldDelete', 0],
LeadEvents::NOTE_POST_SAVE => ['onNotePostSave', 0],
LeadEvents::NOTE_POST_DELETE => ['onNoteDelete', 0],
LeadEvents::TIMELINE_ON_GENERATE => ['onTimelineGenerate', 0],
LeadEvents::LEAD_COMPANY_CHANGE => ['onLeadCompanyChange', 0],
];
}
/**
* Add a lead entry to the audit log.
*/
public function onLeadPostSave(Events\LeadEvent $event): void
{
$lead = $event->getLead();
if (!$details = $event->getChanges()) {
return;
}
// Unset dateLastActive and dateModified and ipAddress to prevent un-necessary audit log entries
unset($details['dateLastActive'], $details['dateModified'], $details['ipAddressList'], $details['manipulator']);
if (empty($details)) {
return;
}
if ($manipulator = $lead->getManipulator()) {
$details['manipulated_by'] = $manipulator->getManipulatedBy();
$details['manipulator_key'] = $manipulator->getManipulatorKey();
}
// Reset the loop prevention if processing a new contact to prevent a memory leak when manipulating large numbers of contacts
if ($lead->getId() !== $this->lastContactId) {
$this->preventLoop = [];
$this->lastContactId = $lead->getId();
}
// Because there is an event within an event, there is a risk that something will trigger a loop which needs to be prevented
$check = base64_encode($lead->getId().md5(json_encode($details)));
if (in_array($check, $this->preventLoop)) {
return;
}
$this->preventLoop[] = $check;
// Change entry
$log = [
'bundle' => 'lead',
'object' => 'lead',
'objectId' => $lead->getId(),
'action' => ($event->isNew()) ? 'create' : 'update',
'details' => $details,
'ipAddress' => $this->ipLookupHelper->getIpAddressFromRequest(),
];
$this->auditLogModel->writeToLog($log);
// Date identified entry
if (isset($details['dateIdentified'])) {
// log the day lead was identified
$log = [
'bundle' => 'lead',
'object' => 'lead',
'objectId' => $lead->getId(),
'action' => 'identified',
'details' => [],
'ipAddress' => $this->ipLookupHelper->getIpAddressFromRequest(),
];
$this->auditLogModel->writeToLog($log);
}
// IP added entry
if (isset($details['ipAddresses']) && !empty($details['ipAddresses'][1])) {
$log = [
'bundle' => 'lead',
'object' => 'lead',
'objectId' => $lead->getId(),
'action' => 'ipadded',
'details' => $details['ipAddresses'],
'ipAddress' => $this->ipLookupHelper->getIpAddressFromRequest(),
];
$this->auditLogModel->writeToLog($log);
}
$this->leadEventDispatcher->dispatchEvents($event, $details);
}
/**
* Add a lead delete entry to the audit log.
*/
public function onLeadDelete(Events\LeadEvent $event): void
{
$lead = $event->getLead();
$log = [
'bundle' => 'lead',
'object' => 'lead',
'objectId' => $lead->deletedId,
'action' => 'delete',
'details' => ['name' => $lead->getPrimaryIdentifier()],
'ipAddress' => $this->ipLookupHelper->getIpAddressFromRequest(),
];
$this->auditLogModel->writeToLog($log);
}
/**
* Add a field entry to the audit log.
*/
public function onFieldPostSave(Events\LeadFieldEvent $event): void
{
$field = $event->getField();
if ($details = $event->getChanges()) {
$log = [
'bundle' => 'lead',
'object' => 'field',
'objectId' => $field->getId(),
'action' => ($event->isNew()) ? 'create' : 'update',
'details' => $details,
'ipAddress' => $this->ipLookupHelper->getIpAddressFromRequest(),
];
$this->auditLogModel->writeToLog($log);
}
}
/**
* Add a field delete entry to the audit log.
*/
public function onFieldDelete(Events\LeadFieldEvent $event): void
{
$field = $event->getField();
$log = [
'bundle' => 'lead',
'object' => 'field',
'objectId' => $field->deletedId,
'action' => 'delete',
'details' => ['name', $field->getLabel()],
'ipAddress' => $this->ipLookupHelper->getIpAddressFromRequest(),
];
$this->auditLogModel->writeToLog($log);
}
/**
* Add a note entry to the audit log.
*/
public function onNotePostSave(Events\LeadNoteEvent $event): void
{
$note = $event->getNote();
if ($details = $event->getChanges()) {
$log = [
'bundle' => 'lead',
'object' => 'note',
'objectId' => $note->getId(),
'action' => ($event->isNew()) ? 'create' : 'update',
'details' => $details,
'ipAddress' => $this->ipLookupHelper->getIpAddressFromRequest(),
];
$this->auditLogModel->writeToLog($log);
}
}
/**
* Add a note delete entry to the audit log.
*/
public function onNoteDelete(Events\LeadNoteEvent $event): void
{
$note = $event->getNote();
$log = [
'bundle' => 'lead',
'object' => 'note',
'objectId' => $note->deletedId,
'action' => 'delete',
'details' => ['text', $note->getText()],
'ipAddress' => $this->ipLookupHelper->getIpAddressFromRequest(),
];
$this->auditLogModel->writeToLog($log);
}
public function preLeadMerge(Events\LeadMergeEvent $event): void
{
$this->entityManager->getRepository(LeadEventLog::class)->updateLead(
$event->getLoser()->getId(),
$event->getVictor()->getId()
);
}
public function onLeadMerge(Events\LeadMergeEvent $event): void
{
$this->entityManager->getRepository(PointsChangeLog::class)->updateLead(
$event->getLoser()->getId(),
$event->getVictor()->getId()
);
$this->entityManager->getRepository(ListLead::class)->updateLead(
$event->getLoser()->getId(),
$event->getVictor()->getId()
);
$this->entityManager->getRepository(LeadNote::class)->updateLead(
$event->getLoser()->getId(),
$event->getVictor()->getId()
);
$this->entityManager->getRepository(LeadDevice::class)->updateLead(
$event->getLoser()->getId(),
$event->getVictor()->getId()
);
$log = [
'bundle' => 'lead',
'object' => 'lead',
'objectId' => $event->getLoser()->getId(),
'action' => 'merge',
'details' => ['merged_into' => $event->getVictor()->getId()],
'ipAddress' => $this->ipLookupHelper->getIpAddressFromRequest(),
];
$this->auditLogModel->writeToLog($log);
}
/**
* Compile events for the lead timeline.
*/
public function onTimelineGenerate(Events\LeadTimelineEvent $event): void
{
$eventTypes = [
'lead.utmtagsadded' => 'mautic.lead.event.utmtagsadded',
'lead.donotcontact' => 'mautic.lead.event.donotcontact',
'lead.imported' => 'mautic.lead.event.imported',
];
// Following events takes the event from the lead itself, so not applicable for API
// where we are getting events for all leads.
if ($event->isForTimeline()) {
$eventTypes['lead.create'] = 'mautic.lead.event.create';
$eventTypes['lead.identified'] = 'mautic.lead.event.identified';
$eventTypes['lead.ipadded'] = 'mautic.lead.event.ipadded';
$eventTypes['lead.apiadded'] = 'mautic.lead.event.apiadded';
}
$filters = $event->getEventFilters();
// Temporary measure as the other event types don't have tests yet
if ($this->isTest) {
$eventTypes = [
'lead.apiadded' => 'mautic.lead.event.apiadded',
];
}
foreach ($eventTypes as $type => $label) {
$name = $this->translator->trans($label);
$event->addEventType($type, $name);
if (!$event->isApplicable($type) || ('lead.utmtagsadded' != $type && !empty($filters['search']))) {
continue;
}
switch ($type) {
case 'lead.create':
$this->addTimelineDateCreatedEntry($event, $type, $name);
break;
case 'lead.identified':
$this->addTimelineDateIdentifiedEntry($event, $type, $name);
break;
case 'lead.ipadded':
$this->addTimelineIpAddressEntries($event, $type, $name);
break;
case 'lead.utmtagsadded':
$this->addTimelineUtmEntries($event, $type, $name);
break;
case 'lead.donotcontact':
$this->addTimelineDoNotContactEntries($event, $type, $name);
break;
case 'lead.imported':
$this->addTimelineImportedEntries($event, $type, $name);
break;
case 'lead.apiadded':
$this->addTimelineApiCreatedEntries($event, $type, $name);
break;
}
}
}
private function addTimelineIpAddressEntries(Events\LeadTimelineEvent $event, $eventTypeKey, $eventTypeName): void
{
$lead = $event->getLead();
$rows = $this->auditLogModel->getRepository()->getLeadIpLogs($lead, $event->getQueryOptions());
if (!$event->isEngagementCount()) {
// Add to counter
$event->addToCounter($eventTypeKey, $rows);
// Add the entries to the event array
$ipAddresses = ($lead instanceof Lead) ? $lead->getIpAddresses()->toArray() : null;
foreach ($rows['results'] as $row) {
if (null !== $ipAddresses && !isset($ipAddresses[$row['ip_address']])) {
continue;
}
$event->addEvent(
[
'event' => $eventTypeKey,
'eventId' => $eventTypeKey.$row['id'],
'eventLabel' => $row['ip_address'],
'eventType' => $eventTypeName,
'eventPriority' => -1, // Usually an IP is added after another event
'timestamp' => $row['date_added'],
'extra' => [
'ipDetails' => $ipAddresses[$row['ip_address']],
],
'contentTemplate' => '@MauticLead/SubscribedEvents/Timeline/ipadded.html.twig',
'contactId' => $row['lead_id'],
]
);
}
} else {
// Purposively not including this in engagements graph as it's info only
}
}
private function addTimelineDateCreatedEntry(Events\LeadTimelineEvent $event, $eventTypeKey, $eventTypeName): void
{
// Do nothing if the lead is not set
if (!$event->getLead() instanceof Lead) {
return;
}
$dateAdded = $event->getLead()->getDateAdded();
if (!$event->isEngagementCount()) {
$event->addToCounter($eventTypeKey, 1);
$start = $event->getEventLimit()['start'];
if (empty($start)) {
$event->addEvent(
[
'event' => $eventTypeKey,
'eventId' => $eventTypeKey.$event->getLead()->getId(),
'icon' => 'ri-spy-line',
'eventType' => $eventTypeName,
'eventPriority' => -5, // Usually something happened to create the lead so this should display afterward
'timestamp' => $dateAdded,
]
);
}
} else {
// Purposively not including this in engagements graph as it's info only
}
}
/**
* @throws Exception
*/
public function onLeadCompanyChange(LeadChangeCompanyEvent $event): void
{
$leadId = $event->getLead()->getId();
$allowMultipleCompanies = $this->coreParametersHelper->get('contact_allow_multiple_companies');
if ($leadId && !$allowMultipleCompanies) {
$this->companyLeadRepository->removeContactSecondaryCompanies($leadId);
}
}
private function addTimelineDateIdentifiedEntry(Events\LeadTimelineEvent $event, $eventTypeKey, $eventTypeName): void
{
// Do nothing if the lead is not set
if (!$event->getLead() instanceof Lead) {
return;
}
if ($dateIdentified = $event->getLead()->getDateIdentified()) {
if (!$event->isEngagementCount()) {
$event->addToCounter($eventTypeKey, 1);
$start = $event->getEventLimit()['start'];
if (empty($start)) {
$event->addEvent(
[
'event' => $eventTypeKey,
'eventId' => $eventTypeKey.$event->getLead()->getId(),
'icon' => 'ri-user-6-fill',
'eventType' => $eventTypeName,
'eventPriority' => -4, // A lead is created prior to being identified
'timestamp' => $dateIdentified,
'featured' => true,
]
);
}
} else {
// Purposively not including this in engagements graph as it's info only
}
}
}
private function addTimelineUtmEntries(Events\LeadTimelineEvent $event, $eventTypeKey, $eventTypeName): void
{
$utmRepo = $this->entityManager->getRepository(UtmTag::class);
$utmTags = $utmRepo->getUtmTagsByLead($event->getLead(), $event->getQueryOptions());
// Add to counter
$event->addToCounter($eventTypeKey, $utmTags);
if (!$event->isEngagementCount()) {
// Add the logs to the event array
foreach ($utmTags['results'] as $utmTag) {
$icon = 'fa-tag';
if (isset($utmTag['utm_medium'])) {
switch (strtolower($utmTag['utm_medium'])) {
case 'social':
case 'socialmedia':
$icon = 'fa-'.((isset($utmTag['utm_source'])) ? strtolower($utmTag['utm_source']) : 'share-alt');
break;
case 'email':
case 'newsletter':
$icon = 'fa-envelope-o';
break;
case 'banner':
case 'ad':
$icon = 'fa-bullseye';
break;
case 'cpc':
$icon = 'fa-money';
break;
case 'location':
$icon = 'fa-map-marker';
break;
case 'device':
$icon = 'fa-'.((isset($utmTag['utm_source'])) ? strtolower($utmTag['utm_source']) : 'tablet');
break;
}
}
$event->addEvent(
[
'event' => $eventTypeKey,
'eventType' => $eventTypeName,
'eventId' => $eventTypeKey.$utmTag['id'],
'eventLabel' => !empty($utmTag['utm_campaign']) ? $this->translator->trans('mautic.lead.timeline.event.utmcampaign').': '.$utmTag['utm_campaign'] : $eventTypeName,
'timestamp' => $utmTag['date_added'],
'icon' => $icon,
'extra' => [
'utmtags' => $utmTag,
],
'contentTemplate' => '@MauticLead/SubscribedEvents/Timeline/utmadded.html.twig',
'contactId' => $utmTag['lead_id'],
]
);
}
} else {
// Purposively not including this in engagements graph as the engagement is counted by the page hit
}
}
private function addTimelineDoNotContactEntries(Events\LeadTimelineEvent $event, $eventTypeKey, $eventTypeName): void
{
/** @var \Mautic\LeadBundle\Entity\DoNotContactRepository $dncRepo */
$dncRepo = $this->entityManager->getRepository(DoNotContact::class);
$rows = $dncRepo->getTimelineStats($event->getLeadId(), $event->getQueryOptions());
// Add to counter
$event->addToCounter($eventTypeKey, $rows);
if (!$event->isEngagementCount()) {
foreach ($rows['results'] as $row) {
$row['reason'] = $this->dncReasonHelper->toText((int) $row['reason']);
$template = '@MauticLead/SubscribedEvents/Timeline/donotcontact.html.twig';
$icon = 'fa-ban';
if (!empty($row['channel'])) {
if ($channelModel = $this->getChannelModel($row['channel'])) {
if ($channelModel instanceof ChannelTimelineInterface) {
if ($overrideTemplate = $channelModel->getChannelTimelineTemplate($eventTypeKey, $row)) {
$template = $overrideTemplate;
}
if ($overrideEventTypeName = $channelModel->getChannelTimelineLabel($eventTypeKey, $row)) {
$eventTypeName = $overrideEventTypeName;
}
if ($overrideIcon = $channelModel->getChannelTimelineIcon($eventTypeKey, $row)) {
$icon = $overrideIcon;
}
}
if (!empty($row['channel_id'])) {
if ($item = $this->getChannelEntityName($row['channel'], $row['channel_id'], true)) {
$row['itemName'] = $item['name'];
$row['itemRoute'] = $item['url'];
}
}
}
}
$contactId = $row['lead_id'];
unset($row['lead_id']);
$event->addEvent(
[
'event' => $eventTypeKey,
'eventId' => $eventTypeKey.$row['id'],
'eventLabel' => (isset($row['itemName'])) ?
[
'label' => ucfirst($row['channel']).' / '.$row['itemName'],
'href' => $row['itemRoute'],
] : ucfirst($row['channel']),
'eventType' => $eventTypeName,
'timestamp' => $row['date_added'],
'extra' => [
'dnc' => $row,
],
'contentTemplate' => $template,
'icon' => $icon,
'contactId' => $contactId,
]
);
}
}
}
private function addTimelineImportedEntries(Events\LeadTimelineEvent $event, $eventTypeKey, $eventTypeName): void
{
/** @var LeadEventLogRepository $eventLogRepo */
$eventLogRepo = $this->entityManager->getRepository(LeadEventLog::class);
$imports = $eventLogRepo->getEvents(
$event->getLead(),
'lead',
'import',
['failed', 'inserted', 'updated'],
$event->getQueryOptions()
);
// Add to counter
$event->addToCounter($eventTypeKey, $imports);
if (!$event->isEngagementCount()) {
// Add the logs to the event array
foreach ($imports['results'] as $import) {
if (is_string($import['properties'])) {
$import['properties'] = json_decode($import['properties'], true);
}
$eventLabel = 'N/A';
if (!empty($import['properties']['file'])) {
$eventLabel = $import['properties']['file'];
} elseif ($import['object_id']) {
$eventLabel = $import['object_id'];
}
$eventLabel = $this->translator->trans('mautic.lead.import.contact.action.'.$import['action'], ['%name%' => $eventLabel]);
$event->addEvent(
[
'event' => $eventTypeKey,
'eventId' => $eventTypeKey.$import['id'],
'eventType' => $eventTypeName,
'eventLabel' => !empty($import['object_id']) ? [
'label' => $eventLabel,
'href' => $this->router->generate(
'mautic_import_action',
[
'objectAction' => 'view',
'object' => 'contacts',
'objectId' => $import['object_id'],
]
),
] : $eventLabel,
'timestamp' => $import['date_added'],
'icon' => 'ri-download-line',
'extra' => $import,
'contentTemplate' => '@MauticLead/SubscribedEvents/Timeline/import.html.twig',
'contactId' => $import['lead_id'],
]
);
}
} else {
// Purposively not including this
}
}
private function addTimelineApiCreatedEntries(Events\LeadTimelineEvent $event, $eventTypeKey, $eventTypeName): void
{
/** @var LeadEventLogRepository $eventLogRepo */
$eventLogRepo = $this->entityManager->getRepository(LeadEventLog::class);
$apiSingleEvents = $eventLogRepo->getEvents(
$event->getLead(),
'lead',
'api-single',
null,
$event->getQueryOptions()
);
$apiBatchEvents = $eventLogRepo->getEvents(
$event->getLead(),
'lead',
'api-batch',
null,
$event->getQueryOptions()
);
// Add to counter
$event->addToCounter($eventTypeKey, $apiSingleEvents);
$event->addToCounter($eventTypeKey, $apiBatchEvents);
if (!$event->isEngagementCount()) {
$apiEvents = [
'total' => intval($apiSingleEvents['total']) + intval($apiBatchEvents['total']),
'results' => array_merge($apiSingleEvents['results'], $apiBatchEvents['results']),
];
// Add the logs to the event array
foreach ($apiEvents['results'] as $apiEvent) {
$event->addEvent(
[
'event' => $eventTypeKey,
'eventId' => $eventTypeKey.$apiEvent['id'],
'eventType' => $eventTypeName,
'eventLabel' => $eventTypeName,
'timestamp' => $apiEvent['date_added'],
'icon' => 'fa-cogs',
'extra' => $apiEvent,
'contactId' => $apiEvent['lead_id'],
]
);
}
} else {
// Purposively not including this
}
}
}