Split ircdproto send functions out into separate services

This makes it easier to see which send functions a protocol module
implements as they are all explicitly registered by the module, and
avoids the problem of subtly breaking other protocol modules when
using inheritance.

Also split the old "core" send implementations out into a module, and
the TS6 ID generator

1 files changed, 34 insertions, 162 deletions

diff --git a/include/protocol.h b/include/protocol.h
index ee782903b..4dc115fe6 100644
--- a/include/protocol.h
+++ b/include/protocol.h
@@ -24,6 +24,7 @@
 #include "service.h"
 #include "servers.h"
 #include "users.h"
+#include "messages.h"
 
 class IRCMessage;
 
@@ -72,168 +73,26 @@ public:
 	virtual void Parse(const Anope::string &, Anope::string &, Anope::string &, std::vector<Anope::string> &);
 	virtual Anope::string Format(IRCMessage &);
 
-	/** Kills a user
-	 * @param source Who is doing the kill
-	 * @param user The target to be killed
-	 * @param reason Kill reason
-	 */
-	virtual void SendSVSKill(const MessageSource &source, User *user, const Anope::string &reason);
-	virtual void SendMode(const MessageSource &, Channel *, const Anope::string &);
-	virtual void SendMode(const MessageSource &, User *, const Anope::string &);
-	virtual void SendKick(const MessageSource &, Channel *, User *, const Anope::string &);
-	virtual void SendNotice(const MessageSource &, const Anope::string &dest, const Anope::string &msg);
-	virtual void SendPrivmsg(const MessageSource &, const Anope::string &dest, const Anope::string &msg);
-	virtual void SendQuit(User *, const Anope::string &reason);
-	virtual void SendPart(User *, Channel *chan, const Anope::string &reason);
-	virtual void SendGlobops(const MessageSource &, const Anope::string &buf);
 	virtual void SendCTCPReply(const MessageSource &, const Anope::string &dest, const Anope::string &buf);
 	virtual void SendNumeric(int numeric, User *dest, IRCMessage &);
 
 	/* Retrieves the next free UID or SID */
-	virtual Anope::string UID_Retrieve();
-	virtual Anope::string SID_Retrieve();
-
-	/** Sets the server in NOOP mode. If NOOP mode is enabled, no users
-	 * will be able to oper on the server.
-	 * @param s The server
-	 * @param mode Whether to turn NOOP on or off
-	 */
-	virtual void SendSVSNOOP(Server *s, bool mode) { }
-
-	/** Sets the topic on a channel
-	 * @param bi The bot to set the topic from
-	 * @param c The channel to set the topic on. The topic being set is Channel::topic
-	 */
-	virtual void SendTopic(const MessageSource &, Channel *);
-
-	/** Sets a vhost on a user.
-	 * @param u The user
-	 * @param vident The ident to set
-	 * @param vhost The vhost to set
-	 */
-	virtual void SendVhost(User *u, const Anope::string &vident, const Anope::string &vhost) { }
-	virtual void SendVhostDel(User *) { }
-
-	/** Sets an akill. This is a recursive function that can be called multiple times
-	 * for the same xline, but for different users, if the xline is not one that can be
-	 * enforced by the IRCd, such as a nick/user/host/realname combination ban.
-	 * @param u The user affected by the akill, if known
-	 * @param x The akill
-	 */
-	virtual void SendAkill(User *, XLine *) anope_abstract;
-	virtual void SendAkillDel(XLine *) anope_abstract;
-
-	/* Realname ban */
-	virtual void SendSGLine(User *, XLine *) { }
-	virtual void SendSGLineDel(XLine *) { }
-
-	/* IP ban */
-	virtual void SendSZLine(User *u, XLine *) { }
-	virtual void SendSZLineDel(XLine *) { }
-
-	/* Nick ban (and sometimes channel) */
-	virtual void SendSQLine(User *, XLine *x) { }
-	virtual void SendSQLineDel(XLine *x) { }
-
-	virtual void SendKill(const MessageSource &source, const Anope::string &target, const Anope::string &reason);
-
-	/** Introduces a client to the rest of the network
-	 * @param u The client to introduce
-	 */
-	virtual void SendClientIntroduction(User *u) anope_abstract;
+	virtual Anope::string UID_Retrieve() { return ""; }
+	virtual Anope::string SID_Retrieve() { return ""; }
 
 
 	virtual void SendAction(const MessageSource &source, const Anope::string &dest, const Anope::string &message);
 
-	virtual void SendGlobalNotice(ServiceBot *bi, Server *dest, const Anope::string &msg) anope_abstract;
-	virtual void SendGlobalPrivmsg(ServiceBot *bi, Server *desc, const Anope::string &msg) anope_abstract;
-
-
-	virtual void SendPing(const Anope::string &servname, const Anope::string &who);
-
-	/**
-	 * Send a PONG reply to a received PING.
-	 * servname should be left empty to send a one param reply.
-	 * @param servname Daemon or client that is responding to the PING.
-	 * @param who Origin of the PING and destination of the PONG message.
-	 **/
-	virtual void SendPong(const Anope::string &servname, const Anope::string &who);
-
-	/** Joins one of our users to a channel.
-	 * @param u The user to join
-	 * @param c The channel to join the user to
-	 * @param status The status to set on the user after joining. This may or may not already internally
-	 * be set on the user. This may include the modes in the join, but will usually place them on the mode
-	 * stacker to be set "soon".
-	 */
-	virtual void SendJoin(User *u, Channel *c, const ChannelStatus *status) anope_abstract;
-
-	/** Force joins a user that isn't ours to a channel.
-	 * @param bi The source of the message
-	 * @param u The user to join
-	 * @param chan The channel to join the user to
-	 * @param param Channel key?
-	 */
-	virtual void SendSVSJoin(const MessageSource &source, User *u, const Anope::string &chan, const Anope::string &param) { }
-
-	/** Force parts a user that isn't ours from a channel.
-	 * @param source The source of the message
-	 * @param u The user to part
-	 * @param chan The channel to part the user from
-	 * @param param part reason, some IRCds don't support this
-	 */
-	virtual void SendSVSPart(const MessageSource &source, User *u, const Anope::string &chan, const Anope::string &param) { }
-
-	virtual void SendInvite(const MessageSource &source, Channel *c, User *u);
-
-
-	/** Sends a nick change of one of our clients.
-	 */
-	virtual void SendNickChange(User *u, const Anope::string &newnick);
-
-	/** Forces a nick change of a user that isn't ours (SVSNICK)
-	 */
-	virtual void SendForceNickChange(User *u, const Anope::string &newnick, time_t when);
-
-	/** Used to introduce ourselves to our uplink. Usually will SendServer(Me) and any other
-	 * initial handshake requirements.
+	/** Used to introduce ourselves to our uplink.
 	 */
-	virtual void SendConnect() anope_abstract;
+	virtual void Handshake() anope_abstract;
 
-	/** Called right before we begin our burst, after we have handshaked successfully with the uplink/
-	 * At this point none of our servesr, users, or channels exist on the uplink
+	/** Called right before we begin our burst, after we have handshaked successfully with the uplink.
+	 * At this point none of our servers, users, or channels exist on the uplink
 	 */
 	virtual void SendBOB() { }
 	virtual void SendEOB() { }
 
-	virtual void SendSVSHold(const Anope::string &, time_t) { }
-	virtual void SendSVSHoldDel(const Anope::string &) { }
-
-	virtual void SendSWhois(const MessageSource &, const Anope::string &, const Anope::string &) { }
-
-	/** Introduces a server to the uplink
-	 */
-	virtual void SendServer(Server *) anope_abstract;
-	virtual void SendSquit(Server *, const Anope::string &message);
-
-
-	virtual void SendLogin(User *u, NickServ::Nick *na) anope_abstract;
-	virtual void SendLogout(User *u) anope_abstract;
-
-	/** Send a channel creation message to the uplink.
-	 * On most TS6 IRCds this is a SJOIN with no nick
-	 */
-	virtual void SendChannel(Channel *c) { }
-
-	/** Make the user an IRC operator
-	 * Normally this is a simple +o, though some IRCds require us to send the oper type
-	 */
-	virtual void SendOper(User *u);
-
-	virtual void SendSASLMechanisms(std::vector<Anope::string> &) { }
-	virtual void SendSASLMessage(const SASL::Message &) { }
-	virtual void SendSVSLogin(const Anope::string &uid, const Anope::string &acc, const Anope::string &vident, const Anope::string &vhost) { }
-
 	virtual bool IsNickValid(const Anope::string &);
 	virtual bool IsChannelValid(const Anope::string &);
 	virtual bool IsIdentValid(const Anope::string &);
@@ -247,35 +106,48 @@ public:
 
 	virtual Anope::string NormalizeMask(const Anope::string &mask);
 
+	template<typename T, typename... Args> void Send(Args&&... args)
+	{
+		ServiceReference<MessageSender<T>> sender(T::NAME);
+
+		if (!sender)
+		{
+			Log(LOG_DEBUG) << "No message sender for type " << T::NAME;
+			return;
+		}
+
+		static_cast<T*>(static_cast<MessageSender<T>*>(sender))->Send(std::forward<Args>(args)...);
+	}
+
 	/* Templated functions which overload the normal functions to provide format strings */
-	template<typename... Args> void SendSVSKill(const MessageSource &source, User *user, const Anope::string &reason, Args&&... args)
+	template<typename... Args> void SendKill(const MessageSource &source, User *user, const Anope::string &reason, Args&&... args)
 	{
-		SendSVSKill(source, user, Anope::Format(reason, std::forward<Args>(args)...));
+		Send<messages::Kill>(source, user, Anope::Format(reason, std::forward<Args>(args)...));
 	}
 
 	template<typename... Args> void SendMode(const MessageSource &source, Channel *chan, const Anope::string &modes, Args&&... args)
 	{
-		SendMode(source, chan, Anope::Format(modes, std::forward<Args>(args)...));
+		Send<messages::ModeChannel>(source, chan, Anope::Format(modes, std::forward<Args>(args)...));
 	}
 
 	template<typename... Args> void SendMode(const MessageSource &source, User *u, const Anope::string &modes, Args&&... args)
 	{
-		SendMode(source, u, Anope::Format(modes, std::forward<Args>(args)...));
+		Send<messages::ModeUser>(source, u, Anope::Format(modes, std::forward<Args>(args)...));
 	}
 
-	template<typename... Args> void SendKick(const MessageSource &source, const Channel *chan, User *user, const Anope::string &reason, Args&&... args)
+	template<typename... Args> void SendKick(const MessageSource &source, Channel *chan, User *user, const Anope::string &reason, Args&&... args)
 	{
-		SendKick(source, chan, user, Anope::Format(reason, std::forward<Args>(args)...));
+		Send<messages::Kick>(source, chan, user, Anope::Format(reason, std::forward<Args>(args)...));
 	}
 
 	template<typename... Args> void SendNotice(const MessageSource &source, const Anope::string &dest, const Anope::string &message, Args&&... args)
 	{
-		SendNotice(source, dest, Anope::Format(message, std::forward<Args>(args)...));
+		Send<messages::Notice>(source, dest, Anope::Format(message, std::forward<Args>(args)...));
 	}
 
 	template<typename... Args> void SendPrivmsg(const MessageSource &source, const Anope::string &dest, const Anope::string &message, Args&&... args)
 	{
-		SendPrivmsg(source, dest, Anope::Format(message, std::forward<Args>(args)...));
+		Send<messages::Privmsg>(source, dest, Anope::Format(message, std::forward<Args>(args)...));
 	}
 
 	template<typename... Args> void SendAction(const MessageSource &source, const Anope::string &dest, const Anope::string &message, Args&&... args)
@@ -288,21 +160,21 @@ public:
 		SendCTCPReply(source, dest, Anope::Format(message, std::forward<Args>(args)...));
 	}
 
-	template<typename... Args> void SendGlobops(const MessageSource &source, const Anope::string &msg, Args&&... args)
+	template<typename... Args> void SendWallops(const MessageSource &source, const Anope::string &msg, Args&&... args)
 	{
-		SendGlobops(source, Anope::Format(msg, std::forward<Args>(args)...));
+		Send<messages::Wallops>(source, Anope::Format(msg, std::forward<Args>(args)...));
 	}
 
 	template<typename... Args> void SendNumeric(int numeric, User *dest, Args&&... args);
 
 	template<typename... Args> void SendQuit(User *u, const Anope::string &reason, Args&&... args)
 	{
-		SendQuit(u, Anope::Format(reason, std::forward<Args>(args)...));
+		Send<messages::Quit>(u, Anope::Format(reason, std::forward<Args>(args)...));
 	}
 
 	template<typename... Args> void SendPart(User *u, Channel *chan, const Anope::string &reason, Args&&... args)
 	{
-		SendPart(u, chan, Anope::Format(reason, std::forward<Args>(args)...));
+		Send<messages::Part>(u, chan, Anope::Format(reason, std::forward<Args>(args)...));
 	}
 };
 
@@ -334,10 +206,10 @@ enum IRCDMessageFlag
 class CoreExport IRCDMessage : public Service
 {
 	Anope::string name;
-	unsigned param_count;
+	unsigned int param_count;
 	std::set<IRCDMessageFlag> flags;
  public:
-	static constexpr const char *NAME = "IRCDMessage";
+	static constexpr const char *NAME = "ircdmessage";
 
 	IRCDMessage(Module *owner, const Anope::string &n, unsigned int p = 0);
 	unsigned int GetParamCount() const;