Changeset 38188 for main/trunk/greenstone3

Timestamp:

2023-09-21T21:46:13+12:00 (8 months ago)

Author:

anupama

Message:

GUI infrastructure for admin to delete user comments is now in place. Actual remove operations not yet implemented, but to be done in 2 phases. In first phase, call the basic remove-metadata(index/archives/index) for each username, comment and timestamp in turn. In second phase, need to add remove-metadata-array functions, so it can be called on all metadata to be removed in one go, as with set-metadata-array called by addUserComments.

Location:

main/trunk/greenstone3/web/interfaces/default

Files:

• js/javascript-global-functions.js (modified) (2 diffs)
• js/user_comments.js (modified) (8 diffs)
• transform/layouts/usercomments.xsl (modified) (2 diffs)

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

@@ -601 +601 @@
 
 // Prepare the payload (data package) to transmit to metadataserver.pl over AJAX.
-// These next 2 functions prepare both the URL version of the payload and the data object version of 
+// These next 2 functions prepare both the URL version of the payload and the data object version 
 // of the payload. Then calling functions, and the _callMetadataServer() function they call, will control
 // and determine which of the two forms ultimately gets used.
@@ -610 +610 @@
 {
     // if we're doing set- or remove- metadata operations,
-    // then we need change the data params that will make up the query string
+    // then we need to change the data params that will make up the query string
     // to make sure we go through GS3's authentication
     // 1. prefix meta names with s1,

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

@@ -95 +95 @@
 }
 
+
 gs.usercomments.loadedUserComments = function(data)
 {
@@ -119 +120 @@
     var i = 0;
     var looping = true;
+
+    var canDeleteComments = gs.variables["userCanDeleteComments"];
+    //alert("canDeleteComments: " + canDeleteComments);
     
     
@@ -153 +157 @@
         
         // for each usercomment, create a child div with the username, timestamp and comment
-        gs.usercomments.displayInUserCommentList(usercommentdiv, username, timestamp, comment);
+        gs.usercomments.displayInUserCommentList(usercommentdiv, username, timestamp, comment, canDeleteComments);
         
         i++;
     }       
+    }
+    
+    if(canDeleteComments) {
+    var delCommentsButton = document.createElement("button");
+    delCommentsButton.innerHTML = "Delete selected";
+    delCommentsButton.setAttribute("id", "del-selected-comments-button");   
+    //delCommentsButton.setAttribute("onclick", gs.usercomments.deleteSelectedComments);
+    // alternatively: https://www.w3schools.com/jsref/met_element_addeventlistener.asp
+    delCommentsButton.addEventListener("click", gs.usercomments.deleteSelectedComments);
+    usercommentdiv.appendChild(delCommentsButton);
+    
     }
     
@@ -168 +183 @@
 
 
-gs.usercomments.displayInUserCommentList = function(usercommentdiv, username, timestamp, comment) {
+gs.usercomments.displayInUserCommentList = function(usercommentdiv, username, timestamp, comment, canDeleteComments) {
     
     var divgroup=document.createElement("div");
@@ -178 +193 @@
     var divtime=document.createElement("div");
     var divcomment=document.createElement("div");
-    
+
     
     divgroup.appendChild(divuser);
     var txt=document.createTextNode(username);
+    if(canDeleteComments) {
+    var deleteCheckBox = document.createElement("input");
+    deleteCheckBox.setAttribute("type", "checkbox");
+    deleteCheckBox.setAttribute("class", "del-me-comment");
+    deleteCheckBox.setAttribute("data-user", username);
+    deleteCheckBox.setAttribute("data-timestamp", timestamp);
+    deleteCheckBox.setAttribute("data-comment", comment);
+    divuser.appendChild(deleteCheckBox);
+    }    
     divuser.appendChild(txt);
     
@@ -200 +224 @@
     
 }
+
+
+gs.usercomments.deleteSelectedComments = function() {
+    // https://stackoverflow.com/questions/590018/getting-all-selected-checkboxes-in-an-array
+    // https://stackoverflow.com/questions/6166763/jquery-multiple-checkboxes-array
+
+    //var selectedComments = document.getElementsByClassName("del-me-comment");
+    // var selectedComments = document.querySelectorAll('input[class=del-me-comment]:checked');
+    var selectedComments = document.querySelectorAll('input[class=del-me-comment][type=checkbox]:checked');
+
+    if(selectedComments.length==0) {    
+    alert("Delete pressed, but nothing selected");
+    } else {
+    //alert("Delete pressed " + selectedComments.length);
+    alert("Delete pressed for docID: " + gs.variables["docID"]
+          + " on num comments: " + selectedComments.length);
+    }   
+}
+
+
+/*
+gs.usercomments.removeUserComment = function (_usernames, _timestamps, _comments, _docid, doc,
+          opt_metaname_username, opt_metaname_usertimestamp, opt_metaname_usercomment)
+{
+    // Want to remove usernames, timestamps and comments from import/metadata.xml,
+    // archives/doc.xml and index/col.gdb.
+    
+    // Need to the add user comment meta of username, timestamp and comment to the
+    // topmost section of the document. So only get the docId up to any period mark:
+    var period = _docid.indexOf(".");
+    if(period != -1) {
+    _docid = _docid.substring(0, period);
+    }
+    
+    // Use the new JSON metatable format to remove list of usernames, their matching timestamps and comments meta for docid in one go
+    // 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"
+    metavals: _usernames
+    };
+    
+    var timestamp_rec = {
+    metaname: opt_metaname_usertimestamp || gs.usercomments.defaults.metaname_usertimestamp, // e.g. "usertimestamp"
+    metavals: _timestamps
+    };
+    
+    var comment_rec = {
+    metaname: opt_metaname_usercomment || gs.usercomments.defaults.metaname_usercomment, // e.g. "usercomment"
+    metavals: _comments
+    };
+    
+    var doc_rec = {
+    docid: _docid,
+    metatable: [username_rec, timestamp_rec, comment_rec],
+    metamode: "accumulate" // TODO
+    };
+    
+    var docArray = [doc_rec];
+    
+    // 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;
+    }
+
+    // There is no remove array version yet!!!
+    
+    //var result = gs.functions.setMetadataArray(gs.variables["c"], gs.variables["site"], docArray, "accumulate", "import|archives|index");
+    gs.functions.removeMetadataArray(gs.variables["c"],
+    gs.variables["site"],
+    docArray, "accumulate",
+    "import|archives|index",
+    function(ajaxResult) { return gs.usercomments.doneUpdatingMetatada(ajaxResult, _username, _timestamp, _comment); },
+    true); // true for synchronous, meaning is opposite to explanation for addUserComment() function below   
+    
+}
+*/
 
 gs.usercomments.addUserComment = function(_username, _comment, _docid, doc,
@@ -268 +374 @@
     var docArray = [doc_rec];
     
-    // Don't allow the user to submit further comments until the metadata has been updated
+    // 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;
+    }
     
     //var result = gs.functions.setMetadataArray(gs.variables["c"], gs.variables["site"], docArray, "accumulate", "import|archives|index");
@@ -329 +439 @@
     // that the set-meta-array operation has completed.
     document.getElementById("usercommentSubmitButton").disabled = false;
+    var delCommentsButton = document.getElementById("delCommentsButton");
+    if(delCommentsButton != undefined) {
+    delCommentsButton.disabled = false;
+    }
+    
 }
 

main/trunk/greenstone3/web/interfaces/default/transform/layouts/usercomments.xsl

@@ -42 +42 @@
   <gsf:variable name="textcommentsubmitted"><xsl:value-of select="util:getInterfaceText($interface_name, /page/@lang, 'usercomments.submitted')"/></gsf:variable>
 
+
+  <gsf:variable name="userCanDeleteComments">
+    <xsl:choose>
+      <xsl:when test="/page/pageRequest/userInformation and (util:csvContains(/page/pageRequest/userInformation/@groups, 'administrator'))">1</xsl:when><xsl:otherwise>0</xsl:otherwise>
+    </xsl:choose>
+  </gsf:variable>
+  <gsf:variable name="docID"><xsl:value-of select="/page/pageRequest/paramList/param[@name='d']/@value"/></gsf:variable>
+  
   <!-- 2. Load the javascript, which will do stuff on window load/ready for which it needs the above gs.variables -->
   <script type="text/javascript" src="interfaces/{$interface_name}/js/gsajaxapi.js"><xsl:text> </xsl:text></script>
@@ -53 +61 @@
        previously submitted comments exist, or if the form#usercommentform to add
        a new comment is displayed. Otherwise only the "Add Comments" link is shown. -->
-      <xsl:comment>Existing comments will be loaded dynamically loaded into this div#usercomments</xsl:comment>
+      <xsl:comment>Existing comments will be dynamically loaded into this div#usercomments</xsl:comment>
     </div>