2 * Copyright (C) 2001, 2002 The Mir-coders group
4 * This file is part of Mir.
6 * Mir is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * Mir is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with Mir; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 * In addition, as a special exception, The Mir-coders gives permission to link
21 * the code of this program with any library licensed under the Apache Software License,
22 * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library
23 * (or with modified versions of the above that use the same license as the above),
24 * and distribute linked combinations including the two. You must obey the
25 * GNU General Public License in all respects for all of the code used other than
26 * the above mentioned libraries. If you modify this file, you may extend this
27 * exception to your version of the file, but you are not obligated to do so.
28 * If you do not wish to do so, delete this exception statement from your version.
34 import javax.servlet.http.HttpServletRequest;
35 import javax.servlet.http.HttpServletResponse;
36 import javax.servlet.http.HttpSession;
38 import mir.config.MirPropertiesConfiguration;
39 import mir.entity.adapter.EntityAdapterEngine;
40 import mir.entity.adapter.EntityAdapterModel;
41 import mir.log.LoggerWrapper;
42 import mir.module.AbstractModule;
43 import mir.module.ModuleExc;
44 import mir.storage.Database;
45 import mir.util.HTTPRequestParser;
46 import mir.util.URLBuilder;
47 import mircoders.global.MirGlobal;
48 import mircoders.localizer.MirLocalizerExc;
49 import mircoders.servlet.ServletHelper;
55 public abstract class ServletModule {
56 public String defaultAction;
57 protected LoggerWrapper logger;
58 protected static MirPropertiesConfiguration configuration = MirPropertiesConfiguration.instance();
59 private static Locale fallbackLocale = new Locale(configuration.getString("Mir.Admin.FallbackLanguage", "en"), "");
61 protected AbstractModule mainModule;
62 protected String definition;
63 protected EntityAdapterModel model;
65 protected String listGenerator;
66 protected String editGenerator;
67 protected String deleteConfirmationGenerator;
68 protected int nrEntitiesPerListPage;
70 /** the list of parameters that need to be propagated in the list */
71 protected List propagatedParameters = new ArrayList();
73 public ServletModule(){
74 propagatedParameters.add("searchfield");
75 propagatedParameters.add("searchtext");
76 propagatedParameters.add("searchispublished");
77 propagatedParameters.add("searchstatus");
78 propagatedParameters.add("searchorder");
82 model = MirGlobal.localizer().dataModel().adapterModel();
84 catch (MirLocalizerExc e) {
85 logger.error("Can't create model: " + e.toString());
86 throw new ServletModuleFailure("Can't retrieve model", e);
89 listGenerator = configuration.getString("ServletModule."+getOperationModuleName()+".ListTemplate");
90 editGenerator = configuration.getString("ServletModule."+getOperationModuleName()+".EditTemplate");
91 deleteConfirmationGenerator = configuration.getString("ServletModule."+getOperationModuleName()+".DeleteConfirmationTemplate");
92 nrEntitiesPerListPage =
93 configuration.getInt("ServletModule."+getOperationModuleName()+".ListSize",
94 configuration.getInt("ServletModule.Default.ListSize", 20));
99 public void logAdminUsage(HttpServletRequest aRequest, String anObject, String aDescription) {
100 MirGlobal.logAdminUsage(ServletHelper.getUser(aRequest), getOperationModuleName() + ":" + anObject, aDescription);
104 * Singleton instance retrievel method. MUST be overridden in subclasses.
106 * @return ServletModule the single instance of the servletmodule class
108 public static ServletModule getInstance() {
113 * Return the module name
115 protected String getOperationModuleName() {
116 return getClass().getName().substring((new String("mircoders.servlet.ServletModule")).length());
119 public static Locale[] getLocales(HttpServletRequest aRequest) {
120 return new Locale[] { getLocale(aRequest), fallbackLocale };
124 * Return the locale either from the session or the accept-language header ot the request
125 * this supersedes getLanguage for the new i18n
127 public static Locale getLocale(HttpServletRequest aRequest) {
128 Locale locale = null;
129 HttpSession session = aRequest.getSession(false);
130 if (session != null) {
131 // session can be null in case of logout
132 locale = (Locale) session.getAttribute("locale");
134 // if there is nothing in the session get it fron the accept-language
135 if (locale == null) {
136 locale = aRequest.getLocale();
142 * get the locale either from the session or the accept-language header ot the request
143 * this supersedes getLanguage for the new i18n
145 public Locale getFallbackLocale(HttpServletRequest aRequest) {
146 return fallbackLocale;
150 * Function to specify the default ordering for lists. May be overridden.
155 public String getDefaultListOrdering() {
157 if (mainModule!=null && mainModule.getStorageObject()!=null) {
158 if (mainModule.getStorageObject().getFieldNames().contains("webdb_create"))
159 return "webdb_create desc";
166 * Generic list servlet method
169 public void list(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc {
170 HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);
172 String where = requestParser.getParameter("where");
173 String order = requestParser.getParameterWithDefault("order", getDefaultListOrdering());
174 int offset = requestParser.getIntegerWithDefault("offset", 0);
176 returnList(aRequest, aResponse, where, order, offset);
180 public void returnList(HttpServletRequest aRequest, HttpServletResponse aResponse,
181 String aWhereClause, String anOrderByClause, int anOffset) throws ServletModuleExc {
182 returnList(aRequest, aResponse, aWhereClause, anOrderByClause, anOffset, Collections.EMPTY_MAP);
185 public void returnList(HttpServletRequest aRequest, HttpServletResponse aResponse,
186 String aWhereClause, String anOrderByClause, int anOffset, Map anOverridingRequestParameters) throws ServletModuleExc {
187 HTTPRequestParser requestParser = new HTTPRequestParser(aRequest, anOverridingRequestParameters);
188 URLBuilder urlBuilder = new URLBuilder();
191 Map responseData = ServletHelper.makeGenerationData(aRequest, aResponse, getLocales(aRequest));
194 EntityAdapterEngine.retrieveAdapterList(model, definition, aWhereClause, anOrderByClause, nrEntitiesPerListPage, anOffset);
196 responseData.put("nexturl", null);
197 responseData.put("prevurl", null);
198 responseData.put("module", getOperationModuleName());
200 urlBuilder.setValue("module", getOperationModuleName());
201 urlBuilder.setValue("do", "list");
202 urlBuilder.setValue("where", aWhereClause);
203 urlBuilder.setValue("order", anOrderByClause);
206 urlBuilder.setValue("offset", anOffset);
207 responseData.put("offset" , new Integer(anOffset).toString());
208 responseData.put("thisurl" , urlBuilder.getQuery());
210 propagateFields(requestParser, urlBuilder, responseData);
212 if (list.size()>=nrEntitiesPerListPage) {
213 urlBuilder.setValue("offset", anOffset + nrEntitiesPerListPage);
214 responseData.put("nexturl" , urlBuilder.getQuery());
218 urlBuilder.setValue("offset", Math.max(anOffset - nrEntitiesPerListPage, 0));
219 responseData.put("prevurl" , urlBuilder.getQuery());
222 responseData.put("entities", list);
223 responseData.put("from" , Integer.toString(anOffset+1));
224 responseData.put("count", "?");
225 responseData.put("to", Integer.toString(anOffset+list.size()-1));
227 ServletHelper.generateResponse(aResponse.getWriter(), responseData, listGenerator);
229 catch (Throwable e) {
230 throw new ServletModuleFailure(e);
234 public void editObject(HttpServletRequest aRequest, HttpServletResponse aResponse, String anId) throws ServletModuleExc {
236 editObject(aRequest, aResponse, model.makeEntityAdapter(definition, mainModule.getById(anId)), false, anId);
238 catch (Throwable t) {
239 throw new ServletModuleFailure(t);
243 public void editObject(HttpServletRequest aRequest, HttpServletResponse aResponse, Object anObject, boolean anIsNew, String anId) throws ServletModuleExc {
244 HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);
245 URLBuilder urlBuilder = new URLBuilder();
248 Map responseData = ServletHelper.makeGenerationData(aRequest, aResponse, getLocales(aRequest));
250 responseData.put("module", getOperationModuleName());
251 responseData.put("entity", anObject);
252 responseData.put("new", new Boolean(anIsNew));
255 urlBuilder.setValue("module", getOperationModuleName());
256 urlBuilder.setValue("returnurl", requestParser.getParameter("returnurl"));
258 urlBuilder.setValue("do", "add");
260 urlBuilder.setValue("id", anId);
261 urlBuilder.setValue("do", "edit");
263 responseData.put("returnurl", requestParser.getParameter("returnurl"));
264 responseData.put("thisurl", urlBuilder.getQuery());
266 ServletHelper.generateResponse(aResponse.getWriter(), responseData, editGenerator);
268 catch (Throwable e) {
269 throw new ServletModuleFailure(e);
274 * Generic add servlet method
276 public void add(HttpServletRequest aRequest, HttpServletResponse aResponse)
277 throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure {
279 Map object = new HashMap();
281 Iterator i = mainModule.getStorageObject().getFieldNames().iterator();
284 object.put(i.next(), "");
286 initializeNewObject(object, aRequest, aResponse);
288 editObject(aRequest, aResponse, object, true, null);
291 protected void initializeNewObject(Map aNewObject, HttpServletRequest aRequest, HttpServletResponse aResponse) {
295 * Generic edit servlet method
297 public void edit(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure {
298 edit(aRequest, aResponse, aRequest.getParameter("id"));
303 public void edit(HttpServletRequest aRequest, HttpServletResponse aResponse, String anIdentifier)
304 throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure {
306 editObject(aRequest, aResponse, model.makeEntityAdapter(definition, mainModule.getById(anIdentifier)), false, anIdentifier);
308 catch (Throwable e) {
309 throw new ServletModuleFailure(e);
314 * Generic update servlet method
316 public void update(HttpServletRequest aRequest, HttpServletResponse aResponse)
317 throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure {
319 HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);
321 String id = aRequest.getParameter("id");
322 Map withValues = getIntersectingValues(aRequest, mainModule.getStorageObject());
323 mainModule.set(withValues);
325 logAdminUsage(aRequest, id, "object modified");
327 String returnUrl = requestParser.getParameter("returnurl");
329 if (returnUrl!=null) {
330 ServletHelper.redirect(aResponse, returnUrl);
333 edit(aRequest, aResponse, id);
336 catch (Throwable e) {
337 throw new ServletModuleFailure(e);
342 * Generic insert servlet method
344 public void insert(HttpServletRequest aRequest, HttpServletResponse aResponse)
345 throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure {
347 HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);
349 Map object = getIntersectingValues(aRequest, mainModule.getStorageObject());
351 String id = processInstertedObject(object, aRequest, aResponse);
353 logAdminUsage(aRequest, id, "object inserted");
355 String returnUrl = requestParser.getParameter("returnurl");
357 if (returnUrl!=null) {
358 ServletHelper.redirect(aResponse, returnUrl);
361 edit(aRequest, aResponse, id);
364 catch (Throwable e) {
365 throw new ServletModuleFailure(e);
372 public String processInstertedObject(Map anObject, HttpServletRequest aRequest, HttpServletResponse aResponse) {
374 return mainModule.add(anObject);
376 catch (ModuleExc t) {
377 throw new ServletModuleFailure(t);
382 * Generic delete confirmation servlet method
384 public void confirmdelete(HttpServletRequest aRequest, HttpServletResponse aResponse) {
386 String idParam = aRequest.getParameter("id");
387 String confirmParam = aRequest.getParameter("confirm");
389 if (confirmParam != null && !confirmParam.equals("")) {
390 mainModule.deleteById(idParam);
391 logAdminUsage(aRequest, idParam, "object deleted");
392 ServletHelper.redirect(aResponse, aRequest.getParameter("okurl"));
395 ServletHelper.redirect(aResponse, aRequest.getParameter("cancelurl"));
397 catch (Throwable t) {
398 throw new ServletModuleFailure(t);
403 * Generic delete servlet method
405 public void delete(HttpServletRequest aRequest, HttpServletResponse aResponse)
406 throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure {
408 String idParam = aRequest.getParameter("id");
411 throw new ServletModuleExc("Invalid call to delete: no id supplied");
413 Map responseData = ServletHelper.makeGenerationData(aRequest, aResponse, getLocales(aRequest));
415 responseData.put("module", getOperationModuleName());
416 responseData.put("id", idParam);
417 responseData.put("cancelurl", aRequest.getParameter("cancelurl"));
418 responseData.put("okurl", aRequest.getParameter("okurl"));
420 ServletHelper.generateResponse(aResponse.getWriter(), responseData, deleteConfirmationGenerator);
422 catch (Throwable e) {
423 throw new ServletModuleFailure(e);
429 public String defaultAction() {
430 return defaultAction;
434 * Gets the fields from a httprequest and matches them with the metadata from
435 * the database object. Returns the keys that match, with their values.
437 * @return Map with the values
439 public Map getIntersectingValues(HttpServletRequest aRequest, Database theStorage)
440 throws ServletModuleExc, ServletModuleFailure {
442 HTTPRequestParser parser;
445 parser = new HTTPRequestParser(aRequest);
447 theFieldList = theStorage.getFieldNames();
449 Map withValues = new HashMap();
450 String aField, aValue;
452 for (int i = 0; i < theFieldList.size(); i++) {
453 aField = (String) theFieldList.get(i);
455 aValue = parser.getParameter(aField);
457 withValues.put(aField, aValue);
462 private void propagateFields(HTTPRequestParser aRequest, URLBuilder aUrlBuilder, Map aResponseData) {
463 Iterator i = propagatedParameters.iterator();
464 while (i.hasNext()) {
465 String parameter = (String) i.next();
466 String value = aRequest.getParameter(parameter);
467 aUrlBuilder.setValue(parameter, value);
468 aResponseData.put(parameter, value);