package fi.iki.elonen; import java.io.*; import java.net.InetSocketAddress; import java.net.ServerSocket; import java.net.Socket; import java.net.URLDecoder; import java.nio.ByteBuffer; import java.nio.channels.FileChannel; import java.text.SimpleDateFormat; import java.util.*; /** * A simple, tiny, nicely embeddable HTTP server in Java *

*

* NanoHTTPD *

Copyright (c) 2012-2013 by Paul S. Hawke, 2001,2005-2013 by Jarno Elonen, 2010 by Konstantinos Togias

*

*

* Features + limitations: *

*

*

* How to use: *

*

* See the separate "LICENSE.md" file for the distribution license (Modified BSD licence) */ public abstract class NanoHTTPD { /** * Common mime type for dynamic content: plain text */ public static final String MIME_PLAINTEXT = "text/plain"; /** * Common mime type for dynamic content: html */ public static final String MIME_HTML = "text/html"; /** * Common mime type for dynamic content: binary */ public static final String MIME_DEFAULT_BINARY = "application/octet-stream"; private final String hostname; private final int myPort; private ServerSocket myServerSocket; private Thread myThread; /** * Pseudo-Parameter to use to store the actual query string in the parameters map for later re-processing. */ private static final String QUERY_STRING_PARAMETER = "NanoHttpd.QUERY_STRING"; /** * Constructs an HTTP server on given port. */ public NanoHTTPD(int port) { this(null, port); } /** * Constructs an HTTP server on given hostname andport. */ public NanoHTTPD(String hostname, int port) { this.hostname = hostname; this.myPort = port; setTempFileManagerFactory(new DefaultTempFileManagerFactory()); setAsyncRunner(new DefaultAsyncRunner()); } /** * Start the server. * @throws IOException if the socket is in use. */ public void start() throws IOException { myServerSocket = new ServerSocket(); myServerSocket.bind((hostname != null) ? new InetSocketAddress(hostname, myPort) : new InetSocketAddress(myPort)); myThread = new Thread(new Runnable() { @Override public void run() { do { try { final Socket finalAccept = myServerSocket.accept(); InputStream inputStream = finalAccept.getInputStream(); OutputStream outputStream = finalAccept.getOutputStream(); TempFileManager tempFileManager = tempFileManagerFactory.create(); final HTTPSession session = new HTTPSession(tempFileManager, inputStream, outputStream); asyncRunner.exec(new Runnable() { @Override public void run() { session.run(); try { finalAccept.close(); } catch (IOException ignored) { } } }); } catch (IOException e) { } } while (!myServerSocket.isClosed()); } }); myThread.setDaemon(true); myThread.setName("NanoHttpd Main Listener"); myThread.start(); } /** * Stop the server. */ public void stop() { try { myServerSocket.close(); myThread.join(); } catch (Exception e) { e.printStackTrace(); } } /** * Override this to customize the server. *

*

* (By default, this delegates to serveFile() and allows directory listing.) * * @param uri Percent-decoded URI without parameters, for example "/index.cgi" * @param method "GET", "POST" etc. * @param parms Parsed, percent decoded parameters from URI and, in case of POST, data. * @param header Header entries, percent decoded * @return HTTP response, see class Response for details */ public abstract Response serve(String uri, Method method, Map header, Map parms, Map files); /** * Decode percent encoded String values. * @param str the percent encoded String * @return expanded form of the input, for example "foo%20bar" becomes "foo bar" */ protected String decodePercent(String str) { String decoded = null; try { decoded = URLDecoder.decode(str, "UTF8"); } catch (UnsupportedEncodingException ignored) { } return decoded; } /** * Decode parameters from a URL, handing the case where a single parameter name might have been * supplied several times, by return lists of values. In general these lists will contain a single * element. * * @param parms original NanoHttpd parameters values, as passed to the serve() method. * @return a map of String (parameter name) to List<String> (a list of the values supplied). */ protected Map> decodeParameters(Map parms) { return this.decodeParameters(parms.get(QUERY_STRING_PARAMETER)); } /** * Decode parameters from a URL, handing the case where a single parameter name might have been * supplied several times, by return lists of values. In general these lists will contain a single * element. * * @param queryString a query string pulled from the URL. * @return a map of String (parameter name) to List<String> (a list of the values supplied). */ protected Map> decodeParameters(String queryString) { Map> parms = new HashMap>(); if (queryString != null) { StringTokenizer st = new StringTokenizer(queryString, "&"); while (st.hasMoreTokens()) { String e = st.nextToken(); int sep = e.indexOf('='); String propertyName = (sep >= 0) ? decodePercent(e.substring(0, sep)).trim() : decodePercent(e).trim(); if (!parms.containsKey(propertyName)) { parms.put(propertyName, new ArrayList()); } String propertyValue = (sep >= 0) ? decodePercent(e.substring(sep + 1)) : null; if (propertyValue != null) { parms.get(propertyName).add(propertyValue); } } } return parms; } /** * HTTP Request methods, with the ability to decode a String back to its enum value. */ public enum Method { GET, PUT, POST, DELETE, HEAD; static Method lookup(String method) { for (Method m : Method.values()) { if (m.toString().equalsIgnoreCase(method)) { return m; } } return null; } } // ------------------------------------------------------------------------------- // // // Threading Strategy. // // ------------------------------------------------------------------------------- // /** * Pluggable strategy for asynchronously executing requests. */ private AsyncRunner asyncRunner; /** * Pluggable strategy for asynchronously executing requests. * @param asyncRunner new strategy for handling threads. */ public void setAsyncRunner(AsyncRunner asyncRunner) { this.asyncRunner = asyncRunner; } /** * Pluggable strategy for asynchronously executing requests. */ public interface AsyncRunner { void exec(Runnable code); } /** * Default threading strategy for NanoHttpd. * *

By default, the server spawns a new Thread for every incoming request. These are set * to daemon status, and named according to the request number. The name is * useful when profiling the application.

*/ public static class DefaultAsyncRunner implements AsyncRunner { private long requestCount; @Override public void exec(Runnable code) { ++requestCount; Thread t = new Thread(code); t.setDaemon(true); t.setName("NanoHttpd Request Processor (#" + requestCount + ")"); t.start(); } } // ------------------------------------------------------------------------------- // // // Temp file handling strategy. // // ------------------------------------------------------------------------------- // /** * Pluggable strategy for creating and cleaning up temporary files. */ private TempFileManagerFactory tempFileManagerFactory; /** * Pluggable strategy for creating and cleaning up temporary files. * @param tempFileManagerFactory new strategy for handling temp files. */ public void setTempFileManagerFactory(TempFileManagerFactory tempFileManagerFactory) { this.tempFileManagerFactory = tempFileManagerFactory; } /** * Factory to create temp file managers. */ public interface TempFileManagerFactory { TempFileManager create(); } /** * Temp file manager. * *

Temp file managers are created 1-to-1 with incoming requests, to create and cleanup * temporary files created as a result of handling the request.

*/ public interface TempFileManager { TempFile createTempFile() throws Exception; void clear(); } /** * A temp file. * *

Temp files are responsible for managing the actual temporary storage and cleaning * themselves up when no longer needed.

*/ public interface TempFile { OutputStream open() throws Exception; void delete() throws Exception; String getName(); } /** * Default strategy for creating and cleaning up temporary files. */ private class DefaultTempFileManagerFactory implements TempFileManagerFactory { @Override public TempFileManager create() { return new DefaultTempFileManager(); } } /** * Default strategy for creating and cleaning up temporary files. * *

This class stores its files in the standard location (that is, * wherever java.io.tmpdir points to). Files are added * to an internal list, and deleted when no longer needed (that is, * when clear() is invoked at the end of processing a * request).

*/ public static class DefaultTempFileManager implements TempFileManager { private final String tmpdir; private final List tempFiles; public DefaultTempFileManager() { tmpdir = System.getProperty("java.io.tmpdir"); tempFiles = new ArrayList(); } @Override public TempFile createTempFile() throws Exception { DefaultTempFile tempFile = new DefaultTempFile(tmpdir); tempFiles.add(tempFile); return tempFile; } @Override public void clear() { for (TempFile file : tempFiles) { try { file.delete(); } catch (Exception ignored) { } } tempFiles.clear(); } } /** * Default strategy for creating and cleaning up temporary files. * *

By default, files are created by File.createTempFile() in * the directory specified.

*/ public static class DefaultTempFile implements TempFile { private File file; private OutputStream fstream; public DefaultTempFile(String tempdir) throws IOException { file = File.createTempFile("NanoHTTPD-", "", new File(tempdir)); fstream = new FileOutputStream(file); } @Override public OutputStream open() throws Exception { return fstream; } @Override public void delete() throws Exception { if (fstream != null) { fstream.close(); } file.delete(); } @Override public String getName() { return file.getAbsolutePath(); } } // ------------------------------------------------------------------------------- // /** * HTTP response. Return one of these from serve(). */ public static class Response { /** * HTTP status code after processing, e.g. "200 OK", HTTP_OK */ private Status status; /** * MIME type of content, e.g. "text/html" */ private String mimeType; /** * Data of the response, may be null. */ private InputStream data; /** * Headers for the HTTP response. Use addHeader() to add lines. */ private Map header = new HashMap(); /** * The request method that spawned this response. */ private Method requestMethod; /** * Default constructor: response = HTTP_OK, mime = MIME_HTML and your supplied message */ public Response(String msg) { this(Status.OK, MIME_HTML, msg); } /** * Basic constructor. */ public Response(Status status, String mimeType, InputStream data) { this.status = status; this.mimeType = mimeType; this.data = data; } /** * Convenience method that makes an InputStream out of given text. */ public Response(Status status, String mimeType, String txt) { this.status = status; this.mimeType = mimeType; try { this.data = txt != null ? new ByteArrayInputStream(txt.getBytes("UTF-8")) : null; } catch (java.io.UnsupportedEncodingException uee) { uee.printStackTrace(); } } public static void error(OutputStream outputStream, Status error, String message) { new Response(error, MIME_PLAINTEXT, message).send(outputStream); } /** * Adds given line to the header. */ public void addHeader(String name, String value) { header.put(name, value); } /** * Sends given response to the socket. */ private void send(OutputStream outputStream) { String mime = mimeType; SimpleDateFormat gmtFrmt = new SimpleDateFormat("E, d MMM yyyy HH:mm:ss 'GMT'", Locale.US); gmtFrmt.setTimeZone(TimeZone.getTimeZone("GMT")); try { if (status == null) { throw new Error("sendResponse(): Status can't be null."); } PrintWriter pw = new PrintWriter(outputStream); pw.print("HTTP/1.0 " + status.getDescription() + " \r\n"); if (mime != null) { pw.print("Content-Type: " + mime + "\r\n"); } if (header == null || header.get("Date") == null) { pw.print("Date: " + gmtFrmt.format(new Date()) + "\r\n"); } if (header != null) { for (String key : header.keySet()) { String value = header.get(key); pw.print(key + ": " + value + "\r\n"); } } pw.print("\r\n"); pw.flush(); if (requestMethod != Method.HEAD && data != null) { int pending = data.available(); // This is to support partial sends, see serveFile() int BUFFER_SIZE = 16 * 1024; byte[] buff = new byte[BUFFER_SIZE]; while (pending > 0) { int read = data.read(buff, 0, ((pending > BUFFER_SIZE) ? BUFFER_SIZE : pending)); if (read <= 0) { break; } outputStream.write(buff, 0, read); pending -= read; } } outputStream.flush(); outputStream.close(); if (data != null) data.close(); } catch (IOException ioe) { // Couldn't write? No can do. } } public Status getStatus() { return status; } public void setStatus(Status status) { this.status = status; } public String getMimeType() { return mimeType; } public void setMimeType(String mimeType) { this.mimeType = mimeType; } public InputStream getData() { return data; } public void setData(InputStream data) { this.data = data; } public Method getRequestMethod() { return requestMethod; } public void setRequestMethod(Method requestMethod) { this.requestMethod = requestMethod; } /** * Some HTTP response status codes */ public enum Status { OK(200, "OK"), CREATED(201, "Created"), ACCEPTED(202, "Accepted"), NO_CONTENT(204, "No Content"), PARTIAL_CONTENT(206, "Partial Content"), REDIRECT(301, "Moved Permanently"), NOT_MODIFIED(304, "Not Modified"), BAD_REQUEST(400, "Bad Request"), UNAUTHORIZED(401, "Unauthorized"), FORBIDDEN(403, "Forbidden"), NOT_FOUND(404, "Not Found"), RANGE_NOT_SATISFIABLE(416, "Requested Range Not Satisfiable"), INTERNAL_ERROR(500, "Internal Server Error"); private final int requestStatus; private final String description; Status(int requestStatus, String description) { this.requestStatus = requestStatus; this.description = description; } public int getRequestStatus() { return this.requestStatus; } public String getDescription() { return "" + this.requestStatus + " " + description; } } } /** * Handles one session, i.e. parses the HTTP request and returns the response. */ protected class HTTPSession implements Runnable { public static final int BUFSIZE = 8192; private final TempFileManager tempFileManager; private final InputStream inputStream; private final OutputStream outputStream; public HTTPSession(TempFileManager tempFileManager, InputStream inputStream, OutputStream outputStream) { this.tempFileManager = tempFileManager; this.inputStream = inputStream; this.outputStream = outputStream; } @Override public void run() { RandomAccessFile randomAccessFile = null; try { if (inputStream == null) { return; } // Read the first 8192 bytes. // The full header should fit in here. // Apache's default header limit is 8KB. // Do NOT assume that a single read will get the entire header at once! byte[] buf = new byte[BUFSIZE]; int splitbyte = 0; int rlen = 0; { int read = inputStream.read(buf, 0, BUFSIZE); while (read > 0) { rlen += read; splitbyte = findHeaderEnd(buf, rlen); if (splitbyte > 0) break; read = inputStream.read(buf, rlen, BUFSIZE - rlen); } } // Create a BufferedReader for parsing the header. BufferedReader hin = new BufferedReader(new InputStreamReader(new ByteArrayInputStream(buf, 0, rlen))); Map pre = new HashMap(); Map parms = new HashMap(); Map header = new HashMap(); Map files = new HashMap(); // Decode the header into parms and header java properties decodeHeader(hin, pre, parms, header); Method method = Method.lookup(pre.get("method")); if (method == null) { Response.error(outputStream, Response.Status.BAD_REQUEST, "BAD REQUEST: Syntax error."); throw new InterruptedException(); } String uri = pre.get("uri"); long size = extractContentLength(header); // Write the part of body already read to ByteArrayOutputStream f randomAccessFile = getTmpBucket(); if (splitbyte < rlen) { randomAccessFile.write(buf, splitbyte, rlen - splitbyte); } // While Firefox sends on the first read all the data fitting // our buffer, Chrome and Opera send only the headers even if // there is data for the body. We do some magic here to find // out whether we have already consumed part of body, if we // have reached the end of the data to be sent or we should // expect the first byte of the body at the next read. if (splitbyte < rlen) { size -= rlen - splitbyte + 1; } else if (splitbyte == 0 || size == 0x7FFFFFFFFFFFFFFFl) { size = 0; } // Now read all the body and write it to f buf = new byte[512]; while (rlen >= 0 && size > 0) { rlen = inputStream.read(buf, 0, 512); size -= rlen; if (rlen > 0) { randomAccessFile.write(buf, 0, rlen); } } // Get the raw body as a byte [] ByteBuffer fbuf = randomAccessFile.getChannel().map(FileChannel.MapMode.READ_ONLY, 0, randomAccessFile.length()); randomAccessFile.seek(0); // Create a BufferedReader for easily reading it as string. InputStream bin = new FileInputStream(randomAccessFile.getFD()); BufferedReader in = new BufferedReader(new InputStreamReader(bin)); // If the method is POST, there may be parameters // in data section, too, read it: if (Method.POST.equals(method)) { String contentType = ""; String contentTypeHeader = header.get("content-type"); StringTokenizer st = null; if (contentTypeHeader != null) { st = new StringTokenizer(contentTypeHeader, ",; "); if (st.hasMoreTokens()) { contentType = st.nextToken(); } } if ("multipart/form-data".equalsIgnoreCase(contentType)) { // Handle multipart/form-data if (!st.hasMoreTokens()) { Response.error(outputStream, Response.Status.BAD_REQUEST, "BAD REQUEST: Content type is multipart/form-data but boundary missing. Usage: GET /example/file.html"); throw new InterruptedException(); } String boundaryStartString = "boundary="; int boundaryContentStart = contentTypeHeader.indexOf(boundaryStartString) + boundaryStartString.length(); String boundary = contentTypeHeader.substring(boundaryContentStart, contentTypeHeader.length()); if (boundary.startsWith("\"") && boundary.startsWith("\"")) { boundary = boundary.substring(1, boundary.length() - 1); } decodeMultipartData(boundary, fbuf, in, parms, files); } else { // Handle application/x-www-form-urlencoded String postLine = ""; char pbuf[] = new char[512]; int read = in.read(pbuf); while (read >= 0 && !postLine.endsWith("\r\n")) { postLine += String.valueOf(pbuf, 0, read); read = in.read(pbuf); } postLine = postLine.trim(); decodeParms(postLine, parms); } } else if (Method.PUT.equals(method)) { files.put("content", saveTmpFile(fbuf, 0, fbuf.limit())); } // Ok, now do the serve() Response r = serve(uri, method, header, parms, files); if (r == null) { Response.error(outputStream, Response.Status.INTERNAL_ERROR, "SERVER INTERNAL ERROR: Serve() returned a null response."); throw new InterruptedException(); } else { r.setRequestMethod(method); r.send(outputStream); } in.close(); inputStream.close(); } catch (IOException ioe) { try { Response.error(outputStream, Response.Status.INTERNAL_ERROR, "SERVER INTERNAL ERROR: IOException: " + ioe.getMessage()); throw new InterruptedException(); } catch (Throwable ignored) { } } catch (InterruptedException ie) { // Thrown by sendError, ignore and exit the thread. } finally { if (randomAccessFile != null) { try { randomAccessFile.close(); } catch (IOException e) { } } tempFileManager.clear(); } } private long extractContentLength(Map header) { long size = 0x7FFFFFFFFFFFFFFFl; String contentLength = header.get("content-length"); if (contentLength != null) { try { size = Integer.parseInt(contentLength); } catch (NumberFormatException ex) { ex.printStackTrace(); } } return size; } /** * Decodes the sent headers and loads the data into Key/value pairs */ private void decodeHeader(BufferedReader in, Map pre, Map parms, Map header) throws InterruptedException { try { // Read the request line String inLine = in.readLine(); if (inLine == null) { return; } StringTokenizer st = new StringTokenizer(inLine); if (!st.hasMoreTokens()) { Response.error(outputStream, Response.Status.BAD_REQUEST, "BAD REQUEST: Syntax error. Usage: GET /example/file.html"); throw new InterruptedException(); } pre.put("method", st.nextToken()); if (!st.hasMoreTokens()) { Response.error(outputStream, Response.Status.BAD_REQUEST, "BAD REQUEST: Missing URI. Usage: GET /example/file.html"); throw new InterruptedException(); } String uri = st.nextToken(); // Decode parameters from the URI int qmi = uri.indexOf('?'); if (qmi >= 0) { decodeParms(uri.substring(qmi + 1), parms); uri = decodePercent(uri.substring(0, qmi)); } else { uri = decodePercent(uri); } // If there's another token, it's protocol version, // followed by HTTP headers. Ignore version but parse headers. // NOTE: this now forces header names lowercase since they are // case insensitive and vary by client. if (st.hasMoreTokens()) { String line = in.readLine(); while (line != null && line.trim().length() > 0) { int p = line.indexOf(':'); if (p >= 0) header.put(line.substring(0, p).trim().toLowerCase(), line.substring(p + 1).trim()); line = in.readLine(); } } pre.put("uri", uri); } catch (IOException ioe) { Response.error(outputStream, Response.Status.INTERNAL_ERROR, "SERVER INTERNAL ERROR: IOException: " + ioe.getMessage()); throw new InterruptedException(); } } /** * Decodes the Multipart Body data and put it into Key/Value pairs. */ private void decodeMultipartData(String boundary, ByteBuffer fbuf, BufferedReader in, Map parms, Map files) throws InterruptedException { try { int[] bpositions = getBoundaryPositions(fbuf, boundary.getBytes()); int boundarycount = 1; String mpline = in.readLine(); while (mpline != null) { if (!mpline.contains(boundary)) { Response.error(outputStream, Response.Status.BAD_REQUEST, "BAD REQUEST: Content type is multipart/form-data but next chunk does not start with boundary. Usage: GET /example/file.html"); throw new InterruptedException(); } boundarycount++; Map item = new HashMap(); mpline = in.readLine(); while (mpline != null && mpline.trim().length() > 0) { int p = mpline.indexOf(':'); if (p != -1) { item.put(mpline.substring(0, p).trim().toLowerCase(), mpline.substring(p + 1).trim()); } mpline = in.readLine(); } if (mpline != null) { String contentDisposition = item.get("content-disposition"); if (contentDisposition == null) { Response.error(outputStream, Response.Status.BAD_REQUEST, "BAD REQUEST: Content type is multipart/form-data but no content-disposition info found. Usage: GET /example/file.html"); throw new InterruptedException(); } StringTokenizer st = new StringTokenizer(contentDisposition, "; "); Map disposition = new HashMap(); while (st.hasMoreTokens()) { String token = st.nextToken(); int p = token.indexOf('='); if (p != -1) { disposition.put(token.substring(0, p).trim().toLowerCase(), token.substring(p + 1).trim()); } } String pname = disposition.get("name"); pname = pname.substring(1, pname.length() - 1); String value = ""; if (item.get("content-type") == null) { while (mpline != null && !mpline.contains(boundary)) { mpline = in.readLine(); if (mpline != null) { int d = mpline.indexOf(boundary); if (d == -1) { value += mpline; } else { value += mpline.substring(0, d - 2); } } } } else { if (boundarycount > bpositions.length) { Response.error(outputStream, Response.Status.INTERNAL_ERROR, "Error processing request"); throw new InterruptedException(); } int offset = stripMultipartHeaders(fbuf, bpositions[boundarycount - 2]); String path = saveTmpFile(fbuf, offset, bpositions[boundarycount - 1] - offset - 4); files.put(pname, path); value = disposition.get("filename"); value = value.substring(1, value.length() - 1); do { mpline = in.readLine(); } while (mpline != null && !mpline.contains(boundary)); } parms.put(pname, value); } } } catch (IOException ioe) { Response.error(outputStream, Response.Status.INTERNAL_ERROR, "SERVER INTERNAL ERROR: IOException: " + ioe.getMessage()); throw new InterruptedException(); } } /** * Find byte index separating header from body. It must be the last byte of the first two sequential new lines. */ private int findHeaderEnd(final byte[] buf, int rlen) { int splitbyte = 0; while (splitbyte + 3 < rlen) { if (buf[splitbyte] == '\r' && buf[splitbyte + 1] == '\n' && buf[splitbyte + 2] == '\r' && buf[splitbyte + 3] == '\n') { return splitbyte + 4; } splitbyte++; } return 0; } /** * Find the byte positions where multipart boundaries start. */ public int[] getBoundaryPositions(ByteBuffer b, byte[] boundary) { int matchcount = 0; int matchbyte = -1; List matchbytes = new ArrayList(); for (int i=0; i 0) { try { TempFile tempFile = tempFileManager.createTempFile(); ByteBuffer src = b.duplicate(); FileChannel dest = new FileOutputStream(tempFile.getName()).getChannel(); src.position(offset).limit(offset + len); dest.write(src.slice()); path = tempFile.getName(); } catch (Exception e) { // Catch exception if any System.err.println("Error: " + e.getMessage()); } } return path; } private RandomAccessFile getTmpBucket() { try { TempFile tempFile = tempFileManager.createTempFile(); return new RandomAccessFile(tempFile.getName(), "rw"); } catch (Exception e) { System.err.println("Error: " + e.getMessage()); } return null; } /** * It returns the offset separating multipart file headers from the file's data. */ private int stripMultipartHeaders(ByteBuffer b, int offset) { int i; for (i=offset; i p) { if (parms == null) { p.put(QUERY_STRING_PARAMETER, ""); return; } p.put(QUERY_STRING_PARAMETER, parms); StringTokenizer st = new StringTokenizer(parms, "&"); while (st.hasMoreTokens()) { String e = st.nextToken(); int sep = e.indexOf('='); if (sep >= 0) { p.put(decodePercent(e.substring(0, sep)).trim(), decodePercent(e.substring(sep + 1))); } else { p.put(decodePercent(e).trim(), ""); } } } } public final int getListeningPort() { return myServerSocket == null ? -1 : myServerSocket.getLocalPort(); } public final boolean wasStarted() { return myServerSocket != null && myThread != null; } public final boolean isAlive() { return wasStarted() && !myServerSocket.isClosed() && myThread.isAlive(); } }