[bugfix] WebDAV API must consider seralization properties when determining Content-Length

Author: adamretter

extensions/webdav/src/main/java/org/exist/webdav/ExistCollection.java

@@ -40,7 +40,6 @@
 import org.exist.webdav.exceptions.CollectionDoesNotExistException;
 import org.exist.webdav.exceptions.CollectionExistsException;
 import org.exist.xmldb.XmldbURI;
-import org.xml.sax.InputSource;
 import org.xml.sax.SAXException;
 
 import java.io.IOException;
@@ -51,6 +50,7 @@
 import java.util.Iterator;
 import java.util.List;
 import java.util.Optional;
+import java.util.Properties;
 
 /**
  * Class for accessing the Collection class of the exist-db native API.
@@ -65,13 +65,14 @@ public class ExistCollection extends ExistResource {
      * @param uri  URI of document
      * @param pool Reference to brokerpool
      */
-    public ExistCollection(XmldbURI uri, BrokerPool pool) {
+    public ExistCollection(final Properties configuration, final XmldbURI uri, final BrokerPool pool) {
+        super(configuration);
 
         if (LOG.isTraceEnabled()) {
             LOG.trace("New collection object for {}", uri);
         }
 
-        brokerPool = pool;
+        this.brokerPool = pool;
         this.xmldbUri = uri;
     }
 

extensions/webdav/src/main/java/org/exist/webdav/ExistDocument.java

@@ -51,6 +51,7 @@
 import java.io.Writer;
 import java.net.URISyntaxException;
 import java.util.Optional;
+import java.util.Properties;
 
 import static java.nio.charset.StandardCharsets.UTF_8;
 
@@ -71,7 +72,8 @@ public class ExistDocument extends ExistResource {
      * @param uri  URI of document
      * @param pool Reference to brokerpool
      */
-    public ExistDocument(XmldbURI uri, BrokerPool pool) {
+    public ExistDocument(final Properties configuration, final XmldbURI uri, final BrokerPool pool) {
+        super(configuration);
 
         if (LOG.isTraceEnabled()) {
             LOG.trace("New document object for {}", uri);
@@ -169,7 +171,10 @@ public void stream(OutputStream os) throws IOException, PermissionDeniedExceptio
                     // Stream XML document
 
                     try {
-                        serialize(broker, document, os);
+                        // Set custom serialization options when available
+                        final Properties properties = configuration.isEmpty() ? new Properties() : configuration;
+
+                        serialize(broker, properties, document, os);
                         os.flush();
                     } catch (SAXException e) {
                         LOG.error(e);
@@ -198,20 +203,18 @@ public void stream(OutputStream os) throws IOException, PermissionDeniedExceptio
 
     }
 
-    private void serialize(final DBBroker broker, final DocumentImpl document, final OutputStream os) throws SAXException, IOException {
+    private void serialize(final DBBroker broker, final Properties properties, final DocumentImpl document, final OutputStream os) throws SAXException, IOException {
         final Serializer serializer = broker.borrowSerializer();
-        // Set custom serialization options when available
-        if (!configuration.isEmpty()) {
-            serializer.setProperties(configuration);
-        }
 
         SAXSerializer saxSerializer = null;
         try {
+            serializer.setUser(getUser());
+            serializer.setProperties(properties);
             saxSerializer = (SAXSerializer) SerializerPool.getInstance().borrowObject(SAXSerializer.class);
 
             // Serialize document
             try (final Writer writer = new OutputStreamWriter(os, UTF_8)) {
-                saxSerializer.setOutput(writer, configuration.isEmpty() ? null : configuration);
+                saxSerializer.setOutput(writer, properties);
                 serializer.setSAXHandlers(saxSerializer, saxSerializer);
 
                 serializer.toSAX(document);

extensions/webdav/src/main/java/org/exist/webdav/ExistResource.java

@@ -54,7 +54,11 @@ public abstract class ExistResource {
     protected String ownerUser;
     protected String ownerGroup;
 
-    protected Properties configuration = new Properties();
+    protected final Properties configuration;
+
+    public ExistResource(final Properties configuration) {
+        this.configuration = configuration;
+    }
 
     abstract void initMetadata();
 
@@ -98,14 +102,6 @@ public String getOwnerUser() {
         return ownerUser;
     }
 
-    public Properties getSerializationConfiguration() {
-        return configuration;
-    }
-
-    public void setSerializationConfiguration(Properties config) {
-        configuration = config;
-    }
-
     /**
      * Authenticate subject with password. NULL is returned when
      * the subject could not be authenticated.

extensions/webdav/src/main/java/org/exist/webdav/ExistResourceFactory.java

@@ -132,12 +132,11 @@ public Resource getResource(String host, String path) {
         // Return appropriate resource
         switch (getResourceType(brokerPool, xmldbUri)) {
             case DOCUMENT:
-                MiltonDocument doc = new MiltonDocument(host, xmldbUri, brokerPool);
-                doc.setSerializationConfiguration(webDavOptions);
+                MiltonDocument doc = new MiltonDocument(webDavOptions, host, xmldbUri, brokerPool);
                 return doc;
 
             case COLLECTION:
-                return new MiltonCollection(host, xmldbUri, brokerPool);
+                return new MiltonCollection(webDavOptions, host, xmldbUri, brokerPool);
 
             case IGNORABLE:
                 if (LOG.isDebugEnabled()) {

extensions/webdav/src/main/java/org/exist/webdav/MiltonCollection.java

@@ -58,26 +58,27 @@ public class MiltonCollection extends MiltonResource
      * Constructor of representation of a Collection in the Milton framework, without subject information.
      * To be called by the resource factory.
      *
+     * @param configuration any configuration properties.
      * @param host FQ host name including port number.
      * @param uri  Path on server indicating path of resource
      * @param pool Handle to Exist database.
      */
-    public MiltonCollection(String host, XmldbURI uri, BrokerPool pool) {
-        this(host, uri, pool, null);
+    public MiltonCollection(final Properties configuration, String host, XmldbURI uri, BrokerPool pool) {
+        this(configuration, host, uri, pool, null);
     }
 
     /**
      * Constructor of representation of a Document in the Milton framework, with subject information.
      * To be called by the resource factory.
      *
+     * @param configuration any configuration properties.
      * @param host    FQ host name including port number.
      * @param uri     Path on server indicating path of resource.
      * @param subject An Exist operation is performed with Subject. Can be NULL.
      * @param pool    Handle to Exist database.
      */
-    public MiltonCollection(String host, XmldbURI uri, BrokerPool pool, Subject subject) {
-
-        super();
+    public MiltonCollection(final Properties configuration, String host, XmldbURI uri, BrokerPool pool, Subject subject) {
+        super(configuration);
 
         if (LOG.isDebugEnabled()) {
             LOG.debug("COLLECTION={}", uri.toString());
@@ -87,7 +88,7 @@ public MiltonCollection(String host, XmldbURI uri, BrokerPool pool, Subject subj
         brokerPool = pool;
         this.host = host;
 
-        existCollection = new ExistCollection(uri, brokerPool);
+        existCollection = new ExistCollection(configuration, uri, brokerPool);
 
         // store simpler type
         existResource = existCollection;
@@ -129,15 +130,15 @@ public Resource child(String childName) {
     private List<MiltonCollection> getCollectionResources() {
         List<MiltonCollection> allResources = new ArrayList<>();
         for (XmldbURI path : existCollection.getCollectionURIs()) {
-            allResources.add(new MiltonCollection(this.host, path, brokerPool, subject));
+            allResources.add(new MiltonCollection(configuration, this.host, path, brokerPool, subject));
         }
         return allResources;
     }
 
     private List<MiltonDocument> getDocumentResources() {
         List<MiltonDocument> allResources = new ArrayList<>();
         for (XmldbURI path : existCollection.getDocumentURIs()) {
-            MiltonDocument mdoc = new MiltonDocument(this.host, path, brokerPool, subject);
+            MiltonDocument mdoc = new MiltonDocument(configuration, this.host, path, brokerPool, subject);
             // Show (restimated) size for PROPFIND only
             mdoc.setIsPropFind(true);
             allResources.add(mdoc);
@@ -207,7 +208,7 @@ public CollectionResource createCollection(String name)
         CollectionResource collection = null;
         try {
             XmldbURI collectionURI = existCollection.createCollection(name);
-            collection = new MiltonCollection(host, collectionURI, brokerPool, subject);
+            collection = new MiltonCollection(configuration, host, collectionURI, brokerPool, subject);
 
         } catch (PermissionDeniedException ex) {
             LOG.debug(ex.getMessage());
@@ -239,7 +240,7 @@ public Resource createNew(String newName, InputStream is, Long length, String co
             // submit
             XmldbURI resourceURI = existCollection.createFile(newName, is, length, contentType);
 
-            resource = new MiltonDocument(host, resourceURI, brokerPool, subject);
+            resource = new MiltonDocument(configuration, host, resourceURI, brokerPool, subject);
 
         } catch (PermissionDeniedException | CollectionDoesNotExistException | IOException e) {
             LOG.debug(e.getMessage());

extensions/webdav/src/main/java/org/exist/webdav/MiltonDocument.java

@@ -70,26 +70,27 @@ public class MiltonDocument extends MiltonResource
      * Constructor of representation of a Document in the Milton framework, without subject information.
      * To be called by the resource factory.
      *
+     * @param configuration any configuration properties.
      * @param host       FQ host name including port number.
      * @param uri        Path on server indicating path of resource
      * @param brokerPool Handle to Exist database.
      */
-    public MiltonDocument(String host, XmldbURI uri, BrokerPool brokerPool) {
-        this(host, uri, brokerPool, null);
+    public MiltonDocument(final Properties configuration, String host, XmldbURI uri, BrokerPool brokerPool) {
+        this(configuration, host, uri, brokerPool, null);
     }
 
     /**
      * Constructor of representation of a Document in the Milton framework, with subject information.
      * To be called by the resource factory.
      *
+     * @param configuration any configuration properties.
      * @param host    FQ host name including port number.
      * @param uri     Path on server indicating path of resource.
      * @param subject An Exist operation is performed with  User. Can be NULL.
      * @param pool    Handle to Exist database.
      */
-    public MiltonDocument(String host, XmldbURI uri, BrokerPool pool, Subject subject) {
-
-        super();
+    public MiltonDocument(final Properties configuration, String host, XmldbURI uri, BrokerPool pool, Subject subject) {
+        super(configuration);
 
         if (userAgentHelper == null) {
             userAgentHelper = new DefaultUserAgentHelper();
@@ -103,7 +104,7 @@ public MiltonDocument(String host, XmldbURI uri, BrokerPool pool, Subject subjec
         brokerPool = pool;
         this.host = host;
 
-        existDocument = new ExistDocument(uri, brokerPool);
+        existDocument = new ExistDocument(configuration, uri, brokerPool);
 
         // store simpler type
         existResource = existDocument;
@@ -484,14 +485,5 @@ public void writeXML(XMLStreamWriter writer) throws XMLStreamException {
      * StAX serializer
      * ================ */
 
-    /**
-     * Set specific WebDAV serialization options
-     *
-     * @param config XML serialization options
-     */
-    public void setSerializationConfiguration(Properties config) {
-        existDocument.setSerializationConfiguration(config);
-    }
-
     private enum SIZE_METHOD {NULL, EXACT, APPROXIMATE}
 }

extensions/webdav/src/main/java/org/exist/webdav/MiltonResource.java

@@ -36,6 +36,7 @@
 import java.net.URISyntaxException;
 import java.util.Date;
 import java.util.GregorianCalendar;
+import java.util.Properties;
 
 /**
  * Generic class representing a Milton Resource.
@@ -56,7 +57,11 @@ public class MiltonResource implements Resource {
     // Used for Long to DateTime conversion
     private DatatypeFactory datatypeFactory;
 
-    public MiltonResource() {
+    protected final Properties configuration;
+
+    public MiltonResource(final Properties configuration) {
+        this.configuration = configuration;
+
         if (datatypeFactory == null) {
             try {
                 datatypeFactory = DatatypeFactory.newInstance();