From b94b33ecf11b9e31cb09e7abef9e79e5a5742105 Mon Sep 17 00:00:00 2001
From: Ziver Koc <ziver@koc.se>
Date: Mon, 6 Sep 2021 16:05:32 +0200
Subject: [PATCH] Possibly fixed multiple listener addition

---
 hal-core/src/se/hal/intf/HalAbstractController.java       | 1 +
 .../src/se/hal/intf/HalAbstractControllerManager.java     | 8 +++++---
 .../src/se/hal/plugin/dummy/DummyController.java          | 3 ++-
 .../src/se/hal/plugin/mqtt/HalMqttController.java         | 3 ++-
 .../src/se/hal/plugin/netscan/NetScanController.java      | 3 ++-
 .../src/se/hal/plugin/nutups/NutUpsController.java        | 3 ++-
 .../src/se/hal/plugin/nvr/rtsp/RTSPController.java        | 3 ++-
 .../src/se/hal/plugin/raspberry/RPiController.java        | 3 ++-
 .../src/se/hal/plugin/tellstick/TellstickSerialComm.java  | 3 ++-
 .../src/se/hal/plugin/zigbee/ZigbeeController.java        | 3 ++-
 .../src/se/hal/plugin/zwave/HalZWaveController.java       | 3 ++-
 11 files changed, 24 insertions(+), 12 deletions(-)

diff --git a/hal-core/src/se/hal/intf/HalAbstractController.java b/hal-core/src/se/hal/intf/HalAbstractController.java
index 2457d751..dc8e99c5 100644
--- a/hal-core/src/se/hal/intf/HalAbstractController.java
+++ b/hal-core/src/se/hal/intf/HalAbstractController.java
@@ -60,6 +60,7 @@ public interface HalAbstractController {
 
     /**
      * Add a listener to the controller that will receive all device reports from registered devices.
+     * Multiple calls with the same listener should only add register the listener once any subsequent calls should be ignored.
      */
     void addListener(HalDeviceReportListener listener);
 
diff --git a/hal-core/src/se/hal/intf/HalAbstractControllerManager.java b/hal-core/src/se/hal/intf/HalAbstractControllerManager.java
index 48c49ad4..34076a54 100644
--- a/hal-core/src/se/hal/intf/HalAbstractControllerManager.java
+++ b/hal-core/src/se/hal/intf/HalAbstractControllerManager.java
@@ -135,7 +135,7 @@ public abstract class HalAbstractControllerManager<T extends HalAbstractControll
 
     /**
      * Will return a singleton controller instance of the given class.
-     * If a instance does not exist yet the a new instance will be allocated
+     * If a instance does not exist yet then a new instance will be allocated
      * depending on if the controller is ready thorough the {@link HalAbstractController#isAvailable()} method.
      *
      * @param clazz     is the class of the wanted object instance wanted
@@ -167,8 +167,10 @@ public abstract class HalAbstractControllerManager<T extends HalAbstractControll
             }
         }
 
-        // Assign the manager as a listener
-
+        // Assign the manager as a listener, This needs to be done every time as the controllerMap is a
+        // shared static for all HalControllerManagers and as we do not know if the current manager is
+        // added as listener or not we need to add it and let the implementation of addListener method
+        // handle duplicate calls.
         if (this instanceof HalDeviceReportListener)
             controller.addListener((HalDeviceReportListener) this);
 
diff --git a/plugins/hal-dummy/src/se/hal/plugin/dummy/DummyController.java b/plugins/hal-dummy/src/se/hal/plugin/dummy/DummyController.java
index 9ae5a953..c8c9c426 100644
--- a/plugins/hal-dummy/src/se/hal/plugin/dummy/DummyController.java
+++ b/plugins/hal-dummy/src/se/hal/plugin/dummy/DummyController.java
@@ -68,7 +68,8 @@ public class DummyController implements HalSensorController, HalEventController,
 
     @Override
     public void addListener(HalDeviceReportListener listener) {
-        deviceListeners.add(listener);
+        if (!deviceListeners.contains(listener))
+            deviceListeners.add(listener);
     }
 
     @Override
diff --git a/plugins/hal-mqtt/src/se/hal/plugin/mqtt/HalMqttController.java b/plugins/hal-mqtt/src/se/hal/plugin/mqtt/HalMqttController.java
index dabdae2c..f42a018c 100644
--- a/plugins/hal-mqtt/src/se/hal/plugin/mqtt/HalMqttController.java
+++ b/plugins/hal-mqtt/src/se/hal/plugin/mqtt/HalMqttController.java
@@ -154,6 +154,7 @@ public class HalMqttController implements HalAutostartController, MqttSubscripti
 
     @Override
     public void addListener(HalDeviceReportListener listener) {
-        deviceListeners.add(listener);
+        if (!deviceListeners.contains(listener))
+            deviceListeners.add(listener);
     }
 }
diff --git a/plugins/hal-netscan/src/se/hal/plugin/netscan/NetScanController.java b/plugins/hal-netscan/src/se/hal/plugin/netscan/NetScanController.java
index a59410e9..81babaeb 100644
--- a/plugins/hal-netscan/src/se/hal/plugin/netscan/NetScanController.java
+++ b/plugins/hal-netscan/src/se/hal/plugin/netscan/NetScanController.java
@@ -125,7 +125,8 @@ public class NetScanController implements HalEventController, HalAutostartContro
 
     @Override
     public void addListener(HalDeviceReportListener listener) {
-        deviceListeners.add(listener);
+        if (!deviceListeners.contains(listener))
+            deviceListeners.add(listener);
     }
 
 
diff --git a/plugins/hal-nutups/src/se/hal/plugin/nutups/NutUpsController.java b/plugins/hal-nutups/src/se/hal/plugin/nutups/NutUpsController.java
index 52bf723a..cfb4d04a 100644
--- a/plugins/hal-nutups/src/se/hal/plugin/nutups/NutUpsController.java
+++ b/plugins/hal-nutups/src/se/hal/plugin/nutups/NutUpsController.java
@@ -101,7 +101,8 @@ public class NutUpsController implements HalSensorController, HalAutostartContro
 
     @Override
     public void addListener(HalDeviceReportListener listener) {
-        deviceListeners.add(listener);
+        if (!deviceListeners.contains(listener))
+            deviceListeners.add(listener);
     }
 
 
diff --git a/plugins/hal-nvr/src/se/hal/plugin/nvr/rtsp/RTSPController.java b/plugins/hal-nvr/src/se/hal/plugin/nvr/rtsp/RTSPController.java
index 01787a01..61e6ac39 100644
--- a/plugins/hal-nvr/src/se/hal/plugin/nvr/rtsp/RTSPController.java
+++ b/plugins/hal-nvr/src/se/hal/plugin/nvr/rtsp/RTSPController.java
@@ -83,7 +83,8 @@ public class RTSPController implements HalCameraController {
 
     @Override
     public void addListener(HalDeviceReportListener listener) {
-        deviceListeners.add(listener);
+        if (!deviceListeners.contains(listener))
+            deviceListeners.add(listener);
     }
 
 }
diff --git a/plugins/hal-raspberry/src/se/hal/plugin/raspberry/RPiController.java b/plugins/hal-raspberry/src/se/hal/plugin/raspberry/RPiController.java
index 21771f48..2bae2169 100644
--- a/plugins/hal-raspberry/src/se/hal/plugin/raspberry/RPiController.java
+++ b/plugins/hal-raspberry/src/se/hal/plugin/raspberry/RPiController.java
@@ -77,7 +77,8 @@ public class RPiController implements HalSensorController {
 
     @Override
     public void addListener(HalDeviceReportListener listener) {
-        deviceListeners.add(listener);
+        if (!deviceListeners.contains(listener))
+            deviceListeners.add(listener);
     }
 
     @Override
diff --git a/plugins/hal-tellstick/src/se/hal/plugin/tellstick/TellstickSerialComm.java b/plugins/hal-tellstick/src/se/hal/plugin/tellstick/TellstickSerialComm.java
index 62223157..1450c78e 100644
--- a/plugins/hal-tellstick/src/se/hal/plugin/tellstick/TellstickSerialComm.java
+++ b/plugins/hal-tellstick/src/se/hal/plugin/tellstick/TellstickSerialComm.java
@@ -252,7 +252,8 @@ public class TellstickSerialComm implements Runnable,
 
     @Override
     public void addListener(HalDeviceReportListener listener) {
-        deviceListeners.add(listener);
+        if (!deviceListeners.contains(listener))
+            deviceListeners.add(listener);
     }
 
 
diff --git a/plugins/hal-zigbee/src/se/hal/plugin/zigbee/ZigbeeController.java b/plugins/hal-zigbee/src/se/hal/plugin/zigbee/ZigbeeController.java
index 3b689516..6c52d4ee 100644
--- a/plugins/hal-zigbee/src/se/hal/plugin/zigbee/ZigbeeController.java
+++ b/plugins/hal-zigbee/src/se/hal/plugin/zigbee/ZigbeeController.java
@@ -386,7 +386,8 @@ public class ZigbeeController implements HalSensorController,
 
     @Override
     public void addListener(HalDeviceReportListener listener) {
-        deviceListeners.add(listener);
+        if (!deviceListeners.contains(listener))
+            deviceListeners.add(listener);
     }
 
     @Override
diff --git a/plugins/hal-zwave/src/se/hal/plugin/zwave/HalZWaveController.java b/plugins/hal-zwave/src/se/hal/plugin/zwave/HalZWaveController.java
index 20629919..99384ca9 100644
--- a/plugins/hal-zwave/src/se/hal/plugin/zwave/HalZWaveController.java
+++ b/plugins/hal-zwave/src/se/hal/plugin/zwave/HalZWaveController.java
@@ -321,7 +321,8 @@ public class HalZWaveController implements HalSensorController, HalEventControll
 
     @Override
     public void addListener(HalDeviceReportListener listener) {
-        deviceListeners.add(listener);
+        if (!deviceListeners.contains(listener))
+            deviceListeners.add(listener);
     }
 
 }