OXDEV-7182 Move HtmlFilter classes into the module

CHANGELOG.md

@@ -4,13 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [4.0.1] - unreleased
+## [4.1.0] - unreleased
 
 ### Fixed
 - Pre-filter CMS content before it is passed to Summernote editor
 
 ### Added
-- `HtmlTagRemover` class
+- `HtmlFilter` and `HtmlTagRemover` class
 
 ## [4.0.0] - 2024-03-12
 

services.yaml

@@ -1,5 +1,6 @@
 imports:
   - { resource: src/Service/services.yaml }
+  - { resource: src/HtmlFilter/services.yaml }
 
 services:
   _defaults:

src/HtmlFilter/HtmlFilter.php

@@ -0,0 +1,43 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\WysiwygModule\HtmlFilter;
+
+use DOMDocument;
+use DOMXPath;
+
+class HtmlFilter implements HtmlFilterInterface
+{
+    public function __construct(private readonly HtmlRemoverInterface $htmlRemover)
+    {
+    }
+
+    public function filter(string $html): string
+    {
+        $doc = new DOMDocument();
+        $doc->loadHTML("<div>$html</div>", LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD);
+
+        $xpath = new DOMXPath($doc);
+        foreach ($xpath->query('//script') as $node) {
+            $this->htmlRemover->remove($node);
+        }
+
+        return $this->getInnerHtml($doc);
+    }
+
+    private function getInnerHtml(DOMDocument $doc): string
+    {
+        $html = '';
+        foreach ($doc->documentElement->childNodes as $node) {
+            $html .= $doc->saveHTML($node);
+        }
+
+        return $html;
+    }
+}

src/HtmlFilter/HtmlFilterInterface.php

@@ -0,0 +1,15 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\WysiwygModule\HtmlFilter;
+
+interface HtmlFilterInterface
+{
+    public function filter(string $html): string;
+}

src/HtmlFilter/HtmlRemoverInterface.php

@@ -0,0 +1,17 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\WysiwygModule\HtmlFilter;
+
+use DOMNode;
+
+interface HtmlRemoverInterface
+{
+    public function remove(DOMNode $node): void;
+}

src/Service/HtmlTagRemover.php → src/HtmlFilter/HtmlTagRemover.php

@@ -7,11 +7,10 @@
 
 declare(strict_types=1);
 
-namespace OxidEsales\WysiwygModule\Service;
+namespace OxidEsales\WysiwygModule\HtmlFilter;
 
 use DOMNode;
 use InvalidArgumentException;
-use OxidEsales\EshopCommunity\Internal\Framework\Templating\HtmlFilter\HtmlRemoverInterface;
 
 class HtmlTagRemover implements HtmlRemoverInterface
 {

src/HtmlFilter/services.yaml

@@ -0,0 +1,12 @@
+services:
+  _defaults:
+    public: false
+    autowire: true
+
+  OxidEsales\WysiwygModule\HtmlFilter\HtmlRemoverInterface:
+    class: OxidEsales\WysiwygModule\HtmlFilter\HtmlTagRemover
+    public: true
+
+  OxidEsales\WysiwygModule\HtmlFilter\HtmlFilterInterface:
+    class: OxidEsales\WysiwygModule\HtmlFilter\HtmlFilter
+    public: true

src/Service/EditorRenderer.php

@@ -9,8 +9,8 @@
 
 namespace OxidEsales\WysiwygModule\Service;
 
-use OxidEsales\EshopCommunity\Internal\Framework\Templating\HtmlFilter\HtmlFilterInterface;
 use OxidEsales\EshopCommunity\Internal\Framework\Templating\TemplateRendererInterface;
+use OxidEsales\WysiwygModule\HtmlFilter\HtmlFilterInterface;
 
 class EditorRenderer implements EditorRendererInterface
 {

src/Service/services.yaml

@@ -12,13 +12,3 @@ services:
   OxidEsales\WysiwygModule\Service\EditorRendererInterface:
     class: OxidEsales\WysiwygModule\Service\EditorRenderer
     public: true
-
-  OxidEsales\EshopCommunity\Internal\Framework\Templating\HtmlFilter\HtmlRemoverInterface:
-    class: OxidEsales\WysiwygModule\Service\HtmlTagRemover
-    public: true
-
-  OxidEsales\EshopCommunity\Internal\Framework\Templating\HtmlFilter\HtmlFilterInterface:
-    class: OxidEsales\EshopCommunity\Internal\Framework\Templating\HtmlFilter\HtmlFilter
-    public: true
-    arguments:
-      $htmlRemover: '@OxidEsales\EshopCommunity\Internal\Framework\Templating\HtmlFilter\HtmlRemoverInterface'

tests/Unit/Service/HtmlTagRemoverTest.php → tests/Unit/HtmlFilter/HtmlTagRemoverTest.php

@@ -7,11 +7,11 @@
 
 declare(strict_types=1);
 
-namespace OxidEsales\WysiwygModule\Tests\Unit\Service;
+namespace OxidEsales\WysiwygModule\Tests\Unit\HtmlFilter;
 
 use DOMDocument;
 use InvalidArgumentException;
-use OxidEsales\WysiwygModule\Service\HtmlTagRemover;
+use OxidEsales\WysiwygModule\HtmlFilter\HtmlTagRemover;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\TestCase;