scripts/mir-setup/README: update with link to new doc on wiki
[mir.git] / source / Mir.java
index de34636..011b1f9 100755 (executable)
+/*
+ * Copyright (C) 2001-2006 The Mir-coders group
+ *
+ * This file is part of Mir.
+ *
+ * Mir is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * Mir 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Mir; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ * 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,
+ * 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
+ * exception to your version of the file, but you are not obligated to do so.
+ * If you do not wish to do so, delete this exception statement from your version.
+ */
 
-import freemarker.template.SimpleHash;
-import freemarker.template.SimpleScalar;
-import mir.misc.HTMLParseException;
-import mir.misc.HTMLTemplateProcessor;
-import mir.misc.MirConfig;
-import mir.misc.StringUtil;
-import mir.servlet.*;
+import mir.bundle.Bundle;
+import mir.config.MirPropertiesConfiguration;
+import mir.servlet.AbstractServlet;
+import mir.servlet.AdminServletModule;
+import mir.servlet.ServletModuleExc;
+import mir.servlet.ServletModuleUserExc;
+import mir.util.ExceptionRoutines;
+import mir.util.StringRoutines;
 import mircoders.entity.EntityUsers;
-import mircoders.module.ModuleMessage;
+import mircoders.global.MirGlobal;
 import mircoders.module.ModuleUsers;
-import mircoders.storage.DatabaseMessages;
-import mircoders.storage.DatabaseUsers;
+import mircoders.servlet.ServletHelper;
+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.lang.reflect.Method;
+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 RK 1999-2001
- *
- */
+public class Mir extends AbstractServlet {
+  private static ModuleUsers usersModule = null;
+  private static Locale fallbackLocale = null;
 
+  private static List loginLanguages = null;
 
-public class Mir extends AbstractServlet {
+  private List getLoginLanguages() throws Failure {
+    synchronized (Mir.class) {
+      try {
+        if (loginLanguages == null) {
+          List languages =
+            StringRoutines.splitString(MirGlobal.config().getString("Mir.Login.Languages", "en"), ";");
 
-    private static ModuleUsers usersModule = null;
-    private static ModuleMessage messageModule = null;
-    private final static HashMap servletModuleInstanceHash = new HashMap();
+          loginLanguages = new ArrayList();
 
-    public HttpSession session;
+          Iterator i = languages.iterator();
 
-    public void doGet(HttpServletRequest req, HttpServletResponse res)
-            throws ServletException, IOException {
-        doPost(req, res);
-    }
+          while (i.hasNext()) {
+            String code = (String) i.next();
 
-    public void doPost(HttpServletRequest req, HttpServletResponse res)
-            throws ServletException, IOException, UnavailableException {
+            Bundle bundle =
+                MirGlobal.getBundleFactory().getBundle("etc/bundles/adminlocal", new String[] { code });
+            Bundle defaultBundle =
+                MirGlobal.getBundleFactory().getBundle("bundles/admin", new String[] { code });
 
-        long startTime = System.currentTimeMillis();
-        long sessionConnectTime = 0;
-        String http = "";
+            String name = bundle.getValue("languagename", Collections.EMPTY_LIST);
 
-        // get the configration - this could conflict if 2 mirs are in the
-        // VM maybe? to be checked. -mh
-        if (getServletContext().getAttribute("mir.confed") == null) {
-            getConfig(req);
-        }
-        MirConfig.setServletName(getServletName());
-
-        session = req.getSession(true);
-
-        if (req.getServerPort() == 443) http = "https"; else http = "http";
-        res.setContentType("text/html");
-        String moduleName = req.getParameter("module");
-
-        checkLanguage(session, req);
-
-        /** @todo for cleanup and readability this should be moved to
-         *  method loginIfNecessary() */
-
-        // Authentifizierung
-        if (moduleName != null && moduleName.equals("login")) {
-            String user = req.getParameter("login");
-            String passwd = req.getParameter("password");
-            theLog.printDebugInfo("--login: evaluating for user: " + user);
-            EntityUsers userEntity = allowedUser(user, passwd);
-            if (userEntity == null) {
-                // login failed: redirecting to login
-                theLog.printWarning("--login: failed!");
-                _sendLoginPage(res, req, res.getWriter());
-                return;
+            if (name == null) {
+              name = defaultBundle.getValue("languagename", Collections.EMPTY_LIST);
             }
-            else {
-                // login successful
-
-                theLog.printInfo("--login: successful! setting uid: " + userEntity.getId());
-                session.setAttribute("login.uid", userEntity);
-                theLog.printDebugInfo("--login: trying to retrieve login.target");
-                String target = (String) session.getAttribute("login.target");
-
-                if (target != null) {
-                    theLog.printDebugInfo("Redirect: " + target);
-                    int serverPort = req.getServerPort();
-                    String redirect = "";
-                    String redirectString = "";
-
-
-                    if (serverPort == 80) {
-                        redirect = res.encodeURL(http + "://" + req.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 = res.encodeURL(http + "://" + req.getServerName() + ":" + req.getServerPort() + target);
-                        redirectString = "<html><head><meta http-equiv=refresh content=\"1;URL="
-                                + redirect
-                                + "\"></head><body>going <a href=\"" + redirect + "\">Mir</a></body></html>";
-                    }
-                    res.getWriter().println(redirectString);
-
-
-                    //res.sendRedirect(redirect);
-
-                }
-                else {
-                    // redirecting to default target
-                    theLog.printDebugInfo("--login: no target - redirecting to default");
-                    _sendStartPage(res, req, res.getWriter(), userEntity);
-                }
-                return;
-            } // if login succesful
-        } // if login
-
-        if (moduleName != null && moduleName.equals("logout")) {
-            theLog.printDebugInfo("--logout");
-            session.invalidate();
-
-            //session = req.getSession(true);
-            //checkLanguage(session, req);
-            _sendLoginPage(res, req, res.getWriter());
-            return;
-        }
 
-        // Check if authed!
-        EntityUsers userEntity = (EntityUsers) session.getAttribute("login.uid");
-        if (userEntity == null) {
-            // redirect to loginpage
-            String redirectString = req.getRequestURI();
-            String queryString = req.getQueryString();
-            if (queryString != null && !queryString.equals("")) {
-                redirectString += "?" + req.getQueryString();
-                theLog.printDebugInfo("STORING: " + redirectString);
-                session.setAttribute("login.target", redirectString);
+            if (name == null) {
+              name = code;
             }
-            _sendLoginPage(res, req, res.getWriter());
-            return;
-        }
 
-        // If no module is specified goto standard startpage
-        if (moduleName == null || moduleName.equals("")) {
-            theLog.printDebugInfo("no module: redirect to standardpage");
-            _sendStartPage(res, req, res.getWriter(), userEntity);
-            return;
+            Map record = new HashMap();
+            record.put("name", name);
+            record.put("code", code);
+            loginLanguages.add(record);
+          }
         }
-        // end of auth
 
-        // From now on regular dispatching...
-        try {
-            // get servletmodule by parameter and continue with dispacher
-            ServletModule smod = getServletModuleForName(moduleName);
-            ServletModuleDispatch.dispatch(smod, req, res);
-        }
-        catch (ServletModuleException e) {
-            handleError(req, res, res.getWriter(),
-                        "ServletException in Module " + moduleName + " -- " + e.toString());
-        }
-        catch (ServletModuleUserException e) {
-            handleUserError(req, res, res.getWriter(), "User error" + e.toString());
-        }
+        return loginLanguages;
+      }
+      catch (Throwable t) {
+        throw new Failure("Error while retrieving the available login languages", t);
+      }
+    }
+  }
 
-        // timing...
-        sessionConnectTime = System.currentTimeMillis() - startTime;
-        theLog.printInfo("EXECTIME (" + moduleName + "): " + sessionConnectTime + " ms");
+  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", "");
+
+    if (defaultlanguage.length() == 0) {
+      Locale locale = aRequest.getLocale();
+      defaultlanguage = locale.getLanguage();
     }
 
+    return defaultlanguage;
+  }
 
-    /**
-     *  Private method getServletModuleForName returns ServletModule
-     *  from Cache
-     *
-     * @return ServletModule
-     *
-     */
-    private static ServletModule getServletModuleForName(String moduleName)
-            throws ServletModuleException {
-
-        // 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);
-                }
-                Method m = theServletModuleClass.getMethod("getInstance", null);
-                ServletModule smod = (ServletModule) m.invoke(null, null);
-                // we put it into map for further reference
-                servletModuleInstanceHash.put(moduleName, smod);
-                return smod;
-            }
-            catch (Exception e) {
-                throw new ServletModuleException("*** error resolving classname for " +
-                                                 moduleName + " -- " + e.toString());
-            }
-        }
-        else
-            return (ServletModule) servletModuleInstanceHash.get(moduleName);
+  protected synchronized Locale getFallbackLocale() throws ServletException {
+    try {
+      if (fallbackLocale == null) {
+        fallbackLocale = new Locale(MirPropertiesConfiguration.instance().getString("Mir.Admin.FallbackLanguage", "en"), "");
+      }
+    }
+    catch (Throwable t) {
+      throw new ServletException(t.getMessage());
     }
 
+    return fallbackLocale;
+  }
 
-    private void handleError(HttpServletRequest req, HttpServletResponse res,
-                             PrintWriter out, String errorString) {
+  public EntityUsers checkCredentials(HttpServletRequest aRequest) throws ServletException {
+    try {
+      EntityUsers user = ServletHelper.getUser(aRequest);
 
-        try {
-            theLog.printError(errorString);
-            SimpleHash modelRoot = new SimpleHash();
-            modelRoot.put("errorstring", new SimpleScalar(errorString));
-            modelRoot.put("date", new SimpleScalar(StringUtil.date2readableDateTime(new GregorianCalendar())));
-            HTMLTemplateProcessor.process(res, MirConfig.getProp("Mir.ErrorTemplate"), modelRoot, out, getLocale(req));
-            out.close();
-        }
-        catch (Exception e) {
-            System.err.println("Error in ErrorTemplate");
+      String username = aRequest.getParameter("login");
+      String password = aRequest.getParameter("password");
+
+      if (username != null && password != null) {
+        user = usersModule.getUserForLogin(username, password);
+
+        if (user!=null) {
+          ServletHelper.setUser(aRequest, user);
+          usersModule.recordLogin(user);
+          aRequest.getSession().setAttribute("sessiontracker", new SessionTracker(username, user.getId()));
         }
+      }
+
+      return user;
     }
+    catch (Throwable t) {
+      throw new ServletException(t.getMessage());
+    }
+  }
+
+  public void process(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletException, IOException, UnavailableException {
+    try {
+      long startTime = System.currentTimeMillis();
+      long sessionConnectTime = 0;
+
+      HttpSession session = aRequest.getSession(true);
+      setNoCaching(aResponse);
+      aResponse.setContentType("text/html; charset=" +
+                               configuration.
+                               getString("Mir.DefaultHTMLCharset", "UTF-8"));
+
+      EntityUsers userEntity = checkCredentials(aRequest);
 
-    private void handleUserError(HttpServletRequest req, HttpServletResponse res,
-                                 PrintWriter out, String errorString) {
-        try {
-            theLog.printError(errorString);
-            SimpleHash modelRoot = new SimpleHash();
-            modelRoot.put("errorstring", new SimpleScalar(errorString));
-            modelRoot.put("date", new SimpleScalar(StringUtil.date2readableDateTime(new GregorianCalendar())));
-            HTMLTemplateProcessor.process(res, MirConfig.getProp("Mir.UserErrorTemplate"),
-                                          modelRoot, out, getLocale(req));
-            out.close();
+      if (userEntity == null) {
+        String queryString = aRequest.getQueryString();
+
+        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);
         }
-        catch (Exception e) {
-            System.err.println("Fehler in UserErrorTemplate");
+
+        _sendLoginPage(aResponse, aRequest);
+      }
+      else {
+        String moduleName = aRequest.getParameter("module");
+        checkLanguage(session, aRequest);
+
+        if ( ( (moduleName == null) || moduleName.equals(""))) {
+          moduleName="Admin";
         }
 
-    }
+        if (moduleName.equals("login")) {
+          String target = (String) session.getAttribute("login.target");
 
-    /**
-     *  evaluate login for user / password
-     */
-    protected EntityUsers allowedUser(String user, String password) {
-        try {
-            if (usersModule == null) usersModule = new ModuleUsers(DatabaseUsers.getInstance());
-            return usersModule.getUserForLogin(user, password);
+          if (target != null) {
+            ServletHelper.redirect(aResponse, target);
+          }
+          else {
+            ServletHelper.redirect(aResponse, "");
+          }
         }
-        catch (Exception e) {
-            theLog.printDebugInfo(e.toString());
-            e.printStackTrace();
-            return null;
+        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);
+
+            sessionConnectTime = System.currentTimeMillis() - startTime;
+            logger.info("EXECTIME (" + moduleName + "): " + sessionConnectTime + " ms");
+          }
+          catch (Throwable e) {
+            Throwable cause = ExceptionRoutines.traceCauseException(e);
+
+            if (cause instanceof ServletModuleUserExc)
+              handleUserError(aRequest, aResponse, (ServletModuleUserExc) cause);
+            else
+              handleError(aRequest, aResponse, cause);
+          }
+
+          if (aRequest.getParameter("killsession")!=null)
+            aRequest.getSession().invalidate();
+        }
+      }
+    }
+    catch (Throwable t) {
+      throw new ServletException(t.toString());
+    }
+  }
+
+  /**
+   * caching routine to get a module for a module name
+   *
+   * @param aModuleName the module name
+   * @return the requested module
+   * @throws ServletModuleExc
+   */
+  private static AdminServletModule getServletModuleForName(String aModuleName) throws ServletModuleExc {
+    return ServletHelper.getServletModule(aModuleName);
+  }
+
+  private void handleUserError(HttpServletRequest aRequest, HttpServletResponse aResponse, ServletModuleUserExc anException) {
+    try {
+      logger.info("user error: " + anException.getMessage());
+
+      Map responseData = ServletHelper.makeGenerationData(aRequest, aResponse, new Locale[] {getLocale(aRequest), getFallbackLocale()});
+
+      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()));
+      }
+
+      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());
     }
+  }
 
-    // Redirect-methods
-    private void _sendLoginPage(HttpServletResponse res, HttpServletRequest req, PrintWriter out) {
-        String loginTemplate = MirConfig.getProp("Mir.LoginTemplate");//"login.template";
-        //  theLog.printDebugInfo("login template: "+loginTemplate);
-        String sessionUrl = res.encodeURL("");
-        //session = req.getSession(true);
-        try {
-            //theLog.printDebugInfo("login: "+lang);
-            //if(lang==null){
-            //  lang=getAcceptLanguage(req);
-            //}
-            SimpleHash mergeData = new SimpleHash();
-            mergeData.put("session", sessionUrl);
-            HTMLTemplateProcessor.process(res, loginTemplate, mergeData, out, getLocale(req));
-        }
-        catch (HTMLParseException e) {
-            handleError(req, res, out, "Error in logintemplate.");
-        }
+  private void handleError(HttpServletRequest aRequest, HttpServletResponse aResponse, Throwable anException) {
+    try {
+      logger.error("error: " + anException);
+
+      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());
+
+      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) {
+
+      }
+    }
+  }
 
-    private void _sendStartPage(HttpServletResponse res, HttpServletRequest req, PrintWriter out, EntityUsers userEntity) {
-        String startTemplate = "admin/start_admin.template";
-        String sessionUrl = res.encodeURL("");
-        try {
-            // merge with logged in user and messages
-            SimpleHash mergeData = new SimpleHash();
-            mergeData.put("session", sessionUrl);
-            mergeData.put("login_user", userEntity);
-            if (messageModule == null) messageModule = new ModuleMessage(DatabaseMessages.getInstance());
-            mergeData.put("messages", messageModule.getByWhereClause(null, "webdb_create desc", 0, 10));
-            HTMLTemplateProcessor.process(res, startTemplate, mergeData, out, getLocale(req));
-        }
-        catch (Exception e) {
-            handleError(req, res, out, "error while trying to send startpage. " + e.toString());
-        }
+  // Redirect-methods
+  private void _sendLoginPage(HttpServletResponse aResponse, HttpServletRequest aRequest) {
+    String loginTemplate = configuration.getString("Mir.LoginTemplate");
+
+    try {
+      Map responseData = ServletHelper.makeGenerationData(aRequest, aResponse, new Locale[] {getLocale(aRequest), getFallbackLocale()});
+
+      responseData.put("defaultlanguage", getDefaultLanguage(aRequest));
+      responseData.put("languages", getLoginLanguages());
+
+      ServletHelper.generateResponse(aResponse.getWriter(), responseData, loginTemplate);
     }
+    catch (Throwable e) {
+      handleError(aRequest, aResponse, e);
+    }
+  }
+
+  public String getServletInfo() {
+    return "Mir " + configuration.getString("Mir.Version");
+  }
 
-    public String getServletInfo() {
-        return "Mir 1.0 rev02 multilanguage";
+  private class SessionTracker implements HttpSessionBindingListener {
+    private String name;
+    private String id;
+
+    public SessionTracker(String aUserName, String anId) {
+      name = aUserName;
+      id = anId;
     }
 
-    private void checkLanguage(HttpSession session, HttpServletRequest req) {
+    public void valueBound(HttpSessionBindingEvent anEvent) {
+      MirGlobal.registerLogin(name, id);
+    }
 
-        // a lang parameter always sets the language
-        String lang = req.getParameter("lang");
-        if (lang != null) {
-            theLog.printInfo("selected language "+lang+" overrides accept-language");
-            setLanguage(session, lang);
-            setLocale(session, new Locale(lang, ""));
-        }
-        // otherwise store language from accept header in session
-        else if (session.getAttribute("Language") == null) {
-            theLog.printInfo("accept-language is "+req.getLocale().getLanguage());
-            setLanguage(session, req.getLocale().getLanguage());
-            setLocale(session, req.getLocale());
-        }
+    public void valueUnbound(HttpSessionBindingEvent anEvent) {
+      MirGlobal.registerLogout(name, id);
     }
+  }
 }
-