X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fm_filter.cpp;h=d3d3ef2185f30c041defb81fce553e3ce23d5e29;hb=93fa544b2671b078cf81ac04fbb4b48d5e2d1677;hp=d138c44cd6229b819a5a9aacb1f69d81c86c4dfd;hpb=b36ce84c7da93f680fc397bcb4c877abe063eaaa;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/m_filter.cpp b/src/modules/m_filter.cpp index d138c44cd..d3d3ef218 100644 --- a/src/modules/m_filter.cpp +++ b/src/modules/m_filter.cpp @@ -23,10 +23,9 @@ #include "inspircd.h" #include "xline.h" #include "modules/regex.h" - -/* $ModDesc: Text (spam) filtering */ - -class ModuleFilter; +#include "modules/server.h" +#include "modules/shun.h" +#include "modules/stats.h" enum FilterFlags { @@ -42,16 +41,18 @@ enum FilterAction FA_BLOCK, FA_SILENT, FA_KILL, + FA_SHUN, FA_NONE }; class FilterResult { public: + Regex* regex; std::string freeform; std::string reason; FilterAction action; - long gline_time; + long duration; bool flag_no_opers; bool flag_part_message; @@ -60,9 +61,15 @@ class FilterResult bool flag_notice; bool flag_strip_color; - FilterResult(const std::string free, const std::string &rea, FilterAction act, long gt, const std::string &fla) : - freeform(free), reason(rea), action(act), gline_time(gt) + FilterResult(dynamic_reference& RegexEngine, const std::string& free, const std::string& rea, FilterAction act, long gt, const std::string& fla) + : freeform(free) + , reason(rea) + , action(act) + , duration(gt) { + if (!RegexEngine) + throw ModuleException("Regex module implementing '"+RegexEngine.GetProvider()+"' is not loaded!"); + regex = RegexEngine->Create(free); this->FillFlags(fla); } @@ -144,27 +151,20 @@ class CommandFilter : public Command : Command(f, "FILTER", 1, 5) { flags_needed = 'o'; - this->syntax = " [] :"; + this->syntax = " [] :"; } - CmdResult Handle(const std::vector&, User*); + CmdResult Handle(const std::vector& , User* ) CXX11_OVERRIDE; - RouteDescriptor GetRouting(User* user, const std::vector& parameters) + RouteDescriptor GetRouting(User* user, const std::vector& parameters) CXX11_OVERRIDE { return ROUTE_BROADCAST; } }; -class ImplFilter : public FilterResult +class ModuleFilter : public Module, public ServerEventListener, public Stats::EventListener { - public: - Regex* regex; + typedef insp::flat_set ExemptTargetSet; - ImplFilter(ModuleFilter* mymodule, const std::string &rea, FilterAction act, long glinetime, const std::string &pat, const std::string &flgs); -}; - - -class ModuleFilter : public Module -{ bool initing; RegexFactory* factory; void FreeFilters(); @@ -173,25 +173,28 @@ class ModuleFilter : public Module CommandFilter filtcommand; dynamic_reference RegexEngine; - std::vector filters; + std::vector filters; int flags; - std::set exemptfromfilter; // List of channel names excluded from filtering. + // List of channel names excluded from filtering. + ExemptTargetSet exemptedchans; + + // List of target nicknames excluded from filtering. + ExemptTargetSet exemptednicks; ModuleFilter(); - void init() CXX11_OVERRIDE; - CullResult cull(); - ModResult OnUserPreMessage(User* user, void* dest, int target_type, std::string& text, char status, CUList& exempt_list, MessageType msgtype) CXX11_OVERRIDE; + CullResult cull() CXX11_OVERRIDE; + ModResult OnUserPreMessage(User* user, const MessageTarget& target, MessageDetails& details) CXX11_OVERRIDE; FilterResult* FilterMatch(User* user, const std::string &text, int flags); bool DeleteFilter(const std::string &freeform); std::pair AddFilter(const std::string &freeform, FilterAction type, const std::string &reason, long duration, const std::string &flags); - void OnRehash(User* user) CXX11_OVERRIDE; + void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE; Version GetVersion() CXX11_OVERRIDE; std::string EncodeFilter(FilterResult* filter); FilterResult DecodeFilter(const std::string &data); - void OnSyncNetwork(Module* proto, void* opaque) CXX11_OVERRIDE; + void OnSyncNetwork(ProtocolInterface::Server& server) CXX11_OVERRIDE; void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata) CXX11_OVERRIDE; - ModResult OnStats(char symbol, User* user, string_list &results) CXX11_OVERRIDE; + ModResult OnStats(Stats::Context& stats) CXX11_OVERRIDE; ModResult OnPreCommand(std::string &command, std::vector ¶meters, LocalUser *user, bool validated, const std::string &original_line) CXX11_OVERRIDE; void OnUnloadModule(Module* mod) CXX11_OVERRIDE; bool AppliesToMe(User* user, FilterResult* filter, int flags); @@ -231,11 +234,14 @@ CmdResult CommandFilter::Handle(const std::vector ¶meters, User if (!ModuleFilter::StringToFilterAction(parameters[1], type)) { - user->WriteNotice("*** Invalid filter type '" + parameters[1] + "'. Supported types are 'gline', 'none', 'block', 'silent' and 'kill'."); + if (ServerInstance->XLines->GetFactory("SHUN")) + user->WriteNotice("*** Invalid filter type '" + parameters[1] + "'. Supported types are 'gline', 'none', 'block', 'silent', 'kill', and 'shun'."); + else + user->WriteNotice("*** Invalid filter type '" + parameters[1] + "'. Supported types are 'gline', 'none', 'block', 'silent', and 'kill'."); return CMD_FAILURE; } - if (type == FA_GLINE) + if (type == FA_GLINE || type == FA_SHUN) { if (parameters.size() >= 5) { @@ -244,7 +250,7 @@ CmdResult CommandFilter::Handle(const std::vector ¶meters, User } else { - user->WriteNotice("*** Not enough parameters: When setting a gline type filter, a gline duration must be specified as the third parameter."); + user->WriteNotice("*** Not enough parameters: When setting a gline or shun type filter, a duration must be specified as the third parameter."); return CMD_FAILURE; } } @@ -296,18 +302,14 @@ bool ModuleFilter::AppliesToMe(User* user, FilterResult* filter, int iflags) } ModuleFilter::ModuleFilter() - : initing(true), filtcommand(this), RegexEngine(this, "regex") + : ServerEventListener(this) + , Stats::EventListener(this) + , initing(true) + , filtcommand(this) + , RegexEngine(this, "regex") { } -void ModuleFilter::init() -{ - ServerInstance->Modules->AddService(filtcommand); - Implementation eventlist[] = { I_OnPreCommand, I_OnStats, I_OnSyncNetwork, I_OnDecodeMetaData, I_OnUserPreMessage, I_OnRehash, I_OnUnloadModule }; - ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation)); - OnRehash(NULL); -} - CullResult ModuleFilter::cull() { FreeFilters(); @@ -316,33 +318,37 @@ CullResult ModuleFilter::cull() void ModuleFilter::FreeFilters() { - for (std::vector::const_iterator i = filters.begin(); i != filters.end(); ++i) + for (std::vector::const_iterator i = filters.begin(); i != filters.end(); ++i) delete i->regex; filters.clear(); } -ModResult ModuleFilter::OnUserPreMessage(User* user, void* dest, int target_type, std::string& text, char status, CUList& exempt_list, MessageType msgtype) +ModResult ModuleFilter::OnUserPreMessage(User* user, const MessageTarget& msgtarget, MessageDetails& details) { - /* Leave ulines alone */ - if ((ServerInstance->ULine(user->server)) || (!IS_LOCAL(user))) + // Leave remote users and servers alone + if (!IS_LOCAL(user)) return MOD_RES_PASSTHRU; - flags = (msgtype == MSG_PRIVMSG) ? FLAG_PRIVMSG : FLAG_NOTICE; + flags = (details.type == MSG_PRIVMSG) ? FLAG_PRIVMSG : FLAG_NOTICE; - FilterResult* f = this->FilterMatch(user, text, flags); + FilterResult* f = this->FilterMatch(user, details.text, flags); if (f) { std::string target; - if (target_type == TYPE_USER) + if (msgtarget.type == MessageTarget::TYPE_USER) { - User* t = (User*)dest; + User* t = msgtarget.Get(); + // Check if the target nick is exempted, if yes, ignore this message + if (exemptednicks.count(t->nick)) + return MOD_RES_PASSTHRU; + target = t->nick; } - else if (target_type == TYPE_CHANNEL) + else if (msgtarget.type == MessageTarget::TYPE_CHANNEL) { - Channel* t = (Channel*)dest; - if (exemptfromfilter.find(t->name) != exemptfromfilter.end()) + Channel* t = msgtarget.Get(); + if (exemptedchans.count(t->name)) return MOD_RES_PASSTHRU; target = t->name; @@ -350,25 +356,38 @@ ModResult ModuleFilter::OnUserPreMessage(User* user, void* dest, int target_type if (f->action == FA_BLOCK) { ServerInstance->SNO->WriteGlobalSno('a', "FILTER: "+user->nick+" had their message filtered, target was "+target+": "+f->reason); - if (target_type == TYPE_CHANNEL) - user->WriteNumeric(404, "%s %s :Message to channel blocked and opers notified (%s)",user->nick.c_str(), target.c_str(), f->reason.c_str()); + if (msgtarget.type == MessageTarget::TYPE_CHANNEL) + user->WriteNumeric(ERR_CANNOTSENDTOCHAN, target, InspIRCd::Format("Message to channel blocked and opers notified (%s)", f->reason.c_str())); else user->WriteNotice("Your message to "+target+" was blocked and opers notified: "+f->reason); } else if (f->action == FA_SILENT) { - if (target_type == TYPE_CHANNEL) - user->WriteNumeric(404, "%s %s :Message to channel blocked (%s)",user->nick.c_str(), target.c_str(), f->reason.c_str()); + if (msgtarget.type == MessageTarget::TYPE_CHANNEL) + user->WriteNumeric(ERR_CANNOTSENDTOCHAN, target, InspIRCd::Format("Message to channel blocked (%s)", f->reason.c_str())); else user->WriteNotice("Your message to "+target+" was blocked: "+f->reason); } else if (f->action == FA_KILL) { + ServerInstance->SNO->WriteGlobalSno('a', "FILTER: " + user->nick + " had their message filtered and was killed, target was " + target + ": " + f->reason); ServerInstance->Users->QuitUser(user, "Filtered: " + f->reason); } + else if (f->action == FA_SHUN && (ServerInstance->XLines->GetFactory("SHUN"))) + { + Shun* sh = new Shun(ServerInstance->Time(), f->duration, ServerInstance->Config->ServerName.c_str(), f->reason.c_str(), user->GetIPString()); + ServerInstance->SNO->WriteGlobalSno('a', "FILTER: " + user->nick + " had their message filtered and was shunned, target was " + target + ": " + f->reason); + if (ServerInstance->XLines->AddLine(sh, NULL)) + { + ServerInstance->XLines->ApplyLines(); + } + else + delete sh; + } else if (f->action == FA_GLINE) { - GLine* gl = new GLine(ServerInstance->Time(), f->gline_time, ServerInstance->Config->ServerName.c_str(), f->reason.c_str(), "*", user->GetIPString()); + GLine* gl = new GLine(ServerInstance->Time(), f->duration, ServerInstance->Config->ServerName.c_str(), f->reason.c_str(), "*", user->GetIPString()); + ServerInstance->SNO->WriteGlobalSno('a', "FILTER: " + user->nick + " had their message filtered and was G-Lined, target was " + target + ": " + f->reason); if (ServerInstance->XLines->AddLine(gl,NULL)) { ServerInstance->XLines->ApplyLines(); @@ -377,7 +396,7 @@ ModResult ModuleFilter::OnUserPreMessage(User* user, void* dest, int target_type delete gl; } - ServerInstance->Logs->Log("FILTER", LOG_DEFAULT, "FILTER: "+ user->nick + " had their message filtered, target was " + target + ": " + f->reason + " Action: " + ModuleFilter::FilterActionToString(f->action)); + ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, user->nick + " had their message filtered, target was " + target + ": " + f->reason + " Action: " + ModuleFilter::FilterActionToString(f->action)); return MOD_RES_DENY; } return MOD_RES_PASSTHRU; @@ -385,7 +404,7 @@ ModResult ModuleFilter::OnUserPreMessage(User* user, void* dest, int target_type ModResult ModuleFilter::OnPreCommand(std::string &command, std::vector ¶meters, LocalUser *user, bool validated, const std::string &original_line) { - if (validated && IS_LOCAL(user)) + if (validated) { flags = 0; bool parting; @@ -405,7 +424,7 @@ ModResult ModuleFilter::OnPreCommand(std::string &command, std::vectoraction == FA_GLINE) { /* Note: We gline *@IP so that if their host doesnt resolve the gline still applies. */ - GLine* gl = new GLine(ServerInstance->Time(), f->gline_time, ServerInstance->Config->ServerName.c_str(), f->reason.c_str(), "*", user->GetIPString()); + GLine* gl = new GLine(ServerInstance->Time(), f->duration, ServerInstance->Config->ServerName.c_str(), f->reason.c_str(), "*", user->GetIPString()); + ServerInstance->SNO->WriteGlobalSno('a', "FILTER: " + user->nick + " had their " + command + " message filtered and was G-Lined: " + f->reason); if (ServerInstance->XLines->AddLine(gl,NULL)) { ServerInstance->XLines->ApplyLines(); @@ -449,21 +469,43 @@ ModResult ModuleFilter::OnPreCommand(std::string &command, std::vectoraction == FA_SHUN && (ServerInstance->XLines->GetFactory("SHUN"))) + { + /* Note: We shun *!*@IP so that if their host doesnt resolve the shun still applies. */ + Shun* sh = new Shun(ServerInstance->Time(), f->duration, ServerInstance->Config->ServerName.c_str(), f->reason.c_str(), user->GetIPString()); + ServerInstance->SNO->WriteGlobalSno('a', "FILTER: " + user->nick + " had their " + command + " message filtered and was shunned: " + f->reason); + if (ServerInstance->XLines->AddLine(sh, NULL)) + { + ServerInstance->XLines->ApplyLines(); + } + else + delete sh; + } return MOD_RES_DENY; } } return MOD_RES_PASSTHRU; } -void ModuleFilter::OnRehash(User* user) +void ModuleFilter::ReadConfig(ConfigStatus& status) { ConfigTagList tags = ServerInstance->Config->ConfTags("exemptfromfilter"); - exemptfromfilter.clear(); + exemptedchans.clear(); + exemptednicks.clear(); + for (ConfigIter i = tags.first; i != tags.second; ++i) { - std::string chan = i->second->getString("channel"); - if (!chan.empty()) - exemptfromfilter.insert(chan); + ConfigTag* tag = i->second; + + // If "target" is not found, try the old "channel" key to keep compatibility with 2.0 configs + const std::string target = tag->getString("target", tag->getString("channel")); + if (!target.empty()) + { + if (target[0] == '#') + exemptedchans.insert(target); + else + exemptednicks.insert(target); + } } std::string newrxengine = ServerInstance->Config->ConfValue("filteropts")->getString("engine"); @@ -512,7 +554,7 @@ std::string ModuleFilter::EncodeFilter(FilterResult* filter) if (*n == ' ') *n = '\7'; - stream << x << " " << FilterActionToString(filter->action) << " " << filter->GetFlags() << " " << filter->gline_time << " :" << filter->reason; + stream << x << " " << FilterActionToString(filter->action) << " " << filter->GetFlags() << " " << filter->duration << " :" << filter->reason; return stream.str(); } @@ -532,7 +574,7 @@ FilterResult ModuleFilter::DecodeFilter(const std::string &data) if (c != 0) throw ModuleException("Invalid flag: '" + std::string(1, c) + "'"); - tokens.GetToken(res.gline_time); + tokens.GetToken(res.duration); tokens.GetToken(res.reason); /* Hax to allow spaces in the freeform without changing the design of the irc protocol */ @@ -543,11 +585,11 @@ FilterResult ModuleFilter::DecodeFilter(const std::string &data) return res; } -void ModuleFilter::OnSyncNetwork(Module* proto, void* opaque) +void ModuleFilter::OnSyncNetwork(ProtocolInterface::Server& server) { - for (std::vector::iterator i = filters.begin(); i != filters.end(); ++i) + for (std::vector::iterator i = filters.begin(); i != filters.end(); ++i) { - proto->ProtoSendMetaData(opaque, NULL, "filter", EncodeFilter(&(*i))); + server.SendMetaData("filter", EncodeFilter(&(*i))); } } @@ -558,31 +600,23 @@ void ModuleFilter::OnDecodeMetaData(Extensible* target, const std::string &extna try { FilterResult data = DecodeFilter(extdata); - this->AddFilter(data.freeform, data.action, data.reason, data.gline_time, data.GetFlags()); + this->AddFilter(data.freeform, data.action, data.reason, data.duration, data.GetFlags()); } catch (ModuleException& e) { - ServerInstance->Logs->Log("m_filter", LOG_DEBUG, "Error when unserializing filter: " + std::string(e.GetReason())); + ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Error when unserializing filter: " + e.GetReason()); } } } -ImplFilter::ImplFilter(ModuleFilter* mymodule, const std::string &rea, FilterAction act, long glinetime, const std::string &pat, const std::string &flgs) - : FilterResult(pat, rea, act, glinetime, flgs) -{ - if (!mymodule->RegexEngine) - throw ModuleException("Regex module implementing '"+mymodule->RegexEngine.GetProvider()+"' is not loaded!"); - regex = mymodule->RegexEngine->Create(pat); -} - FilterResult* ModuleFilter::FilterMatch(User* user, const std::string &text, int flgs) { static std::string stripped_text; stripped_text.clear(); - for (std::vector::iterator index = filters.begin(); index != filters.end(); index++) + for (std::vector::iterator i = filters.begin(); i != filters.end(); ++i) { - FilterResult* filter = dynamic_cast(&(*index)); + FilterResult* filter = &*i; /* Skip ones that dont apply to us */ if (!AppliesToMe(user, filter, flgs)) @@ -594,20 +628,15 @@ FilterResult* ModuleFilter::FilterMatch(User* user, const std::string &text, int InspIRCd::StripColor(stripped_text); } - //ServerInstance->Logs->Log("m_filter", LOG_DEBUG, "Match '%s' against '%s'", text.c_str(), index->freeform.c_str()); - if (index->regex->Matches(filter->flag_strip_color ? stripped_text : text)) - { - //ServerInstance->Logs->Log("m_filter", LOG_DEBUG, "MATCH"); - return &*index; - } - //ServerInstance->Logs->Log("m_filter", LOG_DEBUG, "NO MATCH"); + if (filter->regex->Matches(filter->flag_strip_color ? stripped_text : text)) + return filter; } return NULL; } bool ModuleFilter::DeleteFilter(const std::string &freeform) { - for (std::vector::iterator i = filters.begin(); i != filters.end(); i++) + for (std::vector::iterator i = filters.begin(); i != filters.end(); i++) { if (i->freeform == freeform) { @@ -621,7 +650,7 @@ bool ModuleFilter::DeleteFilter(const std::string &freeform) std::pair ModuleFilter::AddFilter(const std::string &freeform, FilterAction type, const std::string &reason, long duration, const std::string &flgs) { - for (std::vector::iterator i = filters.begin(); i != filters.end(); i++) + for (std::vector::iterator i = filters.begin(); i != filters.end(); i++) { if (i->freeform == freeform) { @@ -631,11 +660,11 @@ std::pair ModuleFilter::AddFilter(const std::string &freeform try { - filters.push_back(ImplFilter(this, reason, type, duration, freeform, flgs)); + filters.push_back(FilterResult(RegexEngine, freeform, reason, type, duration, flgs)); } catch (ModuleException &e) { - ServerInstance->Logs->Log("m_filter", LOG_DEFAULT, "Error in regular expression '%s': %s", freeform.c_str(), e.GetReason()); + ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Error in regular expression '%s': %s", freeform.c_str(), e.GetReason().c_str()); return std::make_pair(false, e.GetReason()); } return std::make_pair(true, ""); @@ -643,17 +672,17 @@ std::pair ModuleFilter::AddFilter(const std::string &freeform bool ModuleFilter::StringToFilterAction(const std::string& str, FilterAction& fa) { - irc::string s(str.c_str()); - - if (s == "gline") + if (stdalgo::string::equalsci(str, "gline")) fa = FA_GLINE; - else if (s == "block") + else if (stdalgo::string::equalsci(str, "block")) fa = FA_BLOCK; - else if (s == "silent") + else if (stdalgo::string::equalsci(str, "silent")) fa = FA_SILENT; - else if (s == "kill") + else if (stdalgo::string::equalsci(str, "kill")) fa = FA_KILL; - else if (s == "none") + else if (stdalgo::string::equalsci(str, "shun") && (ServerInstance->XLines->GetFactory("SHUN"))) + fa = FA_SHUN; + else if (stdalgo::string::equalsci(str, "none")) fa = FA_NONE; else return false; @@ -669,6 +698,7 @@ std::string ModuleFilter::FilterActionToString(FilterAction fa) case FA_BLOCK: return "block"; case FA_SILENT: return "silent"; case FA_KILL: return "kill"; + case FA_SHUN: return "shun"; default: return "none"; } } @@ -684,7 +714,7 @@ void ModuleFilter::ReadFilters() std::string reason = i->second->getString("reason"); std::string action = i->second->getString("action"); std::string flgs = i->second->getString("flags"); - unsigned long gline_time = InspIRCd::Duration(i->second->getString("duration")); + unsigned long duration = i->second->getDuration("duration", 10*60, 1); if (flgs.empty()) flgs = "*"; @@ -694,27 +724,31 @@ void ModuleFilter::ReadFilters() try { - filters.push_back(ImplFilter(this, reason, fa, gline_time, pattern, flgs)); - ServerInstance->Logs->Log("m_filter", LOG_DEFAULT, "Regular expression %s loaded.", pattern.c_str()); + filters.push_back(FilterResult(RegexEngine, pattern, reason, fa, duration, flgs)); + ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Regular expression %s loaded.", pattern.c_str()); } catch (ModuleException &e) { - ServerInstance->Logs->Log("m_filter", LOG_DEFAULT, "Error in regular expression '%s': %s", pattern.c_str(), e.GetReason()); + ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Error in regular expression '%s': %s", pattern.c_str(), e.GetReason().c_str()); } } } -ModResult ModuleFilter::OnStats(char symbol, User* user, string_list &results) +ModResult ModuleFilter::OnStats(Stats::Context& stats) { - if (symbol == 's') + if (stats.GetSymbol() == 's') { - for (std::vector::iterator i = filters.begin(); i != filters.end(); i++) + for (std::vector::iterator i = filters.begin(); i != filters.end(); i++) + { + stats.AddRow(223, RegexEngine.GetProvider()+":"+i->freeform+" "+i->GetFlags()+" "+FilterActionToString(i->action)+" "+ConvToStr(i->duration)+" :"+i->reason); + } + for (ExemptTargetSet::const_iterator i = exemptedchans.begin(); i != exemptedchans.end(); ++i) { - results.push_back(ServerInstance->Config->ServerName+" 223 "+user->nick+" :"+RegexEngine.GetProvider()+":"+i->freeform+" "+i->GetFlags()+" "+FilterActionToString(i->action)+" "+ConvToStr(i->gline_time)+" :"+i->reason); + stats.AddRow(223, "EXEMPT "+(*i)); } - for (std::set::iterator i = exemptfromfilter.begin(); i != exemptfromfilter.end(); ++i) + for (ExemptTargetSet::const_iterator i = exemptednicks.begin(); i != exemptednicks.end(); ++i) { - results.push_back(ServerInstance->Config->ServerName+" 223 "+user->nick+" :EXEMPT "+(*i)); + stats.AddRow(223, "EXEMPT "+(*i)); } } return MOD_RES_PASSTHRU;