Make XMLDocument::xinclude() return values and error conditions sane

See https://wiki.php.net/rfc/dom_additions_84#api_amendments

Author: nielsdos

ext/dom/document.c

@@ -1706,17 +1706,36 @@ static void php_dom_remove_xinclude_nodes(xmlNodePtr cur) /* {{{ */
 }
 /* }}} */
 
-/* {{{ Substitutues xincludes in a DomDocument */
+/* {{{ Substitutes xincludes in a DomDocument */
+static int dom_perform_xinclude(xmlDocPtr docp, dom_object *intern, zend_long flags)
+{
+	PHP_LIBXML_SANITIZE_GLOBALS(xinclude);
+	int err = xmlXIncludeProcessFlags(docp, (int)flags);
+	PHP_LIBXML_RESTORE_GLOBALS(xinclude);
+
+	/* XML_XINCLUDE_START and XML_XINCLUDE_END nodes need to be removed as these
+	are added via xmlXIncludeProcess to mark beginning and ending of xincluded document
+	but are not wanted in resulting document - must be done even if err as it could fail after
+	having processed some xincludes */
+	xmlNodePtr root = docp->children;
+	while (root && root->type != XML_ELEMENT_NODE && root->type != XML_XINCLUDE_START) {
+		root = root->next;
+	}
+	if (root) {
+		php_dom_remove_xinclude_nodes(root);
+	}
+
+	php_libxml_invalidate_node_list_cache(intern->document);
+
+	return err;
+}
+
 PHP_METHOD(DOMDocument, xinclude)
 {
-	zval *id;
 	xmlDoc *docp;
-	xmlNodePtr root;
 	zend_long flags = 0;
-	int err;
 	dom_object *intern;
 
-	id = ZEND_THIS;
 	if (zend_parse_parameters(ZEND_NUM_ARGS(), "|l", &flags) == FAILURE) {
 		RETURN_THROWS();
 	}
@@ -1726,30 +1745,40 @@ PHP_METHOD(DOMDocument, xinclude)
 		RETURN_FALSE;
 	}
 
-	DOM_GET_OBJ(docp, id, xmlDocPtr, intern);
+	DOM_GET_OBJ(docp, ZEND_THIS, xmlDocPtr, intern);
 
-	PHP_LIBXML_SANITIZE_GLOBALS(xinclude);
-	err = xmlXIncludeProcessFlags(docp, (int)flags);
-	PHP_LIBXML_RESTORE_GLOBALS(xinclude);
+	int err = dom_perform_xinclude(docp, intern, flags);
 
-	/* XML_XINCLUDE_START and XML_XINCLUDE_END nodes need to be removed as these
-	are added via xmlXIncludeProcess to mark beginning and ending of xincluded document
-	but are not wanted in resulting document - must be done even if err as it could fail after
-	having processed some xincludes */
-	root = (xmlNodePtr) docp->children;
-	while(root && root->type != XML_ELEMENT_NODE && root->type != XML_XINCLUDE_START) {
-		root = root->next;
+	if (err) {
+		RETVAL_LONG(err);
+	} else {
+		RETVAL_FALSE;
 	}
-	if (root) {
-		php_dom_remove_xinclude_nodes(root);
+}
+
+PHP_METHOD(Dom_XMLDocument, xinclude)
+{
+	xmlDoc *docp;
+	zend_long flags = 0;
+	dom_object *intern;
+
+	if (zend_parse_parameters(ZEND_NUM_ARGS(), "|l", &flags) == FAILURE) {
+		RETURN_THROWS();
 	}
 
-	php_libxml_invalidate_node_list_cache(intern->document);
+	if (ZEND_LONG_EXCEEDS_INT(flags)) {
+		zend_argument_value_error(1, "is too large");
+		RETURN_THROWS();
+	}
 
-	if (err) {
-		RETVAL_LONG(err);
+	DOM_GET_OBJ(docp, ZEND_THIS, xmlDocPtr, intern);
+
+	int err = dom_perform_xinclude(docp, intern, flags);
+
+	if (err < 0) {
+		php_dom_throw_error(INVALID_MODIFICATION_ERR, /* strict */ true);
 	} else {
-		RETVAL_FALSE;
+		RETURN_LONG(err);
 	}
 }
 /* }}} */

ext/dom/php_dom.stub.php

@@ -1617,8 +1617,7 @@ public function createEntityReference(string $name): EntityReference {}
         /** @implementation-alias DOMDocument::validate */
         public function validate(): bool {}
 
-        /** @implementation-alias DOMDocument::xinclude */
-        public function xinclude(int $options = 0): int|false {}
+        public function xinclude(int $options = 0): int {}
 
         public function saveXml(?Node $node = null, int $options = 0): string|false {}
 

ext/dom/php_dom_arginfo.h

@@ -8,22 +8,27 @@ in_array('compress.zlib', stream_get_wrappers()) or die('skip compress.zlib wrap
 ?>
 --FILE--
 <?php
-$dom = new domdocument;
-
 $data = file_get_contents(__DIR__."/xinclude.xml");
 $reldir = str_replace(getcwd(),".",__DIR__);
 if (DIRECTORY_SEPARATOR == '\\') {
     $reldir = str_replace('\\',"/", $reldir);
 }
 $data = str_replace('compress.zlib://ext/dom/tests/','compress.zlib://'.$reldir."/", $data);
 
-
+$dom = new domdocument;
 $dom->loadXML($data);
 $dom->xinclude();
 print $dom->saveXML()."\n";
 foreach ($dom->documentElement->childNodes as $node) {
     print $node->nodeName."\n";
 }
+
+$dom = Dom\XMLDocument::createFromString($data);
+$dom->xinclude();
+print $dom->saveXML()."\n";
+foreach ($dom->documentElement->childNodes as $node) {
+    print $node->nodeName."\n";
+}
 ?>
 --EXPECTF--
 <?xml version="1.0"?>
@@ -41,3 +46,17 @@ foreach ($dom->documentElement->childNodes as $node) {
 book
 book
 #text
+<?xml version="1.0" encoding="UTF-8"?>
+<foo xmlns:xi="http://www.w3.org/2001/XInclude">
+    <book xml:base="compress.zlib://./ext/dom/tests/book.xml">
+  <title>The Grapes of Wrath</title>
+  <author>John Steinbeck</author>
+ </book><book xml:base="compress.zlib://./ext/dom/tests/book.xml">
+  <title>The Pearl</title>
+  <author>John Steinbeck</author>
+ </book>
+ </foo>
+#text
+book
+book
+#text

ext/dom/tests/dom_xinclude.phpt

@@ -0,0 +1,23 @@
+--TEST--
+Test: Xinclude errors
+--EXTENSIONS--
+dom
+--SKIPIF--
+<?php
+if (PHP_INT_SIZE != 8) die("skip for 64bit platforms only");
+?>
+--FILE--
+<?php
+$dom = new DOMDocument;
+$dom->xinclude(PHP_INT_MAX);
+
+$dom = Dom\XMLDocument::createEmpty();
+try {
+    $dom->xinclude(PHP_INT_MAX);
+} catch (ValueError $e) {
+    echo $e->getMessage();
+}
+?>
+--EXPECTF--
+Warning: DOMDocument::xinclude(): Invalid flags in %s on line %d
+Dom\XMLDocument::xinclude(): Argument #1 ($options) is too large