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.42 2003/04/09 02:06:06 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     MessageResources messageResources =\r
 194       MessageResources.getMessageResources("bundles.admin");\r
 195     String htmlcharset = messageResources.getMessage(locale, "htmlcharset");\r
 196 \r
 197     aResponse.setContentType("text/html; charset=" + htmlcharset);\r
 198 \r
 199     String moduleName = aRequest.getParameter("module");\r
 200     checkLanguage(session, aRequest);\r
 201 \r
 202 \r
 203 \r
 204     // Authentication\r
 205     if (((moduleName != null) && moduleName.equals("login")) ||\r
 206         (userEntity == null)) {\r
 207       String user = aRequest.getParameter("login");\r
 208       String passwd = aRequest.getParameter("password");\r
 209       logger.debug("--login: evaluating for user: " + user);\r
 210       userEntity = allowedUser(user, passwd);\r
 211 \r
 212       if (userEntity == null) {\r
 213         // login failed: redirecting to login\r
 214         logger.warn("--login: failed!");\r
 215         _sendLoginPage(aResponse, aRequest, aResponse.getWriter());\r
 216 \r
 217         return;\r
 218       }\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 = aRequest.getServerPort();\r
 231           String redirect = "";\r
 232           String redirectString = "";\r
 233 \r
 234           if (serverPort == 80) {\r
 235             redirect =\r
 236               aResponse.encodeURL(http + "://" + aRequest.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               aResponse.encodeURL(http + "://" + aRequest.getServerName() + ":" +\r
 244                 aRequest.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           aResponse.getWriter().println(redirectString);\r
 252 \r
 253           //aResponse.sendRedirect(redirect);\r
 254         } else {\r
 255           // redirecting to default target\r
 256           logger.debug("--login: no target - redirecting to default");\r
 257           _sendStartPage(aResponse, aRequest, aResponse.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 = aRequest.getSession(true);\r
 271       //checkLanguage(session, aRequest);\r
 272       _sendLoginPage(aResponse, aRequest, aResponse.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 = aRequest.getRequestURI();\r
 281       String queryString = aRequest.getQueryString();\r
 282 \r
 283       if ((queryString != null) && !queryString.equals("")) {\r
 284         redirectString += ("?" + aRequest.getQueryString());\r
 285         logger.debug("STORING: " + redirectString);\r
 286         session.setAttribute("login.target", redirectString);\r
 287       }\r
 288 \r
 289       _sendLoginPage(aResponse, aRequest, aResponse.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(aResponse, aRequest, aResponse.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, aRequest, aResponse);\r
 308     }\r
 309     catch (Throwable e) {\r
 310       Throwable cause = ExceptionFunctions.traceCauseException(e);\r
 311 \r
 312       if (cause instanceof ServletModuleUserExc)\r
 313         handleUserError(aRequest, aResponse, aResponse.getWriter(), (ServletModuleUserExc) cause);\r
 314       else\r
 315         handleError(aRequest, aResponse, aResponse.getWriter(), cause);\r
 316 \r
 317     }\r
 318 \r
 319     // timing...\r
 320     sessionConnectTime = System.currentTimeMillis() - startTime;\r
 321     logger.info("EXECTIME (" + moduleName + "): " + sessionConnectTime + " ms");\r
 322   }\r
 323 \r
 324   /**\r
 325    *  Private method getServletModuleForName returns ServletModule\r
 326    *  from Cache\r
 327    *\r
 328    * @param moduleName\r
 329    * @return ServletModule\r
 330    *\r
 331    */\r
 332   private static ServletModule getServletModuleForName(String moduleName) throws ServletModuleExc {\r
 333     // Instance in Map ?\r
 334     if (!servletModuleInstanceHash.containsKey(moduleName)) {\r
 335       // was not found in hash...\r
 336       try {\r
 337         Class theServletModuleClass = null;\r
 338 \r
 339         try {\r
 340           // first we try to get ServletModule from stern.che3.servlet\r
 341           theServletModuleClass =\r
 342             Class.forName("mircoders.servlet.ServletModule" + moduleName);\r
 343         } catch (ClassNotFoundException e) {\r
 344           // on failure, we try to get it from lib-layer\r
 345           theServletModuleClass =\r
 346             Class.forName("mir.servlet.ServletModule" + moduleName);\r
 347         }\r
 348 \r
 349         Method m = theServletModuleClass.getMethod("getInstance", null);\r
 350         ServletModule smod = (ServletModule) m.invoke(null, null);\r
 351 \r
 352         // we put it into map for further reference\r
 353         servletModuleInstanceHash.put(moduleName, smod);\r
 354 \r
 355         return smod;\r
 356       }\r
 357       catch (Exception e) {\r
 358         throw new ServletModuleExc("*** error resolving classname for " + moduleName + " -- " + e.getMessage());\r
 359       }\r
 360     }\r
 361     else {\r
 362       return (ServletModule) servletModuleInstanceHash.get(moduleName);\r
 363     }\r
 364   }\r
 365 \r
 366   private void handleUserError(HttpServletRequest aRequest, HttpServletResponse aResponse,\r
 367                                PrintWriter out, ServletModuleUserExc anException) {\r
 368     try {\r
 369       logger.info("user error: " + anException.getMessage());\r
 370       SimpleHash modelRoot = new SimpleHash();\r
 371       MessageResources messages = MessageResources.getMessageResources("bundles.admin");\r
 372       modelRoot.put("errorstring",\r
 373           new SimpleScalar(\r
 374               messages.getMessage(getLocale(aRequest), anException.getMessage(), anException.getParameters())\r
 375           ));\r
 376       modelRoot.put("date", new SimpleScalar(StringUtil.date2readableDateTime(new GregorianCalendar())));\r
 377       HTMLTemplateProcessor.process(\r
 378           aResponse,\r
 379           MirPropertiesConfiguration.instance().getString("Mir.UserErrorTemplate"),\r
 380           modelRoot,\r
 381           null,\r
 382           out,\r
 383           getLocale(aRequest),\r
 384           fallbackLocale);\r
 385       out.close();\r
 386     }\r
 387     catch (Exception e) {\r
 388       logger.error("Error in UserErrorTemplate");\r
 389     }\r
 390 \r
 391   }\r
 392 \r
 393   private void handleError(HttpServletRequest aRequest, HttpServletResponse aResponse,PrintWriter out, Throwable anException) {\r
 394 \r
 395     try {\r
 396       logger.error("error: " + anException);\r
 397       SimpleHash modelRoot = new SimpleHash();\r
 398       modelRoot.put("errorstring", new SimpleScalar(anException.getMessage()));\r
 399       modelRoot.put("date", new SimpleScalar(StringUtil.date2readableDateTime(\r
 400                                                new GregorianCalendar())));\r
 401       HTMLTemplateProcessor.process(\r
 402           aResponse,MirPropertiesConfiguration.instance().getString("Mir.ErrorTemplate"),\r
 403           modelRoot,null,out, getLocale(aRequest), getFallbackLocale());\r
 404       out.close();\r
 405     }\r
 406     catch (Exception e) {\r
 407       logger.error("Error in ErrorTemplate");\r
 408     }\r
 409   }\r
 410 \r
 411   /**\r
 412    *  evaluate login for user / password\r
 413    */\r
 414   protected EntityUsers allowedUser(String user, String password) {\r
 415     try {\r
 416       if (usersModule == null) {\r
 417         usersModule = new ModuleUsers(DatabaseUsers.getInstance());\r
 418       }\r
 419 \r
 420       return usersModule.getUserForLogin(user, password);\r
 421     }\r
 422     catch (Exception e) {\r
 423       logger.debug(e.getMessage());\r
 424       e.printStackTrace(logger.asPrintWriter(LoggerWrapper.DEBUG_MESSAGE));\r
 425 \r
 426       return null;\r
 427     }\r
 428   }\r
 429 \r
 430   // Redirect-methods\r
 431   private void _sendLoginPage(HttpServletResponse aResponse, HttpServletRequest aRequest,\r
 432     PrintWriter out) {\r
 433     String loginTemplate = configuration.getString("Mir.LoginTemplate");\r
 434     String sessionUrl = aResponse.encodeURL("");\r
 435 \r
 436     try {\r
 437       SimpleHash mergeData = new SimpleHash();\r
 438       SimpleList languages = new SimpleList();\r
 439 \r
 440       mergeData.put("session", sessionUrl);\r
 441 \r
 442       mergeData.put("defaultlanguage", getDefaultLanguage(aRequest));\r
 443       mergeData.put("languages", getLoginLanguages());\r
 444 \r
 445       HTMLTemplateProcessor.process(aResponse, loginTemplate, mergeData, null, out, getLocale(aRequest), getFallbackLocale());\r
 446     }\r
 447     catch (Throwable e) {\r
 448       handleError(aRequest, aResponse, out, e);\r
 449     }\r
 450   }\r
 451 \r
 452   private void _sendStartPage(HttpServletResponse aResponse, HttpServletRequest aRequest,\r
 453     PrintWriter out, EntityUsers userEntity) {\r
 454     String startTemplate = configuration.getString("Mir.StartTemplate");\r
 455     String sessionUrl = aResponse.encodeURL("");\r
 456 \r
 457     try {\r
 458       Map mergeData = ServletHelper.makeGenerationData(new Locale[] {getLocale(aRequest), getFallbackLocale()}, "bundles.admin", "bundles.adminlocal");\r
 459       mergeData.put("messages",\r
 460              new CachingRewindableIterator(\r
 461                new EntityIteratorAdapter( "", "webdb_create desc", 10,\r
 462                  MirGlobal.localizer().dataModel().adapterModel(), "internalMessage", 10, 0)));\r
 463       mergeData.put("searchvalue", null);\r
 464       mergeData.put("searchfield", null);\r
 465       mergeData.put("searchispublished", null);\r
 466       mergeData.put("searcharticletype", null);\r
 467       mergeData.put("searchorder", null);\r
 468       mergeData.put("selectarticleurl", null);\r
 469 \r
 470       ServletHelper.generateResponse(aResponse.getWriter(), mergeData, startTemplate);\r
 471     }\r
 472     catch (Exception e) {\r
 473       e.printStackTrace(logger.asPrintWriter(LoggerWrapper.DEBUG_MESSAGE));\r
 474       handleError(aRequest, aResponse, out, e);\r
 475     }\r
 476   }\r
 477 \r
 478   public String getServletInfo() {\r
 479     return "Mir " + configuration.getString("Mir.Version");\r
 480   }\r
 481 \r
 482   private void checkLanguage(HttpSession session, HttpServletRequest aRequest) {\r
 483     // a lang parameter always sets the language\r
 484     String lang = aRequest.getParameter("language");\r
 485 \r
 486     if (lang != null) {\r
 487       logger.info("selected language " + lang + " overrides accept-language");\r
 488       setLanguage(session, lang);\r
 489     }\r
 490     // otherwise store language from accept header in session\r
 491     else if (session.getAttribute("language") == null) {\r
 492       logger.info("accept-language is " + aRequest.getLocale().getLanguage());\r
 493       setLanguage(session, aRequest.getLocale().getLanguage());\r
 494     }\r
 495   }\r
 496 }\r