source: main/trunk/greenstone3/src/java/org/greenstone/gsdl3/util/GSParams.java

Last change on this file was 37390, checked in by davidb, 14 months ago

A set of changes related to supporting GoogleIdentity signin
  • Property svn:keywords set to Author Date Id Revision
File size: 9.5 KB
Line 
1/*
2 * GSParams.java
3 * Copyright (C) 2008 New Zealand Digital Library, http://www.nzdl.org
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 */
19package org.greenstone.gsdl3.util;
20
21import java.util.HashMap;
22import java.util.ArrayList;
23
24import org.apache.log4j.Logger;
25
26/** keeps track of the servlet parameters, and their defaults */
27public class GSParams
28{
29
30 static Logger logger = Logger.getLogger(org.greenstone.gsdl3.util.GSParams.class.getName());
31
32 // Only used internally in the session
33 public static final String USER_SESSION_CACHE = "user_session_cache";
34
35 // cgi parameter names
36 public static final String ACTION = "a"; // the major type of action- eg query or browse or process
37 public static final String SUBACTION = "sa"; // subtype of action if we want different processing than the default
38 public static final String REQUEST_TYPE = "rt"; // whether the request is just to display the service form, or to actually do a request to the service
39 public static final String RESPONSE_ONLY = "ro"; // if == 1 do the request and pass back the response xml - no page formatting
40 public static final String OUTPUT = "o"; // if processing is to be done, what type of output - html/xml/other??
41 public static final String SERVICE = "s"; // the name of the service
42
43 public static final String CACHE_KEY = "ck"; // if we want to use another cache key apart from the collection name
44 public static final String UN = "un"; // username for authenticated-ping
45 public static final String PW = "pw"; // pwd for authenticated-ping
46
47 public static final String CLUSTER = "c"; // these two are the same
48 public static final String COLLECTION = "c";
49 public static final String COLLECTION_TYPE = "ct"; // collection type - mg, mgpp, lucene etc
50 public static final String GROUP = "group";
51 public static final String LANGUAGE = "l";
52 public static final String DOCUMENT = "d";
53 public static final String DOCUMENT_TYPE = "dt";
54 public static final String HREF = "href"; // url. might be an external url, or a relative one that needs translating
55 public static final String RELATIVE_LINK = "rl"; // whether the href url is relative to the collection or not.
56 public static final String EXTERNAL_LINK_TYPE = "el"; // for an external link, go direct to the page or frame it in the collection
57 public static final String PROCESS_ID = "pid"; // if a request wasn't completed, this identifies the request - used when asking for a status update
58
59 public static final String HTTP_HEADER_FIELDS = "hhf";
60
61 public static final String FAVOURITEBASKET = "favouritebasket";
62 public static final String DOCUMENTBASKET = "documentbasket";
63 // internal configure args
64 public static final String SYSTEM_SUBSET = "ss";
65 public static final String SYSTEM_CLUSTER = "sc";
66 public static final String SYSTEM_MODULE_NAME = "sn";
67 public static final String SYSTEM_MODULE_TYPE = "st";
68
69 // used for filtering out a piece of the final page
70 public static final String EXCERPT_ID = "excerptid";
71 public static final String EXCERPT_ID_TEXT = "excerptid-text";
72 public static final String EXCERPT_TAG = "excerpttag";
73 public static final String INLINE_TEMPLATE = "ilt";
74 public static final String FILE_LOCATION = "fl";
75
76 //Administration
77 public static final String PASSWORD = "password";
78 public static final String USERNAME = "username";
79 public static final String GOOGLE_SIGNIN = "googleidentity-signin";
80 public static final String LOGOUT = "logout";
81 public static final String VERIFIED = "hmvf";
82
83 // some standard arg values
84 public static final String SYSTEM_ACTION = "s";
85
86 // rss feeds
87 public static final String RSS_ACTION = "rss";
88
89 public static final String EXTERNAL_LINK_TYPE_DIRECT = "direct";
90 public static final String EXTERNAL_LINK_TYPE_FRAMED = "frame";
91
92 public static final String DEBUG = "debug";
93
94 public static final String SERVICE_PREFIX = "s1";
95 public static final String PREVIOUS_PREFIX = "p";
96 public static final String MD_PREFIX = "md___";
97 public static final String SAVEPARAM_PREFIX = "jsession";
98
99 public static final String SERVICE_PARAM_REGEX = "^s\\d\\..*";
100
101 protected HashMap<String, Param> param_map = null;
102 protected HashMap<String, Param> service_param_map = null;
103
104 protected ArrayList<String> params_with_default_list = null;
105
106 public GSParams()
107 {
108 this.param_map = new HashMap<String, Param>(30);
109 this.service_param_map = new HashMap<String, Param>(30);
110 this.params_with_default_list = new ArrayList<String>(10);
111
112 // we now only need to add in the ones that need saving, as we will default to "not save"
113 // these ones are global params - apply across all collections
114 //addParameter(name, save, sensitive, global)
115 addParameter(LANGUAGE, true, false, true);
116 addParameter(FAVOURITEBASKET, true, false, true);
117 addParameter(DOCUMENTBASKET, true, false, true);
118 addParameter(DEBUG, true, false, true);
119
120 // these will only be saved per collection/service
121 addParameter(DOCUMENT, true);
122 addParameter(PROCESS_ID, true);
123 addParameter(COLLECTION_TYPE, true);
124 addParameter(GROUP, true);
125
126 // password is sensitive. don't save, but also don't return it in the page response
127 addParameter(PASSWORD, false, true);
128
129 }
130
131 public boolean addParameter(String name, boolean save)
132 {
133 return addParameter(name, "", save);
134 }
135
136 public boolean addParameter(String name, boolean save, boolean sensitive)
137 {
138 if (this.param_map.containsKey(name))
139 {
140 // already there so could not add
141 return false;
142 }
143 this.param_map.put(name, new Param("", save, sensitive));
144 return true;
145 }
146
147 public boolean addParameter(String name, String default_value, boolean save)
148 {
149 if (this.param_map.containsKey(name))
150 {
151 // already there so could not add
152 return false;
153 }
154
155 this.param_map.put(name, new Param(default_value, save));
156 if (default_value != null && !default_value.equals("")) {
157 this.params_with_default_list.add(name);
158 }
159 return true;
160 }
161 public boolean addParameter(String name, boolean save, boolean sensitive, boolean global)
162 {
163 if (this.param_map.containsKey(name))
164 {
165 // already there so could not add
166 return false;
167 }
168 this.param_map.put(name, new Param("", save, sensitive, global));
169 return true;
170
171 }
172
173 public boolean addServiceParameter(String name, String default_value, boolean save, boolean sensitive) {
174 if (this.service_param_map.containsKey(name)) {
175 // already there, could not add
176 return false;
177 }
178 this.service_param_map.put(name, new Param(default_value, save, sensitive));
179 return true;
180 }
181
182
183 public boolean setParamDefault(String name, String default_value)
184 {
185 Param p = this.param_map.get(name);
186 if (p == null) {
187 addParameter(name, default_value, true);
188 }else {
189 p.default_value = default_value;
190 }
191 if (!this.params_with_default_list.contains(name)) {
192 this.params_with_default_list.add(name);
193 }
194 return true;
195 }
196
197 public String getParamDefault(String name) {
198 Param p = this.param_map.get(name);
199 if (p==null) {
200 return null;
201 }
202 return p.default_value;
203
204 }
205 public boolean shouldSave(String name)
206 {
207 // p. is used to store previous settings
208 if (name.startsWith(PREVIOUS_PREFIX+".") || name.startsWith(MD_PREFIX)) {
209 return false;
210 }
211 else if (name.startsWith(SAVEPARAM_PREFIX+".")) {
212 return true;
213 }
214
215 Param p;
216 if (name.matches(SERVICE_PARAM_REGEX)) {
217 // its a service param
218 p = this.service_param_map.get(name.substring(3));
219 } else {
220 // an ordinary param
221 p = this.param_map.get(name);
222 }
223 if (p==null) {
224 return false; // never save unknown params
225 }
226
227 return p.save;
228 }
229
230
231 public boolean isSensitive(String name) {
232 Param p;
233 if (name.matches(SERVICE_PARAM_REGEX)) {
234 p = this.service_param_map.get(name.substring(3));
235 } else {
236 p = this.param_map.get(name);
237 }
238 if (p==null) {
239 return false;
240 }
241 return p.sensitive;
242 }
243
244 public boolean isGlobal(String name) {
245 Param p = this.param_map.get(name);
246 if (p==null) {
247 return false;
248 }
249 return p.is_global;
250 }
251
252 public ArrayList<String> getParamsWithDefaults() {
253 return (ArrayList<String> )this.params_with_default_list.clone();
254 }
255
256 private class Param
257 {
258
259 public String default_value = null;
260 public boolean save = true;
261 public boolean sensitive = false;
262 public boolean is_global = false;
263
264 public Param(String default_value, boolean save)
265 {
266 this.default_value = default_value;
267 this.save = save;
268 }
269
270 public Param(String default_value, boolean save, boolean sensitive) {
271 this.default_value = default_value;
272 this.save = save;
273 this.sensitive = sensitive;
274 }
275
276 public Param(String default_value, boolean save, boolean sensitive, boolean global) {
277 this.default_value = default_value;
278 this.save = save;
279 this.sensitive = sensitive;
280 this.is_global = global;
281 }
282
283 }
284}
Note: See TracBrowser for help on using the repository browser.