linny-r 1.4.1 → 1.4.3

package/static/scripts/linny-r-gui.js

@@ -2789,13 +2789,15 @@ class Paper {
 } // END of class Paper
 
 
-// CLASS ModalDialog provides basic modal dialog functionality
+// CLASS ModalDialog provides basic modal dialog functionality.
 class ModalDialog {
   constructor(id) {
     this.id = id;
     this.modal = document.getElementById(id + '-modal');
     this.dialog = document.getElementById(id + '-dlg');
-    // NOTE: dialog button properties will be `undefined` if not in the header
+    // NOTE: Dialog title and button properties will be `undefined` if
+    // not in the header DIV child of the dialog DIV element.
+    this.title = this.dialog.getElementsByClassName('dlg-title')[0];
     this.ok = this.dialog.getElementsByClassName('ok-btn')[0];
     this.cancel = this.dialog.getElementsByClassName('cancel-btn')[0];
     this.info = this.dialog.getElementsByClassName('info-btn')[0];
@@ -3266,9 +3268,13 @@ class GUIController extends Controller {
     // The CHECK UPDATE dialog appears when a new version is detected
     this.check_update_modal = new ModalDialog('check-update');
     this.check_update_modal.ok.addEventListener('click',
-        () => UI.shutDownServer());
+        () => UI.shutDownToUpdate());
     this.check_update_modal.cancel.addEventListener('click',
-        () => UI.check_update_modal.hide());
+        () => UI.preventUpdate());
+
+    // The UPDATING modal appears when updating has started.
+    // NOTE: This modal has no OK or CANCEL buttons.
+    this.updating_modal = new ModalDialog('updating');
 
     // Add all draggable stay-on-top dialogs as controller properties
     
@@ -3399,7 +3405,7 @@ class GUIController extends Controller {
   }
 
   drawLinkArrows(cluster, link) {
-    // Draw all arrows in `cluster` that represent `link`
+    // Draw all arrows in `cluster` that represent `link`.
     for(let i = 0; i < cluster.arrows.length; i++) {
       const a = cluster.arrows[i];
       if(a.links.indexOf(link) >= 0) this.paper.drawArrow(a);
@@ -3407,19 +3413,124 @@ class GUIController extends Controller {
   }
 
   shutDownServer() {
-    // Shut down -- this terminates the local host server script 
+    // This terminates the local host server script and display a plain
+    // HTML message in the browser with a restart button.
     if(!SOLVER.user_id) window.open('./shutdown', '_self');
   }
 
+  shutDownToUpdate() {
+    // Sisgnal server that an update is required. This will close the
+    // local host Linny-R server. If this server was started by the
+    // standard OS batch script, this script will proceed to update
+    // Linny-R via npm and then restart the server again. If not, the
+    // fetch request will time out, anf the user will be warned.
+    if(SOLVER.user_id) return;
+    fetch('update/')
+      .then((response) => {
+          if(!response.ok) {
+            UI.alert(`ERROR ${response.status}: ${response.statusText}`);
+          }
+          return response.text();
+        })
+      .then((data) => {
+          if(UI.postResponseOK(data, true)) {
+            UI.check_update_modal.hide();
+            if(data.startsWith('Installing')) UI.waitToRestart();
+          }
+        })
+      .catch((err) => {
+          UI.warn(UI.WARNING.NO_CONNECTION, err);
+        });
+  }
+  
+  waitToRestart() {
+    // Shows the "update in progress" dialog and then fetches the current
+    // version page from the server. Always wait for 5 seconds to permit
+    // reading the text, and ensure that the server has been stopped.
+    // Only then try to restart.
+    if(SOLVER.user_id) return;
+    UI.updating_modal.show();
+    setTimeout(() => UI.tryToRestart(0), 5000);
+  }
+
+  tryToRestart(trials) {
+    // Fetch the current version number from the server. This may take
+    // a wile, as the server was shut down and restarts only after npm
+    // has updated the Linny-R software. Typically, this takes only a few
+    // seconds, but the connection with the npm server may be slow.
+    // Default timeout on Firefox (90 seconds) and Chrome (300 seconds)
+    // should amply suffice, though, hence no provision for a second attempt.
+    fetch('version/')
+      .then((response) => {
+          if(!response.ok) {
+            UI.alert(`ERROR ${response.status}: ${response.statusText}`);
+          }
+          return response.text();
+        })
+      .then((data) => {
+          if(UI.postResponseOK(data)) {
+            // Change the dialog text in case the user does not confirm
+            // when prompted by the browser to leave the page.
+            const
+                m = data.match(/(\d+\.\d+\.\d+)/),
+                md = UI.updating_modal;
+            md.title.innerText = 'Update terminated';
+            let msg = [];
+            if(m) {
+              msg.push(
+                `Linny-R version ${m[1]} has been installed.`,
+                'To continue, you must reload this page, and',
+                'confirm when prompted by your browser.');
+            } else {
+              // Inform user that install appears to have failed.
+              msg.push(
+                'Installation of new version may <strong>not</strong> have',
+                'been successful. Please check the CLI for',
+                'error messages or warnings.');
+            }
+            md.element('msg').innerHTML = msg.join('<br>');
+            // Reload `index.html`. This will start Linny-R anew.
+            window.open('./', '_self');
+          }
+        })
+      .catch((err) => {
+          if(trials < 10) {
+            setTimeout(() => UI.tryToRestart(trials + 1), 5000);
+          } else {
+            UI.warn(UI.WARNING.NO_CONNECTION, err);
+          }
+        });    
+  }
+
+  preventUpdate() {
+    // Signal server that no update is required. 
+    if(SOLVER.user_id) return;
+    fetch('no-update/')
+      .then((response) => {
+          if(!response.ok) {
+            UI.alert(`ERROR ${response.status}: ${response.statusText}`);
+          }
+          return response.text();
+        })
+      .then((data) => {
+          if(UI.postResponseOK(data, true)) UI.check_update_modal.hide();
+        })
+      .catch((err) => {
+          UI.warn(UI.WARNING.NO_CONNECTION, err);
+          UI.check_update_modal.hide();
+        });
+  }
+
   loginPrompt() {
-    // Show the server logon modal
+    // Show the server logon modal.
     this.modals.logon.element('name').value = SOLVER.user_id;
     this.modals.logon.element('password').value = '';
     this.modals.logon.show('password');
   }
   
   rotatingIcon(rotate=false) {
-    // Controls the appearance of the Linny-R icon (top-left in browser window)
+    // Controls the appearance of the Linny-R icon in the top-left
+    // corner of the browser window.
     const
         si = document.getElementById('static-icon'),
         ri = document.getElementById('rotating-icon');
@@ -3433,47 +3544,47 @@ class GUIController extends Controller {
   }
 
   updateTimeStep(t=MODEL.simulationTimeStep) {
-    // Displays `t` as the current time step
-    // NOTE: the Virtual Machine passes its relative time VM.t
+    // Display `t` as the current time step.
+    // NOTE: The Virtual Machine passes its relative time `VM.t`.
     document.getElementById('step').innerHTML = t;
   }
   
   stopSolving() {
-    // Reset solver-related GUI elements and notify modeler
+    // Reset solver-related GUI elements and notify modeler.
     super.stopSolving();
     this.buttons.solve.classList.remove('off');
     this.buttons.stop.classList.remove('blink');
     this.buttons.stop.classList.add('off');
     this.rotatingIcon(false);
-    // Update the time step on the status bar
+    // Update the time step on the status bar.
     this.updateTimeStep();
   }
   
   readyToSolve() {
-    // Set Stop and Reset buttons to their initial state
+    // Set Stop and Reset buttons to their initial state.
     UI.buttons.stop.classList.remove('blink');
     // Hide the reset button
     UI.buttons.reset.classList.add('off');   
   }
   
   startSolving() {
-    // Hide Start button and show Stop button
+    // Hide Start button and show Stop button.
     UI.buttons.solve.classList.add('off');
     UI.buttons.stop.classList.remove('off');
   }
   
   waitToStop() {
-    // Make Stop button blink to indicate "halting -- please wait"
+    // Make Stop button blink to indicate "halting -- please wait".
     UI.buttons.stop.classList.add('blink');
   }
   
   readyToReset() {
-    // Show the Reset button
+    // Show the Reset button.
     UI.buttons.reset.classList.remove('off');
   }
 
   reset() {
-    // Reset properties related to cursor position on diagram 
+    // Reset properties related to cursor position on diagram.
     this.on_node = null;
     this.on_arrow = null;
     this.on_cluster = null;
@@ -3527,7 +3638,7 @@ class GUIController extends Controller {
   jumpToIssue() {
     // Set time step to the one of the warning message for the issue
     // index, redraw the diagram if needed, and display the message
-    // on the infoline
+    // on the infoline.
     if(VM.issue_index >= 0) {
       const
           issue = VM.issue_list[VM.issue_index],
@@ -7356,7 +7467,8 @@ NOTE: Grouping groups results in a single group, e.g., (1;2);(3;4;5) evaluates a
     // is passed to differentiate between the DOM elements to be used
     const
         type = document.getElementById(prefix + 'variable-obj').value,
-        n_list = this.namesByType(VM.object_types[type]).sort(ciCompare),
+        n_list = this.namesByType(VM.object_types[type]).sort(
+            (a, b) => UI.compareFullNames(a, b)),
         vn = document.getElementById(prefix + 'variable-name'),
         options = [];
     // Add "empty" as first and initial option, but disable it.
@@ -7398,7 +7510,7 @@ NOTE: Grouping groups results in a single group, e.g., (1;2);(3;4;5) evaluates a
           slist.push(d.modifiers[m].selector);
         }
         // Sort to present equations in alphabetical order
-        slist.sort(ciCompare);
+        slist.sort((a, b) => UI.compareFullNames(a, b));
         for(let i = 0; i < slist.length; i++) {
           options.push(`<option value="${slist[i]}">${slist[i]}</option>`);
         }
@@ -9900,13 +10012,7 @@ class GUIDatasetManager extends DatasetManager {
         dl = [],
         dnl = [],
         sd = this.selected_dataset,
-        ioclass = ['', 'import', 'export'],
-        ciPrefixCompare = (a, b) => {
-            const
-                pa = a.split(':_').join('  '),
-                pb = b.split(':_').join('  ');
-            return ciCompare(pa, pb);
-          };
+        ioclass = ['', 'import', 'export'];
     for(let d in MODEL.datasets) if(MODEL.datasets.hasOwnProperty(d) &&
          // NOTE: do not list "black-boxed" entities
         !d.startsWith(UI.BLACK_BOX) &&
@@ -9917,7 +10023,7 @@ class GUIDatasetManager extends DatasetManager {
         dnl.push(d);
       }
     }
-    dnl.sort(ciPrefixCompare);
+    dnl.sort((a, b) => UI.compareFullNames(a, b, true));
     // First determine indentation levels, prefixes and names 
     const
         indent = [],
@@ -10678,7 +10784,7 @@ class GUIDatasetManager extends DatasetManager {
     const
         ln =  document.getElementById('series-line-number'),
         lc =  document.getElementById('series-line-count');
-    ln.innerHTML = this.series_data.value.substr(0,
+    ln.innerHTML = this.series_data.value.substring(0,
         this.series_data.selectionStart).split('\n').length;
     lc.innerHTML = this.series_data.value.split('\n').length;
   }
@@ -12190,7 +12296,7 @@ class GUISensitivityAnalysis extends SensitivityAnalysis {
       const
           ds_dict = MODEL.listOfAllSelectors,
           html = [],
-          sl = Object.keys(ds_dict).sort(ciCompare);
+          sl = Object.keys(ds_dict).sort((a, b) => UI.compareFullNames(a, b, true));
       for(let i = 0; i < sl.length; i++) {
         const
             s = sl[i],
@@ -13175,7 +13281,7 @@ class GUIExperimentManager extends ExperimentManager {
       for(let i = 0; i < x.variables.length; i++) {
         addDistinct(x.variables[i].displayName, vl); 
       }
-      vl.sort(ciCompare);
+      vl.sort((a, b) => UI.compareFullNames(a, b));
       for(let i = 0; i < vl.length; i++) {
         ol.push(['<option value="', vl[i], '"',
             (vl[i] == x.selected_variable ? ' selected="selected"' : ''),
@@ -15336,9 +15442,11 @@ class Finder {
     this.close_btn = document.getElementById('finder-close-btn');
     // Make toolbar buttons responsive
     this.close_btn.addEventListener('click', (e) => UI.toggleDialog(e));
-    this.entities = [];
     this.filter_input = document.getElementById('finder-filter-text');
     this.filter_input.addEventListener('input', () => FINDER.changeFilter());
+    this.edit_btn = document.getElementById('finder-edit-btn');
+    this.edit_btn.addEventListener(
+        'click', (event) => FINDER.editAttributes(event.shiftKey));
     this.copy_btn = document.getElementById('finder-copy-btn');
     this.copy_btn.addEventListener(
         'click', (event) => FINDER.copyAttributesToClipboard(event.shiftKey));
@@ -15346,7 +15454,7 @@ class Finder {
     this.item_table = document.getElementById('finder-item-table');
     this.expression_table = document.getElementById('finder-expression-table');
         
-  // Attribute headers are used by Finder to output entity attribute values
+    // Attribute headers are used by Finder to output entity attribute values.
     this.attribute_headers = {
         A: 'ACTORS:\tWeight\tCash IN\tCash OUT\tCash FLOW',
         B: 'CONSTRAINTS (no attributes)',
@@ -15359,12 +15467,15 @@ class Finder {
         Q: 'PRODUCTS:\tLower bound\tUpper bound\tInitial level\tPrice' +
               '\tLevel\tCost price\tHighest cost price'
       };
-    // Set own properties
+    // Set own properties.
+    this.entities = [];
+    this.filtered_types = [];
     this.reset();
   }
 
   reset() {
     this.entities.length = 0;
+    this.filtered_types.length = 0;
     this.selected_entity = null;
     this.filter_input.value = '';
     this.filter_pattern = null;
@@ -15373,7 +15484,7 @@ class Finder {
     this.last_time_clicked = 0;
     this.clicked_object = null;
     // Product cluster index "remembers" for which cluster a product was
-    // last revealed, so it can reveal the next cluster when clicked again
+    // last revealed, so it can reveal the next cluster when clicked again.
     this.product_cluster_index = 0;
   }
   
@@ -15383,7 +15494,7 @@ class Finder {
         dt = now - this.last_time_clicked;
     this.last_time_clicked = now;
     if(obj === this.clicked_object) {
-      // Consider click to be "double" if it occurred less than 300 ms ago
+      // Consider click to be "double" if it occurred less than 300 ms ago.
       if(dt < 300) {
         this.last_time_clicked = 0;
         return true;
@@ -15427,6 +15538,7 @@ class Finder {
         fp = this.filter_pattern && this.filter_pattern.length > 0;
     let imgs = '';
     this.entities.length = 0;
+    this.filtered_types.length = 0;
     // No list unless a pattern OR a specified SUB-set of entity types
     if(fp || et && et !== VM.entity_letters) {
       if(et.indexOf('A') >= 0) {
@@ -15435,6 +15547,7 @@ class Finder {
           if(!fp || patternMatch(MODEL.actors[k].name, this.filter_pattern)) {
             enl.push(k);
             this.entities.push(MODEL.actors[k]);
+            addDistinct('A', this.filtered_types);
           }
         }
       }
@@ -15446,6 +15559,7 @@ class Finder {
               MODEL.processes[k].displayName, this.filter_pattern))) {
             enl.push(k);
             this.entities.push(MODEL.processes[k]);
+            addDistinct('P', this.filtered_types);
           }
         }
       }
@@ -15456,6 +15570,7 @@ class Finder {
               MODEL.products[k].displayName, this.filter_pattern))) {
             enl.push(k);
             this.entities.push(MODEL.products[k]);
+            addDistinct('Q', this.filtered_types);
           }
         }
       }
@@ -15466,6 +15581,7 @@ class Finder {
               MODEL.clusters[k].displayName, this.filter_pattern))) {
             enl.push(k);
             this.entities.push(MODEL.clusters[k]);
+            addDistinct('C', this.filtered_types);
           }
         }
       }
@@ -15479,6 +15595,7 @@ class Finder {
             if(ds !== MODEL.equations_dataset) {
               enl.push(k);
               this.entities.push(MODEL.datasets[k]);
+              addDistinct('D', this.filtered_types);
             }
           }
         }
@@ -15492,6 +15609,7 @@ class Finder {
                     this.filter_pattern)) {
               enl.push(k);
               this.entities.push(MODEL.equations_dataset.modifiers[k]);
+              addDistinct('E', this.filtered_types);
             }
           }
         }
@@ -15508,6 +15626,7 @@ class Finder {
           if(!bb && (!fp || patternMatch(ldn, this.filter_pattern))) {
             enl.push(k);
             this.entities.push(l);
+            addDistinct('L', this.filtered_types);
           }
         }
       }
@@ -15520,11 +15639,12 @@ class Finder {
                 MODEL.constraints[k].displayName, this.filter_pattern))) {
               enl.push(k);
               this.entities.push(MODEL.constraints[k]);
+              addDistinct('B', this.filtered_types);
             }
           }
         }
       }
-      enl.sort(ciCompare);
+      enl.sort((a, b) => UI.compareFullNames(a, b, true));
     }
     document.getElementById('finder-entity-imgs').innerHTML = imgs;
     let seid = 'etr';
@@ -15545,10 +15665,24 @@ class Finder {
     UI.scrollIntoView(document.getElementById(seid));
     document.getElementById('finder-count').innerHTML = pluralS(
         el.length, 'entity', 'entities');
-    if(el.length > 0) {
+    // Only show the edit button if all filtered entities are of the
+    // same type.
+    let n = el.length;
+    this.edit_btn.style.display = 'none';
+    this.copy_btn.style.display = 'none';
+    if(n > 0) {
       this.copy_btn.style.display = 'block';
-    } else {
-      this.copy_btn.style.display = 'none';
+      const ft = this.filtered_types[0];
+      if(this.filtered_types.length === 1 && 'DE'.indexOf(ft) < 0) {
+        // NOTE: Attributes of "no actor" and top cluster cannot be edited.
+        if((ft === 'A' && enl.indexOf('(no_actor)') >= 0) ||
+            (ft === 'C' && enl.indexOf('(top_cluster)') >= 0)) n--;
+        if(n > 0) {
+          this.edit_btn.title = 'Edit attributes of ' +
+              pluralS(n, VM.entity_names[ft]);
+          this.edit_btn.style.display = 'block';
+        }
+      }
     }
     this.updateRightPane();
   }
@@ -15774,6 +15908,10 @@ class Finder {
         UI.showProductPropertiesDialog(obj);
       } else if(obj instanceof Link) {
         UI.showLinkPropertiesDialog(obj);
+      } else if(obj instanceof Cluster && obj !== MODEL.top_cluster) {
+        UI.showClusterPropertiesDialog(obj);
+      } else if(obj instanceof Actor) {
+        ACTOR_MANAGER.showEditActorDialog(obj.name, obj.weight.text);
       } else if(obj instanceof Note) {
         obj.showNotePropertiesDialog();
       } else if(obj instanceof Dataset) {
@@ -15889,12 +16027,19 @@ class Finder {
     }
   }
   
+  editAttributes(shift) {
+    // Show the Edit properties dialog for the filtered-out entities.
+    // These must all be of the same type, or the edit button will not
+    // show. Just in case, check anyway.
+    
+  }
+  
   copyAttributesToClipboard(shift) {
-    // Copy relevant entity attributes as tab-separated text to clipboard
-    // NOTE: all entity types have "get" `attributes` that returns an object
-    // that for each defined attribute (and if model has been solved also each
-    // inferred attribute) has a property with its value. For dynamic
-    // expressions, the expression text is used
+    // Copy relevant entity attributes as tab-separated text to clipboard.
+    // NOTE: All entity types have "get" `attributes` that returns an
+    // object that for each defined attribute (and if model has been
+    // solved also each inferred attribute) has a property with its value.
+    // For dynamic expressions, the expression text is used
     const ea_dict = {A: [], B: [], C: [], D: [], E: [], L: [], P: [], Q: []};
     let e = this.selected_entity;
     if(shift && e) {
@@ -15914,18 +16059,15 @@ class Finder {
           etl = seq[i],
           ead = ea_dict[etl];
       if(ead && ead.length > 0) {
-        // No blank line before first entity type
+        // No blank line before first entity type.
         if(text.length > 0) text.push('');
-        let ah = this.attribute_letters[etl];
+        const en = capitalized(VM.entity_names[etl]);
+        let ah = en + '\t' + VM.entity_attribute_names[etl].join('\t');
+        if(etl === 'L' || etl === 'B') ah = ah.replace(en, `${en} FROM\tTO`);
         if(!MODEL.infer_cost_prices) {
-          // No cost price calculation => trim associated attributes from header
-          let p = ah.indexOf('\tCost price');
-          if(p > 0) {
-            ah = ah.substr(0, p);
-          } else {
-            // SOC is exogenous, and hence comes before F in header => replace
-            ah = ah.replace('\tShare of cost', '');
-          }
+          // If no cost price calculation, trim associated attributes
+          // from the header.
+          ah = ah.replace('\tCost price', '').replace('\tShare of cost', '');
         }
         text.push(ah);
         attr.length = 0;
@@ -16191,7 +16333,7 @@ class GUIReceiver {
           return response.text();
         })
       .then((data) => {
-          // For experiments, only display server response if warning or error
+          // For experiments, only display server response if warning or error.
           UI.postResponseOK(data, !RECEIVER.experiment);
           // If execution completed, perform the call-back action if the
           // receiver is active (so not when auto-reporting a run).