Changeset 31537 for main/trunk/greenstone3/web/interfaces/default/js/javascript-global-functions.js

Timestamp:

2017-03-24T21:37:12+13:00 (7 years ago)

Author:

ak19

Message:

First commit for getting user comments working for GS3. It all works, but there's debugging statements still and haven't cleaned up commented out code. After that, would like to make POST rather than GET AJAX calls, so more refactoring required. 1. config_format.xsl is just minor spelling corrections. 2. header.xsl has a new function generateLogoutURL. 3. document.xsl imports and calls new usercomments.xsl to set up the user comments area. 4. New usercomments.js is imported by new usercomments.xsl, and sets up the interaction of the usercomments area. 5. javascript-global-functions.js now contains setMetadataArray and getMetadataArray functions to parallel what GS2 used in gsajaxapi.js, but for GS3 need to go through GS2Construct.processModifyMetadata() service in java code. 5. GS2Construct.java does different checking for users adding user comments versus users doing document editing. For the latter, the user needs to have editing permissions for the document. But any user is allowed to add comments on any accessible document. But ModifyMetadata should not allow any other metadata to be modified other than meta fields. 6. New language strings for usercomment area and GS2Construct errors in the 2 changed properties files.

File:

• main/trunk/greenstone3/web/interfaces/default/js/javascript-global-functions.js (modified) (6 diffs)

main/trunk/greenstone3/web/interfaces/default/js/javascript-global-functions.js

@@ -422 +422 @@
 }
 
-function callMetadataServer(callingFunction, url, responseFunction)
+// No function overloading in JavaScript. Can pass a custom object, however, see
+// http://stackoverflow.com/questions/456177/function-overloading-in-javascript-best-practices
+function callMetadataServer(callingFunction, url, responseFunction, opts)
 {
     var async_setting = true; // Internal processing of 'read' operations (get meta) is not order dependent
@@ -445 +447 @@
     } // otherwise, such as for get- metadata operation, we proceed as before, which will not require authentication
 
+    if (opts != null && opts["forceSync"] != null) {
+    async_setting = (!opts["forceSync"]);
+    }
+
+    console.log("Away to call: " + url);
+    var ajaxResponse = null;
 
     $.ajax(url, {async: async_setting})
@@ -451 +459 @@
         console.log("(" + callingFunction + ") Response received from server: " + response);
 
+        ajaxResponse = response;
+
         //var xml = $.parseXML(response);
         //console.log(xml);
@@ -456 +466 @@
         if(responseFunction != null)
         {
-            responseFunction(response);
+            
+            responseFunction(response);
         }
     })
@@ -463 +474 @@
         console.log("(" + callingFunction + ") Failed");
     });
+
+    console.log("Finished ajax call to: " + url);
+    
+    console.log("Got response: " + ajaxResponse);
+    return ajaxResponse;
 }
 
@@ -513 +529 @@
 }
 
+// New. Modified version of the GS2 version of this method in gsajaxapi.js.
+// The where parameter can be specified as one or more of: import, archives, index, live 
+// separated by |. If null, it is assumed to be index which is the original default 
+// behaviour of calling set-metadata-array. E.g. where=import|archives|index
+// THIS METHOD IS SYNCHRONOUS
+gs.functions.setMetadataArray = function(collection, site, docArray, metamode, where, responseFunction) 
+{
+    docArrayJSON = JSON.stringify(docArray);
+    
+    var params = "a=" + escape("set-metadata-array"); //"a=set-metadata-array";
+    if(where != null) {
+    params += "&where=" + escape(where); // if where not specified, meta-server will default to setting index meta
+    //} else {
+    //    params += "&where=import|archives|index";
+    }
+    params += "&c="+escape(collection);
+    params += "&site="+escape(site);
+    params += "&json="+escape(docArrayJSON);
+    
+    if (metamode!=null) {
+    params += "&metamode=" + escape(metamode);
+    }
+    
+
+    var response = callMetadataServer("Setting metadata in "+where, "cgi-bin/metadata-server.pl?"+params, responseFunction);
+
+    return response;
+    // return this.urlPostSync(mdserver,params); // gsajaxapi.js version for GS2
+}
+
+
 /*************************
 * GET METADATA FUNCTIONS *
 *************************/
 
+// New. Modified version of the GS2 version of this method in gsajaxapi.js.
+// See description for setMetadataArray above for information about the 'where' parameter.
+// THIS METHOD IS SYNCHRONOUS BY DEFAULT. Set forceSync to false to override this default behaviour
+gs.functions.getMetadataArray = function(collection, site, docArray, where, forceSync, responseFunction)
+{
+    docArrayJSON = JSON.stringify(docArray);
+    
+    var params = "a=" + escape("get-metadata-array"); //"a=set-metadata-array";
+    if(where != null) {
+    params += "&where=" + escape(where); // if where not specified, meta-server will default to setting index meta
+    //} else {
+    //    params += "&where=import|archives|index";
+    }
+    params += "&c="+escape(collection);
+    params += "&site="+escape(site);
+    params += "&json="+escape(docArrayJSON);
+        
+    // get operations are generally asynchronous, but allow calling function to force ajax call 
+    // to be synchronous or not. Default is synchronous, as it was for GS2
+    if(forceSync == null) {
+    forceSync = true;
+    }
+    // Objects/maps can use identifiers or strings for property names
+    // http://stackoverflow.com/questions/456177/function-overloading-in-javascript-best-practices
+    // https://www.w3schools.com/js/js_objects.asp
+    var response = callMetadataServer("Getting metadata from "+where, "cgi-bin/metadata-server.pl?"+params, responseFunction, {"forceSync":forceSync});
+
+    return response;
+    //return this.urlPostSync(mdserver,params); // gsajaxapi.js version for GS2
+}
+
+
 gs.functions.getImportMetadata = function(collection, site, documentID, metadataName, responseFunction)
 {