linny-r 1.6.7 → 1.7.0

package/server.js

@@ -137,13 +137,13 @@ const MILPSolver = require('./static/scripts/linny-r-milp.js');
 //  - workspace=[path]  will create workspace in [path] instead of (main)/user
 const SETTINGS = commandLineSettings();
     
-// The workspace defines the paths to directories where Linny-R can write files
+// The workspace defines the paths to directories where Linny-R can write files.
 const WORKSPACE = createWorkspace();
     
-// Initialize the solver
-const SOLVER = new MILPSolver(SETTINGS, WORKSPACE);
+// Initialize the solver.
+const SOLVER = new MILPSolver(SETTINGS.preferred_solver, WORKSPACE);
 
-// Create launch script
+// Create launch script.
 createLaunchScript();
 
 // Create the HTTP server.
@@ -1262,11 +1262,24 @@ function processRequest(req, res, cmd, data) {
     // NOTE: On remote servers, solver actions require authentication.
     if(action === 'logon') {
       // No authentication -- simply return the passed token, "local host"
-      // as server name, and the identifier of the solver.
-      serveJSON(res,
-          {token: 'local host', server: 'local host', solver: SOLVER.id});
+      // as server name, the name of the solver, the list of installed
+      // solvers, and the Linny-R directory.
+      serveJSON(res, {
+          token: 'local host',
+          server: 'local host',
+          solver: SOLVER.id,
+          solver_list: Object.keys(SOLVER.solver_list),
+          path: WORKING_DIRECTORY
+        });
     } else if(action === 'png') {
       convertSVGtoPNG(req, res, sp);
+    } else if(action === 'change') {
+      const sid = sp.get('solver');
+      if(SOLVER.changeDefault(sid)) {
+        servePlainText(res, 'Default solver set to ' + SOLVER.name);
+      } else {
+        servePlainText(res, 'WARNING: Failed to change solver to ' + sid);
+      }
     } else if(action === 'solve') {
       serveJSON(res, SOLVER.solveBlock(sp));
     } else {
@@ -1282,7 +1295,6 @@ function processRequest(req, res, cmd, data) {
     serveHTML(res, SHUTDOWN_MESSAGE);
     SERVER.close();
   } else if(cmd === 'version') {
-    logAction('HERE version = ' + VERSION_INFO.current);
     servePlainText(res, 'Current version is ' + VERSION_INFO.current);
   } else if(cmd === 'update') {
     // Shut down this server silently. When the server was started from
@@ -1529,8 +1541,6 @@ function commandLineSettings() {
       launch: false,
       port: 5050,
       preferred_solver: '',
-      solver: '',
-      solver_path: '',
       user_dir: path.join(WORKING_DIRECTORY, 'user')
     };
   const
@@ -1600,142 +1610,36 @@ Possible options are:
       }
     }
   }
-  // Check whether MILP solver(s) and Inkscape have been installed
+  // Check whether Inkscape has been installed.
   const path_list = process.env.PATH.split(path.delimiter);
-  let gurobi_path = '',
-      scip_path = '',
-      cplex_path = '',
-      match,
-      max_v = -1;
   for(let i = 0; i < path_list.length; i++) {
-    match = path_list[i].match(/gurobi(\d+)/i);
-    if(match && parseInt(match[1]) > max_v) {
-      gurobi_path = path_list[i];
-      max_v = parseInt(match[1]);
-    }
-    match = path_list[i].match(/[\/\\]cplex[\/\\]bin/i);
-    if(match) {
-      cplex_path = path_list[i];
-    } else {
-      // NOTE: CPLEX may create its own environment variable for its paths
-      match = path_list[i].match(/%(.*cplex.*)%/i);
-      if(match) {
-        const cpl = process.env[match[1]].split(path.delimiter);
-        for(let i = 0; i < cpl.length; i++) {
-          match = cpl[i].match(/[\/\\]cplex[\/\\]bin/i);
-          if(match) {
-            cplex_path = cpl[i];
-            break;
-          }
-        }
-      }
-    }
-    match = path_list[i].match(/[\/\\]scip[^\/\\]+[\/\\]bin/i);
-    if(match) scip_path = path_list[i];
+    // Check whether it is an Inkscape path.
     match = path_list[i].match(/inkscape/i);
+    // If so, use it (so the *last* matching path will be used).
     if(match) settings.inkscape = path_list[i];
   }
-  if(!gurobi_path && !PLATFORM.startsWith('win')) {
-    console.log('Looking for Gurobi in /usr/local/bin');
-    try {
-      // On macOS and Unix, Gurobi is in the user's local binaries
-      const gp = '/usr/local/bin';
-      fs.accessSync(gp + '/gurobi_cl');
-      gurobi_path = gp;
-    } catch(err) {
-      // No real error, so no action needed
-    }
-  }
-  if(gurobi_path) {
-    console.log('Path to Gurobi:', gurobi_path);
-    // Check if command line version is executable
-    const sp = path.join(gurobi_path,
-        'gurobi_cl' + (PLATFORM.startsWith('win') ? '.exe' : ''));
-    try {
-      fs.accessSync(sp, fs.constants.X_OK);
-      if(settings.solver !== 'gurobi') 
-      settings.solver = 'gurobi';
-      settings.solver_path = sp;
-    } catch(err) {
-      console.log(err.message);
-      console.log(
-          'WARNING: Failed to access the Gurobi command line application');
-    }
-  }
-  // Check if cplex(.exe) exists in its directory
-  let sp = path.join(cplex_path, 'cplex' + (PLATFORM.startsWith('win') ? '.exe' : ''));
-  const need_cplex = !settings.solver || settings.preferred_solver === 'cplex';
-  try {
-    fs.accessSync(sp, fs.constants.X_OK);
-    console.log('Path to CPLEX:', sp);
-    if(need_cplex) {
-      settings.solver = 'cplex';
-      settings.solver_path = sp;
-    }
-  } catch(err) {
-    // Only report error if CPLEX is needed
-    if(need_cplex) {
-      console.log(err.message);
-      console.log('WARNING: CPLEX application not found in', sp);
-    }
-  }
-  // Check if scip(.exe) exists in its directory
-  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
-  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);
-    if(need_lps) {
-      settings.solver = 'lp_solve';
-      settings.solver_path = sp;
-    }
-  } catch(err) {
-    // Only report error if LP_solve is needed
-    if(need_lps) {
-      console.log(err.message);
-      console.log('WARNING: LP_solve application not found in', sp);
-    }
-  }
-  // On macOS, Inkscape is not added to the PATH environment variable 
+  // NOTE: On macOS, Inkscape is not added to the PATH environment variable. 
   if(!settings.inkscape && PLATFORM === 'darwin') {
     console.log('Looking for Inkscape in Applications...');
     try {
-      // Look in the default directory
+      // Look in the default directory.
       const ip = '/Applications/Inkscape.app/Contents/MacOS';
       fs.accessSync(ip);
       settings.inkscape = ip;
     } catch(err) {
-      // No real error, so no action needed
+      // No real error, so no action needed.
     }
   }
-  // Verify that Inkscape is installed
+  // Verify that Inkscape is installed.
   if(settings.inkscape) {
-    // NOTE: On Windows, the command line version is a .com file
+    // NOTE: On Windows, the command line version is a .com file.
     let ip = path.join(settings.inkscape,
         'inkscape' + (PLATFORM.startsWith('win') ? '.com' : ''));
     try {
       fs.accessSync(ip, fs.constants.X_OK);
     } catch(err) {
       // NOTE: As of Inkscape version 1.3, the command line executable
-      // is called inkscapecom(.com)
+      // is called inkscapecom(.com).
       ip = path.join(settings.inkscape,
           'inkscapecom' + (PLATFORM.startsWith('win') ? '.com' : ''));
     }
@@ -1759,14 +1663,14 @@ Possible options are:
 }
 
 function createWorkspace() {
-  // Verifies that Linny-R has write access to the user workspace, defines
-  // paths to sub-directories, and creates them if necessary
+  // Verify that Linny-R has write access to the user workspace, define
+  // paths to sub-directories, and create them if necessary.
   try {
-    // See whether the user directory already exists
+    // See whether the user directory already exists.
     try {
       fs.accessSync(SETTINGS.user_dir, fs.constants.R_OK | fs.constants.W_O);
     } catch(err) {
-      // If not, try to create it
+      // If not, try to create it.
       fs.mkdirSync(SETTINGS.user_dir);
       console.log('Created user directory:', SETTINGS.user_dir);
     }
@@ -1776,7 +1680,7 @@ function createWorkspace() {
         SETTINGS.user_dir);
     process.exit();
   }
-  // Define the sub-directory paths
+  // Define the sub-directory paths.
   const ws = {
       autosave: path.join(SETTINGS.user_dir, 'autosave'),
       channel: path.join(SETTINGS.user_dir, 'channel'),
@@ -1787,7 +1691,7 @@ function createWorkspace() {
       reports: path.join(SETTINGS.user_dir, 'reports'),
       solver_output: path.join(SETTINGS.user_dir, 'solver')
     };
-  // Create these sub-directories if not aready there
+  // Create these sub-directories if not aready there.
   try {
     for(let p in ws) if(ws.hasOwnProperty(p)) {
       try {
@@ -1801,9 +1705,11 @@ function createWorkspace() {
     console.log(err.message);
     console.log('WARNING: No access to workspace directory');
   }
-  // The file containing name, URL and access token for remote repositories
+  // The file containing name, URL and access token for remote repositories.
   ws.repositories = path.join(SETTINGS.user_dir, 'repositories.cfg');
-  // Return the updated workspace object
+  // For completeness, add path to Linny-R directory.
+  ws.working_directory = WORKING_DIRECTORY;
+  // Return the updated workspace object.
   return ws;
 }
 

package/static/index.html

@@ -162,16 +162,17 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
             if(info.length > 1) {
               LINNY_R_VERSION = info[0];
               const v = 'Version ' + LINNY_R_VERSION;
-              // Update the "home page" of the documentation manager
+              // Update the "home page" of the documentation manager.
               DOCUMENTATION_MANAGER.about_linny_r =
                   DOCUMENTATION_MANAGER.about_linny_r.replace(
                       '[LINNY_R_VERSION]', v);
-              // Update the version number in the browser's upper left corner
+              // Update the version number in the browser's upper left corner.
               document.getElementById('linny-r-version-number').innerHTML = v;
-              // NOTE: server detects "version 0" when npmjs website was
-              // not reached; if so, do not suggest a new version exists
+              // NOTE: Server detects "version 0" when npmjs website was
+              // not reached; if so, do not suggest a new version exists.
               if(info[1] !== 'up-to-date' && info[1] !== '0') {
-                // Inform user that newer version exists
+                // Inform user that newer version exists.
+                UI.newer_version = info[1];
                 UI.check_update_modal.element('msg').innerHTML = [
                     '<a href="', GITHUB_REPOSITORY,
                     '/releases/tag/v', info[1], '" ',
@@ -423,6 +424,28 @@ and move the cursor over the status bar">
     </div>
   </div>
 
+  <!-- the SERVER dialog permits solver selection, update and shut-down -->
+  <div id="server-modal" class="modal">
+    <div id="server-dlg" class="inp-dlg">
+      <div class="dlg-title">
+        Server and solver
+        <img class="cancel-btn" src="images/cancel.png">
+        <img class="ok-btn" src="images/ok.png">
+      </div>
+      <div id="server-host-div" title="Linny-R directory">Server on local host</div>
+      <div id="server-no-solver-div">No solver detected</div>
+      <div id="server-solver-div" hidden="hidden">
+        <div id="server-sel">
+          <label>Default solver:</label>
+          <select id="server-solver">
+          </select>
+        </div>
+      </div>
+      <button id="server-update" hidden="hidden">Update Linny-R to new version</button>
+      <button id="server-shut-down">Shut down server</button>
+    </div>
+  </div>
+  
   <!-- the MODEL dialog prompts for (optional) model name and author name -->
   <div id="model-modal" class="modal">
     <div id="model-dlg" class="inp-dlg">
@@ -605,6 +628,8 @@ and move the cursor over the status bar">
           <td colspan="2">Solver time limit:&nbsp;
             <input id="settings-time-limit" type="text" autocomplete="off"
                    style="width:35px;text-align:center"> seconds per block
+            <img id="settings-solver-prefs-btn" class="sbtn" src="images/settings.png"
+                 title="Set solver preferences">
           </td>
         </tr>
         <tr>
@@ -688,6 +713,40 @@ NOTE: Unit symbols are case-sensitive, so BTU &ne; Btu">
     </div>
   </div>
 
+  <!-- the SOLVER dialog permits specifying solver preference and tolerances -->
+  <div id="solver-modal" class="modal">
+    <div id="solver-dlg" class="inp-dlg">
+      <div class="dlg-title">
+        Solver preferences
+        <img class="cancel-btn" src="images/cancel.png">
+        <img class="ok-btn" src="images/ok.png">
+      </div>
+      <table style="width: 100%">
+        <tr title="This solver will be used if it is installed">
+          <td>
+            <label>Preferred solver:</label>
+            <select id="solver-preference">
+            </select>
+          </td>
+        </tr>
+        <tr title="Tolerance may range from 1e-9 to 0.1">
+          <td>
+            <label>Integer feasibility tolerance:</label>
+            <input id="solver-int-feasibility" style="width: 55px"
+                   placeholder="5e-7" type="text" autocomplete="off">
+          </td>
+        </tr>
+        <tr title="Relative gap may range from 0 to 0.5">
+          <td>
+            <label>Relative MIP gap:</label>
+            <input id="solver-mip-gap" style="width: 55px"
+                   placeholder="1e-4" type="text" autocomplete="off">
+          </td>
+        </tr>
+      </table>
+    </div>
+  </div>
+
   <!-- the REPOSITORY BROWSER dialog allows interaction with repositories -->
   <div id="repository-dlg" class="inp-dlg">
     <div id="repository-hdr" class="dragger dlg-title">Repository browser

package/static/linny-r.css

@@ -944,6 +944,7 @@ img.inline-cancel-btn {
   height: min-content;
 }
 
+#settings-solver-prefs-btn,
 #settings-scale-units-btn {
   margin-left: 0px;
   margin-right: 7px;
@@ -952,6 +953,7 @@ img.inline-cancel-btn {
   filter: brightness(85%);
 }
 
+#settings-solver-prefs-btn:hover, 
 #settings-scale-units-btn:hover {
   filter: brightness(200%);
 }
@@ -994,6 +996,16 @@ input.pws-5 {
   background-color: #c0ffc0;
 }
 
+/* styles for the SOLVER PREFERENCES dialog */
+#solver-modal {
+  z-index: 110; /* on top of the SETTINGS dialog */
+}
+
+#solver-dlg {
+  width: 212px;
+  height: min-content;
+}
+
 /* styles for the ACTOR DIALOG
    NOTE: the z-index is very high for this dialog, as it should appear
    on top of the ACTOR LIST DIALOG
@@ -1190,6 +1202,35 @@ td.export {
   color: #0000b0;
 }
 
+/* styles for the SERVER dialog */
+#server-dlg {
+  width: 200px;
+  height: min-content;
+}
+#server-host-div,
+#server-solver-div {
+  margin: 3px;
+}
+
+#server-no-solver-div {
+  margin: 3px;
+  padding-top: 2px;
+  padding-bottom: 2px;
+  font-style: italic;
+  margin-bottom: 2px;
+}
+
+#server-solver {
+  font-size: 12px;
+  margin-bottom: 3px;
+}
+
+#server-update,
+#server-shut-down {
+  margin: 3px;
+  font-size: 12px;
+}
+
 /* styles for the MODEL dialog */
 #model-dlg {
   width: 270px;

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

@@ -260,7 +260,7 @@ class Controller {
     return VM.sig2Dig(n) + ' ' + 'kMGTP'.charAt(m) + 'B';
   }
   
-  // Shapes are only used to draw model diagrams
+  // Shapes are only used to draw model diagrams.
   
   createShape(mdl) {
     if(this.paper) return new Shape(mdl);
@@ -275,7 +275,7 @@ class Controller {
     if(shape) shape.removeFromDOM();
   }
 
-  // Methods to ensure proper naming of entities
+  // Methods to ensure proper naming of entities.
 
   cleanName(name) {
     // Returns `name` without the object-attribute separator |, backslashes,
@@ -429,7 +429,7 @@ class Controller {
 
   
   nameToID(name) {
-    // Returns a name in lower case with link arrow replaced by three
+    // Return a name in lower case with link arrow replaced by three
     // underscores, constraint link arrow by four underscores, and spaces
     // converted to underscores; in this way, IDs will always be valid
     // JavaScript object properties.
@@ -442,7 +442,7 @@ class Controller {
       // Empty string signals failure.
       return '';
     }
-    // NOTE: replace single quotes by Unicode apostrophe so that they
+    // NOTE: Replace single quotes by Unicode apostrophe so that they
     // cannot interfere with JavaScript strings delimited by single quotes.
     return name.toLowerCase().replace(/\s/g, '_').replace("'", '\u2019');
   }
@@ -485,8 +485,8 @@ class Controller {
   // Methods to notify modeler
   
   setMessage(msg, type, cause=null) {
-    // Only log errors and warnings on the browser console
-    // NOTE: optionally, the JavaScript error can be passed via `cause`
+    // Only log errors and warnings on the browser console.
+    // NOTE: Optionally, the JavaScript error can be passed via `cause`.
     if(type === 'error' || type === 'warning') {
       // Add type unless message already starts with it
       type = type.toUpperCase() + ':';
@@ -547,8 +547,8 @@ class Controller {
   }
   
   postResponseOK(text, notify=false) {
-    // Checks whether server reponse text is warning or error, and notifies
-    // the modeler if second argument is TRUE
+    // Check whether server reponse text is warning or error, and notify
+    // the modeler if second argument is TRUE.
     let mtype = 'notification';
     if(text.startsWith('ERROR:')) {
       mtype = 'error';
@@ -563,20 +563,20 @@ class Controller {
   }
   
   loginPrompt() {
-    // The VM needs credentials - his should only occur for the GUI
+    // The VM needs credentials - his should only occur for the GUI.
     console.log('WARNING: VM needs credentials, but GUI not active');
   }
 
   resetModel() {
-    // Resets the Virtual Machine (clears solution) 
+    // Reset the Virtual Machine (clears solution). 
     VM.reset();
-    // Redraw model in the browser (GUI only)
+    // Redraw model in the browser (GUI only).
     MODEL.clearSelection();
     this.drawDiagram(MODEL);
   }
   
   stopSolving() {
-    // Notify user only if VM was halted
+    // Notify user only if VM was halted.
     if(VM.halted) {
       this.notify('Solver HALTED');
     } else {
@@ -585,8 +585,9 @@ class Controller {
   }
   
   // NOTE: The following UI functions are implemented as "dummy" methods
-  // because they are called by the Virtual Machine and/or by other controllers
-  // while they can only be meaningfully performed by the GUI controller
+  // because they are called by the Virtual Machine and/or by other
+  // controllers while they can only be meaningfully performed by the
+  // GUI controller.
   addListeners() {}
   readyToReset() {}
   updateScaleUnitList() {}
@@ -616,27 +617,27 @@ class RepositoryBrowser {
     this.repositories = [];
     this.repository_index = -1; 
     this.module_index = -1;
-    // Get the repository list from the server
+    // Get the repository list from the server.
     this.getRepositories();
     this.reset();
   }
   
   reset() {
     this.visible = false;
-    // NOTE: do NOT reset repository list or module index, because:
-    // (1) they are properties of the local host, and hence model-independent
+    // NOTE: Do NOT reset repository list or module index, because:
+    // (1) they are properties of the local host, and hence model-independent;
     // (2) they must be known when loading a module as model, whereas the
-    //     loadingModel method hides and resets all stay-on-top dialogs
+    //     loadingModel method hides and resets all stay-on-top dialogs.
   }
 
   get isLocalHost() {
-    // Returns TRUE if first repository on the list is 'local host'
+    // Return 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
+    // Get the list of repository names from the server.
     this.repositories.length = 0;
     fetch('repo/', postData({action: 'list'}))
       .then((response) => {
@@ -647,14 +648,14 @@ class RepositoryBrowser {
         })
       .then((data) => {
           if(UI.postResponseOK(data)) {
-            // NOTE: trim to prevent empty name strings
+            // NOTE: Trim to prevent empty name strings.
             const rl = data.trim().split('\n');
             for(let i = 0; i < rl.length; i++) {
               this.addRepository(rl[i].trim());
             }
           }
-          // NOTE: set index to first repository on list (typically local host)
-          // unless the list is empty
+          // NOTE: Set index to first repository on list (typically the
+          // local host repository) unless the list is empty.
           this.repository_index = Math.min(0, this.repositories.length - 1);
           this.updateDialog();
         })
@@ -662,7 +663,7 @@ class RepositoryBrowser {
   }
   
   repositoryByName(n) {
-    // Returns the repository having name `n` if already known, otherwise NULL
+    // Return the repository having name `n` if already known, or NULL.
     for(let i = 0; i < this.repositories.length; i++) {
       if(this.repositories[i].name === n) {
         return this.repositories[i];
@@ -672,8 +673,8 @@ class RepositoryBrowser {
   }
   
   asFileName(s) {
-    // Returns string `s` with whitespace converted to a single dash, and
-    // special characters converted to underscores
+    // Return 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, '_')
@@ -681,12 +682,13 @@ class RepositoryBrowser {
   }
   
   loadModuleAsModel() {
-    // Loads selected module as model
+    // Load selected module as model.
     if(this.repository_index >= 0 && this.module_index >= 0) {
-      // NOTE: when loading new model, the stay-on-top dialogs must be reset
+      // NOTE: When loading new model, the stay-on-top dialogs must be
+      // reset (GUI only; for console this is a "dummy" method).
       UI.hideStayOnTopDialogs();
       const r = this.repositories[this.repository_index];
-      // NOTE: pass FALSE to indicate "no inclusion; load XML as model"
+      // NOTE: pass FALSE to indicate "no inclusion; load XML as model".
       r.loadModule(this.module_index, false);
     }
   }