[feature] Enable output-doctype by default in APIs

Author: adamretter

exist-core/src/main/java/org/exist/http/RESTServer.java

@@ -355,7 +355,7 @@ public void doGet(final DBBroker broker, final Txn transaction, final HttpServle
             outputProperties.setProperty(EXistOutputKeys.OUTPUT_DOCTYPE, option);
         } else {
             // set output-doctype by configuration
-            final String outputDocType = broker.getConfiguration().getProperty(Serializer.PROPERTY_OUTPUT_DOCTYPE, "no");
+            final String outputDocType = broker.getConfiguration().getProperty(Serializer.PROPERTY_OUTPUT_DOCTYPE, "yes");
             outputProperties.setProperty(EXistOutputKeys.OUTPUT_DOCTYPE, outputDocType);
         }
         if ((option = getParameter(request, Source)) != null && !safeMode) {

exist-core/src/main/java/org/exist/xmldb/LocalCollection.java

@@ -89,6 +89,7 @@ public class LocalCollection extends AbstractLocal implements EXistCollection {
         defaultProperties.setProperty(EXistOutputKeys.EXPAND_XINCLUDES, "yes");
         defaultProperties.setProperty(EXistOutputKeys.PROCESS_XSL_PI, "no");
         defaultProperties.setProperty(NORMALIZE_HTML, "no");
+        defaultProperties.setProperty(EXistOutputKeys.OUTPUT_DOCTYPE, "yes");
     }
 
     private final XmldbURI path;

exist-core/src/main/java/org/exist/xmlrpc/RpcConnection.java

@@ -664,7 +664,7 @@ private String getDocumentAsString(final XmldbURI docUri, final Map<String, Obje
 
     private void serialize(final DBBroker broker, final Properties properties, final ConsumerE<Serializer, SAXException> toSaxFunction, final Writer writer) throws SAXException, IOException {
         if (!properties.containsKey(EXistOutputKeys.OUTPUT_DOCTYPE)) {
-            final String outputDocType = broker.getConfiguration().getProperty(Serializer.PROPERTY_OUTPUT_DOCTYPE, "no");
+            final String outputDocType = broker.getConfiguration().getProperty(Serializer.PROPERTY_OUTPUT_DOCTYPE, "yes");
             properties.setProperty(EXistOutputKeys.OUTPUT_DOCTYPE, outputDocType);
         }
 

exist-core/src/test/java/org/exist/http/RESTServiceTest.java

@@ -1243,7 +1243,8 @@ public void getDocTypeDefault() throws IOException {
 
             final String response = readResponse(connect.getInputStream());
 
-            assertEquals("<bookmap id=\"bookmap-1\"/>\r\n", response);
+            assertEquals("<!DOCTYPE bookmap PUBLIC \"-//OASIS//DTD DITA BookMap//EN\" \"bookmap.dtd\">\r\n" +
+                    "<bookmap id=\"bookmap-1\"/>\r\n", response);
 
         } finally {
             connect.disconnect();

exist-core/src/test/java/org/exist/xmldb/SerializationTest.java

@@ -171,7 +171,7 @@ public void xqueryUpdateNsTest() throws XMLDBException {
 	@Test
 	public void getDocTypeDefault() throws XMLDBException {
 		final Resource res = testCollection.getResource(TEST_XML_DOC_WITH_DOCTYPE_URI.lastSegmentString());
-		assertEquals("<bookmap id=\"bookmap-1\"/>", res.getContent());
+		assertEquals(XML_WITH_DOCTYPE, res.getContent());
 	}
 
 	@Test

exist-core/src/test/resources-filtered/conf.xml

@@ -739,6 +739,10 @@
            Remember to add a statement like this to your client code:
            service.setProperty("compress-output", "yes");
            to uncompress the retrieved result in the client too.
+
+        - output-doctype:
+            should the Doctype Declaration for a document be serialized
+            if it is present?
         
         - enable-xinclude: 
             should the database expand XInclude tags by default?
@@ -764,7 +768,7 @@
             Set the parameter to "yes" to enable this feature.
 
     -->
-    <serializer add-exist-id="none" compress-output="no" enable-xinclude="yes"
+    <serializer add-exist-id="none" compress-output="no" output-doctype="yes" enable-xinclude="yes"
                 enable-xsl="no" indent="yes" match-tagging-attributes="no" 
                 match-tagging-elements="no">
         <!--

exist-distribution/src/main/config/conf.xml

@@ -815,7 +815,7 @@
             Set the parameter to "yes" to enable this feature.
 
     -->
-    <serializer add-exist-id="none" compress-output="no" output-doctype="no" enable-xinclude="yes"
+    <serializer add-exist-id="none" compress-output="no" output-doctype="yes" enable-xinclude="yes"
                 enable-xsl="no" indent="yes" match-tagging-attributes="no" 
                 match-tagging-elements="no">
         <!--

extensions/webdav/src/main/resources/org/exist/webdav/webdav.properties

@@ -28,4 +28,4 @@
 #process-xsl-pi=no
 #encoding=UTF-8
 #omit-xml-declaration=no
-output-doctype=false
+output-doctype=yes

extensions/webdav/src/test/java/org/exist/webdav/SerializationTest.java

@@ -101,6 +101,6 @@ public void getDocTypeDefault() throws IOException, NotAuthorizedException, BadR
         assertEquals("application/xml", ((File) resource).contentType);
         final java.io.File tempRetrieveFile = TEMP_FOLDER.newFile();
         resource.downloadTo(tempRetrieveFile, null);
-        assertEquals("<bookmap id=\"bookmap-1\"/>", new String(Files.readAllBytes(tempRetrieveFile.toPath()), UTF_8));
+        assertEquals(XML_WITH_DOCTYPE, new String(Files.readAllBytes(tempRetrieveFile.toPath()), UTF_8));
     }
 }

schema/conf.xsd

@@ -302,7 +302,7 @@
                             </xs:simpleType>
                         </xs:attribute>
                         <xs:attribute name="compress-output" type="yes_no" default="no"/>
-                        <xs:attribute name="output-doctype" type="yes_no" default="no"/>
+                        <xs:attribute name="output-doctype" type="yes_no" default="yes"/>
                         <xs:attribute name="enable-xinclude" type="yes_no" default="yes"/>
                         <xs:attribute name="enable-xsl" type="yes_no" default="no"/>
                         <xs:attribute name="indent" type="yes_no" default="yes"/>