dom/src/HTMLParsingHelper.php at 3b5fbe9f437b7c602a20784befdeb9b58b2bd4dc · webfactory/dom · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
<?php

/*
 * (c) webfactory GmbH <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Webfactory\Dom;

abstract class HTMLParsingHelper extends BaseParsingHelper
{
    protected $implicitNamespaces;

    public function __construct()
    {
        $this->implicitNamespaces = $this->defineImplicitNamespaces();

        libxml_set_external_entity_loader(function ($public, $system, $context) {
            if (isset($public)) {
                $catalogDir = __DIR__.'/../../../xml-catalog/';
                switch ($public) {
                    case '-//W3C//DTD XHTML 1.0 Strict//EN':
                        return $catalogDir.'xhtml1-strict.dtd';
                    case '-//W3C//ENTITIES Latin 1 for XHTML//EN':
                        return $catalogDir.'xhtml-lat1.ent';
                    case '-//W3C//ENTITIES Symbols for XHTML//EN':
                        return $catalogDir.'xhtml-symbol.ent';
                    case '-//W3C//ENTITIES Special for XHTML//EN':
                        return $catalogDir.'xhtml-special.ent';
                    case '-//W3C//DTD XHTML 1.0 Transitional//EN':
                        return $catalogDir.'xhtml1-transitional.dtd';
                }
            }

            return $system;
        });
    }

    protected function wrapFragment($fragment, $declaredNamespaces)
    {
        return "<html {$this->xmlNamespaceDeclaration($declaredNamespaces)}>$fragment</html>";
    }

    protected function defineImplicitNamespaces(): array
    {
        /**
         * The Update to PHP 8.1.21 apparently changes the search order for defined namespaces during the process
         * of reconciliation, resulting in finding the namespace having the prefix 'html' prior to the default one
         * without prefix, as the search seems to start from the last defined prefix now. This results in DOMElements
         * getting a wrong prefix while being appended to another element using `appendChild()` e.g. in
         * `BaseParsingHelper::dump()`.
         *
         * This is definitely a supposition, as we do not get everything completely what happens in the corresponding
         * commits
         *
         * - https://github.com/php/php-src/commit/b1d8e240e688cae810c83b364772bf140ac45f42 (https://bugs.php.net/bug.php?id=67440)
         * - https://github.com/php/php-src/commit/b30be40b86b62fc681c432fd96840d8e57e172a5 (https://bugs.php.net/bug.php?id=55294)
         *
         * but it perfectly matches our observation that changing the namespace order fixes several bugs and tests
         * in various private projects of ours.
         */
        if ((phpversion('xml') >= '8.1.21') && (phpversion('xml') < '8.1.25')) {
            return [
                'html' => 'http://www.w3.org/1999/xhtml',
                '' => 'http://www.w3.org/1999/xhtml',
                'hx' => 'http://purl.org/NET/hinclude',
            ];
        }

        return [
            '' => 'http://www.w3.org/1999/xhtml', // ignored by BaseParsingHelper::createXPath(), but defining the default namespace that will be assumed to be active when BaseParsingHelper::parseFragment() is called and no explicit namespace declarations are given
            'html' => 'http://www.w3.org/1999/xhtml', // so XPath expressions can use the "html" prefix to match the current HTML variant (unless an explicit mapping is given to BaseParsingHelper::createXPath())
            'hx' => 'http://purl.org/NET/hinclude', // fuer HInclude http://mnot.github.io/hinclude/; ein Weg um z.B. Controller in Symfony per Ajax zu embedden
        ];
    }
}