Changeset 36977

Timestamp:

2022-12-07T12:07:30+13:00 (12 months ago)

Author:

kjdon

Message:

made service names public so we can use them from other classes rather than hard coding the names in those classes. added ValidateDocumentId service - basically shecks whether the supplied id or list of ids is/are valid

File:

• main/trunk/greenstone3/src/java/org/greenstone/gsdl3/service/AbstractDocumentRetrieve.java (modified) (5 diffs)

main/trunk/greenstone3/src/java/org/greenstone/gsdl3/service/AbstractDocumentRetrieve.java

@@ -27 +27 @@
 import org.greenstone.gsdl3.util.BasicDocument;
 import org.greenstone.gsdl3.util.GSXML;
+import org.greenstone.gsdl3.util.GSParams;
 import org.greenstone.gsdl3.util.GSPath;
 import org.greenstone.gsdl3.util.MacroResolver;
@@ -42 +43 @@
 // General Java classes
 import java.io.File;
+import java.io.Serializable;
 import java.util.StringTokenizer;
 import java.util.Set;
 import java.util.Iterator;
 import java.util.ArrayList;
+import java.util.HashMap;
 
 import org.apache.log4j.*;
@@ -58 +61 @@
 
     // the services on offer
-    protected static final String DOCUMENT_STRUCTURE_RETRIEVE_SERVICE = "DocumentStructureRetrieve";
-    protected static final String DOCUMENT_METADATA_RETRIEVE_SERVICE = "DocumentMetadataRetrieve";
-    protected static final String DOCUMENT_CONTENT_RETRIEVE_SERVICE = "DocumentContentRetrieve";
-
+    public static final String DOCUMENT_STRUCTURE_RETRIEVE_SERVICE = "DocumentStructureRetrieve";
+    public static final String DOCUMENT_METADATA_RETRIEVE_SERVICE = "DocumentMetadataRetrieve";
+    public static final String DOCUMENT_CONTENT_RETRIEVE_SERVICE = "DocumentContentRetrieve";
+        public static final String VALIDATE_DOCUMENT_ID_SERVICE = "ValidateDocumentId";
     protected static final String STRUCT_PARAM = "structure";
     protected static final String INFO_PARAM = "info";
@@ -105 +108 @@
         this.config_info = info;
 
+                Element vdi_service = this.desc_doc.createElement(GSXML.SERVICE_ELEM);
+                vdi_service.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_RETRIEVE);
+                vdi_service.setAttribute(GSXML.NAME_ATT, VALIDATE_DOCUMENT_ID_SERVICE);
+                this.short_service_info.appendChild(vdi_service);
+        
+
         // set up short_service_info_ - for now just has name and type
         if (does_structure)
@@ -190 +199 @@
     }
 
+  /** this request needs to come with a documentNodeList, or a d paramter 
+   *  it returns a documentNodeList, with all document nodes marked with valid=true/false
+  */
+  
+  protected Element processValidateDocumentId(Element request) {
+    Document result_doc = XMLConverter.newDOM();
+    Element result = result_doc.createElement(GSXML.RESPONSE_ELEM);
+    String lang = request.getAttribute(GSXML.LANG_ATT);
+    result.setAttribute(GSXML.FROM_ATT, VALIDATE_DOCUMENT_ID_SERVICE);
+    result.setAttribute(GSXML.TYPE_ATT, GSXML.REQUEST_TYPE_PROCESS);
+
+    // Get the documents
+    boolean has_doc_info = false;
+    Element request_node_list = (Element) GSXML.getChildByTagName(request, GSXML.DOC_NODE_ELEM + GSXML.LIST_MODIFIER);
+    if (request_node_list == null)
+    {
+      // maybe we have a document param
+      Element param_list = (Element) GSXML.getChildByTagName(request, GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
+      if (param_list != null) {
+        HashMap<String, Serializable> params = GSXML.extractParams(param_list, false, GSParams.DOCUMENT);
+        String doc_id = (String)params.get(GSParams.DOCUMENT);
+        if (doc_id!=null && !doc_id.equals("")) {
+          // generate a doc node list
+          request_node_list = result_doc.createElement(GSXML.DOC_NODE_ELEM + GSXML.LIST_MODIFIER);
+          Element current_doc = result_doc.createElement(GSXML.DOC_NODE_ELEM);
+          current_doc.setAttribute(GSXML.NODE_ID_ATT, doc_id);
+          request_node_list.appendChild(current_doc);
+          has_doc_info = true;
+        }
+      }
+    } else {
+      has_doc_info = true;
+    }
+    if (has_doc_info == false) {
+        GSXML.addError(result, VALIDATE_DOCUMENT_ID_SERVICE + ": missing doc id info.  Request must contain either " + GSXML.DOC_NODE_ELEM + GSXML.LIST_MODIFIER+" or "+GSParams.DOCUMENT+" parameter.", GSXML.ERROR_TYPE_SYNTAX);
+      return result;
+    }
+    // copy the request doc node list to the response
+    Element response_node_list = (Element) result_doc.importNode(request_node_list, true);
+    result.appendChild(response_node_list);
+
+    NodeList doc_nodes = GSXML.getChildrenByTagName(response_node_list, GSXML.DOC_NODE_ELEM);
+    if (doc_nodes.getLength() == 0)
+    {
+      GSXML.addError(result, VALIDATE_DOCUMENT_ID_SERVICE+": no " + GSXML.DOC_NODE_ELEM + " found in the " + GSXML.DOC_NODE_ELEM + GSXML.LIST_MODIFIER, GSXML.ERROR_TYPE_SYNTAX);
+      return result;
+    }
+
+    // Whew, now we have checked (almost) all the syntax of the request, now we can process it.
+    for (int i = 0; i < doc_nodes.getLength(); i++)
+    {
+      Element doc_node = (Element) doc_nodes.item(i);
+      String node_id = doc_node.getAttribute(GSXML.NODE_ID_ATT);
+      if (this.gs_doc.isValidOID(node_id)) {
+        doc_node.setAttribute("valid", "true");
+      }
+      else {
+        doc_node.setAttribute("valid", "false");
+      }
+    }
+    return result;
+
+  }
     protected Element processDocumentMetadataRetrieve(Element request)
     {