[bugfix] Java Admin Client should allow you to see and edit a Document's Document Type Declaration if present

Author: adamretter

exist-core/src/main/java/org/exist/client/InteractiveClient.java

@@ -84,6 +84,7 @@
 import se.softhouse.jargo.ArgumentException;
 
 import static java.nio.charset.StandardCharsets.UTF_8;
+import static org.exist.storage.serializers.EXistOutputKeys.OUTPUT_DOCTYPE;
 
 /**
  * Command-line client based on the XML:DB API.
@@ -137,6 +138,7 @@ public class InteractiveClient {
         defaultProps.setProperty(USER, USER_DEFAULT);
         defaultProps.setProperty(EDITOR, EDIT_CMD);
         defaultProps.setProperty(INDENT, "true");
+        defaultProps.setProperty(OUTPUT_DOCTYPE, "true");
         defaultProps.setProperty(ENCODING, ENCODING_DEFAULT.name());
         defaultProps.setProperty(COLORS, "false");
         defaultProps.setProperty(PERMISSIONS, "false");

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

@@ -23,6 +23,7 @@
 
 import org.exist.Namespaces;
 import org.exist.TestUtils;
+import org.exist.storage.serializers.EXistOutputKeys;
 import org.exist.test.ExistWebServer;
 import org.junit.After;
 import org.junit.Before;
@@ -77,7 +78,7 @@ private final String getBaseUri() {
 
 	private static final String EOL = System.getProperty("line.separator");
 
-	private static final String TEST_COLLECTION_NAME = "test";
+	private static final String TEST_COLLECTION_NAME = "xmlrpc-serialization-test";
 
 	private static final String XML_DOC_NAME = "defaultns.xml";
 	private static final String XML =
@@ -107,6 +108,12 @@ private final String getBaseUri() {
 		"	<entry xmlns=\"\" xml:id=\"aargh\"/>" + EOL +
 		"</root>";
 
+	private static final XmldbURI TEST_XML_DOC_WITH_DOCTYPE_URI = XmldbURI.create("test-with-doctype.xml");
+
+	private static final String XML_WITH_DOCTYPE =
+			"<!DOCTYPE bookmap PUBLIC \"-//OASIS//DTD DITA BookMap//EN\" \"bookmap.dtd\">\n" +
+			"<bookmap id=\"bookmap-1\"/>";
+
 	private Collection testCollection;
 
 	@Test
@@ -161,6 +168,40 @@ public void xqueryUpdateNsTest() throws XMLDBException {
 		assertXMLEquals(XML_UPDATED_EXPECTED, onDiskResource);
 	}
 
+	@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());
+	}
+
+	@Test
+	public void getDocTypeNo() throws XMLDBException {
+		final String prevOutputDocType = testCollection.getProperty(EXistOutputKeys.OUTPUT_DOCTYPE);
+		try {
+			final Resource res = testCollection.getResource(TEST_XML_DOC_WITH_DOCTYPE_URI.lastSegmentString());
+			testCollection.setProperty(EXistOutputKeys.OUTPUT_DOCTYPE, "NO");
+			assertEquals("<bookmap id=\"bookmap-1\"/>", res.getContent());
+		} finally {
+			if (prevOutputDocType != null) {
+				testCollection.setProperty(EXistOutputKeys.OUTPUT_DOCTYPE, prevOutputDocType);
+			}
+		}
+	}
+
+	@Test
+	public void getDocTypeYes() throws XMLDBException {
+		final String prevOutputDocType = testCollection.getProperty(EXistOutputKeys.OUTPUT_DOCTYPE);
+		try {
+			final Resource res = testCollection.getResource(TEST_XML_DOC_WITH_DOCTYPE_URI.lastSegmentString());
+			testCollection.setProperty(EXistOutputKeys.OUTPUT_DOCTYPE, "yes");
+			assertEquals(XML_WITH_DOCTYPE, res.getContent());
+		} finally {
+			if (prevOutputDocType != null) {
+				testCollection.setProperty(EXistOutputKeys.OUTPUT_DOCTYPE, prevOutputDocType);
+			}
+		}
+	}
+
 	private static void assertXMLEquals(final String expected, final Resource actual) throws XMLDBException {
 		final Source srcExpected = Input.fromString(expected).build();
 		final Source srcActual = Input.fromString(actual.getContent().toString()).build();
@@ -182,6 +223,10 @@ public void setUp() throws XMLDBException {
         final XMLResource res = (XMLResource) testCollection.createResource(XML_DOC_NAME, "XMLResource");
         res.setContent(XML);
         testCollection.storeResource(res);
+
+		final XMLResource res1 = (XMLResource) testCollection.createResource(TEST_XML_DOC_WITH_DOCTYPE_URI.lastSegmentString(), "XMLResource");
+		res1.setContent(XML_WITH_DOCTYPE);
+		testCollection.storeResource(res1);
     }
 
     @After

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

@@ -48,3 +48,6 @@ expand-xincludes=yes
 ## highlight matches in element and attribute values?
 ## possible values are "none", "both", "elements", "attributes"
 highlight-matches=none
+
+## output the doctype of documents
+output-doctype=yes