Dev 1111 video blocking feature

Model/Config.php

@@ -14,6 +14,7 @@ class Config
     public const XML_PATH_DATA_CULTURE = 'web/cookiebot/data_culture';
     public const XML_PATH_USE_EU_CDN = 'web/cookiebot/use_eu_cdn';
     public const XML_PATH_USE_GOOGLE_CONSENT_MODE = 'web/cookiebot/use_google_consent_mode';
+    public const XML_PATH_BLOCK_VIDEOS_UNTIL_CONSENT = 'web/cookiebot/block_videos_until_consent';
 
     /**
      * @var ScopeConfigInterface
@@ -49,4 +50,9 @@ public function isGoogleConsentModeEnabled(): bool
     {
         return $this->scopeConfig->isSetFlag(self::XML_PATH_USE_GOOGLE_CONSENT_MODE, ScopeInterface::SCOPE_STORE);
     }
+
+    public function isBlockVideosUntilConsentEnabled(): bool
+    {
+        return $this->scopeConfig->isSetFlag(self::XML_PATH_BLOCK_VIDEOS_UNTIL_CONSENT, ScopeInterface::SCOPE_STORE);
+    }
 }

Model/ExternalVideoReplacer.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CustomGento\Cookiebot\Model;
+
+class ExternalVideoReplacer
+{
+    public function replaceIframeSources(string $content): string
+    {
+        $iframePatterns = [
+            // YouTube patterns
+            '/<iframe([^>]*)\s+src=["\'](https?:\/\/(?:www\.)?(?:youtube\.com|youtube-nocookie\.com)\/embed\/[^"\']+)["\']([^>]*)>/i',
+            '/<iframe([^>]*)\s+src=["\'](https?:\/\/(?:www\.)?youtu\.be\/[^"\']+)["\']([^>]*)>/i',
+            // Vimeo patterns
+            '/<iframe([^>]*)\s+src=["\'](https?:\/\/(?:www\.)?vimeo\.com\/[^"\']+)["\']([^>]*)>/i',
+            '/<iframe([^>]*)\s+src=["\'](https?:\/\/(?:www\.)?player\.vimeo\.com\/[^"\']+)["\']([^>]*)>/i'
+        ];
+
+        foreach ($iframePatterns as $pattern) {
+            $content = preg_replace_callback($pattern, function (array $matches) {
+                $beforeSrc = $matches[1];
+                $iframeUrl = $matches[2];
+                $afterSrc  = $matches[3];
+
+                // Check if data-cookieconsent already exists
+                if (preg_match('/data-cookieconsent=["\'][^"\']*["\']/', $beforeSrc . $afterSrc)) {
+                    // If data-cookieconsent already exists, just change src to data-cookieblock-src
+                    return '<iframe' . $beforeSrc . ' data-cookieblock-src="' . $iframeUrl . '"' . $afterSrc . '>';
+                }
+
+                return '<iframe' . $beforeSrc . ' data-cookieblock-src="' . $iframeUrl
+                    . '" data-cookieconsent="marketing"' . $afterSrc . '>';
+            }, $content);
+        }
+
+        return $content;
+    }
+}

Observer/HtmlContentFilterObserver.php

@@ -0,0 +1,59 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CustomGento\Cookiebot\Observer;
+
+use CustomGento\Cookiebot\Model\Config;
+use CustomGento\Cookiebot\Model\ExternalVideoReplacer;
+use Exception;
+use Magento\Framework\App\Response\Http;
+use Magento\Framework\Event\Observer;
+use Magento\Framework\Event\ObserverInterface;
+use Psr\Log\LoggerInterface;
+
+class HtmlContentFilterObserver implements ObserverInterface
+{
+    private LoggerInterface $logger;
+
+    private Config $config;
+
+    private ExternalVideoReplacer $externalVideoReplacer;
+
+    public function __construct(
+        LoggerInterface $logger,
+        Config $config,
+        ExternalVideoReplacer $externalVideoReplacer
+    ) {
+        $this->externalVideoReplacer = $externalVideoReplacer;
+        $this->config                = $config;
+        $this->logger                = $logger;
+    }
+
+    public function execute(Observer $observer): void
+    {
+        if (!$this->config->isBlockVideosUntilConsentEnabled()) {
+            return;
+        }
+
+        try {
+            $response = $observer->getData('response');
+
+            if (!$response instanceof Http) {
+                return;
+            }
+
+            $content = $response->getBody();
+
+            if (empty($content) || !is_string($content)) {
+                return;
+            }
+
+            $modifiedContent = $this->externalVideoReplacer->replaceIframeSources($content);
+
+            $response->setBody($modifiedContent);
+        } catch (Exception $e) {
+            $this->logger->error('Error in HtmlContentFilterObserver: ' . $e->getMessage());
+        }
+    }
+}

README.md

@@ -1,23 +1,37 @@
 # CustomGento_Cookiebot
-This Magento 2 module integrates Cookiebot into your store. This is useful to give the customer the possibility to block unwanted cookies and only allow wanted cookies. It requires an active Cookiebot subscription and can be completely configured in your Cookiebot account. 
+
+This Magento 2 module integrates Cookiebot into your store. This is useful to give the customer the possibility to block
+unwanted cookies and only allow wanted cookies. It requires an active Cookiebot subscription and can be completely
+configured in your Cookiebot account.
 
 ## Installation
+
 - `composer require customgento/module-cookiebot-m2`
 - `bin/magento module:enable CustomGento_Cookiebot`
 - `bin/magento setup:upgrade`
 - `bin/magento setup:di:compile`
 - `bin/magento cache:flush`
 
 ## Configuration
-After installing the extension, just go to Stores > Configuration > Web > Cookiebot Settings to enable Cookiebot and enter your Cookiebot ID. You find the ID in your Cookiebot account under Settings > Your scripts. All other configuration regarding the cookie overlay is done in your Cookiebot account.
 
-Please mind that this extension uses the manual cookie blocking mode. Hence, you still need to update all scripts, which set not-strictly-necessary cookies in your system as described in the [Cookiebot manual implementation guide](https://www.cookiebot.com/en/manual-implementation/).
+After installing the extension, just go to Stores > Configuration > Web > Cookiebot Settings to enable Cookiebot and
+enter your Cookiebot ID. You find the ID in your Cookiebot account under Settings > Your scripts. All other
+configuration regarding the cookie overlay is done in your Cookiebot account.
+
+Please mind that this extension uses the manual cookie blocking mode. Hence, you still need to update all scripts, which
+set not-strictly-necessary cookies in your system as described in
+the [Cookiebot manual implementation guide](https://www.cookiebot.com/en/manual-implementation/).
 
 ## Manual vs. Automatic Cookie Blocking
-Unfortunately, Cookiebot currently does not support automatic blocking when RequireJS is used as stated in their [docs](https://support.cookiebot.com/hc/en-us/articles/360015039559-Installing-Cookiebot-in-Magento-2-3-4). Since Magento 2 does use RequireJS, we need to use the manual cookie blocking mode :-(
+
+Unfortunately, Cookiebot currently does not support automatic blocking when RequireJS is used as stated in
+their [docs](https://support.cookiebot.com/hc/en-us/articles/360015039559-Installing-Cookiebot-in-Magento-2-3-4). Since
+Magento 2 does use RequireJS, we need to use the manual cookie blocking mode :-(
 
 ## Disclaimer
+
 You need a [Cookiebot](https://www.cookiebot.com/) account, so that this extension does anything useful for you.
 
 ## Copyright
+
 © 2020 - present CustomGento GmbH

Test/Unit/Model/ExternalVideoReplacerTest.php

@@ -0,0 +1,124 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CustomGento\Cookiebot\Test\Unit\Model;
+
+use CustomGento\Cookiebot\Model\ExternalVideoReplacer;
+use PHPUnit\Framework\TestCase;
+
+class ExternalVideoReplacerTest extends TestCase
+{
+    /**
+     * @var ExternalVideoReplacer
+     */
+    private $externalVideoReplacer;
+
+    protected function setUp(): void
+    {
+        $this->externalVideoReplacer = new ExternalVideoReplacer();
+    }
+
+    /**
+     * @dataProvider iframeDataProvider
+     */
+    public function testReplaceIframeSources(string $input, string $expected): void
+    {
+        $result = $this->externalVideoReplacer->replaceIframeSources($input);
+        $this->assertEquals($expected, $result);
+    }
+
+    public function iframeDataProvider(): array
+    {
+        return [
+            // YouTube test cases
+            'youtube.com embed'                              => [
+                '<iframe src="https://www.youtube.com/embed/dQw4w9WgXcQ" width="560" height="315"></iframe>',
+                '<iframe data-cookieblock-src="https://www.youtube.com/embed/dQw4w9WgXcQ" data-cookieconsent="marketing" width="560" height="315"></iframe>'
+            ],
+            'youtube-nocookie.com embed'                     => [
+                '<iframe src="https://www.youtube-nocookie.com/embed/dQw4w9WgXcQ" width="560" height="315"></iframe>',
+                '<iframe data-cookieblock-src="https://www.youtube-nocookie.com/embed/dQw4w9WgXcQ" data-cookieconsent="marketing" width="560" height="315"></iframe>'
+            ],
+            'youtu.be URL'                                   => [
+                '<iframe src="https://youtu.be/dQw4w9WgXcQ" width="560" height="315"></iframe>',
+                '<iframe data-cookieblock-src="https://youtu.be/dQw4w9WgXcQ" data-cookieconsent="marketing" width="560" height="315"></iframe>'
+            ],
+            'youtube.com without www'                        => [
+                '<iframe src="https://youtube.com/embed/dQw4w9WgXcQ" width="560" height="315"></iframe>',
+                '<iframe data-cookieblock-src="https://youtube.com/embed/dQw4w9WgXcQ" data-cookieconsent="marketing" width="560" height="315"></iframe>'
+            ],
+            'youtube-nocookie.com without www'               => [
+                '<iframe src="https://youtube-nocookie.com/embed/dQw4w9WgXcQ" width="560" height="315"></iframe>',
+                '<iframe data-cookieblock-src="https://youtube-nocookie.com/embed/dQw4w9WgXcQ" data-cookieconsent="marketing" width="560" height="315"></iframe>'
+            ],
+            'youtu.be without www'                           => [
+                '<iframe src="https://youtu.be/dQw4w9WgXcQ" width="560" height="315"></iframe>',
+                '<iframe data-cookieblock-src="https://youtu.be/dQw4w9WgXcQ" data-cookieconsent="marketing" width="560" height="315"></iframe>'
+            ],
+            'http instead of https for youtube'              => [
+                '<iframe src="http://www.youtube.com/embed/dQw4w9WgXcQ" width="560" height="315"></iframe>',
+                '<iframe data-cookieblock-src="http://www.youtube.com/embed/dQw4w9WgXcQ" data-cookieconsent="marketing" width="560" height="315"></iframe>'
+            ],
+
+            // Vimeo test cases
+            'vimeo.com embed'                                => [
+                '<iframe src="https://vimeo.com/123456789" width="640" height="360"></iframe>',
+                '<iframe data-cookieblock-src="https://vimeo.com/123456789" data-cookieconsent="marketing" width="640" height="360"></iframe>'
+            ],
+            'player.vimeo.com embed'                         => [
+                '<iframe src="https://player.vimeo.com/video/123456789" width="640" height="360"></iframe>',
+                '<iframe data-cookieblock-src="https://player.vimeo.com/video/123456789" data-cookieconsent="marketing" width="640" height="360"></iframe>'
+            ],
+            'www.vimeo.com embed'                            => [
+                '<iframe src="https://www.vimeo.com/123456789" width="640" height="360"></iframe>',
+                '<iframe data-cookieblock-src="https://www.vimeo.com/123456789" data-cookieconsent="marketing" width="640" height="360"></iframe>'
+            ],
+            'www.player.vimeo.com embed'                     => [
+                '<iframe src="https://www.player.vimeo.com/video/123456789" width="640" height="360"></iframe>',
+                '<iframe data-cookieblock-src="https://www.player.vimeo.com/video/123456789" data-cookieconsent="marketing" width="640" height="360"></iframe>'
+            ],
+            'http vimeo'                                     => [
+                '<iframe src="http://vimeo.com/123456789" width="640" height="360"></iframe>',
+                '<iframe data-cookieblock-src="http://vimeo.com/123456789" data-cookieconsent="marketing" width="640" height="360"></iframe>'
+            ],
+            // General test cases
+            'single quotes'                                  => [
+                '<iframe src=\'https://www.youtube.com/embed/dQw4w9WgXcQ\' width="560" height="315"></iframe>',
+                '<iframe data-cookieblock-src="https://www.youtube.com/embed/dQw4w9WgXcQ" data-cookieconsent="marketing" width="560" height="315"></iframe>'
+            ],
+            'multiple iframes different services'            => [
+                '<iframe src="https://www.youtube.com/embed/video1"></iframe><iframe src="https://vimeo.com/video2"></iframe><iframe src="https://www.google.com/maps/embed?pb=test"></iframe>',
+                '<iframe data-cookieblock-src="https://www.youtube.com/embed/video1" data-cookieconsent="marketing"></iframe><iframe data-cookieblock-src="https://vimeo.com/video2" data-cookieconsent="marketing"></iframe><iframe src="https://www.google.com/maps/embed?pb=test"></iframe>'
+            ],
+            'mixed content'                                  => [
+                '<p>Some text</p><iframe src="https://www.youtube.com/embed/dQw4w9WgXcQ"></iframe><p>More text</p><iframe src="https://vimeo.com/123456789"></iframe>',
+                '<p>Some text</p><iframe data-cookieblock-src="https://www.youtube.com/embed/dQw4w9WgXcQ" data-cookieconsent="marketing"></iframe><p>More text</p><iframe data-cookieblock-src="https://vimeo.com/123456789" data-cookieconsent="marketing"></iframe>'
+            ],
+            'iframe with frameborder and allowfullscreen'    => [
+                '<iframe src="https://www.youtube.com/embed/dQw4w9WgXcQ" frameborder="0" allowfullscreen=""></iframe>',
+                '<iframe data-cookieblock-src="https://www.youtube.com/embed/dQw4w9WgXcQ" data-cookieconsent="marketing" frameborder="0" allowfullscreen=""></iframe>'
+            ],
+            'iframe with existing data-cookieconsent'        => [
+                '<iframe src="https://www.youtube.com/embed/dQw4w9WgXcQ" data-cookieconsent="marketing"></iframe>',
+                '<iframe data-cookieblock-src="https://www.youtube.com/embed/dQw4w9WgXcQ" data-cookieconsent="marketing"></iframe>'
+            ],
+            'iframe with different data-cookieconsent value' => [
+                '<iframe src="https://vimeo.com/123456789" data-cookieconsent="statistics"></iframe>',
+                '<iframe data-cookieblock-src="https://vimeo.com/123456789" data-cookieconsent="statistics"></iframe>'
+            ],
+            'no matching iframe'                             => [
+                '<iframe src="https://example.com/video"></iframe>',
+                '<iframe src="https://example.com/video"></iframe>'
+            ],
+            'no iframe at all'                               => [
+                '<p>Just some text content</p>',
+                '<p>Just some text content</p>'
+            ],
+            'empty content'                                  => [
+                '',
+                ''
+            ]
+        ];
+    }
+}

ViewModel/Script.php

@@ -39,4 +39,9 @@ public function isGoogleConsentModeEnabled(): bool
     {
         return $this->config->isGoogleConsentModeEnabled();
     }
+
+    public function isBlockVideosUntilConsentEnabled(): bool
+    {
+        return $this->config->isBlockVideosUntilConsentEnabled();
+    }
 }

composer.json

@@ -10,13 +10,17 @@
         }
     ],
     "require": {
-        "magento/framework": "~102.0||~103.0",
-        "magento/module-catalog": "~103.0||~104.0",
-        "magento/module-cms": "~103.0||~104.0",
-        "php": "~7.4.0||~8.1.0||~8.2.0||~8.3.0||~8.4.0"
+        "ext-pcre": "*",
+        "magento/framework": "^103.0",
+        "magento/module-catalog": "^104.0",
+        "magento/module-cms": "^104.0",
+        "magento/module-config": "^101.2",
+        "magento/module-store": "^101.1",
+        "php": "^7.4.0||^8.1.0||^8.2.0||^8.3.0||^8.4.0",
+        "psr/log": "^1.1||^2||^3"
     },
     "require-dev": {
-        "phpunit/phpunit": "~6.5||~9.5",
+        "phpunit/phpunit": "^6.5||^9.5",
         "roave/security-advisories": "dev-latest"
     },
     "autoload": {

etc/adminhtml/system.xml

@@ -29,6 +29,10 @@
                     <label>Google Consent Mode</label>
                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
                 </field>
+                <field id="block_videos_until_consent" translate="label" type="select" sortOrder="60" showInDefault="1" showInWebsite="1" showInStore="1">
+                    <label>Block YouTube / Vimeo Videos Until Marketing Consent</label>
+                    <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
+                </field>
             </group>
         </section>
     </system>

etc/config.xml

@@ -9,6 +9,7 @@
                 <data_culture/>
                 <use_eu_cdn>0</use_eu_cdn>
                 <use_google_consent_mode>1</use_google_consent_mode>
+                <block_videos_until_consent>0</block_videos_until_consent>
             </cookiebot>
         </web>
     </default>

etc/events.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0"?>
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
+    <event name="controller_front_send_response_before">
+        <observer name="customgento_cookiebot_html_content_filter" instance="CustomGento\Cookiebot\Observer\HtmlContentFilterObserver"/>
+    </event>
+</config>

etc/module.xml

@@ -3,8 +3,12 @@
         xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
     <module name="CustomGento_Cookiebot">
         <sequence>
+            <module name="Magento_Backend"/>
             <module name="Magento_Catalog"/>
             <module name="Magento_Cms"/>
+            <module name="Magento_Config"/>
+            <module name="Magento_ProductVideo"/>
+            <module name="Magento_Store"/>
         </sequence>
     </module>
 </config>

i18n/de_DE.csv

@@ -1,4 +1,9 @@
+"Please <a href=""javascript:Cookiebot.renew()"" class=""cookiebot-iframe-consent-link"">accept %1 cookies</a> to view this %2 content.","Bitte <a href=""javascript:Cookiebot.renew()"" class=""cookiebot-iframe-consent-link"">akzeptieren Sie %1 Cookies</a>, um diesen %2 Inhalt anzuzeigen."
+"Please <a href=""javascript:Cookiebot.renew()"">accept marketing cookies</a> to view this content.","Bitte <a href=""javascript:Cookiebot.renew()"">akzeptieren Sie Marketing-Cookies</a>, um diesen Inhalt anzuzeigen."
 "Cookiebot Settings","Cookiebot Einstellungen"
 "Enable Cookiebot Integration","Cookiebot-Integration aktivieren"
 "Cookiebot ID","Cookiebot ID"
 "Data Culture","Data Culture"
+"Use European CDN","Europäisches CDN verwenden"
+"Google Consent Mode","Google Consent Mode"
+"Block YouTube / Vimeo Videos Until Marketing Consent","Blockiere YouTube / Vimeo Videos bis zur Marketingeinwilligung"

i18n/en_US.csv

@@ -1,4 +1,9 @@
+"Please <a href=""javascript:Cookiebot.renew()"" class=""cookiebot-iframe-consent-link"">accept %1 cookies</a> to view this %2 content.","Please <a href=""javascript:Cookiebot.renew()"" class=""cookiebot-iframe-consent-link"">accept %1 cookies</a> to view this %2 content."
+"Please <a href=""javascript:Cookiebot.renew()"">accept marketing cookies</a> to view this content.","Please <a href=""javascript:Cookiebot.renew()"">accept marketing cookies</a> to view this content."
 "Cookiebot Settings","Cookiebot Settings"
 "Enable Cookiebot Integration","Enable Cookiebot Integration"
 "Cookiebot ID","Cookiebot ID"
 "Data Culture","Data Culture"
+"Use European CDN","Use European CDN"
+"Google Consent Mode","Google Consent Mode"
+"Block YouTube / Vimeo Videos Until Marketing Consent","Block YouTube / Vimeo Videos Until Marketing Consent"