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