Issue: #57

Added another any event that captures any inter-plugin event.

Added it to the RegressionTestPlugin so these events show up in the logs.

Chaskis/ChaskisCore/Chaskis.Core.csproj

@@ -24,6 +24,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <Folder Include="Handlers\AnyInterPluginEvent\" />
     <Folder Include="Handlers\SendKick\" />
     <Folder Include="Handlers\SendPart\" />
   </ItemGroup>

Chaskis/ChaskisCore/Handlers/AnyChaskisEvent/AnyChaskisEventHandler.cs

@@ -24,7 +24,7 @@ public sealed class AnyChaskisEventHandler : IIrcHandler
 
         private readonly AnyChaskisEventHandlerConfig config;
 
-        private static readonly Regex chaskisEventRegex = new Regex(
+        internal static readonly Regex Regex = new Regex(
             @"^<chaskis_",
             RegexOptions.Compiled | RegexOptions.ExplicitCapture
         );
@@ -43,14 +43,6 @@ public AnyChaskisEventHandler( AnyChaskisEventHandlerConfig allConfig )
 
         // ---------------- Properties ----------------
 
-        /// <summary>
-        /// The action to take when ANY message appears from IRC (JOIN, PART, PRIVMSG, PING, etc).
-        /// As far as the passed in IrcResponse to the action goes, the channel and remote user
-        /// will be String.Empty, since this class does no parsing of the IRC message.
-        /// It just grabs the line from the IRC channel and passes it into the AllAction
-        /// with no parsing.  It is up to the AllAction to parse the channel and user
-        /// name if they so desire.
-        /// </summary>
         public AnyChaskisEventHandlerAction LineAction
         {
             get
@@ -85,7 +77,7 @@ public void HandleEvent( HandlerArgs args )
         {
             ArgumentChecker.IsNotNull( args, nameof( args ) );
 
-            if( chaskisEventRegex.IsMatch( args.Line ) == false )
+            if( Regex.IsMatch( args.Line ) == false )
             {
                 return;
             }

Chaskis/ChaskisCore/Handlers/AnyChaskisEvent/AnyChaskisEventHandlerArgs.cs

@@ -28,7 +28,7 @@ public AnyChaskisEventHandlerArgs( IIrcWriter writer, string line )
         public IIrcWriter Writer { get; private set; }
 
         /// <summary>
-        /// The raw line that was read from the server.
+        /// The raw line that was received.
         /// </summary>
         public string Line { get; private set; }
     }

Chaskis/ChaskisCore/Handlers/AnyChaskisEvent/AnyChaskisEventHandlerConfig.cs

@@ -24,7 +24,7 @@ public AnyChaskisEventHandlerConfig()
         // ---------------- Properties ----------------
 
         /// <summary>
-        /// The action to take when ANY chaskis event.  It is up to this action to
+        /// The action to take when ANY chaskis event occurs.  It is up to this action to
         /// actually parse the string.
         /// </summary>
         public AnyChaskisEventHandlerAction LineAction { get; set; }

Chaskis/ChaskisCore/Handlers/AnyInterPluginEvent/AnyInterPluginEventHandler.cs

@@ -0,0 +1,89 @@
+//
+//          Copyright Seth Hendrick 2016-2020.
+// Distributed under the Boost Software License, Version 1.0.
+//    (See accompanying file LICENSE_1_0.txt or copy at
+//          http://www.boost.org/LICENSE_1_0.txt)
+//
+
+using System.Text.RegularExpressions;
+using SethCS.Exceptions;
+
+namespace Chaskis.Core
+{
+    public delegate void AnyInterPluginEventHandlerAction( AnyInterPluginEventHandlerArgs args );
+
+    /// <summary>
+    /// This class will fire for ALL inter-plugin events that are triggered.
+    /// 
+    /// Note, this should really only be used when you want to get ALL output
+    /// from the inter-plugin event without any filtering.  Really only meant to be used for debugging.
+    /// </summary>
+    public sealed class AnyInterPluginEventHandler : IIrcHandler
+    {
+        // ---------------- Fields ----------------
+
+        private readonly AnyInterPluginEventHandlerConfig config;
+
+        private static readonly Regex chaskisEventRegex = new Regex(
+            $@"^\<{InterPluginEventExtensions.XmlRootName}.+",
+            RegexOptions.Compiled | RegexOptions.ExplicitCapture
+        );
+
+        // ---------------- Constructor ----------------
+
+        public AnyInterPluginEventHandler( AnyInterPluginEventHandlerConfig allConfig )
+        {
+            ArgumentChecker.IsNotNull( allConfig, nameof( allConfig ) );
+
+            allConfig.Validate();
+
+            this.config = allConfig.Clone();
+            this.KeepHandling = true;
+        }
+
+        // ---------------- Properties ----------------
+
+        public AnyInterPluginEventHandlerAction LineAction
+        {
+            get
+            {
+                return this.config.LineAction;
+            }
+        }
+
+        /// <summary>
+        /// Whether or not the handler should keep handling or not.
+        /// Set to true to keep handling the event when it appears in the chat.
+        /// Set to false so when the current IRC message is finished processing being,
+        /// it leaves the event queue and never
+        /// happens again.   Useful for events that only need to happen once.
+        ///
+        /// This is a public get/set.  Either classes outside of the handler can
+        /// tell the handler to cancel the event, or it can cancel itself.
+        ///
+        /// Note: when this is set to false, there must be one more IRC message that appears
+        /// before it is removed from the queue.
+        ///
+        /// Defaulted to true.
+        /// </summary>
+        public bool KeepHandling { get; set; }
+
+        // ---------------- Functions ----------------
+
+        /// <summary>
+        /// Handles the event.
+        /// </summary>
+        public void HandleEvent( HandlerArgs args )
+        {
+            ArgumentChecker.IsNotNull( args, nameof( args ) );
+
+            if( chaskisEventRegex.IsMatch( args.Line ) == false )
+            {
+                return;
+            }
+
+            AnyInterPluginEventHandlerArgs allArgs = new AnyInterPluginEventHandlerArgs( args.IrcWriter, args.Line );
+            this.LineAction( allArgs );
+        }
+    }
+}

Chaskis/ChaskisCore/Handlers/AnyInterPluginEvent/AnyInterPluginEventHandlerArgs.cs

@@ -0,0 +1,35 @@
+//
+//          Copyright Seth Hendrick 2020.
+// Distributed under the Boost Software License, Version 1.0.
+//    (See accompanying file LICENSE_1_0.txt or copy at
+//          http://www.boost.org/LICENSE_1_0.txt)
+//
+
+namespace Chaskis.Core
+{
+    /// <summary>
+    /// Arguments that are passed in when <see cref="AnyInterPluginEventHandler"/> is triggered.
+    /// </summary>
+    public class AnyInterPluginEventHandlerArgs
+    {
+        // ---------------- Constructor ----------------
+
+        public AnyInterPluginEventHandlerArgs( IIrcWriter writer, string line )
+        {
+            this.Writer = writer;
+            this.Line = line;
+        }
+
+        // ---------------- Properties ----------------
+
+        /// <summary>
+        /// The Writer to use so we can respond to the event.
+        /// </summary>
+        public IIrcWriter Writer { get; private set; }
+
+        /// <summary>
+        /// The raw line that was received.
+        /// </summary>
+        public string Line { get; private set; }
+    }
+}

Chaskis/ChaskisCore/Handlers/AnyInterPluginEvent/AnyInterPluginEventHandlerConfig.cs

@@ -0,0 +1,57 @@
+//
+//          Copyright Seth Hendrick 2020.
+// Distributed under the Boost Software License, Version 1.0.
+//    (See accompanying file LICENSE_1_0.txt or copy at
+//          http://www.boost.org/LICENSE_1_0.txt)
+//
+
+using System.Text;
+using SethCS.Exceptions;
+
+namespace Chaskis.Core
+{
+    /// <summary>
+    /// Configuration used for <see cref="AnyInterPluginEventHandler"/>
+    /// </summary>
+    public class AnyInterPluginEventHandlerConfig
+    {
+        // ---------------- Constructor ----------------
+
+        public AnyInterPluginEventHandlerConfig()
+        {
+        }
+
+        // ---------------- Properties ----------------
+
+        /// <summary>
+        /// The action to take for ANY inter-plugin event.  It is up to this action to
+        /// actually parse the string.
+        /// </summary>
+        public AnyInterPluginEventHandlerAction LineAction { get; set; }
+
+        // ---------------- Functions ----------------
+
+        public void Validate()
+        {
+            bool success = true;
+            StringBuilder errorString = new StringBuilder();
+            errorString.AppendLine( "Errors when validating " + nameof( AnyInterPluginEventHandlerConfig ) );
+
+            if( this.LineAction == null )
+            {
+                success = false;
+                errorString.AppendLine( "\t- " + nameof( this.LineAction ) + " can not be null" );
+            }
+
+            if( success == false )
+            {
+                throw new ValidationException( errorString.ToString() );
+            }
+        }
+
+        public AnyInterPluginEventHandlerConfig Clone()
+        {
+            return (AnyInterPluginEventHandlerConfig)this.MemberwiseClone();
+        }
+    }
+}

Chaskis/ChaskisCore/Handlers/InterPluginEventHandler.cs

@@ -25,7 +25,7 @@ public class InterPluginEventHandler : IIrcHandler
 
         private static string interPluginHelper = $@"^\<{InterPluginEventExtensions.XmlRootName}.+\</{InterPluginEventExtensions.XmlRootName}\>$";
 
-        private static readonly Regex chaskisRegex = new Regex(
+        internal static readonly Regex Regex = new Regex(
             interPluginHelper,
             RegexOptions.Compiled | RegexOptions.ExplicitCapture
         );
@@ -91,7 +91,7 @@ Action<ChaskisEventHandlerLineActionArgs> lineAction
         /// </summary>
         public void HandleEvent( HandlerArgs args )
         {
-            if( chaskisRegex.IsMatch( args.Line ) == false )
+            if( Regex.IsMatch( args.Line ) == false )
             {
                 return;
             }

Chaskis/ChaskisCore/Handlers/Receive/ReceiveHandler.cs

@@ -27,11 +27,6 @@ public sealed class ReceiveHandler : IIrcHandler
 
         private readonly ReceiveHandlerConfig config;
 
-        private static readonly Regex chaskisEventRegex = new Regex(
-            @"^<chaskis_",
-            RegexOptions.Compiled | RegexOptions.ExplicitCapture
-        );
-
         // ---------------- Constructor ----------------
 
         public ReceiveHandler( ReceiveHandlerConfig allConfig )
@@ -88,9 +83,13 @@ public void HandleEvent( HandlerArgs args )
         {
             ArgumentChecker.IsNotNull( args, nameof( args ) );
 
-            // Do not handle Chaskis Events.  This handler is only
+            // Do not handle Chaskis Events or inter-plugin events.  This handler is only
             // for receiving messages via IRC.
-            if( chaskisEventRegex.IsMatch( args.Line ) )
+            if( AnyChaskisEventHandler.Regex.IsMatch( args.Line ) )
+            {
+                return;
+            }
+            else if( InterPluginEventHandler.Regex.IsMatch( args.Line ) )
             {
                 return;
             }

Chaskis/RegressionTests/RegressionTestPlugin/RegressionTestPlugin.cs

@@ -109,6 +109,15 @@ public void Init( PluginInitor pluginInit )
                 this.handlers.Add( handler );
             }
 
+            {
+                AnyInterPluginEventHandlerConfig interPluginConfig = new AnyInterPluginEventHandlerConfig
+                {
+                    LineAction = PrintInterPluginEvent
+                };
+                AnyInterPluginEventHandler handler = new AnyInterPluginEventHandler( interPluginConfig );
+                this.handlers.Add( handler );
+            }
+
             {
                 MessageHandlerConfig msgConfig = new MessageHandlerConfig
                 {
@@ -270,5 +279,10 @@ private void PrintChaskisEvent( AnyChaskisEventHandlerArgs args )
         {
             Console.WriteLine( args.Line );
         }
+
+        private void PrintInterPluginEvent( AnyInterPluginEventHandlerArgs args )
+        {
+            Console.WriteLine( args.Line );
+        }
     }
 }

Chaskis/UnitTests/CoreTests/Handlers/AnyChaskisEvent/AnyChaskisEventHandlerTest.cs

@@ -11,6 +11,7 @@
 using Moq;
 using NUnit.Framework;
 using SethCS.Exceptions;
+using System.Collections.Generic;
 
 namespace Chaskis.UnitTests.CoreTests.Handlers.AnyChaskisEvent
 {
@@ -196,6 +197,30 @@ public void SendJoinAppears()
             this.CheckResponse( eventString );
         }
 
+        [Test]
+        public void SendInterPluginEvent()
+        {
+            var args = new Dictionary<string, string>
+            {
+                ["arq1"] = "1"
+            };
+
+            var passArgs = new Dictionary<string, string>
+            {
+                ["pass1"] = "2"
+            };
+
+            Core.InterPluginEvent e = new Core.InterPluginEvent(
+                "plugin1",
+                "plugin2",
+                args,
+                passArgs
+            );
+
+            this.uut.HandleEvent( this.ConstructArgs( e.ToXml() ) );
+            Assert.IsNull( this.responseReceived );
+        }
+
         // -------- Test Helpers --------
 
         /// <summary>

Chaskis/UnitTests/CoreTests/Handlers/AnyInterPluginEvent/AnyInterPluginEventHandlerArgsTests.cs

@@ -0,0 +1,37 @@
+//
+//          Copyright Seth Hendrick 2020.
+// Distributed under the Boost Software License, Version 1.0.
+//    (See accompanying file LICENSE_1_0.txt or copy at
+//          http://www.boost.org/LICENSE_1_0.txt)
+//
+
+using Chaskis.Core;
+using Moq;
+using NUnit.Framework;
+
+namespace Chaskis.UnitTests.CoreTests.Handlers.AnyInterPluginEvent
+{
+    [TestFixture]
+    public class AnyInterPluginEventHandlerArgsTests
+    {
+        // ---------------- Tests ----------------
+
+        /// <summary>
+        /// Ensures the properties get set correctly during construction.
+        /// </summary>
+        [Test]
+        public void ConstructorTest()
+        {
+            Mock<IIrcWriter> writer = new Mock<IIrcWriter>( MockBehavior.Strict );
+            const string line = "line";
+
+            AnyInterPluginEventHandlerArgs uut = new AnyInterPluginEventHandlerArgs(
+                writer.Object,
+                line
+            );
+
+            Assert.AreSame( writer.Object, uut.Writer );
+            Assert.AreEqual( line, uut.Line );
+        }
+    }
+}