m_knock Add support for sending a 710 numeric when a KNOCK succeeds, add a config option to choose between behaviors

Fixes #287 reported by @ElementalAlchemist

2 files changed, 37 insertions, 3 deletions

diff --git a/docs/conf/modules.conf.example b/docs/conf/modules.conf.example
index 76563fbeb..84e3b26ab 100644
--- a/docs/conf/modules.conf.example
+++ b/docs/conf/modules.conf.example
@@ -943,6 +943,14 @@
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Knock module: adds the /KNOCK command and +K channel mode
 #<module name="m_knock.so">
+# This setting specifes what to do when someone successfully /KNOCKs.
+# If set to "notice", then a NOTICE will be sent to the channel.
+# This is the default and the compatible setting, as it requires no
+# special support from the clients.
+# If set to "numeric" then a 710 numeric will be sent to the channel.
+# This allows easier scripting but not all clients support it.
+# If set to "both" then (surprise!) both will be sent.
+#<knock notify="notice">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # LDAP authentication module: Adds the ability to authenticate users  #
diff --git a/src/modules/m_knock.cpp b/src/modules/m_knock.cpp
index 8cd5088bc..97eb0e005 100644
--- a/src/modules/m_knock.cpp
+++ b/src/modules/m_knock.cpp
@@ -28,6 +28,8 @@
 class CommandKnock : public Command
 {
  public:
+	bool sendnotice;
+	bool sendnumeric;
 	CommandKnock(Module* Creator) : Command(Creator,"KNOCK", 2, 2)
 	{
 		syntax = "<channel> <reason>";
@@ -62,7 +64,12 @@ class CommandKnock : public Command
 			return CMD_FAILURE;
 		}
 
-		c->WriteChannelWithServ(ServerInstance->Config->ServerName, "NOTICE %s :User %s is KNOCKing on %s (%s)", c->name.c_str(), user->nick.c_str(), c->name.c_str(), parameters[1].c_str());
+		if (sendnotice)
+			c->WriteChannelWithServ(ServerInstance->Config->ServerName, "NOTICE %s :User %s is KNOCKing on %s (%s)", c->name.c_str(), user->nick.c_str(), c->name.c_str(), parameters[1].c_str());
+
+		if (sendnumeric)
+			c->WriteChannelWithServ(ServerInstance->Config->ServerName, "710 %s %s %s :is KNOCKing: %s", c->name.c_str(), c->name.c_str(), user->GetFullHost().c_str(), parameters[1].c_str());
+
 		user->WriteServ("NOTICE %s :KNOCKing on %s", user->nick.c_str(), c->name.c_str());
 		return CMD_SUCCESS;
 	}
@@ -92,11 +99,30 @@ class ModuleKnock : public Module
 			throw ModuleException("Could not add new modes!");
 		ServerInstance->AddCommand(&cmd);
 
+		ServerInstance->Modules->Attach(I_OnRehash, this);
+		OnRehash(NULL);
 	}
 
-
-	virtual ~ModuleKnock()
+	void OnRehash(User* user)
 	{
+		std::string knocknotify = ServerInstance->Config->ConfValue("knock")->getString("notify");
+		irc::string notify(knocknotify.c_str());
+
+		if (notify == "numeric")
+		{
+			cmd.sendnotice = false;
+			cmd.sendnumeric = true;
+		}
+		else if (notify == "both")
+		{
+			cmd.sendnotice = true;
+			cmd.sendnumeric = true;
+		}
+		else
+		{
+			cmd.sendnotice = true;
+			cmd.sendnumeric = false;
+		}
 	}
 
 	virtual Version GetVersion()