Move the set option to its own module.

This is the first step of rewriting nickname protection.

3 files changed, 215 insertions, 172 deletions

diff --git a/data/nickserv.example.conf b/data/nickserv.example.conf
index 001137feb..a62379053 100644
--- a/data/nickserv.example.conf
+++ b/data/nickserv.example.conf
@@ -521,22 +521,11 @@ command { service = "NickServ"; name = "RESETPASS"; command = "nickserv/resetpas
  *   nickserv/set/display, nickserv/saset/display - Used for setting a users display name.
  *   nickserv/set/email, nickserv/saset/email - Used for setting a users email address.
  *   nickserv/set/keepmodes, nickserv/saset/keepmodes - Configure whether or not services should retain a user's modes across sessions.
- *   nickserv/set/kill, nickserv/saset/kill - Used for configuring nickname protection.
  *   nickserv/set/neverop, nickserv/saset/neverop - Used to configure whether a user can be added to access lists
  *   nickserv/saset/noexpire - Used for configuring noexpire, which prevents nicks from expiring.
  *   nickserv/set/password, nickserv/saset/password  - Used for changing a users password.
  */
-module
-{
-	name = "ns_set"
-
-	/*
-	 * Allow the use of the IMMED option in the NickServ SET KILL command.
-	 *
-	 * This directive is optional.
-	 */
-	#allowkillimmed = yes
-}
+module { name = "ns_set" }
 
 command { service = "NickServ"; name = "SET"; command = "nickserv/set"; }
 command { service = "NickServ"; name = "SASET"; command = "nickserv/saset"; permission = "nickserv/saset/"; group = "nickserv/admin"; }
@@ -553,9 +542,6 @@ command { service = "NickServ"; name = "SASET EMAIL"; command = "nickserv/saset/
 command { service = "NickServ"; name = "SET KEEPMODES"; command = "nickserv/set/keepmodes"; }
 command { service = "NickServ"; name = "SASET KEEPMODES"; command = "nickserv/saset/keepmodes"; permission = "nickserv/saset/keepmodes"; }
 
-command { service = "NickServ"; name = "SET KILL"; command = "nickserv/set/kill"; }
-command { service = "NickServ"; name = "SASET KILL"; command = "nickserv/saset/kill"; permission = "nickserv/saset/kill"; }
-
 command { service = "NickServ"; name = "SET PASSWORD"; command = "nickserv/set/password"; }
 command { service = "NickServ"; name = "SASET PASSWORD"; command = "nickserv/saset/password"; permission = "nickserv/saset/password"; }
 
@@ -565,6 +551,28 @@ command { service = "NickServ"; name = "SASET NEVEROP"; command = "nickserv/sase
 command { service = "NickServ"; name = "SASET NOEXPIRE"; command = "nickserv/saset/noexpire"; permission = "nickserv/saset/noexpire"; }
 
 /*
+ * ns_set_kill
+ *
+ * Provides the commands nickserv/set/kill and kickserv/saset/kill.
+ *
+ * Used for configuring nickname protection.
+ */
+module
+{
+	name = "ns_set_kill"
+
+	/*
+	 * Allow the use of the IMMED option in the NickServ SET KILL command.
+	 *
+	 * This directive is optional.
+	 */
+	#allowkillimmed = yes
+}
+
+command { service = "NickServ"; name = "SET KILL"; command = "nickserv/set/kill"; }
+command { service = "NickServ"; name = "SASET KILL"; command = "nickserv/saset/kill"; permission = "nickserv/saset/kill"; }
+
+/*
  * ns_set_language
  *
  * Provides the command nickserv/set/language and nickserv/saset/language.
@@ -578,7 +586,7 @@ command { service = "NickServ"; name = "SASET LANGUAGE"; command = "nickserv/sas
 /*
  * ns_set_message
  *
- * Provides the command nickserv/set/message and nickserv/saset/message.
+ * Provides the commands nickserv/set/message and nickserv/saset/message.
  *
  * Allows users to let services send them PRIVMSGs instead of NOTICEs.
  *
diff --git a/modules/nickserv/ns_set.cpp b/modules/nickserv/ns_set.cpp
index bb212b678..954062acc 100644
--- a/modules/nickserv/ns_set.cpp
+++ b/modules/nickserv/ns_set.cpp
@@ -17,7 +17,7 @@ class CommandNSSet final
 public:
 	CommandNSSet(Module *creator) : Command(creator, "nickserv/set", 1, 3)
 	{
-		this->SetDesc(_("Set options, including kill protection"));
+		this->SetDesc(_("Set nickname options and information"));
 		this->SetSyntax(_("\037option\037 \037parameters\037"));
 	}
 
@@ -752,146 +752,6 @@ public:
 	}
 };
 
-class CommandNSSetKill
-	: public Command
-{
-public:
-	CommandNSSetKill(Module *creator, const Anope::string &sname = "nickserv/set/kill", size_t min = 1) : Command(creator, sname, min, min + 1)
-	{
-		this->SetDesc(_("Turn protection on or off"));
-		this->SetSyntax("{ON | QUICK | IMMED | OFF}");
-	}
-
-	void Run(CommandSource &source, const Anope::string &user, const Anope::string &param)
-	{
-		if (Anope::ReadOnly)
-		{
-			source.Reply(READ_ONLY_MODE);
-			return;
-		}
-
-		if (Config->GetModule("nickserv")->Get<bool>("nonicknameownership"))
-		{
-			source.Reply(_("This command may not be used on this network because nickname ownership is disabled."));
-			return;
-		}
-
-		const NickAlias *na = NickAlias::Find(user);
-		if (!na)
-		{
-			source.Reply(NICK_X_NOT_REGISTERED, user.c_str());
-			return;
-		}
-		NickCore *nc = na->nc;
-
-		EventReturn MOD_RESULT;
-		FOREACH_RESULT(OnSetNickOption, MOD_RESULT, (source, this, nc, param));
-		if (MOD_RESULT == EVENT_STOP)
-			return;
-
-		if (param.equals_ci("ON"))
-		{
-			nc->Extend<bool>("KILLPROTECT");
-			nc->Shrink<bool>("KILL_QUICK");
-			nc->Shrink<bool>("KILL_IMMED");
-			Log(nc == source.GetAccount() ? LOG_COMMAND : LOG_ADMIN, source, this) << "to set kill on for " << nc->display;
-			source.Reply(_("Protection is now \002on\002 for \002%s\002."), nc->display.c_str());
-		}
-		else if (param.equals_ci("QUICK"))
-		{
-			nc->Extend<bool>("KILLPROTECT");
-			nc->Extend<bool>("KILL_QUICK");
-			nc->Shrink<bool>("KILL_IMMED");
-			Log(nc == source.GetAccount() ? LOG_COMMAND : LOG_ADMIN, source, this) << "to set kill quick for " << nc->display;
-			source.Reply(_("Protection is now \002on\002 for \002%s\002, with a reduced delay."), nc->display.c_str());
-		}
-		else if (param.equals_ci("IMMED"))
-		{
-			if (Config->GetModule(this->owner)->Get<bool>("allowkillimmed"))
-			{
-				nc->Extend<bool>("KILLPROTECT");
-				nc->Shrink<bool>("KILL_QUICK");
-				nc->Extend<bool>("KILL_IMMED");
-				Log(nc == source.GetAccount() ? LOG_COMMAND : LOG_ADMIN, source, this) << "to set kill immed for " << nc->display;
-				source.Reply(_("Protection is now \002on\002 for \002%s\002, with no delay."), nc->display.c_str());
-			}
-			else
-				source.Reply(_("The \002IMMED\002 option is not available on this network."));
-		}
-		else if (param.equals_ci("OFF"))
-		{
-			nc->Shrink<bool>("KILLPROTECT");
-			nc->Shrink<bool>("KILL_QUICK");
-			nc->Shrink<bool>("KILL_IMMED");
-			Log(nc == source.GetAccount() ? LOG_COMMAND : LOG_ADMIN, source, this) << "to disable kill for " << nc->display;
-			source.Reply(_("Protection is now \002off\002 for \002%s\002."), nc->display.c_str());
-		}
-		else
-			this->OnSyntaxError(source, "KILL");
-
-		return;
-	}
-
-	void Execute(CommandSource &source, const std::vector<Anope::string> &params) override
-	{
-		this->Run(source, source.nc->display, params[0]);
-	}
-
-	bool OnHelp(CommandSource &source, const Anope::string &) override
-	{
-		this->SendSyntax(source);
-		source.Reply(" ");
-		source.Reply(_("Turns the automatic protection option for your nick\n"
-				"on or off. With protection on, if another user\n"
-				"tries to take your nick, they will be given one minute to\n"
-				"change to another nick, after which %s will forcibly change\n"
-				"their nick.\n"
-				" \n"
-				"If you select \002QUICK\002, the user will be given only 20 seconds\n"
-				"to change nicks instead of the usual 60. If you select\n"
-				"\002IMMED\002, the user's nick will be changed immediately \037without\037 being\n"
-				"warned first or given a chance to change their nick; please\n"
-				"do not use this option unless necessary. Also, your\n"
-				"network's administrators may have disabled this option."), source.service->nick.c_str());
-		return true;
-	}
-};
-
-class CommandNSSASetKill final
-	: public CommandNSSetKill
-{
-public:
-	CommandNSSASetKill(Module *creator) : CommandNSSetKill(creator, "nickserv/saset/kill", 2)
-	{
-		this->ClearSyntax();
-		this->SetSyntax(_("\037nickname\037 {ON | QUICK | IMMED | OFF}"));
-	}
-
-	void Execute(CommandSource &source, const std::vector<Anope::string> &params) override
-	{
-		this->Run(source, params[0], params[1]);
-	}
-
-	bool OnHelp(CommandSource &source, const Anope::string &) override
-	{
-		this->SendSyntax(source);
-		source.Reply(" ");
-		source.Reply(_("Turns the automatic protection option for the nick\n"
-				"on or off. With protection on, if another user\n"
-				"tries to take the nick, they will be given one minute to\n"
-				"change to another nick, after which %s will forcibly change\n"
-				"their nick.\n"
-				" \n"
-				"If you select \002QUICK\002, the user will be given only 20 seconds\n"
-				"to change nicks instead of the usual 60. If you select\n"
-				"\002IMMED\002, the user's nick will be changed immediately \037without\037 being\n"
-				"warned first or given a chance to change their nick; please\n"
-				"do not use this option unless necessary. Also, your\n"
-				"network's administrators may have disabled this option."), source.service->nick.c_str());
-		return true;
-	}
-};
-
 class CommandNSSASetNoexpire final
 	: public Command
 {
@@ -966,16 +826,13 @@ class NSSet final
 	CommandNSSetKeepModes commandnssetkeepmodes;
 	CommandNSSASetKeepModes commandnssasetkeepmodes;
 
-	CommandNSSetKill commandnssetkill;
-	CommandNSSASetKill commandnssasetkill;
 
 	CommandNSSetPassword commandnssetpassword;
 	CommandNSSASetPassword commandnssasetpassword;
 
 	CommandNSSASetNoexpire commandnssasetnoexpire;
 
-	SerializableExtensibleItem<bool> autoop, neverop, killprotect, kill_quick, kill_immed,
-		noexpire;
+	SerializableExtensibleItem<bool> autoop, neverop, noexpire;
 
 	struct KeepModes final
 		: SerializableExtensibleItem<bool>
@@ -1035,18 +892,13 @@ public:
 		commandnssetdisplay(this), commandnssasetdisplay(this),
 		commandnssetemail(this), commandnssasetemail(this),
 		commandnssetkeepmodes(this), commandnssasetkeepmodes(this),
-		commandnssetkill(this), commandnssasetkill(this),
 		commandnssetpassword(this), commandnssasetpassword(this),
 		commandnssasetnoexpire(this),
 
 		autoop(this, "AUTOOP"), neverop(this, "NEVEROP"),
-		killprotect(this, "KILLPROTECT"), kill_quick(this, "KILL_QUICK"),
-		kill_immed(this, "KILL_IMMED"),
 		noexpire(this, "NS_NO_EXPIRE"),
-
 		keep_modes(this, "NS_KEEP_MODES"), ns_set_email(this, "ns_set_email")
 	{
-
 	}
 
 	EventReturn OnPreCommand(CommandSource &source, Command *command, std::vector<Anope::string> &params) override
@@ -1092,12 +944,6 @@ public:
 		if (!show_hidden)
 			return;
 
-		if (kill_immed.HasExt(na->nc))
-			info.AddOption(_("Immediate protection"));
-		else if (kill_quick.HasExt(na->nc))
-			info.AddOption(_("Quick protection"));
-		else if (killprotect.HasExt(na->nc))
-			info.AddOption(_("Protection"));
 		if (autoop.HasExt(na->nc))
 			info.AddOption(_("Auto-op"));
 		if (neverop.HasExt(na->nc))
diff --git a/modules/nickserv/ns_set_kill.cpp b/modules/nickserv/ns_set_kill.cpp
new file mode 100644
index 000000000..bba37e324
--- /dev/null
+++ b/modules/nickserv/ns_set_kill.cpp
@@ -0,0 +1,189 @@
+/* NickServ core functions
+ *
+ * (C) 2003-2024 Anope Team
+ * Contact us at team@anope.org
+ *
+ * Please read COPYING and README for further details.
+ *
+ * Based on the original code of Epona by Lara.
+ * Based on the original code of Services by Andy Church.
+ */
+
+#include "module.h"
+
+class CommandNSSetKill
+	: public Command
+{
+public:
+	CommandNSSetKill(Module *creator, const Anope::string &sname = "nickserv/set/kill", size_t min = 1)
+		: Command(creator, sname, min, min + 1)
+	{
+		this->SetDesc(_("Turn protection on or off"));
+		this->SetSyntax("{ON | QUICK | IMMED | OFF}");
+	}
+
+	void Run(CommandSource &source, const Anope::string &user, const Anope::string &param)
+	{
+		if (Anope::ReadOnly)
+		{
+			source.Reply(READ_ONLY_MODE);
+			return;
+		}
+
+		if (Config->GetModule("nickserv")->Get<bool>("nonicknameownership"))
+		{
+			source.Reply(_("This command may not be used on this network because nickname ownership is disabled."));
+			return;
+		}
+
+		const NickAlias *na = NickAlias::Find(user);
+		if (!na)
+		{
+			source.Reply(NICK_X_NOT_REGISTERED, user.c_str());
+			return;
+		}
+		NickCore *nc = na->nc;
+
+		EventReturn MOD_RESULT;
+		FOREACH_RESULT(OnSetNickOption, MOD_RESULT, (source, this, nc, param));
+		if (MOD_RESULT == EVENT_STOP)
+			return;
+
+		if (param.equals_ci("ON"))
+		{
+			nc->Extend<bool>("KILLPROTECT");
+			nc->Shrink<bool>("KILL_QUICK");
+			nc->Shrink<bool>("KILL_IMMED");
+			Log(nc == source.GetAccount() ? LOG_COMMAND : LOG_ADMIN, source, this) << "to set kill on for " << nc->display;
+			source.Reply(_("Protection is now \002on\002 for \002%s\002."), nc->display.c_str());
+		}
+		else if (param.equals_ci("QUICK"))
+		{
+			nc->Extend<bool>("KILLPROTECT");
+			nc->Extend<bool>("KILL_QUICK");
+			nc->Shrink<bool>("KILL_IMMED");
+			Log(nc == source.GetAccount() ? LOG_COMMAND : LOG_ADMIN, source, this) << "to set kill quick for " << nc->display;
+			source.Reply(_("Protection is now \002on\002 for \002%s\002, with a reduced delay."), nc->display.c_str());
+		}
+		else if (param.equals_ci("IMMED"))
+		{
+			if (Config->GetModule(this->owner)->Get<bool>("allowkillimmed"))
+			{
+				nc->Extend<bool>("KILLPROTECT");
+				nc->Shrink<bool>("KILL_QUICK");
+				nc->Extend<bool>("KILL_IMMED");
+				Log(nc == source.GetAccount() ? LOG_COMMAND : LOG_ADMIN, source, this) << "to set kill immed for " << nc->display;
+				source.Reply(_("Protection is now \002on\002 for \002%s\002, with no delay."), nc->display.c_str());
+			}
+			else
+				source.Reply(_("The \002IMMED\002 option is not available on this network."));
+		}
+		else if (param.equals_ci("OFF"))
+		{
+			nc->Shrink<bool>("KILLPROTECT");
+			nc->Shrink<bool>("KILL_QUICK");
+			nc->Shrink<bool>("KILL_IMMED");
+			Log(nc == source.GetAccount() ? LOG_COMMAND : LOG_ADMIN, source, this) << "to disable kill for " << nc->display;
+			source.Reply(_("Protection is now \002off\002 for \002%s\002."), nc->display.c_str());
+		}
+		else
+			this->OnSyntaxError(source, "KILL");
+
+		return;
+	}
+
+	void Execute(CommandSource &source, const std::vector<Anope::string> &params) override
+	{
+		this->Run(source, source.nc->display, params[0]);
+	}
+
+	bool OnHelp(CommandSource &source, const Anope::string &) override
+	{
+		this->SendSyntax(source);
+		source.Reply(" ");
+		source.Reply(_("Turns the automatic protection option for your nick\n"
+				"on or off. With protection on, if another user\n"
+				"tries to take your nick, they will be given one minute to\n"
+				"change to another nick, after which %s will forcibly change\n"
+				"their nick.\n"
+				" \n"
+				"If you select \002QUICK\002, the user will be given only 20 seconds\n"
+				"to change nicks instead of the usual 60. If you select\n"
+				"\002IMMED\002, the user's nick will be changed immediately \037without\037 being\n"
+				"warned first or given a chance to change their nick; please\n"
+				"do not use this option unless necessary. Also, your\n"
+				"network's administrators may have disabled this option."), source.service->nick.c_str());
+		return true;
+	}
+};
+
+class CommandNSSASetKill final
+	: public CommandNSSetKill
+{
+public:
+	CommandNSSASetKill(Module *creator)
+		: CommandNSSetKill(creator, "nickserv/saset/kill", 2)
+	{
+		this->ClearSyntax();
+		this->SetSyntax(_("\037nickname\037 {ON | QUICK | IMMED | OFF}"));
+	}
+
+	void Execute(CommandSource &source, const std::vector<Anope::string> &params) override
+	{
+		this->Run(source, params[0], params[1]);
+	}
+
+	bool OnHelp(CommandSource &source, const Anope::string &) override
+	{
+		this->SendSyntax(source);
+		source.Reply(" ");
+		source.Reply(_("Turns the automatic protection option for the nick\n"
+				"on or off. With protection on, if another user\n"
+				"tries to take the nick, they will be given one minute to\n"
+				"change to another nick, after which %s will forcibly change\n"
+				"their nick.\n"
+				" \n"
+				"If you select \002QUICK\002, the user will be given only 20 seconds\n"
+				"to change nicks instead of the usual 60. If you select\n"
+				"\002IMMED\002, the user's nick will be changed immediately \037without\037 being\n"
+				"warned first or given a chance to change their nick; please\n"
+				"do not use this option unless necessary. Also, your\n"
+				"network's administrators may have disabled this option."), source.service->nick.c_str());
+		return true;
+	}
+};
+
+class NSSetKill final
+	: public Module
+{
+private:
+	CommandNSSetKill commandnssetkill;
+	CommandNSSASetKill commandnssasetkill;
+	SerializableExtensibleItem<bool> killprotect, kill_quick, kill_immed;
+
+public:
+	NSSetKill(const Anope::string &modname, const Anope::string &creator)
+		: Module(modname, creator, VENDOR)
+		, commandnssetkill(this)
+		, commandnssasetkill(this)
+		, killprotect(this, "KILLPROTECT")
+		, kill_quick(this, "KILL_QUICK")
+		, kill_immed(this, "KILL_IMMED")
+	{
+	}
+
+	void OnNickInfo(CommandSource &source, NickAlias *na, InfoFormatter &info, bool show_hidden) override
+	{
+		if (!show_hidden)
+			return;
+
+		if (kill_immed.HasExt(na->nc))
+			info.AddOption(_("Immediate protection"));
+		else if (kill_quick.HasExt(na->nc))
+			info.AddOption(_("Quick protection"));
+		else if (killprotect.HasExt(na->nc))
+			info.AddOption(_("Protection"));
+	}
+};
+
+MODULE_INIT(NSSetKill)