-// Message and notice filtering using glob patterns
-// a module based on the original work done by Craig Edwards in 2003
-// for the chatspike network.
+/* +------------------------------------+
+ * | Inspire Internet Relay Chat Daemon |
+ * +------------------------------------+
+ *
+ * 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.
+ *
+ * ---------------------------------------------------
+ */
-#include <stdio.h>
-#include <string>
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
+#include "inspircd.h"
+#include "m_filter.h"
-/* $ModDesc: An enhanced version of the unreal m_filter.so used by chatspike.net */
+/* $ModDesc: An advanced spam filtering module */
+/* $ModDep: m_filter.h */
-
+typedef std::map<std::string,FilterResult*> filter_t;
-class ModuleFilter : public Module
+class ModuleFilter : public FilterBase
{
- Server *Srv;
- ConfigReader *Conf, *MyConf;
-
+
+ filter_t filters;
+
public:
- ModuleFilter()
+ ModuleFilter(InspIRCd* Me)
+ : FilterBase(Me, "m_filter.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 = new Server;
- Conf = new ConfigReader;
- std::string filterfile = Conf->ReadValue("filter","file",0);
- if (filterfile == "")
- {
- printf("Error, could not find <filter file=\"\"> definition in your config file!");
- exit(0);
- }
- MyConf = new ConfigReader(filterfile);
- Srv->Log(DEFAULT,std::string("m_filter: read configuration from ")+filterfile);
+ OnRehash(NULL,"");
+
}
-
+
virtual ~ModuleFilter()
{
- delete Srv;
- delete MyConf;
- delete Conf;
}
-
- // format of a config entry is <keyword pattern="*glob*" reason="Some reason here">
-
- virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string text)
+
+ virtual FilterResult* FilterMatch(User* user, const std::string &text, int iflags)
{
- text = text + " ";
- for (int index = 0; index < MyConf->Enumerate("keyword"); index++)
+ for (filter_t::iterator index = filters.begin(); index != filters.end(); index++)
{
- std::string pattern = MyConf->ReadValue("keyword","pattern",index);
- if (Srv->MatchText(text,pattern))
+
+ /* Skip ones that dont apply to us */
+ if (!FilterBase::AppliesToMe(user, index->second, iflags))
+ continue;
+
+ if (InspIRCd::Match(text,index->first))
{
- std::string target = "";
- std::string reason = MyConf->ReadValue("keyword","reason",index);
- if (target_type == TYPE_USER)
- {
- userrec* t = (userrec*)dest;
- target = std::string(t->nick);
- }
- else if (target_type == TYPE_CHANNEL)
+ FilterResult* fr = index->second;
+ if (index != filters.begin())
{
- chanrec* t = (chanrec*)dest;
- target = std::string(t->name);
+ std::string pat = index->first;
+ filters.erase(index);
+ filters.insert(filters.begin(), std::make_pair(pat,fr));
}
- Srv->SendOpers(std::string("FILTER: ")+std::string(user->nick)+
- std::string(" had their message filtered, target was ")+
- target+": "+reason);
- Srv->Log(DEFAULT,std::string("FILTER: ")+std::string(user->nick)+
- std::string(" had their message filtered, target was ")+
- target+": "+reason);
- // this form of SendTo (with the source as NuLL) sends a server notice
- Srv->SendTo(NULL,user,"NOTICE "+std::string(user->nick)+
- " :Your message has been filtered and opers notified: "+reason);
- return 1;
+ return fr;
}
}
- return 0;
+ return NULL;
}
-
- virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string text)
+
+ virtual bool DeleteFilter(const std::string &freeform)
{
- text = text + " ";
- for (int index = 0; index < MyConf->Enumerate("keyword"); index++)
+ if (filters.find(freeform) != filters.end())
{
- std::string pattern = MyConf->ReadValue("keyword","pattern",index);
- if (Srv->MatchText(text,pattern))
- {
- std::string target = "";
- std::string reason = MyConf->ReadValue("keyword","reason",index);
- 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);
- }
- Srv->SendOpers(std::string("FILTER: ")+std::string(user->nick)+
- std::string(" had their notice filtered, target was ")+
- target+": "+MyConf->ReadValue("keyword","reason",index));
- Srv->Log(DEFAULT,std::string("FILTER: ")+std::string(user->nick)+
- std::string(" had their notice filtered, target was ")+
- target+": "+MyConf->ReadValue("keyword","reason",index));
- Srv->SendTo(NULL,user,"NOTICE "+std::string(user->nick)+
- " :Your notice has been filtered and opers notified: "+reason);
- return 1;
- }
+ delete (filters.find(freeform))->second;
+ filters.erase(filters.find(freeform));
+ return true;
}
- return 0;
+ return false;
}
-
- virtual void OnRehash()
+
+ virtual std::pair<bool, std::string> AddFilter(const std::string &freeform, const std::string &type, const std::string &reason, long duration, const std::string &sflags)
{
- // 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);
- if (filterfile == "")
+ if (filters.find(freeform) != filters.end())
{
- // bail if the user forgot to create a config file
- printf("Error, could not find <filter file=\"\"> definition in your config file!");
- exit(0);
+ return std::make_pair(false, "Filter already exists");
}
- // this automatically re-reads the configuration file into the class
- MyConf = new ConfigReader(filterfile);
- Srv->Log(DEFAULT,std::string("m_filter: read configuration from ")+filterfile);
- }
-
- virtual Version GetVersion()
- {
- // This is version 2 because version 1.x is the unreleased unrealircd module
- return Version(2,0,0,0);
- }
-
-};
-// stuff down here is the module-factory stuff. For basic modules you can ignore this.
+ FilterResult* x = new FilterResult(freeform, reason, type, duration, sflags);
+ filters[freeform] = x;
-class ModuleFilterFactory : public ModuleFactory
-{
- public:
- ModuleFilterFactory()
+ return std::make_pair(true, "");
+ }
+
+ virtual void SyncFilters(Module* proto, void* opaque)
{
+ for (filter_t::iterator n = filters.begin(); n != filters.end(); n++)
+ {
+ this->SendFilter(proto, opaque, n->second);
+ }
}
-
- ~ModuleFilterFactory()
+
+ virtual void OnRehash(User* user, const std::string ¶meter)
{
+ ConfigReader* MyConf = new ConfigReader(ServerInstance);
+
+ for (int index = 0; index < MyConf->Enumerate("keyword"); 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 do_action = MyConf->ReadValue("keyword","action",index);
+ std::string sflags = MyConf->ReadValue("keyword","flags",index);
+ long gline_time = ServerInstance->Duration(MyConf->ReadValue("keyword","duration",index));
+ if (do_action.empty())
+ do_action = "none";
+ if (sflags.empty())
+ sflags = "*";
+ FilterResult* x = new FilterResult(pattern, reason, do_action, gline_time, sflags);
+ filters[pattern] = x;
+ }
+ delete MyConf;
+ FilterBase::OnRehash(user, parameter);
}
-
- virtual Module * CreateModule()
+
+ virtual int OnStats(char symbol, User* user, string_list &results)
{
- return new ModuleFilter;
+ if (symbol == 's')
+ {
+ std::string sn = ServerInstance->Config->ServerName;
+ for (filter_t::iterator n = filters.begin(); n != filters.end(); n++)
+ {
+ results.push_back(sn+" 223 "+user->nick+" :GLOB:"+n->second->freeform+" "+n->second->flags+" "+n->second->action+" "+ConvToStr(n->second->gline_time)+" :"+n->second->reason);
+ }
+ }
+ return 0;
}
-
};
-extern "C" void * init_module( void )
-{
- return new ModuleFilterFactory;
-}
-
+MODULE_INIT(ModuleFilter)