EDIT

/**

* Copyright (C) 2013 EDIT

* European Distributed Institute of Taxonomy

* http://www.e-taxonomy.eu

*

* The contents of this file are subject to the Mozilla Public License Version 1.1

* See LICENSE.TXT at the top of this package for the full license terms.

*/

package eu.etaxonomy.cdm.ext.occurrence.bioCase;

import java.io.IOException;

import java.io.InputStream;

import java.net.URI;

import java.util.ArrayList;

import java.util.HashMap;

import java.util.List;

import java.util.Map;

import javax.xml.parsers.DocumentBuilder;

import javax.xml.parsers.DocumentBuilderFactory;

import javax.xml.parsers.ParserConfigurationException;

import org.apache.http.NameValuePair;

import org.apache.http.client.ClientProtocolException;

import org.apache.http.client.entity.UrlEncodedFormEntity;

import org.apache.http.message.BasicNameValuePair;

import org.jdom.Document;

import org.jdom.output.Format;

import org.jdom.output.XMLOutputter;

import org.springframework.stereotype.Service;

import org.springframework.transaction.annotation.Transactional;

import org.w3c.dom.Element;

import org.w3c.dom.Node;

import org.w3c.dom.NodeList;

import org.xml.sax.SAXException;

import eu.etaxonomy.cdm.api.facade.DerivedUnitFacade;

import eu.etaxonomy.cdm.common.UriUtils;

import eu.etaxonomy.cdm.ext.common.ServiceWrapperBase;

import eu.etaxonomy.cdm.ext.occurrence.OccurenceQuery;

import eu.etaxonomy.cdm.model.location.NamedArea;

import eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationBase;

import eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationType;

/**

 * This service provides access to BioCASe providers.<br>

 * It sends a {@link OccurenceQuery} via HTTP POST to a given provider

 * @author pplitzner

 \* @since 13.09.2013

 *

 */

@Service

@Transactional(readOnly = true)

public class BioCaseQueryServiceWrapper extends ServiceWrapperBase<SpecimenOrObservationBase<?>>{

    private static final BasicNameValuePair SUBMIT_PARAM = new BasicNameValuePair("Submit", "Submit");

    private static final String QUERY_PARAM_NAME = "query";

    private static final BasicNameValuePair CAPABILITY_TEST_PARAM = new BasicNameValuePair("capabilities", "1");

    /**

     * Queries the BioCASE provider at the given endPoint with the given {@link OccurenceQuery}.<br>

     * @param query the query object which stores all the query parameters

     * @param endPoint If <code>null</code> then the default endPoint is used

     *  (<i>http://ww3.bgbm.org/biocase/pywrapper.cgi?dsa=Herbar</i>)

     * @return The response as an {@link InputStream}

     */

    public InputStream query(OccurenceQuery query, URI endPoint) throws ClientProtocolException, IOException{

        if(endPoint==null){

            logger.warn("URI for querying was null.");

            return null;

        }

        if(UriUtils.isServiceAvailable(endPoint, 10000)){

            //check capabilities for ABCD version

            Map<String, String> requestHeaders = new HashMap<String, String>();

            requestHeaders.put(CAPABILITY_TEST_PARAM.getName(), CAPABILITY_TEST_PARAM.getValue());

            InputStream response = executeHttpGet(endPoint, requestHeaders);

            String abcdSchema = parseAbcdSchemaVersion(response);

            //build XML query

            Document doc = BioCaseQueryGenerator.generateXMLQuery(query, abcdSchema);

            String xmlOutputString = new XMLOutputter(Format.getPrettyFormat()).outputString(doc);

            //POST parameters

            List<NameValuePair> queryParamsPOST = new ArrayList<NameValuePair>();

            queryParamsPOST.add(SUBMIT_PARAM);

            addNameValuePairTo(queryParamsPOST, QUERY_PARAM_NAME, xmlOutputString);

            UrlEncodedFormEntity httpEntity = new UrlEncodedFormEntity(queryParamsPOST);

            //Query provider

            logger.debug("Querying BioCASE service with " + endPoint + ", POST: " + queryParamsPOST);

            //FIXME do the ABCD import here

            return executeHttpPost(endPoint, null, httpEntity);

        }

        else{

            logger.error("Querying " + endPoint + " got a timeout!");

            return null;

        }

    }

    public String parseAbcdSchemaVersion(InputStream inputStream){

        String errorMessage = "Unable to parse ABCD version.";

        String schemaVersion = null;

        DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();

        DocumentBuilder builder;

        try {

            builder = factory.newDocumentBuilder();

            org.w3c.dom.Document document = builder.parse(inputStream);

            Element root = document.getDocumentElement();

            NodeList supportedSchemasList = root.getElementsByTagName("biocase:SupportedSchemas");

            if(supportedSchemasList!=null){

                for(int i=0;i<supportedSchemasList.getLength();i++){

                    Node supportedSchema = supportedSchemasList.item(i);

                    if(supportedSchema instanceof Element){

                        schemaVersion = ((Element) supportedSchema).getAttribute("namespace");

                    }

                }

            }

        } catch (ParserConfigurationException e) {

            logger.error(errorMessage, e);

        } catch (SAXException e) {

            logger.error(errorMessage, e);

        } catch (IOException e) {

            logger.error(errorMessage, e);

        }

        return schemaVersion;

    }

    public List<SpecimenOrObservationBase<?>> dummyData(){

        List<SpecimenOrObservationBase<?>> results = new ArrayList<SpecimenOrObservationBase<?>>();

        DerivedUnitFacade unit1 = DerivedUnitFacade.NewInstance(SpecimenOrObservationType.PreservedSpecimen);

//        newInstance.setTitleCache("Test Specimen", true);

        unit1.setCollectingMethod("Collected from the ground");

        unit1.setAccessionNumber("ACC-12345");

        unit1.setLocality("locality");

        unit1.setCountry(NamedArea.EUROPE());

        DerivedUnitFacade unit2 = DerivedUnitFacade.NewInstance(SpecimenOrObservationType.PreservedSpecimen);

        unit1.setTitleCache("Test Specimen 2", false);

        unit2.setCollectingMethod("Collected from the ground");

        unit2.setAccessionNumber("ACC-67890");

        unit2.setLocality("solid ground close to car park");

        unit2.setCountry(NamedArea.EUROPE());

        results.add(unit1.innerDerivedUnit());

        results.add(unit2.innerDerivedUnit());

        return results;

    }

    /**

     * @param query

     * @param endPoint

     * @return

     */

    public InputStream querySiblings(OccurenceQuery query, URI endPoint) throws ClientProtocolException, IOException{

        if(endPoint==null){

            logger.warn("URI for querying was null.");

            return null;

        }

        if(UriUtils.isServiceAvailable(endPoint, 10000)){

            //check capabilities for ABCD version

            Map<String, String> requestHeaders = new HashMap<String, String>();

            requestHeaders.put(CAPABILITY_TEST_PARAM.getName(), CAPABILITY_TEST_PARAM.getValue());

            InputStream response = executeHttpGet(endPoint, requestHeaders);

            String abcdSchema = parseAbcdSchemaVersion(response);

            //build XML query

            Document doc = BioCaseQueryGenerator.generateXMLQueryForSiblings(query, abcdSchema);

            String xmlOutputString = new XMLOutputter(Format.getPrettyFormat()).outputString(doc);

            //POST parameters

            List<NameValuePair> queryParamsPOST = new ArrayList<NameValuePair>();

            queryParamsPOST.add(SUBMIT_PARAM);

            addNameValuePairTo(queryParamsPOST, QUERY_PARAM_NAME, xmlOutputString);

            UrlEncodedFormEntity httpEntity = new UrlEncodedFormEntity(queryParamsPOST);

            //Query provider

            logger.debug("Querying BioCASE service with " + endPoint + ", POST: " + queryParamsPOST);

            //FIXME do the ABCD import here

            return executeHttpPost(endPoint, null, httpEntity);

        }

        else{

            logger.error("Querying " + endPoint + " got a timeout!");

            return null;

        }

    }

}