[feature] Add the Query String parmeter '_omit-xml-declaration' and '_omit-original-xml-declaration' to control the output:omit-xml-declaration and exist:omit-original-xml-declaration serialization option via HTTP GET to the REST Server

Author: adamretter

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

@@ -360,6 +360,22 @@ public void doGet(final DBBroker broker, final Txn transaction, final HttpServle
             final String outputDocType = broker.getConfiguration().getProperty(Serializer.PROPERTY_OUTPUT_DOCTYPE, "yes");
             outputProperties.setProperty(EXistOutputKeys.OUTPUT_DOCTYPE, outputDocType);
         }
+        if ((option = getParameter(request, Omit_Xml_Declaration)) != null) {
+            // take user query-string specified omit-xml-declaration setting
+            outputProperties.setProperty(OutputKeys.OMIT_XML_DECLARATION, option);
+        } else {
+            // set omit-xml-declaration by configuration
+            final String omitXmlDeclaration = broker.getConfiguration().getProperty(Serializer.PROPERTY_OMIT_XML_DECLARATION, "yes");
+            outputProperties.setProperty(OutputKeys.OMIT_XML_DECLARATION, omitXmlDeclaration);
+        }
+        if ((option = getParameter(request, Omit_Original_Xml_Declaration)) != null) {
+            // take user query-string specified omit-original-xml-declaration setting
+            outputProperties.setProperty(EXistOutputKeys.OMIT_ORIGINAL_XML_DECLARATION, option);
+        } else {
+            // set omit-original-xml-declaration by configuration
+            final String omitOriginalXmlDeclaration = broker.getConfiguration().getProperty(Serializer.PROPERTY_OMIT_ORIGINAL_XML_DECLARATION, "yes");
+            outputProperties.setProperty(EXistOutputKeys.OMIT_ORIGINAL_XML_DECLARATION, omitOriginalXmlDeclaration);
+        }
         if ((option = getParameter(request, Source)) != null && !safeMode) {
             source = "yes".equals(option);
         }

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

@@ -357,7 +357,29 @@ enum RESTServerParameter {
      *
      * The value of the parameter should be either "yes" or "no".
      */
-    Output_Doctype;
+    Output_Doctype,
+
+    /**
+     * Can be used in the Query String of a GET request
+     * to indicate that the XML Declaration of an XML document should not
+     * be serialized if present.
+     *
+     * Contexts: GET
+     *
+     * The value of the parameter should be either "yes" or "no".
+     */
+    Omit_Xml_Declaration,
+
+    /**
+     * Can be used in the Query String of a GET request
+     * to indicate that the original persisted XML Declaration of an XML document should not
+     * be serialized if present.
+     *
+     * Contexts: GET
+     *
+     * The value of the parameter should be either "yes" or "no".
+     */
+    Omit_Original_Xml_Declaration;
 
     /**
      * Get the parameter key that is

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

@@ -107,6 +107,10 @@ public abstract class Serializer implements XMLReader {
     protected static final Logger LOG = LogManager.getLogger(Serializer.class);
 
     public static final String CONFIGURATION_ELEMENT_NAME = "serializer";
+    public static final String OMIT_XML_DECLARATION_ATTRIBUTE = "omit-xml-declaration";
+    public static final String PROPERTY_OMIT_XML_DECLARATION = "serialization.omit-xml-declaration";
+    public static final String OMIT_ORIGINAL_XML_DECLARATION_ATTRIBUTE = "omit-original-xml-declaration";
+    public static final String PROPERTY_OMIT_ORIGINAL_XML_DECLARATION = "serialization.omit-original-xml-declaration";
     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";

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

@@ -652,6 +652,18 @@ private void configureHtmlToXmlParser(final Element parser) {
      */
     private void configureSerializer( Element serializer )
     {
+        final String omitXmlDeclaration = getConfigAttributeValue( serializer, Serializer.OMIT_XML_DECLARATION_ATTRIBUTE );
+        if (omitXmlDeclaration != null) {
+            config.put(Serializer.PROPERTY_OMIT_XML_DECLARATION, omitXmlDeclaration);
+            LOG.debug(Serializer.PROPERTY_OMIT_XML_DECLARATION + ": {}", config.get(Serializer.PROPERTY_OMIT_XML_DECLARATION));
+        }
+
+        final String omitOriginalXmlDeclaration = getConfigAttributeValue( serializer, Serializer.OMIT_ORIGINAL_XML_DECLARATION_ATTRIBUTE );
+        if (omitOriginalXmlDeclaration != null) {
+            config.put(Serializer.PROPERTY_OMIT_ORIGINAL_XML_DECLARATION, omitOriginalXmlDeclaration);
+            LOG.debug(Serializer.PROPERTY_OMIT_ORIGINAL_XML_DECLARATION + ": {}", config.get(Serializer.PROPERTY_OMIT_ORIGINAL_XML_DECLARATION));
+        }
+
         final String outputDocType = getConfigAttributeValue( serializer, Serializer.OUTPUT_DOCTYPE_ATTRIBUTE );
         if (outputDocType != null) {
             config.put(Serializer.PROPERTY_OUTPUT_DOCTYPE, outputDocType);

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

@@ -203,6 +203,12 @@ public class RESTServiceTest {
 
     private static final XmldbURI TEST_XML_DOC_WITH_XSLPI_URI = XmldbURI.create("test-with-xslpi.xml");
 
+    private static final String XML_WITH_XMLDECL =
+            "<?xml version=\"1.1\" encoding=\"ISO-8859-1\" standalone=\"yes\"?>\n" +
+            "<bookmap id=\"bookmap-2\"/>";
+
+    private static final XmldbURI TEST_XMLDECL_COLLECTION_URI = XmldbURI.ROOT_COLLECTION_URI.append("rest-test-xmldecl");
+    private static final XmldbURI TEST_XML_DOC_WITH_XMLDECL_URI = XmldbURI.create("test-with-xmldecl.xml");
 
     private static String credentials;
     private static String badCredentials;
@@ -231,6 +237,10 @@ private static String getResourceWithDocTypeUri() {
         return getServerUri() + TEST_DOCTYPE_COLLECTION_URI.append(TEST_XML_DOC_WITH_DOCTYPE_URI);
     }
 
+    private static String getResourceWithXmlDeclUri() {
+        return getServerUri() + TEST_XMLDECL_COLLECTION_URI.append(TEST_XML_DOC_WITH_XMLDECL_URI);
+    }
+
     /* About path components of URIs:
 
      ** reserved characters # http://tools.ietf.org/html/rfc3986#section-2.2
@@ -319,6 +329,11 @@ public static void setup() throws PermissionDeniedException, IOException, Trigge
                 broker.saveCollection(transaction, col);
             }
 
+            try (final Collection col = broker.getOrCreateCollection(transaction, TEST_XMLDECL_COLLECTION_URI)) {
+                broker.storeDocument(transaction, TEST_XML_DOC_WITH_XMLDECL_URI, new StringInputSource(XML_WITH_XMLDECL), MimeType.XML_TYPE, col);
+                broker.saveCollection(transaction, col);
+            }
+
             transaction.commit();
         } catch (EXistException | SAXException | LockException e) {
             throw new RuntimeException(e);
@@ -1386,6 +1401,82 @@ public void getDocWithXslPi_twice() throws IOException {
         getDocWithXslPi();
     }
 
+    @Test
+    public void getXmlDeclDefault() throws IOException {
+        final HttpURLConnection connect = getConnection(getResourceWithXmlDeclUri());
+        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-2\"/>\r\n", response);
+
+        } finally {
+            connect.disconnect();
+        }
+    }
+
+    @Test
+    public void getXmlDeclNo() throws IOException {
+        final HttpURLConnection connect = getConnection(getResourceWithXmlDeclUri() + "?_omit-xml-declaration=no&_omit-original-xml-declaration=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("<?xml version=\"1.1\" encoding=\"ISO-8859-1\" standalone=\"yes\"?>\r\n" +
+                    "<bookmap id=\"bookmap-2\"/>\r\n", response);
+
+        } finally {
+            connect.disconnect();
+        }
+    }
+
+    @Test
+    public void getXmlDeclYes() throws IOException {
+        final HttpURLConnection connect = getConnection(getResourceWithXmlDeclUri() + "?_omit-xml-declaration=yes&_omit-original-xml-declaration=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("<bookmap id=\"bookmap-2\"/>\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

@@ -787,6 +787,14 @@
            service.setProperty("compress-output", "yes");
            to uncompress the retrieved result in the client too.
 
+        - omit-xml-declaration:
+            should the XML Declaration for a document be serialized
+            if it is present?
+
+        - omit-original-xml-declaration:
+            should the original persisted XML Declaration for a document be serialized
+            if it is present? Requires omit-xml-declaration to also be set tp 'no'.
+
         - output-doctype:
             should the Doctype Declaration for a document be serialized
             if it is present?
@@ -815,8 +823,10 @@
             Set the parameter to "yes" to enable this feature.
 
     -->
-    <serializer add-exist-id="none" compress-output="no" output-doctype="yes" enable-xinclude="yes"
-                enable-xsl="no" indent="yes" match-tagging-attributes="no" 
+    <serializer add-exist-id="none" compress-output="no"
+                omit-xml-declaration="yes" omit-original-xml-declaration="yes"
+                output-doctype="yes" enable-xinclude="yes"
+                enable-xsl="no" indent="yes" match-tagging-attributes="no"
                 match-tagging-elements="no">
         <!--
             You may add as many custom-filters as you want, they will be executed

schema/conf.xsd

@@ -302,6 +302,8 @@
                             </xs:simpleType>
                         </xs:attribute>
                         <xs:attribute name="compress-output" type="yes_no" default="no"/>
+                        <xs:attribute name="omit-xml-declaration" type="yes_no" default="yes"/>
+                        <xs:attribute name="omit-original-xml-declaration" type="yes_no" default="yes"/>
                         <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"/>