2 * Copyright (C) 2001, 2002 The Mir-coders group
\r
4 * This file is part of Mir.
\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
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
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
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
32 package mir.servlet;
\r
34 import java.io.IOException;
\r
35 import java.io.PrintWriter;
\r
36 import java.util.ArrayList;
\r
37 import java.util.HashMap;
\r
38 import java.util.Locale;
\r
40 import javax.servlet.http.HttpServletRequest;
\r
41 import javax.servlet.http.HttpServletResponse;
\r
42 import javax.servlet.http.HttpSession;
\r
44 import freemarker.template.SimpleHash;
\r
45 import freemarker.template.TemplateModelRoot;
\r
47 import mir.config.MirPropertiesConfiguration;
\r
48 import mir.config.MirPropertiesConfiguration.PropertiesConfigExc;
\r
49 import mir.entity.EntityList;
\r
50 import mir.log.LoggerWrapper;
\r
51 import mir.misc.HTMLParseException;
\r
52 import mir.misc.HTMLTemplateProcessor;
\r
53 import mir.misc.LineFilterWriter;
\r
54 import mir.module.AbstractModule;
\r
55 import mir.module.ModuleException;
\r
56 import mir.storage.StorageObject;
\r
57 import mir.storage.StorageObjectFailure;
\r
65 * Abstract class ServletModule provides the base functionality for servlets.
\r
66 * Deriving a class from ServletModule enables class to insert/edit/update/delete
\r
67 * and list Entity from a Database via mainModule.
\r
70 * Abstrakte Klasse ServletModule stellt die Basisfunktionalitaet der
\r
71 * abgeleiteten ServletModule zur Verf?gung.
\r
73 * @version 28.6.1999
\r
77 public abstract class ServletModule {
\r
79 public String defaultAction;
\r
80 protected LoggerWrapper logger;
\r
81 protected MirPropertiesConfiguration configuration;
\r
82 protected AbstractModule mainModule;
\r
83 protected String templateListString;
\r
84 protected String templateObjektString;
\r
85 protected String templateConfirmString;
\r
88 public ServletModule(){
\r
90 configuration = MirPropertiesConfiguration.instance();
\r
91 } catch (PropertiesConfigExc e) {
\r
92 e.printStackTrace(System.err);
\r
98 * Singelton - Methode muss in den abgeleiteten Klassen ueberschrieben werden.
\r
99 * @return ServletModule
\r
101 public static ServletModule getInstance() {
\r
106 * get the module name to be used for generic operations like delete.
\r
108 protected String getOperationModuleName() {
\r
109 return getClass().getName().substring((new String("mircoders.servlet.ServletModule")).length());
\r
113 * get the session binded language
\r
115 public String getLanguage(HttpServletRequest req) {
\r
116 HttpSession session = req.getSession(false);
\r
117 String language = (String) session.getAttribute("Language");
\r
118 if (language == null) {
\r
119 language = configuration.getString("StandardLanguage");
\r
125 * get the locale either from the session or the accept-language header ot the request
\r
126 * this supersedes getLanguage for the new i18n
\r
128 public Locale getLocale(HttpServletRequest req) {
\r
130 HttpSession session = req.getSession(false);
\r
131 if (session != null) {
\r
132 // session can be null in case of logout
\r
133 loc = (Locale) session.getAttribute("Locale");
\r
135 // if there is nothing in the session get it fron the accept-language
\r
137 loc = req.getLocale();
\r
142 public void redirect(HttpServletResponse aResponse, String aQuery) throws ServletModuleException {
\r
144 aResponse.sendRedirect(MirPropertiesConfiguration.instance().getString("RootUri") + "/Mir?"+aQuery);
\r
146 catch (Throwable t) {
\r
147 throw new ServletModuleException(t.getMessage());
\r
152 * list(req,res) - generische Listmethode. Wennn die Funktionalitaet
\r
153 * nicht reicht, muss sie in der abgeleiteten ServletModule-Klasse
\r
154 * ueberschreiben werden.
\r
156 * @param req Http-Request, das vom Dispatcher durchgereicht wird
\r
157 * @param res Http-Response, die vom Dispatcher durchgereicht wird
\r
159 public void list(HttpServletRequest req, HttpServletResponse res)
\r
160 throws ServletModuleException {
\r
162 EntityList theList;
\r
163 String offsetParam = req.getParameter("offset");
\r
165 PrintWriter out = res.getWriter();
\r
167 // hier offsetcode bearbeiten
\r
168 if (offsetParam != null && !offsetParam.equals("")) {
\r
169 offset = Integer.parseInt(offsetParam);
\r
171 if (req.getParameter("next") != null) {
\r
172 offset = Integer.parseInt(req.getParameter("nextoffset"));
\r
175 if (req.getParameter("prev") != null) {
\r
176 offset = Integer.parseInt(req.getParameter("prevoffset"));
\r
179 theList = mainModule.getByWhereClause(null, offset);
\r
181 HTMLTemplateProcessor.process(res, templateListString, theList, out, getLocale(req));
\r
183 catch (Exception e) {
\r
184 throw new ServletModuleException(e.getMessage());
\r
189 * add(req,res) - generische Addmethode. Wennn die Funktionalitaet
\r
190 * nicht reicht, muss sie in der abgeleiteten ServletModule-Klasse
\r
191 * ueberschreiben werden.
\r
192 * @param req Http-Request, das vom Dispatcher durchgereicht wird
\r
193 * @param res Http-Response, die vom Dispatcher durchgereicht wird
\r
195 public void add(HttpServletRequest req, HttpServletResponse res)
\r
196 throws ServletModuleException {
\r
199 SimpleHash mergeData = new SimpleHash();
\r
200 mergeData.put("new", "1");
\r
201 deliver(req, res, mergeData, templateObjektString);
\r
203 catch (Exception e) {
\r
204 throw new ServletModuleException(e.getMessage());
\r
209 * insert(req,res) - generische Insertmethode, folgt auf add.
\r
210 * Wennn die Funktionalitaet
\r
211 * nicht reicht, muss sie in der abgeleiteten ServletModule-Klasse
\r
212 * ueberschreiben werden.
\r
214 * @param req Http-Request, das vom Dispatcher durchgereicht wird
\r
215 * @param res Http-Response, die vom Dispatcher durchgereicht wird
\r
217 public void insert(HttpServletRequest req, HttpServletResponse res)
\r
218 throws ServletModuleException, ServletModuleUserException {
\r
220 HashMap withValues = getIntersectingValues(req, mainModule.getStorageObject());
\r
221 logger.debug("--trying to add...");
\r
222 String id = mainModule.add(withValues);
\r
223 logger.debug("--trying to deliver..." + id);
\r
226 catch (Exception e) {
\r
227 throw new ServletModuleException(e.getMessage());
\r
232 * delete(req,res) - generic delete method. Can be overridden in subclasses.
\r
236 public void delete(HttpServletRequest req, HttpServletResponse res) throws ServletModuleException {
\r
238 String idParam = req.getParameter("id");
\r
240 if (idParam == null)
\r
241 throw new ServletModuleException("Invalid call to delete: no id supplied");
\r
243 String confirmParam = req.getParameter("confirm");
\r
244 String cancelParam = req.getParameter("cancel");
\r
245 if (confirmParam == null && cancelParam == null) {
\r
246 SimpleHash mergeData = new SimpleHash();
\r
248 mergeData.put("module", getOperationModuleName());
\r
249 mergeData.put("infoString", getOperationModuleName() + ": " + idParam);
\r
250 mergeData.put("id", idParam);
\r
251 mergeData.put("where", req.getParameter("where"));
\r
252 mergeData.put("order", req.getParameter("order"));
\r
253 mergeData.put("offset", req.getParameter("offset"));
\r
254 // this stuff is to be compatible with the other more advanced
\r
255 // search method used for media and comments
\r
256 mergeData.put("query_media_folder", req.getParameter("query_media_folder"));
\r
257 mergeData.put("query_is_published", req.getParameter("query_is_published"));
\r
258 mergeData.put("query_text", req.getParameter("query_text"));
\r
259 mergeData.put("query_field", req.getParameter("query_field"));
\r
261 deliver(req, res, mergeData, templateConfirmString);
\r
264 if (confirmParam != null && !confirmParam.equals("")) {
\r
265 //theLog.printInfo("delete confirmed!");
\r
266 mainModule.deleteById(idParam);
\r
267 list(req, res); // back to list
\r
270 if (req.getParameter("where") != null)
\r
277 catch (Exception e) {
\r
278 throw new ServletModuleException(e.getMessage());
\r
283 * edit(req,res) - generische Editmethode. Wennn die Funktionalitaet
\r
284 * nicht reicht, muss sie in der abgeleiteten ServletModule-Klasse
\r
285 * ueberschreiben werden.
\r
287 * @param req Http-Request, das vom Dispatcher durchgereicht wird
\r
288 * @param res Http-Response, die vom Dispatcher durchgereicht wird
\r
290 public void edit(HttpServletRequest req, HttpServletResponse res)
\r
291 throws ServletModuleException {
\r
293 String idParam = req.getParameter("id");
\r
294 deliver(req, res, mainModule.getById(idParam), templateObjektString);
\r
296 catch (ModuleException e) {
\r
297 throw new ServletModuleException(e.getMessage());
\r
302 * update(req,res) - generische Updatemethode. Wennn die Funktionalitaet
\r
303 * nicht reicht, muss sie in der abgeleiteten ServletModule-Klasse
\r
304 * ueberschreiben werden.
\r
306 * @param req Http-Request, das vom Dispatcher durchgereicht wird
\r
307 * @param res Http-Response, die vom Dispatcher durchgereicht wird
\r
310 public void update(HttpServletRequest req, HttpServletResponse res)
\r
311 throws ServletModuleException {
\r
313 String idParam = req.getParameter("id");
\r
314 HashMap withValues = getIntersectingValues(req, mainModule.getStorageObject());
\r
316 String id = mainModule.set(withValues);
\r
317 String whereParam = req.getParameter("where");
\r
318 String orderParam = req.getParameter("order");
\r
320 if ((whereParam != null && !whereParam.equals("")) || (orderParam != null && !orderParam.equals(""))) {
\r
327 catch (Exception e) {
\r
328 throw new ServletModuleException(e.getMessage());
\r
333 * deliver liefert das Template mit dem Filenamen templateFilename
\r
334 * an den HttpServletResponse res aus, nachdem es mit den Daten aus
\r
335 * TemplateModelRoot rtm gemischt wurde
\r
337 * @param res Http-Response, die vom Dispatcher durchgereicht wird
\r
338 * @param rtm beinahalten das freemarker.template.TempalteModelRoot mit den
\r
339 * Daten, die ins Template gemerged werden sollen.
\r
340 * @param tmpl Name des Templates
\r
341 * @exception ServletModuleException
\r
343 public void deliver(HttpServletRequest req, HttpServletResponse res,
\r
344 TemplateModelRoot rtm, TemplateModelRoot popups,
\r
345 String templateFilename)
\r
346 throws ServletModuleException {
\r
347 if (rtm == null) rtm = new SimpleHash();
\r
349 PrintWriter out = res.getWriter();
\r
350 HTMLTemplateProcessor.process(res, templateFilename, rtm, popups, out, getLocale(req));
\r
352 // we default to admin bundles here, which is not exactly beautiful...
\r
353 // but this whole producer stuff is going to be rewritten soon.
\r
354 // ServletModuleOpenIndy overwrites deliver() to use open bundles
\r
358 catch (HTMLParseException e) {
\r
359 throw new ServletModuleException(e.getMessage());
\r
360 } catch (IOException e) {
\r
361 throw new ServletModuleException(e.getMessage());
\r
367 * deliver liefert das Template mit dem Filenamen templateFilename
\r
368 * an den HttpServletResponse res aus, nachdem es mit den Daten aus
\r
369 * TemplateModelRoot rtm gemischt wurde
\r
371 * @param res Http-Response, die vom Dispatcher durchgereicht wird
\r
372 * @param rtm beinahalten das freemarker.template.TempalteModelRoot mit den
\r
373 * Daten, die ins Template gemerged werden sollen.
\r
374 * @param tmpl Name des Templates
\r
375 * @exception ServletModuleException
\r
377 public void deliver(HttpServletRequest req, HttpServletResponse res,
\r
378 TemplateModelRoot rtm, String templateFilename)
\r
379 throws ServletModuleException {
\r
380 deliver(req, res, rtm, null, templateFilename);
\r
384 * deliver liefert das Template mit dem Filenamen templateFilename
\r
385 * an den HttpServletResponse res aus, nachdem es mit den Daten aus
\r
386 * TemplateModelRoot rtm gemischt wurde
\r
388 * @param res Http-Response, die vom Dispatcher durchgereicht wird
\r
389 * @param rtm beinahalten das freemarker.template.TempalteModelRoot mit den
\r
390 * Daten, die ins Template gemerged werden sollen.
\r
391 * @param tmpl Name des Templates
\r
392 * @exception ServletModuleException
\r
394 public void deliver_compressed(HttpServletRequest req, HttpServletResponse res,
\r
395 TemplateModelRoot rtm, String templateFilename)
\r
396 throws ServletModuleException {
\r
397 if (rtm == null) rtm = new SimpleHash();
\r
399 PrintWriter out = new LineFilterWriter(res.getWriter());
\r
400 //PrintWriter out = res.getWriter();
\r
401 HTMLTemplateProcessor.process(res, templateFilename, rtm, out, getLocale(req));
\r
404 catch (HTMLParseException e) {
\r
405 throw new ServletModuleException(e.getMessage());
\r
407 catch (IOException e) {
\r
408 throw new ServletModuleException(e.getMessage());
\r
413 * deliver liefert das Template mit dem Filenamen templateFilename
\r
414 * an den HttpServletResponse res aus, nachdem es mit den Daten aus
\r
415 * TemplateModelRoot rtm gemischt wurde
\r
417 * @param out ist der OutputStream, in den die gergten Daten geschickt werden sollen.
\r
418 * @param rtm beinahalten das freemarker.template.TempalteModelRoot mit den
\r
419 * Daten, die ins Template gemerged werden sollen.
\r
420 * @param tmpl Name des Templates
\r
421 * @exception ServletModuleException
\r
423 private void deliver(HttpServletResponse res, HttpServletRequest req, PrintWriter out,
\r
424 TemplateModelRoot rtm, String templateFilename)
\r
425 throws HTMLParseException {
\r
426 HTMLTemplateProcessor.process(res, templateFilename, rtm, out, getLocale(req));
\r
430 * Wenn die abgeleitete Klasse diese Methode ueberschreibt und einen String mit einem
\r
431 * Methodennamen zurueckliefert, dann wird diese Methode bei fehlender Angabe des
\r
432 * doParameters ausgefuehrt.
\r
434 * @return Name der Default-Action
\r
436 public String defaultAction() {
\r
437 return defaultAction;
\r
441 * Hier kann vor der Datenaufbereitung schon mal ein response geschickt
\r
442 * werden (um das subjektive Antwortverhalten bei langsamen Verbindungen
\r
445 public void predeliver(HttpServletRequest req, HttpServletResponse res) {
\r
450 * Holt die Felder aus der Metadatenfelderliste des StorageObjects, die
\r
451 * im HttpRequest vorkommen und liefert sie als HashMap zurueck
\r
453 * @return HashMap mit den Werten
\r
455 public HashMap getIntersectingValues(HttpServletRequest req, StorageObject theStorage)
\r
456 throws ServletModuleException {
\r
459 HTTPRequestParser parser;
\r
460 ArrayList theFieldList;
\r
461 System.out.println("using charset: " + req.getParameter("charset"));
\r
462 System.out.println("using method: " + req.getParameter("do"));
\r
463 if (req.getParameter("charset") != null) {
\r
464 parser = new HTTPRequestParser(req, req.getParameter("charset"));
\r
465 System.out.println("using charset: " + req.getParameter("charset"));
\r
466 System.out.println("original charset: " + req.getCharacterEncoding());
\r
469 parser = new HTTPRequestParser(req);
\r
473 theFieldList = theStorage.getFields();
\r
475 HashMap withValues = new HashMap();
\r
476 String aField, aValue;
\r
478 for (int i = 0; i < theFieldList.size(); i++) {
\r
479 aField = (String) theFieldList.get(i);
\r
481 System.out.println("field " + aField + " = " + parser.getParameter(aField));
\r
483 aValue = parser.getParameter(aField);
\r
484 if (aValue != null)
\r
485 withValues.put(aField, aValue);
\r
489 catch (Throwable e) {
\r
490 e.printStackTrace(System.out);
\r
491 throw new ServletModuleException(
\r
492 "ServletModule.getIntersectingValues: " + e.getMessage());
\r