gianugo 2003/08/28 01:11:39
Modified: src/blocks/webdav/samples samples.xml
Added: src/blocks/webdav/conf webdav.xmap
src/blocks/webdav/java/org/apache/cocoon/transformation
DASLTransformer.java
src/blocks/webdav/samples/dasl sitemap.xmap test-dasl.xml
Log:
A first cut at a DASL query component. Needs tweaking, but it's basically
working.
Revision Changes Path
1.1 cocoon-2.1/src/blocks/webdav/conf/webdav.xmap
Index: webdav.xmap
===================================================================
<?xml version="1.0"?>
<xmap xpath="/sitemap/components/transformers"
unless="[EMAIL PROTECTED]'dasl']">
<!-- =================== DASL Transformer ========================= -->
<map:transformer name="dasl"
src="org.apache.cocoon.transformation.DASLTransformer"/>
</xmap>
1.1
cocoon-2.1/src/blocks/webdav/java/org/apache/cocoon/transformation/DASLTransformer.java
Index: DASLTransformer.java
===================================================================
/*
============================================================================
The Apache Software License, Version 1.1
============================================================================
Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
Redistribution and use in source and binary forms, with or without modifica-
tion, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. The end-user documentation included with the redistribution, if any, must
include the following acknowledgment: "This product includes software
developed by the Apache Software Foundation (http://www.apache.org/)."
Alternately, this acknowledgment may appear in the software itself, if
and wherever such third-party acknowledgments normally appear.
4. The names "Apache Cocoon" and "Apache Software Foundation" must not be
used to endorse or promote products derived from this software without
prior written permission. For written permission, please contact
[EMAIL PROTECTED]
5. Products derived from this software may not be called "Apache", nor may
"Apache" appear in their name, without prior written permission of the
Apache Software Foundation.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This software consists of voluntary contributions made by many individuals
on behalf of the Apache Software Foundation and was originally created by
Stefano Mazzocchi <[EMAIL PROTECTED]>. For more information on the Apache
Software Foundation, please see <http://www.apache.org/>.
*/
package org.apache.cocoon.transformation;
import java.util.Enumeration;
import org.apache.cocoon.ProcessingException;
import org.apache.cocoon.xml.XMLUtils;
import org.apache.cocoon.xml.dom.DOMStreamer;
import org.apache.commons.httpclient.HttpConnection;
import org.apache.commons.httpclient.HttpState;
import org.apache.commons.httpclient.HttpURL;
import org.apache.commons.httpclient.UsernamePasswordCredentials;
import org.apache.webdav.lib.BaseProperty;
import org.apache.webdav.lib.methods.SearchMethod;
import org.w3c.dom.DocumentFragment;
import org.w3c.dom.Element;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.AttributesImpl;
/**
* This transformer performs DASL queries on DASL-enabled WebDAV servers.
* It expects a "query" element in the
"http://cocoon.apache.org/webdav/dasl/1.0";
* namespace containing the DASL query to execute, with a "target" attribute
specifiyng
* the webdav:// or http:// URL for the target WebDAV server. It will then
replace
* it with a "query-result" element containing the WebDAV results.
*
* Each result will be contained in a "result" element with a "path"
attribute pointing at it
* and all WebDAV properties presented as (namespaced) children elements.
*
* Sample invocation:
* lt;dasl:query xmlns:dasl="http://cocoon.apache.org/webdav/dasl/1.0";
* target="webdav://localhost/repos/"gt;
* lt;D:searchrequest xmlns:D="DAV:"gt;
* lt;D:basicsearchgt;
* lt;D:selectgt;
* lt;D:allprop/gt;
* lt;/D:selectgt;
* lt;D:fromgt;
* lt;D:scopegt;
* lt;D:hrefgt;/repos/lt;/D:hrefgt;
* lt;D:depthgt;infinitylt;/D:depthgt;
* lt;/D:scopegt;
* lt;/D:fromgt;
* lt;D:wheregt;
* lt;D:eqgt;
* lt;D:propgt;lt;D:getcontenttype/gt;lt;/D:propgt;
* lt;D:literalgt;text/htmllt;/D:literalgt;
* lt;/D:eqgt;
* lt;/D:wheregt;
* lt;D:orderbygt;
* lt;D:ordergt;
* lt;D:propgt;
* lt;D:getcontentlength/gt;
* lt;/D:propgt;
* lt;D:ascending/gt;
* lt;/D:ordergt;
* lt;D:ordergt;
* lt;D:propgt;
* lt;D:href/gt;
* lt;/D:propgt;
* lt;D:ascending/gt;
* lt;/D:ordergt;
* lt;/D:orderbygt;
* lt;/D:basicsearchgt;
* lt;/D:searchrequestgt;
* lt;/dasl:querygt;
*
* TODO: the SWCL Search method doesn't preserve the result order, which makes
* order-by clauses useless.
*
* TODO: *much* better error handling.
*
* @author <a href="mailto: [EMAIL PROTECTED]">Gianugo Rabellino</a>
* @author <a href="mailto:[EMAIL PROTECTED]>Daniele Madama</a>
*/
public class DASLTransformer extends AbstractSAXTransformer {
/** The prefix for tag */
static final String PREFIX = "dasl";
/** The tag name identifying the query */
static final String QUERY_TAG = "query";
/** The tag namespace */
static final String DASL_QUERY_NS =
"http://cocoon.apache.org/webdav/dasl/1.0";;
/** The URL namespace */
static final String TARGET_URL = "target";
/** The WebDAV scheme*/
static final String WEBDAV_SCHEME = "webdav://";
/** The tag name of root_tag for result */
static final String RESULT_ROOT_TAG = "query-result";
protected static final String PATH_NODE_NAME = "path";
protected static final String RESOURCE_NODE_NAME = "resource";
/** The target HTTP URL */
String targetUrl;
/**
* Intercept the <dasl:query> start tag.
*
* @see org.xml.sax.ContentHandler#startElement(java.lang.String,
java.lang.String, java.lang.String, org.xml.sax.Attributes)
*/
public void startElement(
String uri,
String name,
String raw,
Attributes attr)
throws SAXException {
if (name.equals(QUERY_TAG) && uri.equals(DASL_QUERY_NS)) {
this.startRecording();
if ((targetUrl = attr.getValue(TARGET_URL)) == null) {
throw new IllegalStateException("The query element must
contain a \"target\" attribute");
}
//Sanityze target
if (targetUrl.startsWith(WEBDAV_SCHEME))
targetUrl =
"http://"; + targetUrl.substring(WEBDAV_SCHEME.length());
if (!targetUrl.startsWith("http"))
throw new SAXException("Illegal value for target, must be an
http:// or webdav:// URL");
} else {
super.startElement(uri, name, raw, attr);
}
}
/**
* Intercept the <dasl:query> end tag, convert buffered input to a
String, build and execute the
* DASL query.
*
* @see org.xml.sax.ContentHandler#endElement(java.lang.String,
java.lang.String, java.lang.String)
*/
public void endElement(String uri, String name, String raw)
throws SAXException {
String query;
if (name.equals(QUERY_TAG) && uri.equals(DASL_QUERY_NS)) {
DocumentFragment frag = this.endRecording();
try {
query = XMLUtils.serializeNodeToXML(frag);
// Perform the DASL query
this.performSearchMethod(query);
} catch (ProcessingException e) {
throw new SAXException("Unable to fetch the query data:";, e);
}
} else {
super.endElement(uri, name, raw);
}
}
protected void performSearchMethod(String query) {
try {
DOMStreamer propertyStreamer = new DOMStreamer(this.xmlConsumer);
SearchMethod searchMethod = new SearchMethod(this.targetUrl,
query);
HttpURL url = new HttpURL(this.targetUrl);
HttpState state = new HttpState();
state.setCredentials(null, new UsernamePasswordCredentials(
url.getUser(),
url.getPassword()));
HttpConnection conn = new HttpConnection(url.getHost(),
url.getPort());
searchMethod.execute(state, conn);
Enumeration enum = searchMethod.getAllResponseURLs();
this.contentHandler.startElement(
DASL_QUERY_NS,
RESULT_ROOT_TAG,
PREFIX + ":" + RESULT_ROOT_TAG,
null);
while (enum.hasMoreElements()) {
String path = (String) enum.nextElement();
Enumeration properties =
searchMethod.getResponseProperties(path);
AttributesImpl attr = new AttributesImpl();
attr.addAttribute(DASL_QUERY_NS, PATH_NODE_NAME, PREFIX + ":"
+ PATH_NODE_NAME, "CDATA",path);
this.contentHandler.startElement(DASL_QUERY_NS,
RESOURCE_NODE_NAME,
PREFIX + ":" + RESOURCE_NODE_NAME,
attr);
while(properties.hasMoreElements()) {
BaseProperty metadata = (BaseProperty)
properties.nextElement();
Element propertyElement = metadata.getElement();
propertyStreamer.stream(propertyElement);
}
this.contentHandler.endElement(DASL_QUERY_NS,
RESOURCE_NODE_NAME,
PREFIX + ":" + RESOURCE_NODE_NAME);
}
this.contentHandler.endElement(
DASL_QUERY_NS,
RESULT_ROOT_TAG,
PREFIX + ":" + RESULT_ROOT_TAG);
} catch (SAXException e) {
e.printStackTrace();
} catch (Exception e) {
e.printStackTrace();
}
}
}
1.5 +13 -0 cocoon-2.1/src/blocks/webdav/samples/samples.xml
Index: samples.xml
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/blocks/webdav/samples/samples.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- samples.xml 27 Aug 2003 20:06:57 -0000 1.4
+++ samples.xml 28 Aug 2003 08:11:39 -0000 1.5
@@ -68,6 +68,19 @@
</sample>
</group>
+ <group name="DASL">
+ <sample name="DASL query" href="dasl/">
+ This sample shows how to run a query against a DASL
+ enabled WebDAV server (such as Catacomb or Slide). It assumes that
+ on localhost a DASL enables server is running with a resource
+ path of /repos (the default place for Catacomb installs). If
+ that's not the case, please change dasl/test.dasl.xml accordingly.
+ </sample>
+ <sample name="Query source" href="dasl/src/test-dasl.xml">
+ View the actual query source.
+ </sample>
+ </group>
+
<group name="Resources">
<sample name="webdav.org" href="http://www.webdav.org/";>
The webdav.org website
1.1 cocoon-2.1/src/blocks/webdav/samples/dasl/sitemap.xmap
Index: sitemap.xmap
===================================================================
<?xml version="1.0"?>
<map:sitemap xmlns:map="http://apache.org/cocoon/sitemap/1.0";>
<map:pipelines>
<map:pipeline>
<map:match pattern="">
<map:generate src="test-dasl.xml"/>
<map:transform type="dasl"/>
<map:serialize type="xml"/>
</map:match>
<map:match pattern="src/**">
<map:generate src="{1}"/>
<map:serialize type="xml"/>
</map:match>
<map:match pattern="**">
<map:generate src="{1}"/>
<map:transform type="dasl"/>
<map:serialize type="xml"/>
</map:match>
</map:pipeline>
</map:pipelines>
</map:sitemap>
1.1 cocoon-2.1/src/blocks/webdav/samples/dasl/test-dasl.xml
Index: test-dasl.xml
===================================================================
<?xml version="1.0" encoding="utf-8" ?>
<dasl:query xmlns:dasl="http://cocoon.apache.org/webdav/dasl/1.0";
target="webdav://localhost/repos/">
<D:searchrequest xmlns:D="DAV:">
<D:basicsearch>
<D:select>
<D:allprop/>
</D:select>
<D:from>
<D:scope>
<D:href>/repos/</D:href>
<D:depth>infinity</D:depth>
</D:scope>
</D:from>
<D:where>
<D:eq>
<D:prop><D:getcontenttype/></D:prop>
<D:literal>text/html</D:literal>
</D:eq>
</D:where>
<D:orderby>
<D:order>
<D:prop>
<D:getcontentlength/>
</D:prop>
<D:ascending/>
</D:order>
<D:order>
<D:prop>
<D:href/>
</D:prop>
<D:ascending/>
</D:order>
</D:orderby>
</D:basicsearch>
</D:searchrequest>
</dasl:query>
