/*

 * Copyright (c) 2008, 2017, Oracle and/or its affiliates. All rights reserved.

 */

/*

 * Licensed to the Apache Software Foundation (ASF) under one or more

 * contributor license agreements.  See the NOTICE file distributed with

 * this work for additional information regarding copyright ownership.

 * The ASF licenses this file to You 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.parsers;

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

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

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

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

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

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

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

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.XMLNSDocumentScannerImpl;

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

import com.sun.org.apache.xerces.internal.impl.dtd.XML11DTDProcessor;

import com.sun.org.apache.xerces.internal.impl.dtd.XML11DTDValidator;

import com.sun.org.apache.xerces.internal.impl.dtd.XML11NSDTDValidator;

import com.sun.org.apache.xerces.internal.impl.dtd.XMLDTDProcessor;

import com.sun.org.apache.xerces.internal.impl.dtd.XMLDTDValidator;

import com.sun.org.apache.xerces.internal.impl.dtd.XMLNSDTDValidator;

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.impl.xs.XMLSchemaValidator;

import com.sun.org.apache.xerces.internal.impl.xs.XSMessageFormatter;

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

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.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.XMLLocator;

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.XMLDTDScanner;

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

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

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.XMLPullParserConfiguration;

import java.io.IOException;

import java.util.ArrayList;

import java.util.Locale;

import javax.xml.XMLConstants;

import javax.xml.catalog.CatalogFeatures;

import jdk.xml.internal.JdkXmlUtils;

/**

 * This class is the configuration used to parse XML 1.0 and XML 1.1 documents.

 *

 * @author Elena Litani, IBM

 * @author Neil Graham, IBM

 * @author Michael Glavassevich, IBM

 *

 */

public class XML11Configuration extends ParserConfigurationSettings

    implements XMLPullParserConfiguration, XML11Configurable {

    //

    // Constants

    //

    protected final static String XML11_DATATYPE_VALIDATOR_FACTORY =

        "com.sun.org.apache.xerces.internal.impl.dv.dtd.XML11DTDDVFactoryImpl";

    // feature identifiers

    /** Feature identifier: warn on duplicate attribute definition. */

    protected static final String WARN_ON_DUPLICATE_ATTDEF =

        Constants.XERCES_FEATURE_PREFIX + Constants.WARN_ON_DUPLICATE_ATTDEF_FEATURE;

    /** Feature identifier: warn on duplicate entity definition. */

    protected static final String WARN_ON_DUPLICATE_ENTITYDEF =

        Constants.XERCES_FEATURE_PREFIX + Constants.WARN_ON_DUPLICATE_ENTITYDEF_FEATURE;

    /** Feature identifier: warn on undeclared element definition. */

    protected static final String WARN_ON_UNDECLARED_ELEMDEF =

        Constants.XERCES_FEATURE_PREFIX + Constants.WARN_ON_UNDECLARED_ELEMDEF_FEATURE;

    /** Feature identifier: allow Java encodings. */

    protected static final String ALLOW_JAVA_ENCODINGS =

        Constants.XERCES_FEATURE_PREFIX + Constants.ALLOW_JAVA_ENCODINGS_FEATURE;

    /** Feature identifier: continue after fatal error. */

    protected static final String CONTINUE_AFTER_FATAL_ERROR =

        Constants.XERCES_FEATURE_PREFIX + Constants.CONTINUE_AFTER_FATAL_ERROR_FEATURE;

    /** Feature identifier: load external DTD. */

    protected static final String LOAD_EXTERNAL_DTD =

        Constants.XERCES_FEATURE_PREFIX + Constants.LOAD_EXTERNAL_DTD_FEATURE;

    /** Feature identifier: notify built-in refereces. */

    protected static final String NOTIFY_BUILTIN_REFS =

        Constants.XERCES_FEATURE_PREFIX + Constants.NOTIFY_BUILTIN_REFS_FEATURE;

    /** Feature identifier: notify character refereces. */

    protected static final String NOTIFY_CHAR_REFS =

        Constants.XERCES_FEATURE_PREFIX + Constants.NOTIFY_CHAR_REFS_FEATURE;

    /** Feature identifier: expose schema normalized value */

    protected static final String NORMALIZE_DATA =

        Constants.XERCES_FEATURE_PREFIX + Constants.SCHEMA_NORMALIZED_VALUE;

    /** Feature identifier: send element default value via characters() */

    protected static final String SCHEMA_ELEMENT_DEFAULT =

        Constants.XERCES_FEATURE_PREFIX + Constants.SCHEMA_ELEMENT_DEFAULT;

    /** Feature identifier: augment PSVI */

    protected static final String SCHEMA_AUGMENT_PSVI =

        Constants.XERCES_FEATURE_PREFIX + Constants.SCHEMA_AUGMENT_PSVI;

    /** feature identifier: XML Schema validation */

    protected static final String XMLSCHEMA_VALIDATION =

        Constants.XERCES_FEATURE_PREFIX + Constants.SCHEMA_VALIDATION_FEATURE;

    /** feature identifier: XML Schema validation -- full checking */

    protected static final String XMLSCHEMA_FULL_CHECKING =

        Constants.XERCES_FEATURE_PREFIX + Constants.SCHEMA_FULL_CHECKING;

    /** Feature: generate synthetic annotations */

    protected static final String GENERATE_SYNTHETIC_ANNOTATIONS =

        Constants.XERCES_FEATURE_PREFIX + Constants.GENERATE_SYNTHETIC_ANNOTATIONS_FEATURE;

    /** Feature identifier: validate annotations */

    protected static final String VALIDATE_ANNOTATIONS =

        Constants.XERCES_FEATURE_PREFIX + Constants.VALIDATE_ANNOTATIONS_FEATURE;

    /** Feature identifier: honour all schemaLocations */

    protected static final String HONOUR_ALL_SCHEMALOCATIONS =

        Constants.XERCES_FEATURE_PREFIX + Constants.HONOUR_ALL_SCHEMALOCATIONS_FEATURE;

    /** Feature identifier: namespace growth */

    protected static final String NAMESPACE_GROWTH =

        Constants.XERCES_FEATURE_PREFIX + Constants.NAMESPACE_GROWTH_FEATURE;

    /** Feature identifier: tolerate duplicates */

    protected static final String TOLERATE_DUPLICATES =

        Constants.XERCES_FEATURE_PREFIX + Constants.TOLERATE_DUPLICATES_FEATURE;

    /** Feature identifier: use grammar pool only */

    protected static final String USE_GRAMMAR_POOL_ONLY =

        Constants.XERCES_FEATURE_PREFIX + Constants.USE_GRAMMAR_POOL_ONLY_FEATURE;

    // feature identifiers

    /** Feature identifier: validation. */

    protected static final String VALIDATION =

        Constants.SAX_FEATURE_PREFIX + Constants.VALIDATION_FEATURE;

    /** Feature identifier: namespaces. */

    protected static final String NAMESPACES =

        Constants.SAX_FEATURE_PREFIX + Constants.NAMESPACES_FEATURE;

    /** Feature identifier: external general entities. */

    protected static final String EXTERNAL_GENERAL_ENTITIES =

        Constants.SAX_FEATURE_PREFIX + Constants.EXTERNAL_GENERAL_ENTITIES_FEATURE;

    /** Feature identifier: external parameter entities. */

    protected static final String EXTERNAL_PARAMETER_ENTITIES =

        Constants.SAX_FEATURE_PREFIX + Constants.EXTERNAL_PARAMETER_ENTITIES_FEATURE;

    /** Feature identifier: whether to ignore xsi:type attributes until a global element declaration is encountered */

    protected static final String IGNORE_XSI_TYPE =

        Constants.XERCES_FEATURE_PREFIX + Constants.IGNORE_XSI_TYPE_FEATURE;

    /** Feature identifier: whether to ignore ID/IDREF errors */

    protected static final String ID_IDREF_CHECKING =

        Constants.XERCES_FEATURE_PREFIX + Constants.ID_IDREF_CHECKING_FEATURE;

    /** Feature identifier: whether to ignore unparsed entity errors */

    protected static final String UNPARSED_ENTITY_CHECKING =

        Constants.XERCES_FEATURE_PREFIX + Constants.UNPARSED_ENTITY_CHECKING_FEATURE;

    /** Feature identifier: whether to ignore identity constraint errors */

    protected static final String IDENTITY_CONSTRAINT_CHECKING =

        Constants.XERCES_FEATURE_PREFIX + Constants.IDC_CHECKING_FEATURE;

    // property identifiers

    /** 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 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: XML Schema validator. */

    protected static final String SCHEMA_VALIDATOR =

        Constants.XERCES_PROPERTY_PREFIX + Constants.SCHEMA_VALIDATOR_PROPERTY;

    /** Property identifier: schema location. */

    protected static final String SCHEMA_LOCATION =

        Constants.XERCES_PROPERTY_PREFIX + Constants.SCHEMA_LOCATION;

    /** Property identifier: no namespace schema location. */

    protected static final String SCHEMA_NONS_LOCATION =

        Constants.XERCES_PROPERTY_PREFIX + Constants.SCHEMA_NONS_LOCATION;

    /** Property identifier: error reporter. */

    protected static final String ERROR_REPORTER =

        Constants.XERCES_PROPERTY_PREFIX + Constants.ERROR_REPORTER_PROPERTY;

    /** Property identifier: entity manager. */

    protected static final String ENTITY_MANAGER =

        Constants.XERCES_PROPERTY_PREFIX + Constants.ENTITY_MANAGER_PROPERTY;

    /** Property identifier document scanner: */

    protected static final String DOCUMENT_SCANNER =

        Constants.XERCES_PROPERTY_PREFIX + Constants.DOCUMENT_SCANNER_PROPERTY;

    /** Property identifier: DTD scanner. */

    protected static final String DTD_SCANNER =

        Constants.XERCES_PROPERTY_PREFIX + Constants.DTD_SCANNER_PROPERTY;

    /** Property identifier: grammar pool. */

    protected static final String XMLGRAMMAR_POOL =

        Constants.XERCES_PROPERTY_PREFIX + Constants.XMLGRAMMAR_POOL_PROPERTY;

    /** Property identifier: DTD loader. */

    protected static final String DTD_PROCESSOR =

        Constants.XERCES_PROPERTY_PREFIX + Constants.DTD_PROCESSOR_PROPERTY;

    /** Property identifier: DTD validator. */

    protected static final String DTD_VALIDATOR =

        Constants.XERCES_PROPERTY_PREFIX + Constants.DTD_VALIDATOR_PROPERTY;

    /** Property identifier: namespace binder. */

    protected static final String NAMESPACE_BINDER =

        Constants.XERCES_PROPERTY_PREFIX + Constants.NAMESPACE_BINDER_PROPERTY;

    /** Property identifier: datatype validator factory. */

    protected static final String DATATYPE_VALIDATOR_FACTORY =

        Constants.XERCES_PROPERTY_PREFIX + Constants.DATATYPE_VALIDATOR_FACTORY_PROPERTY;

    protected static final String VALIDATION_MANAGER =

        Constants.XERCES_PROPERTY_PREFIX + Constants.VALIDATION_MANAGER_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;

    /** Property identifier: root type definition. */

    protected static final String ROOT_TYPE_DEF =

        Constants.XERCES_PROPERTY_PREFIX + Constants.ROOT_TYPE_DEFINITION_PROPERTY;

    /** Property identifier: root element declaration. */

    protected static final String ROOT_ELEMENT_DECL =

        Constants.XERCES_PROPERTY_PREFIX + Constants.ROOT_ELEMENT_DECLARATION_PROPERTY;

    /** Property identifier: locale. */

    protected static final String LOCALE =

        Constants.XERCES_PROPERTY_PREFIX + Constants.LOCALE_PROPERTY;

    /** Property identifier: Schema DV Factory */

    protected static final String SCHEMA_DV_FACTORY =

        Constants.XERCES_PROPERTY_PREFIX + Constants.SCHEMA_DV_FACTORY_PROPERTY;

    /** Property identifier: Security property manager. */

    private static final String XML_SECURITY_PROPERTY_MANAGER =

            Constants.XML_SECURITY_PROPERTY_MANAGER;

    /** Property identifier: Security manager. */

    private static final String SECURITY_MANAGER = Constants.SECURITY_MANAGER;

    // debugging

    /** Set to true and recompile to print exception stack trace. */

    protected static final boolean PRINT_EXCEPTION_STACK_TRACE = false;

    //

    // Data

    //

    protected SymbolTable fSymbolTable;

    protected XMLInputSource fInputSource;

    protected ValidationManager fValidationManager;

    protected XMLVersionDetector fVersionDetector;

    protected XMLLocator fLocator;

    protected Locale fLocale;

    /** XML 1.0 Components. */

    protected ArrayList<XMLComponent> fComponents;

    /** XML 1.1. Components. */

    protected ArrayList<XMLComponent> fXML11Components = null;

    /** Common components: XMLEntityManager, XMLErrorReporter, XMLSchemaValidator */

    protected ArrayList<XMLComponent> fCommonComponents = null;

    /** The document handler. */

    protected XMLDocumentHandler fDocumentHandler;

    /** The DTD handler. */

    protected XMLDTDHandler fDTDHandler;

    /** The DTD content model handler. */

    protected XMLDTDContentModelHandler fDTDContentModelHandler;

    /** Last component in the document pipeline */

    protected XMLDocumentSource fLastComponent;

    /**

     * True if a parse is in progress. This state is needed because

     * some features/properties cannot be set while parsing (e.g.

     * validation and namespaces).

     */

    protected boolean fParseInProgress = false;

    /** fConfigUpdated is set to true if there has been any change to the configuration settings,

     * i.e a feature or a property was changed.

     */

        protected boolean fConfigUpdated = false;

    //

    // XML 1.0 components

    //

    /** The XML 1.0 Datatype validator factory. */

    protected DTDDVFactory fDatatypeValidatorFactory;

    /** The XML 1.0 Document scanner that does namespace binding. */

    protected XMLNSDocumentScannerImpl fNamespaceScanner;

    /** The XML 1.0 Non-namespace implementation of scanner */

    protected XMLDocumentScannerImpl fNonNSScanner;

    /** The XML 1.0 DTD Validator: binds namespaces */

    protected XMLDTDValidator fDTDValidator;

    /** The XML 1.0 DTD Validator that does not bind namespaces */

    protected XMLDTDValidator fNonNSDTDValidator;

    /** The XML 1.0 DTD scanner. */

    protected XMLDTDScanner fDTDScanner;

    /** The XML 1.0 DTD Processor . */

    protected XMLDTDProcessor fDTDProcessor;

    //

    // XML 1.1 components

    //

    /** The XML 1.1 datatype factory. **/

    protected DTDDVFactory fXML11DatatypeFactory = null;

    /** The XML 1.1 document scanner that does namespace binding. **/

    protected XML11NSDocumentScannerImpl fXML11NSDocScanner = null;

    /** The XML 1.1 document scanner that does not do namespace binding. **/

    protected XML11DocumentScannerImpl fXML11DocScanner = null;

    /** The XML 1.1 DTD validator that does namespace binding. **/

    protected XML11NSDTDValidator fXML11NSDTDValidator = null;

    /** The XML 1.1 DTD validator that does not do namespace binding. **/

    protected XML11DTDValidator fXML11DTDValidator = null;

    /** The XML 1.1 DTD scanner. **/

    protected XML11DTDScannerImpl fXML11DTDScanner = null;

    /** The XML 1.1 DTD processor. **/

    protected XML11DTDProcessor fXML11DTDProcessor = null;

    //

    // Common components

    //

    /** Grammar pool. */

    protected XMLGrammarPool fGrammarPool;

    /** Error reporter. */

    protected XMLErrorReporter fErrorReporter;

    /** Entity manager. */

    protected XMLEntityManager fEntityManager;

    /** XML Schema Validator. */

    protected XMLSchemaValidator fSchemaValidator;

    /** Current scanner */

    protected XMLDocumentScanner fCurrentScanner;

    /** Current Datatype validator factory. */

    protected DTDDVFactory fCurrentDVFactory;

    /** Current DTD scanner. */

    protected XMLDTDScanner fCurrentDTDScanner;

    /** Flag indicating whether XML11 components have been initialized. */

    private boolean f11Initialized = false;

    /** Flag indicating whether the symbol table instance was specified during construction **/

    private boolean fSymbolTableProvided = false;

    /** Flag indicating if the symbol table was initialized and never used before that **/

    private boolean fSymbolTableJustInitialized = true;

    //

    // Constructors

    //

    /** Default constructor. */

    public XML11Configuration() {

        this(null, null, null);

    } // <init>()

    /**

     * Constructs a parser configuration using the specified symbol table.

     *

     * @param symbolTable The symbol table to use.

     */

    public XML11Configuration(SymbolTable symbolTable) {

        this(symbolTable, null, null);

    } // <init>(SymbolTable)

    /**

     * Constructs a parser configuration using the specified symbol table and

     * grammar pool.

     * <p>

     * <strong>REVISIT:</strong>

     * Grammar pool will be updated when the new validation engine is

     * implemented.

     *

     * @param symbolTable The symbol table to use.

     * @param grammarPool The grammar pool to use.

     */

    public XML11Configuration(SymbolTable symbolTable, XMLGrammarPool grammarPool) {

        this(symbolTable, grammarPool, null);

    } // <init>(SymbolTable,XMLGrammarPool)

    /**

     * Constructs a parser configuration using the specified symbol table,

     * grammar pool, and parent settings.

     * <p>

     * <strong>REVISIT:</strong>

     * Grammar pool will be updated when the new validation engine is

     * implemented.

     *

     * @param symbolTable    The symbol table to use.

     * @param grammarPool    The grammar pool to use.

     * @param parentSettings The parent settings.

     */

    public XML11Configuration(

        SymbolTable symbolTable,

        XMLGrammarPool grammarPool,

        XMLComponentManager parentSettings) {

        super(parentSettings);

        // create a vector to hold all the components in use

        // XML 1.0 specialized components

        fComponents = new ArrayList<>();

        // XML 1.1 specialized components

        fXML11Components = new ArrayList<>();

        // Common components for XML 1.1. and XML 1.0

        fCommonComponents = new ArrayList<>();

        // add default recognized features

        final String[] recognizedFeatures =

        {

            CONTINUE_AFTER_FATAL_ERROR, LOAD_EXTERNAL_DTD, // from XMLDTDScannerImpl

            VALIDATION,

            NAMESPACES,

            NORMALIZE_DATA, SCHEMA_ELEMENT_DEFAULT, SCHEMA_AUGMENT_PSVI,

            GENERATE_SYNTHETIC_ANNOTATIONS, VALIDATE_ANNOTATIONS,

            HONOUR_ALL_SCHEMALOCATIONS, IGNORE_XSI_TYPE,

            ID_IDREF_CHECKING, IDENTITY_CONSTRAINT_CHECKING,

            UNPARSED_ENTITY_CHECKING,

            NAMESPACE_GROWTH, TOLERATE_DUPLICATES,

            USE_GRAMMAR_POOL_ONLY,

            // NOTE: These shouldn't really be here but since the XML Schema

            //       validator is constructed dynamically, its recognized

            //       features might not have been set and it would cause a

            //       not-recognized exception to be thrown. -Ac

            XMLSCHEMA_VALIDATION, XMLSCHEMA_FULL_CHECKING,

            EXTERNAL_GENERAL_ENTITIES,

            EXTERNAL_PARAMETER_ENTITIES,

            PARSER_SETTINGS,

            XMLConstants.FEATURE_SECURE_PROCESSING,

            XMLConstants.USE_CATALOG,

            JdkXmlUtils.RESET_SYMBOL_TABLE

        };

        addRecognizedFeatures(recognizedFeatures);

        // set state for default features

        fFeatures.put(VALIDATION, Boolean.FALSE);

        fFeatures.put(NAMESPACES, Boolean.TRUE);