Tracking lead manipulator

app/bundles/FormBundle/Model/SubmissionModel.php

@@ -34,6 +34,7 @@
 use Mautic\FormBundle\Helper\FormFieldHelper;
 use Mautic\FormBundle\Helper\FormUploader;
 use Mautic\FormBundle\Validator\UploadFieldValidator;
+use Mautic\LeadBundle\DataObject\LeadManipulator;
 use Mautic\LeadBundle\Entity\Company;
 use Mautic\LeadBundle\Entity\CompanyChangeLog;
 use Mautic\LeadBundle\Entity\Lead;
@@ -1004,6 +1005,11 @@ protected function createLeadFromSubmit(Form $form, array $leadFieldMatches, $le
         $lead->setLastActive(new \DateTime());
 
         //create a new lead
+        $lead->setManipulator(new LeadManipulator(
+            'form',
+            'submission',
+            $form->getId()
+        ));
         $this->leadModel->saveEntity($lead, false);
 
         if (!$inKioskMode) {

app/bundles/LeadBundle/Controller/LeadController.php

@@ -14,6 +14,7 @@
 use Mautic\CoreBundle\Controller\FormController;
 use Mautic\CoreBundle\Helper\EmojiHelper;
 use Mautic\CoreBundle\Model\IteratorExportDataModel;
+use Mautic\LeadBundle\DataObject\LeadManipulator;
 use Mautic\LeadBundle\Entity\DoNotContact;
 use Mautic\LeadBundle\Entity\Lead;
 use Mautic\LeadBundle\Model\LeadModel;
@@ -441,6 +442,10 @@ public function newAction()
                     $model->setFieldValues($lead, $data, true);
 
                     //form is valid so process the data
+                    $lead->setManipulator(new LeadManipulator(
+                        'lead',
+                        'lead'
+                    ));
                     $model->saveEntity($lead);
 
                     if (!empty($companies)) {
@@ -622,6 +627,11 @@ public function editAction($objectId, $ignorePost = false)
                     $model->setFieldValues($lead, $data, true);
 
                     //form is valid so process the data
+                    $lead->setManipulator(new LeadManipulator(
+                        'lead',
+                        'lead',
+                        $objectId
+                    ));
                     $model->saveEntity($lead, $form->get('buttons')->get('save')->isClicked());
                     $model->modifyCompanies($lead, $companies);
 

app/bundles/LeadBundle/DataObject/LeadManipulator.php

@@ -0,0 +1,65 @@
+<?php
+
+/*
+ * @copyright   2014 Mautic Contributors. All rights reserved
+ * @author      Mautic
+ *
+ * @link        http://mautic.org
+ *
+ * @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
+ */
+
+namespace Mautic\LeadBundle\DataObject;
+
+/**
+ * Class LeadManipulator.
+ */
+class LeadManipulator
+{
+    /** @var string|null */
+    private $bundleName;
+
+    /** @var string|null */
+    private $objectName;
+
+    /** @var int|null */
+    private $objectId;
+
+    /**
+     * LeadManipulator constructor.
+     *
+     * @param string|null $bundleName
+     * @param string|null $objectName
+     * @param int|null    $objectId
+     */
+    public function __construct($bundleName = null, $objectName = null, $objectId = null)
+    {
+        $this->bundleName = $bundleName;
+        $this->objectName = $objectName;
+        $this->objectId   = $objectId;
+    }
+
+    /**
+     * @return string
+     */
+    public function getBundleName()
+    {
+        return $this->bundleName;
+    }
+
+    /**
+     * @return string
+     */
+    public function getObjectName()
+    {
+        return $this->objectName;
+    }
+
+    /**
+     * @return int
+     */
+    public function getObjectId()
+    {
+        return $this->objectId;
+    }
+}

app/bundles/LeadBundle/Entity/Lead.php

@@ -17,6 +17,7 @@
 use Mautic\CoreBundle\Doctrine\Mapping\ClassMetadataBuilder;
 use Mautic\CoreBundle\Entity\FormEntity;
 use Mautic\CoreBundle\Entity\IpAddress;
+use Mautic\LeadBundle\DataObject\LeadManipulator;
 use Mautic\LeadBundle\Model\FieldModel;
 use Mautic\NotificationBundle\Entity\PushID;
 use Mautic\StageBundle\Entity\Stage;
@@ -199,6 +200,9 @@ class Lead extends FormEntity implements CustomFieldEntityInterface
      */
     private $color;
 
+    /** @var LeadManipulator */
+    private $manipulator = null;
+
     /**
      * Sets if the IP was just created by LeadModel::getCurrentLead().
      *
@@ -1286,6 +1290,26 @@ protected function getFirstSocialIdentity()
         return false;
     }
 
+    /**
+     * @param LeadManipulator|null $manipulator
+     *
+     * @return self
+     */
+    public function setManipulator(LeadManipulator $manipulator = null)
+    {
+        $this->manipulator = $manipulator;
+
+        return $this;
+    }
+
+    /**
+     * @return LeadManipulator|null
+     */
+    public function getManipulator()
+    {
+        return $this->manipulator;
+    }
+
     /**
      * @return bool
      */

app/bundles/LeadBundle/Entity/LeadEventLogRepository.php

@@ -115,6 +115,21 @@ public function getEventsByLead($bundle, $object, Lead $lead = null, array $opti
         return $this->getTimelineResults($qb, $options, $alias.'.original_file', $alias.'.date_added', ['query'], ['date_added']);
     }
 
+    /**
+     * Updates lead ID (e.g. after a lead merge).
+     *
+     * @param int $fromLeadId
+     * @param int $toLeadId
+     */
+    public function updateLead($fromLeadId, $toLeadId)
+    {
+        $q = $this->_em->getConnection()->createQueryBuilder();
+        $q->update(MAUTIC_TABLE_PREFIX.'lead_event_log')
+            ->set('lead_id', (int) $toLeadId)
+            ->where('lead_id = '.(int) $fromLeadId)
+            ->execute();
+    }
+
     /**
      * Defines default table alias for lead_event_log table.
      *

app/bundles/LeadBundle/EventListener/LeadSubscriber.php

@@ -58,6 +58,7 @@ public static function getSubscribedEvents()
         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],
@@ -247,6 +248,17 @@ public function onNoteDelete(Events\LeadNoteEvent $event)
         $this->auditLogModel->writeToLog($log);
     }
 
+    /**
+     * @param Events\LeadMergeEvent $event
+     */
+    public function preLeadMerge(Events\LeadMergeEvent $event)
+    {
+        $this->em->getRepository('MauticLeadBundle:LeadEventLog')->updateLead(
+            $event->getLoser()->getId(),
+            $event->getVictor()->getId()
+        );
+    }
+
     /**
      * @param Events\LeadMergeEvent $event
      */

app/bundles/LeadBundle/Model/LeadModel.php

@@ -28,6 +28,7 @@
 use Mautic\CoreBundle\Helper\PathsHelper;
 use Mautic\CoreBundle\Model\FormModel;
 use Mautic\EmailBundle\Helper\EmailValidator;
+use Mautic\LeadBundle\DataObject\LeadManipulator;
 use Mautic\LeadBundle\Entity\Company;
 use Mautic\LeadBundle\Entity\CompanyChangeLog;
 use Mautic\LeadBundle\Entity\DoNotContact;
@@ -497,6 +498,21 @@ public function saveEntity($entity, $unlock = true)
                 $entity->addCompanyChangeLogEntry('form', 'Identify Company', 'Lead added to the company, '.$company['companyname'], $company['id']);
             }
         }
+        $manipulator = $entity->getManipulator();
+        if ($manipulator !== null) {
+            $manipulationLog = new LeadEventLog();
+            $manipulationLog->setLead($entity);
+            $manipulationLog->setBundle($manipulator->getBundleName());
+            $manipulationLog->setObject($manipulator->getObjectName());
+            $manipulationLog->setObjectId($manipulator->getObjectId());
+            if ($entity->isNewlyCreated()) {
+                $manipulationLog->setAction('create');
+            } else {
+                $manipulationLog->setAction('identified');
+            }
+            $entity->addEventLog($manipulationLog);
+            $entity->setManipulator(null);
+        }
 
         $this->setEntityDefaultValues($entity);
 
@@ -1906,6 +1922,10 @@ public function import($fields, $data, $owner = null, $list = null, $tags = null
         }
 
         if ($persist) {
+            $lead->setManipulator(new LeadManipulator(
+                'lead',
+                'lead'
+            ));
             $this->saveEntity($lead);
 
             if ($list !== null) {
@@ -2911,6 +2931,10 @@ protected function createNewContact(IpAddress $ip, $persist = true)
         if ($persist) {
             // Set to prevent loops
             $this->currentLead = $lead;
+            $lead->setManipulator(new LeadManipulator(
+                'lead',
+                'lead'
+            ));
             $this->saveEntity($lead, false);
 
             $fields = $this->getLeadDetails($lead);

app/bundles/PageBundle/Model/PageModel.php

@@ -24,6 +24,7 @@
 use Mautic\CoreBundle\Model\FormModel;
 use Mautic\CoreBundle\Model\TranslationModelTrait;
 use Mautic\CoreBundle\Model\VariantModelTrait;
+use Mautic\LeadBundle\DataObject\LeadManipulator;
 use Mautic\LeadBundle\Entity\Lead;
 use Mautic\LeadBundle\Entity\LeadDevice;
 use Mautic\LeadBundle\Entity\UtmTag;
@@ -469,6 +470,11 @@ public function hitPage($page, Request $request, $code = '200', Lead $lead = nul
             // Lead came from a non-trackable IP so ignore
             return;
         }
+        $lead->setManipulator(new LeadManipulator(
+            'page',
+            $page instanceof Page ? 'page' : 'redirect',
+            $page->getId()
+        ));
         $this->leadModel->saveEntity($lead);
 
         $ipAddress                                 = $this->ipLookupHelper->getIpAddress();

app/bundles/PluginBundle/Integration/AbstractIntegration.php

@@ -19,6 +19,7 @@
 use Mautic\CoreBundle\Helper\EncryptionHelper;
 use Mautic\CoreBundle\Helper\PathsHelper;
 use Mautic\CoreBundle\Model\NotificationModel;
+use Mautic\LeadBundle\DataObject\LeadManipulator;
 use Mautic\LeadBundle\Entity\DoNotContact;
 use Mautic\LeadBundle\Entity\Lead;
 use Mautic\LeadBundle\Model\CompanyModel;
@@ -2065,6 +2066,10 @@ public function getMauticLead($data, $persist = true, $socialCache = null, $iden
         if ($persist && !empty($lead->getChanges(true))) {
             // Only persist if instructed to do so as it could be that calling code needs to manipulate the lead prior to executing event listeners
             try {
+                $lead->setManipulator(new LeadManipulator(
+                    'plugin',
+                    $this->getName()
+                ));
                 $leadModel->saveEntity($lead, false);
             } catch (\Exception $exception) {
                 $this->logger->addWarning($exception->getMessage());

plugins/MauticCrmBundle/Integration/CrmAbstractIntegration.php

@@ -11,6 +11,7 @@
 
 namespace MauticPlugin\MauticCrmBundle\Integration;
 
+use Mautic\LeadBundle\DataObject\LeadManipulator;
 use Mautic\LeadBundle\Entity\Company;
 use Mautic\LeadBundle\Entity\Lead;
 use Mautic\LeadBundle\Helper\IdentifyCompanyHelper;
@@ -460,6 +461,10 @@ public function getMauticLead($data, $persist = true, $socialCache = null, $iden
 
         if ($persist && !empty($lead->getChanges(true))) {
             // Only persist if instructed to do so as it could be that calling code needs to manipulate the lead prior to executing event listeners
+            $lead->setManipulator(new LeadManipulator(
+                'plugin',
+                $this->getName()
+            ));
             $leadModel->saveEntity($lead, false);
         }
 

plugins/MauticCrmBundle/Integration/HubspotIntegration.php

@@ -13,6 +13,7 @@
 namespace MauticPlugin\MauticCrmBundle\Integration;
 
 use Mautic\CoreBundle\Helper\UserHelper;
+use Mautic\LeadBundle\DataObject\LeadManipulator;
 use Mautic\LeadBundle\Entity\Lead;
 use Mautic\LeadBundle\Entity\StagesChangeLog;
 use Mautic\PluginBundle\Entity\IntegrationEntityRepository;
@@ -483,6 +484,10 @@ public function getMauticLead($data, $persist = true, $socialCache = null, $iden
             if ($persist && !empty($lead->getChanges(true))) {
                 // Only persist if instructed to do so as it could be that calling code needs to manipulate the lead prior to executing event listeners
                 try {
+                    $lead->setManipulator(new LeadManipulator(
+                        'plugin',
+                        $this->getName()
+                    ));
                     $this->leadModel->saveEntity($lead, false);
                     if (isset($company)) {
                         $this->leadModel->addToCompany($lead, $company);