[TASK] Backport library to support PHP 7.0 and 7.1 (#103)

The PHP code of this library is backported to additionally support both PHP 7.0 and PHP 7.1. In order to achieve this, const visibility, nullable types and `void` types were removed and replaced with PHPDoc comments where applicable. The v1.5 branch is a back-port of v2 and only considered as a transitional version between v1 and v2 of typo3/html-sanitizer.
TYPO3 · Dec 6, 2022 · 307cbd6 · 307cbd6
1 parent 4f46069
commit 307cbd6
Show file tree

Hide file tree

Showing 24 changed files with 205 additions and 88 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -17,7 +17,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php: ['7.2', '7.3', '7.4', '8.0', '8.1', '8.2']
+        php: ['7.0', '7.1', '7.2', '7.3', '7.4', '8.0', '8.1', '8.2']
 
     steps:
       - uses: actions/checkout@v3

diff --git a/README.md b/README.md
@@ -12,6 +12,9 @@ This `typo3/html-sanitizer` package aims to be a standalone component that can b
 project or library. Albeit it is released within the TYPO3 namespace, it is agnostic to specifics of
 [TYPO3 CMS](https://github.com/typo3/typo3).
 
+> :warning: Version 1.5 of `typo3/html-sanitizer` is a transitional version
+> between v1 and v2 to support PHP 7.0 and PHP 7.1.
+
 + [`\TYPO3\HtmlSanitizer\Behavior`](src/Behavior.php) contains declarative settings for
   a particular process for sanitizing HTML.
 + [`\TYPO3\HtmlSanitizer\Visitor\VisitorInterface`](src/Visitor/VisitorInterface.php)

diff --git a/UPGRADING.md b/UPGRADING.md
@@ -1,9 +1,9 @@
 # TYPO3 HTML Sanitizer notices for upgrading
 
-## v2.1.0
+## v1.5.0
 
-* deprecated `\TYPO3\HtmlSanitizer\Behavior\NodeException::withNode(?DOMNode $node)`,
-  use `\TYPO3\HtmlSanitizer\Behavior\NodeException::withDomNode(?DOMNode $domNode)` instead
+* deprecated `\TYPO3\HtmlSanitizer\Behavior\NodeException::withNode($node)`,
+  use `\TYPO3\HtmlSanitizer\Behavior\NodeException::withDomNode($domNode)` instead
 * deprecated `\TYPO3\HtmlSanitizer\Behavior\NodeException::getNode()`,
   use `\TYPO3\HtmlSanitizer\Behavior\NodeException::getDomNode()` instead
 * deprecated property `\TYPO3\HtmlSanitizer\Sanitizer::$root`, superfluous - don't use it anymore

diff --git a/composer.json b/composer.json
@@ -17,11 +17,11 @@
 	"require": {
 		"ext-dom": "*",
 		"masterminds/html5": "^2.7.6",
-		"php": "^7.2 || ^8.0",
+		"php": "^7.0 || ^8.0",
 		"psr/log": "^1.0 || ^2.0 || ^3.0"
 	},
 	"require-dev": {
-		"phpunit/phpunit": "^8.5"
+		"phpunit/phpunit": "^6.5 || ^8.5"
 	},
 	"scripts": {
 		"test": "phpunit"

diff --git a/src/Behavior.php b/src/Behavior.php
@@ -27,38 +27,38 @@ class Behavior
     /**
      * not having any behavioral capabilities
      */
-    public const BLUNT = 0;
+    const BLUNT = 0;
 
     /**
      * in case an unexpected tag was found, encode the whole tag as HTML
      */
-    public const ENCODE_INVALID_TAG = 1;
+    const ENCODE_INVALID_TAG = 1;
 
     /**
      * in case an unexpected attribute was found, encode the whole tag as HTML
      */
-    public const ENCODE_INVALID_ATTR = 2;
+    const ENCODE_INVALID_ATTR = 2;
 
     /**
      * remove children at nodes that did not expect children
      */
-    public const REMOVE_UNEXPECTED_CHILDREN = 4;
+    const REMOVE_UNEXPECTED_CHILDREN = 4;
 
     /**
      * https://html.spec.whatwg.org/multipage/custom-elements.html#valid-custom-element-name
      * custom elements must contain a hyphen (`-`), start with ASCII lower alpha
      */
-    public const ALLOW_CUSTOM_ELEMENTS = 8;
+    const ALLOW_CUSTOM_ELEMENTS = 8;
 
     /**
      * in case an unexpected comment was found, encode the whole comment as HTML
      */
-    public const ENCODE_INVALID_COMMENT = 16;
+    const ENCODE_INVALID_COMMENT = 16;
 
     /**
      * in case an unexpected CDATA section was found, encode the whole CDATA section as HTML
      */
-    public const ENCODE_INVALID_CDATA_SECTION = 32;
+    const ENCODE_INVALID_CDATA_SECTION = 32;
 
     /**
      * @var int
@@ -136,7 +136,7 @@ public function withoutNodes(NodeInterface ...$nodes): self
         $names = array_map([$this, 'getNodeName'], $nodes);
         $filteredNodes = array_filter(
             $this->nodes,
-            static function (?NodeInterface $node, string $name) use ($nodes, $names) {
+            static function ($node, string $name) use ($nodes, $names) {
                 return $node === null && !in_array($name, $names, true)
                     || $node !== null && !in_array($node, $nodes, true);
             },
@@ -173,7 +173,10 @@ static function (NodeInterface $node) {
         );
     }
 
-    public function getTag(string $name): ?Tag
+    /**
+     * @return Tag|null
+     */
+    public function getTag(string $name)
     {
         $name = strtolower($name);
         $node = $this->nodes[$name] ?? null;
@@ -188,7 +191,10 @@ public function getNodes(): array
         return $this->nodes;
     }
 
-    public function getNode(string $name): ?NodeInterface
+    /**
+     * @return NodeInterface|null
+     */
+    public function getNode(string $name)
     {
         $name = strtolower($name);
         return $this->nodes[$name] ?? null;
@@ -231,9 +237,10 @@ public function shallAllowCustomElements(): bool
 
     /**
      * @param list<string> $names
+     * @return void
      * @throws LogicException
      */
-    protected function assertScalarUniqueness(array $names): void
+    protected function assertScalarUniqueness(array $names)
     {
         $ambiguousNames = array_diff_assoc($names, array_unique($names));
         if ($ambiguousNames !== []) {
@@ -249,8 +256,9 @@ protected function assertScalarUniqueness(array $names): void
 
     /**
      * @param array<string, NodeInterface> $nodes
+     * @return void
      */
-    protected function assertNodeUniqueness(array $nodes): void
+    protected function assertNodeUniqueness(array $nodes)
     {
         $existingNodeNames = array_intersect_key(array_filter($this->nodes), $nodes);
         if ($existingNodeNames !== []) {

diff --git a/src/Behavior/Attr.php b/src/Behavior/Attr.php
@@ -22,13 +22,13 @@ class Attr
     /**
      * not having any behavioral capabilities
      */
-    public const BLUNT = 0;
+    const BLUNT = 0;
 
     /**
      * whether given name shall be considered as prefix, e.g.
      * `data-` or `aria-` for multiple similar and safe attribute names
      */
-    public const NAME_PREFIX = 1;
+    const NAME_PREFIX = 1;
 
     /**
      * whether the first match in `$values` shall be considered
@@ -37,19 +37,19 @@ class Attr
      *
      * @deprecated since version 2.0.13 (it is the default behavior now)
      */
-    public const MATCH_FIRST_VALUE = 2;
+    const MATCH_FIRST_VALUE = 2;
 
     /**
      * whether all `$values` shall be considered as indicator an
      * attribute value is valid - if this flag is not given, the
      * first match in `$values` is taken
      */
-    public const MATCH_ALL_VALUES = 4;
+    const MATCH_ALL_VALUES = 4;
 
     /**
      * whether the current attribute is mandatory for the tag
      */
-    public const MANDATORY = 8;
+    const MANDATORY = 8;
 
     /**
      * either specific attribute name (`class`) or a prefix

diff --git a/src/Behavior/Handler/AsTextHandler.php b/src/Behavior/Handler/AsTextHandler.php
@@ -23,7 +23,14 @@
 
 class AsTextHandler implements HandlerInterface
 {
-    public function handle(NodeInterface $node, ?DOMNode $domNode, Context $context, Behavior $behavior = null): ?DOMNode
+    /**
+     * @param NodeInterface $node
+     * @param DOMNode|null $domNode
+     * @param Context $context
+     * @param Behavior|null $behavior
+     * @return DOMNode|null
+     */
+    public function handle(NodeInterface $node, $domNode, Context $context, Behavior $behavior = null)
     {
         if ($domNode === null) {
             return null;

diff --git a/src/Behavior/Handler/ClosureHandler.php b/src/Behavior/Handler/ClosureHandler.php
@@ -34,7 +34,14 @@ public function __construct(Closure $closure)
         $this->closure = $closure;
     }
 
-    public function handle(NodeInterface $node, ?DOMNode $domNode, Context $context, Behavior $behavior = null): ?DOMNode
+    /**
+     * @param NodeInterface $node
+     * @param DOMNode|null $domNode
+     * @param Context $context
+     * @param Behavior|null $behavior
+     * @return DOMNode|null
+     */
+    public function handle(NodeInterface $node, $domNode, Context $context, Behavior $behavior = null)
     {
         $result = call_user_func($this->closure, $node, $domNode, $context, $behavior);
         if ($result !== null && !$result instanceof DOMNode) {

diff --git a/src/Behavior/HandlerInterface.php b/src/Behavior/HandlerInterface.php
@@ -20,5 +20,12 @@
 
 interface HandlerInterface
 {
-    public function handle(NodeInterface $node, ?DOMNode $domNode, Context $context, Behavior $behavior = null): ?DOMNode;
+    /**
+     * @param NodeInterface $node
+     * @param DOMNode|null $domNode
+     * @param Context $context
+     * @param Behavior|null $behavior
+     * @return DOMNode|null
+     */
+    public function handle(NodeInterface $node, $domNode, Context $context, Behavior $behavior = null);
 }
diff --git a/src/Behavior/NodeException.php b/src/Behavior/NodeException.php
@@ -29,30 +29,38 @@ public static function create(): self
      */
     protected $domNode;
 
-    public function withDomNode(?DOMNode $domNode): self
+    /**
+     * @param DOMNode|null $domNode
+     */
+    public function withDomNode($domNode): self
     {
         $this->domNode = $domNode;
         return $this;
     }
 
     /**
-     * @deprecated since v2.1.0, use withDomNode(?DOMNode $domNode) instead
+     * @param DOMNode|null $domNode
+     * @deprecated since v1.5.0, use withDomNode(?DOMNode $domNode) instead
      */
-    public function withNode(?DOMNode $domNode): self
+    public function withNode($domNode): self
     {
         $this->domNode = $domNode;
         return $this;
     }
 
-    public function getDomNode(): ?DOMNode
+    /**
+     * @return DOMNode|null
+     */
+    public function getDomNode()
     {
         return $this->domNode;
     }
 
     /**
-     * @deprecated since v2.1.0, use getDomNode() instead
+     * @return DOMNode|null
+     * @deprecated since v1.5.0, use getDomNode() instead
      */
-    public function getNode(): ?DOMNode
+    public function getNode()
     {
         return $this->domNode;
     }

diff --git a/src/Behavior/NodeHandler.php b/src/Behavior/NodeHandler.php
@@ -19,12 +19,12 @@ class NodeHandler implements NodeInterface
     /**
      * Whether defaults shall be processed (e.g. verifying all attributes etc.)
      */
-    public const PROCESS_DEFAULTS = 1;
+    const PROCESS_DEFAULTS = 1;
 
     /**
      * Whether this handler shall be processed first (before processing defaults)
      */
-    public const HANDLE_FIRST = 2;
+    const HANDLE_FIRST = 2;
 
     /**
      * @var NodeInterface

diff --git a/src/Behavior/Tag.php b/src/Behavior/Tag.php
@@ -24,22 +24,22 @@ class Tag implements NodeInterface
     /**
      * not having any behavioral capabilities
      */
-    public const BLUNT = 0;
+    const BLUNT = 0;
 
     /**
      * whether to purge this tag in case it does not have any attributes
      */
-    public const PURGE_WITHOUT_ATTRS = 1;
+    const PURGE_WITHOUT_ATTRS = 1;
 
     /**
      * whether to purge this tag in case it does not have children
      */
-    public const PURGE_WITHOUT_CHILDREN = 2;
+    const PURGE_WITHOUT_CHILDREN = 2;
 
     /**
      * whether this tag allows to have children
      */
-    public const ALLOW_CHILDREN = 8;
+    const ALLOW_CHILDREN = 8;
 
     /**
      * @var string
@@ -112,7 +112,10 @@ public function shallAllowChildren(): bool
         return ($this->flags & self::ALLOW_CHILDREN) === self::ALLOW_CHILDREN;
     }
 
-    public function getAttr(string $name): ?Attr
+    /**
+     * @return Attr|null
+     */
+    public function getAttr(string $name)
     {
         $name = strtolower($name);
         if (isset($this->attrs[$name])) {
@@ -128,9 +131,10 @@ public function getAttr(string $name): ?Attr
 
     /**
      * @param string[] $names
+     * @return void
      * @throws LogicException
      */
-    protected function assertScalarUniqueness(array $names): void
+    protected function assertScalarUniqueness(array $names)
     {
         $ambiguousNames = array_diff_assoc($names, array_unique($names));
         if ($ambiguousNames !== []) {
@@ -146,9 +150,10 @@ protected function assertScalarUniqueness(array $names): void
 
     /**
      * @param array<string, Attr> $attrs
+     * @return void
      * @throws LogicException
      */
-    protected function assertAttrUniqueness(array $attrs): void
+    protected function assertAttrUniqueness(array $attrs)
     {
         $existingAttrNames = [];
         $currentAttrNames = array_keys($this->attrs);