Changeset 32893 for main/trunk

Timestamp:

2019-03-11T20:13:33+13:00 (5 years ago)

Author:

ak19

Message:

Part 2 of 2 commits to do with getting errorCallBack working on documentEditing for determining when changes have been saved or not to decided whether editableInitStates can finally be overwritten with current (saved) values. Tested with editing doc meta and doc map meta. Also tested special cases for both: with an meta edit followed by a tomcat restart, which then already warned you it requires a relogin for building to work, until which time editableInitStates is still not overwritten, so that it can warn you of unsaved changes if you attempt to leave the page at any point. The only time these changes don't work as expected (but still works better than original code which just loses your local changes) is when editing doc meta instead of map meta and there's the server restart in the middle and the new value ends up accumulating instead of replacing/overriding the previous value. In the old version of the code, new values were lost and the collection rebuilt, all silently without telling you of data loss.

Location:

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

Files:

• documentedit_scripts_util.js (modified) (6 diffs)
• javascript-global-functions.js (modified) (1 diff)

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

@@ -330 +330 @@
 }
 
+function changesSaved() {
+    console.log("Replacing init states with current states");
+    // Clean changes. We're here because setting meta for all meta changes was successful, so
+    // - update doc's metadata initial states to current:
+    editableInitStates = editableLastStates;        
+    // - update doc's map editors' initial states to current:
+    var map_editors_array = Object.values(gsmap_store);
+    for(var i = 0; i < map_editors_array.length; i++) {
+        var map_editor = map_editors_array[i];
+        map_editor.savedOverlays = JSON.stringify(ShapesUtil.overlayToJSON(map_editor.overlays));
+    }
+}
+
 
 function saveAndRebuild(rebuild) 
@@ -345 +358 @@
     var sendBuildRequest = function()
     {
-        console.log("Replacing init states with current states");
-        // Clean changes. We're here because setting meta for all meta changes was successful, so
-        // - update doc's metadata initial states to current:
-        editableInitStates = editableLastStates;        
-        // - update doc's map editors' initial states to current:
-        var map_editors_array = Object.values(gsmap_store);
-        for(var i = 0; i < map_editors_array.length; i++) {
-            var map_editor = map_editors_array[i];
-            map_editor.savedOverlays = JSON.stringify(ShapesUtil.overlayToJSON(map_editor.overlays));
-        }
-        
-        
         var request = "[";
         for(var i = 0; i < _transactions.length; i++)
@@ -399 +400 @@
                 if (rebuild) {
                     buildCollections(_collectionsToBuild, null, reloadUponRebuild);
-                } else {
+                } else { // no rebuilding
+                    // We're past possible errors at this point. So changes have by now been definitely saved to archives.
+                    // and as there is no rebuilding of the collection, we're now ready to set init states to current states                    
+                    changesSaved();
+                    
                   // reset the save button here
                     enableSaveButtons(true);
@@ -537 +542 @@
 
     
+    var errorCallback = function() {        
+        alert("A server side error occurred during setArchivesMetadata. (Is the server running?)\nNot proceeding further with saving and rebuilding.");
+        return true;
+        
+    }
+    
+    // called on success callback, to check for errors in response. Returns true if response contains the error status code 3
+    var hadErrorResponseOnSave = function(response) {
+        
+        // check response for error status code 3
+        //<status code="3"
+        
+        parser = new DOMParser();
+        xmlDoc = parser.parseFromString(response,"text/xml");
+        
+        // Response may have no status code if metadata changes made and the the server stopped and then restarted and docEditor's building button pressed:
+        // response message returned is that the user is not logged in. Don't handle this scenario here. This function solely checks for error status code===3 in responses.
+        if(xmlDoc.getElementsByTagName("status").length > 0) {
+        
+            var status_code = xmlDoc.getElementsByTagName("status")[0].getAttribute("code");
+            if(status_code === "3") { // status code 3 means error (see GSStatus.java::ERROR)
+                alert("An error occurred during setArchivesMetadata.\nNot proceeding further with saving and rebuilding.\nSee browser's console log for details.");
+                console.log("@@@ Error on setting archive metadata. Got error message: " + response);
+                return true;
+            }
+        }
+        return false;
+
+    }
     
     var processChangesLoop = function(index)
@@ -560 +594 @@
                 // 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, encodeDelimiters(change.value), null, "override", function(){callbackFunction();});
+                gs.functions.setArchivesMetadata(change.collection, gs.xsltParams.site_name, change.docID, change.name, change.metapos, encodeDelimiters(change.value), null, "override",
+                    function(response){ if(!hadErrorResponseOnSave(response)) callbackFunction(); },
+                    errorCallback);                 
             }
           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();});
+            gs.functions.setArchivesMetadata(change.collection, gs.xsltParams.site_name, change.docID, change.name, null, encodeDelimiters(change.value), encodeDelimiters(change.orig), "override",
+                function(response){ if(!hadErrorResponseOnSave(response)) callbackFunction(); },
+                errorCallback);
             }
           else
             {
-            gs.functions.setArchivesMetadata(change.collection, gs.xsltParams.site_name, change.docID, change.name, null, encodeDelimiters(change.value), null, "accumulate", function(){callbackFunction();});
+            gs.functions.setArchivesMetadata(change.collection, gs.xsltParams.site_name, change.docID, change.name, null, encodeDelimiters(change.value), null, "accumulate",
+                function(response){ if(!hadErrorResponseOnSave(response)) callbackFunction(); },
+                errorCallback);
             }
         }
@@ -681 +721 @@
                                     if(counter == collections.length - 1)
                                     {
+                                        // We're here because rebuilding has now completed with no errors.
+                                        // This means changes were definitely successfully saved to archives AND have been rebuilt with NO errors,
+                                        // so set init states to current states:
+                                        changesSaved();
+                                        
                                         removeCollectionsFromBuildList(collections);
                                         if(callback)

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

@@ -533 +533 @@
         
         if(successResponseFunction != null) {
-            
+            //console.log("XXXX callMetaServer - Got response: " + response);
             successResponseFunction(response);
         }
         })
-        .error(function() {
+        .error(function(response) {
             if(errorResponseFunction != null) { 
                 errorResponseFunction(response);