scripts/mir-setup/README: update with link to new doc on wiki
[mir.git] / source / Mir.java
index bbb4d33..011b1f9 100755 (executable)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2001, 2002 The Mir-coders group
+ * Copyright (C) 2001-2006 The Mir-coders group
  *
  * This file is part of Mir.
  *
@@ -19,8 +19,6 @@
  *
  * In addition, as a special exception, The Mir-coders gives permission to link
  * the code of this program with  any library licensed under the Apache Software License,
- * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library
- * (or with modified versions of the above that use the same license as the above),
  * and distribute linked combinations including the two.  You must obey the
  * GNU General Public License in all respects for all of the code used other than
  * the above mentioned libraries.  If you modify this file, you may extend this
  * If you do not wish to do so, delete this exception statement from your version.
  */
 
-import java.io.IOException;
-import java.io.PrintWriter;
-import java.lang.reflect.Method;
-import java.util.GregorianCalendar;
-import java.util.HashMap;
-import java.util.Iterator;
-import java.util.List;
-import java.util.Locale;
-import java.util.Map;
-import java.util.Vector;
-import javax.servlet.ServletException;
-import javax.servlet.UnavailableException;
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
-import javax.servlet.http.HttpSession;
-
-import org.apache.struts.util.MessageResources;
-import freemarker.template.SimpleHash;
-import freemarker.template.SimpleList;
-import freemarker.template.SimpleScalar;
-import freemarker.template.TemplateModel;
-
+import mir.bundle.Bundle;
 import mir.config.MirPropertiesConfiguration;
-import mir.entity.adapter.EntityIteratorAdapter;
-import mir.generator.FreemarkerGenerator;
-import mir.log.LoggerWrapper;
-import mir.misc.HTMLTemplateProcessor;
-import mir.misc.StringUtil;
 import mir.servlet.AbstractServlet;
-import mir.servlet.ServletModule;
-import mir.servlet.ServletModuleDispatch;
+import mir.servlet.AdminServletModule;
 import mir.servlet.ServletModuleExc;
 import mir.servlet.ServletModuleUserExc;
-import mir.util.CachingRewindableIterator;
-import mir.util.ExceptionFunctions;
+import mir.util.ExceptionRoutines;
 import mir.util.StringRoutines;
 import mircoders.entity.EntityUsers;
 import mircoders.global.MirGlobal;
-import mircoders.module.ModuleMessage;
 import mircoders.module.ModuleUsers;
 import mircoders.servlet.ServletHelper;
-import mircoders.servlet.ServletModuleFileEdit;
-import mircoders.servlet.ServletModuleLocalizer;
-import mircoders.storage.DatabaseUsers;
-
-
+import multex.Failure;
 
+import javax.servlet.ServletConfig;
+import javax.servlet.ServletException;
+import javax.servlet.UnavailableException;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+import javax.servlet.http.HttpSession;
+import javax.servlet.http.HttpSessionBindingEvent;
+import javax.servlet.http.HttpSessionBindingListener;
+import java.io.IOException;
+import java.io.PrintWriter;
+import java.io.StringWriter;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.GregorianCalendar;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Locale;
+import java.util.Map;
 
-/**
- * Mir.java - main servlet, that dispatches to servletmodules
- *
- * @author $Author: zapata $
- * @version $Id: Mir.java,v 1.49.2.1 2003/06/13 03:54:08 zapata Exp $
- *
- */
 public class Mir extends AbstractServlet {
   private static ModuleUsers usersModule = null;
-  private static ModuleMessage messageModule = null;
-  private final static Map servletModuleInstanceHash = new HashMap();
   private static Locale fallbackLocale = null;
 
-  //I don't know about making this static cause it removes the
-  //possibility to change the config on the fly.. -mh
   private static List loginLanguages = null;
 
-  protected TemplateModel getLoginLanguages() throws ServletException {
+  private List getLoginLanguages() throws Failure {
     synchronized (Mir.class) {
       try {
         if (loginLanguages == null) {
-          MessageResources messageResources =
-            MessageResources.getMessageResources("bundles.adminlocal");
-          MessageResources messageResources2 =
-            MessageResources.getMessageResources("bundles.admin");
-
           List languages =
             StringRoutines.splitString(MirGlobal.config().getString("Mir.Login.Languages", "en"), ";");
 
-          loginLanguages = new Vector();
+          loginLanguages = new ArrayList();
 
           Iterator i = languages.iterator();
 
           while (i.hasNext()) {
             String code = (String) i.next();
-            Locale locale = new Locale(code, "");
-            String name = messageResources.getMessage(locale, "languagename");
+
+            Bundle bundle =
+                MirGlobal.getBundleFactory().getBundle("etc/bundles/adminlocal", new String[] { code });
+            Bundle defaultBundle =
+                MirGlobal.getBundleFactory().getBundle("bundles/admin", new String[] { code });
+
+            String name = bundle.getValue("languagename", Collections.EMPTY_LIST);
 
             if (name == null) {
-              name = messageResources2.getMessage(locale, "languagename");
+              name = defaultBundle.getValue("languagename", Collections.EMPTY_LIST);
             }
 
             if (name == null) {
@@ -129,16 +103,20 @@ public class Mir extends AbstractServlet {
           }
         }
 
-        return FreemarkerGenerator.makeAdapter(loginLanguages);
+        return loginLanguages;
       }
       catch (Throwable t) {
-        throw new ServletException(t.getMessage());
+        throw new Failure("Error while retrieving the available login languages", t);
       }
     }
   }
 
-  // FIXME: this should probalby go into AbstractServlet so it can be used in
-  // OpenMir as well -mh
+  public void init(ServletConfig config) throws ServletException {
+    super.init(config);
+
+    usersModule = new ModuleUsers();
+  }
+
   protected String getDefaultLanguage(HttpServletRequest aRequest) {
     String defaultlanguage =
       MirGlobal.config().getString("Mir.Login.DefaultLanguage", "");
@@ -164,305 +142,195 @@ public class Mir extends AbstractServlet {
     return fallbackLocale;
   }
 
-  public void process(HttpServletRequest aRequest, HttpServletResponse aResponse)
-    throws ServletException, IOException, UnavailableException {
-    long startTime = System.currentTimeMillis();
-    long sessionConnectTime = 0;
-    EntityUsers userEntity;
-    HttpSession session;
-    String http = "";
+  public EntityUsers checkCredentials(HttpServletRequest aRequest) throws ServletException {
+    try {
+      EntityUsers user = ServletHelper.getUser(aRequest);
 
-    configuration.addProperty("ServletName", getServletName());
+      String username = aRequest.getParameter("login");
+      String password = aRequest.getParameter("password");
 
-    session = aRequest.getSession(true);
-    userEntity = (EntityUsers) session.getAttribute("login.uid");
+      if (username != null && password != null) {
+        user = usersModule.getUserForLogin(username, password);
 
-    if (aRequest.getServerPort() == 443) {
-      http = "https";
+        if (user!=null) {
+          ServletHelper.setUser(aRequest, user);
+          usersModule.recordLogin(user);
+          aRequest.getSession().setAttribute("sessiontracker", new SessionTracker(username, user.getId()));
+        }
+      }
+
+      return user;
     }
-    else {
-      http = "http";
+    catch (Throwable t) {
+      throw new ServletException(t.getMessage());
     }
+  }
 
-    setNoCaching(aResponse);
-
-    Locale locale = new Locale(getDefaultLanguage(aRequest), "");
-
-    aResponse.setContentType("text/html; charset=" +
-        configuration.getString("Mir.DefaultHTMLCharset", "UTF-8"));
+  public void process(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletException, IOException, UnavailableException {
+    try {
+      long startTime = System.currentTimeMillis();
+      long sessionConnectTime = 0;
 
-    String moduleName = aRequest.getParameter("module");
-    checkLanguage(session, aRequest);
+      HttpSession session = aRequest.getSession(true);
+      setNoCaching(aResponse);
+      aResponse.setContentType("text/html; charset=" +
+                               configuration.
+                               getString("Mir.DefaultHTMLCharset", "UTF-8"));
 
-    // Authentication
-    if (((moduleName != null) && moduleName.equals("login")) || (userEntity == null)) {
-      String user = aRequest.getParameter("login");
-      String passwd = aRequest.getParameter("password");
-      logger.debug("--login: evaluating for user: " + user);
-      userEntity = allowedUser(user, passwd);
+      EntityUsers userEntity = checkCredentials(aRequest);
 
       if (userEntity == null) {
-        // login failed: redirecting to login
-        logger.warn("--login: failed!");
-        _sendLoginPage(aResponse, aRequest, aResponse.getWriter());
-
-        return;
-      }
-      else if ((moduleName != null) && moduleName.equals("login")) {
-        // login successful
-        logger.info("--login: successful! setting uid: " + userEntity.getId());
-        session.setAttribute("login.uid", userEntity);
-        logger.debug("--login: trying to retrieve login.target");
-
-        String target = (String) session.getAttribute("login.target");
-
-        if (target != null) {
-          logger.debug("Redirect: " + target);
-
-          int serverPort = aRequest.getServerPort();
-          String redirect = "";
-          String redirectString = "";
-
-          if (serverPort == 80) {
-            redirect =
-              aResponse.encodeURL(http + "://" + aRequest.getServerName() + target);
-            redirectString =
-              "<html><head><meta http-equiv=refresh content=\"1;URL=" +
-              redirect + "\"></head><body>going <a href=\"" + redirect +
-              "\">Mir</a></body></html>";
-          } else {
-            redirect =
-              aResponse.encodeURL(http + "://" + aRequest.getServerName() + ":" +
-                aRequest.getServerPort() + target);
-            redirectString =
-              "<html><head><meta http-equiv=refresh content=\"1;URL=" +
-              redirect + "\"></head><body>going <a href=\"" + redirect +
-              "\">Mir</a></body></html>";
-          }
-
-          aResponse.getWriter().println(redirectString);
+        String queryString = aRequest.getQueryString();
 
-          //aResponse.sendRedirect(redirect);
-        } else {
-          // redirecting to default target
-          logger.debug("--login: no target - redirecting to default");
-          _sendStartPage(aResponse, aRequest, aResponse.getWriter(), userEntity);
+        if ( (queryString != null) && (queryString.length() != 0) && session.getAttribute("login.target") == null &&
+             (aRequest.getParameter("module")==null ||
+              (!aRequest.getParameter("module").equals("login") && !aRequest.getParameter("module").equals("logout")))) {
+          session.setAttribute("login.target", queryString);
         }
 
-        return;
+        _sendLoginPage(aResponse, aRequest);
       }
-       // if login succesful
-    }
-     // if login
-
-    if ((moduleName != null) && moduleName.equals("logout")) {
-      logger.info("--logout");
-      session.invalidate();
-
-      _sendLoginPage(aResponse, aRequest, aResponse.getWriter());
-
-      return;
-    }
+      else {
+        String moduleName = aRequest.getParameter("module");
+        checkLanguage(session, aRequest);
 
-    // Check if authed!
-    if (userEntity == null) {
-      // redirect to loginpage
-      String redirectString = aRequest.getRequestURI();
-      String queryString = aRequest.getQueryString();
-
-      if ((queryString != null) && queryString.length()!=0) {
-        redirectString += ("?" + aRequest.getQueryString());
-        session.setAttribute("login.target", redirectString);
-      }
+        if ( ( (moduleName == null) || moduleName.equals(""))) {
+          moduleName="Admin";
+        }
 
-      _sendLoginPage(aResponse, aRequest, aResponse.getWriter());
+        if (moduleName.equals("login")) {
+          String target = (String) session.getAttribute("login.target");
 
-      return;
-    }
+          if (target != null) {
+            ServletHelper.redirect(aResponse, target);
+          }
+          else {
+            ServletHelper.redirect(aResponse, "");
+          }
+        }
+        else if (moduleName.equals("logout")) {
+          logger.info(userEntity.getFieldValue("login") + " has logged out");
+          session.invalidate();
+          _sendLoginPage(aResponse, aRequest);
+          return;
+        }
+        else {
+          try {
+            AdminServletModule servletModule = getServletModuleForName(moduleName);
+            servletModule.handleRequest(aRequest, aResponse);
 
-    // If no module is specified goto standard startpage
-    if ((moduleName == null) || moduleName.equals("")) {
-//      logger.debug("no module: redirect to standardpage");
-      _sendStartPage(aResponse, aRequest, aResponse.getWriter(), userEntity);
+            sessionConnectTime = System.currentTimeMillis() - startTime;
+            logger.info("EXECTIME (" + moduleName + "): " + sessionConnectTime + " ms");
+          }
+          catch (Throwable e) {
+            Throwable cause = ExceptionRoutines.traceCauseException(e);
 
-      return;
-    }
+            if (cause instanceof ServletModuleUserExc)
+              handleUserError(aRequest, aResponse, (ServletModuleUserExc) cause);
+            else
+              handleError(aRequest, aResponse, cause);
+          }
 
-    try {
-      // get servletmodule by parameter and continue with dispacher
-      ServletModule smod = getServletModuleForName(moduleName);
-      ServletModuleDispatch.dispatch(smod, aRequest, aResponse);
+          if (aRequest.getParameter("killsession")!=null)
+            aRequest.getSession().invalidate();
+        }
+      }
     }
-    catch (Throwable e) {
-      Throwable cause = ExceptionFunctions.traceCauseException(e);
-
-      if (cause instanceof ServletModuleUserExc)
-        handleUserError(aRequest, aResponse, aResponse.getWriter(), (ServletModuleUserExc) cause);
-      else
-        handleError(aRequest, aResponse, aResponse.getWriter(), cause);
-
+    catch (Throwable t) {
+      throw new ServletException(t.toString());
     }
-
-    // timing...
-    sessionConnectTime = System.currentTimeMillis() - startTime;
-    logger.info("EXECTIME (" + moduleName + "): " + sessionConnectTime + " ms");
   }
 
   /**
-   *  Private method getServletModuleForName returns ServletModule
-   *  from Cache
-   *
-   * @param moduleName
-   * @return ServletModule
+   * caching routine to get a module for a module name
    *
+   * @param aModuleName the module name
+   * @return the requested module
+   * @throws ServletModuleExc
    */
-  private static ServletModule getServletModuleForName(String moduleName) throws ServletModuleExc {
-    // Instance in Map ?
-    if (!servletModuleInstanceHash.containsKey(moduleName)) {
-      // was not found in hash...
-      try {
-        Class theServletModuleClass = null;
-
-        try {
-          // first we try to get ServletModule from stern.che3.servlet
-          theServletModuleClass =
-            Class.forName("mircoders.servlet.ServletModule" + moduleName);
-        } catch (ClassNotFoundException e) {
-          // on failure, we try to get it from lib-layer
-          theServletModuleClass =
-            Class.forName("mir.servlet.ServletModule" + moduleName);
-        }
+  private static AdminServletModule getServletModuleForName(String aModuleName) throws ServletModuleExc {
+    return ServletHelper.getServletModule(aModuleName);
+  }
 
-        Method m = theServletModuleClass.getMethod("getInstance", null);
-        ServletModule smod = (ServletModule) m.invoke(null, null);
+  private void handleUserError(HttpServletRequest aRequest, HttpServletResponse aResponse, ServletModuleUserExc anException) {
+    try {
+      logger.info("user error: " + anException.getMessage());
 
-        // we put it into map for further reference
-        servletModuleInstanceHash.put(moduleName, smod);
+      Map responseData = ServletHelper.makeGenerationData(aRequest, aResponse, new Locale[] {getLocale(aRequest), getFallbackLocale()});
 
-        return smod;
-      }
-      catch (Exception e) {
-        throw new ServletModuleExc("*** error resolving classname for " + moduleName + " -- " + e.getMessage());
+      Bundle bundle =
+          MirGlobal.getBundleFactory().getBundle("etc/bundles/adminlocal", new
+              String[] { getLocale(aRequest).getLanguage() });
+      Bundle defaultBundle =
+          MirGlobal.getBundleFactory().getBundle("bundles/admin", new
+              String[] { getLocale(aRequest).getLanguage() });
+      String message =
+        bundle.getValue(anException.getMessage(), Arrays.asList(anException.getParameters()));
+
+      if (message==null) {
+        message =
+          defaultBundle.getValue(anException.getMessage(), Arrays.asList(anException.getParameters()));
       }
-    }
-    else {
-      return (ServletModule) servletModuleInstanceHash.get(moduleName);
-    }
-  }
 
-  private void handleUserError(HttpServletRequest aRequest, HttpServletResponse aResponse,
-                               PrintWriter out, ServletModuleUserExc anException) {
-    try {
-      logger.info("user error: " + anException.getMessage());
-      SimpleHash modelRoot = new SimpleHash();
-      MessageResources messages = MessageResources.getMessageResources("bundles.admin");
-      modelRoot.put("errorstring",
-          new SimpleScalar(
-              messages.getMessage(getLocale(aRequest), anException.getMessage(), anException.getParameters())
-          ));
-      modelRoot.put("date", new SimpleScalar(StringUtil.date2readableDateTime(new GregorianCalendar())));
-      HTMLTemplateProcessor.process(
-          aResponse,
-          MirPropertiesConfiguration.instance().getString("Mir.UserErrorTemplate"),
-          modelRoot,
-          null,
-          out,
-          getLocale(aRequest),
-          fallbackLocale);
-      out.close();
+      responseData.put("errorstring", message);
+      responseData.put("date", new GregorianCalendar().getTime());
+
+      ServletHelper.generateResponse(aResponse.getWriter(), responseData, MirPropertiesConfiguration.instance().getString("Mir.UserErrorTemplate"));
     }
     catch (Throwable e) {
       logger.error("Error handling user error" + e.toString());
     }
-
   }
 
-  private void handleError(HttpServletRequest aRequest, HttpServletResponse aResponse,PrintWriter out, Throwable anException) {
-
+  private void handleError(HttpServletRequest aRequest, HttpServletResponse aResponse, Throwable anException) {
     try {
       logger.error("error: " + anException);
-      SimpleHash modelRoot = new SimpleHash();
-      modelRoot.put("errorstring", new SimpleScalar(anException.getMessage()));
-      modelRoot.put("date", new SimpleScalar(StringUtil.date2readableDateTime(
-                                               new GregorianCalendar())));
-      HTMLTemplateProcessor.process(
-          aResponse,MirPropertiesConfiguration.instance().getString("Mir.ErrorTemplate"),
-          modelRoot,null,out, getLocale(aRequest), getFallbackLocale());
-      out.close();
+
+      Map responseData = ServletHelper.makeGenerationData(aRequest, aResponse, new Locale[] {getLocale(aRequest), getFallbackLocale()});
+
+      responseData.put("errorstring", anException.toString());
+      StringWriter writer = new StringWriter();
+      anException.printStackTrace(new PrintWriter(writer));
+      responseData.put("stacktrace", writer.toString());
+      responseData.put("date", new GregorianCalendar().getTime());
+
+      ServletHelper.generateResponse(aResponse.getWriter(), responseData, MirPropertiesConfiguration.instance().getString("Mir.ErrorTemplate"));
     }
     catch (Throwable e) {
       logger.error("Error handling error: " + e.toString());
-    }
-  }
 
-  /**
-   *  evaluate login for user / password
-   */
-  protected EntityUsers allowedUser(String user, String password) {
-    try {
-      if (usersModule == null) {
-        usersModule = new ModuleUsers(DatabaseUsers.getInstance());
+      try {
+        Throwable rootException = ExceptionRoutines.traceCauseException(anException);
+
+        PrintWriter writer = aResponse.getWriter();
+        writer.println("<html><head><title>FATAL Error</title><body>");
+        writer.println("<h1>" + rootException.toString()+"</h1>");
+        writer.println("<code>");
+        rootException.printStackTrace(writer);
+        writer.println("</code>");
+        writer.println("</body></html>");
+        writer.close();
       }
+      catch (Throwable t) {
 
-      return usersModule.getUserForLogin(user, password);
-    }
-    catch (Exception e) {
-      logger.debug(e.getMessage());
-      e.printStackTrace(logger.asPrintWriter(LoggerWrapper.DEBUG_MESSAGE));
-
-      return null;
+      }
     }
   }
 
   // Redirect-methods
-  private void _sendLoginPage(HttpServletResponse aResponse, HttpServletRequest aRequest,
-    PrintWriter out) {
+  private void _sendLoginPage(HttpServletResponse aResponse, HttpServletRequest aRequest) {
     String loginTemplate = configuration.getString("Mir.LoginTemplate");
-    String sessionUrl = aResponse.encodeURL("");
 
     try {
-      SimpleHash mergeData = new SimpleHash();
-      SimpleList languages = new SimpleList();
+      Map responseData = ServletHelper.makeGenerationData(aRequest, aResponse, new Locale[] {getLocale(aRequest), getFallbackLocale()});
 
-      mergeData.put("session", sessionUrl);
+      responseData.put("defaultlanguage", getDefaultLanguage(aRequest));
+      responseData.put("languages", getLoginLanguages());
 
-      mergeData.put("defaultlanguage", getDefaultLanguage(aRequest));
-      mergeData.put("languages", getLoginLanguages());
-
-      HTMLTemplateProcessor.process(aResponse, loginTemplate, mergeData, null, out, getLocale(aRequest), getFallbackLocale());
+      ServletHelper.generateResponse(aResponse.getWriter(), responseData, loginTemplate);
     }
     catch (Throwable e) {
-      handleError(aRequest, aResponse, out, e);
-    }
-  }
-
-  private void _sendStartPage(HttpServletResponse aResponse, HttpServletRequest aRequest,
-    PrintWriter out, EntityUsers userEntity) {
-    String startTemplate = configuration.getString("Mir.StartTemplate");
-    String sessionUrl = aResponse.encodeURL("");
-
-    try {
-      Map mergeData = ServletHelper.makeGenerationData(aResponse, new Locale[] {getLocale(aRequest), getFallbackLocale()}, "bundles.admin", "bundles.adminlocal");
-      mergeData.put("messages",
-             new CachingRewindableIterator(
-               new EntityIteratorAdapter( "", "webdb_create desc", 10,
-                 MirGlobal.localizer().dataModel().adapterModel(), "internalMessage", 10, 0)));
-
-      mergeData.put("fileeditentries", ((ServletModuleFileEdit) ServletModuleFileEdit.getInstance()).getEntries());
-      mergeData.put("administeroperations", ((ServletModuleLocalizer) ServletModuleLocalizer.getInstance()).getAdministerOperations());
-
-      mergeData.put("searchvalue", null);
-      mergeData.put("searchfield", null);
-      mergeData.put("searchispublished", null);
-      mergeData.put("searcharticletype", null);
-      mergeData.put("searchorder", null);
-      mergeData.put("selectarticleurl", null);
-
-      ServletHelper.generateResponse(out, mergeData, startTemplate);
-    }
-    catch (Exception e) {
-      e.printStackTrace(logger.asPrintWriter(LoggerWrapper.DEBUG_MESSAGE));
-      handleError(aRequest, aResponse, out, e);
+      handleError(aRequest, aResponse, e);
     }
   }
 
@@ -470,19 +338,21 @@ public class Mir extends AbstractServlet {
     return "Mir " + configuration.getString("Mir.Version");
   }
 
-/*  private void checkLanguage(HttpSession session, HttpServletRequest aRequest) {
-    // a lang parameter always sets the language
-    String lang = aRequest.getParameter("language");
+  private class SessionTracker implements HttpSessionBindingListener {
+    private String name;
+    private String id;
 
-    if (lang != null) {
-      logger.info("selected language " + lang + " overrides accept-language");
-      setLanguage(session, lang);
+    public SessionTracker(String aUserName, String anId) {
+      name = aUserName;
+      id = anId;
     }
-    // otherwise store language from accept header in session
-    else if (session.getAttribute("language") == null) {
-      logger.info("accept-language is " + aRequest.getLocale().getLanguage());
-      setLanguage(session, aRequest.getLocale().getLanguage());
+
+    public void valueBound(HttpSessionBindingEvent anEvent) {
+      MirGlobal.registerLogin(name, id);
+    }
+
+    public void valueUnbound(HttpSessionBindingEvent anEvent) {
+      MirGlobal.registerLogout(name, id);
     }
   }
-*/
 }