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