Changeset 27277

Timestamp:

2013-04-29T20:25:28+12:00 (11 years ago)

Author:

ak19

Message:

Adding an Ajax Synchronous Post method to gsajaxapi.js which is then used by the setMetadataArray() that is called from document.dm. Also corrected a variable misspelling in baseaction (authenication changed to authentication) so that locating perl code that deals with authentication may become easier.

Location:

main/trunk/greenstone2

Files:

• macros/document.dm (modified) (4 diffs)
• perllib/cgiactions/baseaction.pm (modified) (3 diffs)
• web/script/gsajaxapi.js (modified) (4 diffs)

main/trunk/greenstone2/macros/document.dm

@@ -151 +151 @@
 <script type="text/javascript">  
 
-    // http://stackoverflow.com/questions/3830244/get-current-date-time-in-seconds
+    // Unused. Replaced in favour of call to escape() in setMetaArray function that calls urlPostSync
+    // http://stackoverflow.com/questions/6020714/escape-html-using-jquery
     function safeHTML(str) \{
          return str.replace("&", "&amp;").replace("<", "&lt;").replace(">", "&gt;").replace('"',"&quot;").replace("'","&#x27;").replace("/", "&#x2F;"); //"\\""
     \} 
+
 
     function addUserComment(_username, _comment, _docid, doc) \{
@@ -163 +165 @@
             _docid = _docid.substring(0, period);
         \}
-        
-        // Entity encode the values before storing (at least <, >, /. And single and double quote, ampersand)
-        // http://stackoverflow.com/questions/6020714/escape-html-using-jquery
-        _username = safeHTML(_username);
-        _comment = safeHTML(_comment);      
+
 
         // Want to store username, timestamp and comment in import/metadata.xml, archives/doc.xml
@@ -183 +181 @@
 
 
-        // To make individual api calls to set username meta, then timestamp then comment meta:
+        // Entity encode the values before storing (at least <, >, /. And single and double quote, ampersand)
+        // http://stackoverflow.com/questions/6020714/escape-html-using-jquery
+        // setMetadataArray escapes the entire JSON, is that better than escaping individually here?
+        //_docid = escape(_docid);
+        //_timestamp = escape(_timestamp);
+        //_username = escape(_username); //safeHTML(_username);
+        //_comment = escape(_comment); //safeHTML(_comment);
+
+        // Use this if making individual api calls to set username meta, then timestamp then comment meta
         // GSAPI already knows the collection
         //gsapi.setMetadata(_docid, "username", null, _username, "accumulate", "import|archives|index");
@@ -222 +228 @@
 
         // GSAPI already knows the collection
-        gsapi.setMetadataArray(docArray, "accumulate","import|archives|index");
-        //doc.AddUserCommentForm.comment.value = "submitted";
-        doc.getElementById("usercommentfeedback").innerHTML = "_textcommentsubmitted_"; //"submitted"; // <p id="feedback"></p>
+        gsapi.setMetadataArray(docArray, "accumulate", "import|archives|index");        
+        doc.AddUserCommentForm.comment.value = "";
+        doc.AddUserCommentForm.username.value = "";
+        doc.getElementById("usercommentfeedback").innerHTML = "_textcommentsubmitted_";
     \}
 </script>

main/trunk/greenstone2/perllib/cgiactions/baseaction.pm

@@ -31 +31 @@
 use inexport;
 
-our $authenication_enabled = 0;
+our $authentication_enabled = 0;
 our $mail_enabled = 0;
 
@@ -71 +71 @@
         $err_mess .= "    Compulsory args: ";
         my @comp_args = ("c");
-        push(@comp_args,"un") if ($authenication_enabled);
+        push(@comp_args,"un") if ($authentication_enabled);
         push(@comp_args,@{$action_table->{$a}->{'compulsory-args'}});
         $err_mess .= join(", ", @comp_args);
@@ -78 +78 @@
 
         my @opt_args = ();
-        push(@opt_args,"un") if (!$authenication_enabled);
+        push(@opt_args,"un") if (!$authentication_enabled);
         push(@opt_args,@{$action_table->{$a}->{'optional-args'}});
 

main/trunk/greenstone2/web/script/gsajaxapi.js

@@ -138 +138 @@
        return xmlHttp.responseText;
     }
-    
+
+    // 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 asynchronous:
+//    xmlHttp.onreadystatechange = function() {
+//        if (xmlHttp.readyState == 4) {
+//            updatepage(xmlHttp.responseText);
+//        }
+//    }
+
+    xmlHttp.send(params); // needs to be escaped/encoded
+
+    //alert(xmlHttp.responseText); // if synchronous, process xmlHttp.responseText AFTER send() call
+    return xmlHttp.responseText;
+}
+
     this.setLiveMetadata = function(id,metaname,metavalue)
     {
@@ -155 +201 @@
     // 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
+    // behaviour of calling set-metadata. E.g. where=import|archives|index
     this.setMetadata = function(docid,metaname,metapos,metavalue,metamode,where)
     {
@@ -177 +223 @@
     }
     
-        this.urlGetSync(mdserver + "?" + params);
-        //this.urlPostSync(mdserver,params);
+        //this.urlGetSync(mdserver + "?" + params);
+        this.urlPostSync(mdserver,params);
     }
 
@@ -191 +237 @@
     var mdserver = this.metadataserverURL();
     
-    var params = "a=set-metadata-array";
+    var params = "a=" + escape("set-metadata-array"); //"a=set-metadata-array";
     if(where != null) {
-        params += "&where=" + where; // if where not specified, meta-server will default to setting index meta
+        params += "&where=" + escape(where); // if where not specified, meta-server will default to setting index meta
         //} else {
         //    params += "&where=import|archives|index";
     }
-    params += "&c="+collect_;
-    params += "&json="+docArrayJSON;
+    params += "&c="+escape(collect_);
+    params += "&json="+escape(docArrayJSON);
     
     if (metamode!=null) {
-        params += "&metamode=" + metamode;
-    }
-    
-    this.urlGetSync(mdserver + "?" + params);
-    
+        params += "&metamode=" + escape(metamode);
+    }
+    
+    //this.urlGetSync(mdserver + "?" + params);
+    this.urlPostSync(mdserver,params);  
     }