]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/extra/m_filter_pcre.cpp
Newly revamped ziplinks module, work of psychon.. resolves (a lot) of problems with...
[user/henk/code/inspircd.git] / src / modules / extra / m_filter_pcre.cpp
index 58ca77333d3dae0af2f8cd0078ef18bae6e89f61..4710d7a33b5836d67ff69274f94c8c0363be0cf9 100644 (file)
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd is copyright (C) 2002-2004 ChatSpike-Dev.
- *                       E-mail:
- *                <brain@chatspike.net>
- *               <Craig@chatspike.net>
- *     
- * Written by Craig Edwards, Craig McLure, and others.
+ *  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.
+ *         the file COPYING for details.
  *
  * ---------------------------------------------------
  */
 
-using namespace std;
-
-// Message and notice filtering using regex patterns
-// a module based on the original work done by Craig Edwards in 2003
-// for the chatspike network.
-
-#include <stdio.h>
-#include <string>
+#include "inspircd.h"
 #include <pcre.h>
 #include "users.h"
 #include "channels.h"
 #include "modules.h"
-#include "helperfuncs.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 */
 
-class FilterPCREException : public ModuleException
+#ifdef WINDOWS
+#pragma comment(lib, "pcre.lib")
+#endif
+
+class PCREFilter : public FilterResult
 {
  public:
-       virtual const char* GetReason()
-       {
-               return "Could not find <filter file=\"\"> definition in your config file!";
-       }
-};
+        pcre* regexp;
 
-/* $ModDesc: m_filter with regexps */
-/* $CompileFlags: -I/usr/local/include */
-/* $LinkerFlags: -L/usr/local/lib -lpcre */
+        PCREFilter(pcre* r, const std::string &rea, const std::string &act, long glinetime, const std::string &pat, const std::string &flgs)
+                : FilterResult(pat, rea, act, glinetime, flgs), regexp(r)
+        {
+        }
 
-class ModuleFilterPCRE : public Module
+        PCREFilter()
+        {
+        }
+};
+
+class ModuleFilterPCRE : public FilterBase
 {
-       Server *Srv;
-       ConfigReader *Conf, *MyConf;
-       std::vector<pcre*> filters;
+       std::vector<PCREFilter> filters;
        pcre *re;
        const char *error;
        int erroffset;
+       PCREFilter fr;
+
  public:
-       ModuleFilterPCRE(Server* Me)
-               : Module::Module(Me)
+       ModuleFilterPCRE(InspIRCd* Me)
+       : FilterBase(Me, "m_filter_pcre.so")
        {
-               // read the configuration file on startup.
-               // it is perfectly valid to set <filter file> to the value of the
-               // main config file, then append your <keyword> tags to the bottom
-               // of the main config... but rather messy. That's why the capability
-               // of using a seperate config file is provided.
-               Srv = Me;
-               Conf = new ConfigReader;
-               std::string filterfile = Conf->ReadValue("filter","file",0);
-               MyConf = new ConfigReader(filterfile);
-               if ((filterfile == "") || (!MyConf->Verify()))
-               {
-                       FilterPCREException e;
-                       throw(e);
-               }
-               Srv->Log(DEFAULT,std::string("m_filter_pcre: read configuration from ")+filterfile);
+               OnRehash(NULL,"");
+
+       }
+
+       virtual ~ModuleFilterPCRE()
+       {
+       }
 
-               filters.clear();
-               for (int index = 0; index < MyConf->Enumerate("keyword"); index++)
+       virtual FilterResult* FilterMatch(User* user, const std::string &text, int flgs)
+       {
+               for (std::vector<PCREFilter>::iterator index = filters.begin(); index != filters.end(); index++)
                {
-                       std::string pattern = MyConf->ReadValue("keyword","pattern",index);
-                       re = pcre_compile(pattern.c_str(),0,&error,&erroffset,NULL);
-                       if (!re)
-                       {
-                               log(DEFAULT,"Error in regular expression: %s at offset %d: %s\n", pattern.c_str(), erroffset, error);
-                               log(DEFAULT,"Regular expression %s not loaded.", pattern.c_str());
-                       }
-                       else
+                       /* Skip ones that dont apply to us */
+
+                       if (!FilterBase::AppliesToMe(user, dynamic_cast<FilterResult*>(&(*index)), flgs))
+                               continue;
+
+                       if (pcre_exec(index->regexp, NULL, text.c_str(), text.length(), 0, 0, NULL, 0) > -1)
                        {
-                               filters.push_back(re);
-                               log(DEFAULT,"Regular expression %s loaded.", pattern.c_str());
+                               fr = *index;
+                               if (index != filters.begin())
+                               {
+                                       filters.erase(index);
+                                       filters.insert(filters.begin(), fr);
+                               }
+                               return &fr;
                        }
                }
-
-       }
-       
-       virtual ~ModuleFilterPCRE()
-       {
-               DELETE(MyConf);
-               DELETE(Conf);
+               return NULL;
        }
 
-       void Implements(char* List)
+       virtual bool DeleteFilter(const std::string &freeform)
        {
-               List[I_OnUserPreMessage] = List[I_OnUserPreNotice] = List[I_OnRehash] = 1;
+               for (std::vector<PCREFilter>::iterator i = filters.begin(); i != filters.end(); i++)
+               {
+                       if (i->freeform == freeform)
+                       {
+                               pcre_free((*i).regexp);
+                               filters.erase(i);
+                               return true;
+                       }
+               }
+               return false;
        }
 
-       // format of a config entry is <keyword pattern="^regexp$" reason="Some reason here" action="kill/block">
-       
-       virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text, char status)
+       virtual void SyncFilters(Module* proto, void* opaque)
        {
-               return OnUserPreNotice(user,dest,target_type,text,status);
+               for (std::vector<PCREFilter>::iterator i = filters.begin(); i != filters.end(); i++)
+               {
+                       this->SendFilter(proto, opaque, &(*i));
+               }
        }
-       
-       virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text, char status)
+
+       virtual std::pair<bool, std::string> AddFilter(const std::string &freeform, const std::string &type, const std::string &reason, long duration, const std::string &flgs)
        {
-               for (unsigned int index = 0; index < filters.size(); index++)
+               for (std::vector<PCREFilter>::iterator i = filters.begin(); i != filters.end(); i++)
                {
-                       if (pcre_exec(filters[index],NULL,text.c_str(),text.length(),0,0,NULL,0) > -1)
+                       if (i->freeform == freeform)
                        {
-                               std::string target = "";
-                               std::string reason = MyConf->ReadValue("keyword","reason",index);
-                               std::string do_action = MyConf->ReadValue("keyword","action",index);
-
-                               if (do_action == "")
-                                       do_action = "none";
-                                       
-                               if (target_type == TYPE_USER)
-                               {
-                                       userrec* t = (userrec*)dest;
-                                       target = std::string(t->nick);
-                               }
-                               else if (target_type == TYPE_CHANNEL)
-                               {
-                                       chanrec* t = (chanrec*)dest;
-                                       target = std::string(t->name);
-                               }
-                               if (do_action == "block")
-                               {       
-                                       Srv->SendOpers(std::string("Filter: ")+std::string(user->nick)+
-                                                       std::string(" had their notice filtered, target was ")+
-                                                       target+": "+reason);
-                                       Srv->SendTo(NULL,user,"NOTICE "+std::string(user->nick)+
-                                                       " :Your notice has been filtered and opers notified: "+reason);
-                               }
-                               Srv->Log(DEFAULT,std::string("Filter: ")+std::string(user->nick)+
-                                               std::string(" had their notice filtered, target was ")+
-                                               target+": "+reason+" Action: "+do_action);
-
-                               if (do_action == "kill")
-                               {
-                                       Srv->QuitUser(user,reason);
-                               }
-                               return 1;
+                               return std::make_pair(false, "Filter already exists");
                        }
                }
-               return 0;
-       }
-       
-       virtual void OnRehash(const std::string &parameter)
-       {
-               // reload our config file on rehash - we must destroy and re-allocate the classes
-               // to call the constructor again and re-read our data.
-               DELETE(Conf);
-               DELETE(MyConf);
-               Conf = new ConfigReader;
-               std::string filterfile = Conf->ReadValue("filter","file",0);
-               // this automatically re-reads the configuration file into the class
-               MyConf = new ConfigReader(filterfile);
-               if ((filterfile == "") || (!MyConf->Verify()))
+
+               re = pcre_compile(freeform.c_str(),0,&error,&erroffset,NULL);
+
+               if (!re)
+               {
+                       ServerInstance->Logs->Log("m_filter_pcre", DEFAULT,"Error in regular expression: %s at offset %d: %s\n", freeform.c_str(), erroffset, error);
+                       ServerInstance->Logs->Log("m_filter_pcre", DEFAULT,"Regular expression %s not loaded.", freeform.c_str());
+                       return std::make_pair(false, "Error in regular expression at offset " + ConvToStr(erroffset) + ": "+error);
+               }
+               else
                {
-                       FilterPCREException e;
-                       // bail if the user forgot to create a config file
-                       throw(e);
+                       filters.push_back(PCREFilter(re, reason, type, duration, freeform, flgs));
+                       return std::make_pair(true, "");
                }
-               Srv->Log(DEFAULT,std::string("m_filter_pcre: read configuration from ")+filterfile);
+       }
+
+       virtual void OnRehash(User* user, const std::string &parameter)
+       {
+               ConfigReader MyConf(ServerInstance);
 
-               filters.clear();
-               for (int index = 0; index < MyConf->Enumerate("keyword"); index++)
+               for (int index = 0; index < MyConf.Enumerate("keyword"); index++)
                {
-                       std::string pattern = MyConf->ReadValue("keyword","pattern",index);
+                       this->DeleteFilter(MyConf.ReadValue("keyword", "pattern", index));
+
+                       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 flgs = MyConf.ReadValue("keyword", "flags", index);
+                       long gline_time = ServerInstance->Duration(MyConf.ReadValue("keyword", "duration", index));
+                       if (action.empty())
+                               action = "none";
+                       if (flgs.empty())
+                               flgs = "*";
+
                        re = pcre_compile(pattern.c_str(),0,&error,&erroffset,NULL);
+
                        if (!re)
                        {
-                               log(DEFAULT,"Error in regular expression: %s at offset %d: %s\n", pattern.c_str(), erroffset, error);
-                               log(DEFAULT,"Regular expression %s not loaded.", pattern.c_str());
+                               ServerInstance->Logs->Log("CONFIG",DEFAULT,"Error in regular expression: %s at offset %d: %s\n", pattern.c_str(), erroffset, error);
+                               ServerInstance->Logs->Log("CONFIG",DEFAULT,"Regular expression %s not loaded.", pattern.c_str());
                        }
                        else
                        {
-                               filters.push_back(re);
-                               log(DEFAULT,"Regular expression %s loaded.", pattern.c_str());
+                               filters.push_back(PCREFilter(re, reason, action, gline_time, pattern, flgs));
+                               ServerInstance->Logs->Log("CONFIG",DEFAULT,"Regular expression %s loaded.", pattern.c_str());
                        }
                }
-
-       }
-       
-       virtual Version GetVersion()
-       {
-               // This is version 2 because version 1.x is the unreleased unrealircd module
-               return Version(3,0,0,0,VF_VENDOR);
+               FilterBase::OnRehash(user, parameter);
        }
-       
-};
-
-// stuff down here is the module-factory stuff. For basic modules you can ignore this.
 
-class ModuleFilterPCREFactory : public ModuleFactory
-{
- public:
-       ModuleFilterPCREFactory()
-       {
-       }
-       
-       ~ModuleFilterPCREFactory()
-       {
-       }
-       
-       virtual Module * CreateModule(Server* Me)
+       virtual int OnStats(char symbol, User* user, string_list &results)
        {
-               return new ModuleFilterPCRE(Me);
+               if (symbol == 's')
+               {
+                       std::string sn = ServerInstance->Config->ServerName;
+                       for (std::vector<PCREFilter>::iterator i = filters.begin(); i != filters.end(); i++)
+                       {
+                               results.push_back(sn+" 223 "+user->nick+" :REGEXP:"+i->freeform+" "+i->flags+" "+i->action+" "+ConvToStr(i->gline_time)+" :"+i->reason);
+                       }
+                       for (std::vector<std::string>::iterator i = exemptfromfilter.begin(); i != exemptfromfilter.end(); ++i)
+                       {
+                               results.push_back(sn+" 223 "+user->nick+" :EXEMPT "+(*i));
+                       }
+               }
+               return 0;
        }
-       
 };
 
-
-extern "C" void * init_module( void )
-{
-       return new ModuleFilterPCREFactory;
-}
+MODULE_INIT(ModuleFilterPCRE)