io.milton.http.webdav.PropFindXmlGeneratorHelper Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of milton-server-ce Show documentation
Show all versions of milton-server-ce Show documentation
Milton Community Edition: Supports DAV level 1 and is available on Apache2 license
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package io.milton.http.webdav;
import io.milton.http.Response;
import io.milton.http.Response.Status;
import io.milton.http.XmlWriter;
import io.milton.http.values.ValueAndType;
import io.milton.http.values.ValueWriters;
import io.milton.http.webdav.PropFindResponse.NameAndError;
import java.io.IOException;
import java.io.OutputStream;
import java.io.UnsupportedEncodingException;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.xml.namespace.QName;
import org.apache.commons.io.output.ByteArrayOutputStream;
/**
*
* @author bradm
*/
public class PropFindXmlGeneratorHelper {
private ValueWriters valueWriters;
public PropFindXmlGeneratorHelper() {
}
public PropFindXmlGeneratorHelper(ValueWriters valueWriters) {
this.valueWriters = valueWriters;
}
/**
*
* @param propFindResponses
* @return - map where key is the uri, and value is the prefix
*/
Map findNameSpaces(List propFindResponses) {
int i = 1;
Map map = new HashMap<>();
// always add webdav namespace
map.put(WebDavProtocol.NS_DAV.getName(), WebDavProtocol.NS_DAV.getPrefix());
// Hack for caldav!!! Temporary only!!!
//xmlns:cal="urn:ietf:params:xml:ns:caldav" xmlns:cs="http://calendarserver.org/ns/"
map.put("urn:ietf:params:xml:ns:caldav", "cal");
map.put("http://calendarserver.org/ns/", "cs");
map.put("urn:ietf:params:xml:ns:carddav", "card");
for (PropFindResponse r : propFindResponses) {
for (QName p : r.getKnownProperties().keySet()) {
String uri = p.getNamespaceURI();
// if( uri.endsWith( ":" ) ) uri = uri.substring( 0, uri.length() - 1 ); // strip trailing :
if (!map.containsKey(uri)) {
map.put(uri, "ns" + i++);
}
}
}
return map;
}
String generateNamespaceDeclarations(Map mapOfNamespaces) {
StringBuilder decs = new StringBuilder();
for (String uri : mapOfNamespaces.keySet()) {
String prefix = mapOfNamespaces.get(uri);
decs.append(" xmlns:").append(prefix).append("=\"").append(uri).append("\"");
}
return decs.toString();
}
void appendResponses(XmlWriter writer, List propFindResponses, Map mapOfNamespaces, boolean writeErrorProps) {
// log.debug( "appendResponses: " + propFindResponses.size() );
for (PropFindResponse r : propFindResponses) {
appendResponse(writer, r, mapOfNamespaces, writeErrorProps);
}
}
public void appendResponse(XmlWriter writer, PropFindResponse r, Map mapOfNamespaces, boolean writeErrorProps) {
XmlWriter.Element el = writer.begin(WebDavProtocol.NS_DAV.getPrefix(), "response");
el.open();
writer.writeProperty(WebDavProtocol.NS_DAV.getPrefix(), "href", r.getHref());
if (r.getStatus() != null) {
writer.writeProperty(WebDavProtocol.NS_DAV.getPrefix(), "status", r.getStatus().toString());
} else {
sendKnownProperties(writer, mapOfNamespaces, r.getKnownProperties(), r.getHref());
if (r.getErrorProperties() != null && writeErrorProps) {
for (Status status : r.getErrorProperties().keySet()) {
List props = r.getErrorProperties().get(status);
sendErrorProperties(status, writer, mapOfNamespaces, props);
}
}
}
el.close();
}
private void sendKnownProperties(XmlWriter writer, Map mapOfNamespaces, Map properties, String href) {
sendProperties(Response.Status.SC_OK, writer, mapOfNamespaces, properties, href);
}
private void sendProperties(Response.Status status, XmlWriter writer, Map mapOfNamespaces, Map properties, String href) {
if (!properties.isEmpty()) {
XmlWriter.Element elPropStat = writer.begin(WebDavProtocol.NS_DAV.getPrefix(), "propstat").open();
XmlWriter.Element elProp = writer.begin(WebDavProtocol.NS_DAV.getPrefix(), "prop").open();
for (QName qname : properties.keySet()) {
String prefix = mapOfNamespaces.get(qname.getNamespaceURI());
ValueAndType val = properties.get(qname);
valueWriters.writeValue(writer, qname, prefix, val, href, mapOfNamespaces);
}
elProp.close();
writer.writeProperty(WebDavProtocol.NS_DAV.getPrefix(), "status", status.toString());
elPropStat.close();
}
}
private void sendErrorProperties(Response.Status status, XmlWriter writer, Map mapOfNamespaces, List properties) {
// log.debug( "sendUnknownProperties: " + properties.size() );
if (!properties.isEmpty()) {
XmlWriter.Element elPropStat = writer.begin(WebDavProtocol.NS_DAV.getPrefix(), "propstat").open();
XmlWriter.Element elProp = writer.begin(WebDavProtocol.NS_DAV.getPrefix(), "prop").open();
for (NameAndError ne : properties) {
QName qname = ne.getName();
String prefix = mapOfNamespaces.get(qname.getNamespaceURI());
writer.writeProperty(prefix, qname.getLocalPart());
}
elProp.close();
writer.writeProperty(WebDavProtocol.NS_DAV.getPrefix(), "status", status.toString());
elPropStat.close();
}
}
void write(ByteArrayOutputStream out, OutputStream outputStream) {
try {
String xml = out.toString("UTF-8");
outputStream.write(xml.getBytes("UTF-8")); // note: this can and should write to the outputstream directory. but if it aint broke, dont fix it...
} catch (IOException ex) {
throw new RuntimeException(ex);
}
}
public ValueWriters getValueWriters() {
return valueWriters;
}
public void setValueWriters(ValueWriters valueWriters) {
this.valueWriters = valueWriters;
}
}