common-smartgears/src/main/java/org/gcube/smartgears/managers/RequestManager.java

package org.gcube.smartgears.managers;

import static org.gcube.smartgears.Constants.WILDCARD;
import static org.gcube.smartgears.handlers.application.request.RequestError.application_error;
import static org.gcube.smartgears.handlers.application.request.RequestError.request_not_authorized_error;

import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.stream.Collectors;

import jakarta.servlet.Filter;
import jakarta.servlet.FilterChain;
import jakarta.servlet.FilterConfig;
import jakarta.servlet.ServletException;
import jakarta.servlet.ServletRequest;
import jakarta.servlet.ServletResponse;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;

import org.gcube.common.authorization.library.exception.AuthorizationException;
import org.gcube.smartgears.Constants;
import org.gcube.smartgears.configuration.application.GCubeExclude;
import org.gcube.smartgears.configuration.application.GCubeInclude;
import org.gcube.smartgears.context.application.ApplicationContext;
import org.gcube.smartgears.context.application.DefaultApplicationContext;
import org.gcube.smartgears.handlers.application.ApplicationPipeline;
import org.gcube.smartgears.handlers.application.RequestEvent;
import org.gcube.smartgears.handlers.application.RequestHandler;
import org.gcube.smartgears.handlers.application.ResponseEvent;
import org.gcube.smartgears.handlers.application.request.RequestError;
import org.gcube.smartgears.handlers.application.request.RequestException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * A {@link Filter} that executes a {@link ApplicationPipeline} of {@link RequestHandler}s before and a client request is delivered
 * to a given servlet and before the response produced by the servlet is returned to the client.
 * 
 * @author Fabio Simeoni
 * 
 */
public class RequestManager implements Filter {

	private static Logger log = LoggerFactory.getLogger(RequestManager.class);

	private final ApplicationContext context;
	private final String servlet;
	private final List<RequestHandler> handlers;

	/**
	 * Creates an instance with the name of the target servlet and a pipeline.
	 * 
	 * @param servlet the name of the servlet
	 * @param pipeline the pipeline
	 */
	public RequestManager(ApplicationContext context, String servletName, List<RequestHandler> handlers) {
		this.context = context;
		this.servlet = servletName;
		this.handlers = handlers;
	}

	@Override
	public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException,
	ServletException {

		HttpServletRequest httprequest = (HttpServletRequest) request;
		HttpServletResponse httpresponse = (HttpServletResponse) response;
			
		List<RequestHandler> filterHandlers = getPipelineHandlers(httprequest, handlers);

		if (filterHandlers.isEmpty()){

			log.trace("filtered handlers are empty");

			chain.doFilter(request, response);

		}else {

			ApplicationPipeline<RequestHandler> pipeline = new ApplicationPipeline<RequestHandler>(filterHandlers);

			log.trace("filtered handler for this call are {}", filterHandlers);

			// create a per-request context with temporary properties
			ApplicationContext ctx = new DefaultApplicationContext(context);
			
			RequestEvent event = new RequestEvent(servlet, ctx, httprequest,httpresponse);

			try {
				pipeline.forward(event);
			}
			catch(Throwable t) {
				log.error("error in doFilter, forward",t);
				handleError(httprequest,httpresponse,t);
				return;
			}
			
			try{
				// dispatch to other filters for this servlet
				chain.doFilter(request, response);
			}catch(ServletException t){
				log.error("error in doFilter",t);
				handleError(httprequest,httpresponse,t.getRootCause());
			}
			
	
			ResponseEvent responseEvent = new ResponseEvent(servlet, ctx, httprequest, httpresponse);

			try {

				pipeline.reverse().forward(responseEvent);
			}
			catch(Throwable t) {
				log.error("error in doFilter, reverse",t);
				handleError(httprequest,httpresponse,t);
				return;
			}
						
		}
	}

	private List<RequestHandler> getPipelineHandlers(
			HttpServletRequest request, List<RequestHandler> handlersToFilter) {

		String query = request.getQueryString();

		log.trace("servletPath is {} and pathInfo is {}",request.getServletPath(), request.getPathInfo());

		
		//excludes also mandatory filter for extensions
		if ("wsdl".equals(query) || "wsdl=1".equals(query) || 
				request.getServletPath().equals(Constants.root_mapping))
			return Collections.emptyList();

		
		String path = request.getServletPath()==null?"":request.getServletPath();

		path += request.getPathInfo() ==null?"":request.getPathInfo();

		log.trace("check which handler should be excluded {}", path);

		if (!context.configuration().excludes().isEmpty()) {
			log.debug("excludes are not empty");
			for (GCubeExclude exclude : context.configuration().excludes()){
				String excludePath= exclude.getPath();
				log.debug("exclude is {}",exclude);
				if ((WILDCARD).equals(excludePath) || 
						(excludePath.endsWith(WILDCARD) && path!=null && path.startsWith(excludePath.substring(0,excludePath.length()-2))) ||
						excludePath.equals(path) || (path.endsWith("/") && excludePath.equals(path.substring(0, path.length()-1)))
						){
					//ALL handler are filtered except for unfilterable
					if (exclude.getHandlers().isEmpty()) { 
						List<RequestHandler> unfilterables = handlersToFilter.stream()
						.filter(RequestHandler::isUnfiltrable).collect(Collectors.toList());
						log.trace("exclude handler is empty so unfilterable handlers are {}",unfilterables);
						return handlersToFilter.stream()
							.filter(RequestHandler::isUnfiltrable).collect(Collectors.toList());
					}
					
					List<RequestHandler> filteredHandlers = new ArrayList<>();
					for (RequestHandler rh : handlersToFilter)
						if (rh.isUnfiltrable() || !exclude.getHandlers().contains(rh.getName()))
							filteredHandlers.add(rh);
					
					return filteredHandlers;
				}
			}
		} else	if (!context.configuration().includes().isEmpty()) {
			for (GCubeInclude include : context.configuration().includes()){
				String includePath= include.getPath();
				log.trace("include is {}",include);
				if (
						(WILDCARD).equals(includePath) || 
						(includePath.endsWith(WILDCARD) && path!=null && path.startsWith(includePath.substring(0,includePath.length()-2))) ||
						includePath.equals(path) || (path.endsWith("/") && includePath.equals(path.substring(0, path.length()-1)))
						){
					//ALL handler are used
					if (include.getHandlers().isEmpty()) return handlersToFilter;

					List<RequestHandler> filteredHandlers = new ArrayList<>();
					for (RequestHandler rh : handlersToFilter)
						if (rh.isUnfiltrable() || include.getHandlers().contains(rh.getName()))
							filteredHandlers.add(rh);
					
					return filteredHandlers;
				}
			}
			return new ArrayList<>();
		} 
		log.trace("returning original handlers");
		return handlersToFilter;
	}

	@Override
	public void init(FilterConfig filterConfig) throws ServletException {

		// propagate filter initialisation to handler
		try {

			for (RequestHandler handler : this.handlers)

				handler.start(context);

		} catch (Throwable t) {

			throw new ServletException(t);

		}
	}

	@Override
	public void destroy() {

		for (RequestHandler handler : this.handlers)
			try {

				handler.stop();

			} catch (Throwable t) {

				log.error("cannot terminate handler {} for application {} ", handler, context.name());
			}

	}


	private void handleError(HttpServletRequest request, HttpServletResponse response,Throwable t) throws IOException {
		
		if(t instanceof AuthorizationException) {
			
			response.setStatus(HttpServletResponse.SC_FORBIDDEN);
			response.getWriter().write("Error (Forbidden) : "+t.getMessage()+"\nStacktrace:\n");
			t.printStackTrace(response.getWriter());
			response.flushBuffer();
		
		} else {

			RequestError error = t instanceof RequestException?
					RequestException.class.cast(t).error():
						application_error;

			if (!response.isCommitted())
				response.resetBuffer();		
			if (error == request_not_authorized_error){
				response.setHeader("WWW-Authenticate", "Basic realm=\"Smartgears\"");
				log.info("setting WWW-Authenticate to response header");
			}
			response.setStatus(error.code());
			response.getWriter().write("Error ("+error.code()+") : "+error.message()+"\nStacktrace:\n");
			t.printStackTrace(response.getWriter());
			response.flushBuffer();
		}
	}
}