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: mh $\r
  69  * @version $Id: Mir.java,v 1.26 2003/01/18 08:32:07 mh 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   //I don't know about making this static cause it removes the \r
  80   //possibility to change the config on the fly.. -mh\r
  81   private static List loginLanguages = null;\r
  82 \r
  83   public HttpSession session;\r
  84 \r
  85   public void doGet(HttpServletRequest req, HttpServletResponse res) throws\r
  86       ServletException, IOException {\r
  87     doPost(req, res);\r
  88   }\r
  89 \r
  90   protected TemplateModel getLoginLanguages() throws ServletException {\r
  91     synchronized (Mir.class) {\r
  92       try {\r
  93 \r
  94         if (loginLanguages == null) {\r
  95           MessageResources messageResources2 = MessageResources.\r
  96               getMessageResources("bundles.admin");\r
  97           MessageResources messageResources = MessageResources.\r
  98               getMessageResources("bundles.adminlocal");\r
  99           List languages = StringRoutines.splitString(MirGlobal.\r
 100               getConfigPropertyWithDefault("Mir.Login.Languages", "en"), ";");\r
 101 \r
 102           loginLanguages = new Vector();\r
 103           Iterator i = languages.iterator();\r
 104 \r
 105           while (i.hasNext()) {\r
 106             String code = (String) i.next();\r
 107             Locale locale = new Locale(code, "");\r
 108             String name = messageResources.getMessage(locale, "languagename");\r
 109             if (name == null)\r
 110               name = messageResources2.getMessage(locale, "languagename");\r
 111             if (name == null)\r
 112               name = code;\r
 113 \r
 114             Map record = new HashMap();\r
 115             record.put("name", name);\r
 116             record.put("code", code);\r
 117             loginLanguages.add(record);\r
 118           }\r
 119         }\r
 120 \r
 121         return FreemarkerGenerator.makeAdapter(loginLanguages);\r
 122       }\r
 123       catch (Throwable t) {\r
 124         throw new ServletException(t.getMessage());\r
 125       }\r
 126     }\r
 127   }\r
 128 \r
 129   // FIXME: this should probalby go into AbstractServlet so it can be used in \r
 130   // OpenMir as well -mh\r
 131   protected String getDefaultLanguage (HttpServletRequest req) {\r
 132     String defaultlanguage = MirGlobal.getConfigPropertyWithDefault("Mir.Login.DefaultLanguage", "");\r
 133     if (defaultlanguage.length() == 0) {\r
 134       Locale locale = req.getLocale();\r
 135       defaultlanguage = locale.getLanguage();\r
 136     }\r
 137  \r
 138     return defaultlanguage; \r
 139   }\r
 140 \r
 141   public void doPost(HttpServletRequest req, HttpServletResponse res) throws\r
 142       ServletException, IOException, UnavailableException {\r
 143 \r
 144     long startTime = System.currentTimeMillis();\r
 145     long sessionConnectTime = 0;\r
 146     EntityUsers userEntity;\r
 147     String http = "";\r
 148 \r
 149     if (getServletContext().getAttribute("mir.confed") == null) {\r
 150       getConfig(req);\r
 151     }\r
 152 \r
 153     MirConfig.setServletName(getServletName());\r
 154 \r
 155     //*** test\r
 156      // Log.info(this, "blalalala");\r
 157 \r
 158     session = req.getSession(true);\r
 159     userEntity = (EntityUsers) session.getAttribute("login.uid");\r
 160 \r
 161     if (req.getServerPort() == 443)\r
 162       http = "https";\r
 163     else\r
 164       http = "http";\r
 165 \r
 166 \r
 167     //make sure client browsers don't cache anything\r
 168     setNoCaching(res);\r
 169 \r
 170     //FIXME: this seems kind of hackish and only here because we can have \r
 171     // default other than the one that the browser is set to.\r
 172     Locale locale = new Locale(getDefaultLanguage(req), "");\r
 173     MessageResources messageResources = MessageResources.getMessageResources("bundles.admin");\r
 174     String htmlcharset = messageResources.getMessage(locale, "htmlcharset");\r
 175 \r
 176     res.setContentType("text/html; charset=" + htmlcharset);\r
 177 \r
 178     String moduleName = req.getParameter("module");\r
 179     checkLanguage(session, req);\r
 180 \r
 181     /** @todo for cleanup and readability this should be moved to\r
 182      *  method loginIfNecessary() */\r
 183 \r
 184     if (moduleName != null && moduleName.equals("direct")) {\r
 185       //...\r
 186     }\r
 187 \r
 188     // Authentication\r
 189     if ( (moduleName != null && moduleName.equals("login")) || (userEntity == null)) {\r
 190       String user = req.getParameter("login");\r
 191       String passwd = req.getParameter("password");\r
 192       theLog.printDebugInfo("--login: evaluating for user: " + user);\r
 193       userEntity = allowedUser(user, passwd);\r
 194       if (userEntity == null) {\r
 195         // login failed: redirecting to login\r
 196         theLog.printWarning("--login: failed!");\r
 197         _sendLoginPage(res, req, res.getWriter());\r
 198         return;\r
 199       }\r
 200       else if (moduleName != null && moduleName.equals("login")) {\r
 201         // login successful\r
 202 \r
 203         theLog.printInfo("--login: successful! setting uid: " +\r
 204                          userEntity.getId());\r
 205         session.setAttribute("login.uid", userEntity);\r
 206         theLog.printDebugInfo("--login: trying to retrieve login.target");\r
 207         String target = (String) session.getAttribute("login.target");\r
 208 \r
 209         if (target != null) {\r
 210           theLog.printDebugInfo("Redirect: " + target);\r
 211           int serverPort = req.getServerPort();\r
 212           String redirect = "";\r
 213           String redirectString = "";\r
 214 \r
 215           if (serverPort == 80) {\r
 216             redirect = res.encodeURL(http + "://" + req.getServerName() +\r
 217                                      target);\r
 218             redirectString =\r
 219                 "<html><head><meta http-equiv=refresh content=\"1;URL="\r
 220                 + redirect\r
 221                 + "\"></head><body>going <a href=\"" + redirect +\r
 222                 "\">Mir</a></body></html>";\r
 223           }\r
 224           else {\r
 225             redirect = res.encodeURL(http + "://" + req.getServerName() + ":" +\r
 226                                      req.getServerPort() + target);\r
 227             redirectString =\r
 228                 "<html><head><meta http-equiv=refresh content=\"1;URL="\r
 229                 + redirect\r
 230                 + "\"></head><body>going <a href=\"" + redirect +\r
 231                 "\">Mir</a></body></html>";\r
 232           }\r
 233           res.getWriter().println(redirectString);\r
 234 \r
 235           //res.sendRedirect(redirect);\r
 236 \r
 237         }\r
 238         else {\r
 239           // redirecting to default target\r
 240           theLog.printDebugInfo("--login: no target - redirecting to default");\r
 241           _sendStartPage(res, req, res.getWriter(), userEntity);\r
 242         }\r
 243         return;\r
 244       } // if login succesful\r
 245     } // if login\r
 246 \r
 247     if (moduleName != null && moduleName.equals("logout")) {\r
 248       theLog.printDebugInfo("--logout");\r
 249       session.invalidate();\r
 250 \r
 251       //session = req.getSession(true);\r
 252       //checkLanguage(session, req);\r
 253       _sendLoginPage(res, req, res.getWriter());\r
 254       return;\r
 255     }\r
 256 \r
 257     // Check if authed!\r
 258     if (userEntity == null) {\r
 259       // redirect to loginpage\r
 260       String redirectString = req.getRequestURI();\r
 261       String queryString = req.getQueryString();\r
 262       if (queryString != null && !queryString.equals("")) {\r
 263         redirectString += "?" + req.getQueryString();\r
 264         theLog.printDebugInfo("STORING: " + redirectString);\r
 265         session.setAttribute("login.target", redirectString);\r
 266       }\r
 267       _sendLoginPage(res, req, res.getWriter());\r
 268       return;\r
 269     }\r
 270 \r
 271     // If no module is specified goto standard startpage\r
 272     if (moduleName == null || moduleName.equals("")) {\r
 273       theLog.printDebugInfo("no module: redirect to standardpage");\r
 274       _sendStartPage(res, req, res.getWriter(), userEntity);\r
 275       return;\r
 276     }\r
 277     // end of auth\r
 278 \r
 279     // From now on regular dispatching...\r
 280     try {\r
 281       // get servletmodule by parameter and continue with dispacher\r
 282       ServletModule smod = getServletModuleForName(moduleName);\r
 283       ServletModuleDispatch.dispatch(smod, req, res);\r
 284     }\r
 285     catch (ServletModuleException e) {\r
 286       handleError(req, res, res.getWriter(),\r
 287                   "ServletException in Module " + moduleName + " -- " +\r
 288                   e.getMessage());\r
 289     }\r
 290     catch (ServletModuleUserException e) {\r
 291       handleUserError(req, res, res.getWriter(), e.getMessage());\r
 292     }\r
 293 \r
 294     // timing...\r
 295     sessionConnectTime = System.currentTimeMillis() - startTime;\r
 296     theLog.printInfo("EXECTIME (" + moduleName + "): " + sessionConnectTime +\r
 297                      " ms");\r
 298   }\r
 299 \r
 300   /**\r
 301    *  Private method getServletModuleForName returns ServletModule\r
 302    *  from Cache\r
 303    *\r
 304    * @param moduleName\r
 305    * @return ServletModule\r
 306    *\r
 307    */\r
 308   private static ServletModule getServletModuleForName(String moduleName) throws\r
 309       ServletModuleException {\r
 310 \r
 311     // Instance in Map ?\r
 312     if (!servletModuleInstanceHash.containsKey(moduleName)) {\r
 313       // was not found in hash...\r
 314       try {\r
 315         Class theServletModuleClass = null;\r
 316         try {\r
 317           // first we try to get ServletModule from stern.che3.servlet\r
 318           theServletModuleClass = Class.forName(\r
 319               "mircoders.servlet.ServletModule" + moduleName);\r
 320         }\r
 321         catch (ClassNotFoundException e) {\r
 322           // on failure, we try to get it from lib-layer\r
 323           theServletModuleClass = Class.forName("mir.servlet.ServletModule" +\r
 324                                                 moduleName);\r
 325         }\r
 326         Method m = theServletModuleClass.getMethod("getInstance", null);\r
 327         ServletModule smod = (ServletModule) m.invoke(null, null);\r
 328         // we put it into map for further reference\r
 329         servletModuleInstanceHash.put(moduleName, smod);\r
 330         return smod;\r
 331       }\r
 332       catch (Exception e) {\r
 333         throw new ServletModuleException("*** error resolving classname for " +\r
 334                                          moduleName + " -- " + e.getMessage());\r
 335       }\r
 336     }\r
 337     else\r
 338       return (ServletModule) servletModuleInstanceHash.get(moduleName);\r
 339   }\r
 340 \r
 341   private void handleError(HttpServletRequest req, HttpServletResponse res,\r
 342                            PrintWriter out, String errorString) {\r
 343 \r
 344     try {\r
 345       theLog.printError(errorString);\r
 346       SimpleHash modelRoot = new SimpleHash();\r
 347       modelRoot.put("errorstring", new SimpleScalar(errorString));\r
 348       modelRoot.put("date",\r
 349                     new SimpleScalar(StringUtil.date2readableDateTime(new GregorianCalendar())));\r
 350       HTMLTemplateProcessor.process(res, MirConfig.getProp("Mir.ErrorTemplate"),\r
 351                                     modelRoot, out, getLocale(req));\r
 352       out.close();\r
 353     }\r
 354     catch (Exception e) {\r
 355       e.printStackTrace(System.out);\r
 356       System.err.println("Error in ErrorTemplate: " + e.getMessage());\r
 357     }\r
 358   }\r
 359 \r
 360   private void handleUserError(HttpServletRequest req, HttpServletResponse res,\r
 361                                PrintWriter out, String errorString) {\r
 362     try {\r
 363       theLog.printError(errorString);\r
 364       SimpleHash modelRoot = new SimpleHash();\r
 365       modelRoot.put("errorstring", new SimpleScalar(errorString));\r
 366       modelRoot.put("date",\r
 367                     new SimpleScalar(StringUtil.date2readableDateTime(new GregorianCalendar())));\r
 368       HTMLTemplateProcessor.process(res,\r
 369                                     MirConfig.getProp("Mir.UserErrorTemplate"),\r
 370                                     modelRoot, out, getLocale(req));\r
 371       out.close();\r
 372     }\r
 373     catch (Exception e) {\r
 374       System.err.println("Error in UserErrorTemplate");\r
 375     }\r
 376 \r
 377   }\r
 378 \r
 379   /**\r
 380    *  evaluate login for user / password\r
 381    */\r
 382   protected EntityUsers allowedUser(String user, String password) {\r
 383     try {\r
 384       if (usersModule == null)\r
 385         usersModule = new ModuleUsers(DatabaseUsers.getInstance());\r
 386       return usersModule.getUserForLogin(user, password);\r
 387     }\r
 388     catch (Exception e) {\r
 389       theLog.printDebugInfo(e.getMessage());\r
 390       e.printStackTrace();\r
 391       return null;\r
 392     }\r
 393   }\r
 394 \r
 395   // Redirect-methods\r
 396   private void _sendLoginPage(HttpServletResponse res, HttpServletRequest req,\r
 397                               PrintWriter out) {\r
 398     String loginTemplate = MirConfig.getProp("Mir.LoginTemplate");\r
 399     String sessionUrl = res.encodeURL("");\r
 400 \r
 401     try {\r
 402       SimpleHash mergeData = new SimpleHash();\r
 403       SimpleList languages = new SimpleList();\r
 404 \r
 405       mergeData.put("session", sessionUrl);\r
 406 \r
 407       mergeData.put("defaultlanguage",  getDefaultLanguage(req));\r
 408       mergeData.put("languages", getLoginLanguages());\r
 409 \r
 410       HTMLTemplateProcessor.process(res, loginTemplate, mergeData, out, getLocale(req));\r
 411     }\r
 412     catch (Throwable e) {\r
 413       handleError(req, res, out, "Error sending login page: " + e.getMessage());\r
 414     }\r
 415   }\r
 416 \r
 417   private void _sendStartPage(HttpServletResponse res, HttpServletRequest req,\r
 418                               PrintWriter out, EntityUsers userEntity) {\r
 419     String startTemplate = "templates/admin/start_admin.template";\r
 420     String sessionUrl = res.encodeURL("");\r
 421 \r
 422     try {\r
 423       // merge with logged in user and messages\r
 424       SimpleHash mergeData = new SimpleHash();\r
 425       mergeData.put("session", sessionUrl);\r
 426       mergeData.put("login_user", userEntity);\r
 427       if (messageModule == null)\r
 428         messageModule = new ModuleMessage(DatabaseMessages.getInstance());\r
 429       mergeData.put("messages",\r
 430                     messageModule.getByWhereClause(null, "webdb_create desc", 0,\r
 431           10));\r
 432 \r
 433       mergeData.put("articletypes",\r
 434                     DatabaseArticleType.getInstance().\r
 435                     selectByWhereClause("", "id", 0, 20));\r
 436 \r
 437       HTMLTemplateProcessor.process(res, startTemplate, mergeData, out, getLocale(req));\r
 438     }\r
 439     catch (Exception e) {\r
 440       e.printStackTrace(System.out);\r
 441       handleError(req, res, out, "error while trying to send startpage. " + e.getMessage());\r
 442     }\r
 443   }\r
 444 \r
 445   public String getServletInfo() {\r
 446     return "Mir " + MirConfig.getProp("Mir.Version");\r
 447   }\r
 448 \r
 449   private void checkLanguage(HttpSession session, HttpServletRequest req) {\r
 450     // a lang parameter always sets the language\r
 451     String lang = req.getParameter("language");\r
 452     if (lang != null) {\r
 453       theLog.printInfo("selected language " + lang + " overrides accept-language");\r
 454       setLanguage(session, lang);\r
 455       setLocale(session, new Locale(lang, ""));\r
 456     }\r
 457     // otherwise store language from accept header in session\r
 458     else if (session.getAttribute("Language") == null) {\r
 459       theLog.printInfo("accept-language is " + req.getLocale().getLanguage());\r
 460       setLanguage(session, req.getLocale().getLanguage());\r
 461       setLocale(session, req.getLocale());\r
 462     }\r
 463   }\r
 464 }\r