linny-r 1.9.3 → 2.0.2

package/post-install.js

@@ -5,28 +5,30 @@ The Linny-R language and tool have been developed by Pieter Bots at Delft
 University of Technology, starting in 2009. The project to develop a browser-
 based version started in 2017. See https://linny-r.org for more information.
 
-This NodeJS script (post-install.js) creates a launch script for Linny-R
-that facilitates start-up: the user can then type `linny-r` at the command
-line prompt, and also create a clickable icon as desktop shortcut.
+This NodeJS script (post-install.js) checks whether the Linny-R directory
+contains a launch script for Linny-R. For macOS, the script file is
+`linny-r.command`, for Windows `linny-r.bat`.
+If such a file already exists, this script will try to rename it, adding
+the prefix `OLD-` to the name. Doing this will make that the the Linny-R
+server script will create the newest version of the launch script the
+first time it is run.
 
-For macOS, the script file is `linny-r.command`, for Windows `linny-r.bat`.
-The script comprises two commands:
+The launch script has two intended functions:
+(1) to facilitate start-up: the user can type `linny-r` at the command
+    line prompt,and (more importantly) create a clickable icon as desktop
+    shortcut.
+(2) to facilitate automatic software updates: when (after lauch in a browser)
+    Linny-R detects a newer version, it will prompt the user whether this
+    update should be installed. When the user confirms, the server script
+    is terminated, and then launch script executes the commands to update
+    and then restart the Linny-R server.
 
-  cd path/to/linny-r/directory
-  node node_modules/linny-r/server launch
-  
-since Windows also supports the slash as path separator. The "launch"
-command tells the script `server.js` to start Linny-R in the default
-web browser. 
-
-Comments are added to the script file to facilitate customization of the
-scripts by the user. The README.md file explains how the script file can be
-used for single-click launch of Linny-R, and how the "workspace" parameter
-can be used in a multi-user network environment to provide individual
-workspaces for users.
+The README.md file explains how the script file can be used for single-click
+launch of Linny-R, and how the "workspace" parameter can be used in a
+multi-user network environment to provide individual workspaces for users.
 */
 /*
-Copyright (c) 2020-2022 Delft University of Technology
+Copyright (c) 2020-2024 Delft University of Technology
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -56,32 +58,86 @@ const
     // NOTE: working directory for this script is the *module* directory,
     // which is two levels deeper than the actual working directory
     WORKING_DIRECTORY = process.cwd().replace(path.sep + mod_dir, ''),
-    lines = [
+    ext = (PLATFORM.startsWith('win') ? 'bat' : 'command'),
+    sp = path.join(WORKING_DIRECTORY, 'linny-r.' + ext);
+
+// NOTE: Function `createLaunchScript` is a copy of this function as
+// defined in script file `server.js`.
+
+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 ',
         '',
+        'cd ' + WORKING_DIRECTORY,
         '# Then this command to launch the Linny-R server should work:',
-        `node ${mod_dir}${path.sep}server launch`
-      ];
-let sp;
-if(PLATFORM.startsWith('win')) {
-  sp = path.join(WORKING_DIRECTORY, 'linny-r.bat');
-  lines[1] += 'C:\\path\\to\\\\your\\Linny-R\\directory';
-} else {
-  sp = path.join(WORKING_DIRECTORY, 'linny-r.command'); 
-  lines[1] += '/path/to/your/Linny-R/directory';
+        '',
+        '# After shut-down, check whether new version should be installed:'
+      ],
+    windows = PLATFORM.startsWith('win'),
+    sp = path.join(WORKING_DIRECTORY, 'linny-r.' + (windows ? 'bat' : 'command'));
+  if(windows) {
+    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 {
+    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';
+  }
+  try {
+    let code = lines.join(os.EOL);
+    if(windows) code = code.replaceAll('#', '::');
+    try {
+      fs.accessSync(sp);
+      // Do not overwrite existing script, as it may have been customized
+      // by the user. When istalling/updating Linny-R, the post-install
+      // script should have renamed it, so typically it is created the
+      // first time Linny-R is run after install/update.
+    } catch(err) {
+      console.log('Creating launch script:', sp);
+      fs.writeFileSync(sp, code, 'utf8');
+      // On macOS machines, try to make the script executable.
+      if(!windows) try {
+        fs.chmodSync(sp, '+x');
+      } catch(err) {
+        console.log('WARNING: Failed to make script executable -- please check');
+      }
+    }
+  } catch(err) {
+    console.log('WARNING: Failed to create launch script');
+  }
 }
-lines[2] = 'cd ' + WORKING_DIRECTORY;
+
+// First rename the existing script (if any) as this may have been changed
+// by the user, and the idea of the changes would be lost by overwriting it.
 try {
+  fs.accessSync(sp);
   try {
-    fs.accessSync(sp);
+    // Only rename the script content if the file it does not yet exist
+    console.log('Renaming existing launch script:', sp);
+    fs.renameSync(sp, path.join(WORKING_DIRECTORY, 'OLD-linny-r.' + ext));
   } catch(err) {
-    // Only write the script content if the file it does not yet exist
-    console.log('Creating launch script:', sp);
-    let code = lines.join(os.EOL);
-    if(PLATFORM.startsWith('win')) code = code.replaceAll('#', '::');
-    fs.writeFileSync(sp, code, 'utf8');
+    console.log('WARNING: Failed to rename existing launch script');
   }
 } catch(err) {
-  console.log('WARNING: Failed to create launch script');
+  // No existing script => action needed.
 }
+
+// Then create new launch script. This way, after update or clean install,
+// the user can
+createLaunchScript();
+

package/server.js

@@ -12,7 +12,7 @@ that pass the MILP equation model to the solver, and then return the solution
 to the Linny-R "virtual machine" that is running in the browser.
 */
 /*
-Copyright (c) 2020-2022 Delft University of Technology
+Copyright (c) 2020-2024 Delft University of Technology
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -416,9 +416,21 @@ function autoSaveLoad(res, sp) {
 function autoSaveStore(res, sp) {
   // Stores XML data under specified file name in the auto-save directory
   let data = 'OK';
-  const fn = sp.get('file');
+  const
+      fn = sp.get('file'),
+      wsd = sp.get('wsd'),
+      ws = (wsd ? WORKSPACE.models : WORKSPACE.autosave),
+      msg = (wsd === 'models' ? 'save to user workspace' : 'auto-save'),
+      exists = (path) => {
+          try {
+            fs.accessSync(path);
+            return true;
+          } catch(err) {
+            return false;
+          }
+        };
   if(!fn) {
-    data = 'WARNING: No name for file to auto-save';
+    data = 'WARNING: No name for file to ' + msg;
   } else {
     const xml = sp.get('xml');
     // Validate XML as a Linny-R model
@@ -429,10 +441,41 @@ function autoSaveStore(res, sp) {
           root = doc.documentElement;
       // Linny-R models have a model element as root
       if(root.nodeName !== 'model') throw 'XML document has no model element';
-      fs.writeFileSync(path.join(WORKSPACE.autosave, fn + '.lnr'), xml);
+      let fp = path.join(ws, fn + '.lnr');
+      if(wsd) {
+        // Append a version number to the file name if named file exists.
+        const re = /\(\d+\).lnr$/;
+        if(exists(fp)) {
+          const m = fp.match(re);
+          let n = 1;
+          if(m) {
+            // Replace version number (n) by (n+1).
+            n = parseInt(m[0].substring(1, m[0].length - 1)) + 1;
+            fp = fp.replace(re, `(${n}).lnr`);
+          } else {
+            // Add (1) as version number.
+            fp = fp.substring(0, fp.length - 4) + ' (1).lnr';
+          }
+          while(exists(fp)) {
+            // Iterate to find the first available version number.
+            n++;
+            fp = fp.replace(re, `(${n}).lnr`);
+          }
+        }
+      }
+      try {
+        fs.writeFileSync(fp, xml);
+        const d = `Model ${ws ? '' : 'auto-'}saved as ${fp}`;
+        console.log(d);
+        // No message (other than OK) when auto-saving.
+        if(ws) data = d;
+      } catch(err) {
+        console.log(err);
+        data = `ERROR: Failed to ${msg} to ${fp}`;
+      }
     } catch(err) {
       console.log(err);
-      data = 'ERROR: Not a Linny-R model to auto-save';
+      data = 'ERROR: Not a Linny-R model to ' + msg;
     }
   }
   servePlainText(res, data);
@@ -1687,6 +1730,7 @@ function createWorkspace() {
       callback: path.join(SETTINGS.user_dir, 'callback'),
       data: path.join(SETTINGS.user_dir, 'data'),
       diagrams: path.join(SETTINGS.user_dir, 'diagrams'),
+      models: path.join(SETTINGS.user_dir, 'models'),
       modules: path.join(SETTINGS.user_dir, 'modules'),
       reports: path.join(SETTINGS.user_dir, 'reports'),
       solver_output: path.join(SETTINGS.user_dir, 'solver')
@@ -1715,18 +1759,18 @@ function createWorkspace() {
 
 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:',
-      '',
-      '',
-      '# Then this command to launch the Linny-R server should work:',
-      '',
-      '# 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');
+  const
+      lines = [
+        '# The first line (without the comment symbol #) should be like this:',
+        '',
+        'cd ' + WORKING_DIRECTORY,
+        '# Then this command to launch the Linny-R server should work:',
+        '',
+        '# After shut-down, check whether new version should be installed:'
+      ],
+    windows = PLATFORM.startsWith('win'),
+    sp = path.join(WORKING_DIRECTORY, 'linny-r.' + (windows ? 'bat' : 'command'));
+  if(windows) {
     lines.push(
       ':loop',
       'if exist newer_version (',
@@ -1738,7 +1782,6 @@ function createLaunchScript() {
     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.push(
       'while test -f newer_version; do',
       '    unlink newer_version',
@@ -1749,22 +1792,23 @@ function createLaunchScript() {
     lines[4] = 'node node_modules/linny-r/server launch';
   }
   try {
-    let make_script = false,
-        code = lines.join(os.EOL);
-    if(PLATFORM.startsWith('win')) code = code.replaceAll('#', '::');
+    let code = lines.join(os.EOL);
+    if(windows) 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;
+      // Do not overwrite existing script, as it may have been customized
+      // by the user. When istalling/updating Linny-R, the post-install
+      // script should have renamed it, so typically it is created the
+      // first time Linny-R is run after install/update.
     } catch(err) {
-      // ... or if it does not exist yet.
-      make_script = true;
-    }
-    if(make_script) {
       console.log('Creating launch script:', sp);
       fs.writeFileSync(sp, code, 'utf8');
+      // On macOS machines, try to make the script executable.
+      if(!windows) try {
+        fs.chmodSync(sp, '+x');
+      } catch(err) {
+        console.log('WARNING: Failed to make script executable -- please check');
+      }
     }
   } catch(err) {
     console.log('WARNING: Failed to create launch script');