/**
 *
 */
package de.intevation.gnv.artifacts;

import java.io.IOException;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;

import javax.xml.XMLConstants;
import javax.xml.xpath.XPathConstants;

import org.apache.log4j.Logger;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

import de.intevation.artifactdatabase.Config;
import de.intevation.artifactdatabase.DefaultArtifact;
import de.intevation.artifactdatabase.XMLUtils;
import de.intevation.artifacts.ArtifactFactory;
import de.intevation.artifacts.ArtifactNamespaceContext;
import de.intevation.artifacts.CallContext;
import de.intevation.gnv.artifacts.context.GNVArtifactContext;
import de.intevation.gnv.transition.DefaultInputData;
import de.intevation.gnv.transition.InputData;
import de.intevation.gnv.transition.InputValue;
import de.intevation.gnv.transition.OutputMode;
import de.intevation.gnv.transition.OutputTransition;
import de.intevation.gnv.transition.Transition;
import de.intevation.gnv.transition.TransitionFactory;
import de.intevation.gnv.transition.exception.TransitionException;
import de.intevation.gnv.utils.ArtifactXMLUtilities;

/**
 * @author Tim Englich <tim.englich@intevation.de>
 *
 */
public abstract class GNVArtifactBase extends DefaultArtifact {
    /**
     * the logger, used to log exceptions and additonaly information
     */
    private static Logger log = Logger.getLogger(GNVArtifactBase.class);
    /**
     * The UID of this Class
     */
    private static final long serialVersionUID = -8907096744400741458L;
    
    /**
     * The Identifier for the Replacement of the Artifactname
     */
    public static final String XPATH_IDENTIFIER_REPLACE = "IDENTIFIER";
    
    /**
     * The XPATH to the XML-Fragment that should be used for the Configuration
     */
    public static final String XPATH_ARTIFACT_CONFIGURATION= "/artifact-database/artifacts/artifact[@name='"+XPATH_IDENTIFIER_REPLACE+"']";
    
    
    /**
     * The current Transition
     */
    protected Transition current = null;
    
    /**
     * The Transitions that can be used
     */
    protected Map<String, Transition> transitions = null;

    /**
     * The Name of the Artifact
     */
    protected String name = null;
    
    private ArtifactXMLUtilities xmlUtilities = new ArtifactXMLUtilities();
    
    /**
     * Constructor
     */
    public GNVArtifactBase() {
        super();
    }
    
    /**
     * @see de.intevation.artifactdatabase.DefaultArtifact#advance(org.w3c.dom.Document, de.intevation.artifacts.CallContext)
     */
    @Override
    public Document advance(Document target, CallContext context) {
        log.debug("GNVArtifactBase.advance");
        Document result = XMLUtils.newDocument();
        try {
            if (this.current != null){
                String transitionName = this.readTransitionName(target);
                if (this.current.isTransitionReachable(transitionName)){
                    // 1. Pr�fung ob Transition valide ist
                    if (this.current.validate()){
                        
                        try {
                            Transition nextStep = this.transitions.get(transitionName);
                            // 2.Ergebnisse Berechnen
                            this.current.advance();
                            // 3. Ergebnisse �bergeben
                            nextStep.setDescibeData(this.current.getDescibeData());
                            nextStep.putInputData(this.current.getInputData());
                            // 4. Umschalten auf neue Transistion
                            this.current = nextStep;
                            result = new ArtifactXMLUtilities().createSuccessReport("Advance success", XMLUtils.newDocument());
                        } catch (TransitionException e) {
                            log.error(e,e);
                            result = new ArtifactXMLUtilities().createExceptionReport(e.getLocalizedMessage(), XMLUtils.newDocument());
                        }
                        
                    }else{
                        String msg = "Advance nicht m�glich, da die Bedingungen f�r den �bergang " +
                                    "in den neuen Zustand noch nicht gegeben ist.";
                        log.error(msg);
                        result = new ArtifactXMLUtilities().createExceptionReport(msg, XMLUtils.newDocument());
                    }
                    
                }else{
                    String msg = "Transitions�bergang wird nicht unterst�tzt.";
                    log.error(msg);
                    result = new ArtifactXMLUtilities().createExceptionReport(msg, XMLUtils.newDocument());
                }
            }else{
                String msg = "Kein Transitionsschritt aktiviert.";
                log.error(msg);
                result = new ArtifactXMLUtilities().createExceptionReport(msg, XMLUtils.newDocument());
            }
        } catch (Exception e) {
            log.error(e,e);
            result = new ArtifactXMLUtilities().createExceptionReport(e.getLocalizedMessage(), XMLUtils.newDocument());
        }
        return result;
    }

    protected String readTransitionName(Document document) {
        String returnValue = Config.getStringXPath(document, "action/target/@name");
        return returnValue;
    }

    protected Node getConfigurationFragment(Document document){
        log.debug("GNVArtifactBase.getConfigurationFragment");
        String xpathQuery = XPATH_ARTIFACT_CONFIGURATION.replaceAll(XPATH_IDENTIFIER_REPLACE, this.name);
        log.debug(xpathQuery);
        return Config.getNodeXPath(document,xpathQuery);
    }
    
    /**
     * @see de.intevation.artifactdatabase.DefaultArtifact#feed(org.w3c.dom.Document, de.intevation.artifacts.CallContext)
     */
    @Override
    public Document feed(Document target, CallContext context) {
        log.debug("GNVArtifactBase.feed");
        Document result = XMLUtils.newDocument();
        try {
            if (this.current != null){
                this.current.putInputData(this.parseInputData(target));
                result = new ArtifactXMLUtilities().createSuccessReport("Feed success", XMLUtils.newDocument());
            }else{
                String msg = "No Transition instantiated";
                log.warn(msg);
                result = new ArtifactXMLUtilities().createExceptionReport(msg, XMLUtils.newDocument());
            }
        } catch (TransitionException e) {
            log.error(e,e);
            result = new ArtifactXMLUtilities().createExceptionReport(e.getLocalizedMessage(), XMLUtils.newDocument());
        }
        return result;
    }
    
    /**
     * @see de.intevation.artifactdatabase.DefaultArtifact#setup(java.lang.String, java.lang.Object)
     */
    @Override
    public void setup(String identifier, ArtifactFactory factory, Object context) {
        log.debug("GNVArtifactBase.setup");
        super.setup(identifier, factory, context);
        
        Object localContext = context;
        if (context instanceof CallContext){
            localContext = ((CallContext)context).globalContext();
            
        }
        
        if (localContext instanceof GNVArtifactContext){
            GNVArtifactContext gnvContext = (GNVArtifactContext)localContext;
            Document doc = gnvContext.getConfig();
            Node artifactNode = this.getConfigurationFragment(doc);
            NodeList transitionList = Config.getNodeSetXPath(artifactNode, "transitions/transition");
            this.transitions = new HashMap<String, Transition>(transitionList.getLength());
            for (int i  = 0 ; i < transitionList.getLength(); i++){
                Transition tmpTransition = TransitionFactory.getInstance().createTransition(transitionList.item(i));
                if (tmpTransition != null){
                    this.transitions.put(tmpTransition.getID(), tmpTransition);
                    if (this.current == null){
                        this.current = tmpTransition;
                    }
                }
            }
            
        }
    }
    
    
    protected Document createDescibeOutput(){
        log.debug("GNVArtifactBase.createDescibeOutput");
        Document document = XMLUtils.newDocument();
         Element rootNode = this.createRootNode(document);
        this.createHeader(rootNode, document, "describe");
        this.createOutputs(rootNode, document);
        this.createCurrentState(rootNode, document);
        this.createReachableStates(rootNode, document);
        this.createModel(rootNode, document);
        this.createUserInterface(rootNode, document);
        return document;
    }
    
    protected Element createRootNode(Document document){
        Element rootNode = xmlUtilities.createArtifactElement(document,"result");
        document.appendChild(rootNode);
        return rootNode;
    }
    
    protected void createHeader(Element parent, Document document, String documentType){
        Element typeNode = xmlUtilities.createArtifactElement(document,"type");
        typeNode.setAttribute("name", documentType);
        parent.appendChild(typeNode);
        
        Element uuidNode = xmlUtilities.createArtifactElement(document,"uuid");
        uuidNode.setAttribute("value", super.identifier);
        parent.appendChild(uuidNode);
        
        Element hashNode = xmlUtilities.createArtifactElement(document,"hash");
        hashNode.setAttribute("value", this.hash());
        parent.appendChild(hashNode);
    }

    protected void createReachableStates(Element parent,Document document){
        Element stateNode = xmlUtilities.createArtifactElement(document,"reachable-states");
        if (this.current != null){
            Iterator<String> states = this.current.reachableTransitions().iterator();
            while(states.hasNext()){
                String value = states.next();
                Element currentNode = xmlUtilities.createArtifactElement(document,"state");
                currentNode.setAttribute("name", value);
                log.debug("Reachable State: "+value);
                currentNode.setAttribute("description", transitions.get(value).getDescription());
                stateNode.appendChild(currentNode);
            }
        }
        parent.appendChild(stateNode);
    }
    
    protected void createCurrentState(Element parent, Document document){
        Element stateNode = xmlUtilities.createArtifactElement(document,"state");
        stateNode.setAttribute("name", this.current.getID());
        stateNode.setAttribute("description", this.current.getDescription());
        parent.appendChild(stateNode);
    }
    
    
    protected void createModel(Element parent, Document document){
        Element modelNode = xmlUtilities.createArtifactElement(document,"model");
        if (this.current != null){
            Collection<InputValue>  inputValues = this.current.getRequiredInputValues();
            if (inputValues != null){
                Iterator<InputValue> it = inputValues.iterator();
                while(it.hasNext()){
                    InputValue inputValue = it.next();
                    Element inputNode = xmlUtilities.createArtifactElement(document,"input");
                    inputNode.setAttribute("name", inputValue.getName());
                    inputNode.setAttribute("type", inputValue.getType());
                    modelNode.appendChild(inputNode);
                }
            }
        }
        parent.appendChild(modelNode);
    }
    
    protected void createUserInterface(Element parent, Document document){
        Element uiNode = xmlUtilities.createArtifactElement(document,"ui");
        
        if (this.current != null){
            this.current.describe(document, uiNode);
        }
        
        parent.appendChild(uiNode);
    }
    
    protected void createOutputs(Element parent, Document document){
        log.debug("GNVArtifactBase.createOutputs");
        Element outputsNode = xmlUtilities.createArtifactElement(document,"outputs");
        if (this.current instanceof OutputTransition){
            Collection<OutputMode> outputModes = ((OutputTransition)this.current).getOutputModes();
            if (outputModes != null){
                Iterator<OutputMode> it = outputModes.iterator();
                while(it.hasNext()){
                    OutputMode outputMode = it.next();
                    log.debug("Write Outputnode for "+ outputMode.toString());
                    Element outputModeNode = xmlUtilities.createArtifactElement(document,"output");
                    outputModeNode.setAttribute("name", outputMode.getName());
                    outputModeNode.setAttribute("description", outputMode.getDescription());
                    outputModeNode.setAttribute("mime-type", outputMode.getMimeType());
                    outputsNode.appendChild(outputModeNode);
                }
            }else{
                log.warn("No Outputmodes given.");
            }
        }
        parent.appendChild(outputsNode);
    }

    
    protected Collection<InputData> parseInputData(Document document){
        log.debug("GNVArtifactBase.parseInputData");
        HashMap<String,InputData> returnValue = null;
        
        log.debug(new ArtifactXMLUtilities().writeDocument2String(document));
        
        NodeList inputElemets = (NodeList)XMLUtils.xpath(document, "/action/data/input",XPathConstants.NODESET, ArtifactNamespaceContext.INSTANCE);//Config.getNodeSetXPath(document, "");
        if(inputElemets != null){
            returnValue = new HashMap<String,InputData>(inputElemets.getLength());
            for (int i = 0; i < inputElemets.getLength(); i++){
                Node inputDataNode = inputElemets.item(i);
                String name = Config.getStringXPath(inputDataNode,"@name");
                String value = Config.getStringXPath(inputDataNode,"@value");
                
                if (returnValue.containsKey(name)){
                    InputData inputData = returnValue.get(name);
                    inputData.concartValue(value);
                    log.debug(inputData.toString());
                    returnValue.put(name, inputData);
                }else{
                    InputData inputData = new DefaultInputData(name,value);
                    
                    returnValue.put(name,inputData);
                }
            }
        }
        return returnValue.values();
    }
    /**
     * @see de.intevation.artifactdatabase.DefaultArtifact#out(org.w3c.dom.Document, java.lang.Object)
     */
 
    
    /**
     * @see de.intevation.artifactdatabase.DefaultArtifact#out(org.w3c.dom.Document, java.io.OutputStream, de.intevation.artifacts.CallContext)
     */
    @Override
    public void out(Document format, OutputStream outputStream, CallContext context)
            throws IOException {
        log.debug("TGNVArtifactBase.out");
        try {
            
            if (current != null && current instanceof OutputTransition){
              ((OutputTransition)current).out(this.readOutputType(format), outputStream);
            }
        } catch (TransitionException e) {
            log.error(e,e);
            throw new IOException(e.getMessage());
        }
    }

    protected String readOutputType(Document document){
        String value = Config.getStringXPath(document,"action/out/@name");
        return value;
    }
}