Merge pull request #270 from dlamkins/bug/262-fix-hook-handler-concur…

…rency Added proper locks when enumerating this.Handlers.
blish-hud · Jun 30, 2020 · 1cbb26a · 1cbb26a
2 parents 9de18dc + edce787
commit 1cbb26a
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 19 deletions.
diff --git a/Blish HUD/GameServices/Input/DebugHelperInputHookManager.cs b/Blish HUD/GameServices/Input/DebugHelperInputHookManager.cs
@@ -11,18 +11,15 @@ internal abstract class DebugHelperInputHookManager<THandlerDelegate, TEventMess
 
         private bool isEnabled = false;
 
-
         public DebugHelperInputHookManager(IMessageService debugHelperMessageService) {
             this.DebugHelperMessageService = debugHelperMessageService;
             debugHelperMessageService.Register<TEventMessage>(DummyHookCallback);
         }
 
-
-        protected IList<THandlerDelegate> Handlers { get; } = new List<THandlerDelegate>();
+        protected IList<THandlerDelegate> Handlers { get; } = new SynchronizedCollection<THandlerDelegate>();
 
         protected IMessageService DebugHelperMessageService { get; }
 
-
         public virtual bool EnableHook() {
             if (isEnabled) return false;
 

diff --git a/Blish HUD/GameServices/Input/Keyboard/DebugHelperKeyboardHookManager.cs b/Blish HUD/GameServices/Input/Keyboard/DebugHelperKeyboardHookManager.cs
@@ -1,4 +1,5 @@
-using Blish_HUD.DebugHelperLib.Models;
+using System.Collections;
+using Blish_HUD.DebugHelperLib.Models;
 using Blish_HUD.DebugHelperLib.Services;
 using Microsoft.Xna.Framework.Input;
 
@@ -14,9 +15,11 @@ protected override void HookCallback(KeyboardEventMessage message) {
             KeyboardEventArgs keyboardEventArgs = new KeyboardEventArgs((KeyboardEventType)message.EventType, (Keys)message.Key);
             bool              isHandled         = false;
 
-            foreach (HandleKeyboardInputDelegate handler in this.Handlers) {
-                isHandled = handler(keyboardEventArgs);
-                if (isHandled) break;
+            lock (((IList) this.Handlers).SyncRoot) {
+                foreach (HandleKeyboardInputDelegate handler in this.Handlers) {
+                    isHandled = handler(keyboardEventArgs);
+                    if (isHandled) break;
+                }
             }
 
             KeyboardResponseMessage response = new KeyboardResponseMessage {

diff --git a/Blish HUD/GameServices/Input/Keyboard/WinApiKeyboardHookManager.cs b/Blish HUD/GameServices/Input/Keyboard/WinApiKeyboardHookManager.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Collections;
 using System.Runtime.InteropServices;
 using Blish_HUD.Input.WinApi;
 using Microsoft.Xna.Framework.Input;
@@ -18,9 +19,11 @@ protected override int HookCallback(int nCode, IntPtr wParam, IntPtr lParam) {
             KeyboardEventArgs KeyboardEventArgs = new KeyboardEventArgs(eventType, key);
             bool              isHandled         = false;
 
-            foreach (HandleKeyboardInputDelegate handler in this.Handlers) {
-                isHandled = handler(KeyboardEventArgs);
-                if (isHandled) break;
+            lock (((IList) this.Handlers).SyncRoot) {
+                foreach (HandleKeyboardInputDelegate handler in this.Handlers) {
+                    isHandled = handler(KeyboardEventArgs);
+                    if (isHandled) break;
+                }
             }
 
             if (isHandled)

diff --git a/Blish HUD/GameServices/Input/Mouse/DebugHelperMouseHookManager.cs b/Blish HUD/GameServices/Input/Mouse/DebugHelperMouseHookManager.cs
@@ -1,4 +1,5 @@
-using Blish_HUD.DebugHelperLib.Models;
+using System.Collections;
+using Blish_HUD.DebugHelperLib.Models;
 using Blish_HUD.DebugHelperLib.Services;
 
 namespace Blish_HUD.Input {
@@ -15,9 +16,11 @@ protected override void HookCallback(MouseEventMessage message) {
 
             bool isHandled = false;
 
-            foreach (HandleMouseInputDelegate handler in this.Handlers) {
-                isHandled = handler(mouseEventArgs);
-                if (isHandled) break;
+            lock (((IList) this.Handlers).SyncRoot) {
+                foreach (HandleMouseInputDelegate handler in this.Handlers) {
+                    isHandled = handler(mouseEventArgs);
+                    if (isHandled) break;
+                }
             }
 
             MouseResponseMessage response = new MouseResponseMessage {

diff --git a/Blish HUD/GameServices/Input/Mouse/WinApiMouseHookManager.cs b/Blish HUD/GameServices/Input/Mouse/WinApiMouseHookManager.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Collections;
 using System.Runtime.InteropServices;
 using Blish_HUD.Input.WinApi;
 
@@ -14,9 +15,11 @@ protected override int HookCallback(int nCode, IntPtr wParam, IntPtr lParam) {
             MouseEventArgs mouseEventArgs = new MouseEventArgs((MouseEventType)wParam, Marshal.PtrToStructure<MouseLLHookStruct>(lParam));
             bool           isHandled      = false;
 
-            foreach (HandleMouseInputDelegate handler in this.Handlers) {
-                isHandled = handler(mouseEventArgs);
-                if (isHandled) break;
+            lock (((IList) this.Handlers).SyncRoot) {
+                foreach (HandleMouseInputDelegate handler in this.Handlers) {
+                    isHandled = handler(mouseEventArgs);
+                    if (isHandled) break;
+                }
             }
 
             if (isHandled)

diff --git a/Blish HUD/GameServices/Input/WinApiInputHookManager.cs b/Blish HUD/GameServices/Input/WinApiInputHookManager.cs
@@ -17,7 +17,7 @@ internal abstract class WinApiInputHookManager<THandlerDelegate> {
 
         protected abstract HookType HookType { get; }
 
-        protected IList<THandlerDelegate> Handlers { get; } = new List<THandlerDelegate>();
+        protected IList<THandlerDelegate> Handlers { get; } = new SynchronizedCollection<THandlerDelegate>();
 
 
         public virtual bool EnableHook() {