Changeset 36996

Timestamp:

2022-12-08T13:02:17+13:00 (12 months ago)

Author:

davidb

Message:

Changes in response to testing out the retrieval of a document sub-section image

Location:

gs3-extensions/iiif-servlet/trunk/src

Files:

• PREPARE-GSDL-AND-COMPILE-CORE.sh (modified) (1 diff)
• README.txt (modified) (4 diffs)
• gsdl-src/java/org/greenstone/gsdl3/IIIFServerBridge.java (modified) (3 diffs)
• gsdl-src/java/org/greenstone/gsdl3/service/IIIFPMH.java (modified) (2 diffs)

gs3-extensions/iiif-servlet/trunk/src/PREPARE-GSDL-AND-COMPILE-CORE.sh

@@ -28 +28 @@
 /bin/cp ../../build/gutil.jar packages/cantaloupe-$cversion/src/main/webapp/WEB-INF/lib/gutil.jar
 
+echo "Topping up with jdbm.jar, xalan.jar and serializer.jar into Cantaloupe's webapps/WEB-INF/lib/ directory"
+/bin/cp ../../web/WEB-INF/lib/jdbm.jar packages/cantaloupe-$cversion/src/main/webapp/WEB-INF/lib/.
+# The follow two JAR files are only needed if debugging by serializing an XML Node to a string
+/bin/cp ../../web/WEB-INF/lib/xalan.jar packages/cantaloupe-$cversion/src/main/webapp/WEB-INF/lib/.
+/bin/cp ../../web/WEB-INF/lib/serializer.jar packages/cantaloupe-$cversion/src/main/webapp/WEB-INF/lib/.
+
 echo
 echo "If first time run, or changes made to:"

gs3-extensions/iiif-servlet/trunk/src/README.txt

@@ -6 +6 @@
     ./COMPILE-CANTALOUPE.sh
 
-Bump to cantaloupe 4.03
+Bump to cantaloupe 4.03 (as some of the URLs of maven dependencies in the older version were no longer available)
 
 
 http://localhost:8383/gs-cantaloupe/
 http://localhost:8383/gs-cantaloupe/admin
-
 http://localhost:8383/gs-cantaloupe/iiif/2
 
@@ -17 +16 @@
 http://localhost/gs-cantaloupe/iiif/2/<site>:<col>:<docid>/info.json
 
-
-Add IIIFPMH service to collection
-
-cp web/WEB-INF/lib/jdbm.jar packages/tomcat/webapps/gs-cantaloupe/WEB-INF/lib/.
-
-http://atea.space:4343/gs-cantaloupe/iiif/2/intermuse:programmes:HASHc5edd00c6c45cc68ce9532/info.js
-
-http://atea.space:4343/gs-cantaloupe/iiif/2/intermuse:programmes:HASHc5edd00c6c45cc68ce9532/full/full/0/default.jpg
+http://localhost/gs-cantaloupe/iiif/2/<site>:<col>:<docid.subsection>/info.json
 
 
-=====
+Add IIIFPMH service to collectionConfig.xml:
+
+    <serviceRack name="IIIFPMH">
+        <setName>intermuseprogammes</setName>
+        <setDescription/><!-- uncomment the following and set the name attribute if 
+           you want this collection to be part of a super set. --><!--<oaiSuperSet name="xxx"/>-->
+        <ListMetadataFormats><!--What metadata sets to support for this collection. You can select any set that is specified in OAIConfig.xml. To use a new set, you need to add a set definition in OAIConfig.xml, then reference it here, like:
+               <metadataFormat metadataPrefix="prefix"/> -->
+            <metadataFormat metadataPrefix="oai_dc"><!-- you can customize the mappings by adding elements in here. See resources/oai/OAIConfig.xml for the format--></metadataFormat>
+        </ListMetadataFormats>
+    </serviceRack>
+
+(Note: the IIIF service was strongly based off OAIPMH)
+
+
+Example IIIF image server requests:
+
+  http://localhost:8383/gs-cantaloupe/iiif/2/intermuse:programmes:HASHc5edd00c6c45cc68ce9532/info.js
+  http://localhost:8383/gs-cantaloupe/iiif/2/intermuse:programmes:HASHc5edd00c6c45cc68ce9532/full/full/0/default.jpg
+
+
+For an image that is a sub-section:
+
+  http://localhost:8383/gs-cantaloupe/iiif/2/intermuse:programmes:HASHc5edd00c6c45cc68ce9532.1/info.js
+
+  http://localhost:8383/gs-cantaloupe/iiif/2/intermuse:programmes:HASHc5edd00c6c45cc68ce9532.1/full/full/0/default.jpg
 
 
@@ -40 +57 @@
      79      79    1405
 
+
+
+
+
+=====
+
 Might actually turn out to need to be:
 
@@ -50 +73 @@
 cp -i ./packages/tomcat/webapps/gs-cantaloupe/WEB-INF/classes/lib/jdbm.jar ./packages/tomcat/webapps/gs-cantaloupe/WEB-INF/lib/.
 popd
+
+
+
+=====
+
+# Deprecated
+
+The following is taken care of in ./PREPATE-AND-COMPILE-GSDL.sh
+
+cd $GSDL3SRCHOME
+cp web/WEB-INF/lib/jdbm.jar packages/tomcat/webapps/gs-cantaloupe/WEB-INF/lib/.
+
+For debugging XML output as String:
+
+  cp web/WEB-INF/lib/xalan.jar packages/tomcat/webapps/gs-cantaloupe/WEB-INF/lib/.
+
+  cp web/WEB-INF/lib/serialeizer.jar packages/tomcat/webapps/gs-cantaloupe/WEB-INF/lib/.
+
+
+=======

gs3-extensions/iiif-servlet/trunk/src/gsdl-src/java/org/greenstone/gsdl3/IIIFServerBridge.java

@@ -45 +45 @@
 import org.w3c.dom.Node;
 
+
+
+import java.io.StringWriter;
+
+//import javax.xml.parsers.DocumentBuilder;
+//import javax.xml.parsers.DocumentBuilderFactory;
+import javax.xml.transform.OutputKeys;
+import javax.xml.transform.Transformer;
+import javax.xml.transform.TransformerException;
+import javax.xml.transform.TransformerFactory;
+import javax.xml.transform.dom.DOMSource;
+import javax.xml.transform.stream.StreamResult;
+
+
 /** a class the serve as a bridge between the Cantaloupe IIIF image server and 
  * Greenstone collections.  Loosely based on OAIServer
@@ -159 +173 @@
     } // end of remote_init()
 
+    // Based on:
+    // https://stackoverflow.com/questions/4412848/xml-node-to-string-in-java
+
+    private static String nodeToString(Node node) {
+    StringWriter sw = new StringWriter();
+    try {
+        Transformer t = TransformerFactory.newInstance().newTransformer();
+        t.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "yes");
+        t.setOutputProperty(OutputKeys.INDENT, "yes");
+        t.transform(new DOMSource(node), new StreamResult(sw));
+    } catch (TransformerException te) {
+        System.out.println("nodeToString Transformer Exception");
+    }
+    return sw.toString();
+    }
 
         public String doGetDocumentMessage(String identifier)
@@ -191 +220 @@
         else
         {
-
+            //logger.info("***** DEBUG: xml_result");           
+            //logger.info(nodeToString(xml_result));
+             
             //
             // All response elements are in the form (with a corresponding verb

gs3-extensions/iiif-servlet/trunk/src/gsdl-src/java/org/greenstone/gsdl3/service/IIIFPMH.java

@@ -187 +187 @@
     }
 
-
+    DBInfo top_level_info = null;
+
+    int subsection_dot = oid.indexOf(".");
+    
+    if (subsection_dot > 0) {
+    // OID specifies document sub-section
+    // => Need to work out the top-level OID, as this is needed to retrieve assocfilepath
+    String root_oid = oid.substring(0,subsection_dot);
+    top_level_info = this.coll_db.getInfo(root_oid);
+    }
+    else {
+    top_level_info = info;
+    }
+    
+    
     // ****
     Element get_record_response = doc.createElement(GSXML.RESPONSE_ELEM);
@@ -193 +207 @@
     get_record_response.appendChild(get_record);
     Element record = doc.createElement(IIIFXML.RECORD);
+
     //compose the header element
     record.appendChild(createHeaderElement(doc, oid));      
+
     //compose the metadata element
-    record.appendChild(createMetadataElement(doc, info));
+    record.appendChild(createMetadataElement(doc, info, top_level_info));
     get_record.appendChild(record);
     return get_record_response;
   }
-
+    
     
  /** create the metadata element used when processing GetRecord request
    */
 
-  protected Element createMetadataElement(Document doc, DBInfo info) {
+  protected Element createMetadataElement(Document doc, DBInfo info, DBInfo top_level_info) {
     // the <metadata> element
     Element metadata_message = doc.createElement(IIIFXML.METADATA);
 
-    addFirstMetadata(metadata_message, "assocfilepath", info);
+    addFirstMetadata(metadata_message, "assocfilepath", top_level_info);
     addFirstMetadata(metadata_message, "Image", info);