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