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