linny-r 1.3.0 → 1.3.1

package/console.js

@@ -113,10 +113,14 @@ 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)
@@ -247,11 +251,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 +355,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 +434,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 +793,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: '',
@@ -759,6 +852,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';
@@ -882,10 +1000,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 +1089,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 +1111,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.1",
   "description": "Executable graphical language with WYSIWYG editor for MILP models",
   "main": "server.js",
   "scripts": {

package/server.js

@@ -847,20 +847,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 +880,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);
@@ -1568,6 +1571,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">

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;
 }
 

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

@@ -3555,81 +3555,6 @@ class GUIController extends Controller {
   // Methods related to draggable & resizable dialogs
   //
   
-  toggleDialog(e) {
-    e = e || window.event;
-    e.preventDefault();
-    e.stopImmediatePropagation();
-    // Infer dialog identifier from target element
-    const
-        dlg = e.target.id.split('-')[0],
-        tde = document.getElementById(dlg + '-dlg'),
-        was_hidden = this.hidden(tde.id);
-    let mgr = tde.getAttribute('data-manager');
-    if(mgr) mgr = window[mgr];
-    // NOTE: prevent modeler from viewing charts while an experiment is running
-    if(dlg === 'chart' && was_hidden && MODEL.running_experiment) {
-      UI.notify(UI.NOTICE.NO_CHARTS);
-      mgr.visible = false;
-      return;
-    }
-    this.toggle(tde.id);
-    if(mgr) mgr.visible = was_hidden;
-    // Open at position after last drag (recorded in DOM data attributes)
-    let t = tde.getAttribute('data-top'),
-        l = tde.getAttribute('data-left');
-    // Make dialog appear in screen center the first time it is shown
-    if(t === null || l === null) {
-      const cs = window.getComputedStyle(tde);
-      t = ((window.innerHeight - parseFloat(cs.height)) / 2) + 'px';
-      l = ((window.innerWidth - parseFloat(cs.width)) / 2) + 'px';
-      tde.style.top = t;
-      tde.style.left = l;
-    }
-    if(!this.hidden(tde.id)) {
-      // Add dialog to "showing" list, and adjust z-indices
-      this.dr_dialog_order.push(tde);
-      this.reorderDialogs();
-      // Update the diagram if its manager has been specified
-      if(mgr) {
-        mgr.visible = true;
-        mgr.updateDialog();
-        if(mgr === DOCUMENTATION_MANAGER) {
-          if(this.info_line.innerHTML.length === 0) {
-            mgr.title.innerHTML = 'About Linny-R';
-            mgr.viewer.innerHTML = mgr.about_linny_r;
-            mgr.edit_btn.classList.remove('enab');
-            mgr.edit_btn.classList.add('disab');
-          }
-          UI.drawDiagram(MODEL);
-        }
-      }
-    } else {
-      const doi = this.dr_dialog_order.indexOf(tde);
-      // NOTE: doi should ALWAYS be >= 0 because dialog WAS showing
-      if(doi >= 0) {
-        this.dr_dialog_order.splice(doi, 1);
-        this.reorderDialogs();
-      }
-      if(mgr) {
-        mgr.visible = true;
-        if(mgr === DOCUMENTATION_MANAGER) {
-          mgr.visible = false;
-          mgr.title.innerHTML = 'Documentation';
-          UI.drawDiagram(MODEL);
-        }
-      }
-    }
-    UI.buttons[dlg].classList.toggle('stay-activ');
-  }
-  
-  reorderDialogs() {
-    let z = 10;
-    for(let i = 0; i < this.dr_dialog_order.length; i++) {
-      this.dr_dialog_order[i].style.zIndex = z;
-      z += 5;
-    }
-  }
-  
   draggableDialog(d) {
     // Make dialog draggable
     const
@@ -3755,7 +3680,7 @@ class GUIController extends Controller {
       UI.dr_dialog.style.width = Math.max(minw, w + dw) + 'px';
       UI.dr_dialog.style.height = Math.max(minh, h + dh) + 'px';
       // Update the dialog if its manager has been specified
-      const mgr = UI.dr_dialog.getAttribute('data-manager');
+      const mgr = UI.dr_dialog.dataset.manager;
       if(mgr) window[mgr].updateDialog();
     }
   
@@ -3766,6 +3691,90 @@ class GUIController extends Controller {
     }
   }
   
+  toggleDialog(e) {
+    // Hide dialog if visible, or show it if not, and update the
+    // order of appearance so that this dialog appears on top
+    e = e || window.event;
+    e.preventDefault();
+    e.stopImmediatePropagation();
+    // Infer dialog identifier from target element
+    const
+        dlg = e.target.id.split('-')[0],
+        tde = document.getElementById(dlg + '-dlg');
+    // NOTE: manager attribute is a string, e.g. 'MONITOR' or 'CHART_MANAGER'
+    let mgr = tde.dataset.manager,
+        was_hidden = this.hidden(tde.id);
+    if(mgr) {
+      // Dialog has a manager object => let `mgr` point to it
+      mgr = window[mgr];
+      // Manager object attributes are more reliable than DOM element
+      // style attributes, so update the visibility status
+      was_hidden = !mgr.visible;
+    }
+    // NOTE: modeler should not view charts while an experiment is
+    // running, so do NOT toggle when the Chart Manager is NOT visible 
+    if(dlg === 'chart' && was_hidden && MODEL.running_experiment) {
+      UI.notify(UI.NOTICE.NO_CHARTS);
+      return;
+    }
+    // Otherwise, toggle the dialog visibility
+    this.toggle(tde.id);
+    UI.buttons[dlg].classList.toggle('stay-activ');
+    if(mgr) mgr.visible = was_hidden;
+    let t, l;
+    if(top in tde.dataset && left in tde.dataset) {
+      // Open at position after last drag (recorded in DOM data attributes)
+      t = tde.dataset.top;
+      l = tde.dataset.left;
+    } else {
+      // Make dialog appear in screen center the first time it is shown
+      const cs = window.getComputedStyle(tde);
+      t = ((window.innerHeight - parseFloat(cs.height)) / 2) + 'px';
+      l = ((window.innerWidth - parseFloat(cs.width)) / 2) + 'px';
+      tde.style.top = t;
+      tde.style.left = l;
+    }
+    if(was_hidden) {
+      // Add activated dialog to "showing" list, and adjust z-indices
+      this.dr_dialog_order.push(tde);
+      this.reorderDialogs();
+      // Update the diagram if its manager has been specified
+      if(mgr) {
+        mgr.updateDialog();
+        if(mgr === DOCUMENTATION_MANAGER) {
+          if(this.info_line.innerHTML.length === 0) {
+            mgr.title.innerHTML = 'About Linny-R';
+            mgr.viewer.innerHTML = mgr.about_linny_r;
+            mgr.edit_btn.classList.remove('enab');
+            mgr.edit_btn.classList.add('disab');
+          }
+          UI.drawDiagram(MODEL);
+        }
+      }
+    } else {
+      const doi = this.dr_dialog_order.indexOf(tde);
+      // NOTE: doi should ALWAYS be >= 0 because dialog WAS showing
+      if(doi >= 0) {
+        this.dr_dialog_order.splice(doi, 1);
+        this.reorderDialogs();
+      }
+      if(mgr === DOCUMENTATION_MANAGER) {
+        mgr.title.innerHTML = 'Documentation';
+        UI.drawDiagram(MODEL);
+      }
+    }
+  }
+  
+  reorderDialogs() {
+    // Set z-index of draggable dialogs according to their order
+    // (most recently shown or clicked on top)
+    let z = 10;
+    for(let i = 0; i < this.dr_dialog_order.length; i++) {
+      this.dr_dialog_order[i].style.zIndex = z;
+      z += 5;
+    }
+  }
+  
   //
   // Button functionality
   //
@@ -5975,7 +5984,7 @@ class GUIMonitor {
         (event) => {
             const el = event.target;
             el.classList.add('sel-pb');
-            MONITOR.showBlock(el.getAttribute('data-blk'));
+            MONITOR.showBlock(el.dataset.blk);
           },
         false);
     this.progress_bar.appendChild(n);

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

@@ -4856,11 +4856,12 @@ Solver status = ${json.status}`);
         return;
       } else {
         // Wait no longer, but warn user that data may be incomplete
-        dsl = [];
+        const dsl = [];
         for(let i = 0; i < MODEL.loading_datasets.length; i++) {
           dsl.push(MODEL.loading_datasets[i].displayName);
         }
-        UI.warn(`Loading datasets (${dsl.join(', ')}) takes too long`);
+        UI.warn('Loading of ' + pluralS(dsl.length, 'dataset') + ' (' +
+            dsl.join(', ') + ') takes too long');
       }
     }
     if(MONITOR.connectToServer()) {