Move nickserv/set/message to a new module, kill options:useprivmsg.

8 files changed, 161 insertions, 142 deletions

diff --git a/data/anope.example.conf b/data/anope.example.conf
index 2123d1274..f365b744a 100644
--- a/data/anope.example.conf
+++ b/data/anope.example.conf
@@ -430,19 +430,6 @@ options
 	timeoutcheck = 3s
 
 	/*
-	 * If set, this will allow users to let services send PRIVMSGs to them
-	 * instead of NOTICEs. Also see the "msg" option of nickserv:defaults,
-	 * which also toggles the default communication (PRIVMSG or NOTICE) to
-	 * use for unregistered users.
-	 *
-	 * This is a feature that is against the IRC RFC and should be used ONLY
-	 * if absolutely necessary.
-	 *
-	 * This directive is optional, and not recommended.
-	 */
-	#useprivmsg = yes
-
-	/*
 	 * If set, will force services to only respond to PRIVMSGs addresses to
 	 * Nick@ServerName - e.g. NickServ@example.com. This should be used in
 	 * conjunction with IRCd aliases. This directive is optional.
diff --git a/data/nickserv.example.conf b/data/nickserv.example.conf
index e42a05023..dd84b7a5e 100644
--- a/data/nickserv.example.conf
+++ b/data/nickserv.example.conf
@@ -106,8 +106,7 @@ module
 	 * -     memo_mail: Notify user if they have a new memo by mail
 	 * -        autoop: User will be automatically opped in channels they enter and have access to
 	 * -       neverop: User can not be added to access lists
-	 * -           msg: Messages will be sent as PRIVMSGs instead of NOTICEs, requires options:useprivmsg
-	 *                  to be enabled as well
+	 * -           msg: Messages will be sent as PRIVMSGs instead of NOTICEs
 	 * - ns_keep_modes: Enables keepmodes, which retains user modes across sessions
 	 *
 	 * This directive is optional, if left blank, the options will default to memo_signon, and
@@ -512,7 +511,6 @@ command { service = "NickServ"; name = "RESETPASS"; command = "nickserv/resetpas
  *   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/message, nickserv/saset/message - Used to configure how services send messages to you.
  *   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.
@@ -547,9 +545,6 @@ command { service = "NickServ"; name = "SASET KEEPMODES"; command = "nickserv/sa
 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 MESSAGE"; command = "nickserv/set/message"; }
-command { service = "NickServ"; name = "SASET MESSAGE"; command = "nickserv/saset/message"; permission = "nickserv/saset/message"; }
-
 command { service = "NickServ"; name = "SET PASSWORD"; command = "nickserv/set/password"; }
 command { service = "NickServ"; name = "SASET PASSWORD"; command = "nickserv/saset/password"; permission = "nickserv/saset/password"; }
 
@@ -570,6 +565,21 @@ command { service = "NickServ"; name = "SET LANGUAGE"; command = "nickserv/set/l
 command { service = "NickServ"; name = "SASET LANGUAGE"; command = "nickserv/saset/language"; permission = "nickserv/saset/language"; }
 
 /*
+ * ns_set_message
+ *
+ * Provides the command nickserv/set/message and nickserv/saset/message.
+ *
+ * Allows users to let services send them PRIVMSGs instead of NOTICEs.
+ *
+ * This might cause problems with badly written clients as the IRC RFC
+ * requires that automatic responses to a PRIVMSG use a NOTICE to avoid
+ * message loops. Only enable this if you are sure this can not happen.
+ */
+#module { name = "ns_set_message" }
+#command { service = "NickServ"; name = "SET MESSAGE"; command = "nickserv/set/message"; }
+#command { service = "NickServ"; name = "SASET MESSAGE"; command = "nickserv/saset/message"; permission = "nickserv/saset/message"; }
+
+/*
  * ns_set_misc
  *
  * Provides the command nickserv/set/misc.
diff --git a/include/config.h b/include/config.h
index 652d42a7a..42445637d 100644
--- a/include/config.h
+++ b/include/config.h
@@ -88,8 +88,6 @@ namespace Configuration
 	{
 		/* options:readtimeout */
 		time_t ReadTimeout;
-		/* options:useprivmsg */
-		bool UsePrivmsg;
 		/* If we should default to privmsging clients */
 		bool DefPrivmsg;
 		/* Default language */
diff --git a/modules/nickserv/ns_set.cpp b/modules/nickserv/ns_set.cpp
index b4dbe0a44..25c4e5a0d 100644
--- a/modules/nickserv/ns_set.cpp
+++ b/modules/nickserv/ns_set.cpp
@@ -892,112 +892,6 @@ public:
 	}
 };
 
-class CommandNSSetMessage
-	: public Command
-{
-public:
-	CommandNSSetMessage(Module *creator, const Anope::string &sname = "nickserv/set/message", size_t min = 1) : Command(creator, sname, min, min + 1)
-	{
-		this->SetDesc(_("Change the communication method of services"));
-		this->SetSyntax("{ON | OFF}");
-	}
-
-	void Run(CommandSource &source, const Anope::string &user, const Anope::string &param)
-	{
-		if (Anope::ReadOnly)
-		{
-			source.Reply(READ_ONLY_MODE);
-			return;
-		}
-
-		const NickAlias *na = NickAlias::Find(user);
-		if (!na)
-		{
-			source.Reply(NICK_X_NOT_REGISTERED, user.c_str());
-			return;
-		}
-		NickCore *nc = na->nc;
-
-		if (!Config->GetBlock("options")->Get<bool>("useprivmsg"))
-		{
-			source.Reply(_("You cannot %s on this network."), source.command.c_str());
-			return;
-		}
-
-		EventReturn MOD_RESULT;
-		FOREACH_RESULT(OnSetNickOption, MOD_RESULT, (source, this, nc, param));
-		if (MOD_RESULT == EVENT_STOP)
-			return;
-
-		if (param.equals_ci("ON"))
-		{
-			Log(nc == source.GetAccount() ? LOG_COMMAND : LOG_ADMIN, source, this) << "to enable " << source.command << " for " << nc->display;
-			nc->Extend<bool>("MSG");
-			source.Reply(_("Services will now reply to \002%s\002 with \002messages\002."), nc->display.c_str());
-		}
-		else if (param.equals_ci("OFF"))
-		{
-			Log(nc == source.GetAccount() ? LOG_COMMAND : LOG_ADMIN, source, this) << "to disable " << source.command << " for " << nc->display;
-			nc->Shrink<bool>("MSG");
-			source.Reply(_("Services will now reply to \002%s\002 with \002notices\002."), nc->display.c_str());
-		}
-		else
-			this->OnSyntaxError(source, "MSG");
-	}
-
-	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
-	{
-		Anope::string cmd = source.command;
-		size_t i = cmd.find_last_of(' ');
-		if (i != Anope::string::npos)
-			cmd = cmd.substr(i + 1);
-
-		this->SendSyntax(source);
-		source.Reply(" ");
-		source.Reply(_("Allows you to choose the way services are communicating with\n"
-				"you. With \002%s\002 set, services will use messages, else they'll\n"
-				"use notices."), cmd.upper().c_str());
-		return true;
-	}
-
-	void OnServHelp(CommandSource &source) override
-	{
-		if (Config->GetBlock("options")->Get<bool>("useprivmsg"))
-			Command::OnServHelp(source);
-	}
-};
-
-class CommandNSSASetMessage final
-	: public CommandNSSetMessage
-{
-public:
-	CommandNSSASetMessage(Module *creator) : CommandNSSetMessage(creator, "nickserv/saset/message", 2)
-	{
-		this->ClearSyntax();
-		this->SetSyntax(_("\037nickname\037 {ON | OFF}"));
-	}
-
-	bool OnHelp(CommandSource &source, const Anope::string &) override
-	{
-		this->SendSyntax(source);
-		source.Reply(" ");
-		source.Reply(_("Allows you to choose the way services are communicating with\n"
-				"the given user. With \002MSG\002 set, services will use messages,\n"
-				"else they'll use notices."));
-		return true;
-	}
-
-	void Execute(CommandSource &source, const std::vector<Anope::string> &params) override
-	{
-		this->Run(source, params[0], params[1]);
-	}
-};
-
 class CommandNSSASetNoexpire final
 	: public Command
 {
@@ -1075,16 +969,13 @@ class NSSet final
 	CommandNSSetKill commandnssetkill;
 	CommandNSSASetKill commandnssasetkill;
 
-	CommandNSSetMessage commandnssetmessage;
-	CommandNSSASetMessage commandnssasetmessage;
-
 	CommandNSSetPassword commandnssetpassword;
 	CommandNSSASetPassword commandnssasetpassword;
 
 	CommandNSSASetNoexpire commandnssasetnoexpire;
 
 	SerializableExtensibleItem<bool> autoop, neverop, killprotect, kill_quick, kill_immed,
-		message, noexpire;
+		noexpire;
 
 	struct KeepModes final
 		: SerializableExtensibleItem<bool>
@@ -1145,13 +1036,12 @@ public:
 		commandnssetemail(this), commandnssasetemail(this),
 		commandnssetkeepmodes(this), commandnssasetkeepmodes(this),
 		commandnssetkill(this), commandnssasetkill(this),
-		commandnssetmessage(this), commandnssasetmessage(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"), message(this, "MSG"),
+		kill_immed(this, "KILL_IMMED"),
 		noexpire(this, "NS_NO_EXPIRE"),
 
 		keep_modes(this, "NS_KEEP_MODES"), ns_set_email(this, "ns_set_email")
@@ -1208,8 +1098,6 @@ public:
 			info.AddOption(_("Quick protection"));
 		else if (killprotect.HasExt(na->nc))
 			info.AddOption(_("Protection"));
-		if (message.HasExt(na->nc))
-			info.AddOption(_("Message mode"));
 		if (autoop.HasExt(na->nc))
 			info.AddOption(_("Auto-op"));
 		if (neverop.HasExt(na->nc))
diff --git a/modules/nickserv/ns_set_message.cpp b/modules/nickserv/ns_set_message.cpp
new file mode 100644
index 000000000..04bb331d2
--- /dev/null
+++ b/modules/nickserv/ns_set_message.cpp
@@ -0,0 +1,137 @@
+/* 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 CommandNSSetMessage
+	: public Command
+{
+public:
+	CommandNSSetMessage(Module *creator, const Anope::string &sname = "nickserv/set/message", size_t min = 1)
+		: Command(creator, sname, min, min + 1)
+	{
+		this->SetDesc(_("Change the communication method of services"));
+		this->SetSyntax("{ON | OFF}");
+	}
+
+	void Run(CommandSource &source, const Anope::string &user, const Anope::string &param)
+	{
+		if (Anope::ReadOnly)
+		{
+			source.Reply(READ_ONLY_MODE);
+			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"))
+		{
+			Log(nc == source.GetAccount() ? LOG_COMMAND : LOG_ADMIN, source, this) << "to enable " << source.command << " for " << nc->display;
+			nc->Extend<bool>("MSG");
+			source.Reply(_("Services will now reply to \002%s\002 with \002messages\002."), nc->display.c_str());
+		}
+		else if (param.equals_ci("OFF"))
+		{
+			Log(nc == source.GetAccount() ? LOG_COMMAND : LOG_ADMIN, source, this) << "to disable " << source.command << " for " << nc->display;
+			nc->Shrink<bool>("MSG");
+			source.Reply(_("Services will now reply to \002%s\002 with \002notices\002."), nc->display.c_str());
+		}
+		else
+			this->OnSyntaxError(source, "MSG");
+	}
+
+	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
+	{
+		Anope::string cmd = source.command;
+		size_t i = cmd.find_last_of(' ');
+		if (i != Anope::string::npos)
+			cmd = cmd.substr(i + 1);
+
+		this->SendSyntax(source);
+		source.Reply(" ");
+		source.Reply(_("Allows you to choose the way services are communicating with\n"
+				"you. With \002%s\002 set, services will use messages, else they'll\n"
+				"use notices."), cmd.upper().c_str());
+		return true;
+	}
+};
+
+class CommandNSSASetMessage final
+	: public CommandNSSetMessage
+{
+public:
+	CommandNSSASetMessage(Module *creator) : CommandNSSetMessage(creator, "nickserv/saset/message", 2)
+	{
+		this->ClearSyntax();
+		this->SetSyntax(_("\037nickname\037 {ON | OFF}"));
+	}
+
+	bool OnHelp(CommandSource &source, const Anope::string &) override
+	{
+		this->SendSyntax(source);
+		source.Reply(" ");
+		source.Reply(_("Allows you to choose the way services are communicating with\n"
+				"the given user. With \002MSG\002 set, services will use messages,\n"
+				"else they'll use notices."));
+		return true;
+	}
+
+	void Execute(CommandSource &source, const std::vector<Anope::string> &params) override
+	{
+		this->Run(source, params[0], params[1]);
+	}
+};
+
+
+class NSSetMessage final
+	: public Module
+{
+private:
+	CommandNSSetMessage commandnssetmessage;
+	CommandNSSASetMessage commandnssasetmessage;
+	SerializableExtensibleItem<bool> message;
+
+public:
+	NSSetMessage(const Anope::string &modname, const Anope::string &creator)
+		: Module(modname, creator, VENDOR)
+		, commandnssetmessage(this)
+		, commandnssasetmessage(this)
+		, message(this, "MSG")
+	{
+	}
+
+	void OnNickInfo(CommandSource &source, NickAlias *na, InfoFormatter &info, bool show_hidden) override
+	{
+		if (!show_hidden)
+			return;
+		if (message.HasExt(na->nc))
+			info.AddOption(_("Message mode"));
+	}
+};
+
+MODULE_INIT(NSSetMessage)
diff --git a/src/config.cpp b/src/config.cpp
index ebf142c04..28be07318 100644
--- a/src/config.cpp
+++ b/src/config.cpp
@@ -121,7 +121,7 @@ template<typename T> static void ValidateNotZero(const Anope::string &block, con
 Conf::Conf() : Block("")
 {
 	ReadTimeout = 0;
-	UsePrivmsg = DefPrivmsg = false;
+	DefPrivmsg = false;
 
 	this->LoadConf(ServicesConf);
 
@@ -195,7 +195,6 @@ Conf::Conf() : Block("")
 	}
 
 	this->ReadTimeout = options->Get<time_t>("readtimeout");
-	this->UsePrivmsg = options->Get<bool>("useprivmsg");
 	this->UseStrictPrivmsg = options->Get<bool>("usestrictprivmsg");
 	this->StrictPrivmsg = !UseStrictPrivmsg ? "/msg " : "/";
 	{
diff --git a/src/servers.cpp b/src/servers.cpp
index ca418aec0..7d4e57770 100644
--- a/src/servers.cpp
+++ b/src/servers.cpp
@@ -328,7 +328,7 @@ bool Server::IsQuitting() const
 
 void Server::Notice(BotInfo *source, const Anope::string &message)
 {
-	if (Config->UsePrivmsg && Config->DefPrivmsg)
+	if (Config->DefPrivmsg)
 		IRCD->SendGlobalPrivmsg(source, this, message);
 	else
 		IRCD->SendGlobalNotice(source, this, message);
diff --git a/src/users.cpp b/src/users.cpp
index e39114654..5f83420a4 100644
--- a/src/users.cpp
+++ b/src/users.cpp
@@ -839,10 +839,10 @@ bool User::BadPassword()
 bool User::ShouldPrivmsg() const
 {
 	// Send a PRIVMSG instead of a NOTICE if:
-	// 1. options:useprivmsg is enabled.
-	// 2. The user is not registered and msg is in nickserv:defaults.
-	// 3. The user is registered and has set /ns set message on.
-	return Config->UsePrivmsg && ((!nc && Config->DefPrivmsg) || (nc && nc->HasExt("MSG")));
+	// 1. The user is not registered and msg is in nickserv:defaults.
+	// 2. The user is registered and has set /ns set message on.
+	static ExtensibleRef<bool> msg("MSG");
+	return (!nc && Config->DefPrivmsg) || (nc && msg && msg->HasExt(nc));
 }
 
 User *User::Find(const Anope::string &name, bool nick_only)