Author: crossley
Date: Wed Aug 24 01:07:54 2005
New Revision: 239562
URL: http://svn.apache.org/viewcvs?rev=239562&view=rev
Log:
Some problem files as examples for testing the whitespace issues.
Added:
forrest/trunk/etc/test-whitespace/
forrest/trunk/etc/test-whitespace/AbstractWrappingModule.java (with props)
forrest/trunk/etc/test-whitespace/XPathTransformer.java (with props)
forrest/trunk/etc/test-whitespace/content-include-html.ft (with props)
Added: forrest/trunk/etc/test-whitespace/AbstractWrappingModule.java
URL:
http://svn.apache.org/viewcvs/forrest/trunk/etc/test-whitespace/AbstractWrappingModule.java?rev=239562&view=auto
==============================================================================
--- forrest/trunk/etc/test-whitespace/AbstractWrappingModule.java (added)
+++ forrest/trunk/etc/test-whitespace/AbstractWrappingModule.java Wed Aug 24
01:07:54 2005
@@ -0,0 +1,97 @@
+/*
+ * Copyright 1999-2004 The Apache Software Foundation or its licensors,
+ * as applicable.
+ *
+ * Licensed 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 org.apache.forrest.locationmap;
+
+import java.util.Iterator;
+import java.util.Map;
+
+import org.apache.avalon.framework.activity.Disposable;
+import org.apache.avalon.framework.configuration.Configurable;
+import org.apache.avalon.framework.configuration.Configuration;
+import org.apache.avalon.framework.configuration.ConfigurationException;
+import org.apache.avalon.framework.logger.AbstractLogEnabled;
+import org.apache.avalon.framework.logger.LogEnabled;
+import org.apache.avalon.framework.service.ServiceException;
+import org.apache.avalon.framework.service.ServiceManager;
+import org.apache.avalon.framework.service.Serviceable;
+
+import org.apache.cocoon.components.modules.input.InputModule;
+
+public abstract class AbstractWrappingModule extends AbstractLogEnabled
+ implements InputModule, Configurable, Serviceable, Disposable {
+
+ InputModule child;
+ ServiceManager manager;
+
+ public void service(ServiceManager manager) throws ServiceException {
+ this.manager = manager;
+ }
+
+ public void configure(Configuration config) throws ConfigurationException {
+
+ Configuration childConf = config.getChild("component-instance");
+ String childClassName = childConf.getAttribute("class");
+ getLogger().debug("Loading wrapped class:"+childClassName);
+
+ try{
+ child = (InputModule) Class.forName(childClassName).newInstance();
+ getLogger().debug("Wrapped class instantiated:"+child);
+
+ if(child instanceof LogEnabled){
+ ((LogEnabled)child).enableLogging( getLogger() );
+ getLogger().debug("Wrapped class LogEnabled");
+ }
+
+ if(child instanceof Serviceable){
+ ((Serviceable)child).service( manager );
+ getLogger().debug("Wrapped class Serviced");
+ }
+
+ if(child instanceof Configurable){
+
((Configurable)child).configure(config.getChild("component-instance"));
+ getLogger().debug("Wrapped class Configured");
+ }
+
+ }catch(Exception e){
+ throw new ConfigurationException
+ ("Cannot instatiate the wrapped Module of
class:"+childClassName, e);
+ }
+ }
+
+ public Object getAttribute(String name, Configuration modeConf, Map
objectModel)
+ throws ConfigurationException {
+ return child.getAttribute(name, modeConf, objectModel);
+ }
+
+ public Iterator getAttributeNames(Configuration modeConf, Map objectModel)
+ throws ConfigurationException {
+ return child.getAttributeNames(modeConf, objectModel);
+ }
+
+ public Object[] getAttributeValues(String name, Configuration modeConf,
Map objectModel)
+ throws ConfigurationException {
+ return child.getAttributeValues(name, modeConf, objectModel);
+ }
+
+ public void dispose() {
+ if(child instanceof Disposable){
+ ((Disposable)child).dispose();
+ }
+ }
+
+}
Propchange: forrest/trunk/etc/test-whitespace/AbstractWrappingModule.java
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/trunk/etc/test-whitespace/XPathTransformer.java
URL:
http://svn.apache.org/viewcvs/forrest/trunk/etc/test-whitespace/XPathTransformer.java?rev=239562&view=auto
==============================================================================
--- forrest/trunk/etc/test-whitespace/XPathTransformer.java (added)
+++ forrest/trunk/etc/test-whitespace/XPathTransformer.java Wed Aug 24 01:07:54
2005
@@ -0,0 +1,409 @@
+/*
+ * Copyright 1999-2004 The Apache Software Foundation or its licensors,
+ * as applicable.
+ *
+ * Licensed 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 org.apache.forrest.util;
+
+import java.io.IOException;
+import java.io.Serializable;
+import java.util.Map;
+import java.util.Stack;
+
+import org.apache.avalon.framework.parameters.Parameters;
+import org.apache.avalon.framework.service.ServiceManager;
+import org.apache.avalon.framework.service.ServiceException;
+import org.apache.cocoon.ProcessingException;
+import org.apache.cocoon.transformation.AbstractDOMTransformer;
+import org.apache.cocoon.caching.CacheableProcessingComponent;
+import org.apache.cocoon.environment.SourceResolver;
+import org.apache.cocoon.util.HashUtil;
+import org.apache.excalibur.source.SourceValidity;
+import org.apache.excalibur.source.impl.validity.NOPValidity;
+import org.apache.excalibur.xml.dom.DOMParser;
+import org.apache.excalibur.xml.xpath.XPathProcessor;
+import org.w3c.dom.Attr;
+import org.w3c.dom.Document;
+import org.w3c.dom.Element;
+import org.w3c.dom.Node;
+import org.w3c.dom.NodeList;
+import org.xml.sax.SAXException;
+
+/**
+ * A transformer that prunes the source tree based on <code>include</code> and
+ * <code>exclude</code> XPath expressions.
+ * The <code>include</code> parameter specifies nodes to let through, and
+ * <code>exclude</code> parameter nodes to filter out. Either or both may be
+ * omitted. The default behaviour is for all nodes to be let through
+ * (<code>include</code> = "/").
+ * <p>
+ * This transformer should be declared in the sitemap at
+ * <b>map:sitemap/map:components/map:transformers</b>, as follows<br>
+ * <pre>
+ * <map:transformer logger="sitemap.transformer.xpath" name="xpath"
src="org.apache.cocoon.transformation.XPathTransformer" /><br>
+ * </pre>
+ * <h3>Example usage</h3>
+ * As an example, consider a user manual XML file:
+ * <pre>
+ * <manual>
+ * <s1 title="Introduction">
+ * <p>This is the introduction</p>
+ * <p>A second paragraph</p>
+ * </s1>
+ * <s1 title="Getting started">
+ * <p>Getting started</p>
+ * <fixme>Add some content here</fixme>
+ * <n:note xmlns:n="urn:notes">banana 1</n:note>
<note>banana 2</note>
+ * <p>Yes, we have no bananas</p>
+ * </s1>
+ * </manual>
+ * </pre>
+ * We could now deliver named chapters as follows:
+ * <pre>
+ * <map:match pattern="manual/*">
+ * <map:generate src="manual.xml"/>
+ * <map:transform type="xpath">
+ * <map:parameter name="include" value="/manual/[EMAIL
PROTECTED]'{1}']"/>
+ * </map:transform>
+ * <map:serialize type="xml"/>
+ * </map:match>
+ * </pre>
+ * So <code>manual/Introduction</code> would return the first chapter.
+ */
+public class XPathTransformer
+ extends AbstractDOMTransformer
+ implements CacheableProcessingComponent
+{
+
+ /** XPath Processor */
+ private XPathProcessor processor = null;
+ private DOMParser parser = null;
+
+ /** XPath specifying nodes to include. Defaults to the root node */
+ protected String include = null;
+ /** XPath specifying nodes to exclude. Defaults to "" (no exclusions) */
+ protected String exclude = null;
+
+ public void setup(SourceResolver resolver, Map objectModel,
+ String source, Parameters parameters)
+ throws ProcessingException, SAXException, IOException {
+ super.setup(resolver, objectModel, source, parameters);
+ this.include = parameters.getParameter("include", "/");
+ this.exclude = parameters.getParameter("exclude", null);
+ }
+
+
+ public void service(ServiceManager manager) throws ServiceException {
+ super.service(manager);
+ try {
+ this.processor =
(XPathProcessor)this.manager.lookup(XPathProcessor.ROLE);
+ } catch (Exception e) {
+ getLogger().error("cannot obtain XPathProcessor", e);
+ }
+ try {
+ this.parser = (DOMParser)this.manager.lookup(DOMParser.ROLE);
+ } catch (Exception e) {
+ getLogger().error("cannot obtain DOMParser", e);
+ }
+ }
+
+
+ /** Implementation of a template method declared in AbstractDOMTransformer.
+ * @param doc DOM of XML received by the transformer
+ * @return A pared-down DOM.
+ */
+ protected Document transform(Document doc) {
+ getLogger().debug("Transforming with include='"+include+"',
exclude='"+exclude+"'");
+ Document newDoc = null;
+ try {
+ newDoc = handleIncludes(doc, this.include);
+ newDoc = handleExcludes(newDoc, this.exclude);
+ } catch (SAXException se) {
+ // Really ought to be able to propagate these to caller
+ getLogger().error("Error when transforming XML", se);
+ throw new RuntimeException("Error transforming XML. See
error log for details: "+se);
+ }
+ return newDoc;
+ }
+
+ /**
+ * Construct a new DOM containing nodes matched by <code>include</code>
XPath expression.
+ * @param doc Original DOM
+ * @param xpath XPath include expression
+ * @return DOM containing nodes from <code>doc</code> matched by
<code>XPath</code>
+ */
+ private Document handleIncludes(Document doc, String xpath) throws
SAXException {
+ if (xpath == null || xpath.equals("/")) {
+ return doc;
+ }
+ Document newDoc = parser.createDocument();
+ NodeList nodes = processor.selectNodeList(doc, xpath);
+ for (int i=0; i<nodes.getLength(); i++) {
+ Node node = nodes.item(i);
+ addNode(newDoc, node);
+ }
+ return newDoc;
+ }
+
+ /**
+ * Construct a new DOM excluding nodes matched by <code>exclude</code>
XPath expression.
+ * @param doc Original DOM
+ * @param xpath XPath exclude expression
+ * @return DOM containing nodes from <code>doc</code>, excluding those
+ * matched by <code>XPath</code>
+ */
+ private Document handleExcludes(Document doc, String xpath) {
+ if (xpath == null || xpath.trim().equals("")) {
+ return doc;
+ }
+ NodeList nodes = processor.selectNodeList(doc, xpath);
+ for (int i = 0; i < nodes.getLength(); i++) {
+ Node node = nodes.item(i);
+ // Detach this node. Attr nodes need to be handled specially
+ if (node.getNodeType() == Node.ATTRIBUTE_NODE) {
+ Attr attrNode = (Attr)node;
+ Element parent = attrNode.getOwnerElement();
+ parent.removeAttributeNode(attrNode);
+ } else {
+ Node parent = node.getParentNode();
+ if (parent != null) {
+ parent.removeChild(node);
+ }
+ }
+ }
+ return doc;
+ }
+
+ /**
+ * Add a node to the Document, including all of the node's ancestor nodes.
+ * Eg, if <code>node</code> is the title="Introduction" node in the
+ * example, the doc would have node /manual/s1/@title='Introduction' added
+ * to it.
+ *
+ * @fixme This method could do with some optimization. Currently, every
+ * node addition results in one expensive node equality check per ancestor
+ * @param doc Document to add a node to
+ * @param nodeTemplate Node from another Document which we wish to
+ * replicate in <code>doc</code>. This is used as a template, not actually
+ * physically copied.
+ */
+ private void addNode(Document doc, final Node nodeTemplate) {
+ // Get a stack of node's ancestors (inclusive)
+ Stack stack = new Stack();
+ Node parent = nodeTemplate;
+ Document oldDoc = nodeTemplate.getOwnerDocument();
+ while (parent != oldDoc) {
+ stack.push(parent);
+ parent = parent.getParentNode();
+ }
+ // Example stack: (top) [ /manual, /manual/s1, /manual/s1/@title ]
(bottom)
+
+ // Now from the earliest (root) ancestor, add cloned nodes to the
+ // doc. We check if a suitable ancestor node doesn't already exist in
+ // addNode()
+ parent = doc;
+ while (!stack.empty()) {
+ Node oldNode = (Node)stack.pop();
+ Node newNode = null;
+ if (!stack.empty()) {
+ // Shallow copy o a parent node (in example: /manual, then
/manual/s1)
+ newNode = doc.importNode(oldNode, false); // Do a shallow copy
+ copyNamespaceDeclarations(oldNode, newNode);
+ parent = findOrCreateNode(parent, newNode);
+ } else {
+ // Deep copy of the matched node (in example: /manual/s1/@title)
+ newNode = doc.importNode(oldNode, true);
+ copyNamespaceDeclarations(oldNode, newNode);
+ parent.appendChild(newNode);
+ }
+ }
+ }
+
+ /**
+ * Add xmlns namespace declaration attribute to newNode, based on those
from oldNode.
+ * It seems that a DOM object built from SAX with namespace-prefixes=false
+ * doesn't have xmlns attribute declarations by default, so we must
+ * manually add them.
+ * @param oldNode Original node, with namespace attributes intact
+ * @param newNode If an Element, this node will have an <code>xmlns</code>
+ * (or <code>xmlns:prefix</code>) attribute added to define the node's
namespace.
+ */
+ private void copyNamespaceDeclarations(final Node oldNode, Node newNode) {
+ if (newNode.getNodeType() == Node.ELEMENT_NODE) {
+ String prefix = oldNode.getPrefix();
+ String nsURI = oldNode.getNamespaceURI();
+ Element newElem = (Element)newNode;
+ if (nsURI != null) {
+ if (prefix == null || prefix.equals("")) {
+ if (!newElem.hasAttribute("xmlns")) newElem.setAttribute("xmlns",
nsURI);
+ } else {
+ if (!newElem.hasAttribute("xmlns:"+prefix))
newElem.setAttribute("xmlns:"+prefix, nsURI);
+ }
+ }
+ }
+ }
+
+ /**
+ * Add newNode as a child of parent, first checking if any equivalent node
+ * to newNode already exists as a child of parent.
+ *
+ * @param parent Parent node of found or created node
+ * @param newNode The node potentially added to parent, unless parent
+ * already has an equivalent node
+ * @return the appended node, or the old equivalent node if found.
+ */
+ private Node findOrCreateNode(Node parent, Node newNode) {
+ NodeList otherChildren = parent.getChildNodes();
+ for (int i = 0; i < otherChildren.getLength(); i++) {
+ Node child = otherChildren.item(i);
+ if (nodeEquality(child, newNode)) {
+ // Found existing equivalent node
+ return child;
+ }
+ }
+ // No existing equivalent node found; add and return newNode
+ parent.appendChild(newNode);
+ return newNode;
+ }
+
+ /**
+ * Shallow-test two nodes for equality.
+ * To quote from the Xerces DOM3 Node.isEqualNode() javadocs, from where
+ * most of the code is filched:
+ *
+ * [Nodes are equal if] the following string attributes are equal:
+ * <code>nodeName</code>, <code>localName</code>,
+ * <code>namespaceURI</code>, <code>prefix</code>, <code>nodeValue</code>.
+ * This is: they are both <code>null</code>, or they have the same length
+ * and are character for character identical.
+ */
+ private boolean nodeEquality(final Node n1, final Node n2) {
+ if (n1.getNodeType() != n2.getNodeType()) {
+ return false;
+ }
+ if (n1.getNodeName() == null) {
+ if (n2.getNodeName() != null) {
+ return false;
+ }
+ }
+ else if (!n1.getNodeName().equals(n2.getNodeName())) {
+ return false;
+ }
+
+ if (n1.getLocalName() == null) {
+ if (n2.getLocalName() != null) {
+ return false;
+ }
+ }
+ else if (!n1.getLocalName().equals(n2.getLocalName())) {
+ return false;
+ }
+
+ if (n1.getNamespaceURI() == null) {
+ if (n2.getNamespaceURI() != null) {
+ return false;
+ }
+ }
+ else if (!n1.getNamespaceURI().equals(n2.getNamespaceURI())) {
+ return false;
+ }
+
+ if (n1.getPrefix() == null) {
+ if (n2.getPrefix() != null) {
+ return false;
+ }
+ }
+ else if (!n1.getPrefix().equals(n2.getPrefix())) {
+ return false;
+ }
+
+ if (n1.getNodeValue() == null) {
+ if (n2.getNodeValue() != null) {
+ return false;
+ }
+ }
+ else if (!n1.getNodeValue().equals(n2.getNodeValue())) {
+ return false;
+ }
+ return true;
+ }
+
+ // Unused debugging methods
+
+ private final void printNode(String msg, Node node) {
+ getLogger().info(msg+" "+node.getNodeName());
+ }
+/*
+ private final void printDeepNode(String msg, Node node) {
+ try {
+ getLogger().info(msg+" "+XMLUtils.serializeNodeToXML(node));
+ } catch (ProcessingException pe) {
+ getLogger().error("Error printing node", pe);
+ }
+ }
+*/
+ // Cache methods
+
+ /**
+ * Generate the unique key.
+ * This key must be unique inside the space of this component.
+ *
+ * @return A hash of the include and exclude parameters, thus uniquely
+ * identifying this XPathTransformer amongst it's peers.
+ */
+ public Serializable getKey() {
+ return ""+HashUtil.hash(this.include+this.exclude);
+ }
+ // For backwards-compat
+ public Serializable generateKey() {
+ return getKey();
+ }
+
+ /**
+ * Generate the validity object.
+ *
+ * @return An "always valid" SourceValidity object. This transformer has no
+ * inputs other than the incoming SAX events.
+ */
+ public SourceValidity getValidity() {
+ return new NOPValidity();
+ }
+
+ // for backwards-compat
+ public SourceValidity generateValidity() {
+ return getValidity();
+ }
+
+ /**
+ * Recycle the component.
+ */
+ public void recycle() {
+ super.recycle();
+ this.include = null;
+ this.exclude = null;
+ // note that we don't turf our parser and processor,
+ }
+
+ /**
+ * dispose
+ */
+ public void dispose() {
+ super.dispose();
+ this.processor = null;
+ this.parser = null;
+ this.include = null;
+ this.exclude = null;
+ }
+}
+
Propchange: forrest/trunk/etc/test-whitespace/XPathTransformer.java
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/trunk/etc/test-whitespace/content-include-html.ft
URL:
http://svn.apache.org/viewcvs/forrest/trunk/etc/test-whitespace/content-include-html.ft?rev=239562&view=auto
==============================================================================
--- forrest/trunk/etc/test-whitespace/content-include-html.ft (added)
+++ forrest/trunk/etc/test-whitespace/content-include-html.ft Wed Aug 24
01:07:54 2005
@@ -0,0 +1,56 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright 2002-2004 The Apache Software Foundation or its licensors,
+ as applicable.
+
+ Licensed 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.
+-->
+
+<forrest:contract name="content-include-html" type="nugget"
+ xmlns:forrest="http://apache.org/forrest/templates/1.0";>
+
+ <description>
+ content-include-html retrieves the content from a Forrest generated HTML
document and
+ includes the current document.
+ </description>
+
+ <usage>
+<![CDATA[<forrest:contract name="content-include-html">
+ <forrest:properties contract="content-include-html">
+ <forrest:property name="content-include-html"
nugget="get.nugget.include.html">
+ <url>/path/to/a/document.html</url>
+ </forrest:property>
+ </forrest:properties>
+</forrest:contract>]]>
+ </usage>
+
+ <forrest:template
+ xmlns:forrest="http://apache.org/forrest/templates/1.0";
+ format="xhtml"
+ name="content-include-html"
+ inputFormat="xsl"
+ body="true"
+ head="false">
+
+ <xsl:stylesheet version="1.1"
+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform";>
+
+ <xsl:template name="content-include-html-body" >
+ <xsl:param name="content-include-html"/>
+ <xsl:copy-of select="$content-include-html//[EMAIL
PROTECTED]'content']/*"/>
+ </xsl:template>
+
+ </xsl:stylesheet>
+
+ </forrest:template>
+</forrest:contract>
Propchange: forrest/trunk/etc/test-whitespace/content-include-html.ft
------------------------------------------------------------------------------
svn:eol-style = native
