Changeset 2128

Timestamp:

Nov 11, 2013, 10:48:59 AM (10 years ago)

Author:

Nicklas Nordborg

Message:

References #489: Histology scoring wizard

Several improvements to saving and error handling:

• Support for 'keep session alive' to reduce the risk of automatic logout during data entry
• Warning about unsaved data should now work for all cases when navigating to another page
• Using local storage to temporary store info on the local computer. Useful if computer/browser crashes and it is possible to restore all entered information.

File:

• extensions/net.sf.basedb.reggie/branches/ticket-489/resources/sampleproc/histology_score.jsp (modified) (18 diffs)

extensions/net.sf.basedb.reggie/branches/ticket-489/resources/sampleproc/histology_score.jsp

@@ -40 +40 @@
 var heGlass;
 
+var disableModificationCheck = false;
+
 var SCORES = ['ScoreInvasiveCancer', 'ScoreInsituCancer', 'ScoreLymphocytes', 'ScoreNormal', 'ScoreStroma', 'ScoreFat'];
 var FIELDS = ['score_invasive_cancer', 'score_insitu_cancer', 'score_lymphocytes', 'score_normal', 'score_stroma', 'score_fat'];
@@ -72 +74 @@
         
         saveOriginalProperties(sample);
+        restoreFromLocalStorage(sample);
         
         // Save ID of HE glass since we need that later
@@ -105 +108 @@
     Main.show('gocreate');
     window.addEventListener('beforeunload', confirmIfModified);
-
+    
+    keepSessionAlive('<%=ID%>', debug && false, '../');
   }
   else
@@ -143 +147 @@
   o.GoodStain = sample.GoodStain;
   o.ScoreComplete = sample.ScoreComplete;
+  o.comments = sample.comments;
   sample.o = o;
   sample.isModified = false;
@@ -152 +157 @@
 function isModified(sample, useCache)
 {
-  if (useCache)
-  {
-    return sample.isModified;
-  }
-  var o = sample.o;
-  for (var p in o)
-  {
-    if (o[p] != sample[p]) return true;
-  }
-  return false;
+  if (!useCache)
+  {
+    var o = sample.o;
+    sample.isModified = false;
+    for (var p in o)
+    {
+      if (o[p] != sample[p])
+      {
+        sample.isModified = true;
+        break;
+      }
+    }
+  }
+  return sample.isModified;
 }
 
@@ -170 +179 @@
   {
     glassName = frm.findGlassName.value;
+    if (!glassName) return;
+    
     if (glassName.match(/^\d+$/))
     {
@@ -185 +196 @@
   }
   
-  location.href = url;
+  location.replace(url);
 }
 
 function selectHeGlass()
 {
+  if (!confirmIfModified()) return;
+  
   var url = getRoot() + 'biomaterials/bioplates/index.jsp?ID=<%=ID%>&cmd=UpdateContext&mode=selectone';
   url += '&resetTemporary=1';
@@ -199 +212 @@
 function setSelectedHeGlass(id, name)
 {
+  disableModificationCheck = true;
   findHeGlass(name);
 }
@@ -352 +366 @@
   
   // Comments
-  frm.comments.value = sample.comments;
+  frm.comments.value = sample.comments || '';
   
   // Class name of selected table cell
@@ -416 +430 @@
     frm.score_complete.disabled = true;
     frm.score_complete.checked = false;
-    
-    if (selectedSample.ScoreTotal != null)
-    {
-      selectedSample.ScoreComplete = false;
-      setInputStatus('score_total', 'Not 100%', 'warning');
-    }
-    else
-    {
-      selectedSample.ScoreComplete = null;
-      setInputStatus('score_total', '', '');
-    }
+
+    setInputStatus('score_total', 'Not 100%', 'warning');
+    selectedSample.ScoreComplete = selectedSample.ScoreTotal == null ? null : false;
   }
 
   setSampleClassName(selectedSample);
+  saveToLocalStorage(selectedSample);
 }
 
@@ -464 +471 @@
   selectedSample.ScoreComplete = frm.score_complete.checked;
   setSampleClassName(selectedSample);
+  saveToLocalStorage(selectedSample);
 }
 
@@ -482 +490 @@
         sample.GoodStain = null;
         setSampleClassName(sample);
+        saveToLocalStorage(sample);
       }
     }
@@ -489 +498 @@
   frm.good_stain.disabled = true;
   setSampleClassName(selectedSample);
+  saveToLocalStorage(selectedSample);
 }
 
@@ -495 +505 @@
   var frm = document.forms['reggie'];
   selectedSample.comments = frm.comments.value;
+  setSampleClassName(selectedSample);
+  saveToLocalStorage(selectedSample);
 }
 
@@ -564 +576 @@
 function confirmIfModified(event)
 {
+  if (disableModificationCheck) return;
+  
   var numModified = 0;
   for (var glassNo = 0; glassNo < heGlass.length; glassNo++)
@@ -578 +592 @@
   }
   
-  var okToContinue = true;
-  if (numModified > 0)
-  {
-    if (event) 
+  if (event) 
+  {
+    if (numModified > 0)
     {
       event.returnValue = 'There are unsaved modifications. Continue?';
-    }
-    else
-    {
-      if (!confirm('There are unsaved modifications. Continue?'))
-      {
-        okToContinue = false;
-      }
-    }
-  }
-  
-  return okToContinue;
+      return event.returnValue;
+    }
+  }
+  else
+  {
+    return confirm('There are unsaved modifications. Continue?');
+  }
+  
 }
 
@@ -667 +677 @@
   }
   
+  // Reset changed properties and remove saved info
+  for (var sampleNo = 0; sampleNo < samples.length; sampleNo++)
+  {
+    var sample = samples[sampleNo];
+    saveOriginalProperties(sample);
+    setSampleClassName(sample);
+    removeFromLocalStorage(sample);
+  }
+
+  
   var msg = '<ul>';
   for (var i = 0; i < response.messages.length; i++)
@@ -679 +699 @@
   Main.hide('gocreate');
 
+}
+
+
+/**
+  Save score information to the local storage.
+*/
+function saveToLocalStorage(sample)
+{
+  if (window.localStorage && isModified(sample, true))
+  {
+    var storeKey = getStoreKey(sample);
+    window.localStorage.setItem(storeKey, JSON.stringify(sample));
+    if (debug)
+    {
+      Main.debug('saveToLocalStorage: ' + sample.name + '=' + window.localStorage.getItem(storeKey));
+    }
+  }
+}
+
+function removeFromLocalStorage(sample)
+{
+  if (!window.localStorage) return;
+  if (debug) Main.debug('removeFromLocalStorage:' + sample.name);
+  window.localStorage.removeItem(getStoreKey(sample));
+}
+
+function restoreFromLocalStorage(sample)
+{
+  if (!window.localStorage) return;
+  try
+  {
+    var stored = window.localStorage.getItem(getStoreKey(sample));
+    if (!stored) return;
+    
+    if (debug) Main.debug(stored);
+    var tmp = JSON.parse(stored);
+    if (!tmp) return;
+    
+    // Check that all original scores are the same, or someone has modified
+    // this sample from another computer
+    for (var p in sample.o)
+    {
+      if (sample.o[p] != tmp.o[p])
+      {
+        return;
+      }
+    }
+    
+    // Ok, copy stored info to the current sample
+    for (var i = 0; i < SCORES.length; i++)
+    {
+      sample[SCORES[i]] = tmp[SCORES[i]];
+    }
+    sample.ScoreComplete = tmp.ScoreComplete;
+    sample.GoodStain = tmp.GoodStain;
+    sample.comments = tmp.comments;
+  }
+  catch (e)
+  {
+    Main.debug('Could not load stored information for sample ' + sample.name + ': ' + e);
+  }
+}
+
+function getStoreKey(sample)
+{
+  return 'reggie.histology.' + sample.id + '.scoreInfo';
 }