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

Last change on this file since 37097 was 37097, checked in by davidb, 16 months ago

Adding in new CGI arg excerptit-text
  • Property svn:keywords set to Author Date Id Revision
File size: 9.4 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 LOGOUT = "logout";
80 public static final String VERIFIED = "hmvf";
81
82 // some standard arg values
83 public static final String SYSTEM_ACTION = "s";
84
85 // rss feeds
86 public static final String RSS_ACTION = "rss";
87
88 public static final String EXTERNAL_LINK_TYPE_DIRECT = "direct";
89 public static final String EXTERNAL_LINK_TYPE_FRAMED = "frame";
90
91 public static final String DEBUG = "debug";
92
93 public static final String SERVICE_PREFIX = "s1";
94 public static final String PREVIOUS_PREFIX = "p";
95 public static final String MD_PREFIX = "md___";
96 public static final String SAVEPARAM_PREFIX = "jsession";
97
98 public static final String SERVICE_PARAM_REGEX = "^s\\d\\..*";
99
100 protected HashMap<String, Param> param_map = null;
101 protected HashMap<String, Param> service_param_map = null;
102
103 protected ArrayList<String> params_with_default_list = null;
104
105 public GSParams()
106 {
107 this.param_map = new HashMap<String, Param>(30);
108 this.service_param_map = new HashMap<String, Param>(30);
109 this.params_with_default_list = new ArrayList<String>(10);
110
111 // we now only need to add in the ones that need saving, as we will default to "not save"
112 // these ones are global params - apply across all collections
113 //addParameter(name, save, sensitive, global)
114 addParameter(LANGUAGE, true, false, true);
115 addParameter(FAVOURITEBASKET, true, false, true);
116 addParameter(DOCUMENTBASKET, true, false, true);
117 addParameter(DEBUG, true, false, true);
118
119 // these will only be saved per collection/service
120 addParameter(DOCUMENT, true);
121 addParameter(PROCESS_ID, true);
122 addParameter(COLLECTION_TYPE, true);
123 addParameter(GROUP, true);
124
125 // password is sensitive. don't save, but also don't return it in the page response
126 addParameter(PASSWORD, false, true);
127
128 }
129
130 public boolean addParameter(String name, boolean save)
131 {
132 return addParameter(name, "", save);
133 }
134
135 public boolean addParameter(String name, boolean save, boolean sensitive)
136 {
137 if (this.param_map.containsKey(name))
138 {
139 // already there so could not add
140 return false;
141 }
142 this.param_map.put(name, new Param("", save, sensitive));
143 return true;
144 }
145
146 public boolean addParameter(String name, String default_value, boolean save)
147 {
148 if (this.param_map.containsKey(name))
149 {
150 // already there so could not add
151 return false;
152 }
153
154 this.param_map.put(name, new Param(default_value, save));
155 if (default_value != null && !default_value.equals("")) {
156 this.params_with_default_list.add(name);
157 }
158 return true;
159 }
160 public boolean addParameter(String name, boolean save, boolean sensitive, boolean global)
161 {
162 if (this.param_map.containsKey(name))
163 {
164 // already there so could not add
165 return false;
166 }
167 this.param_map.put(name, new Param("", save, sensitive, global));
168 return true;
169
170 }
171
172 public boolean addServiceParameter(String name, String default_value, boolean save, boolean sensitive) {
173 if (this.service_param_map.containsKey(name)) {
174 // already there, could not add
175 return false;
176 }
177 this.service_param_map.put(name, new Param(default_value, save, sensitive));
178 return true;
179 }
180
181
182 public boolean setParamDefault(String name, String default_value)
183 {
184 Param p = this.param_map.get(name);
185 if (p == null) {
186 addParameter(name, default_value, true);
187 }else {
188 p.default_value = default_value;
189 }
190 if (!this.params_with_default_list.contains(name)) {
191 this.params_with_default_list.add(name);
192 }
193 return true;
194 }
195
196 public String getParamDefault(String name) {
197 Param p = this.param_map.get(name);
198 if (p==null) {
199 return null;
200 }
201 return p.default_value;
202
203 }
204 public boolean shouldSave(String name)
205 {
206 // p. is used to store previous settings
207 if (name.startsWith(PREVIOUS_PREFIX+".") || name.startsWith(MD_PREFIX)) {
208 return false;
209 }
210 else if (name.startsWith(SAVEPARAM_PREFIX+".")) {
211 return true;
212 }
213
214 Param p;
215 if (name.matches(SERVICE_PARAM_REGEX)) {
216 // its a service param
217 p = this.service_param_map.get(name.substring(3));
218 } else {
219 // an ordinary param
220 p = this.param_map.get(name);
221 }
222 if (p==null) {
223 return false; // never save unknown params
224 }
225
226 return p.save;
227 }
228
229
230 public boolean isSensitive(String name) {
231 Param p;
232 if (name.matches(SERVICE_PARAM_REGEX)) {
233 p = this.service_param_map.get(name.substring(3));
234 } else {
235 p = this.param_map.get(name);
236 }
237 if (p==null) {
238 return false;
239 }
240 return p.sensitive;
241 }
242
243 public boolean isGlobal(String name) {
244 Param p = this.param_map.get(name);
245 if (p==null) {
246 return false;
247 }
248 return p.is_global;
249 }
250
251 public ArrayList<String> getParamsWithDefaults() {
252 return (ArrayList<String> )this.params_with_default_list.clone();
253 }
254
255 private class Param
256 {
257
258 public String default_value = null;
259 public boolean save = true;
260 public boolean sensitive = false;
261 public boolean is_global = false;
262
263 public Param(String default_value, boolean save)
264 {
265 this.default_value = default_value;
266 this.save = save;
267 }
268
269 public Param(String default_value, boolean save, boolean sensitive) {
270 this.default_value = default_value;
271 this.save = save;
272 this.sensitive = sensitive;
273 }
274
275 public Param(String default_value, boolean save, boolean sensitive, boolean global) {
276 this.default_value = default_value;
277 this.save = save;
278 this.sensitive = sensitive;
279 this.is_global = global;
280 }
281
282 }
283}
Note: See TracBrowser for help on using the repository browser.