Handle dumping document to file

Author: nielsdos

ext/dom/document.c

@@ -1540,7 +1540,7 @@ PHP_METHOD(DOMDocument, save)
 	zval *id;
 	xmlDoc *docp;
 	size_t file_len = 0;
-	int bytes, format, saveempty = 0;
+	int saveempty = 0;
 	dom_object *intern;
 	char *file;
 	zend_long options = 0;
@@ -1560,13 +1560,12 @@ PHP_METHOD(DOMDocument, save)
 	/* encoding handled by property on doc */
 
 	libxml_doc_props const* doc_props = dom_get_doc_props_read_only(intern->document);
-	format = doc_props->formatoutput;
+	bool format = doc_props->formatoutput;
 	if (options & LIBXML_SAVE_NOEMPTYTAG) {
 		saveempty = xmlSaveNoEmptyTags;
 		xmlSaveNoEmptyTags = 1;
 	}
-	// TODO: use modern API when necessary
-	bytes = xmlSaveFormatFileEnc(file, docp, NULL, format);
+	zend_long bytes = intern->document->handlers->dump_doc_to_file(file, docp, format, (const char *) docp->encoding);
 	if (options & LIBXML_SAVE_NOEMPTYTAG) {
 		xmlSaveNoEmptyTags = saveempty;
 	}

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

@@ -6,10 +6,15 @@ dom
 <?php
 
 $dom = Dom\XMLDocument::createFromString('<?xml version="1.0"?><container/>');
-var_dump($dom->saveXmlFile("php://stdout"));
+var_dump($dom->saveXmlFile(__DIR__ . "/fromString_02.xml"));
+echo file_get_contents(__DIR__ . "/fromString_02.xml");
 
+?>
+--CLEAN--
+<?php
+@unlink(__DIR__ . "/fromString_02.xml");
 ?>
 --EXPECT--
+int(51)
 <?xml version="1.0" encoding="UTF-8"?>
 <container/>
-int(52)

ext/dom/xml_document.c

@@ -293,9 +293,36 @@ static zend_string *php_new_dom_dump_doc_to_str(xmlDocPtr doc, int options, cons
 	return php_new_dom_dump_node_to_str(doc, (xmlNodePtr) doc, options & XML_SAVE_FORMAT, encoding);
 }
 
+static zend_long php_new_dom_dump_doc_to_file(const char *filename, xmlDocPtr doc, bool format, const char *encoding)
+{
+	xmlCharEncodingHandlerPtr handler = xmlFindCharEncodingHandler(encoding);
+	xmlOutputBufferPtr out = xmlOutputBufferCreateFilename(filename, handler, 0);
+	if (!out) {
+		xmlCharEncCloseFunc(handler);
+		return -1;
+	}
+
+	php_stream *stream = out->context;
+
+	int status = -1;
+	xmlSaveCtxtPtr ctxt = xmlSaveToIO(out->writecallback, NULL, stream, encoding, XML_SAVE_AS_XML);
+	if (EXPECTED(ctxt != NULL)) {
+		status = dom_xml_serialize(ctxt, out, (xmlNodePtr) doc, format);
+		status |= xmlOutputBufferFlush(out);
+		(void) xmlSaveClose(ctxt);
+	}
+
+	size_t offset = php_stream_tell(stream);
+
+	(void) xmlOutputBufferClose(out);
+
+	return status < 0 ? status : (zend_long) offset;
+}
+
 static const php_libxml_document_handlers php_new_dom_default_document_handlers = {
 	.dump_node_to_str = php_new_dom_dump_node_to_str,
 	.dump_doc_to_str = php_new_dom_dump_doc_to_str,
+	.dump_doc_to_file = php_new_dom_dump_doc_to_file,
 };
 
 void dom_set_xml_class(php_libxml_ref_obj *document)

ext/libxml/libxml.c

@@ -83,6 +83,7 @@ static zend_result php_libxml_post_deactivate(void);
 
 static zend_string *php_libxml_default_dump_node_to_str(xmlDocPtr doc, xmlNodePtr node, bool format, const char *encoding);
 static zend_string *php_libxml_default_dump_doc_to_str(xmlDocPtr doc, int options, const char *encoding);
+static zend_long php_libxml_default_dump_doc_to_file(const char *filename, xmlDocPtr doc, bool format, const char *encoding);
 
 /* }}} */
 
@@ -108,6 +109,7 @@ zend_module_entry libxml_module_entry = {
 static const php_libxml_document_handlers php_libxml_default_document_handlers = {
 	.dump_node_to_str = php_libxml_default_dump_node_to_str,
 	.dump_doc_to_str = php_libxml_default_dump_doc_to_str,
+	.dump_doc_to_file = php_libxml_default_dump_doc_to_file,
 };
 
 static void php_libxml_set_old_ns_list(xmlDocPtr doc, xmlNsPtr first, xmlNsPtr last)
@@ -1533,6 +1535,11 @@ static zend_string *php_libxml_default_dump_node_to_str(xmlDocPtr doc, xmlNodePt
 	return str;
 }
 
+static zend_long php_libxml_default_dump_doc_to_file(const char *filename, xmlDocPtr doc, bool format, const char *encoding)
+{
+	return xmlSaveFormatFileEnc(filename, doc, encoding, format);
+}
+
 #if defined(PHP_WIN32) && defined(COMPILE_DL_LIBXML)
 PHP_LIBXML_API BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved)
 {

ext/libxml/php_libxml.h

@@ -75,6 +75,7 @@ typedef struct _php_libxml_private_data_header {
 typedef struct php_libxml_document_handlers {
 	zend_string *(*dump_node_to_str)(xmlDocPtr doc, xmlNodePtr node, bool format, const char *encoding);
 	zend_string *(*dump_doc_to_str)(xmlDocPtr doc, int options, const char *encoding);
+	zend_long (*dump_doc_to_file)(const char *filename, xmlDocPtr doc, bool format, const char *encoding);
 } php_libxml_document_handlers;
 
 /**

ext/simplexml/simplexml.c

@@ -1358,10 +1358,11 @@ PHP_METHOD(SimpleXMLElement, asXML)
 		RETURN_FALSE;
 	}
 
+	xmlDocPtr doc = sxe->document->ptr;
+
 	if (filename) {
 		if (node->parent && (XML_DOCUMENT_NODE == node->parent->type)) {
-			int bytes;
-			bytes = xmlSaveFile(filename, (xmlDocPtr) sxe->document->ptr);
+			zend_long bytes = sxe->document->handlers->dump_doc_to_file(filename, doc, false, (const char *) doc->encoding);
 			if (bytes == -1) {
 				RETURN_FALSE;
 			} else {
@@ -1380,7 +1381,6 @@ PHP_METHOD(SimpleXMLElement, asXML)
 		}
 	}
 
-	xmlDocPtr doc = sxe->document->ptr;
 	zend_string *result;
 	if (node->parent && (XML_DOCUMENT_NODE == node->parent->type)) {
 		result = sxe->document->handlers->dump_doc_to_str(doc, 0, (const char *) doc->encoding);