v0.1.6 update

updated Java release flag from 8 to 11
updated Janino dependency from 3.1.8 to 3.1.9
added optional verbose logging to some methods
improved script deletion logic
modified css for tables

Author: cvogt729

README.md

@@ -12,7 +12,7 @@ WebCTRL is a trademark of Automated Logic Corporation. Any other trademarks ment
 
 ## About
 
-This add-on allows WebCTRL server administrators to upload and execute scripts, which are written in the Java programming language. Scripts may be compiled and packaged into *.jar* archives (recommended), or they may be interpreted at runtime using [Janino 3.1.8](http://janino-compiler.github.io/janino/) (easy for small scripts, but note that Janino has some [limitations](#janino-limitations)). The add-on does not come prepackaged with any scripts; however, sample scripts may be found within [*./samples*](./samples). Also see the [terminal unit commissioning script](https://github.com/automatic-controls/terminal-unit-script).
+This add-on allows WebCTRL server administrators to upload and execute scripts, which are written in the Java programming language. Scripts may be compiled and packaged into *.jar* archives (recommended), or they may be interpreted at runtime using [Janino 3.1.9](http://janino-compiler.github.io/janino/) (easy for small scripts, but note that Janino has some [limitations](#janino-limitations)). The add-on does not come prepackaged with any scripts; however, sample scripts may be found within [*./samples*](./samples). Also see the [terminal unit commissioning script](https://github.com/automatic-controls/terminal-unit-script).
 
 The original purpose of this add-on was to be a customizable alternative to the ACxelerate commissioning tool provided by Automated Logic. Semantic tagging is one concept borrowed from ACxelerate. Before execution, each script is paired with a mapping that associates control program microblock nodes to tag names referenced by the script. Primary script procedures are executed once on each control program specified by a mapping.
 
@@ -46,13 +46,13 @@ To prevent inadvertent schedule modification, each schedule stores a hash of the
 
 ## Script Development
 
-If a single *.java* file is uploaded as a script, then it will be interpreted using [Janino 3.1.8](http://janino-compiler.github.io/janino/) at runtime. **You do not have to configure a development environment for compiling Janino scripts.** In principle, you could develop scripts using only a text editor like *Notepad*. Another advantage of this approach is that you can easily download, edit, and re-upload script source code from any computer with a connection to the WebCTRL server.
+If a single *.java* file is uploaded as a script, then it will be interpreted using [Janino 3.1.9](http://janino-compiler.github.io/janino/) at runtime. **You do not have to configure a development environment for compiling Janino scripts.** In principle, you could develop scripts using only a text editor like *Notepad*. Another advantage of this approach is that you can easily download, edit, and re-upload script source code from any computer with a connection to the WebCTRL server.
 
 However, it is recommended that scripts are compiled and packaged into *.jar* archives. Pre-compiled scripts do not suffer from Janino's [limitations](#janino-limitations). Essentially, just throw all your *.class* files into a *.jar* archive. The only special requirement is that a manifest file exist in the *.jar*, and that the `Main-Class` header specifies which class to use as the primary script (this class should extend `aces.webctrl.scripts.commissioning.core.Script`).
 
 Be mindful to compile your script with a version of Java compatible with the target WebCTRL version of your server. For instance, you should use the build flag `--release 8` if you intend the script to run on WebCTRL7.0, and `--release 11` for WebCTRL8.0. See https://jdk.java.net/ to download the latest version of the java development kit.
 
-To ease the development process, it is suggested to use an IDE (e.g, [Visual Studio Code](https://code.visualstudio.com/)), and then add the following dependencies: [CommissioningScripts-0.1.3.jar](https://github.com/automatic-controls/commissioning-scripts/releases/download/v0.1.3-beta/CommissioningScripts-0.1.3.jar) and [CommissioningScripts-0.1.3-sources.jar](https://github.com/automatic-controls/commissioning-scripts/releases/download/v0.1.3-beta/CommissioningScripts-0.1.3-sources.jar). These dependencies will provide you with intellisense and Javadocs for script development. You are also welcome to reference any other dependencies provided by WebCTRL at runtime (e.g, the add-on API, or `javax.servlet`).
+To ease the development process, it is suggested to use an IDE (e.g, [Visual Studio Code](https://code.visualstudio.com/)), and then add the following dependencies: [CommissioningScripts-0.1.6.jar](https://github.com/automatic-controls/commissioning-scripts/releases/download/v0.1.6-beta/CommissioningScripts-0.1.6.jar) and [CommissioningScripts-0.1.6-sources.jar](https://github.com/automatic-controls/commissioning-scripts/releases/download/v0.1.6-beta/CommissioningScripts-0.1.6-sources.jar). These dependencies will provide you with intellisense and Javadocs for script development. You are also welcome to reference any other dependencies provided by WebCTRL at runtime (e.g, the add-on API, or `javax.servlet`).
 
 This add-on does not enforce any security restrictions on what scripts can do. Scripts are executed with the same privilege set as the add-on. As such, you must be careful to **use scripts at your own risk.** Note that only WebCTRL server administrators are allowed to manage scripts.
 

config/BUILD_DETAILS

@@ -1,25 +1,25 @@
 JDK Version:
-openjdk 19.0.1 2022-10-18
-OpenJDK Runtime Environment (build 19.0.1+10-21)
-OpenJDK 64-Bit Server VM (build 19.0.1+10-21, mixed mode, sharing)
+openjdk 21.0.2 2024-01-16
+OpenJDK Runtime Environment (build 21.0.2+13-58)
+OpenJDK 64-Bit Server VM (build 21.0.2+13-58, mixed mode, sharing)
 
 Compilation Flags:
---release 8
+--release 11
 
 Runtime Dependencies:
-addonsupport-api-addon-1.9.0
-alarmmanager-api-addon-1.9.0
-bacnet-api-core-1.10.002-20230209.1438r
-directaccess-api-addon-1.9.0
-tomcat-embed-core-9.0.68
-webaccess-api-addon-1.9.0
-xdatabase-api-addon-1.9.0
+addonsupport-api-addon-1.10.0
+alarmmanager-api-addon-1.10.0
+bacnet-api-core-1.10.007-20240227.1003r
+directaccess-api-addon-1.10.0
+tomcat-embed-core-9.0.87
+webaccess-api-addon-1.10.0
+xdatabase-api-addon-1.10.0
 core-api-8.0.002
 javax.activation-1.2.0
 spring-context-5.2.8.RELEASE
 
 Packaged Dependencies:
-commons-compiler-3.1.8-sources
-commons-compiler-3.1.8
-janino-3.1.8-sources
-janino-3.1.8
+commons-compiler-3.1.9-sources
+commons-compiler-3.1.9
+janino-3.1.9-sources
+janino-3.1.9

config/COMPILE_FLAGS

@@ -1 +1 @@
---release 8
+--release 11

config/EXTERNAL_DEPS

@@ -1,4 +1,4 @@
-url:janino-3.1.8.jar:https://repo1.maven.org/maven2/org/codehaus/janino/janino/3.1.8/janino-3.1.8.jar
-url:janino-3.1.8-sources.jar:https://repo1.maven.org/maven2/org/codehaus/janino/janino/3.1.8/janino-3.1.8-sources.jar
-url:commons-compiler-3.1.8.jar:https://repo1.maven.org/maven2/org/codehaus/janino/commons-compiler/3.1.8/commons-compiler-3.1.8.jar
-url:commons-compiler-3.1.8-sources.jar:https://repo1.maven.org/maven2/org/codehaus/janino/commons-compiler/3.1.8/commons-compiler-3.1.8-sources.jar
+url:janino-3.1.9.jar:https://repo1.maven.org/maven2/org/codehaus/janino/janino/3.1.9/janino-3.1.9.jar
+url:janino-3.1.9-sources.jar:https://repo1.maven.org/maven2/org/codehaus/janino/janino/3.1.9/janino-3.1.9-sources.jar
+url:commons-compiler-3.1.9.jar:https://repo1.maven.org/maven2/org/codehaus/janino/commons-compiler/3.1.9/commons-compiler-3.1.9.jar
+url:commons-compiler-3.1.9-sources.jar:https://repo1.maven.org/maven2/org/codehaus/janino/commons-compiler/3.1.9/commons-compiler-3.1.9-sources.jar

root/info.xml

@@ -1,6 +1,6 @@
 <extension version="1">
-  <name>ACES_Tech_Tool_Belt</name>
+  <name>CommissioningScripts</name>
   <description>Executes scripts concurrently on groups of equipment to evaluate performance and detect faults.</description>
-  <version>0.1.4</version>
+  <version>0.1.6</version>
   <vendor>Automatic Controls Equipment Systems, Inc.</vendor>
 </extension>

src/aces/webctrl/scripts/commissioning/core/Initializer.java

@@ -198,7 +198,7 @@ public void execute(WritableSystemAccess sys){
         t.kill();
       }
       for (Test t:tests){
-        t.waitForDeath();
+        t.waitForDeath(-1);
       }
       kill = true;
       dataQueryThread.interrupt();

src/aces/webctrl/scripts/commissioning/core/ResolvedTestingUnit.java

@@ -34,6 +34,8 @@ public class ResolvedTestingUnit {
   public volatile int tries = 3;
   /** Specifies how long to wait after failing to read or write a node value. */
   public volatile long failedAttemptTimeout = 300L;
+  /** More error messages will be logged when this is true. */
+  public volatile boolean verbose = false;
   /**
    * Constructs a resolved testing unit based on a few relevant pieces of information.
    * @param tu is the testing unit to resolve.
@@ -120,7 +122,7 @@ public boolean setValue(final String tag, final Object value) throws Interrupted
    * Sets the value of the given node.
    * @return {@code true} if the node value was set successfully; {@code false} otherwise.
    */
-  public static boolean setValue(final Node n, final Object value, final int tries, final long failedAttemptTimeout) throws InterruptedException {
+  public boolean setValue(final Node n, final Object value, final int tries, final long failedAttemptTimeout) throws InterruptedException {
     if (n==null){
       return false;
     }
@@ -142,6 +144,9 @@ public void execute(WritableSystemAccess sys){
             ret.setResult(true);
           }catch(Throwable t){
             ret.setResult(false);
+            if (verbose){
+              Initializer.log(t);
+            }
           }
         }
       });
@@ -187,6 +192,9 @@ public void execute(WritableSystemAccess sys){
             ret.setResult(val.x);
           }catch(Throwable t){
             ret.setResult(null);
+            if (verbose){
+              Initializer.log(t);
+            }
           }
         }
       });
@@ -232,7 +240,7 @@ public String getValue(String tag) throws InterruptedException {
   /**
    * @return the value of the node, or {@code null} if the value could not be retrieved.
    */
-  public static String getValue(Node n, final int tries, final long failedAttemptTimeout) throws InterruptedException {
+  public String getValue(Node n, final int tries, final long failedAttemptTimeout) throws InterruptedException {
     if (n==null){
       return null;
     }else if (n instanceof LiteralNode){
@@ -251,6 +259,9 @@ public void execute(SystemAccess sys){
             ret.setResult(n.getValue());
           }catch(Throwable t){
             ret.setResult(null);
+            if (verbose){
+              Initializer.log(t);
+            }
           }
         }
       });
@@ -269,7 +280,7 @@ public String getDisplayValue(String tag) throws InterruptedException {
   /**
    * @return the display value of the node, or {@code null} if the value could not be retrieved.
    */
-  public static String getDisplayValue(Node n, final int tries, final long failedAttemptTimeout) throws InterruptedException {
+  public String getDisplayValue(Node n, final int tries, final long failedAttemptTimeout) throws InterruptedException {
     if (n==null){
       return null;
     }else if (n instanceof LiteralNode){
@@ -288,6 +299,9 @@ public void execute(SystemAccess sys){
             ret.setResult(n.getDisplayValue());
           }catch(Throwable t){
             ret.setResult(null);
+            if (verbose){
+              Initializer.log(t);
+            }
           }
         }
       });
@@ -336,6 +350,9 @@ public void execute(WritableSystemAccess sys){
                   ret.setResult(true);
                 }catch(Throwable t){
                   ret.setResult(false);
+                  if (verbose){
+                    Initializer.log(t);
+                  }
                 }
               }
             });

src/aces/webctrl/scripts/commissioning/core/Test.java

@@ -47,14 +47,21 @@ public Test(Path scriptFile){
   @Override public int hashCode(){
     return hash;
   }
-  public void delete(){
+  public boolean delete(){
     if (reserved){
-      return;
+      return false;
     }
     try{
-      instances.remove(ID);
       kill();
-      Files.deleteIfExists(scriptFile);
+      if (!waitForDeath(5000L)){
+        return false;
+      }
+      try{
+        Files.deleteIfExists(scriptFile);
+      }catch(Throwable t){
+        return false;
+      }
+      instances.remove(ID);
       final Path scripts = Initializer.getScriptFolder();
       Iterator<ScheduledTest> iter = ScheduledTest.instances.values().iterator();
       ScheduledTest st;
@@ -68,9 +75,11 @@ public void delete(){
           Initializer.log(t);
         }
       }
+      return true;
     }catch(Throwable t){
       Initializer.log(t);
     }
+    return false;
   }
   /**
    * @return the output of the test, or {@code null} if there is no output.
@@ -163,10 +172,29 @@ public boolean isRunning(){
   }
   /**
    * Waits for this test to terminate.
+   * @param timeout in milliseconds specifies the maximum duration to wait for death. -1 means wait forever.
+   * @return whether the test died within the specified timeout
    */
-  public void waitForDeath() throws InterruptedException {
-    while (running.get()){
-      Thread.sleep(500L);
+  public boolean waitForDeath(long timeout) throws InterruptedException {
+    if (!running.get()){
+      return true;
+    }
+    if (timeout==-1){
+      while (running.get()){
+        Thread.sleep(500L);
+      }
+      return true;
+    }else{
+      final long x = System.currentTimeMillis()+timeout;
+      long d;
+      while (running.get()){
+        d = x-System.currentTimeMillis();
+        if (d<=0){
+          break;
+        }
+        Thread.sleep(Math.min(500L,d));
+      }
+      return !running.get();
     }
   }
   /**

src/aces/webctrl/scripts/commissioning/html/main.css

@@ -96,9 +96,13 @@ th {
   background-color:darkslategray;
 }
 table {
-  border-collapse:collapse;
+  border-collapse:separate;
+  border-spacing:0;
   margin:0 auto;
 }
+tr {
+  border-collapse:collapse;
+}
 thead {
   border:solid 3px white;
 }

src/aces/webctrl/scripts/commissioning/web/ScriptPage.java

@@ -57,15 +57,17 @@ public class ScriptPage extends ServletBase {
       }
       final Path script = Initializer.getScriptFolder().resolve(fileName);
       Test newTest = null;
-      for (Test te:Test.instances.values()){
-        if (Files.isSameFile(script,te.getScriptFile())){
-          if (te.reserved){
-            Initializer.log(new FileAlreadyExistsException("Cannot overwrite permanent script: "+fileName));
-            res.setStatus(400);
-            return;
+      if (Files.exists(script)){
+        for (Test te:Test.instances.values()){
+          if (Files.isSameFile(script,te.getScriptFile())){
+            if (te.reserved){
+              Initializer.log(new FileAlreadyExistsException("Cannot overwrite permanent script: "+fileName));
+              res.setStatus(400);
+              return;
+            }
+            newTest = te;
+            break;
           }
-          newTest = te;
-          break;
         }
       }
       {
@@ -215,8 +217,10 @@ public class ScriptPage extends ServletBase {
                 String err = "Cannot delete permanent script.";
                 res.sendError(400, err);
                 Initializer.log(new IllegalAccessError(err));
-              }else{
-                t.delete();
+              }else if (!t.delete()){
+                String err = "Script could not be deleted. Please try again in a few moments.";
+                res.sendError(400, err);
+                Initializer.log(new IllegalAccessError(err));
               }
               break;
             }