]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_filter.cpp
Don't sync filters defined in the config and expire them on rehash.
[user/henk/code/inspircd.git] / src / modules / m_filter.cpp
index 8ad692971179d78043747cf01e2f85dbbf098244..239135655f0754e293432c47df1faf7d943e2e1f 100644 (file)
@@ -25,6 +25,7 @@
 #include "modules/regex.h"
 #include "modules/server.h"
 #include "modules/shun.h"
+#include "modules/stats.h"
 
 enum FilterFlags
 {
@@ -52,6 +53,7 @@ class FilterResult
        std::string reason;
        FilterAction action;
        long duration;
+       bool from_config;
 
        bool flag_no_opers;
        bool flag_part_message;
@@ -60,11 +62,12 @@ class FilterResult
        bool flag_notice;
        bool flag_strip_color;
 
-       FilterResult(dynamic_reference<RegexFactory>& RegexEngine, const std::string& free, const std::string& rea, FilterAction act, long gt, const std::string& fla)
+       FilterResult(dynamic_reference<RegexFactory>& RegexEngine, const std::string& free, const std::string& rea, FilterAction act, long gt, const std::string& fla, bool cfg)
                : freeform(free)
                , reason(rea)
                , action(act)
                , duration(gt)
+               , from_config(cfg)
        {
                if (!RegexEngine)
                        throw ModuleException("Regex module implementing '"+RegexEngine.GetProvider()+"' is not loaded!");
@@ -152,19 +155,20 @@ class CommandFilter : public Command
                flags_needed = 'o';
                this->syntax = "<filter-definition> <action> <flags> [<duration>] :<reason>";
        }
-       CmdResult Handle(const std::vector<std::string>& , User* ) CXX11_OVERRIDE;
+       CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE;
 
-       RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters) CXX11_OVERRIDE
+       RouteDescriptor GetRouting(User* user, const Params& parameters) CXX11_OVERRIDE
        {
                return ROUTE_BROADCAST;
        }
 };
 
-class ModuleFilter : public Module, public ServerEventListener
+class ModuleFilter : public Module, public ServerEventListener, public Stats::EventListener
 {
        typedef insp::flat_set<std::string, irc::insensitive_swo> ExemptTargetSet;
 
        bool initing;
+       bool notifyuser;
        RegexFactory* factory;
        void FreeFilters();
 
@@ -182,6 +186,7 @@ class ModuleFilter : public Module, public ServerEventListener
        ExemptTargetSet exemptednicks;
 
        ModuleFilter();
+       void init() 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);
@@ -194,7 +199,7 @@ class ModuleFilter : public Module, public ServerEventListener
        void OnSyncNetwork(ProtocolInterface::Server& server) CXX11_OVERRIDE;
        void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata) CXX11_OVERRIDE;
        ModResult OnStats(Stats::Context& stats) CXX11_OVERRIDE;
-       ModResult OnPreCommand(std::string &command, std::vector<std::string> &parameters, LocalUser *user, bool validated, const std::string &original_line) CXX11_OVERRIDE;
+       ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated) CXX11_OVERRIDE;
        void OnUnloadModule(Module* mod) CXX11_OVERRIDE;
        bool AppliesToMe(User* user, FilterResult* filter, int flags);
        void ReadFilters();
@@ -202,7 +207,7 @@ class ModuleFilter : public Module, public ServerEventListener
        static std::string FilterActionToString(FilterAction fa);
 };
 
-CmdResult CommandFilter::Handle(const std::vector<std::string> &parameters, User *user)
+CmdResult CommandFilter::Handle(User* user, const Params& parameters)
 {
        if (parameters.size() == 1)
        {
@@ -211,7 +216,7 @@ CmdResult CommandFilter::Handle(const std::vector<std::string> &parameters, User
                if (static_cast<ModuleFilter *>(me)->DeleteFilter(parameters[0]))
                {
                        user->WriteNotice("*** Removed filter '" + parameters[0] + "'");
-                       ServerInstance->SNO->WriteToSnoMask(IS_LOCAL(user) ? 'a' : 'A', "FILTER: "+user->nick+" removed filter '"+parameters[0]+"'");
+                       ServerInstance->SNO->WriteToSnoMask(IS_LOCAL(user) ? 'f' : 'F', "FILTER: "+user->nick+" removed filter '"+parameters[0]+"'");
                        return CMD_SUCCESS;
                }
                else
@@ -266,7 +271,7 @@ CmdResult CommandFilter::Handle(const std::vector<std::string> &parameters, User
                                        (duration ? ", duration " +  parameters[3] : "") + ", flags '" + flags + "', reason: '" +
                                        parameters[reasonindex] + "'");
 
-                               ServerInstance->SNO->WriteToSnoMask(IS_LOCAL(user) ? 'a' : 'A', "FILTER: "+user->nick+" added filter '"+freeform+"', type '"+parameters[1]+"', "+(duration ? "duration "+parameters[3]+", " : "")+"flags '"+flags+"', reason: "+parameters[reasonindex]);
+                               ServerInstance->SNO->WriteToSnoMask(IS_LOCAL(user) ? 'f' : 'F', "FILTER: "+user->nick+" added filter '"+freeform+"', type '"+parameters[1]+"', "+(duration ? "duration "+parameters[3]+", " : "")+"flags '"+flags+"', reason: "+parameters[reasonindex]);
 
                                return CMD_SUCCESS;
                        }
@@ -302,12 +307,18 @@ bool ModuleFilter::AppliesToMe(User* user, FilterResult* filter, int iflags)
 
 ModuleFilter::ModuleFilter()
        : ServerEventListener(this)
+       , Stats::EventListener(this)
        , initing(true)
        , filtcommand(this)
        , RegexEngine(this, "regex")
 {
 }
 
+void ModuleFilter::init()
+{
+       ServerInstance->SNO->EnableSnomask('f', "FILTER");
+}
+
 CullResult ModuleFilter::cull()
 {
        FreeFilters();
@@ -353,28 +364,41 @@ ModResult ModuleFilter::OnUserPreMessage(User* user, const MessageTarget& msgtar
                }
                if (f->action == FA_BLOCK)
                {
-                       ServerInstance->SNO->WriteGlobalSno('a', "FILTER: "+user->nick+" had their message filtered, target was "+target+": "+f->reason);
-                       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()));
+                       ServerInstance->SNO->WriteGlobalSno('f', InspIRCd::Format("%s had their message to %s filtered as it matched %s (%s)",
+                               user->nick.c_str(), target.c_str(), f->freeform.c_str(), f->reason.c_str()));
+                       if (notifyuser)
+                       {
+                               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
-                               user->WriteNotice("Your message to "+target+" was blocked and opers notified: "+f->reason);
+                               details.echo_original = true;
                }
                else if (f->action == FA_SILENT)
                {
-                       if (msgtarget.type == MessageTarget::TYPE_CHANNEL)
-                               user->WriteNumeric(ERR_CANNOTSENDTOCHAN, target, InspIRCd::Format("Message to channel blocked (%s)", f->reason.c_str()));
+                       if (notifyuser)
+                       {
+                               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
-                               user->WriteNotice("Your message to "+target+" was blocked: "+f->reason);
+                               details.echo_original = true;
                }
                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->SNO->WriteGlobalSno('f', InspIRCd::Format("%s was killed because their message to %s matched %s (%s)",
+                               user->nick.c_str(), target.c_str(), f->freeform.c_str(), f->reason.c_str()));
                        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);
+                       ServerInstance->SNO->WriteGlobalSno('f', InspIRCd::Format("%s was shunned because their message to %s matched %s (%s)",
+                               user->nick.c_str(), target.c_str(), f->freeform.c_str(), f->reason.c_str()));
                        if (ServerInstance->XLines->AddLine(sh, NULL))
                        {
                                ServerInstance->XLines->ApplyLines();
@@ -385,7 +409,8 @@ ModResult ModuleFilter::OnUserPreMessage(User* user, const MessageTarget& msgtar
                else if (f->action == FA_GLINE)
                {
                        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);
+                       ServerInstance->SNO->WriteGlobalSno('f', InspIRCd::Format("%s was glined because their message to %s matched %s (%s)",
+                               user->nick.c_str(), target.c_str(), f->freeform.c_str(), f->reason.c_str()));
                        if (ServerInstance->XLines->AddLine(gl,NULL))
                        {
                                ServerInstance->XLines->ApplyLines();
@@ -400,7 +425,7 @@ ModResult ModuleFilter::OnUserPreMessage(User* user, const MessageTarget& msgtar
        return MOD_RES_PASSTHRU;
 }
 
-ModResult ModuleFilter::OnPreCommand(std::string &command, std::vector<std::string> &parameters, LocalUser *user, bool validated, const std::string &original_line)
+ModResult ModuleFilter::OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated)
 {
        if (validated)
        {
@@ -459,7 +484,9 @@ ModResult ModuleFilter::OnPreCommand(std::string &command, std::vector<std::stri
                        {
                                /* Note: We gline *@IP so that if their host doesnt resolve the gline still applies. */
                                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);
+                               ServerInstance->SNO->WriteGlobalSno('f', InspIRCd::Format("%s was glined because their %s message matched %s (%s)",
+                                       user->nick.c_str(), command.c_str(), f->freeform.c_str(), f->reason.c_str()));
+
                                if (ServerInstance->XLines->AddLine(gl,NULL))
                                {
                                        ServerInstance->XLines->ApplyLines();
@@ -471,7 +498,8 @@ ModResult ModuleFilter::OnPreCommand(std::string &command, std::vector<std::stri
                        {
                                /* 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);
+                               ServerInstance->SNO->WriteGlobalSno('f', InspIRCd::Format("%s was shunned because their %s message matched %s (%s)",
+                                       user->nick.c_str(), command.c_str(), f->freeform.c_str(), f->reason.c_str()));
                                if (ServerInstance->XLines->AddLine(sh, NULL))
                                {
                                        ServerInstance->XLines->ApplyLines();
@@ -506,7 +534,9 @@ void ModuleFilter::ReadConfig(ConfigStatus& status)
                }
        }
 
-       std::string newrxengine = ServerInstance->Config->ConfValue("filteropts")->getString("engine");
+       ConfigTag* tag = ServerInstance->Config->ConfValue("filteropts");
+       std::string newrxengine = tag->getString("engine");
+       notifyuser = tag->getBool("notifyuser", true);
 
        factory = RegexEngine ? (RegexEngine.operator->()) : NULL;
 
@@ -518,9 +548,9 @@ void ModuleFilter::ReadConfig(ConfigStatus& status)
        if (!RegexEngine)
        {
                if (newrxengine.empty())
-                       ServerInstance->SNO->WriteGlobalSno('a', "WARNING: No regex engine loaded - Filter functionality disabled until this is corrected.");
+                       ServerInstance->SNO->WriteGlobalSno('f', "WARNING: No regex engine loaded - Filter functionality disabled until this is corrected.");
                else
-                       ServerInstance->SNO->WriteGlobalSno('a', "WARNING: Regex engine '%s' is not loaded - Filter functionality disabled until this is corrected.", newrxengine.c_str());
+                       ServerInstance->SNO->WriteGlobalSno('f', "WARNING: Regex engine '%s' is not loaded - Filter functionality disabled until this is corrected.", newrxengine.c_str());
 
                initing = false;
                FreeFilters();
@@ -529,7 +559,7 @@ void ModuleFilter::ReadConfig(ConfigStatus& status)
 
        if ((!initing) && (RegexEngine.operator->() != factory))
        {
-               ServerInstance->SNO->WriteGlobalSno('a', "Dumping all filters due to regex engine change");
+               ServerInstance->SNO->WriteGlobalSno('f', "Dumping all filters due to regex engine change");
                FreeFilters();
        }
 
@@ -561,19 +591,22 @@ FilterResult ModuleFilter::DecodeFilter(const std::string &data)
        std::string filteraction;
        FilterResult res;
        irc::tokenstream tokens(data);
-       tokens.GetToken(res.freeform);
-       tokens.GetToken(filteraction);
+       tokens.GetMiddle(res.freeform);
+       tokens.GetMiddle(filteraction);
        if (!StringToFilterAction(filteraction, res.action))
                throw ModuleException("Invalid action: " + filteraction);
 
        std::string filterflags;
-       tokens.GetToken(filterflags);
+       tokens.GetMiddle(filterflags);
        char c = res.FillFlags(filterflags);
        if (c != 0)
                throw ModuleException("Invalid flag: '" + std::string(1, c) + "'");
 
-       tokens.GetToken(res.duration);
-       tokens.GetToken(res.reason);
+       std::string duration;
+       tokens.GetMiddle(duration);
+       res.duration = ConvToInt(duration);
+
+       tokens.GetTrailing(res.reason);
 
        /* Hax to allow spaces in the freeform without changing the design of the irc protocol */
        for (std::string::iterator n = res.freeform.begin(); n != res.freeform.end(); n++)
@@ -587,7 +620,11 @@ void ModuleFilter::OnSyncNetwork(ProtocolInterface::Server& server)
 {
        for (std::vector<FilterResult>::iterator i = filters.begin(); i != filters.end(); ++i)
        {
-               server.SendMetaData("filter", EncodeFilter(&(*i)));
+               FilterResult& filter = *i;
+               if (filter.from_config)
+                       continue;
+
+               server.SendMetaData("filter", EncodeFilter(&filter));
        }
 }
 
@@ -658,7 +695,7 @@ std::pair<bool, std::string> ModuleFilter::AddFilter(const std::string &freeform
 
        try
        {
-               filters.push_back(FilterResult(RegexEngine, freeform, reason, type, duration, flgs));
+               filters.push_back(FilterResult(RegexEngine, freeform, reason, type, duration, flgs, false));
        }
        catch (ModuleException &e)
        {
@@ -703,12 +740,24 @@ std::string ModuleFilter::FilterActionToString(FilterAction fa)
 
 void ModuleFilter::ReadFilters()
 {
+       for (std::vector<FilterResult>::iterator filter = filters.begin(); filter != filters.end(); )
+       {
+               if (filter->from_config)
+               {
+                       ServerInstance->SNO->WriteGlobalSno('f', "FILTER: removing filter '" + filter->freeform + "' due to config rehash.");
+                       delete filter->regex;
+                       filter = filters.erase(filter);
+                       continue;
+               }
+
+               // The filter is not from the config.
+               filter++;
+       }
+
        ConfigTagList tags = ServerInstance->Config->ConfTags("keyword");
        for (ConfigIter i = tags.first; i != tags.second; ++i)
        {
                std::string pattern = i->second->getString("pattern");
-               this->DeleteFilter(pattern);
-
                std::string reason = i->second->getString("reason");
                std::string action = i->second->getString("action");
                std::string flgs = i->second->getString("flags");
@@ -722,7 +771,7 @@ void ModuleFilter::ReadFilters()
 
                try
                {
-                       filters.push_back(FilterResult(RegexEngine, pattern, reason, fa, duration, flgs));
+                       filters.push_back(FilterResult(RegexEngine, pattern, reason, fa, duration, flgs, true));
                        ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Regular expression %s loaded.", pattern.c_str());
                }
                catch (ModuleException &e)