add check customer cookie

Author: ihormandzyuk

Block/Adminhtml/System/Config/Form/ProtectCustomerData.php

@@ -0,0 +1,33 @@
+<?php
+/**
+ * Copyright © Magefan ([email protected]). All rights reserved.
+ * Please visit Magefan.com for license details (https://magefan.com/end-user-license-agreement).
+ */
+
+declare(strict_types=1);
+
+namespace Magefan\GoogleTagManager\Block\Adminhtml\System\Config\Form;
+
+use Magento\Config\Block\System\Config\Form\Field;
+use Magento\Framework\Data\Form\Element\AbstractElement;
+
+class ProtectCustomerData extends Field
+{
+    /**
+     * Render protect customer data
+     *
+     * @param  AbstractElement $element
+     * @return string
+     */
+    public function render(AbstractElement $element): string
+    {
+        $url = $this->getUrl('*/*/*/section/web');
+        $comment = 'When enabled, data won\'t be sent to Google, until the customer allows cookies.<br/><br/>
+            <strong>Note</strong>, that this option will work only when Cookie Restriction Mode at 
+            <a href="' . $url . '" target="_blank">Stores > Configuration > General > Web > Default Cookie Settings</a>
+             is enabled.';
+
+        $element->setComment($comment);
+        return parent::render($element);
+    }
+}

Block/GtmCode.php

@@ -8,6 +8,7 @@
 
 namespace Magefan\GoogleTagManager\Block;
 
+use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Framework\View\Element\Template;
 use Magefan\GoogleTagManager\Model\Config;
 
@@ -44,6 +45,27 @@ public function getPublicId(): string
         return $this->config->getPublicId();
     }
 
+    /**
+     * Check if protect customer data is enabled
+     *
+     * @return bool
+     */
+    public function isProtectCustomerDataEnabled(): bool
+    {
+        return $this->config->isProtectCustomerDataEnabled();
+    }
+
+    /**
+     * Get current website ID
+     *
+     * @return int
+     * @throws NoSuchEntityException
+     */
+    public function getWebsiteId(): int
+    {
+        return (int)$this->_storeManager->getStore()->getWebsiteId();
+    }
+
     /**
      * Init GTM datalayer
      *

Model/Config.php

@@ -10,6 +10,7 @@
 
 use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Store\Model\ScopeInterface;
+use Magento\Config\Model\Config\Backend\Admin\Custom;
 
 class Config
 {
@@ -33,6 +34,11 @@ class Config
     public const XML_PATH_ATTRIBUTES_PRODUCT = 'mfgoogletagmanager/attributes/product';
     public const XML_PATH_ATTRIBUTES_BRAND = 'mfgoogletagmanager/attributes/brand';
 
+    /**
+     * Customer data protection regulation config
+     */
+    public const XML_PATH_PROTECT_CUSTOMER_DATA = 'mfgoogletagmanager/customer_data/protect';
+
     /**
      * @var ScopeConfigInterface
      */
@@ -138,6 +144,29 @@ public function getBrandAttribute(string $storeId = null): string
         return (string)$this->getConfig(self::XML_PATH_ATTRIBUTES_BRAND, $storeId);
     }
 
+    /**
+     * Retrieve true if protect customer data is enabled
+     *
+     * @param string|null $storeId
+     * @return bool
+     */
+    public function isProtectCustomerDataEnabled(string $storeId = null): bool
+    {
+        return (bool)$this->getConfig(self::XML_PATH_PROTECT_CUSTOMER_DATA, $storeId) &&
+            $this->isCookieRestrictionModeEnabled($storeId);
+    }
+
+    /**
+     * Retrieve true if cookie restriction mode enabled
+     *
+     * @param string|null $storeId
+     * @return bool
+     */
+    public function isCookieRestrictionModeEnabled(string $storeId = null)
+    {
+        return (bool)$this->getConfig(Custom::XML_PATH_WEB_COOKIE_RESTRICTION, $storeId);
+    }
+
     /**
      * Retrieve store config value
      *

etc/adminhtml/system.xml

@@ -104,6 +104,14 @@ height="0" width="0" style="display:none;visibility:hid
                     <frontend_model>Magefan\GoogleTagManager\Block\Adminhtml\System\Config\Form\Button</frontend_model>
                 </field>
             </group>
+            <group id="customer_data" translate="label" type="text" sortOrder="80" showInDefault="1" showInWebsite="1" showInStore="1">
+                <label>GDPR/CCPA/LGPD (Customer Data Protection Regulation)</label>
+                <field id="protect" translate="label comment" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
+                    <label>Protect Customer Data</label>
+                    <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
+                    <frontend_model>Magefan\GoogleTagManager\Block\Adminhtml\System\Config\Form\ProtectCustomerData</frontend_model>
+                </field>
+            </group>
         </section>
     </system>
 </config>

etc/config.xml

@@ -24,6 +24,9 @@
                 <product>sku</product>
                 <brand/>
             </attributes>
+            <customer_data>
+                <protect>1</protect>
+            </customer_data>
         </mfgoogletagmanager>
     </default>
 </config>

view/frontend/templates/js_code.phtml

@@ -13,9 +13,63 @@ if (!isset($escaper)) {
 }
 ?>
 <!-- Google Tag Manager -->
-<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
-            new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
-        j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
-        'https:<?= '/' . '/' ?>www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
-    })(window,document,'script','dataLayer','<?= $escaper->escapeHtml($block->getPublicId()) ?>');</script>
-<!-- End Google Tag Manager -->
+<script>
+    function mfLoadGtm() {
+        (function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
+                new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
+            j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
+            'https:<?= '/' . '/' ?>www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+        })(window,document,'script','dataLayer','<?= $escaper->escapeHtml($block->getPublicId()) ?>');
+    }
+
+    <?php if ($block->isProtectCustomerDataEnabled()) { ?>
+    document.addEventListener('DOMContentLoaded', function () {
+        function getCookieValue(cookieName) {
+            let name = cookieName + '=';
+            let cookieSplit = document.cookie.split(';');
+
+            for (let i = 0; i < cookieSplit.length; i++) {
+                let a = cookieSplit[i];
+
+                while (a.charAt(0) === ' ') {
+                    a = a.substring(1);
+                }
+
+                if (a.indexOf(name) === 0) {
+                    return a.substring(name.length, a.length);
+                }
+            }
+            return '';
+        }
+
+        function customerDataAllowed() {
+            let cookie = getCookieValue(
+                '<?= $escaper->escapeHtml(\Magento\Cookie\Helper\Cookie::IS_USER_ALLOWED_SAVE_COOKIE) ?>'
+            );
+            if (cookie) {
+                cookie = JSON.parse(decodeURIComponent(cookie));
+                if (cookie[<?= $escaper->escapeHtml($block->getWebsiteId()) ?>]) {
+                    return true;
+                }
+            }
+
+            return false
+        }
+
+        if (customerDataAllowed()) {
+            mfLoadGtm();
+        } else {
+            let interval = setInterval(function () {
+                if (!customerDataAllowed()) return;
+                clearInterval(interval);
+                mfLoadGtm();
+            }, 1000);
+        }
+    });
+
+    <?php } else { ?>
+    mfLoadGtm();
+    <?php } ?>
+
+</script>
+<!-- End Google Tag Manager -->

view/frontend/templates/no_js_code.phtml

@@ -13,6 +13,8 @@ if (!isset($escaper)) {
 }
 ?>
 <!-- Google Tag Manager (noscript) -->
+<?php if (!$block->isProtectCustomerDataEnabled()) { ?>
 <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=<?= $escaper->escapeHtml($block->getPublicId()) ?>"
                   height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
+<?php } ?>
 <!-- End Google Tag Manager (noscript) -->