/**
 * Copyright (C) 2010 Orbeon, Inc.
 *
 * This program is free software; you can redistribute it and/or modify it under the terms of the
 * GNU Lesser General Public License as published by the Free Software Foundation; either version
 * 2.1 of the License, or (at your option) any later version.
 *
 * This program 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 Lesser General Public License for more details.
 *
 * The full text of the license is available at http://www.gnu.org/copyleft/lesser.html
 */
package org.orbeon.oxf.test;

import org.apache.log4j.Logger;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.orbeon.dom.Document;
import org.orbeon.oxf.externalcontext.ExternalContext;
import org.orbeon.oxf.externalcontext.TestExternalContext;
import org.orbeon.oxf.pipeline.api.PipelineContext;
import org.orbeon.oxf.processor.ProcessorUtils;
import org.orbeon.oxf.processor.XMLProcessorRegistry;
import org.orbeon.oxf.processor.generator.DOMGenerator;
import org.orbeon.oxf.resources.ResourceManagerWrapper;
import org.orbeon.oxf.util.IndentedLogger;
import org.orbeon.oxf.util.LoggerFactory;
import org.orbeon.oxf.util.PipelineUtils;
import org.orbeon.oxf.xml.XMLParsing;

import java.util.Enumeration;
import java.util.HashMap;
import java.util.Map;


public abstract class ResourceManagerTestBase {

    public static final Logger logger = LoggerFactory.createLogger(ResourceManagerTestBase.class);

    public static IndentedLogger newIndentedLogger() {
        return new IndentedLogger(logger, true);
    }

    public ResourceManagerTestBase() {}

    private static boolean staticSetupDone;

    @BeforeClass
    public static void staticSetup() throws Exception {
        if (! staticSetupDone) {

            // Avoid Log4j warning telling us no appender could be found
            LoggerFactory.initBasicLogger();

            // Setup resource manager
            final Map<String, Object> props = new HashMap<String, Object>();
            final java.util.Properties properties = System.getProperties();
            for (Enumeration e = properties.propertyNames(); e.hasMoreElements();) {
                final String name = (String) e.nextElement();
                if (name.startsWith("oxf.resources."))
                    props.put(name, properties.getProperty(name));
            }

            logger.info("Initializing Resource Manager with: " + ResourceManagerWrapper.propertiesAsJson(props));
            ResourceManagerWrapper.init(props);
            // Initialize properties
            org.orbeon.oxf.properties.Properties.init("oxf:/ops/unit-tests/properties.xml");

            // Initialize logger
            LoggerFactory.initLogger();

            // Run processor registry so we can use XPL
            final XMLProcessorRegistry registry = new XMLProcessorRegistry();
            final String processorsXML = "processors.xml";
            final Document doc = ResourceManagerWrapper.instance().getContentAsDOM4J(processorsXML, XMLParsing.ParserConfiguration.XINCLUDE_ONLY, true);
            final DOMGenerator config = PipelineUtils.createDOMGenerator(doc, processorsXML, DOMGenerator.ZeroValidity, processorsXML);
            PipelineUtils.connect(config, "data", registry, "config");
            registry.start(new PipelineContext());

            staticSetupDone  = true;
        }
	}

    private PipelineContext pipelineContext;

    @Before
    public void setupResourceManagerTestPipelineContext() {
        this.pipelineContext = createPipelineContextWithExternalContext();
    }

    @After
    public void tearDownResourceManagerTestPipelineContext() {
        if (pipelineContext != null)
            pipelineContext.destroy(true);
    }

    public static PipelineContext createPipelineContextWithExternalContext() {
        return createPipelineContextWithExternalContext("oxf:/org/orbeon/oxf/default-request.xml");
    }

    public static PipelineContext createPipelineContextWithExternalContext(String requestURL) {
        final PipelineContext pipelineContext = new PipelineContext();
        setExternalContext(pipelineContext, requestURL);
        return pipelineContext;
    }

    public static void setExternalContext(PipelineContext pipelineContext) {
        setExternalContext(pipelineContext, "oxf:/org/orbeon/oxf/default-request.xml");
    }

    public static void setExternalContext(PipelineContext pipelineContext, String requestURL) {
        final Document requestDocument = ProcessorUtils.createDocumentFromURL(requestURL, null);
        final ExternalContext externalContext = new TestExternalContext(pipelineContext, requestDocument);
        pipelineContext.setAttribute(PipelineContext.EXTERNAL_CONTEXT, externalContext);
    }
}