Skip to content

Commit 51b8121

Browse files
ndosschendossche
committed
Fix GH-20444: Dom\XMLDocument::C14N() seems broken compared to DOMDocument::C14N()
1 parent 3ad5799 commit 51b8121

File tree

4 files changed

+198
-12
lines changed

4 files changed

+198
-12
lines changed

‎ext/dom/node.c‎

Lines changed: 113 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2081,6 +2081,93 @@ PHP_METHOD(DOMNode, lookupNamespaceURI)
20812081
}
20822082
/* }}} end dom_node_lookup_namespace_uri */
20832083

2084+
static void dom_relink_ns_decls_element(HashTable *links, xmlNodePtr node)
2085+
{
2086+
if (node->type == XML_ELEMENT_NODE) {
2087+
for (xmlAttrPtr attr = node->properties; attr; attr = attr->next) {
2088+
if (php_dom_ns_is_fast((const xmlNode *) attr, php_dom_ns_is_xmlns_magic_token)) {
2089+
xmlNsPtr ns = xmlMalloc(sizeof(*ns));
2090+
if (!ns) {
2091+
return;
2092+
}
2093+
2094+
zval *zv = zend_hash_index_lookup(links, (zend_ulong) node);
2095+
if (Z_ISNULL_P(zv)) {
2096+
ZVAL_LONG(zv, 1);
2097+
} else {
2098+
Z_LVAL_P(zv)++;
2099+
}
2100+
2101+
bool should_free;
2102+
xmlChar *attr_value = php_libxml_attr_value(attr, &should_free);
2103+
2104+
memset(ns, 0, sizeof(*ns));
2105+
ns->type = XML_LOCAL_NAMESPACE;
2106+
ns->href = should_free ? attr_value : xmlStrdup(attr_value);
2107+
ns->prefix = attr->ns->prefix ? xmlStrdup(attr->name) : NULL;
2108+
ns->next = node->nsDef;
2109+
node->nsDef = ns;
2110+
2111+
ns->_private = attr;
2112+
if (attr->prev) {
2113+
attr->prev = attr->next;
2114+
} else {
2115+
node->properties = attr->next;
2116+
}
2117+
if (attr->next) {
2118+
attr->next->prev = attr->prev;
2119+
}
2120+
}
2121+
}
2122+
2123+
if (node->ns && !node->ns->prefix) { // TODO: is this complete?
2124+
/* Workaround for the behaviour where xmlSearchNs() can return the current namespace */
2125+
zend_hash_index_add_new_ptr(links, (zend_ulong) node | 1, node->ns);
2126+
node->ns = xmlSearchNs(node->doc, node, NULL);
2127+
}
2128+
}
2129+
}
2130+
2131+
static void dom_relink_ns_decls(HashTable *links, xmlNodePtr root)
2132+
{
2133+
dom_relink_ns_decls_element(links, root);
2134+
2135+
xmlNodePtr base = root;
2136+
xmlNodePtr node = base->children;
2137+
while (node != NULL) {
2138+
dom_relink_ns_decls_element(links, node);
2139+
node = php_dom_next_in_tree_order(node, base);
2140+
}
2141+
}
2142+
2143+
static void dom_unlink_ns_decls(HashTable *links)
2144+
{
2145+
ZEND_HASH_MAP_FOREACH_NUM_KEY_VAL(links, zend_ulong h, zval *data) {
2146+
if (h & 1) {
2147+
xmlNodePtr node = (xmlNodePtr) (h ^ 1);
2148+
node->ns = Z_PTR_P(data);
2149+
} else {
2150+
xmlNodePtr node = (xmlNodePtr) h;
2151+
while (Z_LVAL_P(data)-- > 0) {
2152+
xmlNsPtr ns = node->nsDef;
2153+
node->nsDef = node->nsDef->next;
2154+
2155+
xmlAttrPtr attr = ns->_private;
2156+
if (attr->prev) {
2157+
attr->prev->next = attr;
2158+
} else {
2159+
node->properties = attr;
2160+
}
2161+
if (attr->next) {
2162+
attr->next->prev = attr;
2163+
}
2164+
2165+
xmlFreeNs(ns);
2166+
}
2167+
}
2168+
} ZEND_HASH_FOREACH_END();
2169+
}
2170+
20842171
static int dom_canonicalize_node_parent_lookup_cb(void *user_data, xmlNodePtr node, xmlNodePtr parent)
20852172
{
20862173
xmlNodePtr root = user_data;
@@ -2136,7 +2223,23 @@ static void dom_canonicalization(INTERNAL_FUNCTION_PARAMETERS, int mode) /* {{{
21362223

21372224
docp = nodep->doc;
21382225

2139-
if (! docp) {
2226+
HashTable links;
2227+
bool modern = php_dom_follow_spec_node(nodep);
2228+
if (modern) {
2229+
xmlNodePtr root = nodep;
2230+
while (root->parent) {
2231+
root = root->parent;
2232+
}
2233+
2234+
if (UNEXPECTED(root->type != XML_DOCUMENT_NODE && root->type != XML_HTML_DOCUMENT_NODE)) {
2235+
php_dom_throw_error_with_message(HIERARCHY_REQUEST_ERR, "Canonicalization can only happen on nodes attached to a document.", /* strict */ true);
2236+
RETURN_THROWS();
2237+
}
2238+
2239+
zend_hash_init(&links, 0, NULL, NULL, false);
2240+
dom_relink_ns_decls(&links, xmlDocGetRootElement(docp));
2241+
} else if (!docp) {
2242+
/* Note: not triggerable with modern DOM */
21402243
zend_throw_error(NULL, "Node must be associated with a document");
21412244
RETURN_THROWS();
21422245
}
@@ -2158,12 +2261,12 @@ static void dom_canonicalization(INTERNAL_FUNCTION_PARAMETERS, int mode) /* {{{
21582261
if (!tmp) {
21592262
/* if mode == 0 then $xpath arg is 3, if mode == 1 then $xpath is 4 */
21602263
zend_argument_value_error(3 + mode, "must have a \"query\" key");
2161-
RETURN_THROWS();
2264+
goto clean_links;
21622265
}
21632266
if (Z_TYPE_P(tmp) != IS_STRING) {
21642267
/* if mode == 0 then $xpath arg is 3, if mode == 1 then $xpath is 4 */
21652268
zend_argument_type_error(3 + mode, "\"query\" option must be a string, %s given", zend_zval_value_name(tmp));
2166-
RETURN_THROWS();
2269+
goto clean_links;
21672270
}
21682271
xquery = Z_STRVAL_P(tmp);
21692272

@@ -2195,7 +2298,7 @@ static void dom_canonicalization(INTERNAL_FUNCTION_PARAMETERS, int mode) /* {{{
21952298
}
21962299
xmlXPathFreeContext(ctxp);
21972300
zend_throw_error(NULL, "XPath query did not return a nodeset");
2198-
RETURN_THROWS();
2301+
goto clean_links;
21992302
}
22002303
}
22012304

@@ -2264,6 +2367,12 @@ static void dom_canonicalization(INTERNAL_FUNCTION_PARAMETERS, int mode) /* {{{
22642367
RETURN_LONG(bytes);
22652368
}
22662369
}
2370+
2371+
clean_links:
2372+
if (modern) {
2373+
dom_unlink_ns_decls(&links);
2374+
zend_hash_destroy(&links);
2375+
}
22672376
}
22682377
/* }}} */
22692378

‎ext/dom/tests/canonicalization.phpt‎

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,32 +21,46 @@ $dom = new DOMDocument();
2121
$dom->loadXML($xml);
2222
$doc = $dom->documentElement->firstChild;
2323

24+
$newDom = Dom\XMLDocument::createFromString($xml);
25+
$newDoc = $newDom->documentElement->firstChild;
26+
$counter = 0;
27+
28+
function check($doc, $newDoc, ...$args) {
29+
global $counter;
30+
$counter++;
31+
echo $doc->C14N(...$args)."\n\n";
32+
if ($doc->C14N(...$args) !== $newDoc->C14N(...$args)) {
33+
var_dump($doc->C14N(...$args), $newDoc->C14N(...$args));
34+
throw new Error("mismatch: $counter");
35+
}
36+
}
37+
2438
/* inclusive/without comments first child element of doc element is context. */
25-
echo $doc->C14N()."\n\n";
39+
check($doc, $newDoc);
2640

2741
/* exclusive/without comments first child element of doc element is context. */
28-
echo $doc->c14N(TRUE)."\n\n";
42+
check($doc, $newDoc, TRUE);
2943

3044
/* inclusive/with comments first child element of doc element is context. */
31-
echo $doc->C14N(FALSE, TRUE)."\n\n";
45+
check($doc, $newDoc, FALSE, TRUE);
3246

3347
/* exclusive/with comments first child element of doc element is context. */
34-
echo $doc->C14N(TRUE, TRUE)."\n\n";
48+
check($doc, $newDoc, TRUE, TRUE);
3549

3650
/* exclusive/without comments using xpath query. */
37-
echo $doc->c14N(TRUE, FALSE, array('query'=>'(//. | //@* | //namespace::*)'))."\n\n";
51+
check($doc, $newDoc, TRUE, FALSE, array('query'=>'(//. | //@* | //namespace::*)'))."\n\n";
3852

3953
/* exclusive/without comments first child element of doc element is context.
4054
using xpath query with registered namespace.
4155
test namespace prefix is also included. */
42-
echo $doc->c14N(TRUE, FALSE,
56+
check($doc, $newDoc, TRUE, FALSE,
4357
array('query'=>'(//a:contain | //a:bar | .//namespace::*)',
4458
'namespaces'=>array('a'=>'http://www.example.com/ns/foo')),
45-
array('test'))."\n\n";
59+
array('test'));
4660

4761
/* exclusive/without comments first child element of doc element is context.
4862
test namespace prefix is also included */
49-
echo $doc->C14N(TRUE, FALSE, NULL, array('test'));
63+
check($doc, $newDoc, TRUE, FALSE, NULL, array('test'));
5064
?>
5165
--EXPECT--
5266
<contain xmlns="http://www.example.com/ns/foo" xmlns:fubar="http://www.example.com/ns/fubar" xmlns:test="urn::test">

‎ext/dom/tests/modern/xml/canonicalize_unattached.phpt‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
--TEST--
2+
Canonicalize unattached node should fail
3+
--EXTENSIONS--
4+
dom
5+
--FILE--
6+
<?php
7+
8+
$d = \Dom\XMLDocument::createFromString('<root><child/></root>');
9+
$child = $d->documentElement->firstChild;
10+
$child->remove();
11+
12+
try {
13+
$child->C14N();
14+
} catch (Dom\DOMException $e) {
15+
echo $e->getMessage(), "\n";
16+
}
17+
18+
?>
19+
--EXPECT--
20+
Canonicalization can only happen on nodes attached to a document.

‎ext/dom/tests/modern/xml/gh20444.phpt‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
--TEST--
2+
GH-20444 (Dom\XMLDocument::C14N() seems broken compared to DOMDocument::C14N())
3+
--EXTENSIONS--
4+
dom
5+
--FILE--
6+
<?php
7+
8+
$xml = <<<EOF
9+
<?xml version="1.0" encoding="UTF-8"?>
10+
<test:root xmlns:test="http://example.com/dummy/ns">
11+
<test:a xmlns:test="http://example.com/dummy/ns"/>
12+
<test:b test:kind="123">abc</test:b>
13+
</test:root>
14+
EOF;
15+
16+
$d = \Dom\XMLDocument::createFromString($xml);
17+
var_dump($d->C14N(true));
18+
19+
$xml = <<<EOF
20+
<?xml version="1.0" encoding="UTF-8"?>
21+
<ns1:root xmlns:ns1="http://example.com/dummy/ns">
22+
<ns1:a/>
23+
<ns1:b>
24+
<ns1:c>123</ns1:c>
25+
</ns1:b>
26+
</ns1:root>
27+
EOF;
28+
29+
$d = \Dom\XMLDocument::createFromString($xml);
30+
var_dump($d->C14N());
31+
32+
?>
33+
--EXPECT--
34+
string(128) "<test:root xmlns:test="http://example.com/dummy/ns">
35+
<test:a></test:a>
36+
<test:b test:kind="123">abc</test:b>
37+
</test:root>"
38+
string(134) "<ns1:root xmlns:ns1="http://example.com/dummy/ns">
39+
<ns1:a></ns1:a>
40+
<ns1:b>
41+
<ns1:c>123</ns1:c>
42+
</ns1:b>
43+
</ns1:root>"

0 commit comments

Comments
 (0)