Add m_ircv3_capnotify which implements the IRCv3.2 cap-notify extension

1 files changed, 149 insertions, 0 deletions

diff --git a/src/modules/m_ircv3_capnotify.cpp b/src/modules/m_ircv3_capnotify.cpp
new file mode 100644
index 000000000..b19c2665d
--- /dev/null
+++ b/src/modules/m_ircv3_capnotify.cpp
@@ -0,0 +1,149 @@
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
+ *
+ *   Copyright (C) 2015 Attila Molnar <attilamolnar@hush.com>
+ *
+ * This file is part of InspIRCd.  InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+
+#include "inspircd.h"
+#include "modules/cap.h"
+#include "modules/reload.h"
+
+class CapNotify : public Cap::Capability
+{
+	bool OnRequest(LocalUser* user, bool add) CXX11_OVERRIDE
+	{
+		// Users using the negotiation protocol v3.2 or newer may not turn off cap-notify
+		if ((!add) && (GetProtocol(user) != Cap::CAP_LEGACY))
+			return false;
+		return true;
+	}
+
+	bool OnList(LocalUser* user) CXX11_OVERRIDE
+	{
+		// If the client supports 3.2 enable cap-notify for them
+		if (GetProtocol(user) != Cap::CAP_LEGACY)
+			set(user, true);
+		return true;
+	}
+
+ public:
+	CapNotify(Module* mod)
+		: Cap::Capability(mod, "cap-notify")
+	{
+	}
+};
+
+class ModuleIRCv3CapNotify : public Module, public Cap::EventListener, public ReloadModule::EventListener
+{
+	CapNotify capnotify;
+	std::string reloadedmod;
+	std::vector<std::string> reloadedcaps;
+
+	void Send(const std::string& capname, Cap::Capability* cap, bool add)
+	{
+		std::string msg = (add ? "ADD :" : "DEL :");
+		msg.append(capname);
+		std::string msgwithval = msg;
+		msgwithval.push_back('=');
+		std::string::size_type msgpos = msgwithval.size();
+
+		const UserManager::LocalList& list = ServerInstance->Users.GetLocalUsers();
+		for (UserManager::LocalList::const_iterator i = list.begin(); i != list.end(); ++i)
+		{
+			LocalUser* user = *i;
+			if (!capnotify.get(user))
+				continue;
+
+			// If the cap is being added and the client supports cap values then show the value, if any
+			if ((add) && (capnotify.GetProtocol(user) != Cap::CAP_LEGACY))
+			{
+				const std::string* capvalue = cap->GetValue(user);
+				if ((capvalue) && (!capvalue->empty()))
+				{
+					msgwithval.append(*capvalue);
+					user->WriteCommand("CAP", msgwithval);
+					msgwithval.erase(msgpos);
+					continue;
+				}
+			}
+			user->WriteCommand("CAP", msg);
+		}
+	}
+
+ public:
+	ModuleIRCv3CapNotify()
+		: Cap::EventListener(this)
+		, ReloadModule::EventListener(this)
+		, capnotify(this)
+	{
+	}
+
+	void OnCapAddDel(Cap::Capability* cap, bool add) CXX11_OVERRIDE
+	{
+		if (cap->creator == this)
+			return;
+
+		if (cap->creator->ModuleSourceFile == reloadedmod)
+		{
+			if (!add)
+				reloadedcaps.push_back(cap->GetName());
+			return;
+		}
+		Send(cap->GetName(), cap, add);
+	}
+
+	void OnCapValueChange(Cap::Capability* cap) CXX11_OVERRIDE
+	{
+		// The value of a cap has changed, send CAP DEL and CAP NEW with the new value
+		Send(cap->GetName(), cap, false);
+		Send(cap->GetName(), cap, true);
+	}
+
+	void OnReloadModuleSave(Module* mod, ReloadModule::CustomData& cd) CXX11_OVERRIDE
+	{
+		if (mod == this)
+			return;
+		reloadedmod = mod->ModuleSourceFile;
+		// Request callback when reload is complete
+		cd.add(this, NULL);
+	}
+
+	void OnReloadModuleRestore(Module* mod, void* data) CXX11_OVERRIDE
+	{
+		// Reloading can change the set of caps provided by a module so assuming that if the reload succeded all
+		// caps that the module previously provided are available or all were lost if the reload failed is wrong.
+		// Instead, we verify the availability of each cap individually.
+		dynamic_reference_nocheck<Cap::Manager> capmanager(this, "capmanager");
+		if (capmanager)
+		{
+			for (std::vector<std::string>::const_iterator i = reloadedcaps.begin(); i != reloadedcaps.end(); ++i)
+			{
+				const std::string& capname = *i;
+				if (!capmanager->Find(capname))
+					Send(capname, NULL, false);
+			}
+		}
+		reloadedmod.clear();
+		reloadedcaps.clear();
+	}
+
+	Version GetVersion() CXX11_OVERRIDE
+	{
+		return Version("Provides the cap-notify IRCv3.2 extension", VF_VENDOR);
+	}
+};
+
+MODULE_INIT(ModuleIRCv3CapNotify)