/*

 * reserved comment block

 * DO NOT REMOVE OR ALTER!

 */

/*

 * Copyright 2001-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.

 */

/*

 * $Id: TransformerFactoryImpl.java,v 1.2.4.1 2005/09/15 06:15:38 pvedula Exp $

 */

package com.sun.org.apache.xalan.internal.xsltc.trax;

import java.io.File;

import java.io.FileInputStream;

import java.io.FileNotFoundException;

import java.io.FilenameFilter;

import java.io.IOException;

import java.io.InputStream;

import java.net.MalformedURLException;

import java.net.URL;

import java.util.Enumeration;

import java.util.Hashtable;

import java.util.Properties;

import java.util.Vector;

import java.util.zip.ZipEntry;

import java.util.zip.ZipFile;

import javax.xml.XMLConstants;

import javax.xml.parsers.SAXParserFactory;

import javax.xml.parsers.SAXParser;

import javax.xml.parsers.ParserConfigurationException;

import javax.xml.transform.ErrorListener;

import javax.xml.transform.Source;

import javax.xml.transform.Templates;

import javax.xml.transform.Transformer;

import javax.xml.transform.TransformerConfigurationException;

import javax.xml.transform.TransformerException;

import javax.xml.transform.URIResolver;

import javax.xml.transform.dom.DOMResult;

import javax.xml.transform.dom.DOMSource;

import javax.xml.transform.sax.SAXResult;

import javax.xml.transform.sax.SAXSource;

import javax.xml.transform.sax.SAXTransformerFactory;

import javax.xml.transform.sax.TemplatesHandler;

import javax.xml.transform.sax.TransformerHandler;

import javax.xml.transform.stream.StreamResult;

import javax.xml.transform.stream.StreamSource;

import com.sun.org.apache.xml.internal.utils.StylesheetPIHandler;

import com.sun.org.apache.xml.internal.utils.StopParseException;

import com.sun.org.apache.xalan.internal.xsltc.compiler.Constants;

import com.sun.org.apache.xalan.internal.xsltc.compiler.SourceLoader;

import com.sun.org.apache.xalan.internal.xsltc.compiler.XSLTC;

import com.sun.org.apache.xalan.internal.xsltc.compiler.util.ErrorMsg;

import com.sun.org.apache.xalan.internal.xsltc.dom.XSLTCDTMManager;

import org.xml.sax.InputSource;

import org.xml.sax.XMLFilter;

import org.xml.sax.XMLReader;

import org.xml.sax.helpers.XMLReaderFactory;

/**

 * Implementation of a JAXP1.1 TransformerFactory for Translets.

 * @author G. Todd Miller

 * @author Morten Jorgensen

 * @author Santiago Pericas-Geertsen

 */

public class TransformerFactoryImpl

    extends SAXTransformerFactory implements SourceLoader, ErrorListener

{

    // Public constants for attributes supported by the XSLTC TransformerFactory.

    public final static String TRANSLET_NAME = "translet-name";

    public final static String DESTINATION_DIRECTORY = "destination-directory";

    public final static String PACKAGE_NAME = "package-name";

    public final static String JAR_NAME = "jar-name";

    public final static String GENERATE_TRANSLET = "generate-translet";

    public final static String AUTO_TRANSLET = "auto-translet";

    public final static String USE_CLASSPATH = "use-classpath";

    public final static String DEBUG = "debug";

    public final static String ENABLE_INLINING = "enable-inlining";

    public final static String INDENT_NUMBER = "indent-number";

    /**

     * This error listener is used only for this factory and is not passed to

     * the Templates or Transformer objects that we create.

     */

    private ErrorListener _errorListener = this;

    /**

     * This URIResolver is passed to all created Templates and Transformers

     */

    private URIResolver _uriResolver = null;

    /**

     * As Gregor Samsa awoke one morning from uneasy dreams he found himself

     * transformed in his bed into a gigantic insect. He was lying on his hard,

     * as it were armour plated, back, and if he lifted his head a little he

     * could see his big, brown belly divided into stiff, arched segments, on

     * top of which the bed quilt could hardly keep in position and was about

     * to slide off completely. His numerous legs, which were pitifully thin

     * compared to the rest of his bulk, waved helplessly before his eyes.

     * "What has happened to me?", he thought. It was no dream....

     */

    protected final static String DEFAULT_TRANSLET_NAME = "GregorSamsa";

    /**

     * The class name of the translet

     */

    private String _transletName = DEFAULT_TRANSLET_NAME;

    /**

     * The destination directory for the translet

     */

    private String _destinationDirectory = null;

    /**

     * The package name prefix for all generated translet classes

     */

    private String _packageName = null;

    /**

     * The jar file name which the translet classes are packaged into

     */

    private String _jarFileName = null;

    /**

     * This Hashtable is used to store parameters for locating

     * <?xml-stylesheet ...?> processing instructions in XML docs.

     */

    private Hashtable _piParams = null;

    /**

     * The above hashtable stores objects of this class.

     */

    private static class PIParamWrapper {

        public String _media = null;

        public String _title = null;

        public String _charset = null;

        public PIParamWrapper(String media, String title, String charset) {

            _media = media;

            _title = title;

            _charset = charset;

        }

    }

    /**

     * Set to <code>true</code> when debugging is enabled.

     */

    private boolean _debug = false;

    /**

     * Set to <code>true</code> when templates are inlined.

     */

    private boolean _enableInlining = false;

    /**

     * Set to <code>true</code> when we want to generate

     * translet classes from the stylesheet.

     */

    private boolean _generateTranslet = false;

    /**

     * If this is set to <code>true</code>, we attempt to use translet classes

     * for transformation if possible without compiling the stylesheet. The

     * translet class is only used if its timestamp is newer than the timestamp

     * of the stylesheet.

     */

    private boolean _autoTranslet = false;

    /**

     * If this is set to <code>true</code>, we attempt to load the translet

     * from the CLASSPATH.

     */

    private boolean _useClasspath = false;

    /**

     * Number of indent spaces when indentation is turned on.

     */

    private int _indentNumber = -1;

    /**

     * The provider of the XSLTC DTM Manager service.  This is fixed for any

     * instance of this class.  In order to change service providers, a new

     * XSLTC <code>TransformerFactory</code> must be instantiated.

     * @see XSLTCDTMManager#getDTMManagerClass()

     */

    private Class m_DTMManagerClass;

    /**

     * <p>State of secure processing feature.</p>

     */

    private boolean _isSecureProcessing = false;

    /**

     * javax.xml.transform.sax.TransformerFactory implementation.

     */

    public TransformerFactoryImpl() {

        m_DTMManagerClass = XSLTCDTMManager.getDTMManagerClass();

    }

    /**

     * javax.xml.transform.sax.TransformerFactory implementation.

     * Set the error event listener for the TransformerFactory, which is used

     * for the processing of transformation instructions, and not for the

     * transformation itself.

     *

     * @param listener The error listener to use with the TransformerFactory

     * @throws IllegalArgumentException

     */

    public void setErrorListener(ErrorListener listener)

        throws IllegalArgumentException

    {

        if (listener == null) {

            ErrorMsg err = new ErrorMsg(ErrorMsg.ERROR_LISTENER_NULL_ERR,

                                        "TransformerFactory");

            throw new IllegalArgumentException(err.toString());

        }

        _errorListener = listener;

    }

    /**

     * javax.xml.transform.sax.TransformerFactory implementation.

     * Get the error event handler for the TransformerFactory.

     *

     * @return The error listener used with the TransformerFactory

     */

    public ErrorListener getErrorListener() {

        return _errorListener;

    }

    /**

     * javax.xml.transform.sax.TransformerFactory implementation.

     * Returns the value set for a TransformerFactory attribute

     *

     * @param name The attribute name

     * @return An object representing the attribute value

     * @throws IllegalArgumentException

     */

    public Object getAttribute(String name)

        throws IllegalArgumentException

    {

        // Return value for attribute 'translet-name'

        if (name.equals(TRANSLET_NAME)) {

            return _transletName;

        }

        else if (name.equals(GENERATE_TRANSLET)) {

            return new Boolean(_generateTranslet);

        }

        else if (name.equals(AUTO_TRANSLET)) {

            return new Boolean(_autoTranslet);

        }

        // Throw an exception for all other attributes

        ErrorMsg err = new ErrorMsg(ErrorMsg.JAXP_INVALID_ATTR_ERR, name);

        throw new IllegalArgumentException(err.toString());

    }

    /**

     * javax.xml.transform.sax.TransformerFactory implementation.

     * Sets the value for a TransformerFactory attribute.

     *

     * @param name The attribute name

     * @param value An object representing the attribute value

     * @throws IllegalArgumentException

     */

    public void setAttribute(String name, Object value)

        throws IllegalArgumentException

    {

        // Set the default translet name (ie. class name), which will be used

        // for translets that cannot be given a name from their system-id.

        if (name.equals(TRANSLET_NAME) && value instanceof String) {

            _transletName = (String) value;

            return;

        }

        else if (name.equals(DESTINATION_DIRECTORY) && value instanceof String) {

            _destinationDirectory = (String) value;

            return;

        }

        else if (name.equals(PACKAGE_NAME) && value instanceof String) {

            _packageName = (String) value;

            return;

        }

        else if (name.equals(JAR_NAME) && value instanceof String) {

            _jarFileName = (String) value;

            return;

        }

        else if (name.equals(GENERATE_TRANSLET)) {

            if (value instanceof Boolean) {

                _generateTranslet = ((Boolean) value).booleanValue();

                return;

            }

            else if (value instanceof String) {

                _generateTranslet = ((String) value).equalsIgnoreCase("true");

                return;

            }

        }

        else if (name.equals(AUTO_TRANSLET)) {

            if (value instanceof Boolean) {

                _autoTranslet = ((Boolean) value).booleanValue();

                return;

            }

            else if (value instanceof String) {

                _autoTranslet = ((String) value).equalsIgnoreCase("true");

                return;

            }

        }

        else if (name.equals(USE_CLASSPATH)) {

            if (value instanceof Boolean) {

                _useClasspath = ((Boolean) value).booleanValue();

                return;

            }

            else if (value instanceof String) {

                _useClasspath = ((String) value).equalsIgnoreCase("true");

                return;

            }

        }

        else if (name.equals(DEBUG)) {

            if (value instanceof Boolean) {

                _debug = ((Boolean) value).booleanValue();

                return;

            }

            else if (value instanceof String) {

                _debug = ((String) value).equalsIgnoreCase("true");

                return;

            }

        }

        else if (name.equals(ENABLE_INLINING)) {

            if (value instanceof Boolean) {

                _enableInlining = ((Boolean) value).booleanValue();

                return;

            }

            else if (value instanceof String) {

                _enableInlining = ((String) value).equalsIgnoreCase("true");

                return;

            }

        }

        else if (name.equals(INDENT_NUMBER)) {

            if (value instanceof String) {

                try {

                    _indentNumber = Integer.parseInt((String) value);

                    return;

                }

                catch (NumberFormatException e) {

                    // Falls through

                }

            }

            else if (value instanceof Integer) {

                _indentNumber = ((Integer) value).intValue();

                return;

            }

        }

        // Throw an exception for all other attributes

        final ErrorMsg err

            = new ErrorMsg(ErrorMsg.JAXP_INVALID_ATTR_ERR, name);

        throw new IllegalArgumentException(err.toString());

    }

    /**

     * <p>Set a feature for this <code>TransformerFactory</code> and <code>Transformer</code>s

     * or <code>Template</code>s created by this factory.</p>

     *

     * <p>

     * Feature names are fully qualified {@link java.net.URI}s.

     * Implementations may define their own features.

     * An {@link TransformerConfigurationException} is thrown if this <code>TransformerFactory</code> or the

     * <code>Transformer</code>s or <code>Template</code>s it creates cannot support the feature.

     * It is possible for an <code>TransformerFactory</code> to expose a feature value but be unable to change its state.

     * </p>

     *

     * <p>See {@link javax.xml.transform.TransformerFactory} for full documentation of specific features.</p>

     *

     * @param name Feature name.

     * @param value Is feature state <code>true</code> or <code>false</code>.

     *

     * @throws TransformerConfigurationException if this <code>TransformerFactory</code>

     *   or the <code>Transformer</code>s or <code>Template</code>s it creates cannot support this feature.

     * @throws NullPointerException If the <code>name</code> parameter is null.

     */

    public void setFeature(String name, boolean value)

        throws TransformerConfigurationException {

        // feature name cannot be null

        if (name == null) {

            ErrorMsg err = new ErrorMsg(ErrorMsg.JAXP_SET_FEATURE_NULL_NAME);

            throw new NullPointerException(err.toString());

        }

        // secure processing?

        else if (name.equals(XMLConstants.FEATURE_SECURE_PROCESSING)) {

            _isSecureProcessing = value;

            // all done processing feature

            return;

        }

        else {

            // unknown feature

            ErrorMsg err = new ErrorMsg(ErrorMsg.JAXP_UNSUPPORTED_FEATURE, name);

            throw new TransformerConfigurationException(err.toString());

        }

    }

    /**

     * javax.xml.transform.sax.TransformerFactory implementation.

     * Look up the value of a feature (to see if it is supported).

     * This method must be updated as the various methods and features of this

     * class are implemented.

     *

     * @param name The feature name

     * @return 'true' if feature is supported, 'false' if not

     */

    public boolean getFeature(String name) {

        // All supported features should be listed here

        String[] features = {

            DOMSource.FEATURE,

            DOMResult.FEATURE,

            SAXSource.FEATURE,

            SAXResult.FEATURE,

            StreamSource.FEATURE,

            StreamResult.FEATURE,

            SAXTransformerFactory.FEATURE,

            SAXTransformerFactory.FEATURE_XMLFILTER

        };

        // feature name cannot be null

        if (name == null) {

            ErrorMsg err = new ErrorMsg(ErrorMsg.JAXP_GET_FEATURE_NULL_NAME);

            throw new NullPointerException(err.toString());

        }

        // Inefficient, but array is small

        for (int i =0; i < features.length; i++) {

            if (name.equals(features[i])) {

                return true;

            }

        }

        // secure processing?

        if (name.equals(XMLConstants.FEATURE_SECURE_PROCESSING)) {

                return _isSecureProcessing;

        }

        // Feature not supported

        return false;

    }

    /**

     * javax.xml.transform.sax.TransformerFactory implementation.

     * Get the object that is used by default during the transformation to

     * resolve URIs used in document(), xsl:import, or xsl:include.

     *

     * @return The URLResolver used for this TransformerFactory and all

     * Templates and Transformer objects created using this factory

     */

    public URIResolver getURIResolver() {

        return _uriResolver;

    }

    /**

     * javax.xml.transform.sax.TransformerFactory implementation.

     * Set the object that is used by default during the transformation to

     * resolve URIs used in document(), xsl:import, or xsl:include. Note that

     * this does not affect Templates and Transformers that are already

     * created with this factory.

     *

     * @param resolver The URLResolver used for this TransformerFactory and all

     * Templates and Transformer objects created using this factory

     */

    public void setURIResolver(URIResolver resolver) {

        _uriResolver = resolver;

    }

    /**

     * javax.xml.transform.sax.TransformerFactory implementation.

     * Get the stylesheet specification(s) associated via the xml-stylesheet

     * processing instruction (see http://www.w3.org/TR/xml-stylesheet/) with

     * the document document specified in the source parameter, and that match

     * the given criteria.

     *

     * @param source The XML source document.

     * @param media The media attribute to be matched. May be null, in which

     * case the prefered templates will be used (i.e. alternate = no).

     * @param title The value of the title attribute to match. May be null.

     * @param charset The value of the charset attribute to match. May be null.

     * @return A Source object suitable for passing to the TransformerFactory.

     * @throws TransformerConfigurationException

     */

    public Source  getAssociatedStylesheet(Source source, String media,

                                          String title, String charset)

        throws TransformerConfigurationException {

        String baseId;

        XMLReader reader = null;

        InputSource isource = null;

        /**

         * Fix for bugzilla bug 24187

         */

        StylesheetPIHandler _stylesheetPIHandler = new StylesheetPIHandler(null,media,title,charset);

        try {

            if (source instanceof DOMSource ) {

                final DOMSource domsrc = (DOMSource) source;

                baseId = domsrc.getSystemId();

                final org.w3c.dom.Node node = domsrc.getNode();

                final DOM2SAX dom2sax = new DOM2SAX(node);

                _stylesheetPIHandler.setBaseId(baseId);

                dom2sax.setContentHandler( _stylesheetPIHandler);

                dom2sax.parse();

            } else {

                isource = SAXSource.sourceToInputSource(source);