source/mircoders/servlet/ServletHelper.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  any library licensed under the Apache Software License,\r
  22  * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library\r
  23  * (or with modified versions of the above that use the same license as the above),\r
  24  * and distribute linked combinations including the two.  You must obey the\r
  25  * GNU General Public License in all respects for all of the code used other than\r
  26  * the above mentioned libraries.  If you modify this file, you may extend this\r
  27  * exception to your version of the file, but you are not obligated to do so.\r
  28  * If you do not wish to do so, delete this exception statement from your version.\r
  29  */\r
  30 package mircoders.servlet;\r
  31 \r
  32 import java.io.PrintWriter;\r
  33 import java.io.IOException;\r
  34 import java.util.Locale;\r
  35 import java.util.Map;\r
  36 \r
  37 import javax.servlet.http.HttpServletRequest;\r
  38 import javax.servlet.http.HttpServletResponse;\r
  39 \r
  40 import mir.config.MirPropertiesConfiguration;\r
  41 import mir.entity.adapter.EntityAdapter;\r
  42 import mir.generator.Generator;\r
  43 import mir.generator.GeneratorHelper;\r
  44 import mir.log.LoggerWrapper;\r
  45 import mir.servlet.ServletModuleExc;\r
  46 import mir.servlet.ServletModuleFailure;\r
  47 import mircoders.entity.EntityUsers;\r
  48 import mircoders.global.MirGlobal;\r
  49 \r
  50 \r
  51 public class ServletHelper {\r
  52   private static LoggerWrapper logger = new LoggerWrapper("ServletModule.Helper");\r
  53 \r
  54   public static Map makeGenerationData(HttpServletRequest aRequest, HttpServletResponse aResponse, Locale[] aLocales) throws ServletModuleExc {\r
  55     return makeGenerationData(aRequest, aResponse, aLocales, "etc/bundles/adminlocal", "bundles/admin");\r
  56   }\r
  57 \r
  58   public static Map makeGenerationData(HttpServletRequest aRequest, HttpServletResponse aResponse, Locale[] aLocales, String aBundle) throws ServletModuleExc {\r
  59     return makeGenerationData(aRequest, aResponse, aLocales, aBundle, aBundle);\r
  60   }\r
  61 \r
  62   public static Map makeGenerationData(HttpServletRequest aRequest, HttpServletResponse aResponse, Locale[] aLocales, String aBundle, String aDefaultBundle) throws ServletModuleExc {\r
  63     try {\r
  64       MirPropertiesConfiguration configuration = MirPropertiesConfiguration.instance();\r
  65       Map result = GeneratorHelper.makeBasicGenerationData(aLocales, aBundle, aDefaultBundle);\r
  66       if (configuration.getString("Mir.Admin.ShowLoggedinUsers").equals("1")) {\r
  67         result.put("loggedinusers", MirGlobal.getLoggedInUsers());\r
  68       }\r
  69       else {\r
  70         result.put("loggedinusers", null);\r
  71       }\r
  72       result.put("systemstatus", MirGlobal.getStatus());\r
  73 \r
  74       // ML: hackish\r
  75       ((Map) result.get("config")).put("actionRoot",\r
  76              aResponse.encodeURL(MirGlobal.config().getString("RootUri") + "/servlet/Mir"));\r
  77 \r
  78       result.put("returnurl", null);\r
  79       result.put("login_user", getUserAdapter(aRequest));\r
  80 \r
  81       return result;\r
  82     }\r
  83     catch (Throwable t) {\r
  84       throw new ServletModuleFailure(t);\r
  85     }\r
  86   }\r
  87 \r
  88   public static void generateResponse(PrintWriter aWriter, Map aGenerationData, String aGenerator) throws ServletModuleExc {\r
  89     logger.debug("generator used: " + aGenerator);\r
  90 \r
  91     Generator generator;\r
  92 \r
  93     try {\r
  94       generator = MirGlobal.localizer().generators().makeAdminGeneratorLibrary().makeGenerator(aGenerator);\r
  95 \r
  96       generator.generate(aWriter, aGenerationData, logger);\r
  97     }\r
  98     catch (Throwable t) {\r
  99       throw new ServletModuleFailure(t);\r
 100     }\r
 101   }\r
 102 \r
 103   public static void generateOpenPostingResponse(PrintWriter aWriter, Map aGenerationData, String aGenerator) throws ServletModuleExc {\r
 104     Generator generator;\r
 105 \r
 106     try {\r
 107       generator = MirGlobal.localizer().generators().makeOpenPostingGeneratorLibrary().makeGenerator(aGenerator);\r
 108 \r
 109       generator.generate(aWriter, aGenerationData, logger);\r
 110     }\r
 111     catch (Throwable t) {\r
 112       throw new ServletModuleFailure(t);\r
 113     }\r
 114   }\r
 115 \r
 116   public static void generateInfoMessage(HttpServletRequest aRequest, HttpServletResponse aResponse,\r
 117       Locale[] aLocales, String aBundle, String aDefaultBundle, String aMessage, String anArgument1, String anArgument2) throws ServletModuleExc {\r
 118     Map responseData = makeGenerationData(aRequest, aResponse, aLocales, aBundle, aDefaultBundle);\r
 119     responseData.put("message", aMessage);\r
 120     responseData.put("argument1", anArgument1);\r
 121     responseData.put("argument2", anArgument2);\r
 122 \r
 123     try {\r
 124       generateResponse(aResponse.getWriter(), responseData, "infomessage.template");\r
 125     }\r
 126     catch (IOException e) {\r
 127       throw new ServletModuleFailure(e);\r
 128     }\r
 129   }\r
 130 \r
 131   public static void redirect(HttpServletResponse aResponse, String aQuery) throws ServletModuleExc, ServletModuleFailure {\r
 132     try {\r
 133       aResponse.sendRedirect(aResponse.encodeRedirectURL(MirPropertiesConfiguration.instance().getString("RootUri") + "/servlet/Mir?"+aQuery));\r
 134     }\r
 135     catch (IOException t) {\r
 136       throw new ServletModuleFailure("ServletModule.redirect: " +t.getMessage(), t);\r
 137     }\r
 138   }\r
 139 \r
 140   public static void redirect(HttpServletResponse aResponse, String aModule, String aMethod) throws ServletModuleExc, ServletModuleFailure {\r
 141     redirect(aResponse, "module="+aModule+"&do="+aMethod);\r
 142   }\r
 143 \r
 144   public static void setUser(HttpServletRequest aRequest, EntityUsers aUser) {\r
 145     if (aUser!=null)\r
 146       aRequest.getSession().setAttribute("login.uid", aUser);\r
 147     else\r
 148       aRequest.getSession().removeAttribute("login.uid");\r
 149   }\r
 150 \r
 151   public static EntityUsers getUser(HttpServletRequest aRequest) {\r
 152     return (EntityUsers) aRequest.getSession().getAttribute("login.uid");\r
 153   }\r
 154 \r
 155   public static EntityAdapter getUserAdapter(HttpServletRequest aRequest) {\r
 156     try {\r
 157       return MirGlobal.localizer().dataModel().adapterModel().makeEntityAdapter( "user", (EntityUsers) aRequest.getSession().getAttribute("login.uid"));\r
 158     }\r
 159     catch (Throwable t) {\r
 160       throw new ServletModuleFailure (t);\r
 161     }\r
 162   }\r
 163 \r
 164   public static String getUserName(HttpServletRequest aRequest) {\r
 165     EntityUsers user = getUser(aRequest);\r
 166 \r
 167     if (user!=null)\r
 168       return user.getFieldValue("login");\r
 169     else\r
 170       return "nobody";\r
 171   }\r
 172 }\r