D-Net

package eu.dnetlib.openaire.exporter;

import java.io.IOException;

import java.io.OutputStream;

import java.io.StringReader;

import java.text.SimpleDateFormat;

import java.util.Date;

import java.util.List;

import java.util.Map;

import javax.servlet.ServletOutputStream;

import javax.servlet.ServletResponse;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import javax.xml.ws.wsaddressing.W3CEndpointReference;

import org.antlr.stringtemplate.StringTemplate;

import org.apache.commons.io.IOUtils;

import org.apache.commons.lang.StringUtils;

import org.apache.commons.logging.Log;

import org.apache.commons.logging.LogFactory;

import org.dom4j.Document;

import org.dom4j.io.SAXReader;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.beans.factory.annotation.Value;

import org.springframework.core.io.Resource;

import org.springframework.stereotype.Controller;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RequestParam;

import com.google.common.base.Joiner;

import com.google.common.base.Splitter;

import com.google.common.collect.Lists;

import com.google.common.collect.Maps;

import eu.dnetlib.enabling.database.rmi.DatabaseService;

import eu.dnetlib.enabling.locators.UniqueServiceLocator;

import eu.dnetlib.enabling.resultset.client.IterableResultSetClient;

import eu.dnetlib.enabling.resultset.client.ResultSetClientFactory;

import eu.dnetlib.miscutils.collections.MappedCollection;

import eu.dnetlib.miscutils.functional.xml.ApplyXslt;

@Controller

public class ProjectsController {

	private enum Funding {

		FP7, WT, FCT, H2020, NHMRC, ARC

	}

	@javax.annotation.Resource

	private UniqueServiceLocator serviceLocator;

	@Value("${dnet.openaire.db.name}")

	private String dbName;

	@Value("${openaire.exporter.dspace.xslt}")

	private Resource dspaceXslt;

	@Value("${openaire.exporter.eprints.xslt}")

	private Resource eprintsXslt;

	@Value("${openaire.exporter.projectsfundings.sql.template}")

	private Resource projectsFundingQueryTemplate;

	@Value("${openaire.exporter.projects2tsv.sql.template}")

	private Resource projects2tsvQueryTemplate;

	@Value("${openaire.exporter.projects2tsv.fields}")

	private String tsvFields;

	@Autowired

	private ResultSetClientFactory resultSetClientFactory;

	@Autowired

	private ProjectQueryParamsFactory projectQueryParamsFactory;

	private static final Log log = LogFactory.getLog(ProjectsController.class); // NOPMD by marko on 11/24/08 5:02 PM

	@RequestMapping(value = "/openaire/export/**/project/dspace.do")

	void processDspace(final HttpServletRequest request,

			final ServletResponse response,

			@RequestParam(value = "startFrom", required = false) final String startFrom,

			@RequestParam(value = "startUntil", required = false) final String startUntil,

			@RequestParam(value = "endFrom", required = false) final String endFrom,

			@RequestParam(value = "endUntil", required = false) final String endUntil) throws Exception {

		response.setContentType("text/xml");

		ProjectQueryParams params = projectQueryParamsFactory.generateParams(request, startFrom, startUntil, endFrom, endUntil);

		ServletOutputStream out = response.getOutputStream();

		String head = "<?xml version='1.0' encoding='UTF-8'?>\n\n" + "<form-value-pairs>\n" + "	<value-pairs value-pairs-name='" + params.getFundingProgramme()

				+ "projects' dc-term='relation'>\n";

		String tail = "	</value-pairs>\n" + "</form-value-pairs>\n";

		IOUtils.copy(new StringReader(head), out);

		emit(out, dspaceXslt, obtainQuery(params));

		IOUtils.copy(new StringReader(tail), out);

	}

	@RequestMapping(value = "/openaire/export/**/project/eprints.do")

	void processEprints(final HttpServletRequest request,

			final ServletResponse response,

			@RequestParam(value = "startFrom", required = false) final String startFrom,

			@RequestParam(value = "startUntil", required = false) final String startUntil,

			@RequestParam(value = "endFrom", required = false) final String endFrom,

			@RequestParam(value = "endUntil", required = false) final String endUntil) throws Exception {

		response.setContentType("text/html");

		emit(response.getOutputStream(), eprintsXslt, obtainQuery(projectQueryParamsFactory.generateParams(request, startFrom, startUntil, endFrom, endUntil)));

	}

	@RequestMapping(value = "/openaire/export/project2tsv.do")

	void processTsv(final HttpServletRequest request, final HttpServletResponse response,

			@RequestParam(value = "funding", required = true) final String funding,

			@RequestParam(value = "article293", required = false) final Boolean article293) throws Exception {

		final String date = new SimpleDateFormat("yyyyMMdd").format(new Date());

		response.setContentType("text/tab-separated-values");

		response.setHeader("Content-Disposition", "attachment; filename=\"projects_" + funding + "_" + date + ".tsv\"");

		final StringTemplate st = new StringTemplate(IOUtils.toString(projects2tsvQueryTemplate.getInputStream()));

		Funding requestedFunding = Funding.valueOf(funding.toUpperCase());

		String fundingPrefix = getFundingPrefix(requestedFunding, null);

		log.debug("Setting fundingprefix to " + fundingPrefix);

		st.setAttribute("fundingprefix", fundingPrefix);

		st.setAttribute("filters", expandFilters(article293));

		emitAsTsv(response.getOutputStream(), st.toString());

	}

	private Map<String, String> expandFilters(final Boolean article293) {

		final Map<String, String> res = Maps.newHashMap();

		if (article293 != null) {

			res.put("pr.ec_article29_3", String.valueOf(article293));

		}

		return res;

	}

	/**

	 * Creates the query on the fundingProgramme specified in the given parameters.

	 *

	 * @param params

	 *            request parameters

	 * @return the query string

	 * @throws IllegalArgumentException

	 *             if the funding program is not recognized

	 * @throws IOException

	 *             if there are problem loading the query temlate

	 * @throws IllegalArgumentException

	 *             if the funding program is not recognized

	 */

	protected String obtainQuery(final ProjectQueryParams params) throws IllegalArgumentException, IOException {

		String funding = params.getFundingProgramme();

		String suffix = params.getFundingPath();

		String fundingPrefix = getFundingPrefix(Funding.valueOf(funding.toUpperCase()), suffix);

		final StringTemplate st = new StringTemplate(IOUtils.toString(projectsFundingQueryTemplate.getInputStream()));

		st.setAttribute("fundingprefix", fundingPrefix);

		String theQuery = setDateParameters(st.toString(), params);

		log.debug("Generated query: " + theQuery);

		return theQuery;

	}

	private String getFundingPrefix(final Funding funding, final String suffix) throws IllegalArgumentException {

		switch (funding) {

		case FCT:

			if (StringUtils.isBlank(suffix)) return "fct_________::FCT::";

			else return "fct_________::FCT::" + suffix;

		case WT:

			if (StringUtils.isBlank(suffix)) return "wt__________::WT::";

			else return "wt__________::WT::" + suffix;

		case FP7:

			if (StringUtils.isBlank(suffix)) return "ec__________::EC::FP7::";

			else return "ec__________::EC::FP7::" + suffix;

		case H2020:

			if (StringUtils.isBlank(suffix)) return "ec__________::EC::H2020";

			else return "ec__________::EC::H2020" + suffix;

		case NHMRC:

			if (StringUtils.isBlank(suffix)) return "nhmrc_______::NHMRC::";

			else return "nhmrc_______::NHMRC::" + suffix;

		case ARC:

			if (StringUtils.isBlank(suffix)) return "arc_________::ARC::";

			else return "arc_________::ARC::" + suffix;

		default:

			throw new IllegalArgumentException("Invalid funding " + funding + " (valid are: FP7, H2020, WT, FCT, NHMRC, ARC)");

		}

	}

	void emit(final OutputStream out, final Resource xslt, final String query) throws IOException {

		W3CEndpointReference epr = serviceLocator.getService(DatabaseService.class).searchSQL(dbName, query);

		IterableResultSetClient iter = resultSetClientFactory.getClient(epr);

		for (String s : new MappedCollection<String, String>(iter, new ApplyXslt(xslt))) {

			out.write(s.getBytes());

		}

	}

	void emitAsTsv(final OutputStream out, final String query) throws Exception {

		W3CEndpointReference epr = serviceLocator.getService(DatabaseService.class).searchSQL(dbName, query);

		final List<String> fields = Lists.newArrayList(Splitter.on(",").omitEmptyStrings().trimResults().split(tsvFields));

		writeCSVLine(out, fields);

		final SAXReader reader = new SAXReader();

		for (String s : resultSetClientFactory.getClient(epr)) {

			final Document doc = reader.read(new StringReader(s));

			final List<String> list = Lists.newArrayList();

			for (String f : fields) {

				list.add(doc.valueOf("//FIELD[@name='" + f + "']").replaceAll("\\n|\\t", " ").replaceAll("\\s+", " ").trim());

			}

			writeCSVLine(out, list);

		}

		out.flush();

	}

	private void writeCSVLine(final OutputStream out, final List<String> list) throws Exception {

		out.write(Joiner.on('\t').useForNull("").join(list).getBytes());

		out.write('\n');

	}

	private String setDateParameters(final String query, final ProjectQueryParams params) {

		String queryWithDates = query;

		if (params.getStartFrom() != null) {

			queryWithDates += " AND p.startdate >= '" + params.getStartFrom() + "'";

		}

		if (params.getStartUntil() != null) {

			queryWithDates += " AND p.startdate <= '" + params.getStartUntil() + "'";

		}

		if (params.getEndFrom() != null) {

			queryWithDates += " AND p.enddate >= '" + params.getEndFrom() + "'";

		}

		if (params.getEndUntil() != null) {

			queryWithDates += " AND p.enddate <= '" + params.getEndUntil() + "'";

		}

		return queryWithDates;

	}

	public String getDbName() {

		return dbName;

	}

	public void setDbName(final String dbName) {

		this.dbName = dbName;

	}

	public Resource getDspaceXslt() {

		return dspaceXslt;

	}

	public void setDspaceXslt(final Resource dspaceXslt) {

		this.dspaceXslt = dspaceXslt;

	}

	public Resource getEprintsXslt() {

		return eprintsXslt;

	}

	public void setEprintsXslt(final Resource eprintsXslt) {

		this.eprintsXslt = eprintsXslt;

	}

	public ProjectQueryParamsFactory getProjectQueryParamsFactory() {

		return projectQueryParamsFactory;

	}

	public void setProjectQueryParamsFactory(final ProjectQueryParamsFactory projectQueryParamsFactory) {

		this.projectQueryParamsFactory = projectQueryParamsFactory;

	}

	public Resource getProjectsFundingQueryTemplate() {

		return projectsFundingQueryTemplate;

	}

	public void setProjectsFundingQueryTemplate(final Resource projectsFundingQueryTemplate) {

		this.projectsFundingQueryTemplate = projectsFundingQueryTemplate;

	}

	public Resource getProjects2tsvQueryTemplate() {

		return projects2tsvQueryTemplate;

	}

	public void setProjects2tsvQueryTemplate(final Resource projects2tsvQueryTemplate) {

		this.projects2tsvQueryTemplate = projects2tsvQueryTemplate;

	}

}