Merge pull request #1872 from mailchimp/Issue1866-2.1

closes #1866 for magento 2.1
mailchimp · Feb 23, 2024 · bed995c · bed995c
2 parents bba2b73 + 95a1f54
commit bed995c
Show file tree

Hide file tree

Showing 7 changed files with 81 additions and 5 deletions.
diff --git a/Helper/Data.php b/Helper/Data.php
@@ -49,6 +49,7 @@ class Data extends \Magento\Framework\App\Helper\AbstractHelper
     const XML_MAGENTO_MAIL           = 'mailchimp/general/magentoemail';
     const XML_SEND_PROMO             = 'mailchimp/ecommerce/send_promo';
     const XML_INCLUDING_TAXES        = 'mailchimp/ecommerce/including_taxes';
+    const XML_CAMPAIGN_ACTION = 'mailchimp/ecommerce/campaign_action';
     const XML_POPUP_FORM             = 'mailchimp/general/popup_form';
     const XML_POPUP_URL              = 'mailchimp/general/popup_url';
     const XML_CLEAN_ERROR_MONTHS     = 'mailchimp/ecommerce/clean_errors_months';

diff --git a/Model/Api/Order.php b/Model/Api/Order.php
@@ -86,6 +86,7 @@ class Order
     protected $_counter;
 
     protected $_batchId;
+    protected $modifiedOrder = false;
 
     /**
      * @param \Ebizmarts\MailChimp\Helper\Data $helper
@@ -160,6 +161,7 @@ protected function _getModifiedOrders($magentoStoreId)
     {
         $batchArray = [];
         $mailchimpStoreId = $this->_helper->getConfigValue(\Ebizmarts\MailChimp\Helper\Data::XML_MAILCHIMP_STORE, $magentoStoreId);
+        $isSynced = $this->_helper->getConfigValue(\Ebizmarts\MailChimp\Helper\Data::XML_PATH_IS_SYNC, $magentoStoreId);
         $modifiedOrders = $this->_getCollection();
         // select orders for the current Magento store id
         $modifiedOrders->addFieldToFilter('store_id', ['eq' => $magentoStoreId]);
@@ -199,7 +201,11 @@ protected function _getModifiedOrders($magentoStoreId)
                     }
                 }
 
-                $orderJson = $this->GeneratePOSTPayload($order, $mailchimpStoreId, $magentoStoreId, true);
+                $orderJson = $this->GeneratePOSTPayload($order, $mailchimpStoreId, $magentoStoreId, true, $isSynced);
+                if ($this->modifiedOrder) {
+                    $order->save();
+                    $this->modifiedOrder = false;
+                }
                 if ($orderJson!==false) {
                     if (!empty($orderJson)) {
                         $this->_helper->modifyCounter(\Ebizmarts\MailChimp\Helper\Data::ORD_MOD);
@@ -234,6 +240,7 @@ protected function _getNewOrders($magentoStoreId)
     {
         $batchArray = [];
         $mailchimpStoreId = $this->_helper->getConfigValue(\Ebizmarts\MailChimp\Helper\Data::XML_MAILCHIMP_STORE, $magentoStoreId);
+        $isSynced = $this->_helper->getConfigValue(\Ebizmarts\MailChimp\Helper\Data::XML_PATH_IS_SYNC, $magentoStoreId);
         $newOrders = $this->_getCollection();
         // select carts for the current Magento store id
         $newOrders->addFieldToFilter('store_id', ['eq' => $magentoStoreId]);
@@ -276,7 +283,11 @@ protected function _getNewOrders($magentoStoreId)
                         $this->_counter++;
                     }
                 }
-                $orderJson = $this->GeneratePOSTPayload($order, $mailchimpStoreId, $magentoStoreId);
+                $orderJson = $this->GeneratePOSTPayload($order, $mailchimpStoreId, $magentoStoreId, false, $isSynced);
+                if ($this->modifiedOrder) {
+                    $order->save();
+                    $this->modifiedOrder = false;
+                }
                 if ($orderJson!==false) {
                     if (!empty($orderJson)) {
                         $this->_helper->modifyCounter(\Ebizmarts\MailChimp\Helper\Data::ORD_NEW);
@@ -316,12 +327,19 @@ protected function _getNewOrders($magentoStoreId)
      * @return string
      * @throws \Exception
      */
-    protected function GeneratePOSTPayload(\Magento\Sales\Model\Order $order, $mailchimpStoreId, $magentoStoreId, $isModifiedOrder = false)
+    protected function GeneratePOSTPayload(\Magento\Sales\Model\Order $order, $mailchimpStoreId, $magentoStoreId, $isModifiedOrder, $isSynced)
     {
         $data = [];
         $data['id'] = $order->getIncrementId();
         if ($order->getMailchimpCampaignId()) {
             $data['campaign_id'] = $order->getMailchimpCampaignId();
+        } elseif ($isSynced) {
+            if ($campaignId = $this->getCampaign($magentoStoreId, $order->getCustomerEmail())) {
+                $data['campaign_id'] = $campaignId;
+                $order->setMailchimpCampaignId($campaignId);
+                $order->setMailchimpFlag(1);
+                $this->modifiedOrder = true;
+            }
         }
 
         if ($order->getMailchimpLandingPage()) {
@@ -721,7 +739,26 @@ protected function _getPromoData(\Magento\Sales\Model\Order $order)
         }
         return $promo;
     }
-
+    protected function getCampaign($store, $email)
+    {
+        $campaign_id = null;
+        $api = $this->_helper->getApi($store);
+        $actions = $this->_helper->getConfigValue(\Ebizmarts\MailChimp\Helper\Data::XML_CAMPAIGN_ACTION, $store);
+        try {
+            $activity = $api->lists->members->memberActivity->get($this->_helper->getDefaultList($store), md5($email), null, null, $actions);
+            if ($activity) {
+                foreach ($activity['activity'] as $act) {
+                    if (key_exists('action', $act) && key_exists('campaign_id', $act) && $act['campaign_id']) {
+                        $campaign_id = $act['campaign_id'];
+                        break;
+                    }
+                }
+            }
+        } catch (\Mailchimp_Error $e) {
+            $this->_helper->log("No activity for $email");
+        }
+        return $campaign_id;
+    }
     protected function _updateOrder($storeId, $entityId, $sync_delta = null, $sync_error = null, $sync_modified = null)
     {
         if (!empty($sync_error)) {

diff --git a/Model/Config/Source/CampaignAction.php b/Model/Config/Source/CampaignAction.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace Ebizmarts\MailChimp\Model\Config\Source;
+
+class CampaignAction implements \Magento\Framework\Option\ArrayInterface
+{
+    private $actions = [
+        ['value' => 'sent', 'label' => 'Sent'],
+        ['value' => 'open', 'label' => 'Open'],
+        ['value' => 'click', 'label' => 'Click']
+    ];
+    public function toOptionArray()
+    {
+        return $this->actions;
+    }
+}
diff --git a/composer.json b/composer.json
@@ -25,7 +25,7 @@
   },
   "require" : {
     "magento/framework": "100.1.*",
-    "ebizmarts/mailchimp-lib": ">=3.0.37",
+    "ebizmarts/mailchimp-lib": ">=3.0.38",
     "ext-json": "*"
   }
 }
diff --git a/etc/adminhtml/system.xml b/etc/adminhtml/system.xml
@@ -222,6 +222,16 @@
                         <field id="*/*/active">1</field>
                     </depends>
                 </field>
+                <field id="campaign_action" translate="label" type="multiselect" sortOrder="155" showInDefault="1" showInWebsite="1" showInStore="1">
+                    <label>Campaign Attribution Action</label>
+                    <source_model>Ebizmarts\MailChimp\Model\Config\Source\CampaignAction</source_model>
+                    <can_be_empty>1</can_be_empty>
+                    <size>3</size>
+                    <depends>
+                        <field id="*/*/active">1</field>
+                    </depends>
+                    <comment>Order attribution based on customer actions</comment>
+                </field>
                 <field id="reset_errors_retry" translate="button_label" type="button" sortOrder="160" showInDefault="1" showInWebsite="1" showInStore="1">
                     <button_label>Reset Errors and retry</button_label>
                     <frontend_model>Ebizmarts\MailChimp\Block\Adminhtml\System\Config\ResetErrors</frontend_model>

diff --git a/etc/config.xml b/etc/config.xml
@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Store:etc/config.xsd">
+    <default>
+        <mailchimp>
+            <ecommerce>
+                <campaign_action>sent,open,click</campaign_action>
+            </ecommerce>
+        </mailchimp>
+    </default>
+</config>
diff --git a/view/adminhtml/web/js/configapikey.js b/view/adminhtml/web/js/configapikey.js
@@ -85,6 +85,7 @@ define(
                 if (ecommerceEnabled == 0 && abandonedCartEnabled == 1) {
                     self._changeAbandonedCart();
                 }
+                $('#mailchimp_ecommerce_campaign_action').attr('size',3);
             },
             _changeEcommerce: function () {
                 var self = this;