Quadcap Embeddable Server

com/quadcap/http/server22/WebServer.java

Go to the documentation of this file.

package com.quadcap.http.server22;

/* Copyright 1997 - 2003 Quadcap Software.  All rights reserved.
 *
 * This software is distributed under the Quadcap Free Software License.
 * This software may be used or modified for any purpose, personal or
 * commercial.  Open Source redistributions are permitted.  Commercial
 * redistribution of larger works derived from, or works which bundle
 * this software requires a "Commercial Redistribution License"; see
 * http://www.quadcap.com/purchase.
 *
 * Redistributions qualify as "Open Source" under  one of the following terms:
 *   
 *    Redistributions are made at no charge beyond the reasonable cost of
 *    materials and delivery.
 *
 *    Redistributions are accompanied by a copy of the Source Code or by an
 *    irrevocable offer to provide a copy of the Source Code for up to three
 *    years at the cost of materials and delivery.  Such redistributions
 *    must allow further use, modification, and redistribution of the Source
 *    Code under substantially the same terms as this license.
 *
 * Redistributions of source code must retain the copyright notices as they
 * appear in each source code file, these license terms, and the
 * disclaimer/limitation of liability set forth as paragraph 6 below.
 *
 * Redistributions in binary form must reproduce this Copyright Notice,
 * these license terms, and the disclaimer/limitation of liability set
 * forth as paragraph 6 below, in the documentation and/or other materials
 * provided with the distribution.
 *
 * The Software is provided on an "AS IS" basis.  No warranty is
 * provided that the Software is free of defects, or fit for a
 * particular purpose.  
 *
 * Limitation of Liability. Quadcap Software shall not be liable
 * for any damages suffered by the Licensee or any third party resulting
 * from use of the Software.
 */

import java.util.Date;
import java.util.Enumeration;
import java.util.Hashtable;
import java.util.Properties;
import java.util.Random;
import java.util.Vector;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.IOException;
import java.io.PrintWriter;

import java.text.SimpleDateFormat;

import java.net.InetAddress;
import java.net.MalformedURLException;
import java.net.Socket;
import java.net.URL;
import java.net.URLConnection;

import javax.servlet.RequestDispatcher;
import javax.servlet.Servlet;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;

import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
import javax.servlet.http.HttpSessionContext;

import com.quadcap.net.server.Server;
import com.quadcap.net.server.Worker;

import com.quadcap.util.threads.Command;
import com.quadcap.util.threads.PeriodicScheduler;

import com.quadcap.util.text.OctetMap;
import com.quadcap.util.text.Scanner;

import com.quadcap.io.dir.Directory;

import com.quadcap.util.Config;
import com.quadcap.util.Debug;
import com.quadcap.util.Util;

/**
 * A basic HTTP server.
 *
 * @author Stan Bailes
 */
public class WebServer {
    Random                              random          = new Random();
    
    /**
     * My (cached) host name
     */
    String                              hostName        = null;

    /**
     * My servlet contexts
     */
    Hashtable                           contexts        = new Hashtable();

    /**
     * Default mime types
     */
    Hashtable                           mimeTypes       = new Hashtable();

    WebApplication                      defaultContext  = null;

    File                                tmpDir;

    long                                sessionCount    = 0;
    static final int                    defaultInactiveInterval = 60;
    static final int                    expireCheckerInterval = 60;

    PeriodicScheduler                   expireChecker;

    PrintWriter                         reqStream;

    Server                              server;

    /**
     * Server interface: initialize this server
     *
     * @param p the properties used to specify information about the
     *  server's startup.
     * @exception IOException may be thrown
     */
    /*{com.quadcap.http.server22.WebServer.xml}
     *
     * <config>
     * <config-var>
     *   <config-name>tempDir</config-name>
     *   <config-dflt>./repository</config-dflt>
     *   <config-desc>Specifies the name of a directory where temporary
     *         JSP-generated files are placed.</config-desc>
     * </config-var>
     *
     * <config-var>
     *   <config-name>context.*.root</config-name>
     *   <config-dflt><i>none</i></config-dflt>
     *   <config-desc>Specify the context path for a web application.
     *       The application
     *       name is specified by the 'wildcard' portion of the property
     *       name.</config-desc>
     * </config-var>
     *
     * <config-var>
     *   <config-name>context.*.docBase</config-name>
     *   <config-dflt><i>none</i></config-dflt>
     *   <config-desc>Specify the path to the web application's files,
     *       either as
     *       a directory name or the name of a Web Application Archive
     *       (.war) file.</config-desc>
     * </config-var>
     *
     * <config-var>
     *   <config-name>acceptor.*.port</config-name>
     *   <config-dflt><i>none</i></config-dflt>
     *   <config-desc>Specify the port number for the server to listen on.
     *       The
     *       wildcard portion of the name gives the name of the socket
     *       acceptor, and doesn't have any real significance other than
     *       as a unique name for the acceptor.</config-desc>
     * </config-var>
     *
     * <config-var>
     *   <config-name>acceptor.*.queueDepth</config-name>
     *   <config-dflt>32</config-dflt>
     *   <config-desc>Specify the TCP queue depth associated with the named
     *       acceptor.</config-desc>
     * </config-var>
     *
     * <include name="docstubs/com.quadcap.net.server.Server.xml"/>
     *
     * </config>
     */
    public void init(Properties p) 
        throws Exception
    {
        p.put("workerClass", "com.quadcap.http.server22.WebWorker");
        server = new Server(p, this);

        String tmp = p.getProperty("tempDir", "repository");
        tmpDir = new File(tmp);
        if (!tmpDir.isDirectory() && !tmpDir.mkdirs()) {
            throw new IOException("Can't create temp directory: " + tmp);
        }

        tmp = p.getProperty("requestLog", "web.log");
        reqStream = new PrintWriter(new FileOutputStream(tmp));

        InputStream dis = ClassLoader.getSystemResourceAsStream(
            "com/quadcap/http/server22/mime.types");
        if (dis != null) {
            try {
                parseMimeTypes(dis);
            } finally {
                dis.close();
            }
        }
        
        Enumeration e = Config.getMatchingProps(p, "context.*.root");
        while (e.hasMoreElements()) {
            String context = e.nextElement().toString();
            String c = "context." + context;
            String root = p.getProperty(c + ".root");
            String docBase = p.getProperty(c + ".docBase");
            if (docBase == null) {
                Debug.println(0, "No docBase specified for context " +
                              context);
            } else {
                try {
                    WebApplication app = addWebApplication(root, docBase);
                    if (context.equals("default")) {
                        defaultContext = app;
                    }
                } catch (Throwable t) {
                    Debug.print(t);
                }
            }
        }

        boolean found = false;
        e = Config.getMatchingProps(p, "acceptor.*.port");
        while (e.hasMoreElements()) {
            found = true;
            String acceptor = e.nextElement().toString();
            String a = "acceptor." + acceptor;
            Properties ap = new Properties();
            ap.put("port", p.getProperty(a + ".port"));
            ap.put("queueDepth", p.getProperty(a + ".queueDepth", "32"));
            Debug.println("startAcceptor: " + ap.get("port"));
            server.startAcceptor(ap);
        }

        expireChecker = new PeriodicScheduler(server.getThreadGroup(),
                                              "expire checker",
                                              this);
        expireChecker.add("Check for expired sessions",
                          new ExpireChecker(),
                          expireCheckerInterval * 1000);
        expireChecker.start();
        if (!found) {
            Debug.println(0, "No acceptor.<name>.port properties found!!");
        }
    }

    public void stop() {
        server.stop();
    }

    final void parseMimeTypes(InputStream is) throws IOException {
        Scanner s = new Scanner(is);
        s.skipWhile(OctetMap.crlfChars);
        int c;
        while ((c = s.peek()) >= 0) {
            if (c == '#') {
                s.skipUntil(OctetMap.crlfChars);
            } else {
                String mimeType = s.parseWhile(OctetMap.uriChars);
                s.skipWhile(OctetMap.wsChars);
                while ((c = s.peek()) >= 0 && OctetMap.tokenChars.has(c)) {
                    String ext = s.parseWhile(OctetMap.tokenChars);
                    mimeTypes.put(ext, mimeType);
                    s.skipWhile(OctetMap.wsChars);
                }
                s.skipUntil(OctetMap.crlfChars);
            }
            s.skipWhile(OctetMap.crlfChars);
        }
        is.close();
    }

    public void removeWebApplication(String root) {
        WebApplication app = getContextForRoot(root);
        if (app != null) {
            contexts.remove(root);
            app.shutdown();
        }
    }

    public WebApplication addWebApplication(String root, String docBase)
        throws IOException, ServletException
    {
        // ---- remove trailing slash from context path
        int len = root.length();
        if (len > 0 && root.charAt(len-1) == '/') {
            root = root.substring(0, len-1);
        }
        //#ifdef DEBUG
        if (Trace.level() > 1) {
            Debug.println("addWebApplication(" + root + ", " + docBase + ")");
        }
        //#endif

        WebApplication oldApp = (WebApplication)contexts.get(root);
        if (oldApp != null) {
            try {
                Debug.println("[Shutting down old app for " + root + ": " +
                              oldApp);
                oldApp.shutdown();
            } catch (Throwable t) {
            }
        }

        File dir = new File(docBase);
        Directory d = Directory.getDirectory(dir);
        WebApplication app = new WebApplication();
        app.init(this, root, d);

        contexts.put(root, app);

        
        return app;
    }

    /**
     * Returns the name and version of the network service under which the
     * servlet is running.
     *
     * @return the server information string
     */
    public String getServerInfo() {
        //> return \"Quadcap Web Server [defined VERSION]\";
//#autogen begin
         return "Quadcap Web Server 3.4";
//#autogen end
    }

    /**
     * Returns the mime type of the specified file, or null if not known.
     */
    public String getMimeTypeForExt(String ext) {
        String type = (String)mimeTypes.get(ext.toLowerCase());
        return type;
    }

    /**
     * Return the servlet context for the specified path.
     */
    public WebApplication getContext(String path) {
        WebApplication ret = (WebApplication)contexts.get(path);
        for (int i = path.length() - 1; ret == null && i >= 0; i--) {
            if (path.charAt(i) == '/') {
                String subPath = path.substring(0, i);
                ret = (WebApplication)contexts.get(subPath);
            }
        }
        if (ret == null) ret = defaultContext;
        Debug.println("defaultContext = " + defaultContext);
        return ret;
    }

    String makeSessionId() {
        int r = random.nextInt() & 0xfffffff;
        return "" + (sessionCount++) + "." + r + "." +
            System.currentTimeMillis();
    }
    
    public void expireSessions() {
        Enumeration e = contexts.elements();
        while (e.hasMoreElements()) {
            WebApplication app = (WebApplication)e.nextElement();
            app.expireSessions();
        }
    }
    
    final File getTempDir() {
        return tmpDir;
    }

    public Enumeration getContextRoots() {
        return contexts.keys();
    }

    public WebApplication getContextForRoot(String root) {
        return (WebApplication)contexts.get(root);
    }

    public static void main(String args[]) {
        Properties p = Config.getProperties();
        WebServer w = new WebServer();
        try {
            w.init(p);
        } catch (Throwable t) {
            Debug.print(t);
        }
    }

    static SimpleDateFormat df;
    static {
        df = new SimpleDateFormat("yyyy/MM/dd HH:mm:ss.SSS");
    }
    public void requestLog(String s) {
        reqStream.println(df.format(new Date()) + " " + s);
        reqStream.flush();
    }
}


class ExpireChecker implements Command {
    public void execute(Object context) {
        ((WebServer)context).expireSessions();
    }
}