Hi all,
Based on our previous discussions on reusing the code between Xalan and Xsltc I am submitting
the patches for moving the StylesheetPIHandler and StopParseException from org.apache.xalan.processor classes to org.apache.xml.utils package. These two java files need to be removed from org/apache/xalan/processor and added to org/apache/xml/utils folder .
Both the xalan and xsltc TransformerFactories are modified to incorporate this change.
Please can you could review this and submit the patch.
Thanks, Bhakti
-------- Original Message --------
Subject: Proposal for moving reused code to independent packages
Date: Wed, 26 Nov 2003 13:38:34 -0800
From: Bhakti Mehta Reply-To: [EMAIL PROTECTED]
To: [EMAIL PROTECTED]
CC: Santiago Pericas-Geertsen
Hi,
I wanted to put forth the following proposal.
There are cases when we may reuse the code from xalan in xsltc. For e.g for one of the bugfixes in xsltc related to getAssociatedStylesheets I had reused org.xml.xalan.processor.StylesheetPIHandler and StopParseException classes which were doing a great job in xalan. However such classes do not get included in the xsltc.jar if the xsltc.jar target is invoked on the Apache codebase. I am sure there may be other cases where we may be reusing code.
We can identify and move such code under a common package
such as org.apache.xml.utils or somewhere else where it could get picked by both xalan or xsltc jars.
Advantages ========== 1)This would help identifying and decoupling common parts so that they could be reused more efficiently. 2)It would help create complete jars which could be used independently. 3)It would help easier maintainence in the future.
Please can you let me know your views on this. It would be nice to initiate and incorporate these changes in our future releases.
Thanks, Bhakti
Index: src/org/apache/xalan/processor/TransformerFactoryImpl.java =================================================================== RCS file: /home/cvspublic/xml-xalan/java/src/org/apache/xalan/processor/TransformerFactoryImpl.java,v retrieving revision 1.54 diff -r1.54 TransformerFactoryImpl.java 92a93,94 > import org.apache.xml.utils.StylesheetPIHandler; > import org.apache.xml.utils.StopParseException; 99a102 >
Index: src/org/apache/xalan/xsltc/trax/TransformerFactoryImpl.java =================================================================== RCS file: /home/cvspublic/xml-xalan/java/src/org/apache/xalan/xsltc/trax/TransformerFactoryImpl.java,v retrieving revision 1.70 diff -r1.70 TransformerFactoryImpl.java 103,105d102 < import org.apache.xalan.processor.StylesheetPIHandler; < import org.apache.xalan.processor.StopParseException; < 116a114,116 > > import org.apache.xml.utils.StylesheetPIHandler; > import org.apache.xml.utils.StopParseException;
/* * 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 * modification, 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 "Xalan" 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 (INCLUDING, 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 based on software copyright (c) 1999, Lotus * Development Corporation., http://www.lotus.com. For more * information on the Apache Software Foundation, please see * <http://www.apache.org/>. */ package org.apache.xml.utils; import java.util.StringTokenizer; import java.util.Vector; import javax.xml.transform.Source; import javax.xml.transform.TransformerException; import javax.xml.transform.URIResolver; import javax.xml.transform.sax.SAXSource; import org.xml.sax.Attributes; import org.xml.sax.InputSource; import org.xml.sax.helpers.DefaultHandler; /** * Search for the xml-stylesheet processing instructions in an XML document. * @see <a href="http://www.w3.org/TR/xml-stylesheet/";>Associating Style Sheets with XML documents, Version 1.0</a> */ public class StylesheetPIHandler extends DefaultHandler { /** The baseID of the document being processed. */ String m_baseID; /** The desired media criteria. */ String m_media; /** The desired title criteria. */ String m_title; /** The desired character set criteria. */ String m_charset; /** A list of SAXSource objects that match the criteria. */ Vector m_stylesheets = new Vector(); // Add code to use a URIResolver. Patch from Dmitri Ilyin. /** * The object that implements the URIResolver interface, * or null. */ URIResolver m_uriResolver; /** * Get the object that will be used to resolve URIs in href * in xml-stylesheet processing instruction. * * @param resolver An object that implements the URIResolver interface, * or null. */ public void setURIResolver(URIResolver resolver) { m_uriResolver = resolver; } /** * Get the object that will be used to resolve URIs in href * in xml-stylesheet processing instruction. * * @return The URIResolver that was set with setURIResolver. */ public URIResolver getURIResolver() { return m_uriResolver; } /** * Construct a StylesheetPIHandler instance that will search * for xml-stylesheet PIs based on the given criteria. * * @param baseID The base ID of the XML document, needed to resolve * relative IDs. * @param media The desired media criteria. * @param title The desired title criteria. * @param charset The desired character set criteria. */ public StylesheetPIHandler(String baseID, String media, String title, String charset) { m_baseID = baseID; m_media = media; m_title = title; m_charset = charset; } /** * Return the last stylesheet found that match the constraints. * * @return Source object that references the last stylesheet reference * that matches the constraints. */ public Source getAssociatedStylesheet() { int sz = m_stylesheets.size(); if (sz > 0) { Source source = (Source) m_stylesheets.elementAt(sz-1); return source; } else return null; } /** * Handle the xml-stylesheet processing instruction. * * @param target The processing instruction target. * @param data The processing instruction data, or null if * none is supplied. * @throws org.xml.sax.SAXException Any SAX exception, possibly * wrapping another exception. * @see org.xml.sax.ContentHandler#processingInstruction * @see <a href="http://www.w3.org/TR/xml-stylesheet/";>Associating Style Sheets with XML documents, Version 1.0</a> */ public void processingInstruction(String target, String data) throws org.xml.sax.SAXException { if (target.equals("xml-stylesheet")) { String href = null; // CDATA #REQUIRED String type = null; // CDATA #REQUIRED String title = null; // CDATA #IMPLIED String media = null; // CDATA #IMPLIED String charset = null; // CDATA #IMPLIED boolean alternate = false; // (yes|no) "no" StringTokenizer tokenizer = new StringTokenizer(data, " \t=\n", true); boolean lookedAhead = false; Source source = null; String token = ""; while (tokenizer.hasMoreTokens()) { if (!lookedAhead) token = tokenizer.nextToken(); else lookedAhead = false; if (tokenizer.hasMoreTokens() && (token.equals(" ") || token.equals("\t") || token.equals("="))) continue; String name = token; if (name.equals("type")) { token = tokenizer.nextToken(); while (tokenizer.hasMoreTokens() && (token.equals(" " ) || token.equals("\t") || token.equals("="))) token = tokenizer.nextToken(); type = token.substring(1, token.length() - 1); } else if (name.equals("href")) { token = tokenizer.nextToken(); while (tokenizer.hasMoreTokens() && (token.equals(" " ) || token.equals("\t") || token.equals("="))) token = tokenizer.nextToken(); href = token; if (tokenizer.hasMoreTokens()) { token = tokenizer.nextToken(); // If the href value has parameters to be passed to a // servlet(something like "foobar?id=12..."), // we want to make sure we get them added to // the href value. Without this check, we would move on // to try to process another attribute and that would be // wrong. // We need to set lookedAhead here to flag that we // already have the next token. while ( token.equals("=") && tokenizer.hasMoreTokens()) { href = href + token + tokenizer.nextToken(); if (tokenizer.hasMoreTokens()) { token = tokenizer.nextToken(); lookedAhead = true; } else { break; } } } href = href.substring(1, href.length() - 1); try { // Add code to use a URIResolver. Patch from Dmitri Ilyin. if (m_uriResolver != null) { source = m_uriResolver.resolve(href, m_baseID); } else { href = SystemIDResolver.getAbsoluteURI(href, m_baseID); source = new SAXSource(new InputSource(href)); } } catch(TransformerException te) { throw new org.xml.sax.SAXException(te); } } else if (name.equals("title")) { token = tokenizer.nextToken(); while (tokenizer.hasMoreTokens() && (token.equals(" " ) || token.equals("\t") || token.equals("="))) token = tokenizer.nextToken(); title = token.substring(1, token.length() - 1); } else if (name.equals("media")) { token = tokenizer.nextToken(); while (tokenizer.hasMoreTokens() && (token.equals(" " ) || token.equals("\t") || token.equals("="))) token = tokenizer.nextToken(); media = token.substring(1, token.length() - 1); } else if (name.equals("charset")) { token = tokenizer.nextToken(); while (tokenizer.hasMoreTokens() && (token.equals(" " ) || token.equals("\t") || token.equals("="))) token = tokenizer.nextToken(); charset = token.substring(1, token.length() - 1); } else if (name.equals("alternate")) { token = tokenizer.nextToken(); while (tokenizer.hasMoreTokens() && (token.equals(" " ) || token.equals("\t") || token.equals("="))) token = tokenizer.nextToken(); alternate = token.substring(1, token.length() - 1).equals("yes"); } } if ((null != type) && (type.equals("text/xsl") || type.equals("text/xml") || type.equals("application/xml+xslt")) && (null != href)) { if (null != m_media) { if (null != media) { if (!media.equals(m_media)) return; } else return; } if (null != m_charset) { if (null != charset) { if (!charset.equals(m_charset)) return; } else return; } if (null != m_title) { if (null != title) { if (!title.equals(m_title)) return; } else return; } m_stylesheets.addElement(source); } } } /** * The spec notes that "The xml-stylesheet processing instruction is allowed only in the prolog of an XML document.", * so, at least for right now, I'm going to go ahead an throw a TransformerException * in order to stop the parse. * * @param uri The Namespace URI, or an empty string. * @param localName The local name (without prefix), or empty string if not namespace processing. * @param rawName The qualified name (with prefix). * @param attributes The specified or defaulted attributes. * * @throws StopParseException since there can be no valid xml-stylesheet processing * instructions past the first element. */ public void startElement( String namespaceURI, String localName, String qName, Attributes atts) throws org.xml.sax.SAXException { throw new StopParseException(); } /** * Added additional getter and setter methods for the Base Id * to fix bugzilla bug 24187 * */ public void setBaseId(String baseId) { m_baseID = baseId; } public String getBaseId() { return m_baseID ; } }
/* * 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 * modification, 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 "Xalan" 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 (INCLUDING, 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 based on software copyright (c) 1999, Lotus * Development Corporation., http://www.lotus.com. For more * information on the Apache Software Foundation, please see * <http://www.apache.org/>. */ package org.apache.xml.utils; /** * This is a special exception that is used to stop parsing when * search for an element. For instance, when searching for xml:stylesheet * PIs, it is used to stop the parse once the document element is found. * @see StylesheetPIHandler * @xsl.usage internal */ public class StopParseException extends org.xml.sax.SAXException { /** * Constructor StopParseException. */ StopParseException() { super("Stylesheet PIs found, stop the parse"); } }
