/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package catalog;

import java.io.File;

import java.io.FileInputStream;

import java.io.IOException;

import java.io.InputStream;

import java.io.StringReader;

import java.io.StringWriter;

import java.nio.file.Paths;

import javax.xml.XMLConstants;

import javax.xml.catalog.Catalog;

import javax.xml.catalog.CatalogException;

import javax.xml.catalog.CatalogFeatures;

import javax.xml.catalog.CatalogFeatures.Feature;

import javax.xml.catalog.CatalogManager;

import javax.xml.catalog.CatalogResolver;

import javax.xml.parsers.ParserConfigurationException;

import javax.xml.parsers.SAXParser;

import javax.xml.parsers.SAXParserFactory;

import javax.xml.stream.XMLInputFactory;

import javax.xml.stream.XMLStreamConstants;

import javax.xml.stream.XMLStreamReader;

import javax.xml.transform.Source;

import javax.xml.transform.Transformer;

import javax.xml.transform.TransformerFactory;

import javax.xml.transform.sax.SAXSource;

import javax.xml.transform.stream.StreamResult;

import javax.xml.transform.stream.StreamSource;

import javax.xml.validation.Schema;

import javax.xml.validation.SchemaFactory;

import javax.xml.validation.Validator;

import org.testng.Assert;

import org.testng.annotations.BeforeClass;

import org.testng.annotations.DataProvider;

import org.testng.annotations.Listeners;

import org.testng.annotations.Test;

import org.xml.sax.Attributes;

import org.xml.sax.ErrorHandler;

import org.xml.sax.InputSource;

import org.xml.sax.SAXException;

import org.xml.sax.XMLReader;

import org.xml.sax.ext.DefaultHandler2;

/*

 * @test

 * @bug 8081248 8144966 8146606 8146237 8150969 8151162 8152527 8154220 8163232

 * @library /javax/xml/jaxp/libs /javax/xml/jaxp/unittest

 * @run testng/othervm -DrunSecMngr=true catalog.CatalogTest

 * @run testng/othervm catalog.CatalogTest

 * @summary Tests basic Catalog functions.

 */

@Listeners({jaxp.library.FilePolicy.class})

public class CatalogTest extends CatalogSupportBase {

    static final String KEY_FILES = "javax.xml.catalog.files";

    /*

     * Initializing fields

     */

    @BeforeClass

    public void setUpClass() throws Exception {

        super.setUp();

    }

    /*

     * @bug 8162431

     * Verifies that circular references are caught and

     * CatalogException is thrown.

     */

    @Test(dataProvider = "getFeatures", expectedExceptions = CatalogException.class)

        CatalogResolver catalogResolver = CatalogManager.catalogResolver(

                cf,

        catalogResolver.resolve("anyuri", "");

    }

    /*

       DataProvider: used to verify circular reference

        Data columns: CatalogFeatures, catalog

     */

    @DataProvider(name = "getFeatures")

    public Object[][] getFeatures() {

        return new Object[][]{

    }

    /*

     * @bug 8163232

     * Verifies that the CatalogResolver supports the following XML Resolvers:

          javax.xml.stream.XMLResolver

          javax.xml.transform.URIResolver

          org.w3c.dom.ls.LSResourceResolver

          org.xml.sax.EntityResolver

     *

     * Plus, system and uri entries can equally be used.

     */

    /*

     * Verifies the support for org.xml.sax.EntityResolver.

     * Expected: the parser returns the expected string.

    */

    @Test(dataProvider = "supportXMLResolver")

        String xmlSource = getClass().getResource(xml).getFile();

        CatalogResolver cr = CatalogManager.catalogResolver(CatalogFeatures.defaults(), catalogFile);

        MyCatalogHandler handler = new MyCatalogHandler(cr, elementInSystem);

        SAXParser parser = getSAXParser(false, true, null);

        parser.parse(xmlSource, handler);

        Assert.assertEquals(handler.getResult().trim(), expected);

    }

    /*

     * Verifies the support for javax.xml.stream.XMLResolver.

     * Expected: the parser returns the expected string.

    */

    @Test(dataProvider = "supportXMLResolver")

        String xmlSource = getClass().getResource(xml).getFile();

        CatalogResolver cr = CatalogManager.catalogResolver(CatalogFeatures.defaults(), catalogFile);

        XMLInputFactory xifactory = XMLInputFactory.newInstance();

        xifactory.setProperty(XMLInputFactory.IS_COALESCING, true);

        xifactory.setProperty(XMLInputFactory.RESOLVER, cr);

        File file = new File(xmlSource);

        InputStream entityxml = new FileInputStream(file);

        XMLStreamReader streamReader = xifactory.createXMLStreamReader(systemId, entityxml);

        String result = null;

        while (streamReader.hasNext()) {

            int eventType = streamReader.next();

            if (eventType == XMLStreamConstants.START_ELEMENT) {

                eventType = streamReader.next();

                if (eventType == XMLStreamConstants.CHARACTERS) {

                    result = streamReader.getText();

                }

            }

        }

        System.out.println(": expected [" + expected + "] <> actual [" + result.trim() + "]");

        Assert.assertEquals(result.trim(), expected);

    }

    /*

     * Verifies the support for org.w3c.dom.ls.LSResourceResolver by ShemaFactory.

     * Success: parsing goes through with no error

     * Fail: throws Exception if references are not resolved (by the CatalogResolver)

    */

    @Test(dataProvider = "supportLSResourceResolver")

        CatalogResolver cr = CatalogManager.catalogResolver(CatalogFeatures.defaults(), catalogFile);

        SchemaFactory factory = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);

        factory.setResourceResolver(cr);

        Schema schema = factory.newSchema(schemaSource);

    }

    /*

     * Verifies the support for org.w3c.dom.ls.LSResourceResolver by Validator.

     * Success: parsing goes through with no error

     * Fail: throws Exception if references are not resolved (by the CatalogResolver)

    */

    @Test(dataProvider = "supportLSResourceResolver1")

        CatalogResolver cr = CatalogManager.catalogResolver(CatalogFeatures.defaults(), catalogFile);

        SchemaFactory factory = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);

        Validator validator = factory.newSchema().newValidator();

        validator.setResourceResolver(cr);

        validator.validate(source);

    }

    /*

     * Verifies the support for javax.xml.transform.URIResolver.

     * Success: parsing goes through with no error

     * Fail: throws Exception if references are not resolved (by the CatalogResolver)

    */

    @Test(dataProvider = "supportURIResolver")

        CatalogResolver cr = CatalogManager.catalogResolver(CatalogFeatures.defaults(), catalogFile);

            TransformerFactory factory = TransformerFactory.newInstance();

            factory.setURIResolver(cr);

            Transformer transformer = factory.newTransformer(xsl);

            StringWriter out = new StringWriter();

            transformer.transform(xml, new StreamResult(out));

            if (expected != null) {

                Assert.assertTrue(out.toString().contains(expected), "supportURIResolver");

            }

    }

    /*

       DataProvider: used to verify the support of XML Resolvers.

        Data columns:

        catalog filepath, xml source file, expected result

     */

    @DataProvider(name = "supportXMLResolver")

        return new Object[][]{

            {catalogFile, "system.xml", "Test system entry"},

            {catalogFile, "rewritesystem.xml", "Test rewritesystem entry"},

            {catalogFile, "rewritesystem1.xml", "Test rewritesystem entry"},

            {catalogFile, "systemsuffix.xml", "Test systemsuffix entry"},

            {catalogFile, "delegatesystem.xml", "Test delegatesystem entry"},

            {catalogFile, "public.xml", "Test public entry"},

            {catalogFile, "delegatepublic.xml", "Test delegatepublic entry"},

            // using uri entries

            {catalogFileUri, "system.xml", "Test system entry"},

            {catalogFileUri, "rewritesystem.xml", "Test rewritesystem entry"},

            {catalogFileUri, "rewritesystem1.xml", "Test rewritesystem entry"},

            {catalogFileUri, "systemsuffix.xml", "Test systemsuffix entry"},

            {catalogFileUri, "delegateuri.xml", "Test delegateuri entry"},

            {catalogFileUri, "public.xml", "Test public entry"},

         };

    }

    /*

       DataProvider: used to verify the support of LSResourceResolver by SchemaFactory.

        Data columns:

        catalog filepath, schema source file

     */

    @DataProvider(name = "supportLSResourceResolver")

        /*

         * XMLSchema.xsd has a reference to XMLSchema.dtd which in turn refers to

         * datatypes.dtd

        */

        return new Object[][]{

            {catalogFile, new StreamSource(new StringReader(xsd_xmlSchema))},

            {catalogFile, new StreamSource(new StringReader(xsd_xmlSchema_import))},

            {catalogFile, new StreamSource(new StringReader(xsd_include_company))},

            {catalogFileUri, new StreamSource(new StringReader(xsd_xmlSchema))},

            {catalogFileUri, new StreamSource(new StringReader(xsd_xmlSchema_import))},

            {catalogFileUri, new StreamSource(new StringReader(xsd_include_company))},

         };

    }

    /*

       DataProvider: used to verify the support of LSResourceResolver by Validator.

        Data columns:

        catalog filepath, source file

     */

    @DataProvider(name = "supportLSResourceResolver1")

        /*

         * val_test.xml has a reference to system.dtd and val_test.xsd

        */

        SAXSource ss = new SAXSource(new InputSource(xml_val_test));

        ss.setSystemId(xml_val_test_id);

        return new Object[][]{

            {catalogFile, ss},

            {catalogFileUri, ss},

         };

    }

    /*

       DataProvider: used to verify the support of LSResourceResolver by Validator.

        Data columns:

        catalog filepath, xsl source, xml source file

     */

    @DataProvider(name = "supportURIResolver")

        SAXSource xslSource = new SAXSource(new InputSource(new File(xsl_doc).toURI().toASCIIString()));

        /*

         * val_test.xml has a reference to system.dtd and val_test.xsd

        */

        SAXSource ss = new SAXSource(new InputSource(xml_val_test));

        ss.setSystemId(xml_val_test_id);

        return new Object[][]{

            {catalogFile, new SAXSource(new InputSource(new File(xsl_doc).toURI().toASCIIString())),

                new StreamSource(new File(xml_doc)), "Resolved by a catalog"},

            {catalogFileUri, new SAXSource(new InputSource(new StringReader(xsl_include))),

                new StreamSource(new StringReader(xml_xsl)), null},

         };

    }

    /*

     * @bug 8150187

     * NPE is expected if the systemId is null. The specification for systemId

     * is as follows:

     * A system identifier is required on all external entities. XML

     * requires a system identifier on all external entities, so this value is

     * always specified.

     */

    @Test(expectedExceptions = NullPointerException.class)

    public void sysIdCantBeNull() {

        CatalogResolver catalogResolver = CatalogManager.catalogResolver(CatalogFeatures.defaults());

        InputSource is = catalogResolver.resolveEntity("-//FOO//DTD XML Dummy V0.0//EN", null);

    }

    /*

     * @bug 8156845

     * Verifies that an URI reference with a urn:publicid is correctly resolved

     * with an uri entry with a publicId.

     *

     * @param expectedFile is not used in this test, it's kept since we're

     * copying the JCK test and its dataProvider. This test may be reused for

     * other cases in that test.

     */

    @Test(dataProvider = "resolveUri")

        CatalogResolver cur = CatalogManager.catalogResolver(CatalogFeatures.defaults(), catalogFile);

        Source source = cur.resolve(href, null);

        Assert.assertNotNull(source, "Source returned is null");

        Assert.assertEquals(expectedUri, source.getSystemId(), msg);

    }

    /*

     * @bug 8154220

     * Verifies that the file input is validated properly. Valid input includes

     * multiple file paths separated by semicolon.

     */

    @Test(dataProvider = "hierarchyOfCatFilesData")

    public void hierarchyOfCatFiles2(String systemId, String expectedUri) {

        String files = file1 + ";" + file2;

        try {

            setSystemProperty(KEY_FILES, files);

            CatalogResolver catalogResolver = CatalogManager.catalogResolver(CatalogFeatures.defaults());

            String sysId = catalogResolver.resolveEntity(null, systemId).getSystemId();

        } finally {

            clearSystemProperty(KEY_FILES);

        }

    }

    /*

     * @bug 8152527

     * This test is the same as the JDK test ResolveEntityTests:testMatch1.

     * Verifies that the CatalogResolver resolves a publicId and/or systemId as

     * expected.

     */

    @Test(dataProvider = "resolveEntity")

        CatalogFeatures features = CatalogFeatures.builder().with(CatalogFeatures.Feature.PREFER, prefer).build();

        CatalogResolver catalogResolver = CatalogManager.catalogResolver(features, catalogFile);

        InputSource is = catalogResolver.resolveEntity(pubId, sysId);

        Assert.assertNotNull(is, msg);

        String expected = (expectedUri == null) ? expectedFile : expectedUri;

        Assert.assertEquals(expected, is.getSystemId(), msg);

    }

    /*

     * @bug 8151162

     * Verifies that the Catalog matches specified publicId or systemId and returns

     * results as expected.

     */

    @Test(dataProvider = "matchWithPrefer")

        String result;

        if (publicId != null && publicId.length() > 0) {

            result = c.matchPublic(publicId);

        } else {

            result = c.matchSystem(systemId);

        }

        Assert.assertEquals(expected, result);

    }

    /*

     * @bug 8151162

     * Verifies that the CatalogResolver resolves specified publicId or systemId

     * in accordance with the prefer setting.

     * prefer "system": resolves with a system entry.

     *                  Exception: use the public entry when the catalog contains

     *                  only public entry and only publicId is specified.

     * prefer "public": attempts to resolve with a system entry;

     *                  attempts to resolve with a public entry if no matching

     *                  system entry is found.

     */

    @Test(dataProvider = "resolveWithPrefer")

        CatalogFeatures f = CatalogFeatures.builder().with(CatalogFeatures.Feature.PREFER, prefer).with(CatalogFeatures.Feature.RESOLVE, "ignore").build();

        CatalogResolver catalogResolver = CatalogManager.catalogResolver(f, catalogFile);

        String result = catalogResolver.resolveEntity(publicId, systemId).getSystemId();

        Assert.assertEquals(expected, result);

    }

    /**

     * @bug 8150969

     * Verifies that the defer attribute set in the catalog file takes precedence

     * over other settings, in which case, whether next and delegate Catalogs will

     * be loaded is determined by the defer attribute.

     */

    @Test(dataProvider = "invalidAltCatalogs", expectedExceptions = CatalogException.class)

        CatalogFeatures features = CatalogFeatures.builder().with(CatalogFeatures.Feature.DEFER, "true").build();

        /*

          Since the defer attribute is set to false in the specified catalog file,

          the parent catalog will try to load the alt catalog, which will fail

          since it points to an invalid catalog.

        */

        Catalog catalog = CatalogManager.catalog(features, catalogFile);

    }

    /**

     * @bug 8146237

     * PREFER from Features API taking precedence over catalog file

     */

    @Test

        try {

            CatalogFeatures features = CatalogFeatures.builder().with(CatalogFeatures.Feature.PREFER, "system").build();

            Catalog catalog = CatalogManager.catalog(features, catalogFile);

            CatalogResolver catalogResolver = CatalogManager.catalogResolver(catalog);

            String actualSystemId = catalogResolver.resolveEntity("-//FOO//DTD XML Dummy V0.0//EN", "http://www.oracle.com/alt1sys.dtd").getSystemId();

            Assert.assertTrue(actualSystemId.contains("dummy.dtd"), "Resulting id should contain dummy.dtd, indicating a match by publicId");

        } catch (Exception e) {

            Assert.fail(e.getMessage());

        }

    }

    /*

       @bug 8146606

       Verifies that the resulting systemId does not contain duplicate slashes

    */

    @Test