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.log.LoggerWrapper;\r
  62 import mir.misc.HTMLTemplateProcessor;\r
  63 import mir.misc.StringUtil;\r
  64 import mir.servlet.AbstractServlet;\r
  65 import mir.servlet.ServletModule;\r
  66 import mir.servlet.ServletModuleDispatch;\r
  67 import mir.servlet.ServletModuleException;\r
  68 import mir.servlet.ServletModuleUserException;\r
  69 import mir.util.StringRoutines;\r
  70 \r
  71 import mircoders.entity.EntityUsers;\r
  72 import mircoders.global.MirGlobal;\r
  73 import mircoders.module.ModuleMessage;\r
  74 import mircoders.module.ModuleUsers;\r
  75 import mircoders.storage.DatabaseArticleType;\r
  76 import mircoders.storage.DatabaseMessages;\r
  77 import mircoders.storage.DatabaseUsers;\r
  78 \r
  79 \r
  80 \r
  81 /**\r
  82  * Mir.java - main servlet, that dispatches to servletmodules\r
  83  *\r
  84  * @author $Author: zapata $\r
  85  * @version $Id: Mir.java,v 1.31 2003/03/04 22:00:51 zapata Exp $\r
  86  *\r
  87  */\r
  88 public class Mir extends AbstractServlet {\r
  89   private static ModuleUsers usersModule = null;\r
  90   private static ModuleMessage messageModule = null;\r
  91   private final static Map servletModuleInstanceHash = new HashMap();\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   public HttpSession session;\r
  97 \r
  98   public void doGet(HttpServletRequest req, HttpServletResponse res)\r
  99     throws ServletException, IOException {\r
 100     doPost(req, res);\r
 101   }\r
 102 \r
 103   protected TemplateModel getLoginLanguages() throws ServletException {\r
 104     synchronized (Mir.class) {\r
 105       try {\r
 106         if (loginLanguages == null) {\r
 107           MessageResources messageResources2 =\r
 108             MessageResources.getMessageResources("bundles.admin");\r
 109           MessageResources messageResources =\r
 110             MessageResources.getMessageResources("bundles.adminlocal");\r
 111           List languages =\r
 112             StringRoutines.splitString(MirGlobal.getConfigPropertyWithDefault(\r
 113                 "Mir.Login.Languages", "en"), ";");\r
 114 \r
 115           loginLanguages = new Vector();\r
 116 \r
 117           Iterator i = languages.iterator();\r
 118 \r
 119           while (i.hasNext()) {\r
 120             String code = (String) i.next();\r
 121             Locale locale = new Locale(code, "");\r
 122             String name = messageResources.getMessage(locale, "languagename");\r
 123 \r
 124             if (name == null) {\r
 125               name = messageResources2.getMessage(locale, "languagename");\r
 126             }\r
 127 \r
 128             if (name == null) {\r
 129               name = code;\r
 130             }\r
 131 \r
 132             Map record = new HashMap();\r
 133             record.put("name", name);\r
 134             record.put("code", code);\r
 135             loginLanguages.add(record);\r
 136           }\r
 137         }\r
 138 \r
 139         return FreemarkerGenerator.makeAdapter(loginLanguages);\r
 140       } catch (Throwable t) {\r
 141         throw new ServletException(t.getMessage());\r
 142       }\r
 143     }\r
 144   }\r
 145 \r
 146   // FIXME: this should probalby go into AbstractServlet so it can be used in\r
 147   // OpenMir as well -mh\r
 148   protected String getDefaultLanguage(HttpServletRequest req) {\r
 149     String defaultlanguage =\r
 150       MirGlobal.getConfigPropertyWithDefault("Mir.Login.DefaultLanguage", "");\r
 151 \r
 152     if (defaultlanguage.length() == 0) {\r
 153       Locale locale = req.getLocale();\r
 154       defaultlanguage = locale.getLanguage();\r
 155     }\r
 156 \r
 157     return defaultlanguage;\r
 158   }\r
 159 \r
 160   public void doPost(HttpServletRequest req, HttpServletResponse res)\r
 161     throws ServletException, IOException, UnavailableException {\r
 162     long startTime = System.currentTimeMillis();\r
 163     long sessionConnectTime = 0;\r
 164     EntityUsers userEntity;\r
 165     String http = "";\r
 166 \r
 167     if ((configuration.getString("RootUri") == null) ||\r
 168         configuration.getString("RootUri").equals("")) {\r
 169       configuration.setProperty("RootUri", req.getContextPath());\r
 170     }\r
 171 \r
 172     configuration.addProperty("ServletName", getServletName());\r
 173 \r
 174     //*** test\r
 175     // Log.info(this, "blalalala");\r
 176     session = req.getSession(true);\r
 177     userEntity = (EntityUsers) session.getAttribute("login.uid");\r
 178 \r
 179     if (req.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(res);\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(req), "");\r
 191     MessageResources messageResources =\r
 192       MessageResources.getMessageResources("bundles.admin");\r
 193     String htmlcharset = messageResources.getMessage(locale, "htmlcharset");\r
 194 \r
 195     res.setContentType("text/html; charset=" + htmlcharset);\r
 196 \r
 197     String moduleName = req.getParameter("module");\r
 198     checkLanguage(session, req);\r
 199 \r
 200     /** @todo for cleanup and readability this should be moved to\r
 201      *  method loginIfNecessary() */\r
 202     if ((moduleName != null) && moduleName.equals("direct")) {\r
 203       //...\r
 204     }\r
 205 \r
 206     // Authentication\r
 207     if (((moduleName != null) && moduleName.equals("login")) ||\r
 208         (userEntity == null)) {\r
 209       String user = req.getParameter("login");\r
 210       String passwd = req.getParameter("password");\r
 211       logger.debug("--login: evaluating for user: " + user);\r
 212       userEntity = allowedUser(user, passwd);\r
 213 \r
 214       if (userEntity == null) {\r
 215         // login failed: redirecting to login\r
 216         logger.warn("--login: failed!");\r
 217         _sendLoginPage(res, req, res.getWriter());\r
 218 \r
 219         return;\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 = req.getServerPort();\r
 232           String redirect = "";\r
 233           String redirectString = "";\r
 234 \r
 235           if (serverPort == 80) {\r
 236             redirect =\r
 237               res.encodeURL(http + "://" + req.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               res.encodeURL(http + "://" + req.getServerName() + ":" +\r
 245                 req.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           res.getWriter().println(redirectString);\r
 253 \r
 254           //res.sendRedirect(redirect);\r
 255         } else {\r
 256           // redirecting to default target\r
 257           logger.debug("--login: no target - redirecting to default");\r
 258           _sendStartPage(res, req, res.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 = req.getSession(true);\r
 272       //checkLanguage(session, req);\r
 273       _sendLoginPage(res, req, res.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 = req.getRequestURI();\r
 282       String queryString = req.getQueryString();\r
 283 \r
 284       if ((queryString != null) && !queryString.equals("")) {\r
 285         redirectString += ("?" + req.getQueryString());\r
 286         logger.debug("STORING: " + redirectString);\r
 287         session.setAttribute("login.target", redirectString);\r
 288       }\r
 289 \r
 290       _sendLoginPage(res, req, res.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(res, req, res.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, req, res);\r
 309     } catch (ServletModuleException e) {\r
 310       handleError(req, res, res.getWriter(),\r
 311         "ServletException in Module " + moduleName + " -- " + e.getMessage());\r
 312     } catch (ServletModuleUserException e) {\r
 313       handleUserError(req, res, res.getWriter(), e.getMessage());\r
 314     }\r
 315 \r
 316     // timing...\r
 317     sessionConnectTime = System.currentTimeMillis() - startTime;\r
 318     logger.info("EXECTIME (" + moduleName + "): " + sessionConnectTime + " ms");\r
 319   }\r
 320 \r
 321   /**\r
 322    *  Private method getServletModuleForName returns ServletModule\r
 323    *  from Cache\r
 324    *\r
 325    * @param moduleName\r
 326    * @return ServletModule\r
 327    *\r
 328    */\r
 329   private static ServletModule getServletModuleForName(String moduleName)\r
 330     throws ServletModuleException {\r
 331     // Instance in Map ?\r
 332     if (!servletModuleInstanceHash.containsKey(moduleName)) {\r
 333       // was not found in hash...\r
 334       try {\r
 335         Class theServletModuleClass = null;\r
 336 \r
 337         try {\r
 338           // first we try to get ServletModule from stern.che3.servlet\r
 339           theServletModuleClass =\r
 340             Class.forName("mircoders.servlet.ServletModule" + moduleName);\r
 341         } catch (ClassNotFoundException e) {\r
 342           // on failure, we try to get it from lib-layer\r
 343           theServletModuleClass =\r
 344             Class.forName("mir.servlet.ServletModule" + moduleName);\r
 345         }\r
 346 \r
 347         Method m = theServletModuleClass.getMethod("getInstance", null);\r
 348         ServletModule smod = (ServletModule) m.invoke(null, null);\r
 349 \r
 350         // we put it into map for further reference\r
 351         servletModuleInstanceHash.put(moduleName, smod);\r
 352 \r
 353         return smod;\r
 354       } catch (Exception e) {\r
 355         throw new ServletModuleException("*** error resolving classname for " +\r
 356           moduleName + " -- " + e.getMessage());\r
 357       }\r
 358     } else {\r
 359       return (ServletModule) servletModuleInstanceHash.get(moduleName);\r
 360     }\r
 361   }\r
 362 \r
 363   private void handleError(HttpServletRequest req, HttpServletResponse res,\r
 364     PrintWriter out, String errorString) {\r
 365     try {\r
 366       logger.error(errorString);\r
 367 \r
 368       SimpleHash modelRoot = new SimpleHash();\r
 369       modelRoot.put("errorstring", new SimpleScalar(errorString));\r
 370       modelRoot.put("date",\r
 371         new SimpleScalar(StringUtil.date2readableDateTime(\r
 372             new GregorianCalendar())));\r
 373       HTMLTemplateProcessor.process(res,\r
 374         MirPropertiesConfiguration.instance().getString("Mir.ErrorTemplate"),\r
 375         modelRoot, out, getLocale(req));\r
 376       out.close();\r
 377     }\r
 378     catch (Exception e) {\r
 379       logger.error("Error in ErrorTemplate: " + e.getMessage());\r
 380       e.printStackTrace(logger.asPrintWriter(LoggerWrapper.DEBUG_MESSAGE));\r
 381     }\r
 382   }\r
 383 \r
 384   private void handleUserError(HttpServletRequest req, HttpServletResponse res,\r
 385     PrintWriter out, String errorString) {\r
 386     try {\r
 387       logger.error(errorString);\r
 388 \r
 389       SimpleHash modelRoot = new SimpleHash();\r
 390       modelRoot.put("errorstring", new SimpleScalar(errorString));\r
 391       modelRoot.put("date",\r
 392         new SimpleScalar(StringUtil.date2readableDateTime(\r
 393             new GregorianCalendar())));\r
 394       HTMLTemplateProcessor.process(res,\r
 395         MirPropertiesConfiguration.instance().getString("Mir.UserErrorTemplate"),\r
 396         modelRoot, out, getLocale(req));\r
 397       out.close();\r
 398     }\r
 399     catch (Exception e) {\r
 400       logger.error("Error in UserErrorTemplate");\r
 401     }\r
 402   }\r
 403 \r
 404   /**\r
 405    *  evaluate login for user / password\r
 406    */\r
 407   protected EntityUsers allowedUser(String user, String password) {\r
 408     try {\r
 409       if (usersModule == null) {\r
 410         usersModule = new ModuleUsers(DatabaseUsers.getInstance());\r
 411       }\r
 412 \r
 413       return usersModule.getUserForLogin(user, password);\r
 414     } catch (Exception e) {\r
 415       logger.debug(e.getMessage());\r
 416       e.printStackTrace();\r
 417 \r
 418       return null;\r
 419     }\r
 420   }\r
 421 \r
 422   // Redirect-methods\r
 423   private void _sendLoginPage(HttpServletResponse res, HttpServletRequest req,\r
 424     PrintWriter out) {\r
 425     String loginTemplate = configuration.getString("Mir.LoginTemplate");\r
 426     String sessionUrl = res.encodeURL("");\r
 427 \r
 428     try {\r
 429       SimpleHash mergeData = new SimpleHash();\r
 430       SimpleList languages = new SimpleList();\r
 431 \r
 432       mergeData.put("session", sessionUrl);\r
 433 \r
 434       mergeData.put("defaultlanguage", getDefaultLanguage(req));\r
 435       mergeData.put("languages", getLoginLanguages());\r
 436 \r
 437       HTMLTemplateProcessor.process(res, loginTemplate, mergeData, out,\r
 438         getLocale(req));\r
 439     } catch (Throwable e) {\r
 440       handleError(req, res, out, "Error sending login page: " + e.getMessage());\r
 441     }\r
 442   }\r
 443 \r
 444   private void _sendStartPage(HttpServletResponse res, HttpServletRequest req,\r
 445     PrintWriter out, EntityUsers userEntity) {\r
 446     String startTemplate = "templates/admin/start_admin.template";\r
 447     String sessionUrl = res.encodeURL("");\r
 448 \r
 449     try {\r
 450       // merge with logged in user and messages\r
 451       SimpleHash mergeData = new SimpleHash();\r
 452       mergeData.put("session", sessionUrl);\r
 453       mergeData.put("login_user", userEntity);\r
 454 \r
 455       if (messageModule == null) {\r
 456         messageModule = new ModuleMessage(DatabaseMessages.getInstance());\r
 457       }\r
 458 \r
 459       mergeData.put("messages",\r
 460         messageModule.getByWhereClause(null, "webdb_create desc", 0, 10));\r
 461 \r
 462       mergeData.put("articletypes",\r
 463         DatabaseArticleType.getInstance().selectByWhereClause("", "id", 0, 20));\r
 464 \r
 465       HTMLTemplateProcessor.process(res, startTemplate, mergeData, out,\r
 466         getLocale(req));\r
 467     }\r
 468     catch (Exception e) {\r
 469       e.printStackTrace(logger.asPrintWriter(LoggerWrapper.DEBUG_MESSAGE));\r
 470       handleError(req, res, out, "error while trying to send startpage. " + e.getMessage());\r
 471     }\r
 472   }\r
 473 \r
 474   public String getServletInfo() {\r
 475     return "Mir " + configuration.getString("Mir.Version");\r
 476   }\r
 477 \r
 478   private void checkLanguage(HttpSession session, HttpServletRequest req) {\r
 479     // a lang parameter always sets the language\r
 480     String lang = req.getParameter("language");\r
 481 \r
 482     if (lang != null) {\r
 483       logger.info("selected language " + lang + " overrides accept-language");\r
 484       setLanguage(session, lang);\r
 485       setLocale(session, new Locale(lang, ""));\r
 486     }\r
 487     // otherwise store language from accept header in session\r
 488     else if (session.getAttribute("Language") == null) {\r
 489       logger.info("accept-language is " + req.getLocale().getLanguage());\r
 490       setLanguage(session, req.getLocale().getLanguage());\r
 491       setLocale(session, req.getLocale());\r
 492     }\r
 493   }\r
 494 }\r