* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * Inspire is copyright (C) 2002-2004 ChatSpike-Dev.
+ * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
* E-mail:
* <brain@chatspike.net>
* <Craig@chatspike.net>
* ---------------------------------------------------
*/
+using namespace std;
+
// Message and notice filtering using glob patterns
// a module based on the original work done by Craig Edwards in 2003
// for the chatspike network.
#include "users.h"
#include "channels.h"
#include "modules.h"
-#include "helperfuncs.h"
+#include "inspircd.h"
+#include "m_filter.h"
+
+/* $ModDesc: An advanced spam filtering module */
+/* $ModDep: m_filter.h */
-/* $ModDesc: An enhanced version of the unreal m_filter.so used by chatspike.net */
+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::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);
- MyConf = new ConfigReader(filterfile);
- if ((filterfile == "") || (!MyConf->Verify()))
- {
- printf("Error, could not find <filter file=\"\"> definition in your config file!");
- log(DEFAULT,"Error, could not find <filter file=\"\"> definition in your config file!");
- return;
- }
- Srv->Log(DEFAULT,std::string("m_filter: read configuration from ")+filterfile);
+ OnRehash("");
}
virtual ~ModuleFilter()
{
- delete Srv;
- delete MyConf;
- delete Conf;
}
-
- // format of a config entry is <keyword pattern="*glob*" reason="Some reason here" action="kill/block">
-
- virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text)
+
+ virtual FilterResult* FilterMatch(const std::string &text)
{
std::string text2 = 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(text2,pattern)) || (Srv->MatchText(text,pattern)))
+ if ((ServerInstance->MatchText(text2,index->first)) || (ServerInstance->MatchText(text,index->first)))
{
- 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 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);
- }
-
- Srv->Log(DEFAULT,std::string("FILTER: ")+std::string(user->nick)+
- std::string(" had their message filtered, target was ")+
- target+": "+reason+" Action: "+do_action);
-
- if (do_action == "kill")
- {
- Srv->QuitUser(user,reason);
- }
- return 1;
+ return index->second;
}
}
- return 0;
+ return NULL;
}
-
- virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text)
+
+ virtual bool DeleteFilter(const std::string &freeform)
{
- std::string text2 = 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(text2,pattern)) || (Srv->MatchText(text,pattern)))
- {
- 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;
- }
+ 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)
{
- // 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()))
+ 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!");
- log(DEFAULT,"Error, could not find <filter file=\"\"> definition in your config file!");
- return;
+ return std::make_pair(false, "Filter already exists");
}
- Srv->Log(DEFAULT,std::string("m_filter: read configuration from ")+filterfile);
+
+ FilterResult* x = new FilterResult;
+ x->reason = reason;
+ x->action = type;
+ x->gline_time = duration;
+ x->freeform = freeform;
+ filters[freeform] = x;
+
+ return std::make_pair(true, "");
}
-
- virtual Version GetVersion()
+
+ virtual void SyncFilters(Module* proto, void* opaque)
{
- // This is version 2 because version 1.x is the unreleased unrealircd module
- return Version(2,0,0,1,VF_VENDOR);
+ for (filter_t::iterator n = filters.begin(); n != filters.end(); n++)
+ {
+ this->SendFilter(proto, opaque, n->second);
+ }
+ }
+
+ virtual void OnRehash(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);
+ long gline_time = ServerInstance->Duration(MyConf->ReadValue("keyword","duration",index).c_str());
+ if (do_action == "")
+ do_action = "none";
+ FilterResult* x = new FilterResult;
+ x->reason = reason;
+ x->action = do_action;
+ x->gline_time = gline_time;
+ x->freeform = pattern;
+ filters[pattern] = x;
+ }
+ DELETE(MyConf);
+ }
+
+ virtual int OnStats(char symbol, userrec* user, string_list &results)
+ {
+ 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->action+" "+ConvToStr(n->second->gline_time)+" :"+n->second->reason);
+ }
+ }
+ return 0;
}
-
};
// stuff down here is the module-factory stuff. For basic modules you can ignore this.
{
}
- virtual Module * CreateModule()
+ virtual Module * CreateModule(InspIRCd* Me)
{
- return new ModuleFilter;
+ return new ModuleFilter(Me);
}
};