Skip to content

Fix GH-11625: DOMElement::replaceWith() doesn't replace node with DOM… #11627

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 15 additions & 7 deletions ext/dom/parentnode.c
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,15 @@ xmlNode* dom_zvals_to_fragment(php_libxml_ref_obj *document, xmlNode *contextNod
goto err;
}

if (newNode->parent != NULL) {
if (newNode->type == XML_DOCUMENT_FRAG_NODE) {
/* Unpack document fragment nodes, the behaviour differs for different libxml2 versions. */
newNode = newNode->children;
if (UNEXPECTED(newNode == NULL)) {
/* No nodes to add, nothing to do here */
continue;
}
xmlUnlinkNode(newNode);
} else if (newNode->parent != NULL) {
xmlUnlinkNode(newNode);
}

Expand Down Expand Up @@ -370,7 +378,7 @@ static void dom_pre_insert(xmlNodePtr insertion_point, xmlNodePtr parentNode, xm
insertion_point->prev->next = newchild;
newchild->prev = insertion_point->prev;
}
insertion_point->prev = newchild;
insertion_point->prev = fragment->last;
if (parentNode->children == insertion_point) {
parentNode->children = newchild;
}
Expand Down Expand Up @@ -555,14 +563,14 @@ void dom_child_replace_with(dom_object *context, zval *nodes, int nodesc)
xmlNodePtr newchild = fragment->children;
xmlDocPtr doc = parentNode->doc;

/* Unlink and free it unless it became a part of the fragment. */
if (child->parent != fragment) {
xmlUnlinkNode(child);
}

if (newchild) {
xmlNodePtr last = fragment->last;

/* Unlink and free it unless it became a part of the fragment. */
if (child->parent != fragment) {
xmlUnlinkNode(child);
}

dom_pre_insert(insertion_point, parentNode, newchild, fragment);

dom_fragment_assign_parent_node(parentNode, fragment);
Expand Down
72 changes: 72 additions & 0 deletions ext/dom/tests/gh11625.phpt
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
--TEST--
GH-11625 (DOMElement::replaceWith() doesn't replace node with DOMDocumentFragment but just deletes node or causes wrapping <></> depending on libxml2 version)
--EXTENSIONS--
dom
--FILE--
<?php

function test($mutator) {
$html = <<<XML
<body>
<div></div><div></div>
</body>
XML;

$dom = new DOMDocument();
$dom->loadXML($html);

$divs = iterator_to_array($dom->getElementsByTagName('div')->getIterator());
$i = 0;
foreach ($divs as $div) {
$mutator($dom, $div, $i);
echo $dom->saveHTML();
$i++;
}
}

echo "--- Single replacement ---\n";

test(function($dom, $div, $i) {
$fragment = $dom->createDocumentFragment();
$fragment->appendXML("<p>Hi $i!</p>");
$div->replaceWith($fragment);
});

echo "--- Multiple replacement ---\n";

test(function($dom, $div, $i) {
$fragment = $dom->createDocumentFragment();
$fragment->appendXML("<p>Hi $i!</p>");
$div->replaceWith($fragment, $dom->createElement('x'), "hello");
});

echo "--- Empty fragment replacement ---\n";

test(function($dom, $div, $i) {
$fragment = $dom->createDocumentFragment();
$div->replaceWith($fragment);
});

?>
--EXPECT--
--- Single replacement ---
<body>
<p>Hi 0!</p><div></div>
</body>
<body>
<p>Hi 0!</p><p>Hi 1!</p>
</body>
--- Multiple replacement ---
<body>
<p>Hi 0!</p><x></x>hello<div></div>
</body>
<body>
<p>Hi 0!</p><x></x>hello<p>Hi 1!</p><x></x>hello
</body>
--- Empty fragment replacement ---
<body>
<div></div>
</body>
<body>

</body>