Changeset 38948 for main/trunk/greenstone3/web/interfaces/default/transform/layouts/webswing-collage.xsl

Timestamp:

2024-04-23T18:59:30+12:00 (4 weeks ago)

Author:

anupama

Message:

1. More streamlining of the XSL code for the GsdlCollage and Phind applets so its easier to add new parameters (don't need to keep checking where else to add them). 2. Minor corrections to the XSL to get GsdlCollageApplet to run as webswing application again too. Tested both GsdlCollage and Phind as webswing application and webswing applet. Both working. The way to swap between them is to make webswing.config.applet or webswing.config.application (in ext/webswing) the active webswing.config.in file in web/ext/webswing and then change the isWebswingRunAsApplet variable to true or false accordingly in both the webswing-collage.xsl and webswing-phind.xsl. If you forget one of these steps, it's not immediately apparent why the webswing application is not launching and you have to check the webswing log for how it's trying to launch it and make sure it makes sense for if you chose applet/application. 3. Allowed Phind run as application to work with width and height values passed in from the commandline. The fallback is still 500x500.

File:

• main/trunk/greenstone3/web/interfaces/default/transform/layouts/webswing-collage.xsl (modified) (5 diffs)

main/trunk/greenstone3/web/interfaces/default/transform/layouts/webswing-collage.xsl

@@ -75 +75 @@
        
        if(!webswingInstance0.options.args) {
-       webswingInstance0.options.args="";       
+          webswingInstance0.options.args="";       
        }
 
@@ -81 +81 @@
        var appletEl = document.getElementById("collage-applet-element");
        
-    if(!appletEl) {
-       
-       if(verbosity >= 4) {
-          console.log("No collage-applet-element on page. Reading in from pageResponse/XSLT.");
+       // Fill up webswingParams JSON record with non-dynamic values and other vals
+       // that may perhaps not be set on the applet element, to use as fallback
+       var webswingParams = {
+       //"webswing":1, // set in webswing.config.in to discourage editing
+       "verbosity": verbosity,
+       "gsdlversion":3,
+       "maxDepth": 500,
+       "maxDisplay": 25,
+       "refreshDelay": 1500,
+       "isJava2":"auto",
+       "bgcolor":"#96c29a"
+       };
+       
+       if(!appletEl && verbosity >= 4) {
+          console.log("No collage-applet-element on page. Using webswing params vals from pageResponse/XSLT.");
        }      
       
@@ -106 +117 @@
        var gs3CollBrowsePath = gs.xsltParams.library_name + "/collection/" + gs.cgiParams.c + "/browse/" + gs.cgiParams.cl; // cl is classifier, e.g "CL3"
 
-       var gsdlversion = 3;
-       var collection = gs.cgiParams.c;
-       var library = gs.xsltParams.library_name;
-       var documentroot = gs.xsltParams.servlet_context;
-       var hrefMustHave = gs3CollBrowsePath;
-       var imageMustNotHave = "interfaces/";
-       var imageType = ".jpg%.png";
-       var classifier = gs.cgiParams.cl + ".1";
-
-       // non-dynamic values
-       var maxDepth = 500; 
-       var maxDisplay = 25;
-       var refreshDelay = 1500;
-       var isJava2 = "auto";
-       var bgcolor = "#96c29a";
-
-       
-       // Control the width and height of the Java application launched with webswing
-       // by passing width and height params set to the attributes of the webswing element
-       // https://stackoverflow.com/questions/21851633/get-height-from-style-attribute
-       var w = document.getElementById("webswing-collage").style.width;
-       var h = document.getElementById("webswing-collage").style.height;
-       
-    } else { // the applet element exists, get all webswing config settings from there
-
+       webswingParams["baseurl"] = baseURL;
+       webswingParams["collection"] = gs.cgiParams.c;
+       webswingParams["library"] = gs.xsltParams.library_name;
+       webswingParams["documentroot"] = gs.xsltParams.servlet_context;
+       webswingParams["hrefMustHave"] = gs3CollBrowsePath;
+       webswingParams["imageMustNotHave"] = "interfaces/";
+       webswingParams["imageType"] = ".jpg%.png";
+       webswingParams["classifier"] = gs.cgiParams.cl + ".1";
+       
+       
+       
+    if(appletEl) { // get all available webswing config settings from applet element
+       if(verbosity >= 4) {
+          console.log("collage-applet-element on page, using its params where available.");
+       }
        // If using the inactive/deprecated applet element as shim, instead of javascript
        // working out the webswing config params from the pageRequest or XSLT variables:
@@ -136 +137 @@
        // as a GS3 library designer may know to how to customize applet parameters
        // better than they know javascript or how to construct webswing parameters.       
-
-       // First (re)setting the verbosity variable already declared earlier
-       var tmp_verbosity = appletEl.querySelector("param[name='verbosity']").value;
-       if(tmp_verbosity) {
-          verbosity = tmp_verbosity;
-       }
-       var baseURL = appletEl.querySelector("param[name='baseurl']").value;
-       var gsdlversion = appletEl.querySelector("param[name='gsdlversion']").value;
-       var collection = appletEl.querySelector("param[name='collection']").value;
-       var library = appletEl.querySelector("param[name='library']").value;
-       var documentroot = appletEl.querySelector("param[name='documentroot']").value;
-       var hrefMustHave = appletEl.querySelector("param[name='hrefMustHave']").value;
-       var imageMustNotHave = appletEl.querySelector("param[name='imageMustNotHave']").value;
-       var imageType = appletEl.querySelector("param[name='imageType']").value;
-       var classifier = appletEl.querySelector("param[name='classifier']").value;
-       var maxDepth = appletEl.querySelector("param[name='maxDepth']").value;
-       var maxDisplay = appletEl.querySelector("param[name='maxDisplay']").value;
-       var refreshDelay = appletEl.querySelector("param[name='refreshDelay']").value;
-       var isJava2 = appletEl.querySelector("param[name='isJava2']").value;
-       var bgcolor = appletEl.querySelector("param[name='bgcolor']").value;
-
-       var w = appletEl.width;
-       var h = appletEl.height;
              
+       // Now get the param subelements of the applet element
+       for (var webswingParam of Object.keys(webswingParams)) {
+          var querySelectorStr = "param[name='"+webswingParam+"']";       
+          var appletParam = appletEl.querySelector(querySelectorStr);
+      if(appletParam) { // if this parameter was set on the applet
+         webswingParams[webswingParam] = appletParam.value;
+      } else {
+         if(verbosity>=3) {
+            console.log("Applet element doesn't supply param: " + webswingParam + ". Using fallback: " + webswingParams[webswingParam]);
+         }
+      }
+       }
+      
     }
-       
-       webswingInstance0.options.args += "--baseurl \"" + baseURL + "\"";
-       //webswingInstance0.options.args += " --webswing 1"; // set in webswing.config.in
-       webswingInstance0.options.args += " --gsdlversion " + gsdlversion;
-       webswingInstance0.options.args += " --collection " + collection;
-       webswingInstance0.options.args += " --library " + library;
-       webswingInstance0.options.args += " --documentroot " + documentroot;
-       webswingInstance0.options.args += " --hrefMustHave " + hrefMustHave;
-       webswingInstance0.options.args += " --imageMustNotHave \""+ imageMustNotHave+ "\"";
-       webswingInstance0.options.args += " --verbosity " + verbosity;
-       webswingInstance0.options.args += " --imageType \"" + imageType + "\"";
-       webswingInstance0.options.args += " --classifier \"" + classifier + "\"";
-       webswingInstance0.options.args += " --maxDepth " + maxDepth;
-       webswingInstance0.options.args += " --maxDisplay " + maxDisplay;
-       webswingInstance0.options.args += " --refreshDelay " + refreshDelay;
-       webswingInstance0.options.args += " --isJava2 \""+ isJava2 +"\"";
-       webswingInstance0.options.args += " --bgcolor \""+ bgcolor +"\"";
-       
-
-       // common code, regardless of whether we use the applet element as a shim or not
-       var suffixIndex = 0;
-       if(w) {       
-          suffixIndex = w.indexOf("px");
-          if(suffixIndex>0) {
-             w = w.substring(0, suffixIndex);
-          }
-          webswingInstance0.options.args += " --width " + w;
-       }       
-       if(h) {
-          suffixIndex = h.indexOf("px");
-          if(suffixIndex>0) {
-             h = h.substring(0, suffixIndex);
-          }
-          webswingInstance0.options.args += " --height " + h;
-       }
-
+
+       // Special case: width and height are attributes of the applet tag not subelements
+       // and may need parsing.
+       // Control the width and height of the Java application launched with webswing by
+       // passing the width and height params set on the webswing element, unless an applet
+       // element is available. In that case try to get the dimensions from the applet tag.
+       // https://stackoverflow.com/questions/21851633/get-height-from-style-attribute
+       var w = appletEl ? appletEl.getAttribute("width") : document.getElementById("webswing-collage").style.width;
+       var h = appletEl ? appletEl.getAttribute("height") : document.getElementById("webswing-collage").style.height;
+       webswingParams["width"] = stripUnitOffAttribute("px", w);
+       webswingParams["height"] = stripUnitOffAttribute("px", h);
+
+       
+       // Having collected all the webswingParams, we can finally build up the single webswing customArgs string
+       var _args = "";
+       for (var webswingParam of Object.keys(webswingParams)) {
+          _args += "--" + webswingParam + " \"" + webswingParams[webswingParam] + "\" "; // space at end to precede next arg
+       }
+       webswingInstance0.options.args += _args.substring(0, _args.length-1); // remove extra space at end
+   
+       
        // Set to false if running the webswing instance as a webswing application. This has
        // nothing to do with if the applet element exists on the page: it can be on the page
@@ -238 +214 @@
         var results = new RegExp("[\\?&]" + name + "=([^&#]*)").exec(location.href);
         return results == null ? null : decodeURIComponent(results[1]);
+    }
+
+    function stripUnitOffAttribute(unit, attr) {
+    // common code, regardless of whether we use the applet element as a shim or not
+       var suffixIndex = 0;
+       if(attr) {       
+          suffixIndex = attr.indexOf(unit);
+          if(suffixIndex>0) {
+             attr = attr.substring(0, suffixIndex);
+          }
+       }       
+       return attr;
     }
   </gsf:script>