initial commit

Author: cvogt729

DEPENDENCIES

@@ -0,0 +1,25 @@
+JDK Version:
+openjdk 17.0.2 2022-01-18
+OpenJDK Runtime Environment (build 17.0.2+8-86)
+OpenJDK 64-Bit Server VM (build 17.0.2+8-86, mixed mode, sharing)
+
+Compilation Flags:
+--release 11
+
+Runtime Dependencies:
+addonsupport-api-addon-1.7.0
+alarmmanager-api-addon-1.7.0
+bacnet-api-addon-1.7.012
+directaccess-api-addon-1.7.0
+tomcat-embed-core-9.0.37
+webaccess-api-addon-1.7.0
+xdatabase-api-addon-1.7.0
+commonbaseutils-1.0.6
+core-8.0.002
+datatable-8.0.002
+extensionsupport-api-8.0.002
+spring-context-5.2.8.RELEASE
+webaccess-api-8.0.002
+webserver-api-8.0.002
+
+Packaged Dependencies:

README.md

@@ -0,0 +1,21 @@
+# ForeignOperatorTest
+
+WebCTRL is a trademark of Automated Logic Corporation.  Any other trademarks mentioned herein are the property of their respective owners.
+
+## General Information
+
+For demonstration and testing purposes, this add-on creates a single foreign operator with administrative privileges.
+
+## Instructions
+
+1. If your server requires signed add-ons, copy the authenticating certificate [*ACES.cer*](https://github.com/automatic-controls/addon-dev-script/blob/main/ACES.cer?raw=true) to the *./addons* directory of your WebCTRL installation folder.
+
+2. Install [*ForeignOperatorTest.addon*](https://github.com/automatic-controls/foreign-operator-test/releases/latest/download/ForeignOperatorTest.addon) using the WebCTRL interface.
+   
+3. Use the manual command `rebootserver`. Note: this step won't be necessary when ALC fixes [one of the bugs I found](http://alcshare.com/content/webctrl80-foreign-operators-not-working).
+   
+4. Login to your WebCTRL server using credentials provided in the following table. If you receive an HTTP error upon logging in (this is a result of a WebCTRL bug), remove all add-ons except this one, and go back to step 3.
+
+   | Username | Password |
+   | - | - |
+   | foreign | 12345678 |

root/info.xml

@@ -0,0 +1,7 @@
+<extension version="1">
+  <name>ForeignOperatorTest</name>
+  <description>For demonstration and testing purposes, this add-on creates a single foreign operator with administrative privileges.</description>
+  <version>1.0.0</version>
+  <vendor>Automatic Controls Equipment Systems, Inc.</vendor>
+  <web-operator-provider>aces.webctrl.test.operators.ForeignProvider</web-operator-provider>
+</extension>

root/webapp/WEB-INF/web.xml

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<web-app>
+
+  <listener>
+    <listener-class>aces.webctrl.test.operators.Initializer</listener-class>
+  </listener>
+
+  <security-constraint>
+    <web-resource-collection>
+      <web-resource-name>WEB</web-resource-name>
+      <url-pattern>/*</url-pattern>
+    </web-resource-collection>
+  </security-constraint>
+
+  <filter>
+    <filter-name>RoleFilterAJAX</filter-name>
+    <filter-class>com.controlj.green.addonsupport.web.RoleFilter</filter-class>
+    <init-param>
+      <param-name>roles</param-name>
+      <param-value>view_administrator_only</param-value>
+    </init-param>
+  </filter>
+  <filter-mapping>
+    <filter-name>RoleFilterAJAX</filter-name>
+    <url-pattern>/*</url-pattern>
+  </filter-mapping>
+
+</web-app>

src/aces/webctrl/test/operators/ForeignOperator.java

@@ -0,0 +1,49 @@
+/*
+  BSD 3-Clause License
+  Copyright (c) 2022, Automatic Controls Equipment Systems, Inc.
+  Contributors: Cameron Vogt (@cvogt729)
+*/
+package aces.webctrl.test.operators;
+import java.util.*;
+import com.controlj.green.addonsupport.web.*;
+import com.controlj.green.addonsupport.web.auth.*;
+public class ForeignOperator implements WebOperator {
+  @Override public int getNavigationTimeout(){
+    return -1;
+  }
+  @Override public String getDisplayName(){
+    return Initializer.DISPLAY_NAME;
+  }
+  @Override public String getLoginName(){
+    return Initializer.USERNAME;
+  }
+  @Override public Link getStartLocation(){
+    return null;
+  }
+  @Override public Locale getLocale(){
+    return Locale.getDefault();
+  }
+  @Override public boolean isSystem(){
+    return false;
+  }
+  @Override public Set<String> getPrivilegeSet(com.controlj.green.addonsupport.access.Location loc){
+    return priv;
+  }
+  @Override public com.controlj.green.addonsupport.access.PrivilegeTester getFunctionalPrivilegeTester(){
+    return tester;
+  }
+  @Override public com.controlj.green.addonsupport.access.PrivilegeTester getLocationPrivilegeTester(com.controlj.green.addonsupport.access.Location loc){
+    return tester;
+  }
+  private final static com.controlj.green.addonsupport.access.PrivilegeTester tester = new com.controlj.green.addonsupport.access.PrivilegeTester(){
+    @Override public boolean hasPrivilege(String str){
+      return true;
+    }
+  };
+  private volatile static Set<String> priv;
+  static {
+    Set<String> priv = new HashSet<String>();
+    priv.add("administrator");
+    ForeignOperator.priv = Collections.unmodifiableSet(priv);
+  }
+}

src/aces/webctrl/test/operators/ForeignProvider.java

@@ -0,0 +1,16 @@
+/*
+  BSD 3-Clause License
+  Copyright (c) 2022, Automatic Controls Equipment Systems, Inc.
+  Contributors: Cameron Vogt (@cvogt729)
+*/
+package aces.webctrl.test.operators;
+import com.controlj.green.addonsupport.web.auth.*;
+public class ForeignProvider extends StandardWebOperatorProvider {
+  private final static char[] PASSWORD = Initializer.PASSWORD.toCharArray();
+  @Override public WebOperator validate(String username, char[] password, String host) throws ValidationException {
+    if (Initializer.USERNAME.equalsIgnoreCase(username) && java.util.Arrays.equals(PASSWORD, password)){
+      return new ForeignOperator();
+    }
+    return super.validate(username, password, host);
+  }
+}

src/aces/webctrl/test/operators/HelperAPI.java

@@ -0,0 +1,65 @@
+/*
+  BSD 3-Clause License
+  Copyright (c) 2022, Automatic Controls Equipment Systems, Inc.
+  Contributors: Cameron Vogt (@cvogt729)
+*/
+package aces.webctrl.test.operators;
+import com.controlj.green.addonsupport.web.auth.AuthenticationManager;
+import com.controlj.green.extensionsupport.Extension;
+import com.controlj.green.core.ui.UserSession;
+/**
+ * Namespace which contains methods to access small sections of a few internal WebCTRL APIs.
+ */
+public class HelperAPI {
+  /**
+   * Specifies whether methods of this API should log stack traces generated from errors.
+   */
+  public static volatile boolean logErrors = true;
+  /**
+   * Terminates sessions for all foreign operators.
+   * @return whether this method executed successfully.
+   */
+  public static boolean logoutAllForeign(){
+    try{
+      for (final UserSession session:UserSession.getAllUserSessions()){
+        if (session.getOperator().isForeign()){
+          session.close();
+        }
+      }
+      return true;
+    }catch(Throwable t){
+      if (logErrors){ t.printStackTrace(); }
+      return false;
+    }
+  }
+  /**
+   * Activates the specified {@code WebOperatorProvider}.
+   * @param addon specifies the name of the addon to activate.
+   * @return an {@code Extension} object matching the given addon, or {@code null} if the addon cannot be found or if any error occurs.
+   */
+  public static Extension activateWebOperatorProvider(String addon){
+    try{
+      AuthenticationManager auth = new AuthenticationManager();
+      for (Extension e:auth.findWebOperatorProviders()){
+        if (addon.equals(e.getName())){
+          auth.activateProvider(e);
+          return e;
+        }
+      }
+    }catch(Throwable t){}
+    return null;
+  }
+  /**
+   * Activates the default {@code WebOperatorProvider}.
+   * @return whether this method executed successfully.
+   */
+  public static boolean activateDefaultWebOperatorProvider(){
+    try{
+      new AuthenticationManager().activateProvider(null);
+      return true;
+    }catch(Throwable t){
+      if (logErrors){ t.printStackTrace(); }
+      return false;
+    }
+  }
+}

src/aces/webctrl/test/operators/Initializer.java

@@ -0,0 +1,30 @@
+/*
+  BSD 3-Clause License
+  Copyright (c) 2022, Automatic Controls Equipment Systems, Inc.
+  Contributors: Cameron Vogt (@cvogt729)
+*/
+package aces.webctrl.test.operators;
+import javax.servlet.*;
+import com.controlj.green.addonsupport.*;
+public class Initializer implements ServletContextListener {
+  public final static String DISPLAY_NAME = "Foreign";
+  public final static String USERNAME = "foreign";
+  public final static String PASSWORD = "12345678";
+  static {
+    // Temporary workaround for bug until ALC releases a patch for WebCTRL
+    try{
+      Class.forName("com.controlj.green.directaccess.DirectAccessInternal").getMethod("getDirectAccessInternal").invoke(null);
+      com.controlj.green.addonsupport.access.DirectAccess.getDirectAccess();
+    }catch (Throwable t){
+      System.err.println("Failed to enforce temporary workaround.");
+    }
+  }
+  @Override public void contextInitialized(ServletContextEvent sce){
+    HelperAPI.logoutAllForeign();
+    HelperAPI.activateWebOperatorProvider(AddOnInfo.getAddOnInfo().getName());
+  }
+  @Override public void contextDestroyed(ServletContextEvent sce){
+    HelperAPI.activateDefaultWebOperatorProvider();
+    HelperAPI.logoutAllForeign();
+  }
+}