npm - linny-r - Versions diffs - 1.4.2 → 1.4.4 - Mend

linny-r 1.4.2 → 1.4.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (50) hide show

package/README.md +162 -74
package/package.json +1 -1
package/server.js +145 -49
package/static/images/check-off-not-same-changed.png +0 -0
package/static/images/check-off-not-same-not-changed.png +0 -0
package/static/images/check-off-same-changed.png +0 -0
package/static/images/check-off-same-not-changed.png +0 -0
package/static/images/check-on-not-same-changed.png +0 -0
package/static/images/check-on-not-same-not-changed.png +0 -0
package/static/images/check-on-same-changed.png +0 -0
package/static/images/check-on-same-not-changed.png +0 -0
package/static/images/eq-not-same-changed.png +0 -0
package/static/images/eq-not-same-not-changed.png +0 -0
package/static/images/eq-same-changed.png +0 -0
package/static/images/eq-same-not-changed.png +0 -0
package/static/images/ne-not-same-changed.png +0 -0
package/static/images/ne-not-same-not-changed.png +0 -0
package/static/images/ne-same-changed.png +0 -0
package/static/images/ne-same-not-changed.png +0 -0
package/static/images/octaeder.svg +993 -0
package/static/images/sort-asc-lead.png +0 -0
package/static/images/sort-asc.png +0 -0
package/static/images/sort-desc-lead.png +0 -0
package/static/images/sort-desc.png +0 -0
package/static/images/sort-not.png +0 -0
package/static/index.html +72 -647
package/static/linny-r.css +199 -417
package/static/scripts/linny-r-gui-actor-manager.js +340 -0
package/static/scripts/linny-r-gui-chart-manager.js +944 -0
package/static/scripts/linny-r-gui-constraint-editor.js +681 -0
package/static/scripts/linny-r-gui-controller.js +4005 -0
package/static/scripts/linny-r-gui-dataset-manager.js +1176 -0
package/static/scripts/linny-r-gui-documentation-manager.js +739 -0
package/static/scripts/linny-r-gui-equation-manager.js +307 -0
package/static/scripts/linny-r-gui-experiment-manager.js +1944 -0
package/static/scripts/linny-r-gui-expression-editor.js +449 -0
package/static/scripts/linny-r-gui-file-manager.js +392 -0
package/static/scripts/linny-r-gui-finder.js +727 -0
package/static/scripts/linny-r-gui-model-autosaver.js +230 -0
package/static/scripts/linny-r-gui-monitor.js +448 -0
package/static/scripts/linny-r-gui-paper.js +2789 -0
package/static/scripts/linny-r-gui-receiver.js +323 -0
package/static/scripts/linny-r-gui-repository-browser.js +819 -0
package/static/scripts/linny-r-gui-scale-unit-manager.js +244 -0
package/static/scripts/linny-r-gui-sensitivity-analysis.js +778 -0
package/static/scripts/linny-r-gui-undo-redo.js +560 -0
package/static/scripts/linny-r-model.js +27 -11
package/static/scripts/linny-r-utils.js +17 -2
package/static/scripts/linny-r-vm.js +31 -12
package/static/scripts/linny-r-gui.js +0 -16761

package/server.js CHANGED Viewed

@@ -87,9 +87,10 @@ function getVersionInfo() {
     info.current_time = new Date(Date.parse(obj.time[info.current]));
     info.up_to_date = info.current === info.latest;
   } catch(err) {
-    // `latest` = 0 indicates that version check failed
+    // `latest` = 0 indicates that version check failed.
     info.latest = 0;
   }
+  clearNewerVersion();
   if(!info.latest) {
     console.log(connectionErrorText('Could not connect to https://registry.npmjs.org/'));
   } else if(!info.up_to_date) {
@@ -145,12 +146,13 @@ const SOLVER = new MILPSolver(SETTINGS, WORKSPACE);
 // Create launch script
 createLaunchScript();
-// Create the HTTP server
+// Create the HTTP server.
 const SERVER = http.createServer((req, res) => {
     const u = new URL(req.url, 'http://127.0.0.1:' + SETTINGS.port);
-    // When POST, first get all the full body
+    // When POST, first get all the full body.
     if(req.method === 'POST') {
       let body = '';
+      // @@TO DO: For big data requests, string may become too long.
       req.on('data', (data) => body += data);
       req.on('end', () => processRequest(req, res, u.pathname, body));
     } else if(req.method === 'GET') {
@@ -198,7 +200,7 @@ function logAction(msg) {
 function autoCheck(res) {
   // Serves a string with the current version number plus info on a
-  // newer release if this is available
+  // newer release if this is available.
   let check = VERSION_INFO.current + '|';
   if(VERSION_INFO.up_to_date) {
     check += 'up-to-date';
@@ -208,22 +210,46 @@ function autoCheck(res) {
   servePlainText(res, check);
 }
-// HTML page to show then the server is shut down by the user
+function setNewerVersion() {
+  // Creates the file "newer_version" in the working directory, so that
+  // when the server is run from the standard batch script it will detect
+  // that an update is required.
+  const nvf = path.join(WORKING_DIRECTORY, 'newer_version');
+  try {
+    fs.writeFileSync(nvf, VERSION_INFO.latest);
+  } catch(err) {
+    console.log('WARNING: Failed to create file:', nvf);
+    console.log(err);
+  }
+}
+function clearNewerVersion() {
+  // Forestalls auto-update by deleting the file "newer_version" that may
+  // have been created at start-up from the working directory.
+  try {
+    fs.unlink(path.join(WORKING_DIRECTORY, 'newer_version'));
+  } catch(err) {
+    // No action, as error is nogt fatal.
+  }
+}
+// HTML page to show when the server is shut down by the user.
 // NOTE: on a macOS machine, this is slightly more work
-const
-    OS_TEXT = (PLATFORM === 'darwin' ? [
+const OS_TEXT = {close: '', reopen: ''};
+if(PLATFORM === 'darwin') {
+  OS_TEXT.close =
 `<p>You can close the <em>Terminal</em> window that shows
   <tt>[Process Terminated]</tt> at the bottom.
-</p>`,
+</p>`;
+  OS_TEXT.reopen =
 `open <em>Terminal</em> again, change to your Linny-R directory by typing:
 </p>
 <p><code>cd ${WORKING_DIRECTORY}</code></p>
-<p>`
-      ] : [
-'',
-'switch to your <em>Command Prompt</em> window '
-      ]),
-    SHUTDOWN_MESSAGE = `<!DOCTYPE html>
+<p>`;
+} else {
+  OS_TEXT.reopen = 'switch to your <em>Command Prompt</em> window ';
+}
+const SHUTDOWN_MESSAGE = `<!DOCTYPE html>
 <html lang="en-US">
 <head>
   <meta http-equiv="content-type" content="text/html; charset=UTF-8">
@@ -243,13 +269,8 @@ const
   </style>
 </head>
 <body>
-  <h3>Linny-R server (127.0.0.1) is shutting down</h3>` + OS_TEXT[0] + `
-  <p>To restart Linny-R, ` + OS_TEXT[1] + ` and then at the prompt` +
-(VERSION_INFO.up_to_date ? '' : `
-  first type:</p>
-  <p><code>npm update linny-r</code><p>
-  to upgrade to Linny-R version ${VERSION_INFO.latest}, and then`) +
-` type:</p>
+  <h3>Linny-R server (127.0.0.1) is shutting down</h3>${OS_TEXT.close}
+  <p>To restart Linny-R, ${OS_TEXT.reopen} and then at the prompt type:</p>
   <p><code>node node_modules${path.sep}linny-r${path.sep}server</code></p>
   <p>
     Then switch back to this window, and click this
@@ -1064,7 +1085,7 @@ function rcvrReport(res, rpath, rfile, run, data, stats, log) {
         }
       }
     }
-    if(n) console.log(n + 'report file' + (n > 1 ? 's' : '') + 'purged');
+    if(n) console.log(n + ' report file' + (n > 1 ? 's' : '') + ' purged');
   } catch(err) {
     // Log error, but do not abort.
     console.log(err);
@@ -1207,16 +1228,20 @@ function processRequest(req, res, cmd, data) {
   // NOTE: `data` is a string of form field1=value1&field2=value2& ... etc.
   // regardless of the request method (GET or POST)
   if(permittedFile(cmd)) {
-    // Path contains valid MIME file type extension => serve if allowed
+    // Path contains valid MIME file type extension => serve if allowed.
     serveStaticFile(res, cmd);
-  } else if(cmd === '/solver/') {
+    return;
+  }
+  // Be permissive w.r.t. leading and trailing slashes.
+  cmd = cmd.replace(/^\/+/, '').replace(/\/+$/, '');
+  if(cmd === 'solver') {
     const
         sp = new URLSearchParams(data),
         action = sp.get('action');
-    // NOTE: on remote servers, solver actions require authentication
+    // 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
+      // 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});
     } else if(action === 'png') {
@@ -1229,19 +1254,40 @@ function processRequest(req, res, cmd, data) {
       console.log(msg);
       serveJSON(res, {error: msg});
     }
-  } else if(cmd === '/shutdown') {
-    // Shut down this server
+  } else if(cmd === 'shutdown') {
+    // Shut down this server WITHOUT updating, and show page with
+    // "shut down" message and restart button.
+    clearNewerVersion();
     serveHTML(res, SHUTDOWN_MESSAGE);
     SERVER.close();
-  } else if(cmd === '/auto-check') {
+  } 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
+    // a batch script, this will update via npm, and then restart.
+    // NOTE: Self-protect against overwriting development scripts.
+    if(WORKING_DIRECTORY.indexOf('LTR3') >= 0) {
+      servePlainText(res, 'No version update in development environment');
+    } else {
+      setNewerVersion();
+      servePlainText(res, 'Installing Linny-R version ' + VERSION_INFO.latest);
+      SERVER.close();
+    }
+  } else if(cmd === 'no-update') {
+    // Remove file "newer_version" so no update will take place when
+    // server is shut down.
+    clearNewerVersion();
+    servePlainText(res, 'No update to version ' + VERSION_INFO.latest);
+  } else if(cmd === 'auto-check') {
     autoCheck(res);
-  } else if(cmd === '/autosave/') {
+  } else if(cmd === 'autosave') {
     autoSave(res, new URLSearchParams(data));
-  } else if(cmd === '/repo/') {
+  } else if(cmd === 'repo') {
     repo(res, new URLSearchParams(data));
-  } else if(cmd === '/load-data/') {
+  } else if(cmd === 'load-data') {
     loadData(res, (new URLSearchParams(data)).get('url'));
-  } else if(cmd === '/receiver/') {
+  } else if(cmd === 'receiver') {
     receiver(res, new URLSearchParams(data));
   } else {
     serveJSON(res, {error: `Unknown Linny-R request: "${cmd}"`});
@@ -1249,7 +1295,7 @@ function processRequest(req, res, cmd, data) {
 }
 function servePlainText(res, msg) {
-  // Serve string `msg` as plain text
+  // Serve string `msg` as plain text.
   res.setHeader('Content-Type', 'text/plain');
   res.writeHead(200);
   res.end(msg);
@@ -1334,8 +1380,9 @@ function convertSVGtoPNG(req, res, sp) {
     // Enclose paths in double quotes if they contain spaces
     if(cmd.indexOf(' ') >= 0) cmd = `"${cmd}"`;
     if(svg.indexOf(' ') >= 0) svg = `"${svg}"`;
-    child_process.exec(cmd + ' --export-type=png --export-dpi=' +
-        SETTINGS.dpi + ' ' + svg,
+    cmd += ` --export-type=png --export-dpi=${SETTINGS.dpi} ${svg}`;
+    console.log(cmd);
+    child_process.exec(cmd,
         (error, stdout, stderr) => {
             let ext = '.svg';
             console.log(stdout);
@@ -1343,8 +1390,24 @@ function convertSVGtoPNG(req, res, sp) {
               console.log('WARNING: Failed to run Inkscape --', error);
               console.log(stderr);
             } else {
-              ext = '.png';
-              // Delete the SVG
+              // Look for the PNG file.
+              const mode = fs.constants.R_OK | fs.constants.W_O;
+              try {
+                fs.accessSync(fp + '.png', mode);
+                ext = '.png';
+              } catch(err) {
+                // NOTE: Inkscape 1.3 adds ".png" to the original file name,
+                // so this may end on ".svg.png"
+                try {
+                  fs.accessSync(fp + '.svg.png', mode);
+                  // If found, rename the PNG file.
+                  fs.renameSync(fp + '.svg.png', fp + '.png');
+                  ext = '.png';
+                } catch(err) {
+                  console.log('WARNING: Inkscape did not output a PNG file');
+                }
+              }
+              // Delete the SVG file.
               try {
                 fs.unlinkSync(fp + '.svg');
               } catch(error) {
@@ -1623,9 +1686,17 @@ function commandLineSettings() {
   }
   // Verify that Inkscape is installed
   if(settings.inkscape) {
-    // NOTE: on Windows, the command line version is a .com file
-    const ip = path.join(settings.inkscape,
+    // 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)
+      ip = path.join(settings.inkscape,
+          'inkscapecom' + (PLATFORM.startsWith('win') ? '.com' : ''));
+    }
     try {
       fs.accessSync(ip, fs.constants.X_OK);
       console.log('Path to Inkscape:', settings.inkscape);
@@ -1698,28 +1769,53 @@ function createLaunchScript() {
   // Creates platform-specific script with Linny-R start-up command
   const lines = [
       '# The first line (without the comment symbol #) should be like this:',
-      '# cd ',
+      '',
       '',
       '# Then this command to launch the Linny-R server should work:',
-      'node ' + path.join('node_modules', 'linny-r', 'server') + ' launch'
+      '',
+      '# After shut-down, check whether new version should be installed:'
     ];
+  lines[2] = 'cd ' + WORKING_DIRECTORY;
   let sp;
   if(PLATFORM.startsWith('win')) {
     sp = path.join(WORKING_DIRECTORY, 'linny-r.bat');
-    lines[1] += 'C:\\path\\to\\main\\Linny-R\\directory';
+    lines.push(
+      ':loop',
+      'if exist newer_version (',
+      '    del newer_version',
+      '    npm update linny-r',
+      '    node node_modules\\linny-r\\server',
+      '    goto loop',
+      ')');
+    lines[1] = '# cd C:\\path\\to\\main\\Linny-R\\directory';
+    lines[4] = 'node node_modules\\linny-r\\server launch';
   } else {
     sp = path.join(WORKING_DIRECTORY, 'linny-r.command');
-    lines[1] += '/path/to/main/Linny-R/directory';
+    lines.push(
+      'while test -f newer_version; do',
+      '    unlink newer_version',
+      '    npm update linny-r',
+      '    node node_modules/linny-r/server',
+      'done');
+    lines[1] = '# cd /path/to/main/Linny-R/directory';
+    lines[4] = 'node node_modules/linny-r/server launch';
   }
-  lines[2] = 'cd ' + WORKING_DIRECTORY;
   try {
+    let make_script = false,
+        code = lines.join(os.EOL);
+    if(PLATFORM.startsWith('win')) code = code.replaceAll('#', '::');
     try {
       fs.accessSync(sp);
+      // Only write the script content if the file has not been customized
+      // by the user...
+      const data = fs.readFileSync(sp, 'utf-8');
+      make_script = code.indexOf(data) >= 0;
     } catch(err) {
-      // Only write the script content if the file it does not yet exist
+      // ... or if it does not exist yet.
+      make_script = true;
+    }
+    if(make_script) {
       console.log('Creating launch script:', sp);
-      let code = lines.join(os.EOL);
-      if(PLATFORM.startsWith('win')) code = code.replaceAll('#', '::');
       fs.writeFileSync(sp, code, 'utf8');
     }
   } catch(err) {