Changeset 38874

Timestamp:

2024-03-25T23:18:19+13:00 (5 weeks ago)

Author:

anupama

Message:

1. Tried to get the GsdlCollageApplet to run as a webswing applet, but it hits a nullpointer in the DisplayImages constructor: createImage hasn't returned anything, I think. This is not a problem with the applet, and the applet gets past this. So next, I want to try getting GsdlCollageApplet to work as an application (as opposed to applet) to see if it is free of this problem and then see if the problem goes away when the webswing is run as an application instead of an applet. 2. Adding the code to GsdlCollageApplet to make it run as an application as well, besides applet. The code was largely copied from JPhind, where I'd done all the thinking for how GS applet classes need to modified to get them to work as an application. Sadly, when I run the GsdlCollageApplet as an Application, I hit the same error as when running it as an Applet through Webswing. It's perplexing what is different about the GsdlCollageApplet run through the appletviewer as a standalone applet that that manages to get a little further. Or maybe the parameters are incomplete in the webswing applet params and the standalone application commandline parameters compared to how the applet was run? I can't think what I'm missing though.

Files:

• gs3-extensions/webswing/trunk/web/etc/webswing.config.in (modified) (1 diff)
• main/trunk/greenstone3/src/java/org/greenstone/applet/GsdlCollageApplet/DownloadImages.java (modified) (1 diff)
• main/trunk/greenstone3/src/java/org/greenstone/applet/GsdlCollageApplet/GsdlCollageApplet.java (modified) (6 diffs)
• main/trunk/greenstone3/web/interfaces/default/interfaceConfig.xml (modified) (1 diff)
• main/trunk/greenstone3/web/interfaces/default/transform/layouts/header.xsl (modified) (1 diff)
• main/trunk/greenstone3/web/interfaces/default/transform/pages/webswing-collage.xsl (added)

gs3-extensions/webswing/trunk/web/etc/webswing.config.in

@@ -122 +122 @@
     "webHomeDir" : "@gsdl3webwritablehomeunix@",
     "goodbyeUrl" : "/"
+  },
+    "/collage" : {
+    "path" : "/collage",
+    "security" : {
+      "module" : "NONE",
+      "config" : { },
+      "classPath" : [ ]
+    },
+
+    "webFolder" : "",
+    "swingConfig" : {
+      "jreExecutable" : "${java.home}/bin/java",
+      "javaVersion" : "${java.version}",
+      "vmArgs" : "",
+      "classPathEntries" : [ "applet/*.jar", "ext/webswing/api/webswing-api.jar" ],
+      "theme" : "Murrine",
+      "fontConfig" : {
+        "dialog" : "${webswing.configDir}/fonts/Roboto-Regular.ttf",
+        "dialoginput" : "${webswing.configDir}/fonts/RobotoMono-Regular.ttf",
+        "monospaced" : "${webswing.configDir}/fonts/RobotoMono-Regular.ttf",
+        "serif" : "${webswing.configDir}/fonts/Roboto-Regular.ttf",
+        "sansserif" : "${webswing.configDir}/fonts/Roboto-Regular.ttf"
+      },
+      "swingSessionTimeout" : 300,
+      "antiAliasText" : true,
+      "isolatedFs" : true,
+      "debug" : false,
+      "directdraw" : true,
+      "allowDelete" : false,
+      "allowDownload" : false,
+      "allowAutoDownload" : true,
+      "allowUpload" : false,
+      "allowJsLink" : true,
+      "allowLocalClipboard" : true,
+      "launcherType" : "Applet",
+      "launcherConfig" : {
+        "appletClass" : "org.greenstone.applet.GsdlCollageApplet.GsdlCollageApplet",
+        "parameters" : {
+         "library" : "library",
+         "collection" : "smallbea",
+            "gsdlversion" : "3",
+            "sitename" : "localsite",
+        "baseurl" : "'http://localhost:8383/greenstone3/",
+            "documentroot" : "greenstone3",
+            "verbosity" : "3",
+            "imageType" : ".jpg%.png",
+            "imageMustNotHave" : "interfaces/",
+        "gwcgi" : "http://localhost:8383/greenstone3/library/collection/smallbea/",
+        "classifier" : "CL2.3",
+        "maxDepth" : "500",
+        "maxDisplay" : "25",
+        "refreshDelay" : "1500",
+        "isJava2" : "auto",
+        "bgcolor" : "#96c29a"
+        }
+      },
+      "homeDir" : "@gsdl3webwritablehomeunix@"
+    },
+    "maxClients" : 4,
+    "maxConnections" : 4,
+    "allowStealSession" : false,
+    "name" : "Greenstone Collage Browser",
+    "sessionMode" : "ALWAYS_NEW_SESSION",
+    "uploadMaxSize" : 1200,
+    "webHomeDir" : "@gsdl3webwritablehomeunix@",
+    "goodbyeUrl" : "/"
   }
 }

main/trunk/greenstone3/src/java/org/greenstone/applet/GsdlCollageApplet/DownloadImages.java

@@ -14 +14 @@
  *  Stores images that are downloaded but have not yet been displayed
  *  in the applet. Provides methods to add to and remove from this list
- *  and check it's size. It uses an inner class to store the data for these
- *  images, comprising of three parts: the image itself, it's source url
+ *  and check its size. It uses an inner class to store the data for these
+ *  images, comprising of three parts: the image itself, its source url
  *  and the name of the image */
 public class DownloadImages {

main/trunk/greenstone3/src/java/org/greenstone/applet/GsdlCollageApplet/GsdlCollageApplet.java

@@ -5 +5 @@
 import java.awt.*;
 import java.net.*;
+
+import javax.swing.JFrame;
+import javax.swing.JLabel;
+import java.util.Map;
+import java.util.HashMap;
 
 /**
@@ -20 +25 @@
  
 public class GsdlCollageApplet extends JApplet {
+    // To run this GsdlCollageApplet as Application instead of as Applet
+    boolean isWebswingApplication = false; // if run as webswing *and* application (not applet)
+    boolean isRunAsApplet = true;
+    // set only if JPhind object is run as an application
+    URL docBaseURL = null;
+    JLabel statusBar = null;    
+    Map<String,String> appParams;
+    
     // package access, used mainly for GS3
     int gsdlversion = 2;
@@ -102 +115 @@
     Thread paint ;
 
+    public GsdlCollageApplet() { super(); }
+
+    public GsdlCollageApplet(String[] args) {
+    // I copied the contents of this contructor for my code for the JPhind.java constructor
+    // This constructor will be used when this JApplet is run as an application
+    // instead of as applet
+    this.isRunAsApplet = false;
+    try {
+        this.docBaseURL = new URL(args[0]);     
+    } catch(MalformedURLException mue) {        
+        mue.printStackTrace();
+        System.err.println("*** Unable to instantiate URL from parameter: " + args[0]);
+        System.exit(-1);
+    }
+
+    appParams = new HashMap<String,String>((args.length+1)/2);
+
+    String key = null;
+    String value = null;
+    for(int i = 1; i < args.length; i++) { // after arg0, have key-value pairs (params)
+        if(i%2==1) {
+        key = args[i].substring(2); // remove -- prefix of paramname
+        //System.err.println("got key: " + key);
+        } else {
+        value = args[i];
+        appParams.put(key, value);
+        //System.err.println("got value: " + value);
+
+
+        // HttpUtils.parseQueryString() deprecated, so hacking decode xtra key-value pairs
+        // https://stackoverflow.com/questions/13592236/parse-a-uri-string-into-name-value-collection?page=1&tab=scoredesc#tab-top
+        // String.split() is preferred over Tokenizer but 2nd parameter behaves differently
+        // than I expected.
+        // https://docs.oracle.com/javase/6/docs/api/java/lang/String.html#split%28java.lang.String,%20int%29
+        if(key.equals("xtraParams")) {
+            value = value.replace("&amp;", "&"); // just in case we have html entities
+            String[] param_list = value.split("&", 0); // 0 for all occurrences
+            for(String key_val : param_list) {          
+            String[] paramPair = key_val.split("=", 2); // get first 2 strings, key and val
+            //System.err.println("key_val: " + key_val);
+            if(paramPair.length == 2) {
+                String xtraParamsKey = paramPair[0];
+                String xtraParamsVal = paramPair[1];
+                //System.err.println("key - val: " + xtraParamsKey + " - " + xtraParamsVal);
+                appParams.put(xtraParamsKey, xtraParamsVal);
+            }
+            }
+        }
+        
+        key = value = null;
+        }
+    }
+
+    isWebswingApplication = appParams.getOrDefault("webswing", "0").equals("1") ? true : false;
+    
+    // manually calling (J)Applet method init()
+    init();
+    }
+    
+    /**
+     * Overriding (J)Applet method getParameter to first check appParams map
+     * if Phind was run run as an application.
+     * https://stackoverflow.com/questions/15905127/overridden-methods-in-javadoc
+    */
+    @Override    
+    public String getParameter(String name) {
+    if(!isRunAsApplet) {
+        return appParams.get(name);
+    }
+    else {
+        return super.getParameter(name);
+    }
+    }
+    
+    @Override
+    public URL getDocumentBase() {
+    if(!isRunAsApplet) { // launched as application
+        //System.err.println("*** docBaseURL: " + docBaseURL);
+        return this.docBaseURL;
+    } else {
+        return super.getDocumentBase();
+    }
+    }
+    
+    @Override
+    public void showStatus(String msg) {
+    // Either firefox doesn't provide a status bar window for applets any more or webswing
+    // doesn't provide a status window, so we don't see Applet.showStatus() output appear
+    // in webswing-phind and in fact don't even see any Applet statusBar in webswing.
+    // However, since we print useful and interesting information to the status bar,
+    // we'll now always show and print to our manually added statusBar now
+    // not only if(!isRunAsApplet) when we needed to manually create a statusBar.
+    this.statusBar.setText(msg);
+    if(isRunAsApplet) {
+        super.showStatus(msg);
+    }
+    }
+    
     public void init() 
     {       
@@ -277 +388 @@
             }
         }
-        // starting URL (image_url) may not be base_url
+        // starting URL (image_url) might not be base_url
         this.baseURL = getParameter("baseurl");
         // TODO: is it not the other way: gwcgi should be param set to base_url
@@ -283 +394 @@
         }
     }
+
+    // status bar that applet has, but we want one also if we run JPhind as application
+    // And in fact, when webswing runs our applet, we never get a status bar. So we
+    // create a custom status bar now even if we're running as an applet.
+    // When this applet is run through the appletviewer we might end up with 2 status bars.
+    setLayout(new BorderLayout());
+    //if(!isRunAsApplet) {
+    statusBar = new JLabel();
+    this.add(statusBar, BorderLayout.SOUTH);
+    Dimension d = statusBar.getSize();
+    d.height = 30;
+    statusBar.setPreferredSize(d);
+    //}
 
     MediaTracker trk = new  MediaTracker(this);
@@ -466 +590 @@
 
 
+    // To also be able to run this applet as an application, need a main method
+    /**
+     * Try running as:
+java -cp ./web/applet/GsdlCollageApplet.jar:./web/WEB-INF/lib/log4j-1.2.8.jar:./web/WEB-INF/classes org.greenstone.applet.GsdlCollageApplet.GsdlCollageApplet "http://localhost:8383/greenstone3/" --gwcgi "http://localhost:8383/greenstone3/library/collection/smallbea/" --library library --collection smallbea --gsdlversion 3 --baseurl "http://localhost:8383/greenstone3/" --sitename localsite --documentroot greenstone3 --verbosity 3 --imageType ".jpg%.png" --imageMustNotHave "interfaces/" --classifier "CL2.3" --maxDepth 500 --maxDisplay 25 --refreshDelay 1500 --isJava2 auto --bgcolor "#96c29a"
+     */
+    public static void main(String[] args) {
+    if(args.length < 9) {
+        System.err.println("Need minimum --params: <baseURL> --library <library> --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
+        GsdlCollageApplet collageApp = new GsdlCollageApplet(args);
+        JFrame frame = new JFrame("Collage Applet as Application");
+        frame.getContentPane().add(collageApp, BorderLayout.CENTER);
+        frame.setSize(500,400);
+        // https://stackoverflow.com/questions/19433358/difference-between-dispose-and-exit-on-close-in-java
+        // default: https://docs.oracle.com/javase/8/docs/api/javax/swing/JFrame.html#EXIT_ON_CLOSE
+        frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE); // don't do EXIT_ON_CLOSE in Applets!
+        frame.setVisible(true);
+
+    }
+    }
 }

main/trunk/greenstone3/web/interfaces/default/interfaceConfig.xml

@@ -7 +7 @@
             <subaction name="gli" xslt="pages/webswing-gli.xsl"/>
             <subaction name="phind" xslt="pages/webswing-phind.xsl"/>
+            <subaction name="collage" xslt="pages/webswing-collage.xsl"/>
             <subaction name="debug" xslt="pages/debuginfo.xsl"/>
             <subaction name="pref" xslt="pages/pref.xsl"/>

main/trunk/greenstone3/web/interfaces/default/transform/layouts/header.xsl

@@ -451 +451 @@
         </xsl:attribute>
           </xsl:if>                       
-          <xsl:attribute name="href"><xsl:value-of select="$library_name"/>?a=a&amp;rt=d&amp;s=<xsl:value-of select="@name"/>&amp;c=<xsl:value-of select="/page/pageResponse/collection/@name"/></xsl:attribute>
-          <!--<xsl:attribute name="href"><xsl:value-of select="$library_name"/>/collection/<xsl:value-of select="/page/pageResponse/collection/@name"/>/page/collage</xsl:attribute>-->
+          <!--<xsl:attribute name="href"><xsl:value-of select="$library_name"/>?a=a&amp;rt=d&amp;s=<xsl:value-of select="@name"/>&amp;c=<xsl:value-of select="/page/pageResponse/collection/@name"/></xsl:attribute>-->
+          <xsl:attribute name="href"><xsl:value-of select="$library_name"/>/collection/<xsl:value-of select="/page/pageResponse/collection/@name"/>/page/collage</xsl:attribute>
           <xsl:value-of select="displayItem[@name='name']"/>
         </a>