linny-r 1.4.0 → 1.4.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "linny-r",
-  "version": "1.4.0",
+  "version": "1.4.2",
   "description": "Executable graphical language with WYSIWYG editor for MILP models",
   "main": "server.js",
   "scripts": {

package/server.js

@@ -910,12 +910,12 @@ function loadData(res, url) {
 //              the call-back Python script specified for the channel
 
 function receiver(res, sp) {
-  //This function processes all receiver actions
+  // This function processes all receiver actions.
   let
       rpath = anyOSpath(sp.get('path') || ''),
       rfile = anyOSpath(sp.get('file') || '');
-  // Assume that path is relative to channel directory unless it starts with
-  // a (back)slash or specifiess drive or volume
+  // Assume that path is relative to working directory unless it starts
+  // with a (back)slash or specifies drive or volume.
   if(!(rpath.startsWith(path.sep) || rpath.indexOf(':') >= 0 ||
       rpath.startsWith(WORKING_DIRECTORY))) {
     rpath = path.join(WORKING_DIRECTORY, rpath);
@@ -1038,8 +1038,49 @@ function rcvrAbort(res, rpath, rfile, log) {
 }
 
 function rcvrReport(res, rpath, rfile, run, data, stats, log) {
+  // Purge reports older than 24 hours.
   try {
-    let fp = path.join(rpath, rfile + run + '-data.txt');
+    const
+      now = new Date(),
+      flist = fs.readdirSync(WORKSPACE.reports);
+    let n = 0;
+    for(let i = 0; i < flist.length; i++) {
+      const
+          pp = path.parse(flist[i]),
+          fp = path.join(WORKSPACE.reports, flist[i]);
+      // NOTE: Only consider text files (extension .txt)
+      if(pp.ext === '.txt') {
+        // Delete only if file is older than 24 hours.
+        const fstat = fs.statSync(fp);
+        if(now - fstat.mtimeMs > 24 * 3600000) {
+          // Delete text file
+          try {
+            fs.unlinkSync(fp);
+            n++;
+          } catch(err) {
+            console.log('WARNING: Failed to delete', fp);
+            console.log(err);
+          }
+        }
+      }
+    }
+    if(n) console.log(n + 'report file' + (n > 1 ? 's' : '') + 'purged');
+  } catch(err) {
+    // Log error, but do not abort.
+    console.log(err);
+  }
+  // Now save the reports.
+  // NOTE: The optional @ indicates where the run number must be inserted.
+  // If not specified, append run number to the base report file name.
+  if(rfile.indexOf('@') < 0) {
+    rfile += run;
+  } else {
+    rfile = rfile.replace('@', run);  
+  }
+  const base = path.join(rpath, rfile);
+  let fp;
+  try {
+    fp = path.join(base + '-data.txt');
     fs.writeFileSync(fp, data);
   } catch(err) {
     console.log(err);
@@ -1048,7 +1089,7 @@ function rcvrReport(res, rpath, rfile, run, data, stats, log) {
     return;
   }
   try {
-    fp = path.join(rpath, rfile + run + '-stats.txt');
+    fp = path.join(base + '-stats.txt');
     fs.writeFileSync(fp, stats);
   } catch(err) {
     console.log(err);
@@ -1057,7 +1098,7 @@ function rcvrReport(res, rpath, rfile, run, data, stats, log) {
     return;
   }
   try {
-    fp = path.join(rpath, rfile + run + '-log.txt');
+    fp = path.join(base + '-log.txt');
     fs.writeFileSync(fp, log);
   } catch(err) {
     console.log(err);
@@ -1630,6 +1671,7 @@ function createWorkspace() {
       data: path.join(SETTINGS.user_dir, 'data'),
       diagrams: path.join(SETTINGS.user_dir, 'diagrams'),
       modules: path.join(SETTINGS.user_dir, 'modules'),
+      reports: path.join(SETTINGS.user_dir, 'reports'),
       solver_output: path.join(SETTINGS.user_dir, 'solver')
     };
   // Create these sub-directories if not aready there

package/static/index.html

@@ -165,8 +165,7 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
                 // Inform user that newer version exists
                 UI.check_update_modal.element('msg').innerHTML = [
                     '<a href="', GITHUB_REPOSITORY,
-                    '/wiki/Linny-R-version-history#version-',
-                    info[1].replaceAll('.', ''), '" ',
+                    '/releases/tag/v', info[1], '" ',
                     'title="Click to view version release notes" ',
                     'target="_blank">Version <strong>',
                     info[1], '</strong></a> released on ',
@@ -601,6 +600,14 @@ and move the cursor over the status bar">
           </td>
           <td style="padding-bottom:4px">Infer and display cost prices</td>
         </tr>
+        <tr title="Reports will be saved in user/reports/, and removed after 24 h">
+          <td style="padding:0px">
+            <div id="settings-report-results" class="box clear"></div>
+          </td>
+          <td style="padding-bottom:4px">
+            Report results after each run
+          </td>
+        </tr>
         <tr>
           <td style="padding:0px">
             <div id="settings-block-arrows" class="box clear"></div>
@@ -1280,9 +1287,6 @@ NOTE: Unit symbols are case-sensitive, so BTU &ne; Btu">
     <div id="process-dlg" class="inp-dlg">
       <div class="dlg-title">
         Process properties
-        <div class="simbtn">
-          <img id="process-sim-btn" class="btn sim enab" src="images/process.png">
-        </div>
         <img class="cancel-btn" src="images/cancel.png">
         <img class="ok-btn" src="images/ok.png">
       </div>

package/static/linny-r.css

@@ -346,20 +346,6 @@ div.contbtn {
   cursor: pointer;
 }
 
-div.simbtn {
-  display: none;
-  margin-left: 5px;
-}
-
-img.sim {
-  height: 14px;
-  width: 14px;  
-}
-
-img.sim.enab:hover {
-  background-color: #9e96e5;
-}
-
 input {
   vertical-align: baseline;
 }

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

@@ -302,14 +302,20 @@ class Controller {
         (name.startsWith(this.BLACK_BOX) || name[0].match(/[\w]/));
   }
   
-  prefixesAndName(name) {
+  prefixesAndName(name, key=false) {
     // Returns name split exclusively at '[non-space]: [non-space]'
+    let sep = this.PREFIXER,
+        space = ' ';
+    if(key) {
+      sep = ':_';
+      space = '_';
+    }
     const
-        s = name.split(this.PREFIXER),
+        s = name.split(sep),
         pan = [s[0]];
     for(let i = 1; i < s.length; i++) {
       const j = pan.length - 1;
-      if(s[i].startsWith(' ') || (i > 0 && pan[j].endsWith(' '))) {
+      if(s[i].startsWith(space) || (i > 0 && pan[j].endsWith(space))) {
         pan[j] += s[i];
       } else {
         pan.push(s[i]);
@@ -350,11 +356,70 @@ class Controller {
             this.LINK_ARROW : this.CONSTRAINT_ARROW),
         nodes = name.split(arrow);
     for(let i = 0; i < nodes.length; i++) {
-      nodes[i] = nodes[i].replace(/^:\s*/, prefix);
+      nodes[i] = nodes[i].replace(/^:\s*/, prefix)
+          // NOTE: An embedded double prefix, e.g., "xxx: : yyy" indicates
+          // that the second colon+space should be replaced by the prefix.
+          // This "double prefix" may occur only once in an entity name,
+          // hence no global regexp.
+          .replace(/(\w+):\s+:\s+(\w+)/, `$1: ${prefix}$2`);
     }
     return nodes.join(arrow);
   }
   
+  tailNumber(name) {
+    // Returns the string of digits at the end of `name`. If not there,
+    // check prefixes (if any) *from right to left* for a tail number.
+    // Thus, the number that is "closest" to the name part is returned.
+    const pan = UI.prefixesAndName(name);
+    let n = endsWithDigits(pan.pop());
+    while(!n && pan.length > 0) {
+      n = endsWithDigits(pan.pop());
+    }
+    return n;
+  }
+  
+  compareFullNames(n1, n2, key=false) {
+    // Compare full names, considering prefixes in *left-to-right* order
+    // while taking into account the tailnumber for each part so that
+    // "xx: yy2: nnn" comes before "xx: yy10: nnn".
+    if(n1 === n2) return 0;
+    if(key) {
+      // NOTE: Replacing link and constraint arrows by two prefixers
+      // ensures that sort wil be first on FROM node, and then on TO node.
+      const p2 = UI.PREFIXER + UI.PREFIXER;
+      // Keys for links and constraints are not based on their names,
+      // so look up their names before comparing.
+      if(n1.indexOf('____') > 0 && MODEL.constraints[n1]) {
+        n1 = MODEL.constraints[n1].displayName
+            .replace(UI.CONSTRAINT_ARROW, p2);
+      } else if(n1.indexOf('___') > 0 && MODEL.links[n1]) {
+        n1 = MODEL.links[n1].displayName
+            .replace(UI.LINK_ARROW, p2);
+      }
+      if(n2.indexOf('____') > 0 && MODEL.constraints[n2]) {
+        n2 = MODEL.constraints[n2].displayName.
+            replace(UI.CONSTRAINT_ARROW, p2);
+      } else if(n2.indexOf('___') > 0 && MODEL.links[n2]) {
+        n2 = MODEL.links[n2].displayName
+            .replace(UI.LINK_ARROW, p2);
+      }
+      n1 = n1.toLowerCase().replaceAll(' ', '_');
+      n2 = n2.toLowerCase().replaceAll(' ', '_');
+    }
+    const
+        pan1 = UI.prefixesAndName(n1, key),
+        pan2 = UI.prefixesAndName(n2, key),
+        sl = Math.min(pan1.length, pan2.length);
+    let i = 0;
+    while(i < sl) {
+      const c = compareWithTailNumbers(pan1[i], pan2[i]);
+      if(c !== 0) return c;
+      i++;
+    }
+    return pan1.length - pan2.length;
+  }
+
+  
   nameToID(name) {
     // Returns a name in lower case with link arrow replaced by three
     // underscores, constraint link arrow by four underscores, and spaces

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

@@ -4901,7 +4901,7 @@ class GUIController extends Controller {
     // Logs MB's of used heap memory to console (to detect memory leaks)
     // NOTE: this feature is supported only by Chrome
     if(msg) msg += ' -- ';
-    if(typeof performance.memory !== 'undefined') {
+    if(performance.memory !== undefined) {
       console.log(msg + 'Allocated memory: ' + Math.round(
           performance.memory.usedJSHeapSize/1048576.0).toFixed(1) + ' MB');
     }
@@ -5701,6 +5701,7 @@ console.log('HERE name conflicts', name_conflicts, mapping);
     this.setBox('settings-decimal-comma', model.decimal_comma);
     this.setBox('settings-align-to-grid', model.align_to_grid);
     this.setBox('settings-cost-prices', model.infer_cost_prices);
+    this.setBox('settings-report-results', model.report_results);
     this.setBox('settings-block-arrows', model.show_block_arrows);
     md.show('name');
   }
@@ -5753,6 +5754,7 @@ console.log('HERE name conflicts', name_conflicts, mapping);
     if(!model.scale_units.hasOwnProperty(dsu)) model.addScaleUnit(dsu);
     model.default_unit = dsu;
     model.currency_unit = md.element('currency-unit').value.trim();
+    model.report_results = UI.boxChecked('settings-report-results');
     model.encrypt = UI.boxChecked('settings-encrypt');
     model.decimal_comma = UI.boxChecked('settings-decimal-comma');
     // Some changes may necessitate redrawing the diagram
@@ -7354,7 +7356,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.
@@ -7396,7 +7399,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>`);
         }
@@ -9898,13 +9901,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) &&
@@ -9915,7 +9912,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 = [],
@@ -10676,7 +10673,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;
   }
@@ -12188,7 +12185,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],
@@ -13173,7 +13170,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"' : ''),
@@ -15522,7 +15519,7 @@ class Finder {
           }
         }
       }
-      enl.sort(ciCompare);
+      enl.sort((a, b) => UI.compareFullNames(a, b, true));
     }
     document.getElementById('finder-entity-imgs').innerHTML = imgs;
     let seid = 'etr';
@@ -15919,7 +15916,7 @@ class Finder {
           // No cost price calculation => trim associated attributes from header
           let p = ah.indexOf('\tCost price');
           if(p > 0) {
-            ah = ah.substr(0, p);
+            ah = ah.substring(0, p);
           } else {
             // SOC is exogenous, and hence comes before F in header => replace
             ah = ah.replace('\tShare of cost', '');
@@ -15991,8 +15988,8 @@ class GUIReceiver {
   }
   
   log(msg) {
-    // Logs a message displayed on the status line while solving
-    if(this.active) {
+    // Logs a message displayed on the status line while solving.
+    if(this.active || MODEL.report_results) {
       if(!msg.startsWith('[')) {
         const
             d = new Date(),
@@ -16135,21 +16132,34 @@ class GUIReceiver {
   report() {
     // Posts the run results to the local server, or signals an error
     let form,
-        run = '';
+        run = '',
+        path = this.channel,
+        file = this.file_name;
     // NOTE: Always set `solving` to FALSE
     this.solving = false;
-    if(this.experiment){
+    // NOTE: When reporting receiver while is not active, report the
+    // results of the running experiment.
+    if(this.experiment || !this.active) {
       if(MODEL.running_experiment) {
         run = MODEL.running_experiment.active_combination_index;
         this.log(`Reporting: ${this.file_name} (run #${run})`);
       }
     }
+    // NOTE: If receiver is not active, path and file must be set.
+    if(!this.active) {
+      path = 'user/reports';
+      // NOTE: The @ will be replaced by the run number, so that that
+      // number precedes the clock time. The @ will be unique because
+      // `asFileName()` replaces special characters by underscores. 
+      file = REPOSITORY_BROWSER.asFileName(MODEL.name || 'model') +
+          '@-' + compactClockTime();
+    }
     if(MODEL.solved && !VM.halted) {
       // Normal execution termination => report results
       const od = MODEL.outputData;
       form = {
-          path: this.channel,
-          file: this.file_name,
+          path: path,
+          file: file,
           action: 'report',
           run: run,
           data: od[0],
@@ -16176,12 +16186,13 @@ 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 execution completed, perform the call-back action if the
+          // receiver is active (so not when auto-reporting a run).
           // NOTE: for experiments, call-back is performed upon completion by
-          // the Experiment Manager
-          if(!RECEIVER.experiment) RECEIVER.callBack();
+          // the Experiment Manager.
+          if(RECEIVER.active && !RECEIVER.experiment) RECEIVER.callBack();
         })
       .catch(() => UI.warn(UI.WARNING.NO_CONNECTION, err));
   }