// YaCyDefaultServlet // Copyright 2013 by Michael Peter Christen; mc@yacy.net, Frankfurt a. M., Germany // First released 2013 at http://yacy.net // // This library is free software; you can redistribute it and/or // modify it under the terms of the GNU Lesser General Public // License as published by the Free Software Foundation; either // version 2.1 of the License, or (at your option) any later version. // // This library is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU // Lesser General Public License for more details. // // You should have received a copy of the GNU Lesser General Public License // along with this program in the file lgpl21.txt // If not, see . // package net.yacy.http; import java.awt.Image; import java.awt.image.BufferedImage; import java.io.BufferedInputStream; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.io.File; import java.io.FileInputStream; import java.io.FileNotFoundException; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import java.lang.ref.SoftReference; import java.lang.reflect.InvocationTargetException; import java.lang.reflect.Method; import java.net.URL; import java.util.Enumeration; import java.util.Iterator; import java.util.List; import java.util.concurrent.ConcurrentHashMap; import javax.servlet.RequestDispatcher; import javax.servlet.ServletContext; import javax.servlet.ServletException; import javax.servlet.UnavailableException; import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import net.yacy.cora.date.GenericFormatter; import net.yacy.cora.document.analysis.Classification; import net.yacy.cora.protocol.HeaderFramework; import net.yacy.cora.protocol.RequestHeader; import net.yacy.cora.util.ConcurrentLog; import net.yacy.kelondro.util.FileUtils; import net.yacy.kelondro.util.MemoryControl; import net.yacy.peers.Seed; import net.yacy.peers.graphics.EncodedImage; import net.yacy.peers.operation.yacyBuildProperties; import net.yacy.search.Switchboard; import net.yacy.search.SwitchboardConstants; import net.yacy.server.http.TemplateEngine; import net.yacy.server.serverClassLoader; import net.yacy.server.serverCore; import net.yacy.server.serverObjects; import net.yacy.server.serverSwitch; import net.yacy.server.servletProperties; import net.yacy.visualization.RasterPlotter; import org.apache.commons.fileupload.FileItem; import org.apache.commons.fileupload.disk.DiskFileItemFactory; import org.apache.commons.fileupload.servlet.ServletFileUpload; import org.eclipse.jetty.http.HttpContent; import org.eclipse.jetty.http.HttpFields; import org.eclipse.jetty.http.MimeTypes; import org.eclipse.jetty.util.URIUtil; import org.eclipse.jetty.util.resource.Resource; import org.eclipse.jetty.util.resource.ResourceFactory; /** * YaCyDefaultServlet based on Jetty DefaultServlet.java * handles static files and the YaCy servlets. * * This interface impements the YaCy specific and standard Servlet routines * which should not have a dependency on the implemented Jetty version. * The Jetty version specific code is moved to the Jetty8HttpServerImpl.java implementation */ /** * The default servlet. This servlet, normally mapped to /, provides the * handling for static content, OPTION and TRACE methods for the context. The * following initParameters are supported, these can be set either on the * servlet itself or as ServletContext initParameters : *
 *  acceptRanges      If true, range requests and responses are
 *                    supported
 *
 *  dirAllowed        If true, directory listings are returned if no
 *                    welcome file is found. Else 403 Forbidden.
 *  
 *  welcomeFile       name of the welcome file (default is "index.html", "welcome.html")
 *
 *  gzip              If set to true, then static content will be served as
 *                    gzip content encoded if a matching resource is
 *                    found ending with ".gz"
 * 
 *  resourceBase      Set to replace the context resource base
 *
 *  resourceCache     If set, this is a context attribute name, which the servlet
 *                    will use to look for a shared ResourceCache instance.
 *
 *  relativeResourceBase
 *                    Set with a pathname relative to the base of the
 *                    servlet context root. Useful for only serving static content out
 *                    of only specific subdirectories.
 *
 *  pathInfoOnly      If true, only the path info will be applied to the resourceBase
 *
 *
 *  etags             If True, weak etags will be generated and handled.
 *
 * 
*/ public abstract class YaCyDefaultServlet extends HttpServlet implements ResourceFactory { private static final long serialVersionUID = 4900000000000001110L; protected ServletContext _servletContext; protected boolean _acceptRanges = true; protected boolean _dirAllowed = true; protected boolean _pathInfoOnly = false; protected boolean _etags = false; protected boolean _gzip = true; protected Resource _resourceBase; protected MimeTypes _mimeTypes; protected String[] _welcomes; protected String _relativeResourceBase; protected File _htLocalePath; protected File _htDocsPath; protected static final serverClassLoader provider = new serverClassLoader(/*this.getClass().getClassLoader()*/); protected ConcurrentHashMap> templateMethodCache = null; /* ------------------------------------------------------------ */ @Override public void init() throws UnavailableException { _htDocsPath = Switchboard.getSwitchboard().htDocsPath; _htLocalePath = Switchboard.getSwitchboard().getDataPath("locale.translated_html", "DATA/LOCALE/htroot"); _servletContext = getServletContext(); _mimeTypes = new MimeTypes(); String tmpstr = this.getServletContext().getInitParameter("welcomeFile"); if (tmpstr == null) { _welcomes = new String[]{"index.html", "welcome.html"}; // set a default welcome file name } else { _welcomes = new String[]{tmpstr,"index.html"}; } _acceptRanges = getInitBoolean("acceptRanges", _acceptRanges); _dirAllowed = getInitBoolean("dirAllowed", _dirAllowed); _pathInfoOnly = getInitBoolean("pathInfoOnly", _pathInfoOnly); _relativeResourceBase = getInitParameter("relativeResourceBase"); String rb = getInitParameter("resourceBase"); if (rb != null) { if (_relativeResourceBase != null) { throw new UnavailableException("resourceBase & relativeResourceBase"); } try { _resourceBase = Resource.newResource(rb); } catch (Exception e) { ConcurrentLog.logException(e); throw new UnavailableException(e.toString()); } } _etags = getInitBoolean("etags", _etags); _gzip=getInitBoolean("gzip",_gzip); if (ConcurrentLog.isFine("YaCyDefaultServlet")) { ConcurrentLog.fine("YaCyDefaultServlet","resource base = " + _resourceBase); } templateMethodCache = new ConcurrentHashMap>(); } /* ------------------------------------------------------------ */ protected boolean getInitBoolean(String name, boolean dft) { String value = getInitParameter(name); if (value == null || value.length() == 0) { return dft; } return (value.startsWith("t") || value.startsWith("T") || value.startsWith("y") || value.startsWith("Y") || value.startsWith("1")); } /* ------------------------------------------------------------ */ /** * get Resource to serve. Map a path to a resource. The default * implementation calls HttpContext.getResource but derived servlets may * provide their own mapping. * * @param pathInContext The path to find a resource for. * @return The resource to serve. */ @Override public Resource getResource(String pathInContext) { Resource r = null; if (_relativeResourceBase != null) { pathInContext = URIUtil.addPaths(_relativeResourceBase, pathInContext); } try { if (_resourceBase != null) { r = _resourceBase.addPath(pathInContext); } else { URL u = _servletContext.getResource(pathInContext); r = Resource.newResource(u); } if (ConcurrentLog.isFine("YaCyDefaultServlet")) { ConcurrentLog.fine("YaCyDefaultServlet","Resource " + pathInContext + "=" + r); } } catch (IOException e) { // ConcurrentLog.logException(e); } return r; } /* ------------------------------------------------------------ */ @Override protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { String servletPath = null; String pathInfo = null; Enumeration reqRanges = null; Boolean included = request.getAttribute(RequestDispatcher.INCLUDE_REQUEST_URI) != null; if (included != null && included.booleanValue()) { servletPath = (String) request.getAttribute(RequestDispatcher.INCLUDE_SERVLET_PATH); pathInfo = (String) request.getAttribute(RequestDispatcher.INCLUDE_PATH_INFO); if (servletPath == null) { servletPath = request.getServletPath(); pathInfo = request.getPathInfo(); } } else { included = Boolean.FALSE; servletPath = _pathInfoOnly ? "/" : request.getServletPath(); pathInfo = request.getPathInfo(); // Is this a Range request? reqRanges = request.getHeaders(HeaderFramework.RANGE); if (!hasDefinedRange(reqRanges)) { reqRanges = null; } } if (pathInfo.startsWith("/currentyacypeer/")) pathInfo = pathInfo.substring(16); String pathInContext = URIUtil.addPaths(servletPath, pathInfo); boolean endsWithSlash = (pathInfo == null ? request.getServletPath() : pathInfo).endsWith(URIUtil.SLASH); // Find the resource and content Resource resource = null; HttpContent content = null; try { String pathofClass = null; // Look for a class resource boolean hasClass = false; if (reqRanges == null && !endsWithSlash) { final int p = pathInContext.lastIndexOf('.'); if (p >= 0) { pathofClass = pathInContext.substring(0, p) + ".class"; resource = getResource(pathofClass); // Does a class resource exist? if (resource != null && resource.exists() && !resource.isDirectory()) { hasClass = true; } } } // find resource resource = getResource(pathInContext); if (ConcurrentLog.isFine("YaCyDefaultServlet")) { ConcurrentLog.fine("YaCyDefaultServlet","uri=" + request.getRequestURI() + " resource=" + resource + (content != null ? " content" : "")); } // Handle resource if (!hasClass && (resource == null || !resource.exists())) { if (included) { throw new FileNotFoundException("!" + pathInContext); } response.sendError(HttpServletResponse.SC_NOT_FOUND); } else if (!resource.isDirectory()) { if (endsWithSlash && pathInContext.length() > 1) { String q = request.getQueryString(); pathInContext = pathInContext.substring(0, pathInContext.length() - 1); if (q != null && q.length() != 0) { pathInContext += "?" + q; } response.sendRedirect(response.encodeRedirectURL(URIUtil.addPaths(_servletContext.getContextPath(), pathInContext))); } else { // ensure we have content if (content == null) { content = new HttpContent.ResourceAsHttpContent(resource, _mimeTypes.getMimeByExtension(resource.toString()), response.getBufferSize(), _etags); } if (hasClass) { // this is a YaCy servlet, handle the template handleTemplate(pathInfo, request, response); } else { if (included.booleanValue() || passConditionalHeaders(request, response, resource, content)) { sendData(request, response, included.booleanValue(), resource, content, reqRanges); } } } } else { if (!endsWithSlash || (pathInContext.length() == 1 && request.getAttribute("org.eclipse.jetty.server.nullPathInfo") != null)) { StringBuffer buf = request.getRequestURL(); synchronized (buf) { int param = buf.lastIndexOf(";"); if (param < 0) { buf.append('/'); } else { buf.insert(param, '/'); } String q = request.getQueryString(); if (q != null && q.length() != 0) { buf.append('?'); buf.append(q); } response.setContentLength(0); response.sendRedirect(response.encodeRedirectURL(buf.toString())); } } else { // look for a welcome file String welcomeFileName = getWelcomeFile (pathInContext); if (welcomeFileName != null) { RequestDispatcher rd = request.getRequestDispatcher(welcomeFileName); if (rd != null) rd.forward(request, response); } else { // send directory listing content = new HttpContent.ResourceAsHttpContent(resource, _mimeTypes.getMimeByExtension(resource.toString()), _etags); if (included.booleanValue() || passConditionalHeaders(request, response, resource, content)) { sendDirectory(request, response, resource, pathInContext); } } } } } catch (IllegalArgumentException e) { ConcurrentLog.logException(e); if (!response.isCommitted()) { response.sendError(500, e.getMessage()); } } finally { if (content != null) { content.release(); } else if (resource != null) { resource.release(); } } } /* ------------------------------------------------------------ */ protected boolean hasDefinedRange(Enumeration reqRanges) { return (reqRanges != null && reqRanges.hasMoreElements()); } /* ------------------------------------------------------------ */ @Override protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { doGet(request, response); } /* ------------------------------------------------------------ */ /* (non-Javadoc) * @see javax.servlet.http.HttpServlet#doTrace(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) */ @Override protected void doTrace(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { resp.sendError(HttpServletResponse.SC_METHOD_NOT_ALLOWED); } /* ------------------------------------------------------------ */ @Override protected void doOptions(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { resp.setHeader("Allow", "GET,HEAD,POST,OPTIONS"); } /* ------------------------------------------------------------ */ /** * Finds a matching welcome file for the supplied path. * The filename to look is set as servlet context init parameter * default is "index.html" * @param path in context * @return The path of the matching welcome file in context or null. */ protected String getWelcomeFile(String pathInContext) { if (_welcomes == null) { return null; } for (int i = 0; i < _welcomes.length; i++) { String welcome_in_context = URIUtil.addPaths(pathInContext, _welcomes[i]); Resource welcome = getResource(welcome_in_context); if (welcome != null && welcome.exists()) { return _welcomes[i]; } } return null; } /* ------------------------------------------------------------ */ /* Check modification date headers. */ abstract protected boolean passConditionalHeaders(HttpServletRequest request, HttpServletResponse response, Resource resource, HttpContent content) throws IOException; /* ------------------------------------------------------------------- */ protected void sendDirectory(HttpServletRequest request, HttpServletResponse response, Resource resource, String pathInContext) throws IOException { if (!_dirAllowed) { response.sendError(HttpServletResponse.SC_FORBIDDEN); return; } byte[] data = null; String base = URIUtil.addPaths(request.getRequestURI(), URIUtil.SLASH); String dir = resource.getListHTML(base, pathInContext.length() > 1); if (dir == null) { response.sendError(HttpServletResponse.SC_FORBIDDEN, "No directory"); return; } data = dir.getBytes("UTF-8"); response.setContentType("text/html; charset=UTF-8"); response.setContentLength(data.length); response.getOutputStream().write(data); } /* ------------------------------------------------------------ */ abstract protected void sendData(HttpServletRequest request, HttpServletResponse response, boolean include, Resource resource, HttpContent content, Enumeration reqRanges) throws IOException; /* ------------------------------------------------------------ */ abstract protected void writeHeaders(HttpServletResponse response, HttpContent content, long count); /* ------------------------------------------------------------ */ protected void writeOptionHeaders(HttpFields fields) { if (_acceptRanges) { fields.put(HeaderFramework.ACCEPT_RANGES, "bytes"); } } /* ------------------------------------------------------------ */ protected void writeOptionHeaders(HttpServletResponse response) { if (_acceptRanges) { response.setHeader(HeaderFramework.ACCEPT_RANGES, "bytes"); } } protected Object invokeServlet(final File targetClass, final RequestHeader request, final serverObjects args) throws IllegalArgumentException, IllegalAccessException, InvocationTargetException { return rewriteMethod(targetClass).invoke(null, new Object[]{request, args, Switchboard.getSwitchboard()}); // add switchboard } protected RequestHeader generateLegacyRequestHeader(HttpServletRequest request, String target, String targetExt) { RequestHeader legacyRequestHeader = new RequestHeader(); @SuppressWarnings("unchecked") Enumeration headers = request.getHeaderNames(); while (headers.hasMoreElements()) { String headerName = headers.nextElement(); @SuppressWarnings("unchecked") Enumeration header = request.getHeaders(headerName); while (header.hasMoreElements()) { legacyRequestHeader.add(headerName, header.nextElement()); } } legacyRequestHeader.put(HeaderFramework.CONNECTION_PROP_CLIENTIP, request.getRemoteAddr()); legacyRequestHeader.put(HeaderFramework.CONNECTION_PROP_PATH, target); legacyRequestHeader.put(HeaderFramework.CONNECTION_PROP_EXT, targetExt); return legacyRequestHeader; } /** * Returns a path to the localized or default file according to the * parameter localeSelection * * @param path relative from htroot * @param localeSelection language of localized file; locale.language from * switchboard is used if localeSelection.equals("") */ public File getLocalizedFile(final String path, final String localeSelection) throws IOException { if (!(localeSelection.equals("default"))) { final File localePath = new File(_htLocalePath, localeSelection + '/' + path); if (localePath.exists()) { return localePath; // avoid "NoSuchFile" troubles if the "localeSelection" is misspelled } } File docsPath = new File(_htDocsPath, path); if (docsPath.exists()) { return docsPath; } return _resourceBase.addPath(path).getFile(); } protected File rewriteClassFile(final File template) { try { String f = template.getCanonicalPath(); final int p = f.lastIndexOf('.'); if (p < 0) { return null; } f = f.substring(0, p) + ".class"; final File cf = new File(f); if (cf.exists()) { return cf; } return null; } catch (final IOException e) { return null; } } protected Method rewriteMethod(final File classFile) throws InvocationTargetException { Method m = null; // now make a class out of the stream try { final SoftReference ref = templateMethodCache.get(classFile); if (ref != null) { m = ref.get(); if (m == null) { templateMethodCache.remove(classFile); } else { return m; } } final Class c = provider.loadClass(classFile); final Class[] params = new Class[]{ RequestHeader.class, serverObjects.class, serverSwitch.class}; m = c.getMethod("respond", params); // store the method into the cache templateMethodCache.put(classFile, new SoftReference(m)); } catch (final ClassNotFoundException e) { ConcurrentLog.severe("YaCyDefaultServlet", "class " + classFile + " is missing:" + e.getMessage()); throw new InvocationTargetException(e, "class " + classFile + " is missing:" + e.getMessage()); } catch (final NoSuchMethodException e) { ConcurrentLog.severe("YaCyDefaultServlet", "method 'respond' not found in class " + classFile + ": " + e.getMessage()); throw new InvocationTargetException(e, "method 'respond' not found in class " + classFile + ": " + e.getMessage()); } return m; } protected void handleTemplate(String target, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException { Switchboard sb = Switchboard.getSwitchboard(); String localeSelection = Switchboard.getSwitchboard().getConfig("locale.language", "default"); File targetFile = getLocalizedFile(target, localeSelection); File targetClass = rewriteClassFile(_resourceBase.addPath(target).getFile()); String targetExt = target.substring(target.lastIndexOf('.') + 1, target.length()); if ((targetClass != null)) { serverObjects args = new serverObjects(); @SuppressWarnings("unchecked") Enumeration argNames = request.getParameterNames(); while (argNames.hasMoreElements()) { String argName = argNames.nextElement(); args.put(argName, request.getParameter(argName)); } //TODO: for SSI request, local parameters are added as attributes, put them back as parameter for the legacy request // likely this should be implemented via httpservletrequestwrapper to supply complete parameters @SuppressWarnings("unchecked") Enumeration attNames = request.getAttributeNames(); while (attNames.hasMoreElements()) { String argName = attNames.nextElement(); args.put(argName, request.getAttribute(argName).toString()); } // add multipart-form fields to parameter if (request.getContentType() != null && request.getContentType().startsWith("multipart/form-data")) { parseMultipart(request, args); } // eof modification to read attribute RequestHeader legacyRequestHeader = generateLegacyRequestHeader(request, target, targetExt); Object tmp; try { tmp = invokeServlet(targetClass, legacyRequestHeader, args); } catch (InvocationTargetException e) { ConcurrentLog.logException(e); throw new ServletException(); } catch (IllegalArgumentException e) { ConcurrentLog.logException(e); throw new ServletException(); } catch (IllegalAccessException e) { ConcurrentLog.logException(e); throw new ServletException(); } if (tmp instanceof RasterPlotter || tmp instanceof EncodedImage || tmp instanceof Image) { net.yacy.cora.util.ByteBuffer result = null; if (tmp instanceof RasterPlotter) { final RasterPlotter yp = (RasterPlotter) tmp; // send an image to client result = RasterPlotter.exportImage(yp.getImage(), "png"); } if (tmp instanceof EncodedImage) { final EncodedImage yp = (EncodedImage) tmp; result = yp.getImage(); } if (tmp instanceof Image) { final Image i = (Image) tmp; // generate an byte array from the generated image int width = i.getWidth(null); if (width < 0) { width = 96; // bad hack } int height = i.getHeight(null); if (height < 0) { height = 96; // bad hack } final BufferedImage bi = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB); bi.createGraphics().drawImage(i, 0, 0, width, height, null); result = RasterPlotter.exportImage(bi, targetExt); } final String mimeType = Classification.ext2mime(targetExt, "text/html"); response.setContentType(mimeType); response.setContentLength(result.length()); response.setStatus(HttpServletResponse.SC_OK); result.writeTo(response.getOutputStream()); return; } servletProperties templatePatterns = null; if (tmp == null) { // if no args given, then tp will be an empty Hashtable object (not null) templatePatterns = new servletProperties(); } else if (tmp instanceof servletProperties) { templatePatterns = (servletProperties) tmp; } else { templatePatterns = new servletProperties((serverObjects) tmp); } // add the application version, the uptime and the client name to every rewrite table templatePatterns.put(servletProperties.PEER_STAT_VERSION, yacyBuildProperties.getVersion()); templatePatterns.put(servletProperties.PEER_STAT_UPTIME, ((System.currentTimeMillis() - serverCore.startupTime) / 1000) / 60); // uptime in minutes templatePatterns.putHTML(servletProperties.PEER_STAT_CLIENTNAME, sb.peers.mySeed().getName()); templatePatterns.putHTML(servletProperties.PEER_STAT_CLIENTID, sb.peers.myID()); templatePatterns.put(servletProperties.PEER_STAT_MYTIME, GenericFormatter.SHORT_SECOND_FORMATTER.format()); Seed myPeer = sb.peers.mySeed(); templatePatterns.put("newpeer", myPeer.getAge() >= 1 ? 0 : 1); templatePatterns.putHTML("newpeer_peerhash", myPeer.hash); templatePatterns.put("p2p", sb.getConfigBool(SwitchboardConstants.DHT_ENABLED, true) || !sb.isRobinsonMode() ? 1 : 0); if (targetFile.exists() && targetFile.isFile() && targetFile.canRead()) { String mimeType = Classification.ext2mime(targetExt, "text/html"); InputStream fis = null; long fileSize = targetFile.length(); if (fileSize <= Math.min(4 * 1024 * 1204, MemoryControl.available() / 100)) { // read file completely into ram, avoid that too many files are open at the same time fis = new ByteArrayInputStream(FileUtils.read(targetFile)); } else { fis = new BufferedInputStream(new FileInputStream(targetFile)); } // set response header response.setContentType(mimeType); response.setStatus(HttpServletResponse.SC_OK); ByteArrayOutputStream bas = new ByteArrayOutputStream(4096); // apply templates TemplateEngine.writeTemplate(fis, bas, templatePatterns, "-UNRESOLVED_PATTERN-".getBytes("UTF-8")); fis.close(); // handle SSI doContentMod (bas.toByteArray(),request,response); } } } protected void doContentMod(final byte[] in, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException { net.yacy.cora.util.ByteBuffer buffer = new net.yacy.cora.util.ByteBuffer(in); OutputStream out = response.getOutputStream(); // remove virtual host "currentyacypeer" int off = 0; // starting offset int x = buffer.indexOf("/currentyacypeer/".getBytes(), off); while (x >= 0) { for (int i = 0; i < 16; i++) { in[x + i] = 32; } off = x + 16; x = buffer.indexOf("/currentyacypeer/".getBytes(), off); } // check and handle SSI (ServerSideIncludes) off = 0; int p = buffer.indexOf("".getBytes(), p + 10); out.write(in, off, p - off); out.flush(); parseSSI(buffer, p, request, response); off = q + 3; p = buffer.indexOf("