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

Last change on this file since 25735 was 25735, checked in by sjm84, 12 years ago

Start page is no longer remembered in the session
  • Property svn:keywords set to Author Date Id Revision
File size: 6.2 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;
22
23/** keeps track of the interface parameters, and their defaults */
24public class GSParams
25{
26
27 // cgi parameter names
28 public static final String ACTION = "a"; // the major type of action- eg query or browse or process
29 public static final String SUBACTION = "sa"; // subtype of action if we want different processing than the default
30 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
31 public static final String RESPONSE_ONLY = "ro"; // if == 1 do the request and pass back the response xml - no page formatting
32 public static final String OUTPUT = "o"; // if processing is to be done, what type of output - html/xml/other??
33 public static final String SERVICE = "s"; // the name of the service
34
35 public static final String CLUSTER = "c"; // these two are the same
36 public static final String COLLECTION = "c";
37 public static final String COLLECTION_TYPE = "ct"; // collection type - mg, mgpp, lucene etc
38
39 public static final String LANGUAGE = "l";
40 public static final String DOCUMENT = "d";
41 public static final String DOCUMENT_TYPE = "dt";
42 public static final String START_PAGE = "startPage";
43 public static final String S_START_PAGE = "s1.startPage";
44 public static final String HREF = "href"; // url. might be an external url, or a relative one that needs translating
45 public static final String RELATIVE_LINK = "rl"; // whether the href url is relative to the collection or not.
46 public static final String EXTERNAL_LINK_TYPE = "el"; // for an external link, go direct to the page or frame it in the collection
47 public static final String PROCESS_ID = "pid"; // if a request wasn't completed, this identifies the request - used when asking for a status update
48
49 public static final String HTTPHEADERFIELDS = "hhf";
50
51 // internal configure args
52 public static final String SYSTEM_SUBSET = "ss";
53 public static final String SYSTEM_CLUSTER = "sc";
54 public static final String SYSTEM_MODULE_NAME = "sn";
55 public static final String SYSTEM_MODULE_TYPE = "st";
56
57 // used for filtering out a piece of the final page
58 public static final String EXCERPT_ID = "excerptid";
59 public static final String EXCERPT_TAG = "excerpttag";
60
61 public static final String INLINE_TEMPLATE = "ilt";
62 public static final String DISPLAY_METADATA = "dmd";
63 public static final String FILE_LOCATION = "fl";
64 public static final String DOC_EDIT = "docEdit";
65 public static final String AJAX_LOAD_BYPASS = "alb";
66
67 //Administration
68 public static final String PASSWORD = "password";
69 public static final String S_PASSWORD = "s1.password";
70 public static final String S_NEW_PASSWORD = "s1.newPassword";
71 public static final String S_OLD_PASSWORD = "s1.oldPassword";
72
73 // some standard arg values
74 public static final String SYSTEM_ACTION = "s";
75
76 public static final String EXTERNAL_LINK_TYPE_DIRECT = "direct";
77 public static final String EXTERNAL_LINK_TYPE_FRAMED = "frame";
78
79 protected HashMap<String, Param> param_map = null;
80
81 public GSParams()
82 {
83 this.param_map = new HashMap<String, Param>(30);
84
85 // add in all the standard params
86 addParameter(ACTION, false);
87 addParameter(SUBACTION, false);
88 addParameter(REQUEST_TYPE, false);
89 addParameter(RESPONSE_ONLY, false);
90 addParameter(CLUSTER, false); // we don't want to save cluster/collection
91 addParameter(LANGUAGE, true);
92 addParameter(DOCUMENT, true);
93 addParameter(DOCUMENT_TYPE, true);
94 addParameter(START_PAGE, false);
95 addParameter(S_START_PAGE, false);
96 // should the following two just be in doc action??
97 addParameter(HREF, false);
98 addParameter(RELATIVE_LINK, false);
99 addParameter(OUTPUT, false);
100 addParameter(SERVICE, false);
101 addParameter(PROCESS_ID, true);
102 addParameter(SYSTEM_SUBSET, false);
103 addParameter(SYSTEM_CLUSTER, false);
104 addParameter(SYSTEM_MODULE_NAME, false);
105 addParameter(SYSTEM_MODULE_TYPE, false);
106 addParameter(INLINE_TEMPLATE, false);
107 addParameter(DISPLAY_METADATA, false);
108 addParameter(AJAX_LOAD_BYPASS, false);
109 addParameter(DOC_EDIT, false);
110 addParameter(PASSWORD, false);
111 addParameter(S_PASSWORD, false);
112 addParameter(S_NEW_PASSWORD, false);
113 addParameter(S_OLD_PASSWORD, false);
114
115 addParameter(COLLECTION_TYPE, true);
116 addParameter(EXTERNAL_LINK_TYPE, false);
117 // filtering args must be specified each time
118 addParameter(EXCERPT_ID, false);
119 addParameter(EXCERPT_TAG, false);
120 }
121
122 public boolean addParameter(String name, boolean save)
123 {
124 return addParameter(name, "", save);
125 }
126
127 public boolean addParameter(String name, String default_value, boolean save)
128 {
129 if (this.param_map.containsKey(name))
130 {
131 // already there so could not add
132 return false;
133 }
134
135 this.param_map.put(name, new Param(default_value, save));
136 return true;
137 }
138
139 public boolean setParamDefault(String name, String default_value)
140 {
141 Param p = this.param_map.get(name);
142 if (p == null)
143 return false;
144 p.default_value = default_value;
145 return true;
146 }
147
148 public boolean shouldSave(String name)
149 {
150 // p. is used to store previous settings
151 if (name.startsWith("p."))
152 return false;
153 Param p = this.param_map.get(name);
154 if (p == null)
155 return true; // if things are not in here, always save.
156 return p.save;
157 }
158
159 private class Param
160 {
161
162 public String default_value = null;
163 public boolean save = true;
164
165 public Param(String default_value, boolean save)
166 {
167 this.default_value = default_value;
168 this.save = save;
169 }
170 }
171}
Note: See TracBrowser for help on using the repository browser.