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