Add Dom\Element::$outerHTML setter

Reference: https://html.spec.whatwg.org/multipage/dynamic-markup-insertion.html#the-outerhtml-property

Author: ndossche

ext/dom/dom_properties.h

@@ -87,6 +87,7 @@ zend_result dom_element_schema_type_info_read(dom_object *obj, zval *retval);
 zend_result dom_element_inner_html_read(dom_object *obj, zval *retval);
 zend_result dom_element_inner_html_write(dom_object *obj, zval *newval);
 zend_result dom_element_outer_html_read(dom_object *obj, zval *retval);
+zend_result dom_element_outer_html_write(dom_object *obj, zval *newval);
 zend_result dom_element_class_list_read(dom_object *obj, zval *retval);
 zend_result dom_modern_element_substituted_node_value_read(dom_object *obj, zval *retval);
 zend_result dom_modern_element_substituted_node_value_write(dom_object *obj, zval *newval);

ext/dom/inner_html_mixin.c

@@ -341,23 +341,31 @@ static xmlNodePtr dom_xml_fragment_parsing_algorithm(dom_object *obj, const xmlN
 	return NULL;
 }
 
-/* https://w3c.github.io/DOM-Parsing/#the-innerhtml-mixin
- * and https://w3c.github.io/DOM-Parsing/#dfn-fragment-parsing-algorithm */
-zend_result dom_element_inner_html_write(dom_object *obj, zval *newval)
+/* https://w3c.github.io/DOM-Parsing/#dfn-fragment-parsing-algorithm */
+static xmlNodePtr dom_parse_fragment(dom_object *obj, xmlNodePtr context_node, const zend_string *input)
 {
-	DOM_PROP_NODE(xmlNodePtr, context_node, obj);
-
-	xmlNodePtr fragment;
 	if (context_node->doc->type == XML_DOCUMENT_NODE) {
-		fragment = dom_xml_fragment_parsing_algorithm(obj, context_node, Z_STR_P(newval));
+		return dom_xml_fragment_parsing_algorithm(obj, context_node, input);
 	} else {
-		fragment = dom_html_fragment_parsing_algorithm(obj, context_node, Z_STR_P(newval), obj->document->quirks_mode);
+		return dom_html_fragment_parsing_algorithm(obj, context_node, input, obj->document->quirks_mode);
 	}
+}
+
+/* https://w3c.github.io/DOM-Parsing/#the-innerhtml-mixin */
+zend_result dom_element_inner_html_write(dom_object *obj, zval *newval)
+{
+	/* 1. We don't do injection sinks, skip. */
+
+	/* 2. Let context be this. */
+	DOM_PROP_NODE(xmlNodePtr, context_node, obj);
 
+	/* 3. Let fragment be the result of invoking the fragment parsing algorithm steps with context and compliantString. */
+	xmlNodePtr fragment = dom_parse_fragment(obj, context_node, Z_STR_P(newval));
 	if (fragment == NULL) {
 		return FAILURE;
 	}
 
+	/* 4. If context is a template element, then set context to the template element's template contents (a DocumentFragment). */
 	if (php_dom_ns_is_fast(context_node, php_dom_ns_is_html_magic_token) && xmlStrEqual(context_node->name, BAD_CAST "template")) {
 		context_node = php_dom_ensure_templated_content(php_dom_get_private_data(obj), context_node);
 		if (context_node == NULL) {
@@ -366,6 +374,7 @@ zend_result dom_element_inner_html_write(dom_object *obj, zval *newval)
 		}
 	}
 
+	/* 5. Replace all with fragment within context. */
 	dom_remove_all_children(context_node);
 	return php_dom_pre_insert(obj->document, fragment, context_node, NULL) ? SUCCESS : FAILURE;
 }
@@ -397,4 +406,62 @@ zend_result dom_element_outer_html_read(dom_object *obj, zval *retval)
 	return SUCCESS;
 }
 
+/* https://html.spec.whatwg.org/multipage/dynamic-markup-insertion.html#the-outerhtml-property */
+zend_result dom_element_outer_html_write(dom_object *obj, zval *newval)
+{
+	/* 1. We don't do injection sinks, skip. */
+
+	/* 2. Let parent be this's parent. */
+	DOM_PROP_NODE(xmlNodePtr, this, obj);
+	xmlNodePtr parent = this->parent;
+	bool created_parent = false;
+
+	/* 3. If parent is null, return. */
+	if (parent == NULL) {
+		return SUCCESS;
+	}
+
+	/* 4. If parent is a Document, throw. */
+	if (parent->type == XML_DOCUMENT_NODE || parent->type == XML_HTML_DOCUMENT_NODE) {
+		php_dom_throw_error(INVALID_MODIFICATION_ERR, true);
+		return FAILURE;
+	}
+
+	/* 5. If parent is a DocumentFragment, set parent to the result of creating an element given this's node document, body, and the HTML namespace. */
+	if (parent->type == XML_DOCUMENT_FRAG_NODE) {
+		xmlNsPtr html_ns = php_dom_libxml_ns_mapper_ensure_html_ns(php_dom_get_ns_mapper(obj));
+
+		parent = xmlNewDocNode(parent->doc, html_ns, BAD_CAST "body", NULL);
+		created_parent = true;
+		if (UNEXPECTED(parent == NULL)) {
+			php_dom_throw_error(INVALID_STATE_ERR, true);
+			return FAILURE;
+		}
+	}
+
+	/* 6. Let fragment be the result of invoking the fragment parsing algorithm steps given parent and compliantString. */
+	xmlNodePtr fragment = dom_parse_fragment(obj, parent, Z_STR_P(newval));
+	if (fragment == NULL) {
+		if (created_parent) {
+			xmlFreeNode(parent);
+		}
+		return FAILURE;
+	}
+
+	/* 7. Replace this with fragment within this's parent. */
+	if (!php_dom_pre_insert(obj->document, fragment, this->parent, this)) {
+		xmlFreeNode(fragment);
+		if (created_parent) {
+			xmlFreeNode(parent);
+		}
+		return FAILURE;
+	}
+	xmlUnlinkNode(this);
+	if (created_parent) {
+		ZEND_ASSERT(parent->children == NULL);
+		xmlFreeNode(parent);
+	}
+	return SUCCESS;
+}
+
 #endif

ext/dom/php_dom.c

@@ -1111,7 +1111,7 @@ PHP_MINIT_FUNCTION(dom)
 	DOM_REGISTER_PROP_HANDLER(&dom_modern_element_prop_handlers, "previousElementSibling", dom_node_previous_element_sibling_read, NULL);
 	DOM_REGISTER_PROP_HANDLER(&dom_modern_element_prop_handlers, "nextElementSibling", dom_node_next_element_sibling_read, NULL);
 	DOM_REGISTER_PROP_HANDLER(&dom_modern_element_prop_handlers, "innerHTML", dom_element_inner_html_read, dom_element_inner_html_write);
-	DOM_REGISTER_PROP_HANDLER(&dom_modern_element_prop_handlers, "outerHTML", dom_element_outer_html_read, NULL);
+	DOM_REGISTER_PROP_HANDLER(&dom_modern_element_prop_handlers, "outerHTML", dom_element_outer_html_read, dom_element_outer_html_write);
 	DOM_REGISTER_PROP_HANDLER(&dom_modern_element_prop_handlers, "substitutedNodeValue", dom_modern_element_substituted_node_value_read, dom_modern_element_substituted_node_value_write);
 	zend_hash_merge(&dom_modern_element_prop_handlers, &dom_modern_node_prop_handlers, NULL, false);
 	DOM_OVERWRITE_PROP_HANDLER(&dom_modern_element_prop_handlers, "textContent", dom_node_text_content_read, dom_node_text_content_write);

ext/dom/tests/modern/html/parser/Element_outerHTML.phpt

@@ -0,0 +1,28 @@
+--TEST--
+Test writing Element::$outerHTML on HTML documents
+--EXTENSIONS--
+dom
+--FILE--
+<?php
+
+$dom = Dom\HTMLDocument::createFromString('<p>foo</p>', LIBXML_NOERROR);
+$p = $dom->body->firstChild;
+$p->outerHTML = '<div></div>&nbsp;<p>'; // intentionally unclosed
+echo $dom->saveXML(), "\n";
+$div = $dom->body->firstChild;
+$div->outerHTML = "invalid\xffutf-8𐍈𐍈𐍈";
+echo $dom->saveXML(), "\n";
+
+$dom->body->outerHTML = '<template><p>foo</p></template>';
+var_dump($dom->body->querySelector('p')); // Should be NULL because the template contents do not participate in the DOM tree
+echo $dom->saveXML(), "\n";
+
+?>
+--EXPECT--
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<html xmlns="http://www.w3.org/1999/xhtml"><head></head><body><div></div> <p></p></body></html>
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<html xmlns="http://www.w3.org/1999/xhtml"><head></head><body>invalid�utf-8𐍈𐍈𐍈 <p></p></body></html>
+NULL
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<html xmlns="http://www.w3.org/1999/xhtml"><head></head><head><template><p>foo</p></template></head><body></body></html>

ext/dom/tests/modern/xml/Element_outerHTML_writing.phpt

@@ -0,0 +1,35 @@
+--TEST--
+Test writing Element::$outerHTML on XML documents
+--EXTENSIONS--
+dom
+--FILE--
+<?php
+
+$dom = Dom\XMLDocument::createFromString("<root xmlns='urn:a'><x/></root>");
+$dom->documentElement->firstChild->outerHTML = '<x xmlns="urn:a"><p>foo</p><p xmlns="urn:x">bar</p></x>';
+echo $dom->saveXML(), "\n";
+
+$dom->documentElement->firstChild->outerHTML = $dom->documentElement->firstChild->outerHTML;
+$element = $dom->documentElement->firstChild->firstChild;
+echo $dom->saveXML(), "\n";
+
+$dom->documentElement->firstChild->outerHTML = 'tést';
+echo $dom->saveXML(), "\n";
+
+var_dump($element->tagName);
+
+$fragment = $dom->createDocumentFragment();
+$fragment->appendChild($dom->createElement('p'));
+$fragment->firstChild->outerHTML = '<strong>bar</strong>';
+echo $dom->saveXML($fragment), "\n";
+
+?>
+--EXPECT--
+<?xml version="1.0" encoding="UTF-8"?>
+<root xmlns="urn:a"><x xmlns="urn:a"><p>foo</p><p xmlns="urn:x">bar</p></x></root>
+<?xml version="1.0" encoding="UTF-8"?>
+<root xmlns="urn:a"><x xmlns="urn:a"><p>foo</p><p xmlns="urn:x">bar</p></x></root>
+<?xml version="1.0" encoding="UTF-8"?>
+<root xmlns="urn:a">tést</root>
+string(1) "p"
+<strong xmlns="http://www.w3.org/1999/xhtml">bar</strong>

ext/dom/tests/modern/xml/Element_outerHTML_writing_errors.phpt

@@ -0,0 +1,25 @@
+--TEST--
+Test writing Element::$outerHTML on XML documents - error cases
+--EXTENSIONS--
+dom
+--FILE--
+<?php
+
+$dom = Dom\XMLDocument::createFromString('<root/>');
+try {
+    $dom->documentElement->outerHTML = '<x/>';
+} catch (DOMException $e) {
+    echo $e->getMessage(), "\n";
+}
+
+$dom = Dom\XMLDocument::createFromString('<root><child/></root>');
+try {
+    $dom->documentElement->firstChild->outerHTML = '<!DOCTYPE html>';
+} catch (DOMException $e) {
+    echo $e->getMessage(), "\n";
+}
+
+?>
+--EXPECT--
+Invalid Modification Error
+XML fragment is not well-formed

ext/dom/xml_serializer.c

@@ -48,7 +48,7 @@
  */
 
 #define TRY(x) do { if (UNEXPECTED((x) < 0)) { return -1; } } while (0)
-#define TRY_OR_CLEANUP(x) do { if (UNEXPECTED((x) < 0)) { goto cleanup; } } while (0)
+#define TRY_OR_CLEANUP(x) do { if (UNEXPECTED((x) < 0)) { printf("fail %d\n",__LINE__);goto cleanup; } } while (0)
 
 #define xmlOutputBufferWriteLit(out, literal) xmlOutputBufferWrite((out), strlen("" literal), "" literal)