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 import java.io.IOException;
\r
33 import java.io.PrintWriter;
\r
34 import java.lang.reflect.Method;
\r
35 import java.util.GregorianCalendar;
\r
36 import java.util.HashMap;
\r
37 import java.util.Locale;
\r
40 import javax.servlet.ServletException;
\r
41 import javax.servlet.UnavailableException;
\r
42 import javax.servlet.http.HttpServletRequest;
\r
43 import javax.servlet.http.HttpServletResponse;
\r
44 import javax.servlet.http.HttpSession;
\r
46 import freemarker.template.*;
\r
48 import org.apache.struts.util.MessageResources;
\r
51 import mir.servlet.*;
\r
53 import mir.generator.*;
\r
54 //import mir.log.Log;
\r
56 import mircoders.global.*;
\r
57 import mircoders.localizer.*;
\r
58 import mircoders.entity.EntityUsers;
\r
59 import mircoders.module.ModuleMessage;
\r
60 import mircoders.module.ModuleUsers;
\r
61 import mircoders.storage.DatabaseArticleType;
\r
62 import mircoders.storage.DatabaseMessages;
\r
63 import mircoders.storage.DatabaseUsers;
\r
66 * Mir.java - main servlet, that dispatches to servletmodules
\r
68 * @author $Author: mh $
\r
69 * @version $Id: Mir.java,v 1.25 2002/12/23 03:00:11 mh Exp $
\r
73 public class Mir extends AbstractServlet {
\r
75 private static ModuleUsers usersModule = null;
\r
76 private static ModuleMessage messageModule = null;
\r
77 private final static HashMap servletModuleInstanceHash = new HashMap();
\r
79 private static List loginLanguages = null;
\r
81 public HttpSession session;
\r
83 public void doGet(HttpServletRequest req, HttpServletResponse res) throws
\r
84 ServletException, IOException {
\r
88 protected TemplateModel getLoginLanguages() throws ServletException {
\r
89 synchronized (Mir.class) {
\r
92 if (loginLanguages == null) {
\r
93 MessageResources messageResources2 = MessageResources.
\r
94 getMessageResources("bundles.admin");
\r
95 MessageResources messageResources = MessageResources.
\r
96 getMessageResources("bundles.adminlocal");
\r
97 List languages = StringRoutines.splitString(MirGlobal.
\r
98 getConfigPropertyWithDefault("Mir.Login.Languages", "en"), ";");
\r
100 loginLanguages = new Vector();
\r
101 Iterator i = languages.iterator();
\r
103 while (i.hasNext()) {
\r
104 String code = (String) i.next();
\r
105 Locale locale = new Locale(code, "");
\r
106 String name = messageResources.getMessage(locale, "languagename");
\r
108 name = messageResources2.getMessage(locale, "languagename");
\r
112 Map record = new HashMap();
\r
113 record.put("name", name);
\r
114 record.put("code", code);
\r
115 loginLanguages.add(record);
\r
119 return FreemarkerGenerator.makeAdapter(loginLanguages);
\r
121 catch (Throwable t) {
\r
122 throw new ServletException(t.getMessage());
\r
127 public void doPost(HttpServletRequest req, HttpServletResponse res) throws
\r
128 ServletException, IOException, UnavailableException {
\r
130 long startTime = System.currentTimeMillis();
\r
131 long sessionConnectTime = 0;
\r
132 EntityUsers userEntity;
\r
135 if (getServletContext().getAttribute("mir.confed") == null) {
\r
139 MirConfig.setServletName(getServletName());
\r
142 // Log.info(this, "blalalala");
\r
144 session = req.getSession(true);
\r
145 userEntity = (EntityUsers) session.getAttribute("login.uid");
\r
147 if (req.getServerPort() == 443)
\r
153 //make sure client browsers don't cache anything
\r
156 res.setContentType("text/html; charset=" + MirConfig.getProp("Mir.DefaultHTMLCharset"));
\r
158 String moduleName = req.getParameter("module");
\r
159 checkLanguage(session, req);
\r
161 /** @todo for cleanup and readability this should be moved to
\r
162 * method loginIfNecessary() */
\r
164 if (moduleName != null && moduleName.equals("direct")) {
\r
169 if ( (moduleName != null && moduleName.equals("login")) || (userEntity == null)) {
\r
170 String user = req.getParameter("login");
\r
171 String passwd = req.getParameter("password");
\r
172 theLog.printDebugInfo("--login: evaluating for user: " + user);
\r
173 userEntity = allowedUser(user, passwd);
\r
174 if (userEntity == null) {
\r
175 // login failed: redirecting to login
\r
176 theLog.printWarning("--login: failed!");
\r
177 _sendLoginPage(res, req, res.getWriter());
\r
180 else if (moduleName != null && moduleName.equals("login")) {
\r
181 // login successful
\r
183 theLog.printInfo("--login: successful! setting uid: " +
\r
184 userEntity.getId());
\r
185 session.setAttribute("login.uid", userEntity);
\r
186 theLog.printDebugInfo("--login: trying to retrieve login.target");
\r
187 String target = (String) session.getAttribute("login.target");
\r
189 if (target != null) {
\r
190 theLog.printDebugInfo("Redirect: " + target);
\r
191 int serverPort = req.getServerPort();
\r
192 String redirect = "";
\r
193 String redirectString = "";
\r
195 if (serverPort == 80) {
\r
196 redirect = res.encodeURL(http + "://" + req.getServerName() +
\r
199 "<html><head><meta http-equiv=refresh content=\"1;URL="
\r
201 + "\"></head><body>going <a href=\"" + redirect +
\r
202 "\">Mir</a></body></html>";
\r
205 redirect = res.encodeURL(http + "://" + req.getServerName() + ":" +
\r
206 req.getServerPort() + target);
\r
208 "<html><head><meta http-equiv=refresh content=\"1;URL="
\r
210 + "\"></head><body>going <a href=\"" + redirect +
\r
211 "\">Mir</a></body></html>";
\r
213 res.getWriter().println(redirectString);
\r
215 //res.sendRedirect(redirect);
\r
219 // redirecting to default target
\r
220 theLog.printDebugInfo("--login: no target - redirecting to default");
\r
221 _sendStartPage(res, req, res.getWriter(), userEntity);
\r
224 } // if login succesful
\r
227 if (moduleName != null && moduleName.equals("logout")) {
\r
228 theLog.printDebugInfo("--logout");
\r
229 session.invalidate();
\r
231 //session = req.getSession(true);
\r
232 //checkLanguage(session, req);
\r
233 _sendLoginPage(res, req, res.getWriter());
\r
237 // Check if authed!
\r
238 if (userEntity == null) {
\r
239 // redirect to loginpage
\r
240 String redirectString = req.getRequestURI();
\r
241 String queryString = req.getQueryString();
\r
242 if (queryString != null && !queryString.equals("")) {
\r
243 redirectString += "?" + req.getQueryString();
\r
244 theLog.printDebugInfo("STORING: " + redirectString);
\r
245 session.setAttribute("login.target", redirectString);
\r
247 _sendLoginPage(res, req, res.getWriter());
\r
251 // If no module is specified goto standard startpage
\r
252 if (moduleName == null || moduleName.equals("")) {
\r
253 theLog.printDebugInfo("no module: redirect to standardpage");
\r
254 _sendStartPage(res, req, res.getWriter(), userEntity);
\r
259 // From now on regular dispatching...
\r
261 // get servletmodule by parameter and continue with dispacher
\r
262 ServletModule smod = getServletModuleForName(moduleName);
\r
263 ServletModuleDispatch.dispatch(smod, req, res);
\r
265 catch (ServletModuleException e) {
\r
266 handleError(req, res, res.getWriter(),
\r
267 "ServletException in Module " + moduleName + " -- " +
\r
270 catch (ServletModuleUserException e) {
\r
271 handleUserError(req, res, res.getWriter(), e.getMessage());
\r
275 sessionConnectTime = System.currentTimeMillis() - startTime;
\r
276 theLog.printInfo("EXECTIME (" + moduleName + "): " + sessionConnectTime +
\r
281 * Private method getServletModuleForName returns ServletModule
\r
284 * @param moduleName
\r
285 * @return ServletModule
\r
288 private static ServletModule getServletModuleForName(String moduleName) throws
\r
289 ServletModuleException {
\r
291 // Instance in Map ?
\r
292 if (!servletModuleInstanceHash.containsKey(moduleName)) {
\r
293 // was not found in hash...
\r
295 Class theServletModuleClass = null;
\r
297 // first we try to get ServletModule from stern.che3.servlet
\r
298 theServletModuleClass = Class.forName(
\r
299 "mircoders.servlet.ServletModule" + moduleName);
\r
301 catch (ClassNotFoundException e) {
\r
302 // on failure, we try to get it from lib-layer
\r
303 theServletModuleClass = Class.forName("mir.servlet.ServletModule" +
\r
306 Method m = theServletModuleClass.getMethod("getInstance", null);
\r
307 ServletModule smod = (ServletModule) m.invoke(null, null);
\r
308 // we put it into map for further reference
\r
309 servletModuleInstanceHash.put(moduleName, smod);
\r
312 catch (Exception e) {
\r
313 throw new ServletModuleException("*** error resolving classname for " +
\r
314 moduleName + " -- " + e.getMessage());
\r
318 return (ServletModule) servletModuleInstanceHash.get(moduleName);
\r
321 private void handleError(HttpServletRequest req, HttpServletResponse res,
\r
322 PrintWriter out, String errorString) {
\r
325 theLog.printError(errorString);
\r
326 SimpleHash modelRoot = new SimpleHash();
\r
327 modelRoot.put("errorstring", new SimpleScalar(errorString));
\r
328 modelRoot.put("date",
\r
329 new SimpleScalar(StringUtil.date2readableDateTime(new GregorianCalendar())));
\r
330 HTMLTemplateProcessor.process(res, MirConfig.getProp("Mir.ErrorTemplate"),
\r
331 modelRoot, out, getLocale(req));
\r
334 catch (Exception e) {
\r
335 e.printStackTrace(System.out);
\r
336 System.err.println("Error in ErrorTemplate: " + e.getMessage());
\r
340 private void handleUserError(HttpServletRequest req, HttpServletResponse res,
\r
341 PrintWriter out, String errorString) {
\r
343 theLog.printError(errorString);
\r
344 SimpleHash modelRoot = new SimpleHash();
\r
345 modelRoot.put("errorstring", new SimpleScalar(errorString));
\r
346 modelRoot.put("date",
\r
347 new SimpleScalar(StringUtil.date2readableDateTime(new GregorianCalendar())));
\r
348 HTMLTemplateProcessor.process(res,
\r
349 MirConfig.getProp("Mir.UserErrorTemplate"),
\r
350 modelRoot, out, getLocale(req));
\r
353 catch (Exception e) {
\r
354 System.err.println("Error in UserErrorTemplate");
\r
360 * evaluate login for user / password
\r
362 protected EntityUsers allowedUser(String user, String password) {
\r
364 if (usersModule == null)
\r
365 usersModule = new ModuleUsers(DatabaseUsers.getInstance());
\r
366 return usersModule.getUserForLogin(user, password);
\r
368 catch (Exception e) {
\r
369 theLog.printDebugInfo(e.getMessage());
\r
370 e.printStackTrace();
\r
375 // Redirect-methods
\r
376 private void _sendLoginPage(HttpServletResponse res, HttpServletRequest req,
\r
378 String loginTemplate = MirConfig.getProp("Mir.LoginTemplate");
\r
379 String sessionUrl = res.encodeURL("");
\r
382 SimpleHash mergeData = new SimpleHash();
\r
383 SimpleList languages = new SimpleList();
\r
385 mergeData.put("session", sessionUrl);
\r
387 String defaultlanguage = MirGlobal.getConfigPropertyWithDefault("Mir.Login.DefaultLanguage", "");
\r
388 if (defaultlanguage.length() == 0)
\r
389 defaultlanguage = req.getLocale().getLanguage();
\r
390 mergeData.put("defaultlanguage", defaultlanguage);
\r
391 mergeData.put("languages", getLoginLanguages());
\r
393 HTMLTemplateProcessor.process(res, loginTemplate, mergeData, out, getLocale(req));
\r
395 catch (Throwable e) {
\r
396 handleError(req, res, out, "Error sending login page: " + e.getMessage());
\r
400 private void _sendStartPage(HttpServletResponse res, HttpServletRequest req,
\r
401 PrintWriter out, EntityUsers userEntity) {
\r
402 String startTemplate = "templates/admin/start_admin.template";
\r
403 String sessionUrl = res.encodeURL("");
\r
406 // merge with logged in user and messages
\r
407 SimpleHash mergeData = new SimpleHash();
\r
408 mergeData.put("session", sessionUrl);
\r
409 mergeData.put("login_user", userEntity);
\r
410 if (messageModule == null)
\r
411 messageModule = new ModuleMessage(DatabaseMessages.getInstance());
\r
412 mergeData.put("messages",
\r
413 messageModule.getByWhereClause(null, "webdb_create desc", 0,
\r
416 mergeData.put("articletypes",
\r
417 DatabaseArticleType.getInstance().
\r
418 selectByWhereClause("", "id", 0, 20));
\r
420 HTMLTemplateProcessor.process(res, startTemplate, mergeData, out, getLocale(req));
\r
422 catch (Exception e) {
\r
423 e.printStackTrace(System.out);
\r
424 handleError(req, res, out, "error while trying to send startpage. " + e.getMessage());
\r
428 public String getServletInfo() {
\r
429 return "Mir " + MirConfig.getProp("Mir.Version");
\r
432 private void checkLanguage(HttpSession session, HttpServletRequest req) {
\r
433 // a lang parameter always sets the language
\r
434 String lang = req.getParameter("language");
\r
435 if (lang != null) {
\r
436 theLog.printInfo("selected language " + lang + " overrides accept-language");
\r
437 setLanguage(session, lang);
\r
438 setLocale(session, new Locale(lang, ""));
\r
440 // otherwise store language from accept header in session
\r
441 else if (session.getAttribute("Language") == null) {
\r
442 theLog.printInfo("accept-language is " + req.getLocale().getLanguage());
\r
443 setLanguage(session, req.getLocale().getLanguage());
\r
444 setLocale(session, req.getLocale());
\r