gov.nasa.pds.search.PDSSearchProtocol Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of registry Show documentation
The Registry provides provides the PDS-specific search protocol and the search capability for the PDS search index generated through the Search Core software. The core functionality for this service is satisfied by Apache Solr.
The newest version!
// Copyright 2019, California Institute of Technology ("Caltech").
// U.S. Government sponsorship acknowledged.
//
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// * Redistributions must reproduce the above copyright notice, this list of
// conditions and the following disclaimer in the documentation and/or other
// materials provided with the distribution.
// * Neither the name of Caltech nor its operating division, the Jet Propulsion
// Laboratory, nor the names of its contributors may be used to endorse or
// promote products derived from this software without specific prior written
// permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.

package gov.nasa.pds.search;

import java.util.logging.Logger;

import org.apache.solr.common.params.ModifiableSolrParams;
import org.apache.solr.handler.component.SearchHandler;
import org.apache.solr.request.SolrQueryRequest;
import org.apache.solr.response.SolrQueryResponse;

import gov.nasa.pds.search.util.XssUtils;

/**
 * @author pramirez
 * @author jpadams
 * 
 */
public class PDSSearchProtocol extends SearchHandler {
	private Logger LOG = Logger.getLogger(this.getClass().getName());

	public final static String[] MULTI_PARAMS = { "identifier", "instrument", "instrument-host", "instrument-host-type",
			"instrument-type", "investigation", "observing-system", "person", "product-class", "target", "target-type",
			"title" };
	public final static String QUERY_PARAM = "q";
	public final static String START_TIME_PARAM = "start-time";
	public final static String STOP_TIME_PARAM = "stop-time";
	public final static String TERM_PARAM = "term";
	public final static String ARCHIVE_STATUS_PARAM = "archive-status";
	public final static String RETURN_TYPE_PARAM = "return-type";
	public final static String VOTABLE = "votable";


	@Override
	public void handleRequestBody(SolrQueryRequest request, SolrQueryResponse response) throws Exception {
		ModifiableSolrParams pdsParams = new ModifiableSolrParams(request.getParams());
		request.setParams(pdsParams);

		/** Query string that will be returned as response **/
		StringBuilder queryString = new StringBuilder();

		int start = 0;

		// Handle multi valued parameters
		for (String parameter : MULTI_PARAMS) {
			if (request.getOriginalParams().getParams(parameter) != null) {

				start = queryString.length();

				// Loop through and add in the identifier to the query string
				for (String value : request.getOriginalParams().getParams(parameter)) {
					if (!value.trim().isEmpty()) {
						queryString.append(parameter);
						queryString.append(":");
						queryString.append(XssUtils.clean(value));
						queryString.append(" OR ");
					}
				}
				// Remove the last OR
				queryString.delete(queryString.length() - 4, queryString.length());

				if (request.getOriginalParams().getParams(parameter).length > 1) {
					queryString.insert(start, "(");
					queryString.append(")");
				}
				queryString.append(" AND ");
			}
		}

		// Remove the last AND
		if (queryString.length() != 0) {
			queryString.delete(queryString.length() - 5, queryString.length());
		}

		// Handle start time
		if (request.getOriginalParams().getParams(START_TIME_PARAM) != null) {
			// if there is already a portion of the query string group with AND
			if (queryString.length() != 0) {
				queryString.append(" AND ");
			}
			queryString.append(START_TIME_PARAM);
			queryString.append(":");
			queryString.append(XssUtils.clean(request.getOriginalParams().getParams(START_TIME_PARAM)[0]));
		}

		// Handle stop time
		if (request.getOriginalParams().getParams(STOP_TIME_PARAM) != null) {
			// if there is already a portion of the query string group with AND
			if (queryString.length() != 0) {
				queryString.append(" AND ");
			}
			queryString.append(STOP_TIME_PARAM);
			queryString.append(":");
			queryString.append(XssUtils.clean(request.getOriginalParams().getParams(STOP_TIME_PARAM)[0]));
		}

		if (request.getOriginalParams().getParams(ARCHIVE_STATUS_PARAM) != null) {
			// if there is already a portion of the query string group with AND
			if (queryString.length() != 0) {
				queryString.append(" AND ");
			}
			queryString.append(ARCHIVE_STATUS_PARAM);
			queryString.append(":");
			queryString.append(XssUtils.clean(request.getOriginalParams().getParams(ARCHIVE_STATUS_PARAM)[0]));
		}

		// Handle terms
		if (request.getOriginalParams().getParams(TERM_PARAM) != null) {
			// if there is already a portion of the query string group with AND
			if (queryString.length() != 0) {
				queryString.append(" ");
			}
			queryString.append(XssUtils.clean(request.getOriginalParams().getParams(TERM_PARAM)[0]));
		}

		// Handle query by appending to query string.
		if (request.getOriginalParams().getParams(QUERY_PARAM) != null) {
			// if there is already a portion of the generic query string
			if (queryString.length() != 0) {
				queryString.append(" ");
			}

			// If query parameter contains OR then surround in parentheses
			if (request.getOriginalParams().getParams(QUERY_PARAM)[0].toLowerCase().matches("[^\\(]* or [^\\)]*")) {
				queryString.append("(");
				queryString.append(XssUtils.clean(request.getOriginalParams().getParams(QUERY_PARAM)[0]));
				queryString.append(")");
			} else {
				queryString.append(XssUtils.clean(request.getOriginalParams().getParams(QUERY_PARAM)[0]));
			}
		}

		// If there is a query pass it onto Solr as the q param
		if (queryString.length() > 0) {
			pdsParams.remove("q");
			pdsParams.add("q", queryString.toString());
		}

		// Handle return type maps to Solrs wt param
		if (request.getOriginalParams().getParams(RETURN_TYPE_PARAM) != null) {
			String returnType = request.getOriginalParams().getParams(RETURN_TYPE_PARAM)[0];
			pdsParams.remove("wt");
			if (VOTABLE.equals(returnType)) {
				// Use Solr's Velocity Response Writer
				pdsParams.add("wt", "velocity");
				// Use votable.vm for the response style
				pdsParams.add("v.layout", "votable");
				// Use the results.vm to format the result set
				pdsParams.add("v.template", "results");
			} else {
				// Just use Solr's default response writers
				pdsParams.add("wt", XssUtils.clean(request.getOriginalParams().getParams(RETURN_TYPE_PARAM)[0]));
			}
		}

		this.LOG.info("Solr Query String: " + queryString);

		super.handleRequestBody(request, response);
	}

}