Massive refactor, stage 2

Author: NattyNarwhal

IrcBot.Title/Title.cs

@@ -52,6 +52,11 @@ string IPlugin.InvokeWithMessage(string source, string message, ref IrcClient cl
             return !String.IsNullOrEmpty(toSend) ? toSend : null;
         }
 
+        string IPlugin.InvokeWithChannelUserChange(string channel, string user, string kicker, string message, ChannelUserChange type, ref IrcClient client)
+        {
+            return null; // Not implemented
+        }
+
         /// <summary>
         /// Gets the title and any other interesting doodads of an HTML document.
         /// </summary>

IrcBot.Utils/Utilities.cs

@@ -18,6 +18,11 @@ string IPlugin.InvokeWithMessage(string source, string message, ref IrcClient cl
         {
             return message == ".ping" ? "pong" : null;
         }
+
+        string IPlugin.InvokeWithChannelUserChange(string channel, string user, string kicker, string message, ChannelUserChange type, ref IrcClient client)
+        {
+            return null; // Not implemented
+        }
     }
 
     /// <summary>
@@ -48,6 +53,11 @@ string IPlugin.InvokeWithMessage(string source, string message, ref IrcClient cl
 
             return null;
         }
+
+        string IPlugin.InvokeWithChannelUserChange(string channel, string user, string kicker, string message, ChannelUserChange type, ref IrcClient client)
+        {
+            return null; // Not implemented
+        }
     }
 
     /// <summary>
@@ -68,6 +78,11 @@ string IPlugin.InvokeWithMessage(string source, string message, ref IrcClient cl
 
             return null;
         }
+
+        string IPlugin.InvokeWithChannelUserChange(string channel, string user, string kicker, string message, ChannelUserChange type, ref IrcClient client)
+        {
+            return null; // Not implemented
+        }
     }
 
     /// <summary>
@@ -83,6 +98,11 @@ string IPlugin.InvokeWithMessage(string source, string message, ref IrcClient cl
             }
             return null;
         }
+
+        string IPlugin.InvokeWithChannelUserChange(string channel, string user, string kicker, string message, ChannelUserChange type, ref IrcClient client)
+        {
+            return null; // Not implemented
+        }
     }
 
     public class Whois : IPlugin
@@ -97,6 +117,11 @@ string IPlugin.InvokeWithMessage(string source, string message, ref IrcClient cl
             }
             return null;
         }
+
+        string IPlugin.InvokeWithChannelUserChange(string channel, string user, string kicker, string message, ChannelUserChange type, ref IrcClient client)
+        {
+            return null; // Not implemented
+        }
     }
 
     /// <summary>
@@ -121,5 +146,10 @@ string IPlugin.InvokeWithMessage(string source, string message, ref IrcClient cl
             }
             return null; // we have no need to talk
         }
+
+        string IPlugin.InvokeWithChannelUserChange(string channel, string user, string kicker, string message, ChannelUserChange type, ref IrcClient client)
+        {
+            return null; // Not implemented
+        }
     }
 }

IrcBot.YouTube/YouTube.cs

@@ -50,5 +50,10 @@ string IPlugin.InvokeWithMessage(string source, string message, ref IrcClient cl
             }
             return to_send;
         }
+
+        string IPlugin.InvokeWithChannelUserChange(string channel, string user, string kicker, string message, ChannelUserChange type, ref IrcClient client)
+        {
+            return null; // Not implemented
+        }
     }
 }

IrcBot/IPlugin.cs

@@ -10,6 +10,7 @@ namespace IrcBot
     /// <summary>
     /// Represents a plugin implementation.
     /// </summary>
+    /// <remarks>You will have to implement them all, but nothing says you don't have to do anything useful with the ones you don't need.</remarks>
     public interface IPlugin
     {
         /// <summary>
@@ -35,5 +36,30 @@ public interface IPlugin
         /// }
         /// </example>
         string InvokeWithMessage(string source, string message, ref IrcClient client);
+
+        /// <summary>
+        /// Activates the plugin with a channel user changing event.
+        /// </summary>
+        /// <param name="channel">If applicable, the channel the event was raised from.</param>
+        /// <param name="user">The user that joined or left.</param>
+        /// <param name="kicker">If applicable, the operator that kicked the user.</param>
+        /// <param name="message">If applicable, the quit, part, or kick message.</param>
+        /// <param name="type">The type of event that was raised.</param>
+        /// <param name="client">A reference to the IRC client, for invoke commands with.</param>
+        /// <returns>A message to send back to the channel. If there's nothing worth sending, you can return null to send nothing.</returns>
+        /// <remarks>
+        /// When using the IrcClient reference, don't invoke SendMessage to the source - the bot will do this to the source with what you return.
+        /// 
+        /// Plugins retain no state other than the IrcClient's when invoked.
+        /// </remarks>
+        string InvokeWithChannelUserChange(string channel, string user, string kicker, string message, ChannelUserChange type, ref IrcClient client);
+    }
+
+    /// <summary>
+    /// The type of event when a channel's user is added or moved.
+    /// </summary>
+    public enum ChannelUserChange
+    {
+        Quit, Part, Join, Kick
     }
 }

IrcBot/Program.cs

@@ -61,6 +61,10 @@ static void Main(string[] args)
             // assign events
             i.OnChannelMessage += i_OnChannelMessage;
             i.OnQueryMessage += i_OnQueryMessage;
+            i.OnJoin += i_OnJoin;
+            i.OnQuit += i_OnQuit;
+            i.OnKick += i_OnKick;
+            i.OnPart += i_OnPart;
             // init
             i.ActiveChannelSyncing = true;
             i.UseSsl = Settings.Default.SSL;
@@ -70,6 +74,27 @@ static void Main(string[] args)
             i.Listen();
         }
 
+        static void i_OnPart(object sender, PartEventArgs e)
+        {
+            InvokePluginWithChannelUserChange(e.Channel, e.Who, null, e.PartMessage, ChannelUserChange.Part);
+        }
+
+        static void i_OnKick(object sender, KickEventArgs e)
+        {
+            // SmartIrc4net documentation is NOT clear on the Who/Whom mixup
+            InvokePluginWithChannelUserChange(e.Channel, e.Whom, e.Who, e.KickReason, ChannelUserChange.Kick);
+        }
+
+        static void i_OnQuit(object sender, QuitEventArgs e)
+        {
+            InvokePluginWithChannelUserChange(null, e.Who, null, e.QuitMessage, ChannelUserChange.Quit);
+        }
+
+        static void i_OnJoin(object sender, JoinEventArgs e)
+        {
+            InvokePluginWithChannelUserChange(e.Channel, e.Who, null, null, ChannelUserChange.Join);
+        }
+
         static void i_OnQueryMessage(object sender, IrcEventArgs e)
         {
             InvokePluginWithMessage(e.Data.Nick, e.Data.Message);
@@ -81,7 +106,7 @@ static void i_OnChannelMessage(object sender, IrcEventArgs e)
         }
 
         /// <summary>
-        /// Invokes a plugin.
+        /// Invokes a plugin with a message.
         /// </summary>
         /// <param name="source">The channel or user that sent the message.</param>
         /// <param name="message">The message for the plugins to handle.</param>
@@ -116,6 +141,38 @@ static void InvokePluginWithMessage(string source, string message)
                 Debug.WriteLine(ex.ToString());
             }
         }
+
+        static void InvokePluginWithChannelUserChange(string channel, string user, string kicker, string message, ChannelUserChange type)
+        {
+            // This doesn't matter anyways if it succeeds or not
+            try
+            {
+                foreach (Type p in plugins)
+                {
+                    Thread t = new Thread(() =>
+                    {
+                        // Why not spawn instances when we loaded them? Sometimes state likes to stick or something.
+                        string to_send = ((IPlugin)Activator.CreateInstance(p)).InvokeWithChannelUserChange(channel, user, kicker, message, type, ref i);
+                        if (!String.IsNullOrEmpty(message))
+                        {
+                            i.SendMessage(SendType.Message, channel, to_send);
+                        }
+                    });
+                    t.IsBackground = true;
+                    t.Name = p.Name;
+                    t.Start();
+                    if (!t.Join(5000))
+                    {
+                        t.Abort();
+                        Debug.WriteLine("The plugin took too long to respond.", "PluginLoader");
+                    }
+                }
+            }
+            catch (Exception ex)
+            {
+                Debug.WriteLine(ex.ToString());
+            }
+        }
     }
 
     /// <summary>

README.md

@@ -6,16 +6,26 @@ A simple IrcBot. Requires SmartIrc4net, and HtmlAgilityPack (will by installed v
 
 Modules implement the `IPlugin` interface.
 
-At first, it loads the files meeting `IrcBot.*.dll` match in the `PluginPath` setting, then loading the classes implementing `IPlugin`. On receiving a message, it will enumerate all plugins and invoke them. A plugin will only return non-null/`String.Empty` if it has something to say when parsing the message.
+At first, it loads the files meeting `IrcBot.*.dll` match in the `PluginPath` setting, then loading the classes implementing `IPlugin`. On receiving a event, it will enumerate all plugins and invoke them with the approriate instance. A plugin will only return non-null/`String.Empty` if it has something to say when parsing the message.
 
-The method instance to use is:
+Note that if you don't have any use for a method in a plugin, simply nop it out by returning null.
 
-    string IPlugin.Invoke(string source, string message, ref Meebey.SmartIrc4net.IrcClient client)
+The method instances to use are:
+
+### InvokeWithMessage
+
+    string IPlugin.InvokeWithMessage(string source, string message, ref Meebey.SmartIrc4net.IrcClient client)
 
 `source` indicates the channel or user (in case of private message) that the message originated from, `message` indicates the message, and `client` is a reference to the bot's instance of IrcClient, which can be used for commands. The return value is what to send back to the source.
 
 Best practices when making your plugin is to use "." as a prefix for commands, and not to use `client.SendMessage`, as it will send to the source what you return. (if not null)
 
+### InvokeWithChannelUserChange
+
+    string IPlugin.InvokeWithChannelUserChange(string channel, string user, string kicker, string message, ChannelUserChange type, ref IrcClient client)
+
+`channel` is the channel the event was recieved from (if applicable), `user` is the user that has been added or removed from the channel, `kicker` was the person who kicked the user (if kicked), `message` is the message/reason for the event (if applicable), `type` is a `ChannelUserChange` enumeration that represents what happened (Join, Part, Quit, Kick), and `client is a reference to the bot's instance of IrcClient.
+
 ### Building a module
 
 To build one, you can add a project to the solution or make a simple file with these parameters to the compiler manually: