1.1 restoration
[mir.git] / source / mir / servlet / ServletModule.java
index 265fb97..d2d89e8 100755 (executable)
-/*\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 the com.oreilly.servlet library, any library\r
- * licensed under the Apache Software License, The Sun (tm) Java Advanced\r
- * Imaging library (JAI), The Sun JIMI library (or with modified versions of\r
- * the above that use the same license as the above), and distribute linked\r
- * combinations including the two.  You must obey the GNU General Public\r
- * License in all respects for all of the code used other than the above\r
- * mentioned libraries.  If you modify this file, you may extend this exception\r
- * to your version of the file, but you are not obligated to do so.  If you do\r
- * not wish to do so, delete this exception statement from your version.\r
- */\r
-\r
-package mir.servlet;\r
-\r
-import java.io.IOException;\r
-import java.io.PrintWriter;\r
-import java.util.List;\r
-import java.util.Map;\r
-import java.util.HashMap;\r
-import java.util.Locale;\r
-\r
-import javax.servlet.http.HttpServletRequest;\r
-import javax.servlet.http.HttpServletResponse;\r
-import javax.servlet.http.HttpSession;\r
-\r
-import freemarker.template.SimpleHash;\r
-import freemarker.template.TemplateModelRoot;\r
-\r
-import mir.config.MirPropertiesConfiguration;\r
-import mir.config.MirPropertiesConfiguration.PropertiesConfigExc;\r
-import mir.entity.EntityList;\r
-import mir.log.LoggerWrapper;\r
-import mir.misc.HTMLParseException;\r
-import mir.misc.HTMLTemplateProcessor;\r
-import mir.misc.LineFilterWriter;\r
-import mir.module.AbstractModule;\r
-import mir.module.ModuleException;\r
-import mir.storage.StorageObject;\r
-import mir.util.*;\r
-\r
-\r
-\r
-\r
-/**\r
- * Abstract class ServletModule provides the base functionality for servlets.\r
- * Deriving a class from ServletModule enables class to insert/edit/update/delete\r
- * and list Entity from a Database via mainModule.\r
- *\r
- *\r
- *  Abstrakte Klasse ServletModule stellt die Basisfunktionalitaet der\r
- *  abgeleiteten ServletModule zur Verf?gung.\r
- *\r
- * @version 28.6.1999\r
- * @author RK\r
- */\r
-\r
-public abstract class ServletModule {\r
-\r
-  public String defaultAction;\r
-  protected LoggerWrapper logger;\r
-        protected MirPropertiesConfiguration configuration;\r
-  protected AbstractModule mainModule;\r
-  protected String templateListString;\r
-  protected String templateObjektString;\r
-  protected String templateConfirmString;\r
-\r
-\r
-  public ServletModule(){\r
-    try {\r
-      configuration = MirPropertiesConfiguration.instance();\r
-    }\r
-    catch (PropertiesConfigExc e) {\r
-      throw new RuntimeException("Can't get configuration: " + e.getMessage());\r
-    }\r
-  }\r
-\r
-\r
-  /**\r
-   * Singelton - Methode muss in den abgeleiteten Klassen ueberschrieben werden.\r
-   * @return ServletModule\r
-   */\r
-  public static ServletModule getInstance() {\r
-    return null;\r
-  }\r
-\r
-  /**\r
-   * get the module name to be used for generic operations like delete.\r
-   */\r
-  protected String getOperationModuleName() {\r
-    return getClass().getName().substring((new String("mircoders.servlet.ServletModule")).length());\r
-  }\r
-\r
-  /**\r
-   * get the session binded language\r
-   */\r
-  public String getLanguage(HttpServletRequest req) {\r
-    HttpSession session = req.getSession(false);\r
-    String language = (String) session.getAttribute("Language");\r
-    if (language == null) {\r
-      language = configuration.getString("StandardLanguage");\r
-    }\r
-    return language;\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 req) {\r
-    Locale loc = null;\r
-    HttpSession session = req.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 = req.getLocale();\r
-    }\r
-    return loc;\r
-  }\r
-\r
-  public void redirect(HttpServletResponse aResponse, String aQuery) throws ServletModuleException {\r
-    try {\r
-      aResponse.sendRedirect(MirPropertiesConfiguration.instance().getString("RootUri") + "/Mir?"+aQuery);\r
-    }\r
-    catch (Throwable t) {\r
-      throw new ServletModuleException(t.getMessage());\r
-    }\r
-  }\r
-\r
-  /**\r
-   *  list(req,res) - generische Listmethode. Wennn die Funktionalitaet\r
-   *  nicht reicht, muss sie in der abgeleiteten ServletModule-Klasse\r
-   *  ueberschreiben werden.\r
-   *\r
-   * @param req Http-Request, das vom Dispatcher durchgereicht wird\r
-   * @param res Http-Response, die vom Dispatcher durchgereicht wird\r
-   */\r
-  public void list(HttpServletRequest req, HttpServletResponse res)\r
-      throws ServletModuleException {\r
-    try {\r
-      EntityList theList;\r
-      String offsetParam = req.getParameter("offset");\r
-      int offset = 0;\r
-      PrintWriter out = res.getWriter();\r
-\r
-      // hier offsetcode bearbeiten\r
-      if (offsetParam != null && !offsetParam.equals("")) {\r
-        offset = Integer.parseInt(offsetParam);\r
-      }\r
-      if (req.getParameter("next") != null) {\r
-        offset = Integer.parseInt(req.getParameter("nextoffset"));\r
-      }\r
-      else {\r
-        if (req.getParameter("prev") != null) {\r
-          offset = Integer.parseInt(req.getParameter("prevoffset"));\r
-        }\r
-      }\r
-      theList = mainModule.getByWhereClause(null, offset);\r
-\r
-      HTMLTemplateProcessor.process(res, templateListString, theList, out, getLocale(req));\r
-    }\r
-    catch (Exception e) {\r
-      throw new ServletModuleException(e.getMessage());\r
-    }\r
-  }\r
-\r
-  /**\r
-   *  add(req,res) - generische Addmethode. Wennn die Funktionalitaet\r
-   *  nicht reicht, muss sie in der abgeleiteten ServletModule-Klasse\r
-   *  ueberschreiben werden.\r
-   * @param req Http-Request, das vom Dispatcher durchgereicht wird\r
-   * @param res Http-Response, die vom Dispatcher durchgereicht wird\r
-   */\r
-  public void add(HttpServletRequest req, HttpServletResponse res)\r
-      throws ServletModuleException, ServletModuleUserException {\r
-\r
-    try {\r
-      SimpleHash mergeData = new SimpleHash();\r
-      mergeData.put("new", "1");\r
-      deliver(req, res, mergeData, templateObjektString);\r
-    }\r
-    catch (Exception e) {\r
-      throw new ServletModuleException(e.getMessage());\r
-    }\r
-  }\r
-\r
-  /**\r
-   *  insert(req,res) - generische Insertmethode, folgt auf add.\r
-   *  Wennn die Funktionalitaet\r
-   *  nicht reicht, muss sie in der abgeleiteten ServletModule-Klasse\r
-   *  ueberschreiben werden.\r
-   *\r
-   * @param req Http-Request, das vom Dispatcher durchgereicht wird\r
-   * @param res Http-Response, die vom Dispatcher durchgereicht wird\r
-   */\r
-  public void insert(HttpServletRequest req, HttpServletResponse res)\r
-      throws ServletModuleException, ServletModuleUserException {\r
-    try {\r
-      Map withValues = getIntersectingValues(req, mainModule.getStorageObject());\r
-      logger.debug("--trying to add...");\r
-      String id = mainModule.add(withValues);\r
-      logger.debug("--trying to deliver..." + id);\r
-      list(req, res);\r
-    }\r
-    catch (Exception e) {\r
-      throw new ServletModuleException(e.getMessage());\r
-    }\r
-  }\r
-\r
-  /**\r
-   *  delete(req,res) - generic delete method. Can be overridden in subclasses.\r
-   *\r
-   */\r
-\r
-  public void delete(HttpServletRequest req, HttpServletResponse res) throws ServletModuleException, ServletModuleUserException {\r
-    try {\r
-      String idParam = req.getParameter("id");\r
-\r
-      if (idParam == null)\r
-        throw new ServletModuleException("Invalid call to delete: no id supplied");\r
-\r
-      String confirmParam = req.getParameter("confirm");\r
-      String cancelParam = req.getParameter("cancel");\r
-      if (confirmParam == null && cancelParam == null) {\r
-        SimpleHash mergeData = new SimpleHash();\r
-\r
-        mergeData.put("module", getOperationModuleName());\r
-        mergeData.put("infoString", getOperationModuleName() + ": " + idParam);\r
-        mergeData.put("id", idParam);\r
-        mergeData.put("where", req.getParameter("where"));\r
-        mergeData.put("order", req.getParameter("order"));\r
-        mergeData.put("offset", req.getParameter("offset"));\r
-        // this stuff is to be compatible with the other more advanced\r
-        // search method used for media and comments\r
-        mergeData.put("query_media_folder", req.getParameter("query_media_folder"));\r
-        mergeData.put("query_is_published", req.getParameter("query_is_published"));\r
-        mergeData.put("query_text", req.getParameter("query_text"));\r
-        mergeData.put("query_field", req.getParameter("query_field"));\r
-\r
-        deliver(req, res, mergeData, templateConfirmString);\r
-      }\r
-      else {\r
-        if (confirmParam != null && !confirmParam.equals("")) {\r
-          //theLog.printInfo("delete confirmed!");\r
-          mainModule.deleteById(idParam);\r
-          list(req, res); // back to list\r
-        }\r
-        else {\r
-          if (req.getParameter("where") != null)\r
-            list(req, res);\r
-          else\r
-            edit(req, res);\r
-        }\r
-      }\r
-    }\r
-    catch (Exception e) {\r
-      throw new ServletModuleException(e.getMessage());\r
-    }\r
-  }\r
-\r
-  /**\r
-   *  edit(req,res) - generische Editmethode. Wennn die Funktionalitaet\r
-   *  nicht reicht, muss sie in der abgeleiteten ServletModule-Klasse\r
-   *  ueberschreiben werden.\r
-   *\r
-   * @param req Http-Request, das vom Dispatcher durchgereicht wird\r
-   * @param res Http-Response, die vom Dispatcher durchgereicht wird\r
-   */\r
-  public void edit(HttpServletRequest req, HttpServletResponse res)\r
-      throws ServletModuleException, ServletModuleUserException {\r
-    edit(req, res, req.getParameter("id"));\r
-  }\r
-\r
-  /**\r
-   *  edit(req,res) - generische Editmethode. Wennn die Funktionalitaet\r
-   *  nicht reicht, muss sie in der abgeleiteten ServletModule-Klasse\r
-   *  ueberschreiben werden.\r
-   *\r
-   * @param req Http-Request, das vom Dispatcher durchgereicht wird\r
-   * @param res Http-Response, die vom Dispatcher durchgereicht wird\r
-   */\r
-  public void edit(HttpServletRequest aRequest, HttpServletResponse aResponse, String anIdentifier)\r
-      throws ServletModuleException, ServletModuleUserException {\r
-    try {\r
-      deliver(aRequest, aResponse, mainModule.getById(anIdentifier), templateObjektString);\r
-    }\r
-    catch (ModuleException e) {\r
-      throw new ServletModuleException(e.getMessage());\r
-    }\r
-  }\r
-\r
-  /**\r
-   *  update(req,res) - generische Updatemethode. Wennn die Funktionalitaet\r
-   *  nicht reicht, muss sie in der abgeleiteten ServletModule-Klasse\r
-   *  ueberschreiben werden.\r
-   *\r
-   * @param req Http-Request, das vom Dispatcher durchgereicht wird\r
-   * @param res Http-Response, die vom Dispatcher durchgereicht wird\r
-   */\r
-\r
-  public void update(HttpServletRequest req, HttpServletResponse res)\r
-      throws ServletModuleException, ServletModuleUserException {\r
-    try {\r
-      String idParam = req.getParameter("id");\r
-      Map withValues = getIntersectingValues(req, mainModule.getStorageObject());\r
-\r
-      String id = mainModule.set(withValues);\r
-      String whereParam = req.getParameter("where");\r
-      String orderParam = req.getParameter("order");\r
-\r
-      if ((whereParam != null && !whereParam.equals("")) || (orderParam != null && !orderParam.equals(""))) {\r
-        list(req, res);\r
-      }\r
-      else {\r
-        edit(req, res);\r
-      }\r
-    }\r
-    catch (Exception e) {\r
-      throw new ServletModuleException(e.getMessage());\r
-    }\r
-  }\r
-\r
-  /**\r
-   * deliver liefert das Template mit dem Filenamen templateFilename\r
-   * an den HttpServletResponse res aus, nachdem es mit den Daten aus\r
-   * TemplateModelRoot rtm gemischt wurde\r
-   *\r
-   * @param res Http-Response, die vom Dispatcher durchgereicht wird\r
-   * @param rtm beinahalten das freemarker.template.TempalteModelRoot mit den\r
-   *   Daten, die ins Template gemerged werden sollen.\r
-   * @param tmpl Name des Templates\r
-   * @exception ServletModuleException\r
-   */\r
-  public void deliver(HttpServletRequest req, HttpServletResponse res,\r
-                      TemplateModelRoot rtm, TemplateModelRoot popups,\r
-                      String templateFilename)\r
-      throws ServletModuleException {\r
-    if (rtm == null) rtm = new SimpleHash();\r
-    try {\r
-      PrintWriter out = res.getWriter();\r
-      HTMLTemplateProcessor.process(res, templateFilename, rtm, popups, out, getLocale(req));\r
-\r
-      // we default to admin bundles here, which is not exactly beautiful...\r
-      // but this whole producer stuff is going to be rewritten soon.\r
-      // ServletModuleOpenIndy overwrites deliver() to use open bundles\r
-      // (br1)\r
-      out.close();\r
-    }\r
-    catch (HTMLParseException e) {\r
-      throw new ServletModuleException(e.getMessage());\r
-    } catch (IOException e) {\r
-      throw new ServletModuleException(e.getMessage());\r
-    }\r
-  }\r
-\r
-\r
-  /**\r
-   * deliver liefert das Template mit dem Filenamen templateFilename\r
-   * an den HttpServletResponse res aus, nachdem es mit den Daten aus\r
-   * TemplateModelRoot rtm gemischt wurde\r
-   *\r
-   * @param res Http-Response, die vom Dispatcher durchgereicht wird\r
-   * @param rtm beinahalten das freemarker.template.TempalteModelRoot mit den\r
-   *   Daten, die ins Template gemerged werden sollen.\r
-   * @param tmpl Name des Templates\r
-   * @exception ServletModuleException\r
-   */\r
-  public void deliver(HttpServletRequest req, HttpServletResponse res,\r
-                      TemplateModelRoot rtm, String templateFilename)\r
-      throws ServletModuleException {\r
-    deliver(req, res, rtm, null, templateFilename);\r
-  }\r
-\r
-  /**\r
-   * deliver liefert das Template mit dem Filenamen templateFilename\r
-   * an den HttpServletResponse res aus, nachdem es mit den Daten aus\r
-   * TemplateModelRoot rtm gemischt wurde\r
-   *\r
-   * @param res Http-Response, die vom Dispatcher durchgereicht wird\r
-   * @param rtm beinahalten das freemarker.template.TempalteModelRoot mit den\r
-   *   Daten, die ins Template gemerged werden sollen.\r
-   * @param tmpl Name des Templates\r
-   * @exception ServletModuleException\r
-   */\r
-  public void deliver_compressed(HttpServletRequest req, HttpServletResponse res,\r
-                                 TemplateModelRoot rtm, String templateFilename)\r
-      throws ServletModuleException {\r
-    if (rtm == null) rtm = new SimpleHash();\r
-    try {\r
-      PrintWriter out = new LineFilterWriter(res.getWriter());\r
-      //PrintWriter out =  res.getWriter();\r
-      HTMLTemplateProcessor.process(res, templateFilename, rtm, out, getLocale(req));\r
-      out.close();\r
-    }\r
-    catch (HTMLParseException e) {\r
-      throw new ServletModuleException(e.getMessage());\r
-    }\r
-    catch (IOException e) {\r
-      throw new ServletModuleException(e.getMessage());\r
-    }\r
-  }\r
-\r
-  /**\r
-   * deliver liefert das Template mit dem Filenamen templateFilename\r
-   * an den HttpServletResponse res aus, nachdem es mit den Daten aus\r
-   * TemplateModelRoot rtm gemischt wurde\r
-   *\r
-   * @param out ist der OutputStream, in den die gergten Daten geschickt werden sollen.\r
-   * @param rtm beinahalten das freemarker.template.TempalteModelRoot mit den\r
-   *   Daten, die ins Template gemerged werden sollen.\r
-   * @param tmpl Name des Templates\r
-   * @exception ServletModuleException\r
-   */\r
-  private void deliver(HttpServletResponse res, HttpServletRequest req, PrintWriter out,\r
-                       TemplateModelRoot rtm, String templateFilename)\r
-      throws HTMLParseException {\r
-    HTMLTemplateProcessor.process(res, templateFilename, rtm, out, getLocale(req));\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
-   *  Hier kann vor der Datenaufbereitung schon mal ein response geschickt\r
-   *  werden (um das subjektive Antwortverhalten bei langsamen Verbindungen\r
-   *  zu verbessern).\r
-   */\r
-  public void predeliver(HttpServletRequest req, HttpServletResponse res) {\r
-    ;\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 req, StorageObject theStorage)\r
-      throws ServletModuleException {\r
-\r
-    try {\r
-      HTTPRequestParser parser;\r
-      List theFieldList;\r
-\r
-      logger.debug("using charset: " + req.getParameter("charset"));\r
-      logger.debug("using method: " + req.getParameter("do"));\r
-      if (req.getParameter("charset") != null) {\r
-        parser = new HTTPRequestParser(req, req.getParameter("charset"));\r
-        logger.debug("using charset: " + req.getParameter("charset"));\r
-        logger.debug("original charset: " + req.getCharacterEncoding());\r
-      }\r
-      else {\r
-        parser = new HTTPRequestParser(req);\r
-      }\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
-        logger.debug("field " + aField + " = " + parser.getParameter(aField));\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
-      throw new ServletModuleException(\r
-          "ServletModule.getIntersectingValues: " + e.getMessage());\r
-    }\r
-  }\r
-\r
-}\r
+/*
+ * 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.util.HashMap;
+import java.util.Iterator;
+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.entity.adapter.EntityAdapterEngine;
+import mir.entity.adapter.EntityAdapterModel;
+import mir.log.LoggerWrapper;
+import mir.module.AbstractModule;
+import mir.module.ModuleExc;
+import mir.storage.StorageObject;
+import mir.util.HTTPRequestParser;
+import mir.util.URLBuilder;
+import mircoders.global.MirGlobal;
+import mircoders.servlet.ServletHelper;
+import mircoders.localizer.MirLocalizerExc;
+import multex.Failure;
+
+/**
+ *
+ * <p>Title: </p>
+ * <p>Description: </p>
+ * <p>Copyright: Copyright (c) 2003</p>
+ * <p>Company: </p>
+ * @author not attributable
+ * @version 1.0
+ */
+
+public abstract class ServletModule {
+  public String defaultAction;
+  protected LoggerWrapper logger;
+  protected static MirPropertiesConfiguration configuration = MirPropertiesConfiguration.instance();
+  private static Locale fallbackLocale = new Locale(configuration.getString("Mir.Admin.FallbackLanguage", "en"), "");
+
+  protected AbstractModule mainModule;
+  protected String definition;
+  protected EntityAdapterModel model;
+
+  protected String listGenerator;
+  protected String editGenerator;
+  protected String deleteConfirmationGenerator;
+  protected int nrEntitiesPerListPage;
+
+
+  public ServletModule(){
+    definition = null;
+    try {
+      model = MirGlobal.localizer().dataModel().adapterModel();
+    }
+    catch (MirLocalizerExc e) {
+      logger.error("Can't create model: " + e.toString());
+      throw new ServletModuleFailure("Can't retrieve model", e);
+    }
+
+
+
+    listGenerator = configuration.getString("ServletModule."+getOperationModuleName()+".ListTemplate");
+    editGenerator = configuration.getString("ServletModule."+getOperationModuleName()+".EditTemplate");
+    deleteConfirmationGenerator = configuration.getString("ServletModule."+getOperationModuleName()+".DeleteConfirmationTemplate");
+    nrEntitiesPerListPage =
+        configuration.getInt("ServletModule."+getOperationModuleName()+".ListSize",
+        configuration.getInt("ServletModule.Default.ListSize", 20));
+
+  }
+
+
+  public void logAdminUsage(HttpServletRequest aRequest, String anObject, String aDescription) {
+    MirGlobal.logAdminUsage(ServletHelper.getUser(aRequest), getOperationModuleName() + ":" + anObject, aDescription);
+  }
+
+  /**
+   * Singleton instance retrievel method. MUST be overridden in subclasses.
+   *
+   * @return ServletModule the single instance of the servletmodule class
+   */
+  public static ServletModule getInstance() {
+    return null;
+  }
+
+  /**
+   * Return the module name
+   */
+  protected String getOperationModuleName() {
+    return getClass().getName().substring((new String("mircoders.servlet.ServletModule")).length());
+  }
+
+  public static Locale[] getLocales(HttpServletRequest aRequest) {
+    return new Locale[] { getLocale(aRequest), fallbackLocale };
+  }
+
+  /**
+   * Return the locale either from the session or the accept-language header ot the request
+   * this supersedes getLanguage for the new i18n
+   */
+  public static Locale getLocale(HttpServletRequest aRequest) {
+    Locale loc = null;
+    HttpSession session = aRequest.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 = aRequest.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 aRequest) {
+    return fallbackLocale;
+  }
+
+  /**
+   * Function to specify the default ordering for lists. May be overridden.
+   *
+   *
+   * @return
+   */
+  public String getDefaultListOrdering() {
+
+    if (mainModule!=null && mainModule.getStorageObject()!=null){
+      if (mainModule.getStorageObject().getFieldNames().contains("webdb_create"))
+        return "webdb_create desc";
+    }
+
+    return "id asc";
+  }
+
+  /**
+   * Generic list servlet method
+   */
+
+  public void list(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc
+  {
+    HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);
+
+    String where = requestParser.getParameter("where");
+    String order = requestParser.getParameterWithDefault("order", getDefaultListOrdering());
+    int offset = requestParser.getIntegerWithDefault("offset", 0);
+
+    returnList(aRequest, aResponse, where, order, offset);
+  }
+
+
+  public void returnList(HttpServletRequest aRequest, HttpServletResponse aResponse,
+     String aWhereClause, String anOrderByClause, int anOffset) throws ServletModuleExc {
+
+    HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);
+    URLBuilder urlBuilder = new URLBuilder();
+    int count;
+
+    try {
+      Map responseData = ServletHelper.makeGenerationData(aRequest, aResponse, getLocales(aRequest));
+
+      List list =
+         EntityAdapterEngine.retrieveAdapterList(model, definition, aWhereClause, anOrderByClause, nrEntitiesPerListPage, anOffset);
+
+      responseData.put("nexturl", null);
+      responseData.put("prevurl", null);
+      responseData.put("module", getOperationModuleName());
+
+      count=mainModule.getSize(aWhereClause);
+
+      urlBuilder.setValue("module", getOperationModuleName());
+      urlBuilder.setValue("do", "list");
+      urlBuilder.setValue("where", aWhereClause);
+      urlBuilder.setValue("order", anOrderByClause);
+
+      urlBuilder.setValue("searchfield", requestParser.getParameter("searchfield"));
+      urlBuilder.setValue("searchtext", requestParser.getParameter("searchtext"));
+      urlBuilder.setValue("searchispublished", requestParser.getParameter("searchispublished"));
+      urlBuilder.setValue("searchstatus", requestParser.getParameter("searchstatus"));
+      urlBuilder.setValue("searchorder", requestParser.getParameter("searchorder"));
+
+      responseData.put("searchfield", requestParser.getParameter("searchfield"));
+      responseData.put("searchtext", requestParser.getParameter("searchtext"));
+      responseData.put("searchispublished", requestParser.getParameter("searchispublished"));
+      responseData.put("searchstatus", requestParser.getParameter("searchstatus"));
+      responseData.put("searchorder", requestParser.getParameter("searchorder"));
+
+      urlBuilder.setValue("offset", anOffset);
+      responseData.put("offset" , new Integer(anOffset).toString());
+      responseData.put("thisurl" , urlBuilder.getQuery());
+
+      if (count>anOffset+nrEntitiesPerListPage) {
+        urlBuilder.setValue("offset", anOffset + nrEntitiesPerListPage);
+        responseData.put("nexturl" , urlBuilder.getQuery());
+      }
+
+      if (anOffset>0) {
+        urlBuilder.setValue("offset", Math.max(anOffset - nrEntitiesPerListPage, 0));
+        responseData.put("prevurl" , urlBuilder.getQuery());
+      }
+
+      responseData.put("entities", list);
+      responseData.put("from" , Integer.toString(anOffset+1));
+      responseData.put("count", Integer.toString(count));
+      responseData.put("to", Integer.toString(Math.min(anOffset+nrEntitiesPerListPage, count)));
+
+      ServletHelper.generateResponse(aResponse.getWriter(), responseData, listGenerator);
+    }
+    catch (Throwable e) {
+      throw new ServletModuleFailure(e);
+    }
+  }
+
+  public void editObject(HttpServletRequest aRequest, HttpServletResponse aResponse, String anId) throws ServletModuleExc {
+    try {
+      editObject(aRequest, aResponse, model.makeEntityAdapter(definition, mainModule.getById(anId)), false, anId);
+    }
+    catch (Throwable t) {
+      throw new ServletModuleFailure(t);
+    }
+  }
+
+  public void editObject(HttpServletRequest aRequest, HttpServletResponse aResponse, Object anObject, boolean anIsNew, String anId) throws ServletModuleExc {
+    HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);
+    URLBuilder urlBuilder = new URLBuilder();
+
+    try {
+      Map responseData = ServletHelper.makeGenerationData(aRequest, aResponse, getLocales(aRequest));
+
+      responseData.put("module", getOperationModuleName());
+      responseData.put("entity", anObject);
+      responseData.put("new", new Boolean(anIsNew));
+
+
+      urlBuilder.setValue("module", getOperationModuleName());
+      urlBuilder.setValue("returnurl", requestParser.getParameter("returnurl"));
+      if (anIsNew)
+        urlBuilder.setValue("do", "add");
+      else {
+        urlBuilder.setValue("id", anId);
+        urlBuilder.setValue("do", "edit");
+      }
+      responseData.put("returnurl", requestParser.getParameter("returnurl"));
+      responseData.put("thisurl", urlBuilder.getQuery());
+
+      ServletHelper.generateResponse(aResponse.getWriter(), responseData, editGenerator);
+    }
+    catch (Throwable e) {
+      throw new ServletModuleFailure(e);
+    }
+  }
+
+  /**
+   * Generic add servlet method
+   */
+  public void add(HttpServletRequest aRequest, HttpServletResponse aResponse)
+      throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure  {
+
+    Map object = new HashMap();
+
+    Iterator i = mainModule.getStorageObject().getFieldNames().iterator();
+
+    while (i.hasNext())
+      object.put(i.next(), "");
+
+    initializeNewObject(object, aRequest, aResponse);
+
+    editObject(aRequest, aResponse, object, true, null);
+  }
+
+  protected void initializeNewObject(Map aNewObject, HttpServletRequest aRequest, HttpServletResponse aResponse) {
+  }
+
+  /**
+   * Generic edit servlet method
+   */
+  public void edit(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure  {
+    edit(aRequest, aResponse, aRequest.getParameter("id"));
+  }
+
+  /**
+   */
+  public void edit(HttpServletRequest aRequest, HttpServletResponse aResponse, String anIdentifier)
+      throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure  {
+    try {
+      editObject(aRequest, aResponse, model.makeEntityAdapter(definition, mainModule.getById(anIdentifier)), false, anIdentifier);
+    }
+    catch (Throwable e) {
+      throw new ServletModuleFailure(e);
+    }
+  }
+
+  /**
+   * Generic update servlet method
+   */
+  public void update(HttpServletRequest aRequest, HttpServletResponse aResponse)
+      throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure  {
+    try {
+      HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);
+
+      String id = aRequest.getParameter("id");
+      Map withValues = getIntersectingValues(aRequest, mainModule.getStorageObject());
+      mainModule.set(withValues);
+
+      logAdminUsage(aRequest, id, "object modified");
+
+      String returnUrl = requestParser.getParameter("returnurl");
+
+      if (returnUrl!=null) {
+        ServletHelper.redirect(aResponse, returnUrl);
+      }
+      else {
+        edit(aRequest, aResponse, id);
+      }
+    }
+    catch (Throwable e) {
+      throw new ServletModuleFailure(e);
+    }
+  }
+
+  /**
+   * Generic insert servlet method
+   */
+  public void insert(HttpServletRequest aRequest, HttpServletResponse aResponse)
+      throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure  {
+    try {
+      HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);
+
+      Map object = getIntersectingValues(aRequest, mainModule.getStorageObject());
+
+      String id = processInstertedObject(object, aRequest, aResponse);
+
+      logAdminUsage(aRequest, id, "object inserted");
+
+      String returnUrl = requestParser.getParameter("returnurl");
+
+      if (returnUrl!=null) {
+        ServletHelper.redirect(aResponse, returnUrl);
+      }
+      else {
+        edit(aRequest, aResponse, id);
+      }
+    }
+    catch (Throwable e) {
+      throw new ServletModuleFailure(e);
+    }
+  }
+
+  /**
+   *
+   */
+  public String processInstertedObject(Map anObject, HttpServletRequest aRequest, HttpServletResponse aResponse) {
+    try {
+      return mainModule.add(anObject);
+    }
+    catch (ModuleExc t) {
+      throw new ServletModuleFailure(t);
+    }
+  };
+
+  /**
+   * Generic delete confirmation servlet method
+   */
+  public void confirmdelete(HttpServletRequest aRequest, HttpServletResponse aResponse) {
+    try {
+      String idParam = aRequest.getParameter("id");
+      String confirmParam = aRequest.getParameter("confirm");
+
+      if (confirmParam != null && !confirmParam.equals("")) {
+        mainModule.deleteById(idParam);
+        logAdminUsage(aRequest, idParam, "object deleted");
+        ServletHelper.redirect(aResponse, aRequest.getParameter("okurl"));
+      }
+      else
+        ServletHelper.redirect(aResponse, aRequest.getParameter("cancelurl"));
+    }
+    catch (Throwable t) {
+      throw new ServletModuleFailure(t);
+    }
+  }
+
+  /**
+   * Generic delete servlet method
+   */
+  public void delete(HttpServletRequest aRequest, HttpServletResponse aResponse)
+      throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure  {
+    try {
+      String idParam = aRequest.getParameter("id");
+
+      if (idParam == null)
+        throw new ServletModuleExc("Invalid call to delete: no id supplied");
+
+      Map responseData = ServletHelper.makeGenerationData(aRequest, aResponse, getLocales(aRequest));
+
+      responseData.put("module", getOperationModuleName());
+      responseData.put("id", idParam);
+      responseData.put("cancelurl", aRequest.getParameter("cancelurl"));
+      responseData.put("okurl", aRequest.getParameter("okurl"));
+
+      ServletHelper.generateResponse(aResponse.getWriter(), responseData, deleteConfirmationGenerator);
+    }
+    catch (Throwable e) {
+      throw new ServletModuleFailure(e);
+    }
+  }
+
+  /**
+   */
+  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 aRequest, StorageObject theStorage)
+      throws ServletModuleExc, ServletModuleFailure {
+
+    HTTPRequestParser parser;
+    List theFieldList;
+
+    parser = new HTTPRequestParser(aRequest);
+
+    theFieldList = theStorage.getFieldNames();
+
+    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;
+  }
+}
\ No newline at end of file