source/Mir.java

   1 /*\r
   2  * Copyright (C) 2001, 2002 The Mir-coders group\r
   3  *\r
   4  * This file is part of Mir.\r
   5  *\r
   6  * Mir is free software; you can redistribute it and/or modify\r
   7  * it under the terms of the GNU General Public License as published by\r
   8  * the Free Software Foundation; either version 2 of the License, or\r
   9  * (at your option) any later version.\r
  10  *\r
  11  * Mir is distributed in the hope that it will be useful,\r
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  14  * GNU General Public License for more details.\r
  15  *\r
  16  * You should have received a copy of the GNU General Public License\r
  17  * along with Mir; if not, write to the Free Software\r
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
  19  *\r
  20  * In addition, as a special exception, The Mir-coders gives permission to link\r
  21  * the code of this program with the com.oreilly.servlet library, any library\r
  22  * licensed under the Apache Software License, The Sun (tm) Java Advanced\r
  23  * Imaging library (JAI), The Sun JIMI library (or with modified versions of\r
  24  * the above that use the same license as the above), and distribute linked\r
  25  * combinations including the two.  You must obey the GNU General Public\r
  26  * License in all respects for all of the code used other than the above\r
  27  * mentioned libraries.  If you modify this file, you may extend this exception\r
  28  * to your version of the file, but you are not obligated to do so.  If you do\r
  29  * not wish to do so, delete this exception statement from your version.\r
  30  */\r
  31 \r
  32 import java.io.IOException;\r
  33 import java.io.PrintWriter;\r
  34 import java.lang.reflect.Method;\r
  35 import java.util.GregorianCalendar;\r
  36 import java.util.HashMap;\r
  37 import java.util.Locale;\r
  38 import java.util.*;\r
  39 \r
  40 import javax.servlet.ServletException;\r
  41 import javax.servlet.UnavailableException;\r
  42 import javax.servlet.http.HttpServletRequest;\r
  43 import javax.servlet.http.HttpServletResponse;\r
  44 import javax.servlet.http.HttpSession;\r
  45 \r
  46 import freemarker.template.*;\r
  47 \r
  48 import org.apache.struts.util.MessageResources;\r
  49 \r
  50 import mir.misc.*;\r
  51 import mir.servlet.*;\r
  52 import mir.util.*;\r
  53 import mir.generator.*;\r
  54 //import mir.log.Log;\r
  55 \r
  56 import mircoders.global.*;\r
  57 import mircoders.localizer.*;\r
  58 import mircoders.entity.EntityUsers;\r
  59 import mircoders.module.ModuleMessage;\r
  60 import mircoders.module.ModuleUsers;\r
  61 import mircoders.storage.DatabaseArticleType;\r
  62 import mircoders.storage.DatabaseMessages;\r
  63 import mircoders.storage.DatabaseUsers;\r
  64 \r
  65 /**\r
  66  * Mir.java - main servlet, that dispatches to servletmodules\r
  67  *\r
  68  * @author $Author: zapata $\r
  69  * @version $Id: Mir.java,v 1.24 2002/12/17 19:20:31 zapata Exp $\r
  70  *\r
  71  */\r
  72 \r
  73 public class Mir extends AbstractServlet {\r
  74 \r
  75   private static ModuleUsers usersModule = null;\r
  76   private static ModuleMessage messageModule = null;\r
  77   private final static HashMap servletModuleInstanceHash = new HashMap();\r
  78 \r
  79   private static List loginLanguages = null;\r
  80 \r
  81   public HttpSession session;\r
  82 \r
  83   public void doGet(HttpServletRequest req, HttpServletResponse res) throws\r
  84       ServletException, IOException {\r
  85     doPost(req, res);\r
  86   }\r
  87 \r
  88   protected TemplateModel getLoginLanguages() throws ServletException {\r
  89     synchronized (Mir.class) {\r
  90       try {\r
  91 \r
  92         if (loginLanguages == null) {\r
  93           MessageResources messageResources2 = MessageResources.\r
  94               getMessageResources("bundles.admin");\r
  95           MessageResources messageResources = MessageResources.\r
  96               getMessageResources("bundles.adminlocal");\r
  97           List languages = StringRoutines.splitString(MirGlobal.\r
  98               getConfigPropertyWithDefault("Mir.Login.Languages", "en"), ";");\r
  99 \r
 100           loginLanguages = new Vector();\r
 101           Iterator i = languages.iterator();\r
 102 \r
 103           while (i.hasNext()) {\r
 104             String code = (String) i.next();\r
 105             Locale locale = new Locale(code, "");\r
 106             String name = messageResources.getMessage(locale, "languagename");\r
 107             if (name == null)\r
 108               name = messageResources2.getMessage(locale, "languagename");\r
 109             if (name == null)\r
 110               name = code;\r
 111 \r
 112             Map record = new HashMap();\r
 113             record.put("name", name);\r
 114             record.put("code", code);\r
 115             loginLanguages.add(record);\r
 116           }\r
 117         }\r
 118 \r
 119         return FreemarkerGenerator.makeAdapter(loginLanguages);\r
 120       }\r
 121       catch (Throwable t) {\r
 122         throw new ServletException(t.getMessage());\r
 123       }\r
 124     }\r
 125   }\r
 126 \r
 127   public void doPost(HttpServletRequest req, HttpServletResponse res) throws\r
 128       ServletException, IOException, UnavailableException {\r
 129 \r
 130     long startTime = System.currentTimeMillis();\r
 131     long sessionConnectTime = 0;\r
 132     EntityUsers userEntity;\r
 133     String http = "";\r
 134 \r
 135     if (getServletContext().getAttribute("mir.confed") == null) {\r
 136       getConfig(req);\r
 137     }\r
 138 \r
 139     MirConfig.setServletName(getServletName());\r
 140 \r
 141     //*** test\r
 142      // Log.info(this, "blalalala");\r
 143 \r
 144     session = req.getSession(true);\r
 145     userEntity = (EntityUsers) session.getAttribute("login.uid");\r
 146 \r
 147     if (req.getServerPort() == 443)\r
 148       http = "https";\r
 149     else\r
 150       http = "http";\r
 151 \r
 152     //nothing in Mir can or should be cached as it's all dynamic...\r
 153     //\r
 154     //this needs to be done here and not per page (via meta tags) as some\r
 155     //browsers have problems w/ it per-page -mh\r
 156     res.setHeader("Pragma", "no-cache");\r
 157     res.setDateHeader("Expires", 0);\r
 158     res.setHeader("Cache-Control", "no-cache");\r
 159     res.setContentType("text/html; charset=" + MirConfig.getProp("Mir.DefaultEncoding"));\r
 160 \r
 161     String moduleName = req.getParameter("module");\r
 162     checkLanguage(session, req);\r
 163 \r
 164     /** @todo for cleanup and readability this should be moved to\r
 165      *  method loginIfNecessary() */\r
 166 \r
 167     if (moduleName != null && moduleName.equals("direct")) {\r
 168       //...\r
 169     }\r
 170 \r
 171     // Authentication\r
 172     if ( (moduleName != null && moduleName.equals("login")) || (userEntity == null)) {\r
 173       String user = req.getParameter("login");\r
 174       String passwd = req.getParameter("password");\r
 175       theLog.printDebugInfo("--login: evaluating for user: " + user);\r
 176       userEntity = allowedUser(user, passwd);\r
 177       if (userEntity == null) {\r
 178         // login failed: redirecting to login\r
 179         theLog.printWarning("--login: failed!");\r
 180         _sendLoginPage(res, req, res.getWriter());\r
 181         return;\r
 182       }\r
 183       else if (moduleName != null && moduleName.equals("login")) {\r
 184         // login successful\r
 185 \r
 186         theLog.printInfo("--login: successful! setting uid: " +\r
 187                          userEntity.getId());\r
 188         session.setAttribute("login.uid", userEntity);\r
 189         theLog.printDebugInfo("--login: trying to retrieve login.target");\r
 190         String target = (String) session.getAttribute("login.target");\r
 191 \r
 192         if (target != null) {\r
 193           theLog.printDebugInfo("Redirect: " + target);\r
 194           int serverPort = req.getServerPort();\r
 195           String redirect = "";\r
 196           String redirectString = "";\r
 197 \r
 198           if (serverPort == 80) {\r
 199             redirect = res.encodeURL(http + "://" + req.getServerName() +\r
 200                                      target);\r
 201             redirectString =\r
 202                 "<html><head><meta http-equiv=refresh content=\"1;URL="\r
 203                 + redirect\r
 204                 + "\"></head><body>going <a href=\"" + redirect +\r
 205                 "\">Mir</a></body></html>";\r
 206           }\r
 207           else {\r
 208             redirect = res.encodeURL(http + "://" + req.getServerName() + ":" +\r
 209                                      req.getServerPort() + target);\r
 210             redirectString =\r
 211                 "<html><head><meta http-equiv=refresh content=\"1;URL="\r
 212                 + redirect\r
 213                 + "\"></head><body>going <a href=\"" + redirect +\r
 214                 "\">Mir</a></body></html>";\r
 215           }\r
 216           res.getWriter().println(redirectString);\r
 217 \r
 218           //res.sendRedirect(redirect);\r
 219 \r
 220         }\r
 221         else {\r
 222           // redirecting to default target\r
 223           theLog.printDebugInfo("--login: no target - redirecting to default");\r
 224           _sendStartPage(res, req, res.getWriter(), userEntity);\r
 225         }\r
 226         return;\r
 227       } // if login succesful\r
 228     } // if login\r
 229 \r
 230     if (moduleName != null && moduleName.equals("logout")) {\r
 231       theLog.printDebugInfo("--logout");\r
 232       session.invalidate();\r
 233 \r
 234       //session = req.getSession(true);\r
 235       //checkLanguage(session, req);\r
 236       _sendLoginPage(res, req, res.getWriter());\r
 237       return;\r
 238     }\r
 239 \r
 240     // Check if authed!\r
 241     if (userEntity == null) {\r
 242       // redirect to loginpage\r
 243       String redirectString = req.getRequestURI();\r
 244       String queryString = req.getQueryString();\r
 245       if (queryString != null && !queryString.equals("")) {\r
 246         redirectString += "?" + req.getQueryString();\r
 247         theLog.printDebugInfo("STORING: " + redirectString);\r
 248         session.setAttribute("login.target", redirectString);\r
 249       }\r
 250       _sendLoginPage(res, req, res.getWriter());\r
 251       return;\r
 252     }\r
 253 \r
 254     // If no module is specified goto standard startpage\r
 255     if (moduleName == null || moduleName.equals("")) {\r
 256       theLog.printDebugInfo("no module: redirect to standardpage");\r
 257       _sendStartPage(res, req, res.getWriter(), userEntity);\r
 258       return;\r
 259     }\r
 260     // end of auth\r
 261 \r
 262     // From now on regular dispatching...\r
 263     try {\r
 264       // get servletmodule by parameter and continue with dispacher\r
 265       ServletModule smod = getServletModuleForName(moduleName);\r
 266       ServletModuleDispatch.dispatch(smod, req, res);\r
 267     }\r
 268     catch (ServletModuleException e) {\r
 269       handleError(req, res, res.getWriter(),\r
 270                   "ServletException in Module " + moduleName + " -- " +\r
 271                   e.getMessage());\r
 272     }\r
 273     catch (ServletModuleUserException e) {\r
 274       handleUserError(req, res, res.getWriter(), e.getMessage());\r
 275     }\r
 276 \r
 277     // timing...\r
 278     sessionConnectTime = System.currentTimeMillis() - startTime;\r
 279     theLog.printInfo("EXECTIME (" + moduleName + "): " + sessionConnectTime +\r
 280                      " ms");\r
 281   }\r
 282 \r
 283   /**\r
 284    *  Private method getServletModuleForName returns ServletModule\r
 285    *  from Cache\r
 286    *\r
 287    * @param moduleName\r
 288    * @return ServletModule\r
 289    *\r
 290    */\r
 291   private static ServletModule getServletModuleForName(String moduleName) throws\r
 292       ServletModuleException {\r
 293 \r
 294     // Instance in Map ?\r
 295     if (!servletModuleInstanceHash.containsKey(moduleName)) {\r
 296       // was not found in hash...\r
 297       try {\r
 298         Class theServletModuleClass = null;\r
 299         try {\r
 300           // first we try to get ServletModule from stern.che3.servlet\r
 301           theServletModuleClass = Class.forName(\r
 302               "mircoders.servlet.ServletModule" + moduleName);\r
 303         }\r
 304         catch (ClassNotFoundException e) {\r
 305           // on failure, we try to get it from lib-layer\r
 306           theServletModuleClass = Class.forName("mir.servlet.ServletModule" +\r
 307                                                 moduleName);\r
 308         }\r
 309         Method m = theServletModuleClass.getMethod("getInstance", null);\r
 310         ServletModule smod = (ServletModule) m.invoke(null, null);\r
 311         // we put it into map for further reference\r
 312         servletModuleInstanceHash.put(moduleName, smod);\r
 313         return smod;\r
 314       }\r
 315       catch (Exception e) {\r
 316         throw new ServletModuleException("*** error resolving classname for " +\r
 317                                          moduleName + " -- " + e.getMessage());\r
 318       }\r
 319     }\r
 320     else\r
 321       return (ServletModule) servletModuleInstanceHash.get(moduleName);\r
 322   }\r
 323 \r
 324   private void handleError(HttpServletRequest req, HttpServletResponse res,\r
 325                            PrintWriter out, String errorString) {\r
 326 \r
 327     try {\r
 328       theLog.printError(errorString);\r
 329       SimpleHash modelRoot = new SimpleHash();\r
 330       modelRoot.put("errorstring", new SimpleScalar(errorString));\r
 331       modelRoot.put("date",\r
 332                     new SimpleScalar(StringUtil.date2readableDateTime(new GregorianCalendar())));\r
 333       HTMLTemplateProcessor.process(res, MirConfig.getProp("Mir.ErrorTemplate"),\r
 334                                     modelRoot, out, getLocale(req));\r
 335       out.close();\r
 336     }\r
 337     catch (Exception e) {\r
 338       e.printStackTrace(System.out);\r
 339       System.err.println("Error in ErrorTemplate: " + e.getMessage());\r
 340     }\r
 341   }\r
 342 \r
 343   private void handleUserError(HttpServletRequest req, HttpServletResponse res,\r
 344                                PrintWriter out, String errorString) {\r
 345     try {\r
 346       theLog.printError(errorString);\r
 347       SimpleHash modelRoot = new SimpleHash();\r
 348       modelRoot.put("errorstring", new SimpleScalar(errorString));\r
 349       modelRoot.put("date",\r
 350                     new SimpleScalar(StringUtil.date2readableDateTime(new GregorianCalendar())));\r
 351       HTMLTemplateProcessor.process(res,\r
 352                                     MirConfig.getProp("Mir.UserErrorTemplate"),\r
 353                                     modelRoot, out, getLocale(req));\r
 354       out.close();\r
 355     }\r
 356     catch (Exception e) {\r
 357       System.err.println("Error in UserErrorTemplate");\r
 358     }\r
 359 \r
 360   }\r
 361 \r
 362   /**\r
 363    *  evaluate login for user / password\r
 364    */\r
 365   protected EntityUsers allowedUser(String user, String password) {\r
 366     try {\r
 367       if (usersModule == null)\r
 368         usersModule = new ModuleUsers(DatabaseUsers.getInstance());\r
 369       return usersModule.getUserForLogin(user, password);\r
 370     }\r
 371     catch (Exception e) {\r
 372       theLog.printDebugInfo(e.getMessage());\r
 373       e.printStackTrace();\r
 374       return null;\r
 375     }\r
 376   }\r
 377 \r
 378   // Redirect-methods\r
 379   private void _sendLoginPage(HttpServletResponse res, HttpServletRequest req,\r
 380                               PrintWriter out) {\r
 381     String loginTemplate = MirConfig.getProp("Mir.LoginTemplate");\r
 382     String sessionUrl = res.encodeURL("");\r
 383 \r
 384     try {\r
 385       SimpleHash mergeData = new SimpleHash();\r
 386       SimpleList languages = new SimpleList();\r
 387 \r
 388       mergeData.put("session", sessionUrl);\r
 389 \r
 390       mergeData.put("defaultlanguage", MirGlobal.getConfigPropertyWithDefault("Mir.Login.DefaultLanguage", "en"));\r
 391       mergeData.put("languages", getLoginLanguages());\r
 392 \r
 393       HTMLTemplateProcessor.process(res, loginTemplate, mergeData, out, getLocale(req));\r
 394     }\r
 395     catch (Throwable e) {\r
 396       handleError(req, res, out, "Error sending login page: " + e.getMessage());\r
 397     }\r
 398   }\r
 399 \r
 400   private void _sendStartPage(HttpServletResponse res, HttpServletRequest req,\r
 401                               PrintWriter out, EntityUsers userEntity) {\r
 402     String startTemplate = "templates/admin/start_admin.template";\r
 403     String sessionUrl = res.encodeURL("");\r
 404 \r
 405     try {\r
 406       // merge with logged in user and messages\r
 407       SimpleHash mergeData = new SimpleHash();\r
 408       mergeData.put("session", sessionUrl);\r
 409       mergeData.put("login_user", userEntity);\r
 410       if (messageModule == null)\r
 411         messageModule = new ModuleMessage(DatabaseMessages.getInstance());\r
 412       mergeData.put("messages",\r
 413                     messageModule.getByWhereClause(null, "webdb_create desc", 0,\r
 414           10));\r
 415 \r
 416       mergeData.put("articletypes",\r
 417                     DatabaseArticleType.getInstance().\r
 418                     selectByWhereClause("", "id", 0, 20));\r
 419 \r
 420       HTMLTemplateProcessor.process(res, startTemplate, mergeData, out, getLocale(req));\r
 421     }\r
 422     catch (Exception e) {\r
 423       e.printStackTrace(System.out);\r
 424       handleError(req, res, out, "error while trying to send startpage. " + e.getMessage());\r
 425     }\r
 426   }\r
 427 \r
 428   public String getServletInfo() {\r
 429     return "Mir " + MirConfig.getProp("Mir.Version");\r
 430   }\r
 431 \r
 432   private void checkLanguage(HttpSession session, HttpServletRequest req) {\r
 433     // a lang parameter always sets the language\r
 434     String lang = req.getParameter("language");\r
 435     if (lang != null) {\r
 436       theLog.printInfo("selected language " + lang + " overrides accept-language");\r
 437       setLanguage(session, lang);\r
 438       setLocale(session, new Locale(lang, ""));\r
 439     }\r
 440     // otherwise store language from accept header in session\r
 441     else if (session.getAttribute("Language") == null) {\r
 442       theLog.printInfo("accept-language is " + req.getLocale().getLanguage());\r
 443       setLanguage(session, req.getLocale().getLanguage());\r
 444       setLocale(session, req.getLocale());\r
 445     }\r
 446   }\r
 447 }\r