Implement Document::$body getter

Author: nielsdos

ext/dom/dom_properties.h

@@ -64,6 +64,7 @@ zend_result dom_document_substitue_entities_write(dom_object *obj, zval *newval)
 
 /* html5 document properties */
 zend_result dom_html_document_encoding_write(dom_object *obj, zval *retval);
+zend_result dom_html_document_body_read(dom_object *obj, zval *retval);
 
 /* documenttype properties */
 zend_result dom_documenttype_name_read(dom_object *obj, zval *retval);

ext/dom/html_document.c

@@ -1366,4 +1366,28 @@ zend_result dom_html_document_encoding_write(dom_object *obj, zval *newval)
 	return FAILURE;
 }
 
+zend_result dom_html_document_body_read(dom_object *obj, zval *retval)
+{
+	DOM_PROP_NODE(const xmlDoc *, docp, obj);
+
+	const xmlNode *root = xmlDocGetRootElement(docp);
+	if (root == NULL || !(php_dom_ns_is_fast(root, php_dom_ns_is_html_magic_token) && xmlStrEqual(root->name, BAD_CAST "html"))) {
+		ZVAL_NULL(retval);
+		return SUCCESS;
+	}
+
+	xmlNodePtr cur = root->children;
+	while (cur != NULL) {
+		if (cur->type == XML_ELEMENT_NODE && php_dom_ns_is_fast(cur, php_dom_ns_is_html_magic_token)
+			&& (xmlStrEqual(cur->name, BAD_CAST "body") || xmlStrEqual(cur->name, BAD_CAST "frameset"))) {
+			php_dom_create_object(cur, retval, obj);
+			return SUCCESS;
+		}
+		cur = cur->next;
+	}
+
+	ZVAL_NULL(retval);
+	return SUCCESS;
+}
+
 #endif  /* HAVE_LIBXML && HAVE_DOM */

ext/dom/php_dom.c

@@ -839,6 +839,7 @@ PHP_MINIT_FUNCTION(dom)
 	DOM_REGISTER_PROP_HANDLER(&dom_abstract_base_document_prop_handlers, "firstElementChild", dom_parent_node_first_element_child_read, NULL);
 	DOM_REGISTER_PROP_HANDLER(&dom_abstract_base_document_prop_handlers, "lastElementChild", dom_parent_node_last_element_child_read, NULL);
 	DOM_REGISTER_PROP_HANDLER(&dom_abstract_base_document_prop_handlers, "childElementCount", dom_parent_node_child_element_count, NULL);
+	DOM_REGISTER_PROP_HANDLER(&dom_abstract_base_document_prop_handlers, "body", dom_html_document_body_read, NULL);
 	zend_hash_merge(&dom_abstract_base_document_prop_handlers, &dom_modern_node_prop_handlers, NULL, false);
 	/* No need to register in &classes because this is an abstract class handler. */
 

ext/dom/php_dom.stub.php

@@ -1583,6 +1583,11 @@ public function prepend(Node|string ...$nodes): void {}
         public function replaceChildren(Node|string ...$nodes): void {}
 
         public function importLegacyNode(\DOMNode $node, bool $deep = false): Node {}
+
+        /* TODO: HTMLElement, once we decided on whether to implement that ? */
+        public ?Element $body;
+        /** @readonly */
+        public ?Element $head;
     }
 
     final class HTMLDocument extends Document

ext/dom/php_dom_arginfo.h

@@ -0,0 +1,98 @@
+--TEST--
+Test DOM\Document::$body
+--EXTENSIONS--
+dom
+--FILE--
+<?php
+
+echo "--- From parsing ---\n";
+
+$dom = DOM\HTMLDocument::createFromString("<p>foo</p>", LIBXML_NOERROR);
+var_dump($dom->body?->nodeName);
+
+echo "--- After body removal ---\n";
+
+$dom->body->remove();
+var_dump($dom->body?->nodeName);
+
+echo "--- body in no namespace ---\n";
+
+$tmp = $dom->documentElement->appendChild($dom->createElementNS("", "body"));
+var_dump($dom->body?->nodeName);
+$tmp->remove();
+
+echo "--- frameset in no namespace ---\n";
+
+$tmp = $dom->documentElement->appendChild($dom->createElementNS("", "frameset"));
+var_dump($dom->body?->nodeName);
+$tmp->remove();
+
+echo "--- body in right namespace ---\n";
+
+$tmp = $dom->documentElement->appendChild($dom->createElementNS("http://www.w3.org/1999/xhtml", "body"));
+var_dump($dom->body?->nodeName);
+$tmp->remove();
+
+echo "--- frameset in right namespace ---\n";
+
+$tmp = $dom->documentElement->appendChild($dom->createElementNS("http://www.w3.org/1999/xhtml", "frameset"));
+var_dump($dom->body?->nodeName);
+$tmp->remove();
+
+echo "--- prefixed body in right namespace ---\n";
+
+$tmp = $dom->documentElement->appendChild($dom->createElementNS("http://www.w3.org/1999/xhtml", "prefix:body"));
+var_dump($dom->body?->nodeName);
+$tmp->remove();
+
+echo "--- prefixed frameset in right namespace ---\n";
+
+$tmp = $dom->documentElement->appendChild($dom->createElementNS("http://www.w3.org/1999/xhtml", "prefix:frameset"));
+var_dump($dom->body?->nodeName);
+$tmp->remove();
+
+echo "--- multiple body-like elements in right namespace ---\n";
+
+$tmp1 = $dom->documentElement->appendChild($dom->createElementNS("http://www.w3.org/1999/xhtml", "prefix1:body"));
+var_dump($dom->body?->nodeName);
+$tmp2 = $dom->documentElement->appendChild($dom->createElementNS("http://www.w3.org/1999/xhtml", "prefix2:frameset"));
+var_dump($dom->body?->nodeName);
+$tmp1->remove();
+var_dump($dom->body?->nodeName);
+$tmp2->remove();
+var_dump($dom->body?->nodeName);
+
+echo "--- html element in no namespace ---\n";
+
+$dom = DOM\XMLDocument::createFromString(<<<XML
+<html xmlns="">
+  <body/>
+</html>
+XML);
+var_dump($dom->body);
+
+?>
+--EXPECT--
+--- From parsing ---
+string(4) "BODY"
+--- After body removal ---
+NULL
+--- body in no namespace ---
+NULL
+--- frameset in no namespace ---
+NULL
+--- body in right namespace ---
+string(4) "BODY"
+--- frameset in right namespace ---
+string(8) "FRAMESET"
+--- prefixed body in right namespace ---
+string(11) "PREFIX:BODY"
+--- prefixed frameset in right namespace ---
+string(15) "PREFIX:FRAMESET"
+--- multiple body-like elements in right namespace ---
+string(12) "PREFIX1:BODY"
+string(12) "PREFIX1:BODY"
+string(16) "PREFIX2:FRAMESET"
+NULL
+--- html element in no namespace ---
+NULL

ext/dom/tests/modern/html/interactions/Document_body.phpt

@@ -23,7 +23,7 @@ var_dump(get_class($dom->getElementsByTagName("p")->item(0)));
 
 ?>
 --EXPECT--
-object(DOM\HTMLDocument)#1 (25) {
+object(DOM\HTMLDocument)#1 (26) {
   ["implementation"]=>
   string(22) "(object value omitted)"
   ["URL"]=>
@@ -46,6 +46,8 @@ object(DOM\HTMLDocument)#1 (25) {
   string(22) "(object value omitted)"
   ["childElementCount"]=>
   int(1)
+  ["body"]=>
+  string(22) "(object value omitted)"
   ["nodeType"]=>
   int(13)
   ["nodeName"]=>

ext/dom/tests/modern/html/interactions/HTMLDocument_should_retain_properties_and_owner_01.phpt

@@ -23,7 +23,7 @@ var_dump(get_class($dom->getElementsByTagName("p")->item(0)));
 
 ?>
 --EXPECT--
-object(DOM\HTMLDocument)#1 (25) {
+object(DOM\HTMLDocument)#1 (26) {
   ["implementation"]=>
   string(22) "(object value omitted)"
   ["URL"]=>
@@ -46,6 +46,8 @@ object(DOM\HTMLDocument)#1 (25) {
   string(22) "(object value omitted)"
   ["childElementCount"]=>
   int(1)
+  ["body"]=>
+  string(22) "(object value omitted)"
   ["nodeType"]=>
   int(13)
   ["nodeName"]=>

ext/dom/tests/modern/html/interactions/HTMLDocument_should_retain_properties_and_owner_02.phpt

@@ -37,7 +37,7 @@ echo $dom->implementation->createDocument(null, "", $dtd)->saveXML(), "\n";
 ?>
 --EXPECT--
 --- (null, "") ---
-object(DOM\XMLDocument)#3 (29) {
+object(DOM\XMLDocument)#3 (30) {
   ["xmlEncoding"]=>
   string(5) "UTF-8"
   ["xmlStandalone"]=>
@@ -68,6 +68,8 @@ object(DOM\XMLDocument)#3 (29) {
   NULL
   ["childElementCount"]=>
   int(0)
+  ["body"]=>
+  NULL
   ["nodeType"]=>
   int(9)
   ["nodeName"]=>

ext/dom/tests/modern/spec/Document_implementation_createDocument.phpt

@@ -10,7 +10,7 @@ var_dump($dom);
 
 ?>
 --EXPECT--
-object(DOM\XMLDocument)#1 (29) {
+object(DOM\XMLDocument)#1 (30) {
   ["xmlEncoding"]=>
   string(5) "UTF-8"
   ["xmlStandalone"]=>
@@ -41,6 +41,8 @@ object(DOM\XMLDocument)#1 (29) {
   NULL
   ["childElementCount"]=>
   int(0)
+  ["body"]=>
+  NULL
   ["nodeType"]=>
   int(9)
   ["nodeName"]=>

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

@@ -10,7 +10,7 @@ var_dump($dom);
 
 ?>
 --EXPECT--
-object(DOM\XMLDocument)#1 (29) {
+object(DOM\XMLDocument)#1 (30) {
   ["xmlEncoding"]=>
   string(5) "UTF-8"
   ["xmlStandalone"]=>
@@ -41,6 +41,8 @@ object(DOM\XMLDocument)#1 (29) {
   NULL
   ["childElementCount"]=>
   int(0)
+  ["body"]=>
+  NULL
   ["nodeType"]=>
   int(9)
   ["nodeName"]=>

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

@@ -13,7 +13,7 @@ var_dump($element->ownerDocument);
 
 ?>
 --EXPECTF--
-object(DOM\XMLDocument)#1 (29) {
+object(DOM\XMLDocument)#1 (30) {
   ["xmlEncoding"]=>
   string(5) "UTF-8"
   ["xmlStandalone"]=>
@@ -44,6 +44,8 @@ object(DOM\XMLDocument)#1 (29) {
   string(22) "(object value omitted)"
   ["childElementCount"]=>
   int(1)
+  ["body"]=>
+  NULL
   ["nodeType"]=>
   int(9)
   ["nodeName"]=>