linny-r 1.3.0 → 1.3.2

package/console.js

@@ -86,6 +86,9 @@ console.log('Platform:', PLATFORM, '(' + os.type() + ')');
 console.log('Module directory:', MODULE_DIRECTORY);
 console.log('Working directory:', WORKING_DIRECTORY);
 
+// Currently, these external solvers are supported:
+const SUPPORTED_SOLVERS = ['gurobi', 'scip', 'lp_solve'];
+
 const
     // Load the MILP solver (dependent on Node.js: `fs`, `os` and `path`)
     MILPSolver = require('./static/scripts/linny-r-milp.js'),
@@ -113,13 +116,17 @@ Possible options are:
   channel=[identifier]  will start listening at the specified channel
                         (FUTURE OPTION)
   check                 will report whether current version is up-to-date
-  model=[path]          will load model file in [path]
+  data-dir=[path]       will look for series data files in [path] instead of
+                        (main)/user/data
+  model=[path]          will load model file specified by [path]
   module=[name@repo]    will load model [name] from repository [repo]
                         (if @repo is blank, repository "local host" is used)
                         (FUTURE OPTION)
+  report=[name]         will write run results to [name]-series.txt and
+                        [name]-stats.txt in (workspace)/reports
   run                   will run the loaded model
   solver=[name]         will select solver [name], or warn if not found
-                        (name choices: Gurobi or LP_solve)
+                        (name choices: Gurobi, SCIP or LP_solve)
   user=[identifier]     user ID will be used to log onto remote servers
   verbose               will output solver messages to the console
   workspace=[path]      will create workspace in [path] instead of (main)/user
@@ -247,11 +254,81 @@ class ConsoleMonitor {
 } // END of class ConsoleMonitor
 
 
+// NOTE: This implementation is very incomplete, still!
+class ConsoleRepositoryBrowser {
+  constructor() {
+    this.repositories = [];
+    this.repository_index = -1; 
+    this.module_index = -1;
+    // Get the repository list from the modules
+    this.getRepositories();
+    this.reset();
+  }
+  
+  reset() {
+    this.visible = false;
+  }
+
+  get isLocalHost() {
+    // Returns TRUE if first repository on the list is 'local host'
+    return this.repositories.length > 0 &&
+      this.repositories[0].name === 'local host';
+  }
+
+  getRepositories() {
+    // Gets the list of repository names from the server
+    this.repositories.length = 0;
+    // @@TO DO!!
+  }
+  
+  repositoryByName(n) {
+    // Returns the repository having name `n` if already known, otherwise NULL
+    for(let i = 0; i < this.repositories.length; i++) {
+      if(this.repositories[i].name === n) {
+        return this.repositories[i];
+      }
+    }
+    return null;
+  }
+  
+  asFileName(s) {
+    // NOTE: asFileName is implemented as function (see below) to permit
+    // its use prior to instantiation of the RepositoryBrowser
+    return stringToFileName(s);
+  }
+  
+}
+
+function stringToFileName(s) {
+  // Returns string `s` with whitespace converted to a single dash, and
+  // special characters converted to underscores
+  return s.normalize('NFKD').trim()
+      .replace(/[\s\-]+/g, '-')
+      .replace(/[^A-Za-z0-9_\-]/g, '_')
+      .replace(/^[\-\_]+|[\-\_]+$/g, '');
+}
+
 // CLASS ConsoleFileManager allows loading and saving models and diagrams, and
 // handles the interaction with the MILP solver via `exec` calls and files
 // stored on the modeler's computer
 class ConsoleFileManager {
 
+  anyOSpath(p) {
+    // Helper function that converts any path notation to platform notation
+    // based on the predominant separator
+    const
+       s_parts = p.split('/'),
+       bs_parts = p.split('\\'),
+       parts = (s_parts.length > bs_parts.length ? s_parts : bs_parts);
+    // On macOS machines, paths start with a slash, so first substring is empty
+    if(parts[0].endsWith(':') && path.sep === '\\') {
+      // On Windows machines, add a backslash after the disk (if specified)
+      parts[0] += path.sep;
+    }
+    // Reassemble path for the OS of this machine
+    return path.join(...parts);
+  }
+  
   getRemoteData(dataset, url) {
     // Gets data from a URL, or from a file on the local host 
     if(url === '') return;
@@ -281,7 +358,13 @@ class ConsoleFileManager {
         console.log('ERROR: Invalid URL', url);
       }
     } else {
-      const fp = anyOSpath(url);
+      let fp = this.anyOSpath(url);
+      if(!(fp.startsWith('/') || fp.startsWith('\\') || fp.indexOf(':\\') > 0)) {
+        // Relative path => add path to specified data path or to the
+        // default location user/data
+        fp = path.join(SETTINGS.data_path || WORKSPACE.data, fp);
+        console.log('Full path: ', fp);
+      }
       fs.readFile(fp, 'utf8', (err, data) => {
           if(err) {
             console.log(err);
@@ -354,6 +437,17 @@ class ConsoleFileManager {
       });
   }
 
+  writeStringToFile(s, fp) {
+    // Write string `s` to path `fp`
+    try {
+      fs.writeFileSync(fp, s);
+      console.log(pluralS(s.length, 'character') + ' written to file ' + fp);
+    } catch(err) {
+      console.log(err);
+      console.log('ERROR: Failed to write data to file ' +  fp);
+    }
+  }
+
 } // END of class ConsoleFileManager
 
 // CLASS ConsoleReceiver defines a listener/interpreter for channel commands
@@ -702,7 +796,9 @@ function commandLineSettings() {
   const settings = {
       cli_name: (PLATFORM.startsWith('win') ? 'Command Prompt' : 'Terminal'),
       check: false,
+      data_path: '',
       preferred_solver: '',
+      report: '',
       run: false,
       solver: '',
       solver_path: '',
@@ -724,7 +820,7 @@ function commandLineSettings() {
       const av = lca.split('=');
       if(av.length === 1) av.push('');
       if(av[0] === 'solver') {
-        if(av[1] !== 'gurobi' && av[1] !== 'lp_solve') {
+        if(SUPPORTED_SOLVERS.indexOf(av[1]) < 0) {
           console.log(`WARNING: Unknown solver "${av[1]}"`);
         } else {
           settings.preferred_solver = av[1];
@@ -759,6 +855,31 @@ function commandLineSettings() {
           console.log(`ERROR: File "${av[1]}" not found`);
           process.exit();
         }
+      } else if(av[0] === 'data-dir') {
+        // Set path (if valid) to override default data directory
+        const dp = av[1];
+        try {
+          // See whether the directory already exists
+          try {
+            fs.accessSync(dp, fs.constants.R_OK | fs.constants.W_O);
+          } catch(err) {
+            // If not, try to create it
+            fs.mkdirSync(dp);
+            console.log('Created data directory:', dp);
+          }
+          settings.data_path = dp;
+        } catch(err) {
+          console.log(err.message);
+          console.log('ERROR: Failed to create data directory:', dp);
+        }
+      } else if(av[0] === 'report') {
+        // Set report file name (if valid)
+        const rfn = stringToFileName(av[1]);
+        if(/^[A-Za-z0-9]+/.test(rfn)) {
+          settings.report = path.join(settings.user_dir, 'reports', rfn);
+        } else {
+          console.log(`WARNING: Invalid report file name "{$rfn}"`);
+        }
       } else if(av[0] === 'module') {
         // Add default repository is none specified
         if(av[1].indexOf('@') < 0) av[1] += '@local host';
@@ -802,6 +923,7 @@ function commandLineSettings() {
   // Check whether MILP solver(s) and Inkscape have been installed
   const path_list = process.env.PATH.split(path.delimiter);
   let gurobi_path = '',
+      scip_path = '',
       match,
       max_v = -1;
   for(let i = 0; i < path_list.length; i++) {
@@ -810,6 +932,8 @@ function commandLineSettings() {
       gurobi_path = path_list[i];
       max_v = parseInt(match[1]);
     }
+    match = path_list[i].match(/[\/\\]scip[^\/\\]+[\/\\]bin/i);
+    if(match) scip_path = path_list[i];
     match = path_list[i].match(/inkscape/i);
     if(match) settings.inkscape = path_list[i];
   }
@@ -840,6 +964,23 @@ function commandLineSettings() {
           'WARNING: Failed to access the Gurobi command line application');
     }
   }
+  // Check if scip(.exe) exists in its directory
+  let sp = path.join(scip_path, 'scip' + (PLATFORM.startsWith('win') ? '.exe' : ''));
+  const need_scip = !settings.solver || settings.preferred_solver === 'scip';
+  try {
+    fs.accessSync(sp, fs.constants.X_OK);
+    console.log('Path to SCIP:', sp);
+    if(need_scip) {
+      settings.solver = 'scip';
+      settings.solver_path = sp;
+    }
+  } catch(err) {
+    // Only report error if SCIP is needed
+    if(need_scip) {
+      console.log(err.message);
+      console.log('WARNING: SCIP application not found in', sp);
+    }
+  }
   // Check if lp_solve(.exe) exists in main directory
   const
       sp = path.join(WORKING_DIRECTORY,
@@ -882,10 +1023,13 @@ function createWorkspace() {
   }
   // Define the sub-directory paths
   const ws = {
+      autosave: path.join(SETTINGS.user_dir, 'autosave'),
       channel: path.join(SETTINGS.user_dir, 'channel'),
       callback: path.join(SETTINGS.user_dir, 'callback'),
+      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
@@ -968,7 +1112,7 @@ PROMPTER.questionPrompt = (str) => {
 // Initialize the Linny-R console components as global variables
 global.UI = new Controller();
 global.VM = new VirtualMachine();
-//global.REPOSITORY_BROWSER = new ConsoleRepositoryBrowser(),  // still to re-code
+global.REPOSITORY_BROWSER = new ConsoleRepositoryBrowser();
 global.FILE_MANAGER = new ConsoleFileManager();
 global.DATASET_MANAGER = new DatasetManager();
 global.CHART_MANAGER = new ChartManager();
@@ -990,8 +1134,19 @@ if(SETTINGS.model_path) {
         MONITOR.show_log = SETTINGS.verbose;
         VM.callback = () => {
             const od = model.outputData;
-            console.log(od[0]);
-            console.log(od[1]);
+            // Output data is two-string list [time series, statistics]
+            if(SETTINGS.report) {
+              // Output time series
+              FILE_MANAGER.writeStringToFile(od[0],
+                  SETTINGS.report + '-series.txt');
+              // Output statistics
+              FILE_MANAGER.writeStringToFile(od[1],
+                  SETTINGS.report + '-stats.txt');
+            } else {
+              // Output strings to console
+              console.log(od[0]);
+              console.log(od[1]);
+            }
             VM.callback = null;
         };
         VM.solveModel();

package/package.json

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

package/server.js

@@ -122,6 +122,8 @@ function checkNodeModule(name) {
   }
 }
 
+// Currently, these external solvers are supported:
+const SUPPORTED_SOLVERS = ['gurobi', 'scip', 'lp_solve'];
 
 // Load class MILPSolver
 const MILPSolver = require('./static/scripts/linny-r-milp.js');
@@ -847,20 +849,19 @@ function repoDelete(res, name, file) {
 // Dataset dialog
 
 function anyOSpath(p) {
-  // Helper function that converts Unix path notation (with slashes) to
-  // Windows notation if needed
-  if(p.indexOf('/') < 0) return p;
-  p = p.split('/');
+  // Helper function that converts any path notation to platform notation
+  // based on the predominant separator
+  const
+     s_parts = p.split('/'),
+     bs_parts = p.split('\\'),
+     parts = (s_parts.length > bs_parts.length ? s_parts : bs_parts);
   // On macOS machines, paths start with a slash, so first substring is empty
-  if(p[0].length === 0) {
-      // In that case, add the leading slash
-    return '/' + path.join(...p);
-  } else if(p[0].endsWith(':') && path.sep === '\\') {
+  if(parts[0].endsWith(':') && path.sep === '\\') {
     // On Windows machines, add a backslash after the disk (if specified)
-    path[0] += path.sep;
+    parts[0] += path.sep;
   }
   // Reassemble path for the OS of this machine
-  return path.join(...p);
+  return path.join(...parts);
 }
 
 function loadData(res, url) {
@@ -881,7 +882,11 @@ function loadData(res, url) {
       servePlainText(res, `ERROR: Invalid URL <tt>${url}</tt>`);
     }
   } else {
-    const fp = anyOSpath(url);
+    let fp = anyOSpath(url);
+    if(!(fp.startsWith('/') || fp.startsWith('\\') || fp.indexOf(':\\') > 0)) {
+      // Relative path => add path to user/data directory
+      fp = path.join(WORKSPACE.data, fp);
+    }
     fs.readFile(fp, 'utf8', (err, data) => {
         if(err) {
           console.log(err);
@@ -1419,7 +1424,7 @@ function commandLineSettings() {
           settings.port = n;
         }
       } else if(av[0] === 'solver') {
-        if(av[1] !== 'gurobi' && av[1] !== 'lp_solve') {
+        if(SUPPORTED_SOLVERS.indexOf(av[1]) < 0) {
           console.log(`WARNING: Unknown solver "${av[1]}"`);
         } else {
           settings.preferred_solver = av[1];
@@ -1452,6 +1457,7 @@ function commandLineSettings() {
   // Check whether MILP solver(s) and Inkscape have been installed
   const path_list = process.env.PATH.split(path.delimiter);
   let gurobi_path = '',
+      scip_path = '',
       match,
       max_v = -1;
   for(let i = 0; i < path_list.length; i++) {
@@ -1460,6 +1466,8 @@ function commandLineSettings() {
       gurobi_path = path_list[i];
       max_v = parseInt(match[1]);
     }
+    match = path_list[i].match(/[\/\\]scip[^\/\\]+[\/\\]bin/i);
+    if(match) scip_path = path_list[i];
     match = path_list[i].match(/inkscape/i);
     if(match) settings.inkscape = path_list[i];
   }
@@ -1490,11 +1498,27 @@ function commandLineSettings() {
           'WARNING: Failed to access the Gurobi command line application');
     }
   }
+  // Check if scip(.exe) exists in its directory
+  let sp = path.join(scip_path, 'scip' + (PLATFORM.startsWith('win') ? '.exe' : ''));
+  const need_scip = !settings.solver || settings.preferred_solver === 'scip';
+  try {
+    fs.accessSync(sp, fs.constants.X_OK);
+    console.log('Path to SCIP:', sp);
+    if(need_scip) {
+      settings.solver = 'scip';
+      settings.solver_path = sp;
+    }
+  } catch(err) {
+    // Only report error if SCIP is needed
+    if(need_scip) {
+      console.log(err.message);
+      console.log('WARNING: SCIP application not found in', sp);
+    }
+  }
   // Check if lp_solve(.exe) exists in working directory
-  const
-      sp = path.join(WORKING_DIRECTORY,
-          'lp_solve' + (PLATFORM.startsWith('win') ? '.exe' : '')),
-      need_lps = !settings.solver || settings.preferred_solver === 'lp_solve';
+  sp = path.join(WORKING_DIRECTORY,
+          'lp_solve' + (PLATFORM.startsWith('win') ? '.exe' : '')); 
+  const need_lps = !settings.solver || settings.preferred_solver === 'lp_solve';
   try {
     fs.accessSync(sp, fs.constants.X_OK);
     console.log('Path to LP_solve:', sp);
@@ -1568,6 +1592,7 @@ function createWorkspace() {
       autosave: path.join(SETTINGS.user_dir, 'autosave'),
       channel: path.join(SETTINGS.user_dir, 'channel'),
       callback: path.join(SETTINGS.user_dir, 'callback'),
+      data: path.join(SETTINGS.user_dir, 'data'),
       diagrams: path.join(SETTINGS.user_dir, 'diagrams'),
       modules: path.join(SETTINGS.user_dir, 'modules'),
       solver_output: path.join(SETTINGS.user_dir, 'solver'),

package/static/index.html

@@ -1704,8 +1704,11 @@ NOTE: * and ? will be interpreted as wildcards"
         <!-- options are added by DATASET_MANAGER -->
       </select>
       <div id="series-remote">
-      <input id="series-url" type="text"
-             placeholder="(URL or path on local host)"> </div>
+        <img id="series-clip" src="images/paperclip.png">
+        <input id="series-url" type="text"
+               placeholder="URL or path on local host"
+               title="Path can be absolute or relative to (Linny-R)/user/data">
+      </div>
       <div id="series-data-lbl">Series data:</div>
       <textarea id="series-data" autocomplete="off"
           autocorrect="off" autocapitalize="off" spellcheck="false">
@@ -2801,7 +2804,65 @@ where X can be one or several of these letters: ABCDELPQ">
       </div>
     </div>
   </div>
-  
+
+  <!-- the PASTE dialog prompts for a prefix and parameter bindings -->
+  <div id="paste-modal" class="modal">
+    <div id="paste-dlg" class="inp-dlg">
+      <div class="dlg-title">
+        Name conflict resolution strategy
+        <img class="cancel-btn" src="images/cancel.png">
+        <img class="ok-btn" src="images/ok.png">
+      </div>
+      <div id="paste-ftp" class="paste-option">
+        <div id="paste-ftp-box" class="box checked"></div>
+        <div class="paste-tactic">
+          Change <span id="paste-from-prefix"></span>&hellip;
+          to <span id="paste-to-prefix"></span>&hellip;
+        </div>
+      </div>
+      <div id="paste-fta" class="paste-option">
+        <div id="paste-fta-box" class="box checked"></div>
+        <div class="paste-tactic">
+          Change actor <span id="paste-from-actor"></span>
+          to <span id="paste-to-actor"></span>
+        </div>
+      </div>
+      <div class="paste-option">
+        <div id="paste-a-box" class="box checked"></div>
+        <div class="paste-tactic">
+          <label>If no actor, add:</label>
+          <input id="paste-actor" type="text"
+                 placeholder="(no actor)" autocomplete="off">
+        </div>
+      </div>
+      <div class="paste-option">
+        <div id="paste-p-box" class="box checked"></div>
+        <div class="paste-tactic">
+          <label>Add prefix:</label>
+          <input id="paste-prefix" type="text"
+                 placeholder="(none)" autocomplete="off">
+        </div>
+      </div>
+      <div class="paste-option">
+        <div id="paste-inc-box" class="box checked"></div>
+        <div class="paste-tactic">
+          Auto-increment tail number
+        </div>
+      </div>
+      <div class="paste-option">
+        <div id="paste-near-box" class="box checked"></div>
+        <div class="paste-tactic">
+          Link to nearest eligible node
+        </div>
+      </div>
+      <div style="font-weight: bold; margin:4px 2px 2px 2px">
+        Mapping of nodes to link from/to:
+      </div>
+      <div id="paste-scroll-area">
+      </div>
+    </div>
+  </div>  
+
   <!--- rotating Linny-R logo icon -->
   <div id="rotating-icon">
     <div>

package/static/linny-r.css

@@ -2468,12 +2468,18 @@ td.equation-expression {
 #series-remote {
   position: absolute;
   top: 134px;
-  left: 3px;
-  width: calc(100% - 8px);
+  left: 2px;
+  width: calc(100% - 5px);
+}
+
+#series-clip {
+  height: 12px;
+  width: 132x;
+  vertical-align: middle;
 }
 
 #series-url {
-  width: 100%;
+  width: calc(100% - 17px);
   font-size: 12px;
 }
 
@@ -4047,6 +4053,7 @@ span.sd-clear {
   height: 111px;
 }
 
+#paste-dlg,
 #include-dlg {
   width: 320px;
   height: min-content;
@@ -4072,6 +4079,7 @@ span.sd-clear {
   margin-left: 9px;
 }
 
+#paste-scroll-area,
 #include-scroll-area {
   margin: 2px;
   height: min-content;
@@ -4082,6 +4090,60 @@ span.sd-clear {
   overflow-y: auto;
 }
 
+div.paste-tactic {
+  display: inline-block;
+  vertical-align: top;
+  padding-top: 3px;
+}
+
+div.paste-select::before {
+  content: ' \1F872';
+  margin-right: 3px;
+}
+
+div.paste-select {
+  display: inline-block;
+  font-size: 12px;
+  max-width: calc(100% - 25px);
+  margin: 2px;
+}
+
+#paste-prefix,
+#paste-actor {
+  width: 150px;
+  font-size: 12px;
+  height: 17px !important;
+  margin-left: 1px;
+}
+
+#paste-from-prefix,
+#paste-to-prefix,
+#paste-from-actor,
+#paste-to-actor {
+  max-width: 220px;
+  overflow: clip;
+  white-space: nowrap;
+  text-overflow: ellipsis;
+}
+
+#paste-from-prefix {
+  color: #6060c0;
+}
+
+#paste-to-prefix {
+  color: #0000c0;
+}
+
+#paste-from-actor {
+  font-style: italic;
+  color: #8050a0;
+}
+
+#paste-to-actor {
+  font-style: italic;
+  color: #600080;
+}
+
 tr.i-param {
   font-style: italic;
   border: 1px solid Silver;

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

@@ -136,7 +136,7 @@ class Controller {
       ACTOR_PROPS: ['weight', 'comments'],
       CLUSTER_PROPS: ['comments', 'collapsed', 'ignore'],
       PROCESS_PROPS: ['comments', 'lower_bound', 'upper_bound', 'initial_level',
-        'pace', 'equal_bounds', 'level_to_zero', 'integer_level', 'collapsed'],
+        'pace_expression', 'equal_bounds', 'level_to_zero', 'integer_level', 'collapsed'],
       PRODUCT_PROPS: ['comments', 'lower_bound', 'upper_bound', 'initial_level',
         'scale_unit', 'equal_bounds', 'price', 'is_source', 'is_sink', 'is_buffer',
         'is_data', 'integer_level', 'no_slack'],
@@ -316,6 +316,21 @@ class Controller {
     return pan;
   }
   
+  sharedPrefix(n1, n2) {
+    const
+        pan1 = this.prefixesAndName(n1),
+        pan2 = this.prefixesAndName(n2),
+        l = Math.min(pan1.length - 1, pan2.length - 1),
+        shared = [];
+    let i = 0;
+    while(i < l && ciCompare(pan1[i], pan2[i]) === 0) {
+      // NOTE: if identical except for case, prefer "Abc" over "aBc" 
+      shared.push(pan1[i] < pan2[i] ? pan1[i] : pan2[i]);
+      i++;
+    }
+    return shared.join(this.PREFIXER);
+  }
+  
   nameToID(name) {
     // Returns a name in lower case with link arrow replaced by three
     // underscores, constraint link arrow by four underscores, and spaces