You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by an...@apache.org on 2006/05/29 07:59:21 UTC
svn commit: r410025 - in /cocoon/trunk/core/cocoon-core/src:
main/java/org/apache/cocoon/transformation/
test/java/org/apache/cocoon/transformation/
test/resources/org/apache/cocoon/transformation/
Author: antonio
Date: Sun May 28 22:59:20 2006
New Revision: 410025
URL: http://svn.apache.org/viewvc?rev=410025&view=rev
Log:
Merging from 2.1 fix for COCOON-1753 XInclude transformer uses href fragment rather than xpointer attribute (spec conformance).
Added:
cocoon/trunk/core/cocoon-core/src/test/resources/org/apache/cocoon/transformation/xinclude-input-fallbackTest.xml (with props)
cocoon/trunk/core/cocoon-core/src/test/resources/org/apache/cocoon/transformation/xinclude-input-nestedXincludeFallbackTest.xml (with props)
cocoon/trunk/core/cocoon-core/src/test/resources/org/apache/cocoon/transformation/xinclude-result-fallbackTest.xml (with props)
cocoon/trunk/core/cocoon-core/src/test/resources/org/apache/cocoon/transformation/xinclude-result-nestedXincludeFallbackTest.xml (with props)
Modified:
cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/XIncludeTransformer.java
cocoon/trunk/core/cocoon-core/src/test/java/org/apache/cocoon/transformation/XIncludeTransformerTestCase.java
Modified: cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/XIncludeTransformer.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/XIncludeTransformer.java?rev=410025&r1=410024&r2=410025&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/XIncludeTransformer.java (original)
+++ cocoon/trunk/core/cocoon-core/src/main/java/org/apache/cocoon/transformation/XIncludeTransformer.java Sun May 28 22:59:20 2006
@@ -80,6 +80,7 @@
public static final String XINCLUDE_INCLUDE_ELEMENT = "include";
public static final String XINCLUDE_FALLBACK_ELEMENT = "fallback";
public static final String XINCLUDE_INCLUDE_ELEMENT_HREF_ATTRIBUTE = "href";
+ public static final String XINCLUDE_INCLUDE_ELEMENT_XPOINTER_ATTRIBUTE = "xpointer";
public static final String XINCLUDE_INCLUDE_ELEMENT_PARSE_ATTRIBUTE = "parse";
private static final String XINCLUDE_CACHE_KEY = "XInclude";
@@ -93,7 +94,7 @@
this.validity = new MultiSourceValidity(resolver, MultiSourceValidity.CHECK_ALWAYS);
this.xIncludePipe = new XIncludePipe();
this.xIncludePipe.enableLogging(getLogger());
- this.xIncludePipe.init(null);
+ this.xIncludePipe.init(null, null);
super.setContentHandler(xIncludePipe);
super.setLexicalHandler(xIncludePipe);
}
@@ -158,10 +159,18 @@
* XIncludePipe. Used to detect loop inclusions.
* */
private String href;
+
+ /**
+ * Value of the xpointer attribute of the xi:include element that caused the creation of this
+ * XIncludePipe. Used to detect loop inclusions.
+ */
+ private String xpointer;
+
private XIncludePipe parent;
- public void init(String uri) {
+ public void init(String uri, String xpointer) {
this.href = uri;
+ this.xpointer = xpointer;
this.xmlBaseSupport = new XMLBaseSupport(resolver, getLogger());
}
@@ -177,6 +186,10 @@
return href;
}
+ public String getXpointer() {
+ return xpointer;
+ }
+
public void endDocument() throws SAXException {
// We won't be getting any more sources so mark the MultiSourceValidity as finished.
validity.close();
@@ -203,17 +216,14 @@
if (XINCLUDE_NAMESPACE_URI.equals(uri)) {
if (XINCLUDE_INCLUDE_ELEMENT.equals(name)) {
String href = attr.getValue("",XINCLUDE_INCLUDE_ELEMENT_HREF_ATTRIBUTE);
- if (href == null) {
- throw new SAXException(raw + " must have a 'href' attribute at " + getLocation());
- }
String parse = attr.getValue("",XINCLUDE_INCLUDE_ELEMENT_PARSE_ATTRIBUTE);
+ String xpointer = attr.getValue("",XINCLUDE_INCLUDE_ELEMENT_XPOINTER_ATTRIBUTE);
- if (null == parse) parse="xml";
xIncludeLevel++;
try {
- processXIncludeElement(href, parse);
+ processXIncludeElement(href, parse, xpointer);
} catch (ProcessingException e) {
getLogger().debug("Rethrowing exception", e);
throw new SAXException(e);
@@ -361,25 +371,38 @@
super.setDocumentLocator(locator);
}
- protected void processXIncludeElement(String href, String parse)
- throws SAXException,ProcessingException,IOException {
+ protected void processXIncludeElement(String href, String parse, String xpointer)
+ throws SAXException, ProcessingException, IOException {
if (getLogger().isDebugEnabled()) {
- getLogger().debug("Processing XInclude element: href="+href+", parse="+parse);
+ getLogger().debug("Processing XInclude element: href="+href+", parse="+parse+", xpointer="+xpointer);
}
+ // Default for @parse is "xml"
+ if (parse == null) {
+ parse = "xml";
+ }
Source url = null;
- String suffix = "";
+
try {
int fragmentIdentifierPos = href.indexOf('#');
if (fragmentIdentifierPos != -1) {
- suffix = href.substring(fragmentIdentifierPos + 1);
+ getLogger().warn("Fragment identifer found in 'href' attribute: " + href +
+ "\nFragment identifiers are forbidden by the XInclude specification. " +
+ "They are still handled by XIncludeTransformer for backward " +
+ "compatibility, but their use is deprecated and will be prohibited " +
+ "in a future release. Use the 'xpointer' attribute instead.");
+ if (xpointer == null) {
+ xpointer = href.substring(fragmentIdentifierPos + 1);
+ }
href = href.substring(0, fragmentIdentifierPos);
}
- // an empty href is a reference to the current document -- this can be different than the current base
- if (href.equals("")) {
- if (this.href == null)
+ // An empty or absent href is a reference to the current document -- this can be different than the current base
+ if (href == null || href.length() == 0) {
+ if (this.href == null) {
throw new SAXException("XIncludeTransformer: encountered empty href (= href pointing to the current document) but the location of the current document is unknown.");
+ }
+ // The following can be simplified once fragment identifiers are prohibited
int fragmentIdentifierPos2 = this.href.indexOf('#');
if (fragmentIdentifierPos2 != -1)
href = this.href.substring(0, fragmentIdentifierPos2);
@@ -389,19 +412,17 @@
url = xmlBaseSupport.makeAbsolute(href);
if (getLogger().isDebugEnabled()) {
- getLogger().debug("URL: " + url.getURI() + "\nSuffix: " + suffix);
+ getLogger().debug("URL: " + url.getURI() + "\nXPointer: " + xpointer);
}
// add the source to the SourceValidity
validity.addSource(url);
-
- // check loop inclusion
- String canonicURI = url.getURI() + (suffix.length() > 0 ? "#" + suffix: "");
- if (isLoopInclusion(canonicURI))
- throw new ProcessingException("Detected loop inclusion of " + canonicURI);
if (parse.equals("text")) {
getLogger().debug("Parse type is text");
+ if (xpointer != null) {
+ throw new SAXException("xpointer attribute must not be present when parse='text': " + getLocation());
+ }
InputStream is = null;
InputStreamReader isr = null;
Reader reader = null;
@@ -420,19 +441,25 @@
if (is != null) is.close();
}
} else if (parse.equals("xml")) {
+ getLogger().debug("Parse type is XML");
+
+ // Check loop inclusion
+ if (isLoopInclusion(url.getURI(), xpointer)) {
+ throw new ProcessingException("Detected loop inclusion of href=" + url.getURI() + ", xpointer=" + xpointer);
+ }
+
XIncludePipe subPipe = new XIncludePipe();
subPipe.enableLogging(getLogger());
- subPipe.init(canonicURI);
+ subPipe.init(url.getURI(), xpointer);
subPipe.setConsumer(xmlConsumer);
subPipe.setParent(this);
- getLogger().debug("Parse type is XML");
try {
- if (suffix.length() > 0) {
- XPointer xpointer;
- xpointer = XPointerFrameworkParser.parse(NetUtils.decodePath(suffix));
- XPointerContext context = new XPointerContext(suffix, url, subPipe, getLogger(), manager);
- xpointer.process(context);
+ if (xpointer != null && xpointer.length() > 0) {
+ XPointer xptr;
+ xptr = XPointerFrameworkParser.parse(NetUtils.decodePath(xpointer));
+ XPointerContext context = new XPointerContext(xpointer, url, subPipe, getLogger(), manager);
+ xptr.process(context);
} else {
SourceUtil.toSAX(url, new IncludeXMLConsumer(subPipe));
}
@@ -464,6 +491,8 @@
fallBackException = e;
getLogger().error("Error processing an xInclude, will try to use fallback.", e);
}
+ } else {
+ throw new SAXException("Found 'parse' attribute with unknown value " + parse + " at " + getLocation());
}
} catch (SourceException se) {
throw SourceUtil.handle(se);
@@ -474,14 +503,18 @@
}
}
- public boolean isLoopInclusion(String uri) {
- if (uri.equals(this.href)) {
+ public boolean isLoopInclusion(String uri, String xpointer) {
+ if (xpointer == null) {
+ xpointer = "";
+ }
+
+ if (uri.equals(this.href) && xpointer.equals(this.xpointer == null ? "" : this.xpointer)) {
return true;
}
XIncludePipe parent = getParent();
while (parent != null) {
- if (uri.equals(parent.getHref())) {
+ if (uri.equals(parent.getHref()) && xpointer.equals(parent.getXpointer() == null ? "" : parent.getXpointer())) {
return true;
}
parent = parent.getParent();
Modified: cocoon/trunk/core/cocoon-core/src/test/java/org/apache/cocoon/transformation/XIncludeTransformerTestCase.java
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-core/src/test/java/org/apache/cocoon/transformation/XIncludeTransformerTestCase.java?rev=410025&r1=410024&r2=410025&view=diff
==============================================================================
--- cocoon/trunk/core/cocoon-core/src/test/java/org/apache/cocoon/transformation/XIncludeTransformerTestCase.java (original)
+++ cocoon/trunk/core/cocoon-core/src/test/java/org/apache/cocoon/transformation/XIncludeTransformerTestCase.java Sun May 28 22:59:20 2006
@@ -25,7 +25,7 @@
* @version $Id$
*/
public class XIncludeTransformerTestCase extends SitemapComponentTestCase {
-
+
/* (non-Javadoc)
* @see org.apache.cocoon.SitemapComponentTestCase#getSitemapComponentInfo()
*/
@@ -34,22 +34,18 @@
XIncludeTransformer.class.getName(),
"xinclude"};
}
-
+
+ private void xincludeTest(String input, String result) throws Exception {
+ assertEqual(load(result), transform("xinclude", null, new Parameters(), load(input)));
+ }
/** Testcase for xinclude simple include
*
* @throws Exception if ServiceManager enterEnvironment fails
*/
public void testXInclude1() throws Exception {
getLogger().debug("testXInclude1");
-
- Parameters parameters = new Parameters();
-
- String input = "resource://org/apache/cocoon/transformation/xinclude-input-1.xml";
- String result = "resource://org/apache/cocoon/transformation/xinclude-result-1.xml";
- String src = null;
-
- assertEqual( load(result),
- transform("xinclude", src, parameters, load(input)));
+ xincludeTest("resource://org/apache/cocoon/transformation/xinclude-input-1.xml",
+ "resource://org/apache/cocoon/transformation/xinclude-result-1.xml");
}
/** Testcase for xinclude simple text include
@@ -58,15 +54,31 @@
*/
public void testXInclude2() throws Exception {
getLogger().debug("testXInclude2");
-
- Parameters parameters = new Parameters();
-
- String input = "resource://org/apache/cocoon/transformation/xinclude-input-2.xml";
- String result = "resource://org/apache/cocoon/transformation/xinclude-result-2.xml";
- String src = null;
-
- assertEqual( load(result),
- transform("xinclude", src, parameters, load(input)));
+ xincludeTest("resource://org/apache/cocoon/transformation/xinclude-input-2.xml",
+ "resource://org/apache/cocoon/transformation/xinclude-result-2.xml");
}
-
+
+ // TODO: AG (2006-05-29): The following 2 testcases fail, due an unexpeced exception:
+ // org.springframework.beans.factory.NoSuchBeanDefinitionException
+ // Once the avalon support into spring is totally transparent, this should work again.
+ // Another option is to rewrite the XInclude transformer to only use spring framework.
+ /** Testcase for xinclude simple fallback
+ *
+ * @throws Exception if ComponentManager enterEnvironment fails
+ */
+ /*public void testXIncludeSimpleFallbackTest() throws Exception {
+ getLogger().debug("testXIncludeSimpleFallbackTest");
+ xincludeTest("resource://org/apache/cocoon/transformation/xinclude-input-fallbackTest.xml",
+ "resource://org/apache/cocoon/transformation/xinclude-result-fallbackTest.xml");
+ }*/
+
+ /** Testcase for xinclude with a nested xinclude elemento into the fallback
+ *
+ * @throws Exception if ComponentManager enterEnvironment fails
+ */
+ /*public void testXIncludeNestedXincludeElementInAFallbackTest() throws Exception {
+ getLogger().debug("testXIncludeNestedXincludeElementInAFallbackTest");
+ xincludeTest("resource://org/apache/cocoon/transformation/xinclude-input-nestedXincludeFallbackTest.xml",
+ "resource://org/apache/cocoon/transformation/xinclude-result-fallbackTest.xml");
+ }*/
}
Added: cocoon/trunk/core/cocoon-core/src/test/resources/org/apache/cocoon/transformation/xinclude-input-fallbackTest.xml
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-core/src/test/resources/org/apache/cocoon/transformation/xinclude-input-fallbackTest.xml?rev=410025&view=auto
==============================================================================
--- cocoon/trunk/core/cocoon-core/src/test/resources/org/apache/cocoon/transformation/xinclude-input-fallbackTest.xml (added)
+++ cocoon/trunk/core/cocoon-core/src/test/resources/org/apache/cocoon/transformation/xinclude-input-fallbackTest.xml Sun May 28 22:59:20 2006
@@ -0,0 +1,31 @@
+<?xml version="1.0" ?>
+<!--
+ Copyright 1999-2004 The Apache Software Foundation
+
+ 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.
+-->
+
+<root
+ xmlns:xi="http://www.w3.org/2001/XInclude">
+ <p>P1</p>
+ <p>P2</p>
+
+ <xi:include href="this_file_does_not_exist.xml">
+ <xi:fallback>
+ <element>This should be here if the file was not found</element>
+ </xi:fallback>
+ </xi:include>
+
+ <p>P3</p>
+ <p>P4</p>
+</root>
\ No newline at end of file
Propchange: cocoon/trunk/core/cocoon-core/src/test/resources/org/apache/cocoon/transformation/xinclude-input-fallbackTest.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: cocoon/trunk/core/cocoon-core/src/test/resources/org/apache/cocoon/transformation/xinclude-input-nestedXincludeFallbackTest.xml
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-core/src/test/resources/org/apache/cocoon/transformation/xinclude-input-nestedXincludeFallbackTest.xml?rev=410025&view=auto
==============================================================================
--- cocoon/trunk/core/cocoon-core/src/test/resources/org/apache/cocoon/transformation/xinclude-input-nestedXincludeFallbackTest.xml (added)
+++ cocoon/trunk/core/cocoon-core/src/test/resources/org/apache/cocoon/transformation/xinclude-input-nestedXincludeFallbackTest.xml Sun May 28 22:59:20 2006
@@ -0,0 +1,31 @@
+<?xml version="1.0" ?>
+<!--
+ Copyright 1999-2004 The Apache Software Foundation
+
+ 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.
+-->
+
+<root
+ xmlns:xi="http://www.w3.org/2001/XInclude">
+ <p>P1</p>
+ <p>P2</p>
+
+ <xi:include href="this_file_does_not_exist.xml">
+ <xi:fallback>
+ <xi:include href="resource://org/apache/cocoon/transformation/xinclude-incl.xml"/>
+ </xi:fallback>
+ </xi:include>
+
+ <p>P3</p>
+ <p>P4</p>
+</root>
\ No newline at end of file
Propchange: cocoon/trunk/core/cocoon-core/src/test/resources/org/apache/cocoon/transformation/xinclude-input-nestedXincludeFallbackTest.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: cocoon/trunk/core/cocoon-core/src/test/resources/org/apache/cocoon/transformation/xinclude-result-fallbackTest.xml
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-core/src/test/resources/org/apache/cocoon/transformation/xinclude-result-fallbackTest.xml?rev=410025&view=auto
==============================================================================
--- cocoon/trunk/core/cocoon-core/src/test/resources/org/apache/cocoon/transformation/xinclude-result-fallbackTest.xml (added)
+++ cocoon/trunk/core/cocoon-core/src/test/resources/org/apache/cocoon/transformation/xinclude-result-fallbackTest.xml Sun May 28 22:59:20 2006
@@ -0,0 +1,27 @@
+<?xml version="1.0" ?>
+<!--
+ Copyright 1999-2004 The Apache Software Foundation
+
+ 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.
+-->
+
+<root
+ xmlns:xi="http://apache.org/cocoon/include/1.0">
+ <p>P1</p>
+ <p>P2</p>
+
+ <element>This should be here if the file was not found</element>
+
+ <p>P3</p>
+ <p>P4</p>
+</root>
\ No newline at end of file
Propchange: cocoon/trunk/core/cocoon-core/src/test/resources/org/apache/cocoon/transformation/xinclude-result-fallbackTest.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: cocoon/trunk/core/cocoon-core/src/test/resources/org/apache/cocoon/transformation/xinclude-result-nestedXincludeFallbackTest.xml
URL: http://svn.apache.org/viewvc/cocoon/trunk/core/cocoon-core/src/test/resources/org/apache/cocoon/transformation/xinclude-result-nestedXincludeFallbackTest.xml?rev=410025&view=auto
==============================================================================
--- cocoon/trunk/core/cocoon-core/src/test/resources/org/apache/cocoon/transformation/xinclude-result-nestedXincludeFallbackTest.xml (added)
+++ cocoon/trunk/core/cocoon-core/src/test/resources/org/apache/cocoon/transformation/xinclude-result-nestedXincludeFallbackTest.xml Sun May 28 22:59:20 2006
@@ -0,0 +1,33 @@
+<?xml version="1.0" ?>
+<!--
+ Copyright 1999-2004 The Apache Software Foundation
+
+ 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.
+-->
+
+<root
+ xmlns:xi="http://apache.org/cocoon/include/1.0">
+ <p>P1</p>
+ <p>P2</p>
+
+<root-include>
+ <br/>
+ <p>include 1</p>
+ <p>include 2</p>
+ <p>include 3</p>
+ <p>include 4</p>
+</root-include>
+
+ <p>P3</p>
+ <p>P4</p>
+</root>
Propchange: cocoon/trunk/core/cocoon-core/src/test/resources/org/apache/cocoon/transformation/xinclude-result-nestedXincludeFallbackTest.xml
------------------------------------------------------------------------------
svn:eol-style = native