Changeset 38422

Timestamp:

2023-11-21T17:24:00+13:00 (3 weeks ago)

Author:

anupama

Message:

1. Moved the code that processes which prepares user comments marked for deletion into documentedit_scripts_usercomments.js (out of documentedit_scripts_util.js). 2. Call to encodeDelimiters(metaval) when preparing user comments to be edited, to match what document editing code does.

Location:

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

Files:

• documentedit_scripts_usercomments.js (modified) (3 diffs)
• documentedit_scripts_util.js (modified) (3 diffs)

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

@@ -1 +1 @@
 /** Javascript file for editing and especially deleting user comments in a documentediting situation */
 
-// Skeleton function that may be called by documentedit_scripts_util.js when saving and rebuilding.
-// This function should return all the doc sections' (actually only root section's) usercomments data so that
-// setArchivesMetadata can be called for root section and the entire collection rebuilt with the changes
+// Function called by documentedit_scripts_util.js when saving and rebuilding.
+// This function should return usercomments data (only exists for doc root's section) so that
+// setMetadataArray can be called for doc root and the entire collection rebuilt with the changes
 function getUserCommentsEditDataForSaving(userCommentsMetaFields, userCommentsRowsChanged) {
     // https://medium.com/@martin.crabtree/javascript-tracking-key-value-pairs-using-hashmaps-7de6df598257
@@ -20 +20 @@
     var metaval = changedElem.value; //changedElem.textContent; // gets orig value
     metaval = metaval.replace(/ /g, " "); // copied from docedit_scripts_utl, when procsesing the array called changes.
+    metaval = encodeDelimiters(metaval);
     
     var currentElem = changedElem;
@@ -62 +63 @@
     }
     
+    return docArray;
+}
+
+// Function called by documentedit_scripts_util.js when saving and rebuilding.
+// This function should return usercomments data (only exists for doc root's section) so that
+// removeMetadataArray can be called for doc root and the collection rebuilt with the deletions
+function getUserCommentsDeletions(userCommentsMetaFields, docids_to_delCommentsMetapositions) {
+    
+    var docids = Object.keys(docids_to_delCommentsMetapositions);
+    var docArray = [];
+    for(i = 0; i < docids.length; i++) { //if(docids.length > 0) {
+      var _docid = docids[i];
+      var delCommentsMetapositions = docids_to_delCommentsMetapositions[_docid];
+      
+
+      // build up the data structure for all the usercomments to be deleted
+      if(delCommentsMetapositions.length > 0) {
+      //console.log("About to delete position: " + delCommentsMetapositions);
+      var timestamp_rec = {
+          metaname: userCommentsMetaFields[0],
+          metapositions: delCommentsMetapositions
+      };
+      var username_rec = {
+          metaname: userCommentsMetaFields[1],
+          metapositions: delCommentsMetapositions
+      };    
+      var comment_rec = {
+          metaname: userCommentsMetaFields[2],
+          metapositions: delCommentsMetapositions
+      };
+    
+    
+      var doc_rec = {
+          docid: _docid,
+          metatable: [username_rec, timestamp_rec, comment_rec]
+      };
+
+      docArray.push(doc_rec);    
+      }
+    }
+
     return docArray;
 }

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

@@ -480 +480 @@
         docids_to_delCommentsMetapositions[docID].push(metapos);
         
-        
         //console.log("docID : " + docID + " - metapos: " + metapos);
     }
@@ -502 +501 @@
     }
 
-    var docids = Object.keys(docids_to_delCommentsMetapositions);
-    var docArray = [];
-    for(i = 0; i < docids.length; i++) { //if(docids.length > 0) {
-      var _docid = docids[i];
-      var delCommentsMetapositions = docids_to_delCommentsMetapositions[_docid];
-      
-
-      // build up the data structure for all the usercomments to be deleted
-      if(delCommentsMetapositions.length > 0) {
-      //console.log("About to delete position: " + delCommentsMetapositions);
-      var timestamp_rec = {
-          metaname: userCommentsMetaFields[0],
-          metapositions: delCommentsMetapositions
-      };
-      var username_rec = {
-          metaname: userCommentsMetaFields[1],
-          metapositions: delCommentsMetapositions
-      };    
-      var comment_rec = {
-          metaname: userCommentsMetaFields[2],
-          metapositions: delCommentsMetapositions
-      };
-    
-    
-      var doc_rec = {
-          docid: _docid,
-          metatable: [username_rec, timestamp_rec, comment_rec]
-      };
-
-      docArray.push(doc_rec);    
-      }
-    }
-
-    if(docArray.length > 0) {// or if(docids.length > 0)
+    // we can now process the deleted user comments, by organizing them into a single JSON
+    // so that a single call to removeMetadataArray can delete them all more efficiently
+    var docArray = getUserCommentsDeletions(
+    userCommentsMetaFields, docids_to_delCommentsMetapositions);
+   
+    if(docArray.length > 0) {
     metadataChanges.push({type:'deleteUserComments', docArray:docArray});
     addCollectionToBuild(collection);
@@ -542 +513 @@
     docArray = [];
     docids_to_delCommentsMetapositions = {};
-    docids = [];
+
   }