]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_filter.cpp
Remove InspIRCd* parameters and fields
[user/henk/code/inspircd.git] / src / modules / m_filter.cpp
index b7d97777117e3642ba659d95865a36e81c9250e1..b6dbee4eac99e9c25dac0994f02a31b7364442a7 100644 (file)
@@ -95,130 +95,137 @@ class FilterResult : public classbase
        }
 };
 
-class CommandFilter;
+class FilterBase;
+
+class CommandFilter : public Command
+{
+       FilterBase* Base;
+ public:
+       CommandFilter(FilterBase* f)
+               : Command(reinterpret_cast<Module*>(f), "FILTER", 1, 5), Base(f)
+       {
+               flags_needed = 'o';
+               this->syntax = "<filter-definition> <action> <flags> [<gline-duration>] :<reason>";
+       }
+       CmdResult Handle(const std::vector<std::string>&, User*);
+
+       void TooFewParams(User* user, const std::string &extra_text)
+       {
+               user->WriteServ("NOTICE %s :*** Not enough parameters%s", user->nick.c_str(), extra_text.c_str());
+       }
+
+       RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
+       {
+               return ROUTE_BROADCAST;
+       }
+};
 
 class FilterBase : public Module
 {
-       CommandFilter* filtcommand;
+       CommandFilter filtcommand;
        int flags;
 protected:
        std::vector<std::string> exemptfromfilter; // List of channel names excluded from filtering.
  public:
-       FilterBase(InspIRCd* Me, const std::string &source);
+       FilterBase();
        virtual ~FilterBase();
-       virtual int OnUserPreMessage(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list);
+       virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list);
        virtual FilterResult* FilterMatch(User* user, const std::string &text, int flags) = 0;
        virtual bool DeleteFilter(const std::string &freeform) = 0;
        virtual void SyncFilters(Module* proto, void* opaque) = 0;
        virtual void SendFilter(Module* proto, void* opaque, FilterResult* iter);
        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) = 0;
-       virtual int OnUserPreNotice(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list);
-       virtual void OnRehash(User* user, const std::string &parameter);
+       virtual ModResult OnUserPreNotice(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list);
+       virtual void OnRehash(User* user);
        virtual Version GetVersion();
        std::string EncodeFilter(FilterResult* filter);
        FilterResult DecodeFilter(const std::string &data);
-       virtual void OnSyncOtherMetaData(Module* proto, void* opaque, bool displayable = false);
-       virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata);
-       virtual int OnStats(char symbol, User* user, string_list &results) = 0;
-       virtual int OnPreCommand(std::string &command, std::vector<std::string> &parameters, User *user, bool validated, const std::string &original_line);
+       virtual void OnSyncNetwork(Module* proto, void* opaque);
+       virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
+       virtual ModResult OnStats(char symbol, User* user, string_list &results) = 0;
+       virtual ModResult OnPreCommand(std::string &command, std::vector<std::string> &parameters, User *user, bool validated, const std::string &original_line);
        bool AppliesToMe(User* user, FilterResult* filter, int flags);
        void OnLoadModule(Module* mod, const std::string& name);
        virtual void ReadFilters(ConfigReader &MyConf) = 0;
 };
 
-class CommandFilter : public Command
+CmdResult CommandFilter::Handle(const std::vector<std::string> &parameters, User *user)
 {
-       FilterBase* Base;
- public:
-       CommandFilter(FilterBase* f, InspIRCd* Me, const std::string &ssource) : Command(Me, "FILTER", "o", 1, 5), Base(f)
-       {
-               this->source = ssource;
-               this->syntax = "<filter-definition> <action> <flags> [<gline-duration>] :<reason>";
-       }
-
-       CmdResult Handle(const std::vector<std::string> &parameters, User *user)
+       if (parameters.size() == 1)
        {
-               if (parameters.size() == 1)
+               /* Deleting a filter */
+               if (Base->DeleteFilter(parameters[0]))
                {
-                       /* Deleting a filter */
-                       if (Base->DeleteFilter(parameters[0]))
-                       {
-                               user->WriteServ("NOTICE %s :*** Removed filter '%s'", user->nick.c_str(), parameters[0].c_str());
-                               ServerInstance->SNO->WriteGlobalSno('a', std::string("FILTER: ")+user->nick+" removed filter '"+parameters[0]+"'");
-                               return CMD_SUCCESS;
-                       }
-                       else
-                       {
-                               user->WriteServ("NOTICE %s :*** Filter '%s' not found in list, try /stats s.", user->nick.c_str(), parameters[0].c_str());
-                               return CMD_FAILURE;
-                       }
+                       user->WriteServ("NOTICE %s :*** Removed filter '%s'", user->nick.c_str(), parameters[0].c_str());
+                       ServerInstance->SNO->WriteToSnoMask(IS_LOCAL(user) ? 'a' : 'A', std::string("FILTER: ")+user->nick+" removed filter '"+parameters[0]+"'");
+                       return CMD_SUCCESS;
                }
                else
                {
-                       /* Adding a filter */
-                       if (parameters.size() >= 4)
-                       {
-                               std::string freeform = parameters[0];
-                               std::string type = parameters[1];
-                               std::string flags = parameters[2];
-                               std::string reason;
-                               long duration = 0;
+                       user->WriteServ("NOTICE %s :*** Filter '%s' not found in list, try /stats s.", user->nick.c_str(), parameters[0].c_str());
+                       return CMD_FAILURE;
+               }
+       }
+       else
+       {
+               /* Adding a filter */
+               if (parameters.size() >= 4)
+               {
+                       std::string freeform = parameters[0];
+                       std::string type = parameters[1];
+                       std::string flags = parameters[2];
+                       std::string reason;
+                       long duration = 0;
 
 
-                               if ((type != "gline") && (type != "none") && (type != "block") && (type != "kill") && (type != "silent"))
-                               {
-                                       user->WriteServ("NOTICE %s :*** Invalid filter type '%s'. Supported types are 'gline', 'none', 'block', 'silent' and 'kill'.", user->nick.c_str(), type.c_str());
-                                       return CMD_FAILURE;
-                               }
+                       if ((type != "gline") && (type != "none") && (type != "block") && (type != "kill") && (type != "silent"))
+                       {
+                               user->WriteServ("NOTICE %s :*** Invalid filter type '%s'. Supported types are 'gline', 'none', 'block', 'silent' and 'kill'.", user->nick.c_str(), type.c_str());
+                               return CMD_FAILURE;
+                       }
 
-                               if (type == "gline")
+                       if (type == "gline")
+                       {
+                               if (parameters.size() >= 5)
                                {
-                                       if (parameters.size() >= 5)
-                                       {
-                                               duration = ServerInstance->Duration(parameters[3]);
-                                               reason = parameters[4];
-                                       }
-                                       else
-                                       {
-                                               this->TooFewParams(user, ": When setting a gline type filter, a gline duration must be specified as the third parameter.");
-                                               return CMD_FAILURE;
-                                       }
+                                       duration = ServerInstance->Duration(parameters[3]);
+                                       reason = parameters[4];
                                }
                                else
                                {
-                                       reason = parameters[3];
+                                       this->TooFewParams(user, ": When setting a gline type filter, a gline duration must be specified as the third parameter.");
+                                       return CMD_FAILURE;
                                }
-                               std::pair<bool, std::string> result = Base->AddFilter(freeform, type, reason, duration, flags);
-                               if (result.first)
-                               {
-                                       user->WriteServ("NOTICE %s :*** Added filter '%s', type '%s'%s%s, flags '%s', reason: '%s'", user->nick.c_str(), freeform.c_str(),
-                                                       type.c_str(), (duration ? ", duration " : ""), (duration ? parameters[3].c_str() : ""),
-                                                       flags.c_str(), reason.c_str());
+                       }
+                       else
+                       {
+                               reason = parameters[3];
+                       }
+                       std::pair<bool, std::string> result = Base->AddFilter(freeform, type, reason, duration, flags);
+                       if (result.first)
+                       {
+                               user->WriteServ("NOTICE %s :*** Added filter '%s', type '%s'%s%s, flags '%s', reason: '%s'", user->nick.c_str(), freeform.c_str(),
+                                               type.c_str(), (duration ? ", duration " : ""), (duration ? parameters[3].c_str() : ""),
+                                               flags.c_str(), reason.c_str());
 
-                                       ServerInstance->SNO->WriteGlobalSno('a', std::string("FILTER: ")+user->nick+" added filter '"+freeform+"', type '"+type+"', "+(duration ? "duration "+parameters[3]+", " : "")+"flags '"+flags+"', reason: "+reason);
+                               ServerInstance->SNO->WriteToSnoMask(IS_LOCAL(user) ? 'a' : 'A', std::string("FILTER: ")+user->nick+" added filter '"+freeform+"', type '"+type+"', "+(duration ? "duration "+parameters[3]+", " : "")+"flags '"+flags+"', reason: "+reason);
 
-                                       return CMD_SUCCESS;
-                               }
-                               else
-                               {
-                                       user->WriteServ("NOTICE %s :*** Filter '%s' could not be added: %s", user->nick.c_str(), freeform.c_str(), result.second.c_str());
-                                       return CMD_FAILURE;
-                               }
+                               return CMD_SUCCESS;
                        }
                        else
                        {
-                               this->TooFewParams(user, ".");
+                               user->WriteServ("NOTICE %s :*** Filter '%s' could not be added: %s", user->nick.c_str(), freeform.c_str(), result.second.c_str());
                                return CMD_FAILURE;
                        }
-
                }
-       }
+               else
+               {
+                       this->TooFewParams(user, ".");
+                       return CMD_FAILURE;
+               }
 
-       void TooFewParams(User* user, const std::string &extra_text)
-       {
-               user->WriteServ("NOTICE %s :*** Not enough parameters%s", user->nick.c_str(), extra_text.c_str());
        }
-};
+}
 
 bool FilterBase::AppliesToMe(User* user, FilterResult* filter, int iflags)
 {
@@ -235,12 +242,11 @@ bool FilterBase::AppliesToMe(User* user, FilterResult* filter, int iflags)
        return true;
 }
 
-FilterBase::FilterBase(InspIRCd* Me, const std::string &source) : Module(Me)
+FilterBase::FilterBase() : filtcommand(this)
 {
-       Me->Modules->UseInterface("RegularExpression");
-       filtcommand = new CommandFilter(this, Me, source);
-       ServerInstance->AddCommand(filtcommand);
-       Implementation eventlist[] = { I_OnPreCommand, I_OnStats, I_OnSyncOtherMetaData, I_OnDecodeMetaData, I_OnUserPreMessage, I_OnUserPreNotice, I_OnRehash, I_OnLoadModule };
+       ServerInstance->Modules->UseInterface("RegularExpression");
+       ServerInstance->AddCommand(&filtcommand);
+       Implementation eventlist[] = { I_OnPreCommand, I_OnStats, I_OnSyncNetwork, I_OnDecodeMetaData, I_OnUserPreMessage, I_OnUserPreNotice, I_OnRehash, I_OnLoadModule };
        ServerInstance->Modules->Attach(eventlist, this, 8);
 }
 
@@ -249,20 +255,20 @@ FilterBase::~FilterBase()
        ServerInstance->Modules->DoneWithInterface("RegularExpression");
 }
 
-int FilterBase::OnUserPreMessage(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
+ModResult FilterBase::OnUserPreMessage(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
 {
        if (!IS_LOCAL(user))
-               return 0;
+               return MOD_RES_PASSTHRU;
 
        flags = FLAG_PRIVMSG;
        return OnUserPreNotice(user,dest,target_type,text,status,exempt_list);
 }
 
-int FilterBase::OnUserPreNotice(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
+ModResult FilterBase::OnUserPreNotice(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
 {
        /* Leave ulines alone */
        if ((ServerInstance->ULine(user->server)) || (!IS_LOCAL(user)))
-               return 0;
+               return MOD_RES_PASSTHRU;
 
        if (!flags)
                flags = FLAG_NOTICE;
@@ -281,7 +287,7 @@ int FilterBase::OnUserPreNotice(User* user,void* dest,int target_type, std::stri
                        Channel* t = (Channel*)dest;
                        target = std::string(t->name);
                        std::vector<std::string>::iterator i = find(exemptfromfilter.begin(), exemptfromfilter.end(), target);
-                       if (i != exemptfromfilter.end()) return 0;
+                       if (i != exemptfromfilter.end()) return MOD_RES_PASSTHRU;
                }
                if (f->action == "block")
                {
@@ -304,7 +310,7 @@ int FilterBase::OnUserPreNotice(User* user,void* dest,int target_type, std::stri
                }
                if (f->action == "gline")
                {
-                       GLine* gl = new GLine(ServerInstance, ServerInstance->Time(), f->gline_time, ServerInstance->Config->ServerName, f->reason.c_str(), "*", user->GetIPString());
+                       GLine* gl = new GLine(ServerInstance->Time(), f->gline_time, ServerInstance->Config->ServerName, f->reason.c_str(), "*", user->GetIPString());
                        if (ServerInstance->XLines->AddLine(gl,NULL))
                        {
                                ServerInstance->XLines->ApplyLines();
@@ -314,12 +320,12 @@ int FilterBase::OnUserPreNotice(User* user,void* dest,int target_type, std::stri
                }
 
                ServerInstance->Logs->Log("FILTER",DEFAULT,"FILTER: "+ user->nick + " had their message filtered, target was " + target + ": " + f->reason + " Action: " + f->action);
-               return 1;
+               return MOD_RES_DENY;
        }
-       return 0;
+       return MOD_RES_PASSTHRU;
 }
 
-int FilterBase::OnPreCommand(std::string &command, std::vector<std::string> &parameters, User *user, bool validated, const std::string &original_line)
+ModResult FilterBase::OnPreCommand(std::string &command, std::vector<std::string> &parameters, User *user, bool validated, const std::string &original_line)
 {
        flags = 0;
        if (validated && IS_LOCAL(user))
@@ -332,7 +338,7 @@ int FilterBase::OnPreCommand(std::string &command, std::vector<std::string> &par
                {
                        /* QUIT with no reason: nothing to do */
                        if (parameters.size() < 1)
-                               return 0;
+                               return MOD_RES_PASSTHRU;
 
                        checkline = parameters[0];
                        replacepoint = 0;
@@ -343,10 +349,10 @@ int FilterBase::OnPreCommand(std::string &command, std::vector<std::string> &par
                {
                        /* PART with no reason: nothing to do */
                        if (parameters.size() < 2)
-                               return 0;
+                               return MOD_RES_PASSTHRU;
 
                        std::vector<std::string>::iterator i = find(exemptfromfilter.begin(), exemptfromfilter.end(), parameters[0]);
-                       if (i != exemptfromfilter.end()) return 0;
+                       if (i != exemptfromfilter.end()) return MOD_RES_PASSTHRU;
                        checkline = parameters[1];
                        replacepoint = 1;
                        parting = true;
@@ -354,7 +360,7 @@ int FilterBase::OnPreCommand(std::string &command, std::vector<std::string> &par
                }
                else
                        /* We're only messing with PART and QUIT */
-                       return 0;
+                       return MOD_RES_PASSTHRU;
 
                FilterResult* f = NULL;
 
@@ -363,7 +369,7 @@ int FilterBase::OnPreCommand(std::string &command, std::vector<std::string> &par
 
                if (!f)
                        /* PART or QUIT reason doesnt match a filter */
-                       return 0;
+                       return MOD_RES_PASSTHRU;
 
                /* We cant block a part or quit, so instead we change the reason to 'Reason filtered' */
                Command* c = ServerInstance->Parser->GetHandler(command);
@@ -380,7 +386,7 @@ int FilterBase::OnPreCommand(std::string &command, std::vector<std::string> &par
                        if ((f->action == "block") || (((!parting) && (f->action == "kill"))) || (f->action == "silent"))
                        {
                                c->Handle(params, user);
-                               return 1;
+                               return MOD_RES_DENY;
                        }
                        else
                        {
@@ -393,7 +399,7 @@ int FilterBase::OnPreCommand(std::string &command, std::vector<std::string> &par
                                if (f->action == "gline")
                                {
                                        /* Note: We gline *@IP so that if their host doesnt resolve the gline still applies. */
-                                       GLine* gl = new GLine(ServerInstance, ServerInstance->Time(), f->gline_time, ServerInstance->Config->ServerName, f->reason.c_str(), "*", user->GetIPString());
+                                       GLine* gl = new GLine(ServerInstance->Time(), f->gline_time, ServerInstance->Config->ServerName, f->reason.c_str(), "*", user->GetIPString());
                                        if (ServerInstance->XLines->AddLine(gl,NULL))
                                        {
                                                ServerInstance->XLines->ApplyLines();
@@ -401,17 +407,17 @@ int FilterBase::OnPreCommand(std::string &command, std::vector<std::string> &par
                                        else
                                                delete gl;
                                }
-                               return 1;
+                               return MOD_RES_DENY;
                        }
                }
-               return 0;
+               return MOD_RES_PASSTHRU;
        }
-       return 0;
+       return MOD_RES_PASSTHRU;
 }
 
-void FilterBase::OnRehash(User* user, const std::string &parameter)
+void FilterBase::OnRehash(User* user)
 {
-       ConfigReader MyConf(ServerInstance);
+       ConfigReader MyConf;
        std::vector<std::string>().swap(exemptfromfilter);
        for (int index = 0; index < MyConf.Enumerate("exemptfromfilter"); ++index)
        {
@@ -461,7 +467,7 @@ void FilterBase::OnLoadModule(Module* mod, const std::string& name)
                        /* Force a rehash to make sure that any filters that couldnt be applied from the conf
                         * on startup or on load are applied right now.
                         */
-                       ConfigReader Config(ServerInstance);
+                       ConfigReader Config;
                        ServerInstance->SNO->WriteGlobalSno('a', "Found and activated regex module '%s' for m_filter.so.", RegexEngine.c_str());
                        ReadFilters(Config);
                }
@@ -471,7 +477,7 @@ void FilterBase::OnLoadModule(Module* mod, const std::string& name)
 
 Version FilterBase::GetVersion()
 {
-       return Version("$Id$", VF_VENDOR | VF_COMMON, API_VERSION);
+       return Version("Text (spam) filtering", VF_VENDOR | VF_COMMON, API_VERSION);
 }
 
 
@@ -510,19 +516,19 @@ FilterResult FilterBase::DecodeFilter(const std::string &data)
        return res;
 }
 
-void FilterBase::OnSyncOtherMetaData(Module* proto, void* opaque, bool displayable)
+void FilterBase::OnSyncNetwork(Module* proto, void* opaque)
 {
        this->SyncFilters(proto, opaque);
 }
 
 void FilterBase::SendFilter(Module* proto, void* opaque, FilterResult* iter)
 {
-       proto->ProtoSendMetaData(opaque, TYPE_OTHER, NULL, "filter", EncodeFilter(iter));
+       proto->ProtoSendMetaData(opaque, NULL, "filter", EncodeFilter(iter));
 }
 
-void FilterBase::OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
+void FilterBase::OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata)
 {
-       if ((target_type == TYPE_OTHER) && (extname == "filter"))
+       if ((target == NULL) && (extname == "filter"))
        {
                FilterResult data = DecodeFilter(extdata);
                this->AddFilter(data.freeform, data.action, data.reason, data.gline_time, data.flags);
@@ -556,10 +562,9 @@ class ModuleFilter : public FilterBase
        ImplFilter fr;
 
  public:
-       ModuleFilter(InspIRCd* Me)
-       : FilterBase(Me, "m_filter.so")
+       ModuleFilter()
        {
-               OnRehash(NULL,"");
+               OnRehash(NULL);
        }
 
        virtual ~ModuleFilter()
@@ -636,10 +641,10 @@ class ModuleFilter : public FilterBase
                return std::make_pair(true, "");
        }
 
-       virtual void OnRehash(User* user, const std::string &parameter)
+       virtual void OnRehash(User* user)
        {
-               ConfigReader MyConf(ServerInstance);
-               FilterBase::OnRehash(user, parameter);
+               ConfigReader MyConf;
+               FilterBase::OnRehash(user);
                ReadFilters(MyConf);
        }
 
@@ -671,7 +676,7 @@ class ModuleFilter : public FilterBase
                }
        }
 
-       virtual int OnStats(char symbol, User* user, string_list &results)
+       virtual ModResult OnStats(char symbol, User* user, string_list &results)
        {
                if (symbol == 's')
                {
@@ -685,7 +690,7 @@ class ModuleFilter : public FilterBase
                                results.push_back(sn+" 223 "+user->nick+" :EXEMPT "+(*i));
                        }
                }
-               return 0;
+               return MOD_RES_PASSTHRU;
        }
 };