Changeset 4023

Timestamp:

2003-03-28T09:55:57+12:00 (21 years ago)

Author:

kjdon

Message:

added in stuff for using enrich services to markup the documents

File:

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

trunk/gsdl3/src/java/org/greenstone/gsdl3/action/DocumentAction.java

@@ -41 +41 @@
     public static final String SIBLING_ARG = "sib";
 
+    /** if this is set to true, when a document is displayed, any annotation
+     * type services (enrich) will be offered to the user as well */
+    protected static final boolean provide_annotations = true;
+
     /* add the action specific args to the cgi param list
      */
@@ -52 +56 @@
     // for now, no subaction eventually we may want to have subactions such as text assoc or something ?
     
+    // check that  the stylesheet is present
+    String stylesheet = GSFile.stylesheetFile(config_, "document.xsl");
+    if (stylesheet == null) {
+        System.err.println("DocumentAction Error: document stylesheet not found!");
+        return null;
+    }
+
     // get the request - assume only one
     Element request = (Element)GSXML.getChildByTagName(message, GSXML.REQUEST_ELEM);
@@ -58 +69 @@
 
     String collection = (String) params.get(GSCGI.COLLECTION_ARG);
-    String to;
+    String lang = request.getAttribute(GSXML.LANG_ATT);
     String document_name = (String) params.get(GSCGI.DOCUMENT_ARG);
     if (document_name == null || document_name.equals("")) {
@@ -64 +75 @@
         return null;
     }
+
     //whether to retrieve siblings or not
     boolean get_siblings = false;
@@ -71 +83 @@
     }
     
+    // Create the return page tree
+    Element page = doc_.createElement(GSXML.PAGE_ELEM);
+    page.setAttribute(GSXML.LANG_ATT, lang);
+
+    // Add the display element, config stuff, and original request from the message
+    page.appendChild(doc_.importNode(GSXML.getChildByTagName(message, GSXML.DISPLAY_ELEM), true));
+    page.appendChild(doc_.importNode(GSXML.getChildByTagName(message, GSXML.CONFIGURATION_ELEM), true));
+    Element page_request = GSXML.duplicateWithNewName(doc_, request, GSXML.PAGE_REQUEST_ELEM, true);
+    page.appendChild(page_request);
+    // the element for all the response data
+    Element page_response = doc_.createElement(GSXML.PAGE_RESPONSE_ELEM);
+    page.appendChild(page_response);
+
+    // get the additional data needed for the page
+    getBackgroundData(page_response, collection, lang);
+
+    // the_document is where all the doc info - structure and metadata etc
+    //-  is added into, to be returned in the page
+    Element the_document = doc_.createElement(GSXML.DOCUMENT_ELEM);
+    page_response.appendChild(the_document);
+
+    
     // Build a request to obtain the document structure
     Element ds_message = doc_.createElement(GSXML.MESSAGE_ELEM);
-    Element ds_request = doc_.createElement(GSXML.REQUEST_ELEM);
+    String to = GSPath.appendLink(collection, "DocumentStructureRetrieve");  // Hard-wired?
+    Element ds_request = GSXML.createBasicRequest(doc_,GSXML.REQUEST_TYPE_PROCESS, to, lang); 
     ds_message.appendChild(ds_request);
-    to = GSPath.appendLink(collection, "DocumentStructureRetrieve");  // Hard-wired?
-    ds_request.setAttribute(GSXML.TO_ATT, to);
-    ds_request.setAttribute(GSXML.TYPE_ATT, GSXML.REQUEST_TYPE_PROCESS);
-    ds_request.setAttribute(GSXML.LANG_ATT, request.getAttribute(GSXML.LANG_ATT));
 
     // Create a parameter list to specify the required structure information
@@ -115 +146 @@
     Element ds_response_structure = (Element) GSXML.getNodeByPath(ds_response_message, path);
 
-    // the_document is where all the extra info is added into, to be returned in the page
-    Element the_document = doc_.createElement(GSXML.DOCUMENT_ELEM);
     // add the contents of the structure bit into the_document
     NodeList structs = ds_response_structure.getChildNodes();
@@ -125 +154 @@
     // Build a request to obtain some document metadata
     Element dm_message = doc_.createElement(GSXML.MESSAGE_ELEM);
-    Element dm_request = doc_.createElement(GSXML.REQUEST_ELEM);
+    to = GSPath.appendLink(collection, "DocumentMetadataRetrieve");  // Hard-wired?
+    Element dm_request = GSXML.createBasicRequest(doc_, GSXML.REQUEST_TYPE_PROCESS, to, lang);
     dm_message.appendChild(dm_request);
-    to = GSPath.appendLink(collection, "DocumentMetadataRetrieve");  // Hard-wired?
-    dm_request.setAttribute(GSXML.TO_ATT, to);
-    dm_request.setAttribute(GSXML.TYPE_ATT, GSXML.REQUEST_TYPE_PROCESS);
-    dm_request.setAttribute(GSXML.LANG_ATT, request.getAttribute(GSXML.LANG_ATT));
-
     // Create a parameter list to specify the required metadata information
     // for now get Title
@@ -175 +200 @@
     // Build a request to obtain some document content
     Element dc_message = doc_.createElement(GSXML.MESSAGE_ELEM);
-    Element dc_request = doc_.createElement(GSXML.REQUEST_ELEM);
+    to = GSPath.appendLink(collection, "DocumentContentRetrieve");  // Hard-wired?
+    Element dc_request = GSXML.createBasicRequest(doc_, GSXML.REQUEST_TYPE_PROCESS, to, lang);
     dc_message.appendChild(dc_request);
-    to = GSPath.appendLink(collection, "DocumentContentRetrieve");  // Hard-wired?
-    dc_request.setAttribute(GSXML.TO_ATT, to);
-    dc_request.setAttribute(GSXML.TYPE_ATT, GSXML.REQUEST_TYPE_PROCESS);
-    dc_request.setAttribute(GSXML.LANG_ATT, request.getAttribute(GSXML.LANG_ATT));
+    
 
     // Create a parameter list to specify the request parameters - empty for now
@@ -193 +216 @@
     path = GSPath.appendLink(path, GSXML.DOC_NODE_ELEM);
     Element dc_response_doc = (Element) GSXML.getNodeByPath(dc_response_message, path);
-    //path = GSPath.appendLink(path, GSXML.DOC_NODE_CONTENT_ELEM);
     Element dc_response_doc_content = (Element) GSXML.getChildByTagName(dc_response_doc, GSXML.NODE_CONTENT_ELEM);
+    if (provide_annotations) {
+        // now we can modifiy the response doc if needed
+        String enrich_service = (String)params.get(GSCGI.SERVICE_ARG);
+        if (enrich_service != null && !enrich_service.equals("")) {
+        // send a message to the service
+        Element enrich_message = doc_.createElement(GSXML.MESSAGE_ELEM);
+        Element enrich_request = GSXML.createBasicRequest(doc_, GSXML.REQUEST_TYPE_PROCESS, enrich_service, lang);
+        enrich_message.appendChild(enrich_request);
+        Element enrich_pl = getServiceParamList(cgi_paramList);
+        enrich_request.appendChild(enrich_pl);
+        Element doc_list = doc_.createElement(GSXML.DOC_NODE_ELEM+GSXML.LIST_MODIFIER);
+        enrich_request.appendChild(doc_list);
+        doc_list.appendChild(doc_.importNode(dc_response_doc, true));
+        
+        Element enrich_response = mr_.process(enrich_message);
+        
+        String [] links = {GSXML.RESPONSE_ELEM, GSXML.DOC_NODE_ELEM+GSXML.LIST_MODIFIER, GSXML.DOC_NODE_ELEM, GSXML.NODE_CONTENT_ELEM};
+        path = GSPath.createPath(links);
+        System.out.println("enrich path = "+path);
+
+        //appendLink(GSXML.RESPONSE_ELEM, GSXML.DOC_NODE_ELEM+GSXML.LIST_MODIFIER);
+        //path = GSPath.appendLink(GSXML.DOC_NODE_ELEM
+        dc_response_doc_content = (Element)GSXML.getNodeByPath(enrich_response, path);
+        } 
+    }
     // use the returned id rather than the sent one cos there may have
     // been modifiers such as .pr that are removed.
     String modified_doc_id = dc_response_doc.getAttribute(GSXML.NODE_ID_ATT);
+    the_document.setAttribute("selectedNode", modified_doc_id);
     // Merge the document content with the metadata and structure information
     for (int i = 0; i < doc_nodes.getLength(); i++) {
@@ -209 +257 @@
     }
 
-    // Create the return page tree
-    Element page = doc_.createElement(GSXML.PAGE_ELEM);
-    page.setAttribute(GSXML.LANG_ATT, request.getAttribute(GSXML.LANG_ATT));
-
-    // Add the display element, config stuff, and original request from the message
-    page.appendChild(doc_.importNode(GSXML.getChildByTagName(message, GSXML.DISPLAY_ELEM), true));
-    page.appendChild(doc_.importNode(GSXML.getChildByTagName(message, GSXML.CONFIGURATION_ELEM), true));
-    Element page_request = GSXML.duplicateWithNewName(doc_, request, "pageRequest", true);
-    page.appendChild(page_request);
-
-    // get the collection or cluster description - for the httpAddress type metadata
-    Element coll_about_message = doc_.createElement(GSXML.MESSAGE_ELEM);
-    Element coll_about_request = GSXML.createBasicRequest(doc_, GSXML.REQUEST_TYPE_DESCRIBE,  collection, page.getAttribute(GSXML.LANG_ATT));
-    coll_about_message.appendChild(coll_about_request);
-    Element coll_about_response = (Element)mr_.process(coll_about_message);
-
-    // add the response to the page 
-    Element response = (Element) GSXML.getChildByTagName(coll_about_response, GSXML.RESPONSE_ELEM);
-    Element page_response = GSXML.duplicateWithNewName(doc_, response, "pageResponse", false);
-    page_response.appendChild(the_document);
-
-    // Add the results of the action to the page
-    page.appendChild(page_response);
-    System.out.println("Page:\n" + converter_.getPrettyString(page));
-
-    // Finally, process using the stylesheet, and return
-    String stylesheet = GSFile.stylesheetFile(config_, "document.xsl");
-    if (stylesheet == null) {
-        System.err.println("DocumentAction Error: document stylesheet not found!");
-        return null;
-    }
 
     Document style_doc = converter_.getDOM(new File(stylesheet));
@@ -245 +262 @@
     return (Element) transformer_.transform(style_doc, page);    
     }
+
+    protected Element getServiceParamList(Element cgi_param_list) {
+
+    Element new_param_list = doc_.createElement(GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
+    Element param;
+    NodeList cgi_params = cgi_param_list.getChildNodes();
+    for (int i=0; i<cgi_params.getLength(); i++) {
+        Element p = (Element) cgi_params.item(i);
+        String name = p.getAttribute(GSXML.NAME_ATT);
+        if (name.equals(GSCGI.SERVICE_ARG) || name.equals(GSCGI.REQUEST_TYPE_ARG) || name.equals(GSCGI.CLUSTER_ARG) || name.equals(GSCGI.DOCUMENT_ARG) || name.equals(SIBLING_ARG) ) {
+        continue;
+        }
+        // esle add it in to the list
+        new_param_list.appendChild(doc_.importNode(p, true));
+    }
+    return new_param_list;
+    }
+
+    /** this method gets the collection description, the format info, the
+     * list of enrich services, etc - stuff that is needed for the page,
+     * but is the same whatever the query is - should be cached */
+    protected  boolean getBackgroundData(Element page_response, 
+                     String collection, String lang) {
+
+    // create a message to process - contains requests for the collection 
+    // description, the format element, the enrich services on offer
+    // these could all be cached
+    Element info_message = doc_.createElement(GSXML.MESSAGE_ELEM);
+
+    // the collection request
+    Element coll_about_request = GSXML.createBasicRequest(doc_, GSXML.REQUEST_TYPE_DESCRIBE,  collection, lang);
+    info_message.appendChild(coll_about_request);
+
+    // the format request - ignore for now, where does this request go to??
+    //Element format_request = GSXML.createBasicRequest(doc_, GSXML.REQUEST_TYPE_FORMAT, ???, lang);
+    //info_message.appendChild(format_request);
+
+    // the enrich_services request - only do this if provide_annotations is true
+
+    if (provide_annotations) {
+        Element enrich_services_request = GSXML.createBasicRequest(doc_, GSXML.REQUEST_TYPE_DESCRIBE, "", lang);
+        enrich_services_request.setAttribute(GSXML.INFO_ATT, "serviceList");
+        info_message.appendChild(enrich_services_request);
+    }
+    
+    Element info_response = (Element)mr_.process(info_message);
+
+    // the collection is the first response
+    NodeList responses = info_response.getElementsByTagName(GSXML.RESPONSE_ELEM);
+    Element coll_resp = (Element)responses.item(0);
+    page_response.appendChild(doc_.importNode(GSXML.getChildByTagName(coll_resp, GSXML.COLLECTION_ELEM), true));
+    
+    //Element format_resp = (Element) responses.item(1);
+    //page_reponse.appendChild(doc_.importNode(GSXML.getChildByTagName(format_resp, GSXML.FORMAT_ELEM), true));
+    
+
+    if (provide_annotations) {
+        Element services_resp = (Element)responses.item(1); // change when format request added in
+
+        // a new message for the mr
+        Element enrich_message = doc_.createElement(GSXML.MESSAGE_ELEM);
+        
+        NodeList e_services = services_resp.getElementsByTagName(GSXML.SERVICE_ELEM);
+        boolean service_found = false;
+        for (int j=0; j<e_services.getLength(); j++) {
+        if (((Element)e_services.item(j)).getAttribute(GSXML.TYPE_ATT).equals("enrich")) {
+            Element s = GSXML.createBasicRequest(doc_, GSXML.REQUEST_TYPE_DESCRIBE, ((Element)e_services.item(j)).getAttribute(GSXML.NAME_ATT), lang);
+            enrich_message.appendChild(s);
+            service_found = true;
+        }
+        }
+        if (service_found) {
+        Element enrich_response = mr_.process(enrich_message);
+
+        e_services = enrich_response.getElementsByTagName(GSXML.SERVICE_ELEM);
+        Element service_list = doc_.createElement(GSXML.SERVICE_ELEM + GSXML.LIST_MODIFIER);
+        for (int i=0; i<e_services.getLength(); i++) {
+            Element pl = (Element)GSXML.getChildByTagName(e_services.item(i), GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
+            if (pl != null) {
+            // add short names to the params in the param list
+            cgi_.paramListAddShortNames(pl);
+            }
+            service_list.appendChild(doc_.importNode(e_services.item(i), true));
+        }
+        page_response.appendChild(service_list);
+        }
+    } // if provide_annotations
+    return true;
+        
+    }
 }