[feature] Add the Query String parmeter '_output-doctype' to control the exist:output-doctype serialization option via HTTP GET to the REST Server

Author: adamretter

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

@@ -252,6 +252,10 @@ private String getParameter(final HttpServletRequest request, final RESTServerPa
      * the returned XML.</li>
      * </ul>
      *
+     * <li>_output-doctype: if set to "yes", the returned XML will include
+     * a Document Type Declaration if one is present, if "no" the Document Type Declaration will be omitted.</li>
+     * </ul>
+     *
      * @param broker the database broker
      * @param transaction the database transaction
      * @param request the request
@@ -346,6 +350,14 @@ public void doGet(final DBBroker broker, final Txn transaction, final HttpServle
         if ((option = getParameter(request, Indent)) != null) {
             outputProperties.setProperty(OutputKeys.INDENT, option);
         }
+        if ((option = getParameter(request, Output_Doctype)) != null) {
+            // take user query-string specified output-doctype setting
+            outputProperties.setProperty(EXistOutputKeys.OUTPUT_DOCTYPE, option);
+        } else {
+            // set output-doctype by configuration
+            final String outputDocType = broker.getConfiguration().getProperty(Serializer.PROPERTY_OUTPUT_DOCTYPE, "no");
+            outputProperties.setProperty(EXistOutputKeys.OUTPUT_DOCTYPE, outputDocType);
+        }
         if ((option = getParameter(request, Source)) != null && !safeMode) {
             source = "yes".equals(option);
         }

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

@@ -346,7 +346,18 @@ enum RESTServerParameter {
      * <exist:property name = string
      *  value = string/>
      */
-    Property;
+    Property,
+
+    /**
+     * Can be used in the Query String of a GET request
+     * to indicate that the doctype of an XML document should also
+     * be serialized if present.
+     *
+     * Contexts: GET
+     *
+     * The value of the parameter should be either "yes" or "no".
+     */
+    Output_Doctype;
 
     /**
      * Get the parameter key that is
@@ -366,6 +377,6 @@ public String queryStringKey() {
      * @return The parameter key, suitable for use in an XML document
      */
     public String xmlKey() {
-        return name().toLowerCase();
+        return name().toLowerCase().replace('_', '-');
     }
 }

exist-core/src/main/java/org/exist/storage/serializers/Serializer.java

@@ -118,6 +118,8 @@ public abstract class Serializer implements XMLReader {
 	protected final static Logger LOG = LogManager.getLogger(Serializer.class);
 
 	public static final String CONFIGURATION_ELEMENT_NAME = "serializer";
+	public static final String OUTPUT_DOCTYPE_ATTRIBUTE = "output-doctype";
+	public static final String PROPERTY_OUTPUT_DOCTYPE = "serialization.output-doctype";
 	public static final String ENABLE_XINCLUDE_ATTRIBUTE = "enable-xinclude";
 	public static final String PROPERTY_ENABLE_XINCLUDE = "serialization.enable-xinclude";
 	public static final String ENABLE_XSL_ATTRIBUTE = "enable-xsl";

exist-core/src/main/java/org/exist/util/Configuration.java

@@ -652,6 +652,12 @@ private void configureHtmlToXmlParser(final Element parser) {
      */
     private void configureSerializer( Element serializer )
     {
+        final String outputDocType = getConfigAttributeValue( serializer, Serializer.OUTPUT_DOCTYPE_ATTRIBUTE );
+        if (outputDocType != null) {
+            config.put(Serializer.PROPERTY_OUTPUT_DOCTYPE, outputDocType);
+            LOG.debug(Serializer.PROPERTY_OUTPUT_DOCTYPE + ": {}", config.get(Serializer.PROPERTY_OUTPUT_DOCTYPE));
+        }
+
         final String xinclude = getConfigAttributeValue( serializer, Serializer.ENABLE_XINCLUDE_ATTRIBUTE );
 
         if( xinclude != null ) {

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

@@ -166,6 +166,13 @@ public class RESTServiceTest {
                     "    <header>{request:get-header('Authorization')}</header>\n" +
                     "</authorization>\n";
 
+    private static final String XML_WITH_DOCTYPE =
+            "<!DOCTYPE bookmap PUBLIC \"-//OASIS//DTD DITA BookMap//EN\" \"bookmap.dtd\">\n" +
+            "<bookmap id=\"bookmap-1\"/>";
+
+    private static final XmldbURI TEST_DOCTYPE_COLLECTION_URI = XmldbURI.ROOT_COLLECTION_URI.append("rest-test-doctype");
+    private static final XmldbURI TEST_XML_DOC_WITH_DOCTYPE_URI = XmldbURI.create("test-with-doctype.xml");
+
     private static String credentials;
     private static String badCredentials;
 
@@ -189,6 +196,10 @@ private static String getResourceUri() {
         return getServerUri() + XmldbURI.ROOT_COLLECTION + "/test/test.xml";
     }
 
+    private static String getResourceWithDocTypeUri() {
+        return getServerUri() + TEST_DOCTYPE_COLLECTION_URI.append(TEST_XML_DOC_WITH_DOCTYPE_URI);
+    }
+
     /* About path components of URIs:
 
      ** reserved characters # http://tools.ietf.org/html/rfc3986#section-2.2
@@ -266,6 +277,11 @@ public static void setup() throws PermissionDeniedException, IOException, Trigge
                 broker.saveCollection(transaction, col);
             }
 
+            try (final Collection col = broker.getOrCreateCollection(transaction, TEST_DOCTYPE_COLLECTION_URI)) {
+                broker.storeDocument(transaction, TEST_XML_DOC_WITH_DOCTYPE_URI, new StringInputSource(XML_WITH_DOCTYPE), MimeType.XML_TYPE, col);
+                broker.saveCollection(transaction, col);
+            }
+
             transaction.commit();
         } catch (EXistException | SAXException | LockException e) {
             throw new RuntimeException(e);
@@ -1206,6 +1222,86 @@ public void doDeleteEncodedPath() throws IOException {
         }
     }
 
+    /**
+     * By default there should be NO doctype serialized.
+     */
+    @Test
+    public void getDocTypeDefault() throws IOException {
+        final HttpURLConnection connect = getConnection(getResourceWithDocTypeUri());
+        try {
+            connect.setRequestMethod("GET");
+            connect.connect();
+
+            final int r = connect.getResponseCode();
+            assertEquals("Server returned response code " + r, HttpStatus.OK_200, r);
+            String contentType = connect.getContentType();
+            final int semicolon = contentType.indexOf(';');
+            if (semicolon > 0) {
+                contentType = contentType.substring(0, semicolon).trim();
+            }
+            assertEquals("Server returned content type " + contentType, "application/xml", contentType);
+
+            final String response = readResponse(connect.getInputStream());
+
+            assertEquals("<bookmap id=\"bookmap-1\"/>\r\n", response);
+
+        } finally {
+            connect.disconnect();
+        }
+    }
+
+    @Test
+    public void getDocTypeNo() throws IOException {
+        final HttpURLConnection connect = getConnection(getResourceWithDocTypeUri() + "?_output-doctype=no");
+        try {
+            connect.setRequestMethod("GET");
+            connect.connect();
+
+            final int r = connect.getResponseCode();
+            assertEquals("Server returned response code " + r, HttpStatus.OK_200, r);
+            String contentType = connect.getContentType();
+            final int semicolon = contentType.indexOf(';');
+            if (semicolon > 0) {
+                contentType = contentType.substring(0, semicolon).trim();
+            }
+            assertEquals("Server returned content type " + contentType, "application/xml", contentType);
+
+            final String response = readResponse(connect.getInputStream());
+
+            assertEquals("<bookmap id=\"bookmap-1\"/>\r\n", response);
+
+        } finally {
+            connect.disconnect();
+        }
+    }
+
+    @Test
+    public void getDocTypeYes() throws IOException {
+        final HttpURLConnection connect = getConnection(getResourceWithDocTypeUri() + "?_output-doctype=yes");
+        try {
+            connect.setRequestMethod("GET");
+            connect.connect();
+
+            final int r = connect.getResponseCode();
+            assertEquals("Server returned response code " + r, HttpStatus.OK_200, r);
+            String contentType = connect.getContentType();
+            final int semicolon = contentType.indexOf(';');
+            if (semicolon > 0) {
+                contentType = contentType.substring(0, semicolon).trim();
+            }
+            assertEquals("Server returned content type " + contentType, "application/xml", contentType);
+
+            final String response = readResponse(connect.getInputStream());
+
+            assertEquals(
+                    "<!DOCTYPE bookmap PUBLIC \"-//OASIS//DTD DITA BookMap//EN\" \"bookmap.dtd\">\r\n" +
+                    "<bookmap id=\"bookmap-1\"/>\r\n", response);
+
+        } finally {
+            connect.disconnect();
+        }
+    }
+
     private void chmod(final String resourcePath, final String mode) throws IOException {
         final String uri = getCollectionUri() +"?_query=" + URLEncoder.encode(
                 "sm:chmod(xs:anyURI('" + resourcePath + "'), '" + mode + "')",

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

@@ -786,7 +786,11 @@
            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?
         
@@ -811,7 +815,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="no" enable-xinclude="yes"
                 enable-xsl="no" indent="yes" match-tagging-attributes="no" 
                 match-tagging-elements="no">
         <!--

exist-distribution/src/main/config/webdav.properties

@@ -0,0 +1,31 @@
+#
+# eXist-db Open Source Native XML Database
+# Copyright (C) 2001 The eXist-db Authors
+#
+# [email protected]
+# http://www.exist-db.org
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+#
+
+## XML Serialization options for the WevDAV
+## The file is read from EXIST_HOME/etc
+## Be careful changing the default values !
+#indent=yes
+#expand-xincludes=no
+#process-xsl-pi=no
+#encoding=UTF-8
+#omit-xml-declaration=no
+#output-doctype=yes

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

@@ -21,8 +21,8 @@
 #
 
 ## XML Serialization options for the WevDAV
-## The file is read from EXIST_HOME
-## Be carefull changing the default values !
+## The file is read from the classpath
+## Be careful changing the default values !
 #indent=yes
 #expand-xincludes=no
 #process-xsl-pi=no

schema/conf.xsd

@@ -302,6 +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="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"/>