Make regex providers load correctly. Move m_rline to use the regex providers, and also move m_rline out of extras/. Document provider modules, <rline:engine> and particularly the uselessness of <rline engine="glob">.

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@10573 e03df62e-2008-0410-955e-edbf42e46eb7

1 files changed, 315 insertions, 0 deletions

diff --git a/src/modules/m_rline.cpp b/src/modules/m_rline.cpp
new file mode 100644
index 000000000..e6340cc0f
--- /dev/null
+++ b/src/modules/m_rline.cpp
@@ -0,0 +1,315 @@
+/*       +------------------------------------+
+ *       | Inspire Internet Relay Chat Daemon |
+ *       +------------------------------------+
+ *
+ *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
+ *
+ * This program is free but copyrighted software; see
+ *            the file COPYING for details.
+ *
+ * ---------------------------------------------------
+ */
+
+#include "inspircd.h"
+#include "m_regex.h"
+#include "xline.h"
+
+static Module* rxengine = 0;
+static Module* mymodule = 0; /* Needed to let RLine send request! */
+
+/* $ModDesc: RLINE: Regexp user banning. */
+
+class CoreExport RLine : public XLine
+{
+ public:
+
+	/** Create a R-Line.
+	 * @param s_time The set time
+	 * @param d The duration of the xline
+	 * @param src The sender of the xline
+	 * @param re The reason of the xline
+	 * @param regex Pattern to match with
+	 * @
+	 */
+	RLine(InspIRCd* Instance, time_t s_time, long d, const char* src, const char* re, const char* regexs) : XLine(Instance, s_time, d, src, re, "R")
+	{
+		matchtext = regexs;
+
+		if (!rxengine)
+		{
+			ServerInstance->SNO->WriteToSnoMask('x', "Cannot create regexes until engine is set to a loaded provider!");
+			throw ModuleException("Regex engine not set or loaded!");
+		}
+
+		try {
+			regex = RegexFactoryRequest(mymodule, rxengine, regexs).Create();
+		} catch (ModuleException& ex) {
+			ServerInstance->SNO->WriteToSnoMask('x', "Bad regex: %s", ex.GetReason());
+			throw;
+		}
+	}
+
+	/** Destructor
+	 */
+	~RLine()
+	{
+		delete regex;
+	}
+
+	bool Matches(User *u)
+	{
+		std::string compare = std::string(u->nick) + "!" + u->ident + "@" + u->host + " " + u->fullname;
+
+		ServerInstance->Logs->Log("m_rline",DEBUG, "Matching " + matchtext + " against string " + compare);
+
+		if (regex->Matches(compare))
+		{
+			// Bang. :D
+			return true;
+		}
+
+		return false;
+	}
+
+	bool Matches(const std::string &compare)
+	{
+		if (regex->Matches(compare))
+		{
+			// Bang. :D
+			return true;
+		}
+
+		return false;
+	}
+
+	void Apply(User* u)
+	{
+		DefaultApply(u, "R", true);
+	}
+
+	void DisplayExpiry()
+	{
+		ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed R-Line %s (set by %s %ld seconds ago)", this->matchtext.c_str(), this->source, this->duration);
+	}
+
+	const char* Displayable()
+	{
+		return matchtext.c_str();
+	}
+
+	std::string matchtext;
+
+	Regex *regex;
+};
+
+
+/** An XLineFactory specialized to generate RLine* pointers
+ */
+class CoreExport RLineFactory : public XLineFactory
+{
+ public:
+	RLineFactory(InspIRCd* Instance) : XLineFactory(Instance, "R") { }
+
+	/** Generate a RLine
+	 */
+	XLine* Generate(time_t set_time, long duration, const char* source, const char* reason, const char* xline_specific_mask)
+	{
+		return new RLine(ServerInstance, set_time, duration, source, reason, xline_specific_mask);
+	}
+};
+
+/** Handle /RLINE
+ * Syntax is same as other lines: RLINE regex_goes_here 1d :reason
+ */
+class CommandRLine : public Command
+{
+	std::string rxengine;
+
+ public:
+	CommandRLine (InspIRCd* Instance) : Command(Instance,"RLINE", "o", 1)
+	{
+		this->source = "m_rline.so";
+	}
+
+	CmdResult Handle (const std::vector<std::string>& parameters, User *user)
+	{
+
+		if (parameters.size() >= 3)
+		{
+			// Adding - XXX todo make this respect <insane> tag perhaps..
+
+			long duration = ServerInstance->Duration(parameters[1]);
+			RLine *r = NULL;
+
+			try
+			{
+				r = new RLine(ServerInstance, ServerInstance->Time(), duration, user->nick.c_str(), parameters[2].c_str(), parameters[0].c_str());
+			}
+			catch (...)
+			{
+				; // Do nothing. If we get here, the regex was fucked up, and they already got told it fucked up.
+			}
+
+			if (r)
+			{
+				if (ServerInstance->XLines->AddLine(r, user))
+				{
+					if (!duration)
+					{
+						ServerInstance->SNO->WriteToSnoMask('x',"%s added permanent R-Line for %s.", user->nick.c_str(), parameters[0].c_str());
+					}
+					else
+					{
+						time_t c_requires_crap = duration + ServerInstance->Time();
+						ServerInstance->SNO->WriteToSnoMask('x', "%s added timed R-Line for %s, expires on %s", user->nick.c_str(), parameters[0].c_str(),
+								ServerInstance->TimeString(c_requires_crap).c_str());
+					}
+
+					ServerInstance->XLines->ApplyLines();
+				}
+				else
+				{
+					delete r;
+					user->WriteServ("NOTICE %s :*** R-Line for %s already exists", user->nick.c_str(), parameters[0].c_str());
+				}
+			}
+		}
+		else
+		{
+			if (ServerInstance->XLines->DelLine(parameters[0].c_str(), "R", user))
+			{
+				ServerInstance->SNO->WriteToSnoMask('x',"%s Removed R-Line on %s.",user->nick.c_str(),parameters[0].c_str());
+			}
+			else
+			{
+				// XXX todo implement stats
+				user->WriteServ("NOTICE %s :*** R-Line %s not found in list, try /stats g.",user->nick.c_str(),parameters[0].c_str());
+			}
+		}
+
+		return CMD_SUCCESS;
+	}
+};
+
+class ModuleRLine : public Module
+{
+ private:
+	CommandRLine *r;
+	RLineFactory *f;
+	bool MatchOnNickChange;
+	std::string RegexEngine;
+
+ public:
+	ModuleRLine(InspIRCd* Me) : Module(Me)
+	{
+		mymodule = this;
+		OnRehash(NULL, "");
+
+		Me->Modules->UseInterface("RegularExpression");
+
+		// Create a new command
+		r = new CommandRLine(ServerInstance);
+		ServerInstance->AddCommand(r);
+
+		f = new RLineFactory(ServerInstance);
+		ServerInstance->XLines->RegisterFactory(f);
+
+		Implementation eventlist[] = { I_OnUserConnect, I_OnRehash, I_OnUserPostNick, I_OnLoadModule };
+		ServerInstance->Modules->Attach(eventlist, this, 3);
+
+	}
+
+	virtual ~ModuleRLine()
+	{
+		ServerInstance->Modules->DoneWithInterface("RegularExpression");
+		ServerInstance->XLines->DelAll("R");
+		ServerInstance->XLines->UnregisterFactory(f);
+	}
+
+	virtual Version GetVersion()
+	{
+		return Version("$Id$", VF_COMMON | VF_VENDOR, API_VERSION);
+	}
+
+	virtual void OnUserConnect(User* user)
+	{
+		// Apply lines on user connect
+		XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
+
+		if (rl)
+		{
+			// Bang. :P
+			rl->Apply(user);
+		}
+	}
+
+	virtual void OnRehash(User *user, const std::string &parameter)
+	{
+		ConfigReader Conf(ServerInstance);
+
+		MatchOnNickChange = Conf.ReadFlag("rline", "matchonnickchange", 0);
+
+		std::string newrxengine;
+
+		newrxengine = Conf.ReadValue("rline", "engine", 0);
+
+		if (!RegexEngine.empty())
+		{
+			if (RegexEngine == newrxengine)
+				return;
+			ServerInstance->SNO->WriteToSnoMask('x', "Dumping all R-Lines due to regex engine change (was '%s', now '%s')", RegexEngine.c_str(), newrxengine.c_str());
+			ServerInstance->XLines->DelAll("R");
+		}
+		rxengine = 0;
+		RegexEngine = newrxengine;
+		modulelist* ml = ServerInstance->Modules->FindInterface("RegularExpression");
+		for (modulelist::iterator i = ml->begin(); i != ml->end(); ++i)
+		{
+			std::string rxname = RegexNameRequest(this, *i).Send();
+			if (rxname == newrxengine)
+			{
+				ServerInstance->SNO->WriteToSnoMask('x', "R-Line now using engine '%s'", RegexEngine.c_str());
+				rxengine = *i;
+			}
+		}
+		if (!rxengine)
+		{
+			ServerInstance->SNO->WriteToSnoMask('x', "WARNING: Regex engine '%s' is not loaded - R-Line functionality disabled until this is corrected.", RegexEngine.c_str());
+		}
+	}
+
+	virtual void OnLoadModule(Module* mod, const std::string& name)
+	{
+		if (ServerInstance->Modules->ModuleHasInterface(mod, "RegularExpression"))
+		{
+			std::string rxname = RegexNameRequest(this, mod).Send();
+			if (rxname == RegexEngine)
+			{
+				ServerInstance->SNO->WriteToSnoMask('x', "R-Line now using engine '%s'", RegexEngine.c_str());
+				rxengine = mod;
+			}
+		}
+	}
+
+	virtual void OnUserPostNick(User *user, const std::string &oldnick)
+	{
+		if (!IS_LOCAL(user))
+			return;
+
+		if (!MatchOnNickChange)
+			return;
+
+		XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
+
+		if (rl)
+		{
+			// Bang! :D
+			rl->Apply(user);
+		}
+	}
+
+};
+
+MODULE_INIT(ModuleRLine)
+