Changeset 32838

Timestamp:

2019-03-02T19:41:08+13:00 (5 years ago)

Author:

ak19

Message:

Save and rebuild works with map, but as with save shortcut key on map editor, the metamode ends up as accumulate still in doc.xml. Some other issues (not related to saveandrebuild) need fixing up like a popup about unsaved changes appearing even after save and rebuild has finished and possibly more things).

Location:

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

Files:

• documentedit_scripts.js (modified) (1 diff)
• documentedit_scripts_util.js (modified) (3 diffs)
• map-scripts-editor.js (modified) (6 diffs)

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

@@ -117 +117 @@
 
 var gsmap_store = {};
+var gps_metadata_name = "GPS.mapOverlay";
 
 // Called by documentedit_scripts_util.js when saving and rebuilding.
 // This function should return all the doc sections' map overlay data so that
 // setArchivesMetadata can be called for each and the entire collection rebuilt with the changes
-function getDocMapsEditDataForSaving() {
+function getDocMapsEditDataForSaving(collName) {
     var map_editors_array = Object.values(gsmap_store);
     var modifiedMaps = []; // the array that is the return value: an array of only all the modified maps
     
-    // get collection name
-    var coll = gs.cgiParams.c;
-
     
     for(var i = 0; i < map_editors_array.length; i++) {
         var map_editor = map_editors_array[i];
-        var oldMapData = map_editor.savedOverlays;
-        var newMapData = JSON.stringify(ShapesUtil.overlayToJSON(map_editor.overlays));
+        var oldMapData = map_editor.savedOverlays; // stringified JSON shape
+        var newMapData = JSON.stringify(ShapesUtil.overlayToJSON(map_editor.overlays)); // stringified JSON shape too
         
-        if(oldMapData !== newMapData) {
+        // We only consider a map editor's map data to have been modified in the following cases:
+        // - if oldMapData is null, new mapData should not be empty array
+        // - OR oldMapData had some value and it's not the same as newMapData
+        if(!oldMapData && newMapData !== "[]" /*|| oldMapData && oldMapData !== newMapData*/) {
+            var nodeID = map_editors_array[i].id;
+            console.log("old vs new mapdata for nodeID " + nodeID);
+            console.log(oldMapData);
+            console.log(newMapData);
             
-            var nodeID = map_editors_array[i].id;
-            var val = map_editors_array[i].overlays;
             modifiedMaps.push({
-                collection: coll,
+                collection: collName,
                 docID: nodeID,
-                name:"GSP.mapOverlay",
-                pos: 0,
+                name:gps_metadata_name,
+                metapos: 0,
                 value:newMapData                
             });

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

@@ -447 +447 @@
 
   var changes = changesToUpdate();
+  
   //Clean changes
   editableInitStates = editableLastStates;
+  
     for(var i = 0; i < changes.length; i++)
     {
         var changedElem = changes[i];
-        //Save metadata     
+        //Save metadata
+        
         if(gs.functions.hasClass(changedElem, "metaTableCellArea")) 
         {
@@ -514 +517 @@
     }
 
+    // Check for changes to any map editors in the document
+    var modified_map_editors_data = getDocMapsEditDataForSaving(gs.cgiParams.c); // collection  
+    for(var i = 0; i < modified_map_editors_data.length; i++) {     
+        metadataChanges.push(modified_map_editors_data[i]); // of the form { collection: gs.cgiParams.c, docID: nodeID, name:"GSP.mapOverlay", metapos: 0, value: <stringifiedJSON> }
+        addCollectionToBuild(gs.cgiParams.c); // collection
+    }
+
+    
     
     var processChangesLoop = function(index)
     {
-      
         var change = metadataChanges[index];
-        
+                
         var callbackFunction;
         if(index + 1 == metadataChanges.length)
@@ -532 +542 @@
             gs.functions.removeArchivesMetadata(collection, gs.xsltParams.site_name, change.docID, change.name, null, encodeDelimiters(change.value), function(){callbackFunction();});
         } else {
-          if(change.orig)
+          // Checking "if(change.metapos)" doesn't work for us as it becomes false when the property doesn't exist AND when the property is 0. But metapos IS 0 for us.
+          // https://ultimatecourses.com/blog/methods-to-determine-if-an-object-has-a-given-property
+          if('metapos' in change && change.metapos === 0) {// && change.metapos === 0) { // for maps
+                
+                // collection, site, documentID, metadataName, metadataPosition, metadataValue, prevMetadataValue, metamode, responseFunction               
+                //console.log("@@@ metapos! change: ", change);
+                gs.functions.setArchivesMetadata(change.collection, gs.xsltParams.site_name, change.docID, change.name, change.metapos, change.value /*TODO: encodeDelimiters(change.value)*/, null, "override", function(){callbackFunction();});
+            }
+          else if(change.orig)
             {
             gs.functions.setArchivesMetadata(change.collection, gs.xsltParams.site_name, change.docID, change.name, null, encodeDelimiters(change.value), encodeDelimiters(change.orig), "override", function(){callbackFunction();});

main/trunk/greenstone3/web/interfaces/default/js/map-scripts-editor.js

@@ -111 +111 @@
         console.log(enableMessage);
         
-        
+        // Comment out following section in entirety -- from "e=e" to end of "if(e)" -- if
+        // you don't want to see the popup about changes that haven't been saved yet
         e = e || window.event;
         // For IE and Firefox
@@ -126 +127 @@
             }               
         }
+        
     }
 }
@@ -332 +334 @@
     //Keyboard shortcuts            
     var mapAndControls = document.getElementById("map-and-controls-" + this.id); 
-    console.log("@@@@ initMapEditor. mapAndControls: " + mapAndControls);
+    console.log("@@@@ initMapEditor. mapAndControls: ", mapAndControls);
     
     //Sets shift as unpressed
@@ -399 +401 @@
     var site_name = gs.xsltParams.site_name;
     var nodeID = this.id; // documentID, hopefully contains section ID too
-    var metaname = "GPS.mapOverlay";
-    
+    var metaname = gps_metadata_name;
+        
     // collection, site, documentID, metadataName, metadataPosition, responseFunction
     gs.functions.getArchivesMetadata(collection, site_name, nodeID, metaname, 0, function(responseText){
@@ -660 +662 @@
     console.log("Save pressed");
     
-    var json_overlays = ShapesUtil.overlayToJSON(this.overlays);
+    var json_overlays = JSON.stringify(ShapesUtil.overlayToJSON(this.overlays));    
+    that.savedOverlays = json_overlays; // save the old version to compare with future changes
     var collection = gs.cgiParams.c;
     var site_name = gs.xsltParams.site_name;
@@ -667 +670 @@
     
     // collection, site, documentID, metadataName, metadataPosition, metadataValue, prevMetadataValue, metamode, responseFunction   
-    gs.functions.setArchivesMetadata(collection, site_name, nodeID, metaname, 0, JSON.stringify(json_overlays), null, "override", function(){
+    gs.functions.setArchivesMetadata(collection, site_name, nodeID, metaname, 0, json_overlays, null, "override", function(){
             console.log("SAVED");
         }
     );
     
-    gs.functions.getArchivesMetadata(collection, site_name, nodeID, metaname, 0, function(responseText){
+    /*gs.functions.getArchivesMetadata(collection, site_name, nodeID, metaname, 0, function(responseText){
             var JSONString = responseText.getValue();
             that.savedOverlays = JSONString;
         }
-    );  
+    );*/
+    
     
 }