Changeset 32446 for main/trunk

Timestamp:

2018-09-13T13:55:17+12:00 (6 years ago)

Author:

kjdon

Message:

overhaul of params class. default is now to not save - add params to teh object if they are needed to be saved. separate map for service params so we don't need to store s1.xxx as well as xxx. there are only a few global params listed in the class now. actions will add their own ones, and services also will add their own ones.

File:

• main/trunk/greenstone3/src/java/org/greenstone/gsdl3/util/GSParams.java (modified) (7 diffs)

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

@@ -21 +21 @@
 import java.util.HashMap;
 
+import org.apache.log4j.Logger;
+
 /** keeps track of the servlet parameters, and their defaults */
 public class GSParams
 {
 
+  static Logger logger = Logger.getLogger(org.greenstone.gsdl3.util.GSParams.class.getName());
     // cgi parameter names
     public static final String ACTION = "a"; // the major type of action- eg query or browse or process
@@ -43 +46 @@
     public static final String DOCUMENT = "d";
     public static final String DOCUMENT_TYPE = "dt";
-    public static final String START_PAGE = "startPage";
-    public static final String S_START_PAGE = "s1.startPage";
     public static final String HREF = "href"; // url. might be an external url, or a relative one that needs translating
     public static final String RELATIVE_LINK = "rl"; // whether the href url is relative to the collection or not.
@@ -51 +52 @@
 
     public static final String HTTP_HEADER_FIELDS = "hhf";
-    public static final String QUICK_SEARCH = "qs";
 
     // internal configure args
@@ -64 +64 @@
 
     public static final String INLINE_TEMPLATE = "ilt";
-    public static final String DISPLAY_METADATA = "dmd";
     public static final String FILE_LOCATION = "fl";
-    public static final String DOC_EDIT = "docEdit";
-    public static final String AJAX_LOAD_BYPASS = "alb";
-
-  // document display args
-  public static final String EXPAND_DOCUMENT = "ed";
-  public static final String EXPAND_CONTENTS = "ec";
-  public static final String NO_TEXT = "noText";
   
     //Administration
-    public static final String PASSWORD = "password";
-    public static final String S_PASSWORD = "s1.password";
-    public static final String S_NEW_PASSWORD = "s1.newPassword";
-    public static final String S_OLD_PASSWORD = "s1.oldPassword";
-  public static final String S_NEW_EMAIL="s1.newEmail";
-    public static final String S_NEW_USERNAME = "s1.newUsername";
-    public static final String S_PREV_USERNAME = "s1.prevUsername";
-
-  // Authentication
-  public static final String S_RECAPTCHA_RESPONSE = "s1.g-recaptcha-response";
-  public static final String S_USERNAME = "s1.username";
-  public static final String S_EMAIL = "s1.email";
-    //Facets
-    public static final String S_FACETS = "s1.facets";
-    public static final String S_FACETS_QUERIES = "s1.facetQueries";
+        public static final String PASSWORD = "password";
+        public static final String USERNAME = "username";
+        public static final String LOGOUT = "logout";
 
     // some standard arg values
@@ -102 +82 @@
     public static final String DEBUG = "debug";
 
-    protected HashMap<String, Param> param_map = null;
+  public static final String SERVICE_PREFIX = "s1";
+  public static final String PREVIOUS_PREFIX = "p";
+  public static final String MD_PREFIX = "md___";
+
+  public static final String SERVICE_PARAM_REGEX = "^s\\d\\..*";
+  
+  protected HashMap<String, Param> param_map = null;
+  protected HashMap<String, Param> service_param_map = null;
 
     public GSParams()
     {
         this.param_map = new HashMap<String, Param>(30);
-
-        // add in all the standard params
-        addParameter(ACTION, false);
-        addParameter(SUBACTION, false);
-        addParameter(REQUEST_TYPE, false);
-        addParameter(RESPONSE_ONLY, false);
-        addParameter(CLUSTER, false); // we don't want to save cluster/collection 
+        this.service_param_map =  new HashMap<String, Param>(30);
+
+        // we now only need to add in the ones that need saving, as we will default to "not save"
         addParameter(LANGUAGE, true);
         addParameter(DOCUMENT, true);
-        addParameter(DOCUMENT_TYPE, false);
-        addParameter(QUICK_SEARCH, false);
-        addParameter(START_PAGE, false);
-        addParameter(S_START_PAGE, false);
-        // should the following two just be in doc action??
-        addParameter(HREF, false);
-        addParameter(RELATIVE_LINK, false);
-        addParameter(OUTPUT, false);
-        addParameter(SERVICE, false);
         addParameter(PROCESS_ID, true);
-        addParameter(SYSTEM_SUBSET, false);
-        addParameter(SYSTEM_CLUSTER, false);
-        addParameter(SYSTEM_MODULE_NAME, false);
-        addParameter(SYSTEM_MODULE_TYPE, false);
-        addParameter(INLINE_TEMPLATE, false);
-        addParameter(DISPLAY_METADATA, false);
-        addParameter(AJAX_LOAD_BYPASS, false);
-        addParameter(EXPAND_DOCUMENT, false);
-        addParameter(EXPAND_CONTENTS, false);
-        addParameter(NO_TEXT, false);
-        addParameter(DOC_EDIT, false);
+        addParameter(COLLECTION_TYPE, true);
+        addParameter(DEBUG, true);
+
+        // password is sensitive. don't save, but also don't return it in the page response
         addParameter(PASSWORD, false, true);
-        addParameter(S_PASSWORD, false, true);
-        addParameter(S_NEW_PASSWORD, false, true);
-        addParameter(S_OLD_PASSWORD, false, true);
-        addParameter(S_RECAPTCHA_RESPONSE, false, true);
-        addParameter(S_USERNAME, false);
-        addParameter(S_EMAIL, false);
-        addParameter(S_NEW_USERNAME, false);
-        addParameter(S_PREV_USERNAME, false);
-        addParameter(S_NEW_EMAIL, false);
-        addParameter(S_FACETS, false);
-        addParameter(S_FACETS_QUERIES, false);
-
-        addParameter(COLLECTION_TYPE, true);
-        addParameter(EXTERNAL_LINK_TYPE, false);
-        // filtering args must be specified each time
-        addParameter(EXCERPT_ID, false);
-        addParameter(EXCERPT_TAG, false);
         
-        addParameter(DEBUG, true);
     }
 
@@ -185 +134 @@
     }
 
+  public boolean addServiceParameter(String name, String default_value, boolean save, boolean sensitive) {
+    if (this.service_param_map.containsKey(name)) {
+      // already there, could not add
+      return false;
+    }
+    this.service_param_map.put(name, new Param(default_value, save, sensitive));
+    return true;
+  }
+    
+   
     public boolean setParamDefault(String name, String default_value)
     {
@@ -197 +156 @@
     {
         // p. is used to store previous settings
-        if (name.startsWith("p.") || name.startsWith("md___"))
-            return false;
-        Param p = this.param_map.get(name);
-        if (p == null)
-            return true; // if things are not in here, always save.
+        if (name.startsWith(PREVIOUS_PREFIX+".") || name.startsWith(MD_PREFIX))
+            return false;
+        Param p;
+        if (name.matches(SERVICE_PARAM_REGEX)) {
+          // its a service param
+          p = this.service_param_map.get(name.substring(3));
+        } else {
+          // an ordinary param
+          p = this.param_map.get(name);
+        }
+        if (p==null) {
+          return false; // never save unknown params
+        }
         return p.save;
     }
+        
 
   public boolean isSensitive(String name) {
-    Param p = this.param_map.get(name);
+    Param p;
+    if (name.matches(SERVICE_PARAM_REGEX)) {
+      p = this.service_param_map.get(name.substring(3));
+    } else {
+      p = this.param_map.get(name);
+    }
     if (p==null) {
       return false;