[RFC] Implement XMLWriter::toUri() and XMLWriter::toMemory()

Author: ndossche

NEWS

@@ -327,7 +327,7 @@ PHP                                                                        NEWS
   . Add XMLReader::fromStream(). (nielsdos)
 
 - XMLWriter:
-  . Add XMLWriter::toStream(). (nielsdos)
+  . Add XMLWriter::toStream(), XMLWriter::toUri(), XMLWriter::toMemory(). (nielsdos)
 
 - XSL:
   . Implement request #64137 (XSLTProcessor::setParameter() should allow both

UPGRADING

@@ -633,7 +633,7 @@ PHP 8.4 UPGRADE NOTES
     RFC: https://wiki.php.net/rfc/xmlreader_writer_streams
 
 - XMLWriter:
-  . Added XMLWriter::toStream().
+  . Added XMLWriter::toStream(), XMLWriter::toUri(), XMLWriter::toMemory().
     RFC: https://wiki.php.net/rfc/xmlreader_writer_streams
 
 - XSL:

ext/xmlwriter/php_xmlwriter.c

@@ -179,6 +179,18 @@ static char *_xmlwriter_get_valid_file_path(char *source, char *resolved_path, i
 }
 /* }}} */
 
+static void xml_writer_create_static(INTERNAL_FUNCTION_PARAMETERS, xmlTextWriterPtr writer, xmlBufferPtr output)
+{
+	if (object_init_with_constructor(return_value, Z_CE_P(ZEND_THIS), 0, NULL, NULL) == SUCCESS) {
+		ze_xmlwriter_object *intern = Z_XMLWRITER_P(return_value);
+		intern->ptr = writer;
+		intern->output = output;
+	} else {
+		xmlBufferFree(output);
+		xmlFreeTextWriter(writer);
+	}
+}
+
 static const zend_module_dep xmlwriter_deps[] = {
 	ZEND_MOD_REQUIRED("libxml")
 	ZEND_MOD_END
@@ -836,6 +848,36 @@ PHP_FUNCTION(xmlwriter_open_uri)
 }
 /* }}} */
 
+PHP_METHOD(XMLWriter, toUri)
+{
+	char *source;
+	size_t source_len;
+	char resolved_path[MAXPATHLEN + 1];
+
+	ZEND_PARSE_PARAMETERS_START(1, 1)
+		Z_PARAM_PATH(source, source_len)
+	ZEND_PARSE_PARAMETERS_END();
+
+	if (source_len == 0) {
+		zend_argument_value_error(1, "cannot be empty");
+		RETURN_THROWS();
+	}
+
+	const char *valid_file = _xmlwriter_get_valid_file_path(source, resolved_path, MAXPATHLEN);
+	if (!valid_file) {
+		zend_argument_value_error(1, "must resolve to a valid file path");
+		RETURN_THROWS();
+	}
+
+	xmlTextWriterPtr writer = xmlNewTextWriterFilename(valid_file, 0);
+	if (!writer) {
+		zend_throw_error(NULL, "Could not construct libxml writer");
+		RETURN_THROWS();
+	}
+
+	xml_writer_create_static(INTERNAL_FUNCTION_PARAM_PASSTHRU, writer, NULL);
+}
+
 /* {{{ Create new xmlwriter using memory for string output */
 PHP_FUNCTION(xmlwriter_open_memory)
 {
@@ -881,6 +923,23 @@ PHP_FUNCTION(xmlwriter_open_memory)
 }
 /* }}} */
 
+PHP_METHOD(XMLWriter, toMemory)
+{
+	ZEND_PARSE_PARAMETERS_NONE();
+
+	xmlBufferPtr buffer = xmlBufferCreate();
+	xmlTextWriterPtr writer = xmlNewTextWriterMemory(buffer, 0);
+
+	/* No need for an explicit buffer check as this will fail on a NULL buffer. */
+	if (!writer) {
+		xmlBufferFree(buffer);
+		zend_throw_error(NULL, "Could not construct libxml writer");
+		RETURN_THROWS();
+	}
+
+	xml_writer_create_static(INTERNAL_FUNCTION_PARAM_PASSTHRU, writer, buffer);
+}
+
 static int xml_writer_stream_write(void *context, const char *buffer, int len)
 {
 	zend_resource *resource = context;
@@ -927,14 +986,8 @@ PHP_METHOD(XMLWriter, toStream)
 		RETURN_THROWS();
 	}
 
-	if (object_init_with_constructor(return_value, Z_CE_P(ZEND_THIS), 0, NULL, NULL) == SUCCESS) {
-		ze_xmlwriter_object *intern = Z_XMLWRITER_P(return_value);
-		intern->ptr = writer;
-		/* output_buffer is owned by writer, and so writer will clean that up for us. */
-		intern->output = NULL;
-	} else {
-		xmlFreeTextWriter(writer);
-	}
+	/* output_buffer is owned by writer, and so writer will clean that up for us. */
+	xml_writer_create_static(INTERNAL_FUNCTION_PARAM_PASSTHRU, writer, NULL);
 }
 
 /* {{{ php_xmlwriter_flush */

ext/xmlwriter/php_xmlwriter.stub.php

@@ -95,13 +95,17 @@ class XMLWriter
      */
     public function openUri(string $uri): bool {}
 
+    public static function toUri(string $uri): static {}
+
     /**
      * @tentative-return-type
      * @alias xmlwriter_open_memory
      * @no-verify Behaviour differs from the aliased function
      */
     public function openMemory(): bool {}
 
+    public static function toMemory(): static {}
+
     /** @param resource $stream */
     public static function toStream($stream): static {}
 

ext/xmlwriter/php_xmlwriter_arginfo.h

@@ -0,0 +1,30 @@
+--TEST--
+XMLWriter::toMemory() - custom constructor
+--EXTENSIONS--
+xmlwriter
+--FILE--
+<?php
+
+class CustomXMLWriter extends XMLWriter {
+    public int $myField;
+
+    public function __construct() {
+        $this->myField = 1234;
+        echo "hello world\n";
+    }
+}
+
+$writer = CustomXMLWriter::toMemory();
+var_dump($writer);
+$writer->startElement("root");
+$writer->endElement();
+echo $writer->outputMemory();
+
+?>
+--EXPECTF--
+hello world
+object(CustomXMLWriter)#%d (1) {
+  ["myField"]=>
+  int(1234)
+}
+<root/>

ext/xmlwriter/tests/xmlwriter_toMemory_custom_constructor.phpt

@@ -0,0 +1,22 @@
+--TEST--
+XMLWriter::toMemory() - custom constructor error
+--EXTENSIONS--
+xmlwriter
+--FILE--
+<?php
+
+class CustomXMLWriter extends XMLWriter {
+    public function __construct() {
+        throw new Error('nope');
+    }
+}
+
+try {
+    CustomXMLWriter::toMemory();
+} catch (Throwable $e) {
+    echo $e->getMessage(), "\n";
+}
+
+?>
+--EXPECT--
+nope

ext/xmlwriter/tests/xmlwriter_toMemory_custom_constructor_error.phpt

@@ -0,0 +1,17 @@
+--TEST--
+XMLWriter::toMemory() - normal usage
+--EXTENSIONS--
+xmlwriter
+--FILE--
+<?php
+
+$writer = XMLWriter::toMemory();
+$writer->startElement("root");
+$writer->writeAttribute("align", "left");
+$writer->writeComment("hello");
+$writer->endElement();
+echo $writer->outputMemory();
+
+?>
+--EXPECT--
+<root align="left"><!--hello--></root>