merged with 1.1
[mir.git] / source / Mir.java
index c8bb32d..6ec9e62 100755 (executable)
-import java.io.*;
-import java.util.*;
-import java.net.*;
-import java.lang.reflect.*;
-import javax.servlet.*;
-import javax.servlet.http.*;
-import java.sql.*;
-
-import freemarker.template.*;
-
-import webdb.misc.*;
-import webdb.servlet.*;
-
-import mir.servlet.*;
-import mir.module.*;
-import mir.entity.*;
-import mir.storage.*;
-
-/**
- *  Mir.java - main servlet, that dispatches to servletmodules
- *
- *  @author RK 1999-2001
- *
- */
-
-
-public class Mir extends AbstractServlet
-{
-
-       private static ModuleUsers usersModule=null;
-       private static ModuleMessage messageModule=null;
-       private static boolean confed=false;
-
-
-       public void doGet(HttpServletRequest req, HttpServletResponse res)
-               throws ServletException, IOException {
-               doPost(req,res);
-       }
-
-       public void doPost(HttpServletRequest req, HttpServletResponse res)
-               throws ServletException, IOException {
-
-               long            startTime = (new java.util.Date()).getTime();
-               Class           theServletModule;
-               ServletModule   smod;
-               long            sessionConnectTime=0;
-               String          http="";
-
-               // get the configration
-    if (!confed){
-      confed = getConfig(req);
-    }
-
-
-               if (req.getServerPort() == 443) http="https";   else http="http";
-               res.setContentType("text/html");
-               String moduleName = req.getParameter("module");
-    HttpSession session = req.getSession(true);
-
-    if(session.getAttribute("Language")==null){
-      setLanguage(req,getAcceptLanguage(req));
-    }
-
-               // Authentifizierung
-               if (moduleName!=null && moduleName.equals("login")) {
-                       String user=req.getParameter("login");
-                       String passwd= req.getParameter("password");
-      String lang = req.getParameter("lang");
-                       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(req,res.getWriter());
-                               return;
-                       }       else {
-                               // login successful
-
-        //if accept-language!=selected language change language
-        if(!getLanguage(req).equals(lang)){
-          setLanguage(req,lang);
-        }
-
-                               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);
-                                       res.getWriter().println("<html><head><meta http-equiv=refresh content=\0421;URL="
-                                                                       + res.encodeURL(http +"://" + req.getServerName()+ target)
-                                                                       + "\"></head><body>going " + target + "</body></html>");
-                               } else {
-                                       // redirecting to default target
-                                       //theLog.printDebugInfo("--login: no target - redirecting to default");
-                                       _sendStartPage(req, res.getWriter(),userEntity);
-                               }
-                               return;
-                       } // if login succesful
-               } // if login
-
-               if (moduleName!=null && moduleName.equals("logout")) {
-                       theLog.printDebugInfo("--logout");
-                       session.invalidate();
-                       _sendLoginPage(req,res.getWriter());
-                       return;
-               }
-
-               // Check if authed!
-               EntityUsers userEntity = (EntityUsers)session.getAttribute("login.uid");
-               if (userEntity == null) {
-                       // redirect to loginpage
-                       String redirectString = req.getRequestURI();
-                       if (req.getQueryString()!=null) redirectString += "?" + req.getQueryString();
-                       theLog.printDebugInfo("STORING: " + redirectString);
-                       session.setAttribute("login.target", redirectString);
-                       _sendLoginPage(req,res.getWriter());
-                       return;
-               }
-
-               // Bei blossem Serveltaufruf redirect auf Standardstarttemplate
-               if (moduleName == null || moduleName.equals("")) {
-                       _sendStartPage(req, res.getWriter(),userEntity);
-                       return;
-               }
-
-               //From now on normal Dispatching...
-               try {
-                       try {
-        theServletModule = Class.forName("mir.servlet.ServletModule" + moduleName);
-                       } catch (ClassNotFoundException e) {
-        // searching Servlet webdb.servlet-classes
-        theServletModule = Class.forName("webdb.servlet.ServletModule" + moduleName);
-                       }
-      //Instanciate the ServletModule
-                       Method m = theServletModule.getMethod("getInstance",null);
-                       smod = (ServletModule)m.invoke(null,null);
-                       ServletModuleDispatch.dispatch(smod,req,res);
-               }
-               catch (NoSuchMethodException e) { handleError( res.getWriter(), "ServletModule" + moduleName + " getInstance() nicht gefunden."); }
-               catch (InvocationTargetException e) { handleError( res.getWriter(), "ServletModule" + moduleName + " target nicht gefunden."); }
-               catch (ClassNotFoundException e) { handleError( res.getWriter(), "ServletModule" + moduleName + " nicht gefunden."); }
-               catch (IllegalArgumentException e) { handleError( res.getWriter(), "ServletModule" + moduleName + " nicht gefunden."); }
-               catch (ServletModuleException e){ handleError(res.getWriter(), "ServletException in Module ServletModule" + moduleName + " -- " + e.toString()); }
-               catch (IllegalAccessException e){
-                               handleError(res.getWriter(), "Kein Zugriff auf Klasse ServletModule" + moduleName + " -- " + e.toString()); }
-
-               // timing...
-               sessionConnectTime = new java.util.Date().getTime() - startTime;
-               theLog.printInfo("EXECTIME (" + moduleName + "): " + sessionConnectTime + " ms");
-       }
-
-       private void handleError(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(Configuration.getProperty("Mir.ErrorTemplate"),modelRoot,out);
-                       out.close();
-               }
-               catch (Exception e) {
-                       System.err.println("Fehler in ErrorTemplate");
-               }
-       }
-
-       /**
-        *  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);
-               }
-               catch(Exception e) { theLog.printDebugInfo(e.toString()); return null; }
-       }
-
-       // Redirect-methods
-       private void _sendLoginPage(HttpServletRequest req, PrintWriter out) {
-    String loginTemplate = "login.template";
-               try {
-      theLog.printDebugInfo("login: "+lang);
-                       if(lang==null){
-                               lang=getAcceptLanguage(req);
-                       }
-                       HTMLTemplateProcessor.process(lang+"/"+loginTemplate, new SimpleHash(), out);
-               }       catch(HTMLParseException e) {
-                       handleError( out, "fehler in logintemplate.");
-               }
-       }
-
-       private void _sendStartPage(HttpServletRequest req,PrintWriter out, EntityUsers userEntity) {
-               String startTemplate = "start_admin.template";
-               try {
-                       // merge with logged in user and messages
-                       SimpleHash mergeData = new SimpleHash();
-                       mergeData.put("login_user", HTMLTemplateProcessor.makeSimpleHash(userEntity));
-                       if (messageModule == null) messageModule = new ModuleMessage(DatabaseMessages.getInstance());
-                       mergeData.put("messages", HTMLTemplateProcessor.makeSimpleList(messageModule.getByWhereClause(null, "webdb_create desc",0,10)));
-                       HTMLTemplateProcessor.process(getLanguage(req)+"/"+startTemplate, mergeData,out);
-               }
-               catch(Exception e) {
-                       handleError( out, "error while trying to send startpage. " + e.toString());
-               }
-       }
-
-       public String getServletInfo(){ return "Mir 1.0 rev02 multilanguage"; }
-
-}
-
+/*\r
+ * Copyright (C) 2001, 2002 The Mir-coders group\r
+ *\r
+ * This file is part of Mir.\r
+ *\r
+ * Mir is free software; you can redistribute it and/or modify\r
+ * it under the terms of the GNU General Public License as published by\r
+ * the Free Software Foundation; either version 2 of the License, or\r
+ * (at your option) any later version.\r
+ *\r
+ * Mir is distributed in the hope that it will be useful,\r
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
+ * GNU General Public License for more details.\r
+ *\r
+ * You should have received a copy of the GNU General Public License\r
+ * along with Mir; if not, write to the Free Software\r
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
+ *\r
+ * In addition, as a special exception, The Mir-coders gives permission to link\r
+ * the code of this program with  any library licensed under the Apache Software License,\r
+ * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library\r
+ * (or with modified versions of the above that use the same license as the above),\r
+ * and distribute linked combinations including the two.  You must obey the\r
+ * GNU General Public License in all respects for all of the code used other than\r
+ * the above mentioned libraries.  If you modify this file, you may extend this\r
+ * exception to your version of the file, but you are not obligated to do so.\r
+ * If you do not wish to do so, delete this exception statement from your version.\r
+ */\r
+\r
+import java.io.IOException;\r
+import java.lang.reflect.Method;\r
+import java.util.*;\r
+import java.util.HashMap;\r
+import java.util.Iterator;\r
+import java.util.List;\r
+import java.util.Locale;\r
+import java.util.Map;\r
+import java.util.Vector;\r
+import javax.servlet.ServletConfig;\r
+import javax.servlet.ServletException;\r
+import javax.servlet.UnavailableException;\r
+import javax.servlet.http.HttpServletRequest;\r
+import javax.servlet.http.HttpServletResponse;\r
+import javax.servlet.http.HttpSession;\r
+\r
+import org.apache.struts.util.MessageResources;\r
+import mir.config.MirPropertiesConfiguration;\r
+import mir.servlet.AbstractServlet;\r
+import mir.servlet.ServletModule;\r
+import mir.servlet.ServletModuleDispatch;\r
+import mir.servlet.ServletModuleExc;\r
+import mir.servlet.ServletModuleUserExc;\r
+import mir.util.ExceptionFunctions;\r
+import mir.util.StringRoutines;\r
+import mircoders.entity.EntityUsers;\r
+import mircoders.global.MirGlobal;\r
+import mircoders.module.ModuleMessage;\r
+import mircoders.module.ModuleUsers;\r
+import mircoders.servlet.ServletHelper;\r
+import mircoders.storage.DatabaseUsers;\r
+\r
+\r
+\r
+\r
+/**\r
+ * Mir.java - main servlet, that dispatches to servletmodules\r
+ *\r
+ * @author $Author: zapata $\r
+ * @version $Id: Mir.java,v 1.50 2003/09/03 18:29:01 zapata Exp $\r
+ *\r
+ */\r
+public class Mir extends AbstractServlet {\r
+  private static ModuleUsers usersModule = null;\r
+  private static ModuleMessage messageModule = null;\r
+  private final static Map servletModuleInstanceHash = new HashMap();\r
+  private static Locale fallbackLocale = null;\r
+\r
+  private static List loginLanguages = null;\r
+\r
+  protected List getLoginLanguages() throws ServletException {\r
+    synchronized (Mir.class) {\r
+      try {\r
+        if (loginLanguages == null) {\r
+          MessageResources messageResources =\r
+            MessageResources.getMessageResources("bundles.adminlocal");\r
+          MessageResources messageResources2 =\r
+            MessageResources.getMessageResources("bundles.admin");\r
+\r
+          List languages =\r
+            StringRoutines.splitString(MirGlobal.config().getString("Mir.Login.Languages", "en"), ";");\r
+\r
+          loginLanguages = new Vector();\r
+\r
+          Iterator i = languages.iterator();\r
+\r
+          while (i.hasNext()) {\r
+            String code = (String) i.next();\r
+            Locale locale = new Locale(code, "");\r
+            String name = messageResources.getMessage(locale, "languagename");\r
+\r
+            if (name == null) {\r
+              name = messageResources2.getMessage(locale, "languagename");\r
+            }\r
+\r
+            if (name == null) {\r
+              name = code;\r
+            }\r
+\r
+            Map record = new HashMap();\r
+            record.put("name", name);\r
+            record.put("code", code);\r
+            loginLanguages.add(record);\r
+          }\r
+        }\r
+\r
+        return loginLanguages;\r
+      }\r
+      catch (Throwable t) {\r
+        throw new ServletException(t.getMessage());\r
+      }\r
+    }\r
+  }\r
+\r
+  public void init(ServletConfig config) throws ServletException {\r
+    super.init(config);\r
+\r
+    usersModule = new ModuleUsers(DatabaseUsers.getInstance());\r
+  }\r
+\r
+  protected String getDefaultLanguage(HttpServletRequest aRequest) {\r
+    String defaultlanguage =\r
+      MirGlobal.config().getString("Mir.Login.DefaultLanguage", "");\r
+\r
+    if (defaultlanguage.length() == 0) {\r
+      Locale locale = aRequest.getLocale();\r
+      defaultlanguage = locale.getLanguage();\r
+    }\r
+\r
+    return defaultlanguage;\r
+  }\r
+\r
+  protected synchronized Locale getFallbackLocale() throws ServletException {\r
+    try {\r
+      if (fallbackLocale == null) {\r
+        fallbackLocale = new Locale(MirPropertiesConfiguration.instance().getString("Mir.Admin.FallbackLanguage", "en"), "");\r
+      }\r
+    }\r
+    catch (Throwable t) {\r
+      throw new ServletException(t.getMessage());\r
+    }\r
+\r
+    return fallbackLocale;\r
+  }\r
+\r
+  public EntityUsers checkCredentials(HttpServletRequest aRequest) throws ServletException {\r
+    try {\r
+      EntityUsers user = ServletHelper.getUser(aRequest);\r
+\r
+      String username = aRequest.getParameter("login");\r
+      String password = aRequest.getParameter("password");\r
+\r
+      if (username != null && password != null) {\r
+        user = usersModule.getUserForLogin(username, password);\r
+\r
+\r
+        ServletHelper.setUser(aRequest, user);\r
+      }\r
+\r
+      return user;\r
+    }\r
+    catch (Throwable t) {\r
+      t.printStackTrace();\r
+\r
+      throw new ServletException(t.toString());\r
+    }\r
+  }\r
+\r
+  public void process(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletException, IOException, UnavailableException {\r
+    try {\r
+      long startTime = System.currentTimeMillis();\r
+      long sessionConnectTime = 0;\r
+\r
+      HttpSession session = aRequest.getSession(true);\r
+      setNoCaching(aResponse);\r
+      Locale locale = new Locale(getDefaultLanguage(aRequest), "");\r
+      aResponse.setContentType("text/html; charset=" +\r
+                               configuration.\r
+                               getString("Mir.DefaultHTMLCharset", "UTF-8"));\r
+\r
+      EntityUsers userEntity = checkCredentials(aRequest);\r
+\r
+      if (userEntity == null) {\r
+        String queryString = aRequest.getQueryString();\r
+\r
+        if ( (queryString != null) && (queryString.length() != 0) && session.getAttribute("login.target") == null &&\r
+             (aRequest.getParameter("module")==null ||\r
+              (!aRequest.getParameter("module").equals("login") && !aRequest.getParameter("module").equals("logout")))) {\r
+          session.setAttribute("login.target", queryString);\r
+        }\r
+\r
+        _sendLoginPage(aResponse, aRequest);\r
+      }\r
+      else {\r
+        String moduleName = aRequest.getParameter("module");\r
+        checkLanguage(session, aRequest);\r
+\r
+        if ( ( (moduleName == null) || moduleName.equals(""))) {\r
+          moduleName="Admin";\r
+        }\r
+\r
+\r
+        if (moduleName.equals("login")) {\r
+          String target = (String) session.getAttribute("login.target");\r
+\r
+          if (target != null) {\r
+            ServletHelper.redirect(aResponse, target);\r
+          }\r
+          else {\r
+            ServletHelper.redirect(aResponse, "");\r
+          }\r
+        }\r
+        else if (moduleName.equals("logout")) {\r
+          logger.info(userEntity.getValue("login") + " has logged out");\r
+          session.invalidate();\r
+          _sendLoginPage(aResponse, aRequest);\r
+          return;\r
+        }\r
+        else {\r
+          try {\r
+            ServletModule servletModule = getServletModuleForName(moduleName);\r
+            ServletModuleDispatch.dispatch(servletModule, aRequest, aResponse);\r
+\r
+            sessionConnectTime = System.currentTimeMillis() - startTime;\r
+            logger.info("EXECTIME (" + moduleName + "): " + sessionConnectTime + " ms");\r
+          }\r
+          catch (Throwable e) {\r
+            Throwable cause = ExceptionFunctions.traceCauseException(e);\r
+\r
+            if (cause instanceof ServletModuleUserExc)\r
+              handleUserError(aRequest, aResponse, (ServletModuleUserExc) cause);\r
+            else\r
+              handleError(aRequest, aResponse, cause);\r
+          }\r
+\r
+          if (aRequest.getParameter("killsession")!=null)\r
+            aRequest.getSession().invalidate();\r
+        }\r
+      }\r
+    }\r
+    catch (Throwable t) {\r
+      t.printStackTrace();\r
+\r
+      throw new ServletException(t.toString());\r
+    }\r
+  }\r
+\r
+  /**\r
+   * caching routine to get a module for a module name\r
+   *\r
+   * @param moduleName the module name\r
+   * @return the requested module\r
+   * @throws ServletModuleExc\r
+   */\r
+\r
+  private static ServletModule getServletModuleForName(String moduleName) throws ServletModuleExc {\r
+    // Instance in Map ?\r
+    if (!servletModuleInstanceHash.containsKey(moduleName)) {\r
+      // was not found in hash...\r
+      try {\r
+        Class theServletModuleClass = null;\r
+\r
+        try {\r
+          // first we try to get ServletModule from stern.che3.servlet\r
+          theServletModuleClass =\r
+            Class.forName("mircoders.servlet.ServletModule" + moduleName);\r
+        }\r
+        catch (ClassNotFoundException e) {\r
+          // on failure, we try to get it from lib-layer\r
+          theServletModuleClass =\r
+            Class.forName("mir.servlet.ServletModule" + moduleName);\r
+        }\r
+\r
+        Method m = theServletModuleClass.getMethod("getInstance", null);\r
+        ServletModule smod = (ServletModule) m.invoke(null, null);\r
+\r
+        // we put it into map for further reference\r
+        servletModuleInstanceHash.put(moduleName, smod);\r
+\r
+        return smod;\r
+      }\r
+      catch (Exception e) {\r
+        throw new ServletModuleExc("*** error resolving classname for " + moduleName + " -- " + e.getMessage());\r
+      }\r
+    }\r
+    else {\r
+      return (ServletModule) servletModuleInstanceHash.get(moduleName);\r
+    }\r
+  }\r
+\r
+  private void handleUserError(HttpServletRequest aRequest, HttpServletResponse aResponse, ServletModuleUserExc anException) {\r
+    try {\r
+      logger.info("user error: " + anException.getMessage());\r
+\r
+      Map responseData = ServletHelper.makeGenerationData(aRequest, aResponse, new Locale[] {getLocale(aRequest), getFallbackLocale()});\r
+\r
+      MessageResources messages = MessageResources.getMessageResources("bundles.admin");\r
+      responseData.put("errorstring", messages.getMessage(getLocale(aRequest), anException.getMessage(), anException.getParameters()));\r
+      responseData.put("date", new GregorianCalendar().getTime());\r
+\r
+      ServletHelper.generateResponse(aResponse.getWriter(), responseData, MirPropertiesConfiguration.instance().getString("Mir.UserErrorTemplate"));\r
+    }\r
+    catch (Throwable e) {\r
+      logger.error("Error handling user error" + e.toString());\r
+    }\r
+  }\r
+\r
+  private void handleError(HttpServletRequest aRequest, HttpServletResponse aResponse, Throwable anException) {\r
+    try {\r
+      logger.error("error: " + anException);\r
+\r
+      Map responseData = ServletHelper.makeGenerationData(aRequest, aResponse, new Locale[] {getLocale(aRequest), getFallbackLocale()});\r
+\r
+      responseData.put("errorstring", anException.toString());\r
+      responseData.put("date", new GregorianCalendar().getTime());\r
+\r
+      ServletHelper.generateResponse(aResponse.getWriter(), responseData, MirPropertiesConfiguration.instance().getString("Mir.ErrorTemplate"));\r
+    }\r
+    catch (Throwable e) {\r
+      logger.error("Error handling error: " + e.toString());\r
+    }\r
+  }\r
+\r
+  // Redirect-methods\r
+  private void _sendLoginPage(HttpServletResponse aResponse, HttpServletRequest aRequest) {\r
+    String loginTemplate = configuration.getString("Mir.LoginTemplate");\r
+\r
+    try {\r
+      Map responseData = ServletHelper.makeGenerationData(aRequest, aResponse, new Locale[] {getLocale(aRequest), getFallbackLocale()});\r
+\r
+      responseData.put("defaultlanguage", getDefaultLanguage(aRequest));\r
+      responseData.put("languages", getLoginLanguages());\r
+\r
+      ServletHelper.generateResponse(aResponse.getWriter(), responseData, loginTemplate);\r
+    }\r
+    catch (Throwable e) {\r
+      handleError(aRequest, aResponse, e);\r
+    }\r
+  }\r
+\r
+  public String getServletInfo() {\r
+    return "Mir " + configuration.getString("Mir.Version");\r
+  }\r
+}\r