Changeset 31527 for main/trunk/greenstone3/web/interfaces/default

Timestamp:

2017-03-21T15:22:50+13:00 (7 years ago)

Author:

ak19

Message:

Bringing the GS3 version of gsajaxapi.js file up to speed with GS2 version with the addition of 6 functions otherwise unused by GS3. A variation of a couple of these functions will appear in GS3's javascript-global-functions.js and those will be used by GS3 for the upcoming GS3 UserComments feature.

File:

• main/trunk/greenstone3/web/interfaces/default/js/gsajaxapi.js (modified) (8 diffs)

main/trunk/greenstone3/web/interfaces/default/js/gsajaxapi.js

@@ -1 +1 @@
 
-function GSAjaxAPI(gwcgi,collect) 
+function GSAjaxAPI(gwcgi,collect,un,ky) 
 {
     var gwcgi_   = gwcgi;
     var collect_ = collect;
+    var un_ = un;
+    var ky_ = ky;
 
 
@@ -101 +103 @@
     }
 
+    if(un_ != null) {
+        url += "&un=" + un_;
+    }
+    if(ky_ != null) {
+        url += "&ky=" + ky_;
+    }
+
     xmlHttp.open("GET",url,true);
     xmlHttp.send(null);
@@ -130 +139 @@
          }
        }
-    
+
+       if(un_ != null) {
+       url += "&un=" + un_;
+       }
+       if(ky_ != null) {
+       url += "&ky=" + ky_;
+       }
+
        xmlHttp.open("GET",url,false);
        xmlHttp.send(null);
@@ -138 +154 @@
        return xmlHttp.responseText;
     }
-    
-
-    
-    
+
+//*********ADDITIONS TO BRING GS3 VERSION OF THIS FILE UP TO SPEED WITH GS2 VERSION********************//
+//*********BUT NOT USED BY GS3. SEE GS3's javascript-global-functions.js INSTEAD (UPCOMING CHANGES)
+//*********FOR THE PORTED VERSIONS OF THOSE FUNCTIONS AMONG THESE ADDITIONS THAT ARE NECESSARY FOR GS3.
+
+// New, an Ajax Synchronous Post method.
+// http://www.degraeve.com/reference/simple-ajax-example.php
+// Async vs Sync: http://www.w3schools.com/ajax/ajax_xmlhttprequest_send.asp 
+// Also:
+// http://stackoverflow.com/questions/6312447/in-an-ajax-post-do-i-need-to-urlencode-parameters-before-sending
+// http://api.jquery.com/jQuery.post/
+// http://www.w3schools.com/ajax/ajax_xmlhttprequest_send.asp
+    this.urlPostSync = function(scriptURL, params) {
+    var xmlHttp=false;
+       try {
+         // Firefox, Opera 8.0+, Safari
+         xmlHttp=new XMLHttpRequest();
+       }
+       catch (e) {
+         // Internet Explorer
+         try {
+           xmlHttp=new ActiveXObject("Msxml2.XMLHTTP");
+         }
+         catch (e) {
+           try {
+             xmlHttp=new ActiveXObject("Microsoft.XMLHTTP");
+           }
+           catch (e) {
+             alert("Your browser does not support AJAX!");
+             return false;
+           }
+         }
+       }
+
+    // e.g. scriptURL: /greenstone/cgi-bin/metadata-server.pl
+    xmlHttp.open('POST', scriptURL, false); // false means synchronous
+    xmlHttp.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded');
+    
+    if(un_ != null) {
+    params += "&un=" + un_;
+    }
+    if(ky_ != null) {
+    params += "&ky=" + ky_;
+    }
+
+    xmlHttp.send(params); // needs to be escaped/encoded
+
+    //alert(scriptURL + "?" + params);
+    //alert(xmlHttp.responseText); // if synchronous, process xmlHttp.responseText AFTER send() call
+    return xmlHttp.responseText;
+}
+
+    // New, an Ajax Asynchronous Post method.
+    // For helpful links, see the urlPostSync() method above
+    this.urlPostAsync = function(scriptURL, params, callback) {
+    var xmlHttp=false;
+       try {
+         // Firefox, Opera 8.0+, Safari
+         xmlHttp=new XMLHttpRequest();
+       }
+       catch (e) {
+         // Internet Explorer
+         try {
+           xmlHttp=new ActiveXObject("Msxml2.XMLHTTP");
+         }
+         catch (e) {
+           try {
+             xmlHttp=new ActiveXObject("Microsoft.XMLHTTP");
+           }
+           catch (e) {
+             alert("Your browser does not support AJAX!");
+             return false;
+           }
+         }
+       }
+
+
+
+    // e.g. scriptURL: /greenstone/cgi-bin/metadata-server.pl
+    xmlHttp.open('POST', scriptURL, true); // true means asynchronous
+    xmlHttp.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded');
+
+
+    // If asynchronous:
+    // If the callback param is a function, we will set it up to get called when 
+    // the async post has finished (is ready)
+    // if the callback parameter isn't a function, the param represents a field 
+    // that we want to dynamically update when the async post process has finished
+
+    var typeof_callback = typeof(callback);
+    if ((typeof_callback == "string") || (typeof_callback == "number") || (typeof_callback == "boolean")) {
+        var locid = callback;
+
+        xmlHttp.onreadystatechange=function() {
+        if(xmlHttp.readyState==4) {
+            if (locelem != null) {
+            var locelem = document.getElementById(locid);
+            
+            locelem.innerHTML = xmlHttp.responseText;
+            }
+        }
+        }
+    }
+    else if (typeof_callback == "function") {
+        xmlHttp.onreadystatechange=function() {
+        if(xmlHttp.readyState==4) {
+            callback(xmlHttp); // e.g. this might do: updatepage(xmlHttp.responseText);
+        }
+        }
+    }
+    else {
+        alert("Unrecognized type of callback value: " + typeof_callback);
+    }
+    
+    if(un_ != null) {
+    params += "&un=" + un_;
+    }
+    if(ky_ != null) {
+    params += "&ky=" + ky_;
+    }
+    //alert("Posting Async: " + scriptURL + "?" + params);
+
+    xmlHttp.send(params); // needs to be escaped/encoded
+    // if synchronous, would process xmlHttp AFTER send() call, such as by
+    // accessing xmlHttp.responseText to return that to the caller at this point.
+}
+
+    // New
+    // 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. E.g. where=import|archives|index
+    this.setMetadata = function(docid,metaname,metapos,metavalue,metamode,where)
+    {
+        var mdserver = this.metadataserverURL();
+    
+        var params = "a=set-metadata";
+    if(where != null) {
+        params += "&where=" + where; // if where not specified, meta-server will default to setting index meta
+        //} else {
+        //    params += "&where=import|archives|index";
+    }
+        params += "&c="+collect_;
+        params += "&d="+docid;
+        params += "&metaname=" + metaname;
+        if (metapos!=null) {
+            params += "&metapos=" + metapos;
+        }
+        params += "&metavalue=" + metavalue;
+    if (metamode!=null) {
+            params += "&metamode=" + metamode;
+    }
+    
+        //this.urlGetSync(mdserver + "?" + params);
+        this.urlPostSync(mdserver,params);
+    }
+
+    // New
+    // 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.setMetadataArray = function(docArray,metamode,where) 
+    {
+    docArrayJSON = JSON.stringify(docArray);
+    
+    var mdserver = this.metadataserverURL();
+    
+    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(collect_);
+    params += "&json="+escape(docArrayJSON);
+    
+    if (metamode!=null) {
+        params += "&metamode=" + escape(metamode);
+    }
+    
+    //this.urlGetSync(mdserver + "?" + params);
+    return this.urlPostSync(mdserver,params);   
+    }
+
+    // New
+    this.getArchivesMetadata = function(docoid,metaname,metapos)
+    {
+        var mdserver = this.metadataserverURL();
+    
+        var url = mdserver + "?a=get-archives-metadata";
+        url += "&c="+collect_;
+        url += "&d="+docoid;
+        url += "&metaname=" + metaname;
+        if (metapos!=null) {
+            url += "&metapos=" + metapos;
+        }
+
+    //alert("In getArchivesMeta. URL: " + url)
+        return this.urlGetSync(url); //Once this works, make it POST
+    }
+
+    this.getMetadataArray = function(docArray,where)
+    {
+    docArrayJSON = JSON.stringify(docArray);
+
+    var mdserver = this.metadataserverURL();
+    
+    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(collect_);
+    params += "&json="+escape(docArrayJSON);
+    
+    //this.urlGetSync(mdserver + "?" + params);
+    return this.urlPostSync(mdserver,params);   
+    }
+//*******END OF ADDITIONS TO BRING GS3 VERSION OF THIS FILE UP TO SPEED WITH GS2 VERSION********//
     
     this.setLiveMetadata = function(id,metaname,metavalue)
@@ -155 +386 @@
         this.urlGetSync(url);
     }
-    
+
     this._setMetadata = function(mode,docid,metaname,metapos,metavalue,metamode)
     {
@@ -168 +399 @@
         }
         params += "&metavalue=" + metavalue;
-        if (metamode!=null) {
+    if (metamode!=null) {
             params += "&metamode=" + metamode;
-        }
+    }
     
         this.urlGetSync(mdserver + "?" + params);
@@ -177 +408 @@
     
     
-    this._setDocumentArrayMetadata = function(mode,docArray,metamode) 
-    {
-        docArrayJSON = JSON.stringify(docArray);
-  
-        var mdserver = this.metadataserverURL();
-    
-        var params = "a=set" + mode + "-metadata-array";
-        params += "&c="+collect_;
-        params += "&json="+docArrayJSON;
-    
-        if (metamode!=null) {
-            params += "&metamode=" + metamode;
-        }
-        
-        this.urlGetSync(mdserver + "?" + params);
-   
-    }
+    this._setDocumentArrayMetadata = function(mode,docArray,metamode) 
+    {
+    docArrayJSON = JSON.stringify(docArray);
+    
+    var mdserver = this.metadataserverURL();
+
+    var params = "a=set" + mode + "-metadata-array";
+    params += "&c="+collect_;
+    params += "&json="+docArrayJSON;
+    
+    if (metamode!=null) {
+        params += "&metamode=" + metamode;
+    }
+    
+    this.urlGetSync(mdserver + "?" + params);
+    
+    }
     
     
@@ -210 +441 @@
     }
 
-    this.setDocumentArrayMetadata = function(docArray,metamode) 
-    {
-        //showDialog('Greenstone Javascript API','This sequence of changes has been commited into the system.','success', 2);
-    
-        this._setDocumentArrayMetadata("",docArray,metamode);
-        this._setDocumentArrayMetadata("-archives",docArray,metamode);
-    }
+    this.setDocumentArrayMetadata = function(docArray,metamode) 
+    {
+    //showDialog('Greenstone Javascript API','This sequence of changes has been commited into the system.','success', 2);
+    
+    this._setDocumentArrayMetadata("",docArray,metamode);
+    this._setDocumentArrayMetadata("-archives",docArray,metamode);
+    }
     
     this.setNewDocumentMetadata = function(docid,metaname,metavalue)