Changeset 38848 for main/trunk/greenstone3

Timestamp:

2024-03-18T20:37:34+13:00 (3 months ago)

Author:

anupama

Message:

1. Running webswing-phind as an application instead of as an applet, so we can finally pass in the variable collection and library parameters. This required altering webswing.config.in (to launch JPhind as application instead of applet) and webswing-phind.xsl (to pass in the additional parameters). 2. When run as applet, clicking leaf nodes in the search results list opened the clicked url result in a browser window/tab but this wasn't happening when run as application. The easiest solution was to handle it when JPhind is run as a webswing application: in that case, it just requires registering a new eventhandler called openURL in the webswing-phind.xsl's JavaScript code, then calling this from the Java code. In JPhind.java, we now pass in a webswing command line parameter set to 1 to indicate JPhind is run as by webswing and as an application. (The webswing cmdline arg will default to 0 if not set, such as for applets or if run from the commandline without being set.) If run as an applet, JPhind uses the inherited AppletContext object as before to open a URL in the browser where the applet is being run. But now, if run as a webswing Application, it calls the new webswing custom eventhandler called openURL (for which JPhind needs to be compiled against the webswing-api.jar now) and passes the URL and any target window where the URL is to be opened. Finally, webswing.config.in passes in the new webswing parameter set to 1, since we're running the phind webswing as an application and also needs the webswing-api.jar in its classpath for phind.

Location:

main/trunk/greenstone3

Files:

• build.xml (modified) (1 diff)
• src/java/org/greenstone/applet/phind/JPhind.java (modified) (6 diffs)
• web/WEB-INF/classes/interface_default.properties (modified) (1 diff)
• web/interfaces/default/transform/pages/webswing-phind.xsl (modified) (2 diffs)

main/trunk/greenstone3/build.xml

@@ -822 +822 @@
     <pathelement location="${lib.jni}/mg.jar"/>
     <pathelement location="${lib.jni}/mgpp.jar"/>
+
+    <pathelement location="${web.writablehome}/ext/webswing/api/webswing-api.jar"/>    
     
     <!-- Include all elements that Tomcat exposes to applications -->

main/trunk/greenstone3/src/java/org/greenstone/applet/phind/JPhind.java

@@ -92 +92 @@
 package org.greenstone.applet.phind;
 
+import org.webswing.toolkit.api.WebswingUtil;
+
 import javax.swing.JApplet;
 import javax.swing.JComponent;
@@ -136 +138 @@
     implements ActionListener {
 
+    boolean isWebswingApplication = false; // if run as webswing *and* application (not applet)
+    
     boolean isRunAsApplet = true;
     // set only if JPhind object is run as an application
@@ -215 +219 @@
     // 1. The search button is easy to disable, and is disabled when a
     //    socket connection is in progress.
-    // 2. ResutCanvas widgets can'r be similarly disabled because the
+    // 2. ResutCanvas widgets can't be similarly disabled because the
     //    browser hides or wipes them, which looks very bad.
     // 3. I cannot just ignore clicks on canvasses because the browser
@@ -280 +284 @@
     }
 
+    isWebswingApplication = appParams.getOrDefault("webswing", "0").equals("1") ? true : false;
+    
     // manually calling (J)Applet method init()
     init();
@@ -716 +722 @@
     try { 
         URL url= new URL(address);
-        if (window.length() > 0) {
-        getAppletContext().showDocument(url, window);
-        } else {
-        getAppletContext().showDocument(url);
+        if(isRunAsApplet) {
+        if (window.length() > 0) {
+            getAppletContext().showDocument(url, window);
+        } else {
+            getAppletContext().showDocument(url);
+        }
+        } else if(isWebswingApplication) {
+        if (window.length() > 0) {
+            WebswingUtil.getWebswingApi().sendActionEvent("openURL",
+                                  url.toString() + " - " +window,
+                                  null);
+        } else {
+            WebswingUtil.getWebswingApi().sendActionEvent("openURL", url.toString(), null);
+        }
+        } else { // else application, but not webswing, TODO: open browser at the URL
+        System.err.println("Phind.displayWebPage() for non-applet and non-webswing application is not yet implemented.");
         }
     } catch (Exception e) { 
@@ -1130 +1148 @@
     public static void main(String args[]) {
     if(args.length < 9) {
-        System.err.println("Need minimum --params: <baseURL> --collection <collection> --classifier <classifier> --phindcgi <URL> --library <libURL> [--backdrop <ImgURL>] [--xtraParams <key1=value1&key2=value2&...]");
+        System.err.println("Need minimum --params: <baseURL> --collection <collection> --classifier <classifier> --phindcgi <URL> --library <libURL> [--webswing <1/0>] [--backdrop <ImgURL>] [--xtraParams <key1=value1&key2=value2&...]");
     }
     else { // collection fao.org, classifier 1, phindcgi url, library url, backdrop imgurl

main/trunk/greenstone3/web/WEB-INF/classes/interface_default.properties

@@ -330 +330 @@
 webswinggli.brief=Allows you to configure and build collections
 
+webswing_glipage=The WebSwing GLI page
+webswing_phindpage=The WebSwing Phind page
+
 tabletopDL.title=Tabletop DL Interface
 tabletopDL.brief=An interactive experience for end-users based around a tabletop/desktop metaphor

main/trunk/greenstone3/web/interfaces/default/transform/pages/webswing-phind.xsl

@@ -117 +117 @@
         customization: function(injector) {
         injector.services.base.handleActionEvent = function(actionName, data, binaryData) {
-                console.log("WebSwing actionEvent callback handler: called with actionName = " + actionName);       
+                //console.log("WebSwing actionEvent callback handler: called with actionName = " + actionName);
+
+            if (actionName === "openURL") {
+              var url = data;
+          // check if a target tab/window name has been specified
+          // Any better way of passing more than 1 string between Java and JavaScript?
+          var index = url.indexOf(" - ");
+          if (index !== -1) {
+             var target = url.substring(index+3); // skip past " - " to get target name
+             window.open(url, target);               
+          } else {
+             window.open(url, '_blank');
+          }
+        }
+        
           }
             }
@@ -124 +138 @@
        }
        };
+
+       
+       // The applet jar files can just remain in web/applet where they are compiled up
+       if(!webswingInstance0.options.args) {
+       webswingInstance0.options.args="";       
+       }
+       
+       //https://stackoverflow.com/questions/25203124/how-to-get-base-url-with-jquery-or-javascript
+       var baseURL = window.location.origin+window.location.pathname;       
+       // webswingInstance0.options.args += "\"" + baseURL+ "?a=a&rt=d&s=PhindApplet&c="+gs.cgiParams.c + "\"";       
+       webswingInstance0.options.args += "\"" + baseURL + "\"";
+       
+       webswingInstance0.options.args += " --collection=" + gs.cgiParams.c;
+       webswingInstance0.options.args += " --library=" + gs.xsltParams.library_name;
+       
+       //console.log("args: " +  webswingInstance0.options.args);
+       
+       
        /*
        // Not yet working. Stick ${customArgs} at end of final param Value (BEFORE the value's closing double quote) in webswing.config.in