From 9a4a03eada6226b56ddcf6e23428960071f87e53 Mon Sep 17 00:00:00 2001
From: Tomasz Kowalewski <t.kowalewski@createit.pl>
Date: Thu, 29 Aug 2024 12:41:27 +0200
Subject: [PATCH] OXDEV-7182 Move HtmlFilter classes into the module

---
 CHANGELOG.md                                  |  4 +-
 services.yaml                                 |  1 +
 src/HtmlFilter/HtmlFilter.php                 | 43 +++++++++++++++++++
 src/HtmlFilter/HtmlFilterInterface.php        | 15 +++++++
 src/HtmlFilter/HtmlRemoverInterface.php       | 17 ++++++++
 .../HtmlTagRemover.php                        |  3 +-
 src/HtmlFilter/services.yaml                  | 12 ++++++
 src/Service/EditorRenderer.php                |  2 +-
 src/Service/services.yaml                     | 10 -----
 .../HtmlTagRemoverTest.php                    |  4 +-
 10 files changed, 94 insertions(+), 17 deletions(-)
 create mode 100644 src/HtmlFilter/HtmlFilter.php
 create mode 100644 src/HtmlFilter/HtmlFilterInterface.php
 create mode 100644 src/HtmlFilter/HtmlRemoverInterface.php
 rename src/{Service => HtmlFilter}/HtmlTagRemover.php (82%)
 create mode 100644 src/HtmlFilter/services.yaml
 rename tests/Unit/{Service => HtmlFilter}/HtmlTagRemoverTest.php (94%)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 2f70137..3948370 100644
--- a/CHANGELOG.md
+++ b/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
 
diff --git a/services.yaml b/services.yaml
index 07393ee..62cead9 100644
--- a/services.yaml
+++ b/services.yaml
@@ -1,5 +1,6 @@
 imports:
   - { resource: src/Service/services.yaml }
+  - { resource: src/HtmlFilter/services.yaml }
 
 services:
   _defaults:
diff --git a/src/HtmlFilter/HtmlFilter.php b/src/HtmlFilter/HtmlFilter.php
new file mode 100644
index 0000000..21bc0ae
--- /dev/null
+++ b/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;
+    }
+}
diff --git a/src/HtmlFilter/HtmlFilterInterface.php b/src/HtmlFilter/HtmlFilterInterface.php
new file mode 100644
index 0000000..47a8678
--- /dev/null
+++ b/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;
+}
diff --git a/src/HtmlFilter/HtmlRemoverInterface.php b/src/HtmlFilter/HtmlRemoverInterface.php
new file mode 100644
index 0000000..6fe66a7
--- /dev/null
+++ b/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;
+}
diff --git a/src/Service/HtmlTagRemover.php b/src/HtmlFilter/HtmlTagRemover.php
similarity index 82%
rename from src/Service/HtmlTagRemover.php
rename to src/HtmlFilter/HtmlTagRemover.php
index d097efa..d04253e 100644
--- a/src/Service/HtmlTagRemover.php
+++ b/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
 {
diff --git a/src/HtmlFilter/services.yaml b/src/HtmlFilter/services.yaml
new file mode 100644
index 0000000..283cddd
--- /dev/null
+++ b/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
diff --git a/src/Service/EditorRenderer.php b/src/Service/EditorRenderer.php
index f9dd3f4..ddf3e9e 100644
--- a/src/Service/EditorRenderer.php
+++ b/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
 {
diff --git a/src/Service/services.yaml b/src/Service/services.yaml
index c8d1591..7a45fc1 100644
--- a/src/Service/services.yaml
+++ b/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'
\ No newline at end of file
diff --git a/tests/Unit/Service/HtmlTagRemoverTest.php b/tests/Unit/HtmlFilter/HtmlTagRemoverTest.php
similarity index 94%
rename from tests/Unit/Service/HtmlTagRemoverTest.php
rename to tests/Unit/HtmlFilter/HtmlTagRemoverTest.php
index 7bdb6bd..0623d06 100644
--- a/tests/Unit/Service/HtmlTagRemoverTest.php
+++ b/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;