major cleanup:
[mir.git] / source / mir / servlet / ServletModule.java
index 12df8a9..42519db 100755 (executable)
-/*
- * Copyright (C) 2001, 2002 The Mir-coders group
- *
- * This file is part of Mir.
- *
- * Mir is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * Mir is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with Mir; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
- *
- * In addition, as a special exception, The Mir-coders gives permission to link
- * the code of this program with  any library licensed under the Apache Software License, 
- * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library 
- * (or with modified versions of the above that use the same license as the above), 
- * and distribute linked combinations including the two.  You must obey the 
- * GNU General Public License in all respects for all of the code used other than 
- * the above mentioned libraries.  If you modify this file, you may extend this 
- * exception to your version of the file, but you are not obligated to do so.  
- * If you do not wish to do so, delete this exception statement from your version.
- */
-package mir.servlet;
-
-import java.io.PrintWriter;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Locale;
-import java.util.Map;
-
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
-import javax.servlet.http.HttpSession;
-
-import mir.config.MirPropertiesConfiguration;
-import mir.config.MirPropertiesConfiguration.PropertiesConfigExc;
-import mir.entity.EntityList;
-import mir.log.LoggerWrapper;
-import mir.misc.HTMLTemplateProcessor;
-import mir.misc.LineFilterWriter;
-import mir.module.AbstractModule;
-import mir.storage.StorageObject;
-import mir.util.HTTPRequestParser;
-import freemarker.template.SimpleHash;
-import freemarker.template.TemplateModelRoot;
-
-
-
-
-/**
- * Abstract class ServletModule provides the base functionality for servlets.
- * Deriving a class from ServletModule enables class to insert/edit/update/delete
- * and list Entity from a Database via mainModule.
- *
- *
- *  Abstrakte Klasse ServletModule stellt die Basisfunktionalitaet der
- *  abgeleiteten ServletModule zur Verf?gung.
- *
- * @version 28.6.1999
- * @author RK
- */
-
-public abstract class ServletModule {
-
-  public String defaultAction;
-  protected LoggerWrapper logger;
-  protected MirPropertiesConfiguration configuration;
-  protected AbstractModule mainModule;
-  protected Locale fallbackLocale;
-  protected String templateListString;
-  protected String templateObjektString;
-  protected String templateConfirmString;
-
-
-  public ServletModule(){
-    try {
-      configuration = MirPropertiesConfiguration.instance();
-    }
-    catch (PropertiesConfigExc e) {
-      throw new RuntimeException("Can't get configuration: " + e.getMessage());
-    }
-
-    fallbackLocale = new Locale(configuration.getString("Mir.Admin.FallbackLanguage", "en"), "");
-  }
-
-
-  /**
-   * Singelton - Methode muss in den abgeleiteten Klassen ueberschrieben werden.
-   * @return ServletModule
-   */
-  public static ServletModule getInstance() {
-    return null;
-  }
-
-  /**
-   * get the module name to be used for generic operations like delete.
-   */
-  protected String getOperationModuleName() {
-    return getClass().getName().substring((new String("mircoders.servlet.ServletModule")).length());
-  }
-
-  /**
-   * get the locale either from the session or the accept-language header ot the request
-   * this supersedes getLanguage for the new i18n
-   */
-  public Locale getLocale(HttpServletRequest req) {
-    Locale loc = null;
-    HttpSession session = req.getSession(false);
-    if (session != null) {
-      // session can be null in case of logout
-      loc = (Locale) session.getAttribute("locale");
-    }
-    // if there is nothing in the session get it fron the accept-language
-    if (loc == null) {
-      loc = req.getLocale();
-    }
-    return loc;
-  }
-
-  /**
-   * get the locale either from the session or the accept-language header ot the request
-   * this supersedes getLanguage for the new i18n
-   */
-  public Locale getFallbackLocale(HttpServletRequest req) {
-    return fallbackLocale;
-  }
-
-  public void redirect(HttpServletResponse aResponse, String aQuery) throws ServletModuleExc, ServletModuleFailure {
-    try {
-      aResponse.sendRedirect(MirPropertiesConfiguration.instance().getString("RootUri") + "/Mir?"+aQuery);
-    }
-    catch (Throwable t) {
-      throw new ServletModuleFailure("ServletModule.redirect: " +t.getMessage(), t);
-    }
-  }
-
-  /**
-   *  list(req,res) - generische Listmethode. Wennn die Funktionalitaet
-   *  nicht reicht, muss sie in der abgeleiteten ServletModule-Klasse
-   *  ueberschreiben werden.
-   *
-   * @param req Http-Request, das vom Dispatcher durchgereicht wird
-   * @param res Http-Response, die vom Dispatcher durchgereicht wird
-   */
-  public void list(HttpServletRequest req, HttpServletResponse res)
-      throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure {
-    try {
-      EntityList theList;
-      String offsetParam = req.getParameter("offset");
-      int offset = 0;
-      PrintWriter out = res.getWriter();
-
-      // hier offsetcode bearbeiten
-      if (offsetParam != null && !offsetParam.equals("")) {
-        offset = Integer.parseInt(offsetParam);
-      }
-      if (req.getParameter("next") != null) {
-        offset = Integer.parseInt(req.getParameter("nextoffset"));
-      }
-      else {
-        if (req.getParameter("prev") != null) {
-          offset = Integer.parseInt(req.getParameter("prevoffset"));
-        }
-      }
-      theList = mainModule.getByWhereClause(null, offset);
-
-      HTMLTemplateProcessor.process(res, templateListString, theList, null, null, out, getLocale(req), getFallbackLocale(req));
-    }
-    catch (Throwable e) {
-      throw new ServletModuleFailure(e);
-    }
-  }
-
-  /**
-   *  add(req,res) - generische Addmethode. Wennn die Funktionalitaet
-   *  nicht reicht, muss sie in der abgeleiteten ServletModule-Klasse
-   *  ueberschreiben werden.
-   * @param req Http-Request, das vom Dispatcher durchgereicht wird
-   * @param res Http-Response, die vom Dispatcher durchgereicht wird
-   */
-  public void add(HttpServletRequest req, HttpServletResponse res)
-      throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure  {
-
-    try {
-      SimpleHash mergeData = new SimpleHash();
-      mergeData.put("new", "1");
-      deliver(req, res, mergeData, templateObjektString);
-    }
-    catch (Throwable e) {
-      throw new ServletModuleFailure(e);
-    }
-  }
-
-  /**
-   *  insert(req,res) - generische Insertmethode, folgt auf add.
-   *  Wennn die Funktionalitaet
-   *  nicht reicht, muss sie in der abgeleiteten ServletModule-Klasse
-   *  ueberschreiben werden.
-   *
-   * @param req Http-Request, das vom Dispatcher durchgereicht wird
-   * @param res Http-Response, die vom Dispatcher durchgereicht wird
-   */
-  public void insert(HttpServletRequest req, HttpServletResponse res)
-      throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure  {
-    try {
-      Map withValues = getIntersectingValues(req, mainModule.getStorageObject());
-      logger.debug("--trying to add...");
-      String id = mainModule.add(withValues);
-      logger.debug("--trying to deliver..." + id);
-      list(req, res);
-    }
-    catch (Throwable e) {
-      throw new ServletModuleFailure(e);
-    }
-  }
-
-  /**
-   *  delete(req,res) - generic delete method. Can be overridden in subclasses.
-   *
-   */
-
-  public void delete(HttpServletRequest req, HttpServletResponse res)
-      throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure  {
-    try {
-      String idParam = req.getParameter("id");
-
-      if (idParam == null)
-        throw new ServletModuleExc("Invalid call to delete: no id supplied");
-
-      String confirmParam = req.getParameter("confirm");
-      String cancelParam = req.getParameter("cancel");
-      if (confirmParam == null && cancelParam == null) {
-        SimpleHash mergeData = new SimpleHash();
-
-        mergeData.put("module", getOperationModuleName());
-        mergeData.put("infoString", getOperationModuleName() + ": " + idParam);
-        mergeData.put("id", idParam);
-        mergeData.put("where", req.getParameter("where"));
-        mergeData.put("order", req.getParameter("order"));
-        mergeData.put("offset", req.getParameter("offset"));
-        // this stuff is to be compatible with the other more advanced
-        // search method used for media and comments
-        mergeData.put("query_media_folder", req.getParameter("query_media_folder"));
-        mergeData.put("query_is_published", req.getParameter("query_is_published"));
-        mergeData.put("query_text", req.getParameter("query_text"));
-        mergeData.put("query_field", req.getParameter("query_field"));
-
-        deliver(req, res, mergeData, templateConfirmString);
-      }
-      else {
-        if (confirmParam != null && !confirmParam.equals("")) {
-          //theLog.printInfo("delete confirmed!");
-          mainModule.deleteById(idParam);
-          list(req, res); // back to list
-        }
-        else {
-          if (req.getParameter("where") != null)
-            list(req, res);
-          else
-            edit(req, res);
-        }
-      }
-    }
-    catch (Throwable e) {
-      throw new ServletModuleFailure(e);
-    }
-  }
-
-  /**
-   *  edit(req,res) - generische Editmethode. Wennn die Funktionalitaet
-   *  nicht reicht, muss sie in der abgeleiteten ServletModule-Klasse
-   *  ueberschreiben werden.
-   *
-   * @param req Http-Request, das vom Dispatcher durchgereicht wird
-   * @param res Http-Response, die vom Dispatcher durchgereicht wird
-   */
-  public void edit(HttpServletRequest req, HttpServletResponse res)
-      throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure  {
-    edit(req, res, req.getParameter("id"));
-  }
-
-  /**
-   *  edit(req,res) - generische Editmethode. Wennn die Funktionalitaet
-   *  nicht reicht, muss sie in der abgeleiteten ServletModule-Klasse
-   *  ueberschreiben werden.
-   *
-   * @param req Http-Request, das vom Dispatcher durchgereicht wird
-   * @param res Http-Response, die vom Dispatcher durchgereicht wird
-   */
-  public void edit(HttpServletRequest aRequest, HttpServletResponse aResponse, String anIdentifier)
-      throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure  {
-    try {
-      deliver(aRequest, aResponse, mainModule.getById(anIdentifier), templateObjektString);
-    }
-    catch (Throwable e) {
-      throw new ServletModuleFailure(e);
-    }
-  }
-
-  /**
-   *  update(req,res) - generische Updatemethode. Wennn die Funktionalitaet
-   *  nicht reicht, muss sie in der abgeleiteten ServletModule-Klasse
-   *  ueberschreiben werden.
-   *
-   * @param req Http-Request, das vom Dispatcher durchgereicht wird
-   * @param res Http-Response, die vom Dispatcher durchgereicht wird
-   */
-
-  public void update(HttpServletRequest req, HttpServletResponse res)
-      throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure  {
-    try {
-      String idParam = req.getParameter("id");
-      Map withValues = getIntersectingValues(req, mainModule.getStorageObject());
-
-      String id = mainModule.set(withValues);
-      String whereParam = req.getParameter("where");
-      String orderParam = req.getParameter("order");
-
-      if ((whereParam != null && !whereParam.equals("")) || (orderParam != null && !orderParam.equals(""))) {
-        list(req, res);
-      }
-      else {
-        edit(req, res);
-      }
-    }
-    catch (Throwable e) {
-      throw new ServletModuleFailure(e);
-    }
-  }
-
-  /**
-   * deliver liefert das Template mit dem Filenamen templateFilename
-   * an den HttpServletResponse res aus, nachdem es mit den Daten aus
-   * TemplateModelRoot rtm gemischt wurde
-   *
-   * @param res Http-Response, die vom Dispatcher durchgereicht wird
-   * @param rtm beinahalten das freemarker.template.TempalteModelRoot mit den
-   *   Daten, die ins Template gemerged werden sollen.
-   * @param tmpl Name des Templates
-   * @exception ServletModuleException
-   */
-  public void deliver(HttpServletRequest req, HttpServletResponse res, TemplateModelRoot rtm,
-         TemplateModelRoot popups, String templateFilename) throws ServletModuleFailure  {
-    if (rtm == null)
-      rtm = new SimpleHash();
-
-    try {
-      PrintWriter out = res.getWriter();
-      HTMLTemplateProcessor.process(res, templateFilename, rtm, popups, out, getLocale(req), getFallbackLocale(req));
-
-      // we default to admin bundles here, which is not exactly beautiful...
-      // but this whole producer stuff is going to be rewritten soon.
-      // ServletModuleOpenIndy overwrites deliver() to use open bundles
-      // (br1)
-      out.close();
-    }
-    catch (Throwable e) {
-      throw new ServletModuleFailure(e);
-    }
-  }
-
-
-  /**
-   * deliver liefert das Template mit dem Filenamen templateFilename
-   * an den HttpServletResponse res aus, nachdem es mit den Daten aus
-   * TemplateModelRoot rtm gemischt wurde
-   *
-   * @param res Http-Response, die vom Dispatcher durchgereicht wird
-   * @param rtm beinahalten das freemarker.template.TempalteModelRoot mit den
-   *   Daten, die ins Template gemerged werden sollen.
-   * @param tmpl Name des Templates
-   * @exception ServletModuleException
-   */
-  public void deliver(HttpServletRequest req, HttpServletResponse res,
-        TemplateModelRoot rtm, String templateFilename) throws ServletModuleFailure {
-    deliver(req, res, rtm, null, templateFilename);
-  }
-
-  /**
-   * deliver liefert das Template mit dem Filenamen templateFilename
-   * an den HttpServletResponse res aus, nachdem es mit den Daten aus
-   * TemplateModelRoot rtm gemischt wurde
-   *
-   * @param res Http-Response, die vom Dispatcher durchgereicht wird
-   * @param rtm beinahalten das freemarker.template.TempalteModelRoot mit den
-   *   Daten, die ins Template gemerged werden sollen.
-   * @param tmpl Name des Templates
-   * @exception ServletModuleException
-   */
-  public void deliver_compressed(HttpServletRequest req, HttpServletResponse res,
-                                 TemplateModelRoot rtm, String templateFilename)
-      throws ServletModuleFailure {
-    if (rtm == null) rtm = new SimpleHash();
-    try {
-      PrintWriter out = new LineFilterWriter(res.getWriter());
-      //PrintWriter out =  res.getWriter();
-      HTMLTemplateProcessor.process(res, templateFilename, rtm, null, out, getLocale(req), getFallbackLocale(req));
-      out.close();
-    }
-    catch (Throwable e) {
-      throw new ServletModuleFailure(e);
-    }
-  }
-
-  /**
-   * deliver liefert das Template mit dem Filenamen templateFilename
-   * an den HttpServletResponse res aus, nachdem es mit den Daten aus
-   * TemplateModelRoot rtm gemischt wurde
-   *
-   * @param out ist der OutputStream, in den die gergten Daten geschickt werden sollen.
-   * @param rtm beinahalten das freemarker.template.TempalteModelRoot mit den
-   *   Daten, die ins Template gemerged werden sollen.
-   * @param tmpl Name des Templates
-   * @exception ServletModuleException
-   */
-  private void deliver(HttpServletResponse res, HttpServletRequest req, PrintWriter out,
-                       TemplateModelRoot rtm, String templateFilename)
-      throws ServletModuleFailure {
-    try {
-      HTMLTemplateProcessor.process(res, templateFilename, rtm, null, out, getLocale(req), getFallbackLocale(req));
-    }
-    catch (Throwable e) {
-      throw new ServletModuleFailure(e);
-    }
-  }
-
-  /**
-   *  Wenn die abgeleitete Klasse diese Methode ueberschreibt und einen String mit einem
-   *  Methodennamen zurueckliefert, dann wird diese Methode bei fehlender Angabe des
-   *  doParameters ausgefuehrt.
-   *
-   * @return Name der Default-Action
-   */
-  public String defaultAction() {
-    return defaultAction;
-  }
-
-  /**
-   * Gets the fields from a httprequest and matches them with the metadata from
-   * the storage object. Returns the keys that match, with their values.
-   *
-   * @return Map with the values
-   */
-  public Map getIntersectingValues(HttpServletRequest req, StorageObject theStorage)
-      throws ServletModuleExc, ServletModuleFailure {
-
-    try {
-      HTTPRequestParser parser;
-      List theFieldList;
-
-      parser = new HTTPRequestParser(req);
-
-      theFieldList = theStorage.getFields();
-
-      Map withValues = new HashMap();
-      String aField, aValue;
-
-      for (int i = 0; i < theFieldList.size(); i++) {
-        aField = (String) theFieldList.get(i);
-
-        aValue = parser.getParameter(aField);
-        if (aValue != null)
-          withValues.put(aField, aValue);
-      }
-      return withValues;
-    }
-    catch (Throwable e) {
-      e.printStackTrace(logger.asPrintWriter(LoggerWrapper.DEBUG_MESSAGE));
-
-      throw new ServletModuleFailure( "ServletModule.getIntersectingValues: " + e.getMessage(), e);
-    }
-  }
+/*\r
+ * Copyright (C) 2001, 2002 The Mir-coders group\r
+ *\r
+ * This file is part of Mir.\r
+ *\r
+ * Mir is free software; you can redistribute it and/or modify\r
+ * it under the terms of the GNU General Public License as published by\r
+ * the Free Software Foundation; either version 2 of the License, or\r
+ * (at your option) any later version.\r
+ *\r
+ * Mir is distributed in the hope that it will be useful,\r
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
+ * GNU General Public License for more details.\r
+ *\r
+ * You should have received a copy of the GNU General Public License\r
+ * along with Mir; if not, write to the Free Software\r
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
+ *\r
+ * In addition, as a special exception, The Mir-coders gives permission to link\r
+ * the code of this program with  any library licensed under the Apache Software License,\r
+ * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library\r
+ * (or with modified versions of the above that use the same license as the above),\r
+ * and distribute linked combinations including the two.  You must obey the\r
+ * GNU General Public License in all respects for all of the code used other than\r
+ * the above mentioned libraries.  If you modify this file, you may extend this\r
+ * exception to your version of the file, but you are not obligated to do so.\r
+ * If you do not wish to do so, delete this exception statement from your version.\r
+ */\r
+package mir.servlet;\r
+\r
+import java.util.HashMap;\r
+import java.util.Iterator;\r
+import java.util.List;\r
+import java.util.Locale;\r
+import java.util.Map;\r
+import javax.servlet.http.HttpServletRequest;\r
+import javax.servlet.http.HttpServletResponse;\r
+import javax.servlet.http.HttpSession;\r
+\r
+import mir.config.MirPropertiesConfiguration;\r
+import mir.config.MirPropertiesConfiguration.PropertiesConfigExc;\r
+import mir.entity.adapter.EntityAdapterDefinition;\r
+import mir.entity.adapter.EntityAdapterEngine;\r
+import mir.entity.adapter.EntityAdapterModel;\r
+import mir.log.LoggerWrapper;\r
+import mir.module.AbstractModule;\r
+import mir.storage.StorageObject;\r
+import mir.util.HTTPRequestParser;\r
+import mir.util.URLBuilder;\r
+import mircoders.servlet.ServletHelper;\r
+\r
+/**\r
+ *\r
+ * <p>Title: </p>\r
+ * <p>Description: </p>\r
+ * <p>Copyright: Copyright (c) 2003</p>\r
+ * <p>Company: </p>\r
+ * @author not attributable\r
+ * @version 1.0\r
+ */\r
+\r
+public abstract class ServletModule {\r
+  public String defaultAction;\r
+  protected LoggerWrapper logger;\r
+  protected MirPropertiesConfiguration configuration;\r
+  protected Locale fallbackLocale;\r
+\r
+  protected AbstractModule mainModule;\r
+  protected String definition;\r
+  protected EntityAdapterModel model;\r
+\r
+  protected String listGenerator;\r
+  protected String editGenerator;\r
+  protected String deleteConfirmationGenerator;\r
+  protected int nrEntitiesPerListPage;\r
+\r
+\r
+  public ServletModule(){\r
+    definition = null;\r
+    model = null;\r
+\r
+    try {\r
+      configuration = MirPropertiesConfiguration.instance();\r
+    }\r
+    catch (PropertiesConfigExc e) {\r
+      throw new RuntimeException("Can't get configuration: " + e.getMessage());\r
+    }\r
+\r
+    listGenerator = configuration.getString("ServletModule."+getOperationModuleName()+".ListTemplate");\r
+    editGenerator = configuration.getString("ServletModule."+getOperationModuleName()+".EditTemplate");\r
+    deleteConfirmationGenerator = configuration.getString("ServletModule."+getOperationModuleName()+".DeleteConfirmationTemplate");\r
+    nrEntitiesPerListPage =\r
+        configuration.getInt("ServletModule."+getOperationModuleName()+".ListSize",\r
+        configuration.getInt("ServletModule.Default.ListSize", 20));\r
+\r
+    fallbackLocale = new Locale(configuration.getString("Mir.Admin.FallbackLanguage", "en"), "");\r
+  }\r
+\r
+\r
+  /**\r
+   * Singleton instance retrievel method. MUST be overridden in subclasses.\r
+   *\r
+   * @return ServletModule the single instance of the servletmodule class\r
+   */\r
+  public static ServletModule getInstance() {\r
+    return null;\r
+  }\r
+\r
+  /**\r
+   * Get the module name\r
+   *\r
+   * @return\r
+   */\r
+  protected String getOperationModuleName() {\r
+    return getClass().getName().substring((new String("mircoders.servlet.ServletModule")).length());\r
+  }\r
+\r
+  /**\r
+   * get the locale either from the session or the accept-language header ot the request\r
+   * this supersedes getLanguage for the new i18n\r
+   */\r
+  public Locale getLocale(HttpServletRequest aRequest) {\r
+    Locale loc = null;\r
+    HttpSession session = aRequest.getSession(false);\r
+    if (session != null) {\r
+      // session can be null in case of logout\r
+      loc = (Locale) session.getAttribute("locale");\r
+    }\r
+    // if there is nothing in the session get it fron the accept-language\r
+    if (loc == null) {\r
+      loc = aRequest.getLocale();\r
+    }\r
+    return loc;\r
+  }\r
+\r
+  /**\r
+   * get the locale either from the session or the accept-language header ot the request\r
+   * this supersedes getLanguage for the new i18n\r
+   */\r
+  public Locale getFallbackLocale(HttpServletRequest aRequest) {\r
+    return fallbackLocale;\r
+  }\r
+\r
+  /**\r
+   * Function to specify the default ordering for lists. May be overridden.\r
+   *\r
+   *\r
+   * @return\r
+   */\r
+  public String getDefaultListOrdering() {\r
+\r
+    if (mainModule!=null && mainModule.getStorageObject()!=null){\r
+      if (mainModule.getStorageObject().getFields().contains("webdb_create"))\r
+        return "webdb_create desc";\r
+    }\r
+\r
+    return "id asc";\r
+  }\r
+\r
+  /**\r
+   *\r
+   * @param aResponse\r
+   * @param aQuery\r
+   * @throws ServletModuleExc\r
+   * @throws ServletModuleFailure\r
+   */\r
+  public void redirect(HttpServletResponse aResponse, String aQuery) throws ServletModuleExc, ServletModuleFailure {\r
+    try {\r
+      aResponse.sendRedirect(aResponse.encodeRedirectURL(MirPropertiesConfiguration.instance().getString("RootUri") + "/Mir?"+aQuery));\r
+    }\r
+    catch (Throwable t) {\r
+      throw new ServletModuleFailure("ServletModule.redirect: " +t.getMessage(), t);\r
+    }\r
+  }\r
+\r
+  /**\r
+   * Generic list method\r
+   *\r
+   * @param aRequest\r
+   * @param aResponse\r
+   * @throws ServletModuleExc\r
+   * @throws ServletModuleUserExc\r
+   * @throws ServletModuleFailure\r
+   */\r
+\r
+  public void list(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc\r
+  {\r
+    HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);\r
+\r
+    String where = requestParser.getParameter("where");\r
+    String order = requestParser.getParameterWithDefault("order", getDefaultListOrdering());\r
+    int offset = requestParser.getIntegerWithDefault("offset", 0);\r
+\r
+    returnList(aRequest, aResponse, where, order, offset);\r
+  }\r
+\r
+\r
+  public void returnList(HttpServletRequest aRequest, HttpServletResponse aResponse,\r
+     String aWhereClause, String anOrderByClause, int anOffset) throws ServletModuleExc {\r
+\r
+    HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);\r
+    URLBuilder urlBuilder = new URLBuilder();\r
+    int count;\r
+\r
+    try {\r
+      Map responseData = ServletHelper.makeGenerationData(aRequest, aResponse, new Locale[] { getLocale(aRequest), getFallbackLocale(aRequest)});\r
+\r
+      List list =\r
+         EntityAdapterEngine.retrieveAdapterList(model, definition, aWhereClause, anOrderByClause, nrEntitiesPerListPage, anOffset);\r
+\r
+      responseData.put("nexturl", null);\r
+      responseData.put("prevurl", null);\r
+      responseData.put("module", getOperationModuleName());\r
+\r
+      count=mainModule.getSize(aWhereClause);\r
+\r
+      urlBuilder.setValue("module", getOperationModuleName());\r
+      urlBuilder.setValue("do", "list");\r
+      urlBuilder.setValue("where", aWhereClause);\r
+      urlBuilder.setValue("order", anOrderByClause);\r
+\r
+      urlBuilder.setValue("searchfield", requestParser.getParameter("searchfield"));\r
+      urlBuilder.setValue("searchtext", requestParser.getParameter("searchtext"));\r
+      urlBuilder.setValue("searchispublished", requestParser.getParameter("searchispublished"));\r
+      urlBuilder.setValue("searchstatus", requestParser.getParameter("searchstatus"));\r
+      urlBuilder.setValue("searchorder", requestParser.getParameter("searchorder"));\r
+\r
+      responseData.put("searchfield", requestParser.getParameter("searchfield"));\r
+      responseData.put("searchtext", requestParser.getParameter("searchtext"));\r
+      responseData.put("searchispublished", requestParser.getParameter("searchispublished"));\r
+      responseData.put("searchstatus", requestParser.getParameter("searchstatus"));\r
+      responseData.put("searchorder", requestParser.getParameter("searchorder"));\r
+\r
+      urlBuilder.setValue("offset", anOffset);\r
+      responseData.put("offset" , new Integer(anOffset).toString());\r
+      responseData.put("thisurl" , urlBuilder.getQuery());\r
+\r
+      if (count>anOffset+nrEntitiesPerListPage) {\r
+        urlBuilder.setValue("offset", anOffset + nrEntitiesPerListPage);\r
+        responseData.put("nexturl" , urlBuilder.getQuery());\r
+      }\r
+\r
+      if (anOffset>0) {\r
+        urlBuilder.setValue("offset", Math.max(anOffset - nrEntitiesPerListPage, 0));\r
+        responseData.put("prevurl" , urlBuilder.getQuery());\r
+      }\r
+\r
+      responseData.put("entities", list);\r
+      responseData.put("from" , Integer.toString(anOffset+1));\r
+      responseData.put("count", Integer.toString(count));\r
+      responseData.put("to", Integer.toString(Math.min(anOffset+nrEntitiesPerListPage, count)));\r
+\r
+      ServletHelper.generateResponse(aResponse.getWriter(), responseData, listGenerator);\r
+    }\r
+    catch (Throwable e) {\r
+      throw new ServletModuleFailure(e);\r
+    }\r
+  }\r
+\r
+  public void editObject(HttpServletRequest aRequest, HttpServletResponse aResponse, Object anObject, boolean anIsNew, String anId) throws ServletModuleExc {\r
+    HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);\r
+    URLBuilder urlBuilder = new URLBuilder();\r
+    EntityAdapterModel model;\r
+\r
+    try {\r
+      Map responseData = ServletHelper.makeGenerationData(aRequest, aResponse, new Locale[] { getLocale(aRequest), getFallbackLocale(aRequest)});\r
+\r
+      responseData.put("module", getOperationModuleName());\r
+      responseData.put("entity", anObject);\r
+      responseData.put("new", new Boolean(anIsNew));\r
+\r
+\r
+      urlBuilder.setValue("module", getOperationModuleName());\r
+      urlBuilder.setValue("returnurl", requestParser.getParameter("returnurl"));\r
+      if (anIsNew)\r
+        urlBuilder.setValue("do", "add");\r
+      else {\r
+        urlBuilder.setValue("id", anId);\r
+        urlBuilder.setValue("do", "edit");\r
+      }\r
+      responseData.put("returnurl", requestParser.getParameter("returnurl"));\r
+      responseData.put("thisurl", urlBuilder.getQuery());\r
+\r
+      ServletHelper.generateResponse(aResponse.getWriter(), responseData, editGenerator);\r
+    }\r
+    catch (Throwable e) {\r
+      throw new ServletModuleFailure(e);\r
+    }\r
+  }\r
+\r
+\r
+  /**\r
+   * Generic add method\r
+   *\r
+   * @param aRequest\r
+   * @param aResponse\r
+   * @throws ServletModuleExc\r
+   * @throws ServletModuleUserExc\r
+   * @throws ServletModuleFailure\r
+   */\r
+  public void add(HttpServletRequest aRequest, HttpServletResponse aResponse)\r
+      throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure  {\r
+\r
+    Map object = new HashMap();\r
+\r
+    Iterator i = mainModule.getStorageObject().getFields().iterator();\r
+\r
+    while (i.hasNext())\r
+      object.put(i.next(), "");\r
+\r
+    initializeNewObject(object, aRequest, aResponse);\r
+\r
+    editObject(aRequest, aResponse, object, true, null);\r
+  }\r
+\r
+  protected void initializeNewObject(Map aNewObject, HttpServletRequest aRequest, HttpServletResponse aResponse) {\r
+  }\r
+\r
+  /**\r
+   * Method called when the user edits an object.\r
+   *\r
+   * @param aRequest\r
+   * @param aResponse\r
+   * @throws ServletModuleExc\r
+   * @throws ServletModuleUserExc\r
+   * @throws ServletModuleFailure\r
+   */\r
+  public void edit(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure  {\r
+    edit(aRequest, aResponse, aRequest.getParameter("id"));\r
+  }\r
+\r
+  /**\r
+   * Generic edit method\r
+   *\r
+   * @param aRequest\r
+   * @param aResponse\r
+   * @param anIdentifier\r
+   * @throws ServletModuleExc\r
+   * @throws ServletModuleUserExc\r
+   * @throws ServletModuleFailure\r
+   */\r
+  public void edit(HttpServletRequest aRequest, HttpServletResponse aResponse, String anIdentifier)\r
+      throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure  {\r
+    try {\r
+      editObject(aRequest, aResponse, model.makeEntityAdapter(definition, mainModule.getById(anIdentifier)), false, anIdentifier);\r
+    }\r
+    catch (Throwable e) {\r
+      throw new ServletModuleFailure(e);\r
+    }\r
+  }\r
+\r
+  /**\r
+   * Generic update method\r
+   *\r
+   * @param aRequest\r
+   * @param aResponse\r
+   * @throws ServletModuleExc\r
+   * @throws ServletModuleUserExc\r
+   * @throws ServletModuleFailure\r
+   */\r
+  public void update(HttpServletRequest aRequest, HttpServletResponse aResponse)\r
+      throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure  {\r
+    try {\r
+      HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);\r
+\r
+      String id = aRequest.getParameter("id");\r
+      Map withValues = getIntersectingValues(aRequest, mainModule.getStorageObject());\r
+      mainModule.set(withValues);\r
+\r
+      String returnUrl = requestParser.getParameter("returnurl");\r
+\r
+      if (returnUrl!=null) {\r
+        redirect(aResponse, returnUrl);\r
+      }\r
+      else {\r
+        edit(aRequest, aResponse, id);\r
+      }\r
+    }\r
+    catch (Throwable e) {\r
+      throw new ServletModuleFailure(e);\r
+    }\r
+  }\r
+\r
+  /**\r
+   * Generic insert method\r
+   *\r
+   * @param aRequest\r
+   * @param aResponse\r
+   * @throws ServletModuleExc\r
+   * @throws ServletModuleUserExc\r
+   * @throws ServletModuleFailure\r
+   */\r
+  public void insert(HttpServletRequest aRequest, HttpServletResponse aResponse)\r
+      throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure  {\r
+    try {\r
+      HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);\r
+\r
+      Map object = getIntersectingValues(aRequest, mainModule.getStorageObject());\r
+\r
+      String id = processInstertedObject(object, aRequest, aResponse);\r
+\r
+      String returnUrl = requestParser.getParameter("returnurl");\r
+\r
+      if (returnUrl!=null) {\r
+        redirect(aResponse, returnUrl);\r
+      }\r
+      else {\r
+        edit(aRequest, aResponse, id);\r
+      }\r
+    }\r
+    catch (Throwable e) {\r
+      throw new ServletModuleFailure(e);\r
+    }\r
+  }\r
+\r
+  public String processInstertedObject(Map anObject, HttpServletRequest aRequest, HttpServletResponse aResponse) {\r
+    try {\r
+      return mainModule.add(anObject);\r
+    }\r
+    catch (Throwable t) {\r
+      throw new ServletModuleFailure(t);\r
+    }\r
+  };\r
+\r
+  /**\r
+   *\r
+   * @param aRequest\r
+   * @param aResponse\r
+   */\r
+  public void confirmdelete(HttpServletRequest aRequest, HttpServletResponse aResponse) {\r
+    try {\r
+      String idParam = aRequest.getParameter("id");\r
+      String confirmParam = aRequest.getParameter("confirm");\r
+      String cancelParam = aRequest.getParameter("cancel");\r
+\r
+      if (confirmParam != null && !confirmParam.equals("")) {\r
+        mainModule.deleteById(idParam);\r
+        redirect(aResponse, aRequest.getParameter("okurl"));\r
+      }\r
+      else\r
+        redirect(aResponse, aRequest.getParameter("cancelurl"));\r
+    }\r
+    catch (Throwable t) {\r
+      throw new ServletModuleFailure(t);\r
+    }\r
+  }\r
+\r
+  /**\r
+   *\r
+   * @param aRequest\r
+   * @param aResponse\r
+   * @throws ServletModuleExc\r
+   * @throws ServletModuleUserExc\r
+   * @throws ServletModuleFailure\r
+   */\r
+  public void delete(HttpServletRequest aRequest, HttpServletResponse aResponse)\r
+      throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure  {\r
+    try {\r
+      String idParam = aRequest.getParameter("id");\r
+\r
+      if (idParam == null)\r
+        throw new ServletModuleExc("Invalid call to delete: no id supplied");\r
+\r
+      Map responseData = ServletHelper.makeGenerationData(aRequest, aResponse, new Locale[] { getLocale(aRequest), getFallbackLocale(aRequest)});\r
+\r
+      responseData.put("module", getOperationModuleName());\r
+      responseData.put("id", idParam);\r
+      responseData.put("cancelurl", aRequest.getParameter("cancelurl"));\r
+      responseData.put("okurl", aRequest.getParameter("okurl"));\r
+\r
+      ServletHelper.generateResponse(aResponse.getWriter(), responseData, deleteConfirmationGenerator);\r
+    }\r
+    catch (Throwable e) {\r
+      throw new ServletModuleFailure(e);\r
+    }\r
+  }\r
+\r
+  /**\r
+   *  Wenn die abgeleitete Klasse diese Methode ueberschreibt und einen String mit einem\r
+   *  Methodennamen zurueckliefert, dann wird diese Methode bei fehlender Angabe des\r
+   *  doParameters ausgefuehrt.\r
+   *\r
+   * @return Name der Default-Action\r
+   */\r
+  public String defaultAction() {\r
+    return defaultAction;\r
+  }\r
+\r
+  /**\r
+   * Gets the fields from a httprequest and matches them with the metadata from\r
+   * the storage object. Returns the keys that match, with their values.\r
+   *\r
+   * @return Map with the values\r
+   */\r
+  public Map getIntersectingValues(HttpServletRequest aRequest, StorageObject theStorage)\r
+      throws ServletModuleExc, ServletModuleFailure {\r
+\r
+    try {\r
+      HTTPRequestParser parser;\r
+      List theFieldList;\r
+\r
+      parser = new HTTPRequestParser(aRequest);\r
+\r
+      theFieldList = theStorage.getFields();\r
+\r
+      Map withValues = new HashMap();\r
+      String aField, aValue;\r
+\r
+      for (int i = 0; i < theFieldList.size(); i++) {\r
+        aField = (String) theFieldList.get(i);\r
+\r
+        aValue = parser.getParameter(aField);\r
+        if (aValue != null)\r
+          withValues.put(aField, aValue);\r
+      }\r
+      return withValues;\r
+    }\r
+    catch (Throwable e) {\r
+      e.printStackTrace(logger.asPrintWriter(LoggerWrapper.DEBUG_MESSAGE));\r
+\r
+      throw new ServletModuleFailure( "ServletModule.getIntersectingValues: " + e.getMessage(), e);\r
+    }\r
+  }\r
 }
\ No newline at end of file