Changeset 4259

Timestamp:

2003-05-08T16:17:29+12:00 (21 years ago)

Author:

kjdon

Message:

LibraryServlet now caches cgi args, and adds them into the request

File:

• trunk/gsdl3/src/java/org/greenstone/gsdl3/LibraryServlet.java (modified) (11 diffs)

trunk/gsdl3/src/java/org/greenstone/gsdl3/LibraryServlet.java

@@ -6 +6 @@
 import org.w3c.dom.Document;
 import org.w3c.dom.Element;
+import org.w3c.dom.NodeList;
 import java.io.*;
 import javax.servlet.*;
@@ -25 +26 @@
     
     /** the receptionist to send messages to */
-    protected Receptionist recept_=null;
+    protected WebReceptionist recept=null;
     /** the default language - is specified by setting a servlet param,
-     * otherwise DEFUALT_LANG is used*/
-    protected String default_lang_= null;
+     * otherwise DEFAULT_LANG is used*/
+    protected String default_lang= null;
     /** The default default - used if a default lang is not specified 
      * in the servlet params */
     protected final String DEFAULT_LANG = "en";
     /** container Document to create XML Nodes */
-    protected Document doc_=null;    
+    protected Document doc=null;    
     /** a converter class to parse XML and create Docs */
-    protected XMLConverter converter_=null;
-
+    protected XMLConverter converter=null;
+    /** the cgi stuff - the Receptionist can add new args to this
+     * its used by the servlet to determine what args to save */
+    protected GSCGI cgi = null;
     /** initialise the servlet
      */
@@ -48 +51 @@
     String site_name = config.getInitParameter("sitename");
     String interface_name = config.getInitParameter("interfacename");
-    default_lang_ = config.getInitParameter("defaultlang");
+    this.default_lang = config.getInitParameter("defaultlang");
     if (library_name == null || gsdl3_home == null || site_name ==null ||  interface_name ==null) {
         // must have this
@@ -56 +59 @@
     }
 
-    if (default_lang_ == null) {
+    if (this.default_lang == null) {
         // choose english
-        default_lang_ = DEFAULT_LANG;
+        this.default_lang = DEFAULT_LANG;
     }
 
@@ -65 +68 @@
     config_vars.site_name_ = site_name;
     config_vars.interface_name_ =interface_name;
-    config_vars.default_language_ = default_lang_;
+    config_vars.default_language_ = this.default_lang;
     config_vars.createXML();
     
-    converter_ = new XMLConverter();
-    doc_ = converter_.newDOM();
-
+    this.converter = new XMLConverter();
+    this.doc = this.converter.newDOM();
+    
     // now try and create MR and recpt
     // new message router - create it and pass reference to recept.
@@ -85 +88 @@
         e.printStackTrace();
         message_router = new MessageRouter();
-        }
-        
-    }
+        }   
+    }
+    
     message_router.setSiteHome(GSFile.siteHome(config_vars.gsdl3_home_, 
                            config_vars.site_name_));
@@ -95 +98 @@
     String recept_name = (String)config.getInitParameter("receptionist");
     if (recept_name == null) {
-        recept_ = new Receptionist();
+        this.recept = new DefaultReceptionist();
     } else {
         try {
-        recept_ = (Receptionist)Class.forName("org.greenstone.gsdl3.core."+recept_name).newInstance();
+        this.recept = (WebReceptionist)Class.forName("org.greenstone.gsdl3.core."+recept_name).newInstance();
         } catch (Exception e) { // cant use this new one, so use normal one
         System.out.println("LibraryServlet configure exception when trying to use a new Receptionist "+recept_name+": "+e.getMessage());
         e.printStackTrace();
-        recept_ = new Receptionist();
-        }
-    }
-    recept_.setConfigVars(config_vars);
-    recept_.setMessageRouter(message_router);
-    recept_.configure();
-    
+        this.recept = new DefaultReceptionist();
+        }
+    }
+    this.recept.setConfigVars(config_vars);
+    this.recept.setMessageRouter(message_router);
+    this.recept.configure();
+    // the cgi arg thingy
+    
+    String cgi_name = (String)config.getInitParameter("cgiargs");
+    if (cgi_name == null) {
+        this.cgi = new GSCGI();
+    } else {
+        try {
+        this.cgi = (GSCGI)Class.forName("org.greenstone.gsdl3.util."+cgi_name).newInstance();
+        } catch (Exception e) {
+        System.out.println("LibraryServlet configure exception when trying to use a new cgi thing "+cgi_name+": "+e.getMessage());
+        e.printStackTrace();
+        this.cgi = new GSCGI();
+        }
+    }
+    // pass it to the receptionist
+    this.recept.setCGI(this.cgi);
     }
     
@@ -115 +133 @@
     throws ServletException, IOException {
     
+    HttpSession session = request.getSession(true);
+
+    // print them out to test it
+//      Enumeration stored_names = session.getAttributeNames();
+//      System.out.println("session values are:");
+//      while (stored_names.hasMoreElements()) {
+//          String name = (String)stored_names.nextElement();
+//          System.out.println("stored "+name+":" +session.getAttribute(name));
+//      }
+
     request.setCharacterEncoding("UTF-8");
     response.setContentType("text/html;charset=UTF-8");
@@ -121 +149 @@
     String lang = request.getParameter(GSCGI.LANGUAGE_ARG);
     if (lang==null || lang.equals("")) {
-        lang = default_lang_; // the default
-    }
+        // try the session cached lang
+        lang = (String)session.getAttribute(GSCGI.LANGUAGE_ARG);
+        if (lang==null || lang.equals("")) {
+        // still not set, use the default
+        lang = this.default_lang;
+        }
+    }
+    
+    // set the lang in the session
+    session.setAttribute(GSCGI.LANGUAGE_ARG, lang);
+
     String output = request.getParameter(GSCGI.OUTPUT_ARG);
     if (output==null || output.equals("")) {
@@ -129 +166 @@
 
     // the request to the receptionist  
-    Element xml_message = doc_.createElement(GSXML.MESSAGE_ELEM);
-    Element xml_request = doc_.createElement(GSXML.REQUEST_ELEM);
+    Element xml_message = this.doc.createElement(GSXML.MESSAGE_ELEM);
+    Element xml_request = GSXML.createBasicRequest(this.doc, GSXML.REQUEST_TYPE_CGI, "", lang);
+    xml_request.setAttribute(GSXML.OUTPUT_ATT, output);
     xml_message.appendChild(xml_request);
-    xml_request.setAttribute(GSXML.LANG_ATT, lang);
-    xml_request.setAttribute(GSXML.TYPE_ATT, GSXML.REQUEST_TYPE_CGI);
-    xml_request.setAttribute(GSXML.OUTPUT_ATT, output);
+    
     
     String action = request.getParameter(GSCGI.ACTION_ARG);
@@ -146 +182 @@
         xml_request.setAttribute(GSXML.SUBACTION_ATT, subaction);
         
-        Element xml_result = recept_.process(xml_message);
-        out.println(converter_.getString(xml_result));
-        return;
-    } 
-    
-    xml_request.setAttribute(GSXML.ACTION_ATT, action);
-    if (subaction != null) {
-        xml_request.setAttribute(GSXML.SUBACTION_ATT, subaction);
-    }
-    Element xml_param_list = doc_.createElement(GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
-    xml_request.appendChild(xml_param_list);
-    Enumeration params = request.getParameterNames();
-    while(params.hasMoreElements()) {
-        String name = (String)params.nextElement();
-        if (!name.equals(GSCGI.ACTION_ARG) && !name.equals(GSCGI.SUBACTION_ARG) && !name.equals(GSCGI.LANGUAGE_ARG) && !name.equals(GSCGI.OUTPUT_ARG)) { // these ones are in the header so leave out
-        String value="";
-        String []values = request.getParameterValues(name);
-        value = values[0];
-        if (values.length > 1) {
-            for (int i=1; i< values.length; i++) {
-            value += ","+values[i];
+    } else {
+    
+        xml_request.setAttribute(GSXML.ACTION_ATT, action);
+        if (subaction != null) {
+        xml_request.setAttribute(GSXML.SUBACTION_ATT, subaction);
+        }
+
+        //  create the param list for the greenstone request - includes
+        // the params from the current request and any others from the saved session
+        Element xml_param_list = this.doc.createElement(GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
+        xml_request.appendChild(xml_param_list);
+        
+        Enumeration params = request.getParameterNames();
+        while(params.hasMoreElements()) {
+        String name = (String)params.nextElement();
+        if (!name.equals(GSCGI.ACTION_ARG) && !name.equals(GSCGI.SUBACTION_ARG) && !name.equals(GSCGI.LANGUAGE_ARG) && !name.equals(GSCGI.OUTPUT_ARG)) {// we have already dealt with these 
+            String value="";
+            String [] values = request.getParameterValues(name);
+            value = values[0];
+            if (values.length > 1) {
+            for (int i=1; i< values.length; i++) {
+                value += ","+values[i];
+            }
+            }
+            // either add it to the param list straight away, or save it to the session and add it later
+            if (this.cgi.shouldSave(name)) {            
+            session.setAttribute(name, value);
+            } else { 
+            Element param = this.doc.createElement(GSXML.PARAM_ELEM);
+            param.setAttribute(GSXML.NAME_ATT, name);
+            param.setAttribute(GSXML.VALUE_ATT, GSXML.xmlSafe(value));
+            xml_param_list.appendChild(param);
             }
         }
-        Element param = doc_.createElement(GSXML.PARAM_ELEM);
-        param.setAttribute(GSXML.NAME_ATT, name);
-        param.setAttribute(GSXML.VALUE_ATT, GSXML.xmlSafe(value));
-        xml_param_list.appendChild(param);
+        }
+        
+        // put in all the params from the session cache
+        params = session.getAttributeNames();
+        while(params.hasMoreElements()) {
+        String name = (String)params.nextElement();
         
-        }
-    }
-
+        if ( !name.equals(GSCGI.LANGUAGE_ARG) ) { // lang is stored but we dont want it in the param list cos its already in the request
+            
+            Element param = this.doc.createElement(GSXML.PARAM_ELEM);
+            param.setAttribute(GSXML.NAME_ATT, name);
+            param.setAttribute(GSXML.VALUE_ATT, GSXML.xmlSafe((String)session.getAttribute(name)));
+            xml_param_list.appendChild(param);
+        }
+        }
+
+    
+    }
+    
     if (!output.equals("html")) {
         response.setContentType("text/xml"); // for now use text
     }
-    
-    Element xml_result = recept_.process(xml_message);
-    out.println(converter_.getPrettyString(xml_result));
+    
+    Element xml_result = this.recept.process(xml_message);
+    encodeURLs(xml_result, response);
+    out.println(this.converter.getPrettyString(xml_result));
+    }
+
+    /** this goes through each URL and adds in a session id if needed--
+     * its needed if the browser doesn't accept cookies
+     */
+    protected void encodeURLs(Element data, HttpServletResponse response) {
+
+    // get all the <a> elements
+    NodeList hrefs = data.getElementsByTagName("a");
+    for (int i=0; i<hrefs.getLength(); i++) {
+        Element a = (Element)hrefs.item(i);
+        a.setAttribute("href", response.encodeURL(a.getAttribute("href")));
+    }
+    
+    // now find any submit bits - get all the <form> elements
+    NodeList forms = data.getElementsByTagName("form");
+    for (int i=0; i<forms.getLength(); i++) {
+        Element form = (Element)forms.item(i);
+        form.setAttribute("action", response.encodeURL(form.getAttribute("action")));
+    }
+    // are these the only cases where URLs occur??
+    // we should only do this for greenstone urls?
+    
     }
 }