/*

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

 */

package com.sun.org.apache.xerces.internal.dom;

import com.sun.org.apache.xerces.internal.impl.Constants;

import com.sun.org.apache.xerces.internal.impl.XMLEntityManager;

import com.sun.org.apache.xerces.internal.impl.XMLErrorReporter;

import com.sun.org.apache.xerces.internal.impl.dv.DTDDVFactory;

import com.sun.org.apache.xerces.internal.impl.msg.XMLMessageFormatter;

import com.sun.org.apache.xerces.internal.impl.validation.ValidationManager;

import com.sun.org.apache.xerces.internal.util.DOMEntityResolverWrapper;

import com.sun.org.apache.xerces.internal.util.DOMErrorHandlerWrapper;

import com.sun.org.apache.xerces.internal.util.MessageFormatter;

import com.sun.org.apache.xerces.internal.util.ParserConfigurationSettings;

import com.sun.org.apache.xerces.internal.util.PropertyState;

import com.sun.org.apache.xerces.internal.util.SymbolTable;

import com.sun.org.apache.xerces.internal.utils.ObjectFactory;

import com.sun.org.apache.xerces.internal.xni.XMLDTDContentModelHandler;

import com.sun.org.apache.xerces.internal.xni.XMLDTDHandler;

import com.sun.org.apache.xerces.internal.xni.XMLDocumentHandler;

import com.sun.org.apache.xerces.internal.xni.XNIException;

import com.sun.org.apache.xerces.internal.xni.grammars.XMLGrammarPool;

import com.sun.org.apache.xerces.internal.xni.parser.XMLComponent;

import com.sun.org.apache.xerces.internal.xni.parser.XMLComponentManager;

import com.sun.org.apache.xerces.internal.xni.parser.XMLConfigurationException;

import com.sun.org.apache.xerces.internal.xni.parser.XMLEntityResolver;

import com.sun.org.apache.xerces.internal.xni.parser.XMLErrorHandler;

import com.sun.org.apache.xerces.internal.xni.parser.XMLInputSource;

import com.sun.org.apache.xerces.internal.xni.parser.XMLParserConfiguration;

import java.io.IOException;

import java.util.ArrayList;

import java.util.HashMap;

import java.util.Locale;

import java.util.Vector;

import javax.xml.XMLConstants;

import org.w3c.dom.DOMConfiguration;

import org.w3c.dom.DOMErrorHandler;

import org.w3c.dom.DOMException;

import org.w3c.dom.DOMStringList;

import org.w3c.dom.ls.LSResourceResolver;

/**

 * Xerces implementation of DOMConfiguration that maintains a table of recognized parameters.

 *

 * @xerces.internal

 *

 * @author Elena Litani, IBM

 * @author Neeraj Bajaj, Sun Microsystems.

 * @version $Id: DOMConfigurationImpl.java,v 1.9 2010-11-01 04:39:37 joehw Exp $

 */

public class DOMConfigurationImpl extends ParserConfigurationSettings

    implements XMLParserConfiguration, DOMConfiguration {

    //

    // Constants

    //

    // feature identifiers

    /** Feature identifier: validation. */

    protected static final String XERCES_VALIDATION =

        Constants.SAX_FEATURE_PREFIX + Constants.VALIDATION_FEATURE;

    /** Feature identifier: namespaces. */

    protected static final String XERCES_NAMESPACES =

        Constants.SAX_FEATURE_PREFIX + Constants.NAMESPACES_FEATURE;

    protected static final String SCHEMA =

        Constants.XERCES_FEATURE_PREFIX + Constants.SCHEMA_VALIDATION_FEATURE;

    protected static final String SCHEMA_FULL_CHECKING =

        Constants.XERCES_FEATURE_PREFIX + Constants.SCHEMA_FULL_CHECKING;

    protected static final String DYNAMIC_VALIDATION =

        Constants.XERCES_FEATURE_PREFIX + Constants.DYNAMIC_VALIDATION_FEATURE;

    protected static final String NORMALIZE_DATA =

        Constants.XERCES_FEATURE_PREFIX + Constants.SCHEMA_NORMALIZED_VALUE;

    /** sending psvi in the pipeline */

    protected static final String SEND_PSVI =

        Constants.XERCES_FEATURE_PREFIX + Constants.SCHEMA_AUGMENT_PSVI;

    protected final static String DTD_VALIDATOR_FACTORY_PROPERTY =

        Constants.XERCES_PROPERTY_PREFIX + Constants.DATATYPE_VALIDATOR_FACTORY_PROPERTY;

    /** Feature identifier: namespace growth */

    protected static final String NAMESPACE_GROWTH =

        Constants.XERCES_FEATURE_PREFIX + Constants.NAMESPACE_GROWTH_FEATURE;

    protected static final String TOLERATE_DUPLICATES =

        Constants.XERCES_FEATURE_PREFIX + Constants.TOLERATE_DUPLICATES_FEATURE;

    // property identifiers

    /** Property identifier: entity manager. */

    protected static final String ENTITY_MANAGER =

        Constants.XERCES_PROPERTY_PREFIX + Constants.ENTITY_MANAGER_PROPERTY;

    /** Property identifier: error reporter. */

    protected static final String ERROR_REPORTER =

        Constants.XERCES_PROPERTY_PREFIX + Constants.ERROR_REPORTER_PROPERTY;

    /** Property identifier: xml string. */

    protected static final String XML_STRING =

        Constants.SAX_PROPERTY_PREFIX + Constants.XML_STRING_PROPERTY;

    /** Property identifier: symbol table. */

    protected static final String SYMBOL_TABLE =

        Constants.XERCES_PROPERTY_PREFIX + Constants.SYMBOL_TABLE_PROPERTY;

    /** Property id: Grammar pool*/

    protected static final String GRAMMAR_POOL =

    Constants.XERCES_PROPERTY_PREFIX + Constants.XMLGRAMMAR_POOL_PROPERTY;

    /** Property identifier: error handler. */

    protected static final String ERROR_HANDLER =

        Constants.XERCES_PROPERTY_PREFIX + Constants.ERROR_HANDLER_PROPERTY;

    /** Property identifier: entity resolver. */

    protected static final String ENTITY_RESOLVER =

        Constants.XERCES_PROPERTY_PREFIX + Constants.ENTITY_RESOLVER_PROPERTY;

    /** Property identifier: JAXP schema language / DOM schema-type. */

    protected static final String JAXP_SCHEMA_LANGUAGE =

    Constants.JAXP_PROPERTY_PREFIX + Constants.SCHEMA_LANGUAGE;

    /** Property identifier: JAXP schema source/ DOM schema-location. */

    protected static final String JAXP_SCHEMA_SOURCE =

    Constants.JAXP_PROPERTY_PREFIX + Constants.SCHEMA_SOURCE;

    protected static final String VALIDATION_MANAGER =

        Constants.XERCES_PROPERTY_PREFIX + Constants.VALIDATION_MANAGER_PROPERTY;

    /** Property identifier: Schema DV Factory */

    protected static final String SCHEMA_DV_FACTORY =

        Constants.XERCES_PROPERTY_PREFIX + Constants.SCHEMA_DV_FACTORY_PROPERTY;

    //

    // Data

    //

    XMLDocumentHandler fDocumentHandler;

    /** Normalization features*/

    protected short features = 0;

    protected final static short NAMESPACES          = 0x1<<0;

    protected final static short DTNORMALIZATION     = 0x1<<1;

    protected final static short ENTITIES            = 0x1<<2;

    protected final static short CDATA               = 0x1<<3;

    protected final static short SPLITCDATA          = 0x1<<4;

    protected final static short COMMENTS            = 0x1<<5;

    protected final static short VALIDATE            = 0x1<<6;

    protected final static short PSVI                = 0x1<<7;

    protected final static short WELLFORMED          = 0x1<<8;

    protected final static short NSDECL              = 0x1<<9;

    protected final static short INFOSET_TRUE_PARAMS = NAMESPACES | COMMENTS | WELLFORMED | NSDECL;

    protected final static short INFOSET_FALSE_PARAMS = ENTITIES | DTNORMALIZATION | CDATA;

    protected final static short INFOSET_MASK = INFOSET_TRUE_PARAMS | INFOSET_FALSE_PARAMS;

    // components

    /** Symbol table. */

    protected SymbolTable fSymbolTable;

    /** Components. */

    protected ArrayList fComponents;

    protected ValidationManager fValidationManager;

    /** Locale. */

    protected Locale fLocale;

    /** Error reporter */

    protected XMLErrorReporter fErrorReporter;

    protected final DOMErrorHandlerWrapper fErrorHandlerWrapper =

                new DOMErrorHandlerWrapper();

    // private data

    private DOMStringList fRecognizedParameters;

    //

    // Constructors

    //

    /** Default Constructor. */

    protected DOMConfigurationImpl() {

        this(null, null);

    } // <init>()

    /**

     * Constructs a parser configuration using the specified symbol table.

     *

     * @param symbolTable The symbol table to use.

     */

    protected DOMConfigurationImpl(SymbolTable symbolTable) {

        this(symbolTable, null);

    } // <init>(SymbolTable)

    /**

     * Constructs a parser configuration using the specified symbol table

     * and parent settings.

     *

     * @param symbolTable    The symbol table to use.

     * @param parentSettings The parent settings.

     */

    protected DOMConfigurationImpl(SymbolTable symbolTable,

                                    XMLComponentManager parentSettings) {

        super(parentSettings);

        // create table for features and properties

        fFeatures = new HashMap();

        fProperties = new HashMap();

        // add default recognized features

        final String[] recognizedFeatures = {

            XERCES_VALIDATION,

            XERCES_NAMESPACES,

            SCHEMA,

            SCHEMA_FULL_CHECKING,

            DYNAMIC_VALIDATION,

            NORMALIZE_DATA,

            SEND_PSVI,

            NAMESPACE_GROWTH,

            TOLERATE_DUPLICATES

        };

        addRecognizedFeatures(recognizedFeatures);

        // set state for default features

        setFeature(XERCES_VALIDATION, false);

        setFeature(SCHEMA, false);

        setFeature(SCHEMA_FULL_CHECKING, false);

        setFeature(DYNAMIC_VALIDATION, false);

        setFeature(NORMALIZE_DATA, false);

        setFeature(XERCES_NAMESPACES, true);

        setFeature(SEND_PSVI, true);

        setFeature(NAMESPACE_GROWTH, false);

        // add default recognized properties

        final String[] recognizedProperties = {

            XML_STRING,

            SYMBOL_TABLE,

            ERROR_HANDLER,

            ENTITY_RESOLVER,

            ERROR_REPORTER,

            ENTITY_MANAGER,

            VALIDATION_MANAGER,

            GRAMMAR_POOL,

            JAXP_SCHEMA_SOURCE,

            JAXP_SCHEMA_LANGUAGE,

            DTD_VALIDATOR_FACTORY_PROPERTY,

            SCHEMA_DV_FACTORY,

        };

        addRecognizedProperties(recognizedProperties);

        // set default values for normalization features

        features |= NAMESPACES;

        features |= ENTITIES;

        features |= COMMENTS;

        features |= CDATA;

        features |= SPLITCDATA;

        features |= WELLFORMED;

        features |= NSDECL;

        if (symbolTable == null) {

            symbolTable = new SymbolTable();

        }

        fSymbolTable = symbolTable;

        fComponents = new ArrayList();

        setProperty(SYMBOL_TABLE, fSymbolTable);

        fErrorReporter = new XMLErrorReporter();

        setProperty(ERROR_REPORTER, fErrorReporter);

        addComponent(fErrorReporter);

        setProperty(DTD_VALIDATOR_FACTORY_PROPERTY, DTDDVFactory.getInstance());

        XMLEntityManager manager =  new XMLEntityManager();

        setProperty(ENTITY_MANAGER, manager);

        addComponent(manager);

        fValidationManager = createValidationManager();

        setProperty(VALIDATION_MANAGER, fValidationManager);

        // add message formatters

        if (fErrorReporter.getMessageFormatter(XMLMessageFormatter.XML_DOMAIN) == null) {

            XMLMessageFormatter xmft = new XMLMessageFormatter();

            fErrorReporter.putMessageFormatter(XMLMessageFormatter.XML_DOMAIN, xmft);

            fErrorReporter.putMessageFormatter(XMLMessageFormatter.XMLNS_DOMAIN, xmft);

        }

        // REVISIT: try to include XML Schema formatter.

        //          This is a hack to allow DTD configuration to be build.

        //

        if (fErrorReporter.getMessageFormatter("http://www.w3.org/TR/xml-schema-1") == null) {

            MessageFormatter xmft = null;

            try {

               xmft = (MessageFormatter)(

                    ObjectFactory.newInstance("com.sun.org.apache.xerces.internal.impl.xs.XSMessageFormatter", true));

            } catch (Exception exception){

            }

             if (xmft !=  null) {

                 fErrorReporter.putMessageFormatter("http://www.w3.org/TR/xml-schema-1", xmft);

             }

        }

        // set locale

        try {

            setLocale(Locale.getDefault());

        }

        catch (XNIException e) {

            // do nothing

            // REVISIT: What is the right thing to do? -Ac

        }

    } // <init>(SymbolTable)

    //

    // XMLParserConfiguration methods

    //

    /**

     * Parse an XML document.

     * <p>

     * The parser can use this method to instruct this configuration

     * to begin parsing an XML document from any valid input source

     * (a character stream, a byte stream, or a URI).

     * <p>

     * Parsers may not invoke this method while a parse is in progress.

     * Once a parse is complete, the parser may then parse another XML

     * document.

     * <p>

     * This method is synchronous: it will not return until parsing

     * has ended.  If a client application wants to terminate

     * parsing early, it should throw an exception.

     *

     * @param source The input source for the top-level of the

     *               XML document.

     *

     * @exception XNIException Any XNI exception, possibly wrapping

     *                         another exception.

     * @exception IOException  An IO exception from the parser, possibly

     *                         from a byte stream or character stream

     *                         supplied by the parser.

     */

    public void parse(XMLInputSource inputSource)

        throws XNIException, IOException{

        // no-op

    }

    /**

     * Sets the document handler on the last component in the pipeline

     * to receive information about the document.

     *

     * @param documentHandler   The document handler.

     */

    public void setDocumentHandler(XMLDocumentHandler documentHandler) {

        fDocumentHandler = documentHandler;

    } // setDocumentHandler(XMLDocumentHandler)

    /** Returns the registered document handler. */

    public XMLDocumentHandler getDocumentHandler() {

        return fDocumentHandler;

    } // getDocumentHandler():XMLDocumentHandler

    /**

     * Sets the DTD handler.

     *

     * @param dtdHandler The DTD handler.

     */

    public void setDTDHandler(XMLDTDHandler dtdHandler) {

        //no-op

    } // setDTDHandler(XMLDTDHandler)

    /** Returns the registered DTD handler. */

    public XMLDTDHandler getDTDHandler() {

        return null;

    } // getDTDHandler():XMLDTDHandler

    /**

     * Sets the DTD content model handler.

     *

     * @param handler The DTD content model handler.

     */

    public void setDTDContentModelHandler(XMLDTDContentModelHandler handler) {

        //no-op

    } // setDTDContentModelHandler(XMLDTDContentModelHandler)

    /** Returns the registered DTD content model handler. */

    public XMLDTDContentModelHandler getDTDContentModelHandler() {

        return null;

    } // getDTDContentModelHandler():XMLDTDContentModelHandler

    /**

     * Sets the resolver used to resolve external entities. The EntityResolver

     * interface supports resolution of public and system identifiers.

     *

     * @param resolver The new entity resolver. Passing a null value will

     *                 uninstall the currently installed resolver.

     */

    public void setEntityResolver(XMLEntityResolver resolver) {

        if (resolver !=null) {

            fProperties.put(ENTITY_RESOLVER, resolver);

        }

    } // setEntityResolver(XMLEntityResolver)

    /**

     * Return the current entity resolver.

     *

     * @return The current entity resolver, or null if none

     *         has been registered.

     * @see #setEntityResolver

     */

    public XMLEntityResolver getEntityResolver() {

        return (XMLEntityResolver)fProperties.get(ENTITY_RESOLVER);

    } // getEntityResolver():XMLEntityResolver

    /**

     * Allow an application to register an error event handler.

     *

     * <p>If the application does not register an error handler, all

     * error events reported by the SAX parser will be silently

     * ignored; however, normal processing may not continue.  It is

     * highly recommended that all SAX applications implement an

     * error handler to avoid unexpected bugs.</p>

     *

     * <p>Applications may register a new or different handler in the

     * middle of a parse, and the SAX parser must begin using the new

     * handler immediately.</p>

     *

     * @param errorHandler The error handler.

     * @exception java.lang.NullPointerException If the handler

     *            argument is null.

     * @see #getErrorHandler

     */

    public void setErrorHandler(XMLErrorHandler errorHandler) {

        if (errorHandler != null) {

            fProperties.put(ERROR_HANDLER, errorHandler);

        }

    } // setErrorHandler(XMLErrorHandler)

    /**

     * Return the current error handler.

     *

     * @return The current error handler, or null if none

     *         has been registered.

     * @see #setErrorHandler

     */

    public XMLErrorHandler getErrorHandler() {

        return (XMLErrorHandler)fProperties.get(ERROR_HANDLER);

    } // getErrorHandler():XMLErrorHandler

    /**

     * Set the state of a feature.

     *

     * Set the state of any feature in a SAX2 parser.  The parser

     * might not recognize the feature, and if it does recognize

     * it, it might not be able to fulfill the request.

     *

     * @param featureId The unique identifier (URI) of the feature.

     * @param state The requested state of the feature (true or false).

     *

     * @exception com.sun.org.apache.xerces.internal.xni.parser.XMLConfigurationException If the

     *            requested feature is not known.

     */

    public void setFeature(String featureId, boolean state)

        throws XMLConfigurationException {

        // save state if noone "objects"

        super.setFeature(featureId, state);

    } // setFeature(String,boolean)

    /**

     * setProperty

     *

     * @param propertyId

     * @param value

     */

    public void setProperty(String propertyId, Object value)

        throws XMLConfigurationException {

        // store value if noone "objects"

        super.setProperty(propertyId, value);

    } // setProperty(String,Object)