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.
31 package mircoders.servlet;
33 import java.util.HashMap;
34 import java.util.Iterator;
35 import java.util.List;
36 import java.util.Locale;
39 import javax.servlet.http.HttpServletRequest;
40 import javax.servlet.http.HttpServletResponse;
42 import mir.entity.adapter.EntityAdapterModel;
43 import mir.entity.adapter.EntityIteratorAdapter;
44 import mir.log.LoggerWrapper;
45 import mir.servlet.ServletModule;
46 import mir.servlet.ServletModuleExc;
47 import mir.servlet.ServletModuleFailure;
48 import mir.servlet.ServletModuleUserExc;
49 import mir.util.CachingRewindableIterator;
50 import mir.util.HTTPRequestParser;
51 import mir.util.URLBuilder;
52 import mircoders.entity.EntityUsers;
53 import mircoders.global.MirGlobal;
54 import mircoders.module.ModuleUsers;
55 import mircoders.storage.DatabaseUsers;
60 * <p>Description: </p>
61 * <p>Copyright: Copyright (c) 2003</p>
63 * @author not attributable
66 public class ServletModuleUsers extends ServletModule
68 private static ServletModuleUsers instance = new ServletModuleUsers();
69 public static ServletModule getInstance() { return instance; }
70 protected ModuleUsers usersModule;
72 private ServletModuleUsers() {
74 logger = new LoggerWrapper("ServletModule.Users");
77 model = MirGlobal.localizer().dataModel().adapterModel();
79 usersModule = new ModuleUsers(DatabaseUsers.getInstance());
80 mainModule = usersModule;
83 logger.debug("initialization of ServletModuleUsers failed!: " + e.getMessage());
87 public void edit(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc
89 String idParam = aRequest.getParameter("id");
92 throw new ServletModuleExc("ServletModuleUser.edit: invalid call: (id) not specified");
95 EntityUsers user = (EntityUsers) mainModule.getById(idParam);
96 MirGlobal.accessControl().user().assertMayEditUser(ServletHelper.getUser(aRequest), user);
98 showUser(idParam, false, aRequest, aResponse);
100 catch (Throwable e) {
101 throw new ServletModuleFailure(e);
105 public void add(HttpServletRequest aRequest, HttpServletResponse aResponse)
106 throws ServletModuleExc
109 MirGlobal.accessControl().user().assertMayAddUsers(ServletHelper.getUser(aRequest));
111 showUser(null, false, aRequest, aResponse);
113 catch (Throwable e) {
114 throw new ServletModuleFailure(e);
118 public String validatePassword(EntityUsers aUser, HTTPRequestParser aRequestParser) throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure
120 if ( (aRequestParser.getParameter("newpassword") != null &&
121 aRequestParser.getParameter("newpassword").length() > 0) ||
122 (aRequestParser.getParameter("newpassword2") != null &&
123 aRequestParser.getParameter("newpassword2").length() > 0)
125 String newPassword = aRequestParser.getParameterWithDefault("newpassword", "");
126 String newPassword2 = aRequestParser.getParameterWithDefault("newpassword2", "");
127 String oldPassword = aRequestParser.getParameterWithDefault("oldpassword", "");
130 if (!usersModule.checkUserPassword(aUser, oldPassword)) {
131 throw new ServletModuleUserExc("user.error.incorrectpassword", new String[] {});
134 catch (Throwable t) {
135 throw new ServletModuleFailure(t);
139 if (newPassword.length() == 0 || newPassword2.length() == 0) {
140 throw new ServletModuleUserExc("user.error.missingpasswords", new String[] {});
143 if (!newPassword.equals(newPassword2)) {
144 throw new ServletModuleUserExc("user.error.passwordmismatch", new String[] {});
153 public void insert(HttpServletRequest aRequest, HttpServletResponse aResponse)
154 throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure
157 MirGlobal.accessControl().user().assertMayAddUsers(ServletHelper.getUser(aRequest));
159 HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);
160 Map withValues = getIntersectingValues(aRequest, mainModule.getStorageObject());
162 String newPassword=validatePassword(ServletHelper.getUser(aRequest), requestParser);
163 if (newPassword!=null)
164 withValues.put("password", newPassword);
166 throw new ServletModuleUserExc("user.error.missingpassword", new String[] {});
168 String id = mainModule.add(withValues);
170 logAdminUsage(aRequest, id, "object added");
172 if (requestParser.hasParameter("returnurl"))
173 redirect(aResponse, requestParser.getParameter("returnurl"));
175 list(aRequest, aResponse);
177 catch (Throwable e) {
178 throw new ServletModuleFailure(e);
182 public void update(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure
185 HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);
186 String id = requestParser.getParameter("id");
187 EntityUsers user = (EntityUsers) mainModule.getById(id);
188 MirGlobal.accessControl().user().assertMayEditUser(ServletHelper.getUser(aRequest), user);
190 Map withValues = getIntersectingValues(aRequest, mainModule.getStorageObject());
191 if (!withValues.containsKey("is_admin"))
192 withValues.put("is_admin","0");
193 if (!withValues.containsKey("is_disabled"))
194 withValues.put("is_disabled","0");
196 String newPassword=validatePassword(ServletHelper.getUser(aRequest), requestParser);
197 if (newPassword!=null)
198 withValues.put("password", MirGlobal.localizer().adminInterface().makePasswordDigest(newPassword));
200 mainModule.set(withValues);
202 logAdminUsage(aRequest, id, "object modified");
204 if (requestParser.hasParameter("returnurl"))
205 redirect(aResponse, requestParser.getParameter("returnurl"));
207 list(aRequest, aResponse);
209 catch (Throwable e) {
210 throw new ServletModuleFailure(e);
214 public void updatepassword(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc, ServletModuleUserExc, ServletModuleFailure
217 HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);
218 String id = requestParser.getParameter("id");
219 EntityUsers user = (EntityUsers) mainModule.getById(id);
220 MirGlobal.accessControl().user().assertMayChangeUserPassword(ServletHelper.getUser(aRequest), user);
222 String newPassword=validatePassword(ServletHelper.getUser(aRequest), requestParser);
223 if (newPassword!=null) {
224 user.setValueForProperty("password", MirGlobal.localizer().adminInterface().makePasswordDigest(newPassword));
227 logAdminUsage(aRequest, id, "password changed");
229 // hackish: to make sure the cached logged in user is up-to-date:
230 ServletHelper.setUser(aRequest, (EntityUsers) mainModule.getById(ServletHelper.getUser(aRequest).getId()));
233 if (requestParser.hasParameter("returnurl"))
234 redirect(aResponse, requestParser.getParameter("returnurl"));
236 redirect(aResponse, "");
238 catch (Throwable e) {
239 throw new ServletModuleFailure(e);
243 public void list(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc
245 HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);
247 int offset = requestParser.getIntegerWithDefault("offset", 0);
249 returnUserList(aRequest, aResponse, offset);
252 public void returnUserList(
253 HttpServletRequest aRequest,
254 HttpServletResponse aResponse,
255 int anOffset) throws ServletModuleExc {
257 // ML: to be deleted, support for 3 extra vars to be added
259 HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);
260 URLBuilder urlBuilder = new URLBuilder();
261 EntityAdapterModel model;
265 Map responseData = ServletHelper.makeGenerationData(aRequest, aResponse, new Locale[] { getLocale(aRequest), getFallbackLocale(aRequest)});
266 model = MirGlobal.localizer().dataModel().adapterModel();
269 new CachingRewindableIterator(
270 new EntityIteratorAdapter( "", "login", nrEntitiesPerListPage,
271 MirGlobal.localizer().dataModel().adapterModel(), "user", nrEntitiesPerListPage, anOffset)
274 responseData.put("nexturl", null);
275 responseData.put("prevurl", null);
277 count=mainModule.getSize("");
279 urlBuilder.setValue("module", "Users");
280 urlBuilder.setValue("do", "list");
282 urlBuilder.setValue("offset", anOffset);
283 responseData.put("offset" , new Integer(anOffset).toString());
284 responseData.put("thisurl" , urlBuilder.getQuery());
286 if (count>=anOffset+nrEntitiesPerListPage) {
287 urlBuilder.setValue("offset", (anOffset + nrEntitiesPerListPage));
288 responseData.put("nexturl" , urlBuilder.getQuery());
292 urlBuilder.setValue("offset", Math.max(anOffset - nrEntitiesPerListPage, 0));
293 responseData.put("prevurl" , urlBuilder.getQuery());
296 responseData.put("users", userList);
297 responseData.put("mayDeleteUsers", new Boolean(MirGlobal.accessControl().user().mayDeleteUsers(ServletHelper.getUser(aRequest))));
298 responseData.put("mayAddUsers", new Boolean(MirGlobal.accessControl().user().mayAddUsers(ServletHelper.getUser(aRequest))));
299 responseData.put("mayEditUsers", new Boolean(MirGlobal.accessControl().user().mayEditUsers(ServletHelper.getUser(aRequest))));
301 responseData.put("from" , Integer.toString(anOffset+1));
302 responseData.put("count", Integer.toString(count));
303 responseData.put("to", Integer.toString(Math.min(anOffset+nrEntitiesPerListPage, count)));
304 responseData.put("offset" , Integer.toString(anOffset));
306 ServletHelper.generateResponse(aResponse.getWriter(), responseData, listGenerator);
308 catch (Throwable e) {
309 throw new ServletModuleFailure(e);
313 public void showUser(String anId, boolean anOnlyPassword, HttpServletRequest aRequest, HttpServletResponse aResponse)
314 throws ServletModuleExc {
316 HTTPRequestParser requestParser = new HTTPRequestParser(aRequest);
317 Map responseData = ServletHelper.makeGenerationData(aRequest, aResponse, new Locale[] { getLocale(aRequest), getFallbackLocale(aRequest)});
318 EntityAdapterModel model = MirGlobal.localizer().dataModel().adapterModel();
320 URLBuilder urlBuilder = new URLBuilder();
322 urlBuilder.setValue("module", "Users");
324 urlBuilder.setValue("do", "changepassword");
326 urlBuilder.setValue("do", "edit");
327 urlBuilder.setValue("id", anId);
328 urlBuilder.setValue("returnurl", requestParser.getParameter("returnurl"));
331 responseData.put("new", Boolean.FALSE);
332 user = model.makeEntityAdapter("user", mainModule.getById(anId));
335 List fields = DatabaseUsers.getInstance().getFields();
336 responseData.put("new", Boolean.TRUE);
337 user = new HashMap();
338 Iterator i = fields.iterator();
339 while (i.hasNext()) {
340 user.put(i.next(), null);
343 MirGlobal.localizer().adminInterface().initializeArticle(user);
345 responseData.put("user", user);
346 responseData.put("passwordonly", new Boolean(anOnlyPassword));
348 responseData.put("returnurl", requestParser.getParameter("returnurl"));
349 responseData.put("thisurl", urlBuilder.getQuery());
351 ServletHelper.generateResponse(aResponse.getWriter(), responseData, editGenerator);
353 catch (Throwable e) {
354 throw new ServletModuleFailure(e);
358 public void delete(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleUserExc, ServletModuleExc, ServletModuleFailure {
360 EntityUsers user = (EntityUsers) mainModule.getById(aRequest.getParameter("id"));
362 MirGlobal.accessControl().user().assertMayDeleteUser(ServletHelper.getUser(aRequest), user);
364 super.delete(aRequest, aResponse);
366 catch (Throwable t) {
367 throw new ServletModuleFailure(t);
371 public void changepassword(HttpServletRequest aRequest, HttpServletResponse aResponse) throws ServletModuleExc
373 String idParam = aRequest.getParameter("id");
376 throw new ServletModuleExc("ServletModuleUser.edit: invalid call: (id) not specified");
379 EntityUsers user = (EntityUsers) mainModule.getById(idParam);
380 MirGlobal.accessControl().user().assertMayChangeUserPassword(ServletHelper.getUser(aRequest), user);
382 showUser(idParam, true, aRequest, aResponse);
384 catch (Throwable e) {
385 throw new ServletModuleFailure(e);