Changeset 38218 for main/trunk/greenstone3/web

Timestamp:

2023-09-25T23:04:59+13:00 (9 months ago)

Author:

anupama

Message:

Added code in user_comments.js for the compound remove_metadata_array to get called. There's debug statements in this and in java-global-functions.js, that's because I'm still working on it. But I don't want the code to get lost in the upcoming move to another lab sometime this week.

Location:

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

Files:

• javascript-global-functions.js (modified) (2 diffs)
• user_comments.js (modified) (8 diffs)

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

@@ -1020 +1020 @@
 }
 
-// metamode (such as accumulate) has no meaning when removingMetadata,
-// so best not make it an option to avoid confusing callers?
-gs.functions.removeMetadataArray = function(collection, site, docArray, /*metamode,*/
+// metamode=override is in theory supported by remove_archives and remove_import metadata
+// but not by remove_index and remove_live metadata. However, even in the former 2 cases,
+// passing in metamode=override still appears to be ineffective, see recent svn revision 38193.
+// And metamode accumulate prevents all removal.
+// So for now, this function forces metamode to null, regardless of what is passed in.
+// At least this ensures a more consistent effect with remove_index (and remove_live) functions.
+gs.functions.removeMetadataArray = function(collection, site, docArray, metamode,
             where, successResponseFunction, forceSync, errorResponseFunction) 
-{  
+{
+    alert("in gs.functions.removeMetaArray START");
+    
     if( typeof errorResponseFunction === 'undefined' ) { errorResponseFunction = null; } // force error callback to be defined: either null or has value
 
@@ -1038 +1044 @@
     
     var response = gs.functions._callMetadataServer("Removing metadata from "+where, payload, successResponseFunction, errorResponseFunction, {"forceSync": forceSync, "requestMethod": "POST"});
-    
+
+    console.log("in gs.functions.removeMetaArray: " + JSON.stringify(payload));
+    
     return response;
 }

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

@@ -167 +167 @@
     //delCommentsButton.setAttribute("onclick", gs.usercomments.deleteSelectedComments);
     // alternatively: https://www.w3schools.com/jsref/met_element_addeventlistener.asp
-    delCommentsButton.addEventListener("click", gs.usercomments.deleteSelectedComments);
+
+    delCommentsButton.addEventListener("click", gs.usercomments.removeSelectedComments);
+    // Arduous way: deletes each metadata individually
+    //delCommentsButton.addEventListener("click", gs.usercomments.deleteSelectedComments);
     
     delButtonDiv.appendChild(delCommentsButton);
@@ -238 +241 @@
 }
 
+// Uses remove array to remove multiple metadata in one ajax call
+gs.usercomments.removeSelectedComments = function(eventObject, opt_metaname_username, opt_metaname_usertimestamp, opt_metaname_usercomment)
+{
+    // https://stackoverflow.com/questions/590018/getting-all-selected-checkboxes-in-an-array
+    // https://stackoverflow.com/questions/6166763/jquery-multiple-checkboxes-array
+
+    var selectedComments = document.querySelectorAll('input[class=del-me-comment][type=checkbox]:checked');
+
+    if(selectedComments.length > 0) {   
+    
+    // Don't allow the user to submit further comments or delete comments
+    // until the metadata has been updated
+    document.getElementById("usercommentSubmitButton").disabled = true;
+    var delCommentsButton = document.getElementById("delCommentsButton");
+    if(delCommentsButton != undefined) {// should be defined when in this function
+        delCommentsButton.disabled = true;
+    }
+
+    // User comment meta are at topmost section of the document.
+    // So only get the docId up to any period mark:
+    var _docid = document.AddUserCommentForm.d.value;   
+    var period = _docid.indexOf(".");
+    if(period != -1) {
+        _docid = _docid.substring(0, period);
+    }
+    
+    //document.querySelectorAll('input[class=del-me-comment][type=checkbox]:checked').forEach(elem => console.log(elem.getAttribute('data-username')));
+
+    var metadataPositions = [];
+    var failure = false;
+
+    // start deleting from end of metadata list, so we don't have to recalculate metapos each time
+    for (var i = 0; i < selectedComments.length; i++) {
+
+        var metapos = selectedComments[i].getAttribute("data-metapos");
+        metadataPositions.push(metapos); // add metapos to end of array
+    }
+    }    
+    
+    // now we have all the metapositions we need to delete
+    // create a JSON of indicating the username, timestamp and comment metadata need to be deleted
+    // at all those metapositions
+    
+    // removeMetadataArray escapes the entire JSON, so we don't individually escape the fields here
+
+    // For creating the JSON object that gets turned into a string, see
+    // http://msdn.microsoft.com/en-us/library/ie/cc836459%28v=vs.94%29.aspx
+    // http://jsfiddle.net/qmacro/W54hy/
+    
+    var username_rec = {
+    metaname: opt_metaname_username || gs.usercomments.defaults.metaname_username, // e.g. "username"
+    metapositions: metadataPositions
+    };
+    
+    var timestamp_rec = {
+    metaname: opt_metaname_usertimestamp || gs.usercomments.defaults.metaname_usertimestamp, // e.g. "usertimestamp"
+    metavals: metadataPositions
+    };
+    
+    var comment_rec = {
+    metaname: opt_metaname_usercomment || gs.usercomments.defaults.metaname_usercomment, // e.g. "usercomment"
+    metavals: metadataPositions
+    };
+    
+    var doc_rec = {
+    docid: _docid,
+    metatable: [username_rec, timestamp_rec, comment_rec],
+    //metamode: "accumulate"
+    };
+    
+    var docArray = [doc_rec];
+
+    // Don't allow the user to submit further comments or delete any
+    // until the metadata has been updated
+    document.getElementById("usercommentSubmitButton").disabled = true;
+    var delCommentsButton = document.getElementById("delCommentsButton");
+    if(delCommentsButton != undefined) {
+    delCommentsButton.disabled = true;
+    }
+
+    
+    gs.functions.removeMetadataArray(
+    gs.variables["c"],
+    gs.variables["site"],
+    docArray,
+    null, //metamode
+    "import|archives|index",
+    function(ajaxResult) { return gs.usercomments.doneRemovingMetadata(ajaxResult, metadataPositions); },
+    false, // false for asynchronous, see comment in gs.usercomments.addUserComment()
+    function(ajaxError) { return gs.usercomments.removeMultipleCommentsFailed(ajaxError); }
+    );
+    
+
+    //console.log("username: " + opt_metaname_username + " - " + gs.usercomments.defaults.metaname_username);
+    console.log("metapositions to remove: " + metadataPositions);
+    console.log("docArray:\n" + JSON.stringify(docArray));
+}
+
+gs.usercomments.removeMultipleCommentsFailed = function(data) {
+    var result = (data.responseText) ? data.responseText : data;
+    alert("Remove failed. Got: " + result);
+    failure = true;
+
+    // TODO, force a page reload so that the usercomments' state somewhat better reflects what's in DBs
+}
+
+
+// Removes single metadata at a time
 gs.usercomments.deleteSelectedComments = function() {
     // https://stackoverflow.com/questions/590018/getting-all-selected-checkboxes-in-an-array
@@ -282 +393 @@
                          gs.variables["site"],
                          _docid,
-                         "gs.username",
+                         gs.usercomments.defaults.metaname_username,
                          metapos, 
                          //"import|archives|index",
@@ -295 +406 @@
                          gs.variables["site"],
                          _docid,
-                         "gs.usertimestamp",
+                         gs.usercomments.defaults.metaname_usertimestamp,
                          metapos, 
                          //"import|archives|index",
@@ -308 +419 @@
                          gs.variables["site"],
                          _docid,
-                         "gs.usercomment",
+                         gs.usercomments.defaults.metaname_usercomment,
                          metapos, 
                          //"import|archives|index",
@@ -322 +433 @@
     //console.log("modifiedMetapos: " + modifiedMetapos);
 
-    gs.usercomments.doneRemovingMetadata(modifiedMetapos);
+    gs.usercomments.doneRemovingMetadata(null, modifiedMetapos);
     }
 }
@@ -337 +448 @@
 }
 
-gs.usercomments.doneRemovingMetadata = function(modifiedMetapos) {
+gs.usercomments.doneRemovingMetadata = function(data, modifiedMetapos) {
+
+    // data is xmlHttpRequest Object if gsajaxapi is used for the ajax call.
+    // And data is a string if jQuery AJAX was used.
+    // Using JavaScript's feature sensing to detect which of the two we're dealing with:
+    var result = (data.responseText) ? data.responseText : data;        
+
+    //alert(result);
+    console.log("@@@ Done removing metadata:\n" + result);
+    
     var userCommentsDiv = document.getElementById("usercomments");
         
@@ -524 +644 @@
 
 gs.usercomments.doneUpdatingMetatada = function(data, _username, _timestamp, _comment)
-{
+{   
     // data is xmlHttpRequest Object if gsajaxapi is used for the ajax call.
     // And data is a string if jQuery AJAX was used.