Mir goes GPL
[mir.git] / source / mir / servlet / AbstractServlet.java
1 /*
2  * Copyright (C) 2001, 2002  The Mir-coders group
3  *
4  * This file is part of Mir.
5  *
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.
10  *
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.
15  *
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
19  *
20  * In addition, as a special exception, The Mir-coders gives permission to link
21  * the code of this program with the com.oreilly.servlet library, any library
22  * licensed under the Apache Software License, The Sun (tm) Java Advanced
23  * Imaging library (JAI), The Sun JIMI library (or with modified versions of
24  * the above that use the same license as the above), and distribute linked
25  * combinations including the two.  You must obey the GNU General Public
26  * License in all respects for all of the code used other than the above
27  * mentioned libraries.  If you modify this file, you may extend this exception
28  * to your version of the file, but you are not obligated to do so.  If you do
29  * not wish to do so, delete this exception statement from your version.
30  */
31
32 package mir.servlet;
33
34 import mir.misc.Logfile;
35 import mir.misc.MirConfig;
36 import mir.misc.StringUtil;
37 import mir.storage.StorageObjectException;
38
39 import javax.servlet.UnavailableException;
40 import javax.servlet.http.HttpServlet;
41 import javax.servlet.http.HttpServletRequest;
42 import javax.servlet.http.HttpSession;
43 import java.util.Locale;
44 import java.util.Random;
45
46 /**
47  * Title:        Mir
48  * Description:  Abstract servlet-class
49  * Copyright:    Copyright (c) 2001
50  * Company:      Indymedia
51  * @author       idfx
52  * @version 1.0
53  */
54
55 public abstract class AbstractServlet extends HttpServlet {
56     protected static String lang;
57     protected static Logfile theLog;
58
59     /**
60      * the configration
61      */
62     protected boolean getConfig(HttpServletRequest req)
63             throws UnavailableException {
64
65         //String RealPath = super.getServletContext().getRealPath("/");
66         String Uri = req.getRequestURI();
67         String Name = super.getServletName();
68         String RootUri = StringUtil.replace(Uri, "/servlet/" + Name, "");
69
70         // init config
71         //MirConfig.initConfig(RealPath, RootUri, Name, getInitParameter("Config"));
72         MirConfig.initConfig(super.getServletContext(), RootUri, Name,
73                               getInitParameter("Config"));
74
75         theLog = Logfile.getInstance(MirConfig.getPropWithHome(Name + ".Logfile"));
76         theLog.printInfo(Name + " started.");
77         theLog.printInfo("Path is: " + MirConfig.getProp("Home"));
78         theLog.printInfo("Root URI is: " + MirConfig.getProp("RootUri"));
79         theLog.printInfo("StandardLanguage is: " + MirConfig.getProp("StandardLanguage"));
80         try {
81             MirConfig.initDbPool();
82         }
83         catch (StorageObjectException e) {
84             throw new UnavailableException(
85                     "Could not initialize database pool. -- "
86                     + e.toString(), 0);
87         }
88         super.getServletContext().setAttribute("mir.confed", new Boolean(true));
89         return true;
90     }
91
92     /**
93      * Bind the language to the session
94      */
95     protected void setLanguage(HttpSession session, String language) {
96         session.setAttribute("Language", language);
97     }
98
99     protected void setLocale(HttpSession session, Locale loc) {
100         session.setAttribute("Locale", loc);
101     }
102
103     /**
104      * Get the session-bound language
105      */
106     protected String getLanguage(HttpServletRequest req, HttpSession session) {
107         String lang = (String) session.getAttribute("Language");
108         if (lang == null || lang.equals("")) {
109             return getAcceptLanguage(req);
110         }
111         else {
112             return lang;
113         }
114     }
115
116     /**
117      * get the locale either from the session or the accept-language header ot the request
118      * this supersedes getLanguage for the new i18n
119      */
120     public Locale getLocale(HttpServletRequest req) {
121         Locale loc=null;
122         HttpSession session = req.getSession(false);
123         if (session!=null) {
124             // session can be null in case of logout
125             loc = (Locale) session.getAttribute("Locale");
126         }
127         // if there is nothing in the session get it fron the accept-language
128         if (loc == null) {
129             loc = req.getLocale();
130         }
131         return loc;
132     }
133
134     /**
135      * Checks the Accept-Language of the client browser.
136      * If this language is available it returns its country-code,
137      * else it returns the standard-language
138      */
139     protected String getAcceptLanguage(HttpServletRequest req) {
140         Locale loc = req.getLocale();
141         lang = loc.getLanguage();
142         /* not needed anymore due to new i18n
143           File f = new File(HTMLTemplateProcessor.templateDir+"/"+lang);
144         //is there an existing template-path?
145         if(!f.isDirectory()){
146           //no there isn't. we use standard-language
147           lang = MirConfig.getProp("StandardLanguage");
148           theLog.printDebugInfo("language not existing");
149         }
150         theLog.printDebugInfo("Language: " + lang);
151         */
152         return lang;
153     }
154 }