* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ * InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/Credits
*
* This program is free but copyrighted software; see
- * the file COPYING for details.
+ * the file COPYING for details.
*
* ---------------------------------------------------
*/
#include "inspircd.h"
-#include <pcre.h>
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
-#include "m_filter.h"
-
-/* $ModDesc: m_filter with regexps */
-/* $CompileFlags: exec("pcre-config --cflags") */
-/* $LinkerFlags: exec("pcre-config --libs") rpath("pcre-config --libs") -lpcre */
-/* $ModDep: m_filter.h */
-
-#ifdef WINDOWS
-#pragma comment(lib, "pcre.lib")
-#endif
-
-class PCREFilter : public FilterResult
+#include "m_regex.h"
+#include "xline.h"
+
+static Module* rxengine = NULL;
+static Module* mymodule = NULL; /* Needed to let RLine send request! */
+static bool ZlineOnMatch = false;
+static std::vector<ZLine *> background_zlines;
+
+/* $ModDesc: RLINE: Regexp user banning. */
+
+class RLine : public XLine
{
public:
- pcre* regexp;
- PCREFilter(pcre* r, const std::string &rea, const std::string &act, long gline_time, const std::string &pat, const std::string &flags)
- : FilterResult(pat, rea, act, gline_time, flags), regexp(r)
- {
- }
+ /** 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(time_t s_time, long d, std::string src, std::string re, std::string regexs)
+ : XLine(s_time, d, src, re, "R")
+ {
+ matchtext = regexs;
+
+ if (!rxengine)
+ {
+ ServerInstance->SNO->WriteToSnoMask('a', "Cannot create regexes until engine is set to a loaded provider!");
+ throw ModuleException("Regex engine not set or loaded!");
+ }
+
+ /* This can throw on failure, but if it does we DONT catch it here, we catch it and display it
+ * where the object is created, we might not ALWAYS want it to output stuff to snomask x all the time
+ */
+ regex = RegexFactoryRequest(mymodule, rxengine, regexs).Create();
+ }
+
+ /** Destructor
+ */
+ ~RLine()
+ {
+ delete regex;
+ }
+
+ bool Matches(User *u)
+ {
+ if (u->exempt)
+ return false;
+
+ std::string compare = u->nick + "!" + u->ident + "@" + u->host + " " + u->fullname;
+ return regex->Matches(compare);
+ }
+
+ bool Matches(const std::string &compare)
+ {
+ return regex->Matches(compare);
+ }
+
+ void Apply(User* u)
+ {
+ if (ZlineOnMatch) {
+ background_zlines.push_back(new ZLine(ServerInstance->Time(), duration ? expiry - ServerInstance->Time() : 0, ServerInstance->Config->ServerName.c_str(), reason.c_str(), u->GetIPString()));
+ }
+ DefaultApply(u, "R", false);
+ }
+
+ void DisplayExpiry()
+ {
+ ServerInstance->SNO->WriteToSnoMask('x',"Removing expired R-line %s (set by %s %ld seconds ago)",
+ this->matchtext.c_str(), this->source.c_str(), (long int)(ServerInstance->Time() - this->set_time));
+ }
+
+ const char* Displayable()
+ {
+ return matchtext.c_str();
+ }
+
+ std::string matchtext;
- PCREFilter()
- {
- }
+ Regex *regex;
};
-class ModuleFilterPCRE : public FilterBase
-{
- std::vector<PCREFilter> filters;
- pcre *re;
- const char *error;
- int erroffset;
- PCREFilter fr;
+/** An XLineFactory specialized to generate RLine* pointers
+ */
+class RLineFactory : public XLineFactory
+{
public:
- ModuleFilterPCRE(InspIRCd* Me)
- : FilterBase(Me, "m_filter_pcre.so")
+ RLineFactory() : XLineFactory("R")
+ {
+ }
+
+ /** Generate a RLine
+ */
+ XLine* Generate(time_t set_time, long duration, std::string source, std::string reason, std::string xline_specific_mask)
{
- OnRehash(NULL,"");
+ return new RLine(set_time, duration, source, reason, xline_specific_mask);
+ }
+ ~RLineFactory()
+ {
}
+};
+
+/** Handle /RLINE
+ * Syntax is same as other lines: RLINE regex_goes_here 1d :reason
+ */
+class CommandRLine : public Command
+{
+ std::string rxengine;
- virtual ~ModuleFilterPCRE()
+ public:
+ CommandRLine(Module* Creator) : Command(Creator,"RLINE", 1, 3)
{
+ flags_needed = 'o'; this->syntax = "<regex> [<rline-duration>] :<reason>";
}
- virtual FilterResult* FilterMatch(User* user, const std::string &text, int flags)
+ CmdResult Handle (const std::vector<std::string>& parameters, User *user)
{
- for (std::vector<PCREFilter>::iterator index = filters.begin(); index != filters.end(); index++)
+
+ if (parameters.size() >= 3)
{
- /* Skip ones that dont apply to us */
+ // Adding - XXX todo make this respect <insane> tag perhaps..
- if (!FilterBase::AppliesToMe(user, dynamic_cast<FilterResult*>(&(*index)), flags))
- continue;
+ long duration = ServerInstance->Duration(parameters[1]);
+ RLine *r = NULL;
+
+ try
+ {
+ r = new RLine(ServerInstance->Time(), duration, user->nick.c_str(), parameters[2].c_str(), parameters[0].c_str());
+ }
+ catch (ModuleException &e)
+ {
+ ServerInstance->SNO->WriteToSnoMask('a',"Could not add RLINE: %s", e.GetReason());
+ }
- if (pcre_exec(index->regexp, NULL, text.c_str(), text.length(), 0, 0, NULL, 0) > -1)
+ if (r)
{
- fr = *index;
- if (index != filters.begin())
+ if (ServerInstance->XLines->AddLine(r, user))
{
- filters.erase(index);
- filters.insert(filters.begin(), fr);
+ if (!duration)
+ {
+ ServerInstance->SNO->WriteToSnoMask('x',"%s added permanent R-line for %s: %s", user->nick.c_str(), parameters[0].c_str(), parameters[2].c_str());
+ }
+ else
+ {
+ time_t c_requires_crap = duration + ServerInstance->Time();
+ ServerInstance->SNO->WriteToSnoMask('x', "%s added timed R-line for %s to expire on %s: %s", user->nick.c_str(), parameters[0].c_str(), ServerInstance->TimeString(c_requires_crap).c_str(), parameters[2].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());
}
- return &fr;
}
}
- return NULL;
- }
-
- virtual bool DeleteFilter(const std::string &freeform)
- {
- for (std::vector<PCREFilter>::iterator i = filters.begin(); i != filters.end(); i++)
+ else
{
- if (i->freeform == freeform)
+ if (ServerInstance->XLines->DelLine(parameters[0].c_str(), "R", user))
{
- pcre_free((*i).regexp);
- filters.erase(i);
- return true;
+ ServerInstance->SNO->WriteToSnoMask('x',"%s removed R-line on %s",user->nick.c_str(),parameters[0].c_str());
+ }
+ else
+ {
+ user->WriteServ("NOTICE %s :*** R-Line %s not found in list, try /stats R.",user->nick.c_str(),parameters[0].c_str());
}
}
- return false;
+
+ return CMD_SUCCESS;
}
- virtual void SyncFilters(Module* proto, void* opaque)
+ RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
{
- for (std::vector<PCREFilter>::iterator i = filters.begin(); i != filters.end(); i++)
- {
- this->SendFilter(proto, opaque, &(*i));
- }
+ return ROUTE_BROADCAST;
+ }
+};
+
+class ModuleRLine : public Module
+{
+ private:
+ CommandRLine r;
+ RLineFactory f;
+ bool MatchOnNickChange;
+ std::string RegexEngine;
+
+ public:
+ ModuleRLine() : r(this)
+ {
+ mymodule = this;
+ OnRehash(NULL);
+
+ ServerInstance->Modules->UseInterface("RegularExpression");
+
+ ServerInstance->AddCommand(&r);
+ ServerInstance->XLines->RegisterFactory(&f);
+
+ Implementation eventlist[] = { I_OnUserConnect, I_OnRehash, I_OnUserPostNick, I_OnLoadModule, I_OnStats, I_OnBackgroundTimer };
+ ServerInstance->Modules->Attach(eventlist, this, 6);
+
+ }
+
+ virtual ~ModuleRLine()
+ {
+ ServerInstance->Modules->DoneWithInterface("RegularExpression");
+ ServerInstance->XLines->DelAll("R");
+ ServerInstance->XLines->UnregisterFactory(&f);
+ }
+
+ virtual Version GetVersion()
+ {
+ return Version("RLINE: Regexp user banning.", VF_COMMON | VF_VENDOR);
}
- virtual std::pair<bool, std::string> AddFilter(const std::string &freeform, const std::string &type, const std::string &reason, long duration, const std::string &flags)
+ virtual void OnUserConnect(User* user)
{
- for (std::vector<PCREFilter>::iterator i = filters.begin(); i != filters.end(); i++)
+ // Apply lines on user connect
+ XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
+
+ if (rl)
{
- if (i->freeform == freeform)
- {
- return std::make_pair(false, "Filter already exists");
- }
+ // Bang. :P
+ rl->Apply(user);
}
+ }
- re = pcre_compile(freeform.c_str(),0,&error,&erroffset,NULL);
+ virtual void OnRehash(User *user)
+ {
+ ConfigReader Conf;
- if (!re)
+ if (!Conf.ReadFlag("rline", "zlineonmatch", 0) && ZlineOnMatch)
+ background_zlines.clear();
+
+ MatchOnNickChange = Conf.ReadFlag("rline", "matchonnickchange", 0);
+ ZlineOnMatch = Conf.ReadFlag("rline", "zlineonmatch", 0);
+ std::string newrxengine = Conf.ReadValue("rline", "engine", 0);
+
+ if (!RegexEngine.empty())
{
- ServerInstance->Log(DEFAULT,"Error in regular expression: %s at offset %d: %s\n", freeform.c_str(), erroffset, error);
- ServerInstance->Log(DEFAULT,"Regular expression %s not loaded.", freeform.c_str());
- return std::make_pair(false, "Error in regular expression at offset " + ConvToStr(erroffset) + ": "+error);
+ 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");
}
- else
+ rxengine = 0;
+ RegexEngine = newrxengine;
+ modulelist* ml = ServerInstance->Modules->FindInterface("RegularExpression");
+ if (ml)
+ {
+ for (modulelist::iterator i = ml->begin(); i != ml->end(); ++i)
+ {
+ if (RegexNameRequest(this, *i).result == newrxengine)
+ {
+ ServerInstance->SNO->WriteToSnoMask('a', "R-Line now using engine '%s'", RegexEngine.c_str());
+ rxengine = *i;
+ }
+ }
+ }
+ if (!rxengine)
{
- filters.push_back(PCREFilter(re, reason, type, duration, freeform, flags));
- return std::make_pair(true, "");
+ ServerInstance->SNO->WriteToSnoMask('a', "WARNING: Regex engine '%s' is not loaded - R-Line functionality disabled until this is corrected.", RegexEngine.c_str());
}
}
- virtual void OnRehash(User* user, const std::string ¶meter)
- {
- ConfigReader MyConf(ServerInstance);
+ virtual ModResult OnStats(char symbol, User* user, string_list &results)
+ {
+ if (symbol != 'R')
+ return MOD_RES_PASSTHRU;
- for (int index = 0; index < MyConf.Enumerate("keyword"); index++)
+ ServerInstance->XLines->InvokeStats("R", 223, user, results);
+ return MOD_RES_DENY;
+ }
+
+ virtual void OnLoadModule(Module* mod)
+ {
+ if (ServerInstance->Modules->ModuleHasInterface(mod, "RegularExpression"))
{
- this->DeleteFilter(MyConf.ReadValue("keyword", "pattern", index));
+ std::string rxname = RegexNameRequest(this, mod).result;
+ if (rxname == RegexEngine)
+ {
+ ServerInstance->SNO->WriteToSnoMask('a', "R-Line now using engine '%s'", RegexEngine.c_str());
+ rxengine = mod;
+ }
+ }
+ }
- std::string pattern = MyConf.ReadValue("keyword", "pattern", index);
- std::string reason = MyConf.ReadValue("keyword", "reason", index);
- std::string action = MyConf.ReadValue("keyword", "action", index);
- std::string flags = MyConf.ReadValue("keyword", "flags", index);
- long gline_time = ServerInstance->Duration(MyConf.ReadValue("keyword", "duration", index));
- if (action.empty())
- action = "none";
- if (flags.empty())
- flags = "*";
+ virtual void OnUserPostNick(User *user, const std::string &oldnick)
+ {
+ if (!IS_LOCAL(user))
+ return;
- re = pcre_compile(pattern.c_str(),0,&error,&erroffset,NULL);
+ if (!MatchOnNickChange)
+ return;
- if (!re)
- {
- ServerInstance->Log(DEFAULT,"Error in regular expression: %s at offset %d: %s\n", pattern.c_str(), erroffset, error);
- ServerInstance->Log(DEFAULT,"Regular expression %s not loaded.", pattern.c_str());
- }
- else
- {
- filters.push_back(PCREFilter(re, reason, action, gline_time, pattern, flags));
- ServerInstance->Log(DEFAULT,"Regular expression %s loaded.", pattern.c_str());
- }
+ XLine *rl = ServerInstance->XLines->MatchesLine("R", user);
+
+ if (rl)
+ {
+ // Bang! :D
+ rl->Apply(user);
}
}
- virtual int OnStats(char symbol, User* user, string_list &results)
+ virtual void OnBackgroundTimer(time_t curtime)
{
- if (symbol == 's')
+ if (!ZlineOnMatch) return;
+ for (std::vector<ZLine *>::iterator i = background_zlines.begin(); i != background_zlines.end(); i++)
{
- std::string sn = ServerInstance->Config->ServerName;
- for (std::vector<PCREFilter>::iterator i = filters.begin(); i != filters.end(); i++)
+ ZLine *zl = *i;
+ if (ServerInstance->XLines->AddLine(zl,NULL))
{
- results.push_back(sn+" 223 "+user->nick+" :REGEXP:"+i->freeform+" "+i->flags+" "+i->action+" "+ConvToStr(i->gline_time)+" :"+i->reason);
+ ServerInstance->SNO->WriteToSnoMask('x',"Z-line added due to R-line match on *@%s%s%s: %s",
+ zl->ipaddr.c_str(), zl->duration ? " to expire on " : "", zl->duration ? ServerInstance->TimeString(zl->expiry).c_str() : "", zl->reason.c_str());
+ ServerInstance->XLines->ApplyLines();
}
}
- return 0;
+ background_zlines.clear();
}
+
};
-MODULE_INIT(ModuleFilterPCRE)
+MODULE_INIT(ModuleRLine)