uri-resolver/src/main/java/org/gcube/datatransfer/resolver/catalogue/CatalogueResolver.java

412 lines
13 KiB
Java

/**
*
*/
package org.gcube.datatransfer.resolver.catalogue;
import java.io.IOException;
import java.io.StringReader;
import java.io.UnsupportedEncodingException;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.commons.codec.binary.Base64;
import org.apache.commons.httpclient.HttpStatus;
import org.apache.commons.io.IOUtils;
import org.gcube.common.encryption.StringEncrypter;
import org.gcube.common.scope.api.ScopeProvider;
import org.gcube.datatransfer.resolver.UriResolverRewriteFilter;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* The Class GisResolver.
*
* @author Francesco Mangiacrapa francesco.mangiacrapa@isti.cnr.it
* Jan 7, 2016
*/
public class CatalogueResolver extends HttpServlet{
private static final long serialVersionUID = -8273405286016095823L;
private static final String TEXT_PALIN_CHARSET_UTF_8 = "text/plain;charset=UTF-8";
public static final String UTF_8 = "UTF-8";
public static final String CATALOGUE_LINK_PARAM = UriResolverRewriteFilter.PARAMETER_CATALOGUE_LINK;
private static final String PATH_SEPARATOR = "/";
public static final String PARAMETER_PATH = "path";
public static final String ENV_SCOPE = "SCOPE"; //Environment Variable
/** The logger. */
private static final Logger logger = LoggerFactory.getLogger(CatalogueResolver.class);
/** The scope to enc decr. */
private String scopeToEncDecr = null;
/* (non-Javadoc)
* @see javax.servlet.GenericServlet#init()
*/
@Override
public void init() throws ServletException {
initScopeFromEnv();
}
/**
* Inits the scope from env.
*
* @return the string
* @throws ServletException the servlet exception
*/
private String initScopeFromEnv() throws ServletException{
if(scopeToEncDecr!=null)
return scopeToEncDecr;
scopeToEncDecr = System.getenv(ENV_SCOPE);
logger.info("Reading Environment Variable "+ENV_SCOPE+" to get the scope for encrypt/descrypt");
if(scopeToEncDecr == null || scopeToEncDecr.isEmpty())
throw new ServletException(CatalogueResolver.class.getName() +" cannot work without set the Environment Variable: "+ENV_SCOPE);
return scopeToEncDecr;
}
/* (non-Javadoc)
* @see javax.servlet.http.HttpServlet#doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
*/
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
//ScopeProvider.instance.set(scope);
String catalogueQueryLink = req.getParameter(CATALOGUE_LINK_PARAM);
logger.info("Trying to decode encoded catalogue query link: "+catalogueQueryLink);
if(catalogueQueryLink==null || catalogueQueryLink.isEmpty()){
logger.error("Data Catalogue Link is malformed, set "+CATALOGUE_LINK_PARAM+" parameter");
sendError(resp, HttpStatus.SC_BAD_REQUEST, "Data Catalogue Link is malformed, set "+CATALOGUE_LINK_PARAM+" parameter");
return;
}
String base64DecodedId = "";
String decryptedDCId = "";
try {
base64DecodedId = base64DecodeString(catalogueQueryLink);
logger.info("Base 64 decoded Data Catalogue Link: "+base64DecodedId +", now decrypting...");
if(scopeToEncDecr==null)
initScopeFromEnv();
ScopeProvider.instance.set(scopeToEncDecr);
decryptedDCId = StringEncrypter.getEncrypter().decrypt(base64DecodedId);
logger.info("Decrypted Data Catalogue Link: "+decryptedDCId);
}catch (Exception e) {
logger.error("An error occurred during decrypting data catalogue link: "+base64DecodedId+", using the scope: "+scopeToEncDecr, e);
sendError(resp, HttpStatus.SC_INTERNAL_SERVER_ERROR, "The system cannot decrypt the Catalogue Link");
return;
}
CatalogueEntityRequest cer = new CatalogueEntityRequest();
for (CatalogueRequestParameter parameter : CatalogueRequestParameter.values()) {
String value = getValueOfParameter(parameter.getKey(), decryptedDCId);
cer.addParameterToRequest(parameter.getKey(), value);
}
logger.debug("Read parameters: "+cer.toString());
String scope = cer.getValueOfParameter(CatalogueRequestParameter.GCUBE_SCOPE.getKey());
if(scope==null || scope.isEmpty()){
logger.error("An error occurred during resolving data catalogue link: "+base64DecodedId+", the scope to search CKan Portlet is null or empty");
sendError(resp, HttpStatus.SC_INTERNAL_SERVER_ERROR, "The system cannot resolve the Catalogue Link, the scope is null or empty");
return;
}
String ckanPorltetUrl = "";
try{
logger.info("Using scope "+scope+ " to search Ckan Portlet URL from IS");
ScopeProvider.instance.set(scope);
ckanPorltetUrl = CkanPorltetApplicationProfile.getPortletUrlFromInfrastrucure();
if(ckanPorltetUrl == null || ckanPorltetUrl.isEmpty()){
sendError(resp, HttpStatus.SC_INTERNAL_SERVER_ERROR, "An error occurred during discovery Data Catalogue URL, try again later");
return;
}
}catch(Exception e){
logger.error("An error occurred during discovery Data Catalogue URL: ",e);
sendError(resp, HttpStatus.SC_INTERNAL_SERVER_ERROR, "An error occurred during discovery Data Catalogue URL, try again later");
return;
}
//UrlEncoderUtil.encodeQuery(cer.getParameters());
String buildPath = PARAMETER_PATH +"=";
buildPath+= PATH_SEPARATOR+cer.getValueOfParameter(CatalogueRequestParameter.ENTITY_CONTEXT.getKey()) + PATH_SEPARATOR;
buildPath+=cer.getValueOfParameter(CatalogueRequestParameter.ENTITY_NAME.getKey());
String finalUrl = ckanPorltetUrl+"?"+buildPath;
logger.info("Builded final URL: "+finalUrl);
resp.sendRedirect(resp.encodeRedirectURL(finalUrl));
}
/* (non-Javadoc)
* @see javax.servlet.http.HttpServlet#doPost(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
*/
@Override
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
CatalogueEntityRequest cer = new CatalogueEntityRequest();
String originalScope = null;
try{
String jsonRequest = IOUtils.toString(req.getInputStream());
logger.debug("Read json request: "+jsonRequest);
JSONObject inputJson = new JSONObject(jsonRequest);
for (CatalogueRequestParameter parameter : CatalogueRequestParameter.values()) {
try{
switch (parameter) {
case QUERY_STRING:
//TODO must be implemented
JSONArray queryString = inputJson.getJSONArray(parameter.getKey());
break;
default:
String value = inputJson.getString(parameter.getKey());
logger.debug("Read value: "+value+", for parameter: "+parameter.getKey());
cer.addParameterToRequest(parameter.getKey(), value);
break;
}
}catch(Exception e){
String error = "";
try {
if(parameter.isMandatory()){
error = parameter.getKey() +" not found";
sendError(resp, HttpStatus.SC_BAD_REQUEST, error);
return;
}
else
logger.debug("Not Mandatory parameter: "+parameter.getKey()+", not found, I goes on");
}catch (IOException e1) {
//silent
}
}
}
}catch(JSONException e){
try {
logger.error("Json passed is malformed: ", e);
sendError(resp, HttpStatus.SC_BAD_REQUEST, "Json passed is malformed");
}
catch (IOException e1) {
//silent
}
return;
}
try{
//CHECK IF INPUT SCOPE IS VALID
String scope = cer.getValueOfParameter(CatalogueRequestParameter.GCUBE_SCOPE.getKey());
if(!scope.startsWith("/")){
logger.info("Scope not start with char '/' adding it");
scope+="/"+scope;
cer.addParameterToRequest(CatalogueRequestParameter.GCUBE_SCOPE.getKey(), scope);
}
originalScope = ScopeProvider.instance.get();
logger.info("Using scope "+scopeToEncDecr+ " from env to get encrypt key");
ScopeProvider.instance.set(scopeToEncDecr);
String buildLink = getServerURL(req);
buildLink += req.getRequestURI();
//String query = UrlEncoderUtil.encodeQuery(cer.getParameters());
String query = "";
for (String key : cer.getParameters().keySet()) {
query+=key+"="+ cer.getParameters().get(key) +"&";
}
query = UrlEncoderUtil.removeLastChar(query);
logger.info("Builded query string: "+query);
String encriptedQuery = StringEncrypter.getEncrypter().encrypt(query);
logger.info("Encrypted query: "+encriptedQuery);
String encodedQuery = base64EncodeStringURLSafe(encriptedQuery);
logger.info("Catalogue Query Link: "+encodedQuery);
buildLink+=PATH_SEPARATOR+encodedQuery;
logger.info("Writing Catalogue Link: "+buildLink);
resp.setContentType(TEXT_PALIN_CHARSET_UTF_8);
resp.setCharacterEncoding(UTF_8);
resp.getWriter().write(buildLink);
}catch(Exception e){
try {
logger.error("An internal error is occurred: ", e);
sendError(resp, HttpStatus.SC_INTERNAL_SERVER_ERROR, "An error occurred during generating Data Catalogue Link, try again later");
return;
}
catch (IOException e1) {
//silent
}
}finally{
if(originalScope!=null && !originalScope.isEmpty()){
ScopeProvider.instance.set(originalScope);
logger.info("scope provider setted to orginal scope: "+originalScope);
}else{
ScopeProvider.instance.reset();
logger.info("scope provider reset");
}
}
}
/**
* Send error.
*
* @param response the response
* @param status the status
* @param message the message
* @throws IOException Signals that an I/O exception has occurred.
*/
protected static void sendError(HttpServletResponse response, int status, String message) throws IOException{
logger.error("error message: "+message);
logger.info("writing response...");
if(response==null)
return;
response.setStatus(status);
StringReader sr = new StringReader(message);
IOUtils.copy(sr, response.getOutputStream());
logger.info("response writed");
response.flushBuffer();
}
/**
* Gets the server url.
*
* @param req the req
* @return the server url
*/
public String getServerURL(HttpServletRequest req) {
String scheme = req.getScheme(); // http
String serverName = req.getServerName(); // hostname.com
int serverPort = req.getServerPort(); // 80
//String contextPath = req.getContextPath(); // /mywebapp
// Reconstruct original requesting URL
StringBuffer url = new StringBuffer();
url.append(scheme).append("://").append(serverName);
if (serverPort != 80 && serverPort != 443)
url.append(":").append(serverPort);
// if(contextPath!=null)
// url.append(":").append(contextPath);
String uToS = url.toString();
logger.debug("returning servlet context URL: "+uToS);
return uToS;
}
/**
* Gets the value of parameter in the passed query string, null otherwise
*
* @param parameter the parameter
* @param httpQueryString the http query string
* @return the value of parameter if exists, null otherwise
*/
public static String getValueOfParameter(String parameter, String httpQueryString) {
// logger.trace("finding: "+wmsParam +" into "+url);
int index = httpQueryString.toLowerCase().indexOf(parameter.toLowerCase()+"="); //ADDING CHAR "=" IN TAIL TO BE SECURE IT IS A PARAMETER
// logger.trace("start index of "+wmsParam+ " is: "+index);
String value = "";
if(index > -1){
int start = index + parameter.length()+1; //add +1 for char '='
String sub = httpQueryString.substring(start, httpQueryString.length());
int indexOfSeparator = sub.indexOf("&");
int end = indexOfSeparator!=-1?indexOfSeparator:sub.length();
value = sub.substring(0, end);
}else
return null;
// logger.trace("return value: "+value);
return value;
}
/**
* Base64 encode string url safe.
*
* @param s the s
* @return the string
*/
public static String base64EncodeStringURLSafe(String s) {
try {
return Base64.encodeBase64URLSafeString(s.getBytes(UTF_8));
}
catch (UnsupportedEncodingException e) {
logger.error("Failed to decode the String", e);
logger.error("Returning input string: " + s);
return s;
}
}
/**
* Base64 decode string.
*
* @param s the s
* @return the string
*/
public static String base64DecodeString(String s) {
try {
return new String(Base64.decodeBase64(s.getBytes(UTF_8)));
}
catch (UnsupportedEncodingException e) {
logger.error("Failed to decode the String", e);
logger.error("Returning input string: " + s);
return s;
}
}
/**
* The main method.
*
* @param args
* the arguments
*/
public static void main(String[] args) {
// jsonRequest = "{" +
// "\"gcube_scope\" : \"/gcube\"," +
// "\"entity_context\" : \"dataset\"," +
// "\"entity_name\" : \"sarda-sarda\"" +
// "}";
// //String test = "{" +
// // "\"gcube_scope\" : \"/gcube\"," +
// // "\"entity_context\" : \"dataset\"," +
// // "\"entity_name\" : \"sarda-sarda\"," +
// // "\"query\" : {\"key1\" : \"value1\", \"key2\":\"value2\"}" +
//
//
// // "}";
}
}