net.javapla.jawn.server.JawnServlet Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jawn-server Show documentation
Show all versions of jawn-server Show documentation
java-web-planet / jawn - A simple web framework in Java
package net.javapla.jawn.server;
import java.io.IOException;
import java.util.Set;
import java.util.TreeSet;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.google.inject.Injector;
import net.javapla.jawn.core.FrameworkEngine;
import net.javapla.jawn.core.configuration.JawnConfigurations;
import net.javapla.jawn.core.exceptions.InitException;
import net.javapla.jawn.core.http.Context;
import net.javapla.jawn.core.http.Context.Internal2;
import net.javapla.jawn.core.templates.TemplateEngine;
public class JawnServlet extends HttpServlet {
private static final long serialVersionUID = 5010901670613409779L;
protected final Logger logger = LoggerFactory.getLogger(getClass().getName());
private String[] exclusions;
protected final Injector injector;
//protected final ServerBootstrap bootstrapper;
protected final FrameworkEngine engine;
public JawnServlet() {
//TODO instantiating Jawn() instead
// bootstrapper = new ServerBootstrap();
// bootstrapper.boot();
injector = null;//bootstrapper.getInjector();
engine = injector.getInstance(FrameworkEngine.class);
}
@Override
public void init() throws ServletException {
super.init();
config(getServletContext());
}
protected void config(ServletContext servletContext) {
// find paths inside webapp, that are NOT WEB-INF
Set exclusionPaths = findExclusionPaths(servletContext);
// and convert them to an array for fast lookup
exclusions = exclusionPaths.toArray(new String[exclusionPaths.size()]);
logger.debug("Letting the server take care of providing resources from: {}", exclusionPaths);
// either the encoding was set by the user, or we default
//TODO make encoding configurable
// String enc = appContext.getAsString(AppContext.ENCODING);
// if (enc == null) {
// enc = Constants.ENCODING;
// appContext.set(AppContext.ENCODING, enc);
// }
// logger.debug("Setting encoding: " + enc);
// root_controller = filterConfig.getInitParameter("root_controller");
logger.info("Java-web-planet: starting the app in environment: " + injector.getInstance(JawnConfigurations.class).getMode());
}
@Override
protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
final String path = request.getServletPath();
// if (response.isCommitted()) return;
// if (path.isEmpty()) return;
//System.err.println(path + " --------------- " + translateResource(path));
//MTD: filtering resources
//if (translateResource(path) != null) return;
// redirect if the path ends with a slash - URLS cannot end with a slash - they should not do such a thing - why would they?
//if (redirectUrlEndingWithSlash(path, response)) return;
JawnServletContext context = (JawnServletContext) injector.getInstance(Context.class);
context.init(/*servletContext, */request, response);
engine.onRouteRequest((Internal2) context);
}
/**
* Actually sorts the paths, which is not appreciated and not even used anywhere
* @param servletContext2
* @return
*/
private Set findExclusionPaths(ServletContext servletContext) {
Set exclusions = new TreeSet();
// Let other handlers deal with folders that do not reside in the WEB-INF or META-INF
Set resourcePaths = servletContext.getResourcePaths("/");
// This most certainly should not be null!
// It means that the server cannot read files at all
if (resourcePaths == null) throw new InitException("ServletContext cannot read files. Reason is unknown");
resourcePaths.removeIf( path -> path.contains("-INF") || path.contains("-inf"));
// We still need to also remove the views folder from being processed by other handlers
resourcePaths.removeIf( path -> path.contains(TemplateEngine.TEMPLATES_FOLDER));
// Add the remaining paths to exclusions
for (String path : resourcePaths) {
// add leading slash
if (path.charAt(0) != '/')
path = '/' + path;
// remove the last slash
if (path.charAt(path.length()-1) == '/')
path = path.substring(0, path.length()-1);
exclusions.add(path);
}
return exclusions;
}
protected static final boolean redirectUrlEndingWithSlash(final String path, final HttpServletResponse response) throws IOException {
if (path.length() > 1 && path.charAt(path.length()-1) == '/') { //ends with
response.sendRedirect(path.substring(0, path.length()-1));
return true;
}
return false;
}
/**
* Instead of just verifying if a path contains an exclusion, the method returns the exclusion.
* This takes care of some resources being prepended with the language prefix.
* Like:
* http://localhost/da/images/something.jpg
* should be the same as
* http://localhost/en/images/something.jpg,
* http://localhost/images/something.jpg
* @author MTD
*
* @return The full servletPath if can be seen as a resource from any of the exclusions
*/
protected final String translateResource(String servletPath) {
// This looks at the start of the of the URL to check for resource paths in the root webapp.
// Example: exclusions = ['/images','/css','/js,'/favicon.ico']
// servletPath = /images/bootstrap/cursor.gif
//
// It must not interfere with substrings, like so:
// servletPath = /json
// This starts with /js, which is a part of the exclusions, so we need to ensure that either
// the servletPath is exactly the same as the exclusion (like '/favicon.ico')
// or the servletPath has higher length and the next character after the exclusion has to be a separator,
// so we know it is a folder to look up
for (String path : exclusions) {
if ( servletPath.startsWith(path) // startsWith uses its internal array without any copying (fast)
&& (servletPath.length() == path.length() || // they are equal
servletPath.charAt(path.length()) == '/')) // servletPath MUST be larger, and the next char needs to be a separator
return servletPath;
}
//TODO
//Language prefix is no longer used as built-in part of the URL
//The language needs to be explicit specified elsewhere
/*
// If nothing was found, then perhaps the URL had a language prefix
int start = servletPath.indexOf('/',1);
// Do not even try
if (start < 0) return null;
String segment = servletPath.substring(start);
for (String path : exclusions) { // this is most likely faster than Arrays#binarySearch as exclusions is extremely small
if (segment.startsWith(path))
return segment;
}*/
// If we have to look past for more than a single URL segment
/*int start = servletPath.indexOf('/',1), end = start;
String segment;
while (end > -1) { // fail fast
segment = servletPath.substring(start);
for (String path : exclusions) {
if (segment.startsWith(path))
return segment;
}
start = end;
end = servletPath.indexOf('/',start+1);
}*/
return null;
}
@Override
public void destroy() {
// bootstrapper.shutdown();
// appBootstrap.destroy(appContext);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy