Add custom tag support and mark inline tag

n0str · n0str · commit b9f57bad7a52 · 2018-10-14T23:20:57.000+03:00
diff --git a/EditorJS/BlockHandler.php b/EditorJS/BlockHandler.php
@@ -225,6 +225,13 @@ private function getPurifier($allowedTags)
 
         $sanitizer->set('HTML.Allowed', $allowedTags);
 
+        /**
+         * Define custom HTML Definition for mark tool
+         */
+        if ($def = $sanitizer->maybeGetRawHTMLDefinition()) {
+            $def->addElement('mark', 'Inline', 'Inline', 'Common');
+        }
+
         $purifier = new \HTMLPurifier($sanitizer);
 
         return $purifier;
@@ -240,6 +247,7 @@ private function getDefaultPurifier()
         $sanitizer->set('HTML.TargetBlank', true);
         $sanitizer->set('URI.AllowedSchemes', ['http' => true, 'https' => true]);
         $sanitizer->set('AutoFormat.RemoveEmpty', true);
+        $sanitizer->set('HTML.DefinitionID', 'html5-definitions');
 
         if (!is_dir('/tmp/purifier')) {
             mkdir('/tmp/purifier', 0777, true);
diff --git a/tests/BlockHandlerTest.php b/tests/BlockHandlerTest.php
@@ -71,15 +71,4 @@ public function testListTool()
         $this->assertEquals("second", $result[0]['data']['items'][1]);
         $this->assertEquals("third", $result[0]['data']['items'][2]);
     }
-
-    public function testHtmlPurifier()
-    {
-        $data = '{"time":1539180803359,"blocks":[{"type":"header","data":{"text":"<b>t</b><i>e</i><u>st</u>","level":2}}, {"type":"quote","data":{"text":"<b>t</b><i>e</i><u>st</u>","caption":"", "alignment":"left"}}]}';
-        $editor = new EditorJS($data, $this->configuration);
-        $result = $editor->getBlocks();
-
-        $this->assertEquals(2, count($result));
-        $this->assertEquals('test', $result[0]['data']['text']);
-        $this->assertEquals('<b>t</b><i>e</i><u>st</u>', $result[1]['data']['text']);
-    }
 }
diff --git a/tests/PurifierTest.php b/tests/PurifierTest.php
@@ -0,0 +1,46 @@
+<?php
+
+use EditorJS\EditorJS;
+
+/**
+ * Class PurifierTest
+ *
+ * Check HTML Purification cases
+ */
+class PurifierTest extends TestCase
+{
+    const CONFIGURATION_FILE = TESTS_DIR . "/samples/purify-test-config.json";
+
+    /**
+     * Sample configuration
+     */
+    public $configuration;
+
+    /**
+     * Setup configuration
+     */
+    public function setUp()
+    {
+        $this->configuration = file_get_contents(PurifierTest::CONFIGURATION_FILE);
+    }
+
+    public function testHtmlPurifier()
+    {
+        $data = '{"time":1539180803359,"blocks":[{"type":"header","data":{"text":"<b>t</b><i>e</i><u>st</u>","level":2}}, {"type":"quote","data":{"text":"<b>t</b><i>e</i><u>st</u>","caption":"", "alignment":"left"}}]}';
+        $editor = new EditorJS($data, $this->configuration);
+        $result = $editor->getBlocks();
+
+        $this->assertEquals(2, count($result));
+        $this->assertEquals('test', $result[0]['data']['text']);
+        $this->assertEquals('<b>t</b><i>e</i><u>st</u>', $result[1]['data']['text']);
+    }
+
+    public function testCustomTagPurifier()
+    {
+        $data = '{"time":1539180803359,"blocks":[{"type":"header","data":{"text":"<b>t</b><mark>e</mark><u>st</u>","level":2}}]}';
+        $editor = new EditorJS($data, $this->configuration);
+        $result = $editor->getBlocks();
+
+        $this->assertEquals('t<mark>e</mark>st', $result[0]['data']['text']);
+    }
+}
diff --git a/tests/samples/purify-test-config.json b/tests/samples/purify-test-config.json
@@ -0,0 +1,27 @@
+{
+  "tools": {
+    "header": {
+      "text": {
+        "type": "string",
+        "allowedTags": "mark"
+      },
+      "level": {
+        "type": "int",
+        "canBeOnly": [2, 3, 4]
+      }
+    },
+    "quote": {
+      "text": {
+        "type": "string",
+        "allowedTags": "i,b,u"
+      },
+      "caption": {
+        "type": "string"
+      },
+      "alignment": {
+        "type": "string",
+        "canBeOnly": ["left", "right"]
+      }
+    }
+  }
+}
