1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
7 * <brain@chatspike.net>
8 * <Craig@chatspike.net>
10 * Written by Craig Edwards, Craig McLure, and others.
11 * This program is free but copyrighted software; see
12 * the file COPYING for details.
14 * ---------------------------------------------------
19 // Message and notice filtering using glob patterns
20 // a module based on the original work done by Craig Edwards in 2003
21 // for the chatspike network.
31 /* $ModDesc: An enhanced version of the unreal m_filter.so used by chatspike.net */
35 class Filter : public classbase
42 typedef std::map<std::string,Filter*> filter_t;
44 class FilterException : public ModuleException
47 virtual const char* GetReason()
49 return "Could not find <filter file=\"\"> definition in your config file!";
53 class ModuleFilter : public Module
59 ModuleFilter(InspIRCd* Me)
62 // read the configuration file on startup.
63 // it is perfectly valid to set <filter file> to the value of the
64 // main config file, then append your <keyword> tags to the bottom
65 // of the main config... but rather messy. That's why the capability
66 // of using a seperate config file is provided.
71 virtual ~ModuleFilter()
75 void Implements(char* List)
77 List[I_OnUserPreMessage] = List[I_OnUserPreNotice] = List[I_OnRehash] = 1;
80 // format of a config entry is <keyword pattern="*glob*" reason="Some reason here" action="kill/block">
82 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text, char status)
84 return OnUserPreNotice(user,dest,target_type,text,status);
87 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text, char status)
89 std::string text2 = text+" ";
90 for (filter_t::iterator index = filters.begin(); index != filters.end(); index++)
92 if ((ServerInstance->MatchText(text2,index->first)) || (ServerInstance->MatchText(text,index->first)))
94 Filter* f = (Filter*)index->second;
95 std::string target = "";
97 if (target_type == TYPE_USER)
99 userrec* t = (userrec*)dest;
100 target = std::string(t->nick);
102 else if (target_type == TYPE_CHANNEL)
104 chanrec* t = (chanrec*)dest;
105 target = std::string(t->name);
108 if (f->action == "block")
110 ServerInstance->WriteOpers(std::string("FILTER: ")+user->nick+" had their notice filtered, target was "+target+": "+f->reason);
111 user->WriteServ("NOTICE "+std::string(user->nick)+" :Your notice has been filtered and opers notified: "+f->reason);
113 ServerInstance->Log(DEFAULT,"FILTER: "+std::string(user->nick)+std::string(" had their notice filtered, target was ")+target+": "+f->reason+" Action: "+f->action);
115 if (f->action == "kill")
117 userrec::QuitUser(ServerInstance,user,f->reason);
125 virtual void OnRehash(const std::string ¶meter)
127 // reload our config file on rehash - we must destroy and re-allocate the classes
128 // to call the constructor again and re-read our data.
129 ConfigReader* Conf = new ConfigReader(ServerInstance);
130 std::string filterfile = Conf->ReadValue("filter","file",0);
131 // this automatically re-reads the configuration file into the class
132 ConfigReader* MyConf = new ConfigReader(ServerInstance, filterfile);
133 if ((filterfile == "") || (!MyConf->Verify()))
135 // bail if the user forgot to create a config file
139 for (filter_t::iterator n = filters.begin(); n != filters.end(); n++)
144 for (int index = 0; index < MyConf->Enumerate("keyword"); index++)
146 std::string pattern = MyConf->ReadValue("keyword","pattern",index);
147 std::string reason = MyConf->ReadValue("keyword","reason",index);
148 std::string do_action = MyConf->ReadValue("keyword","action",index);
151 Filter* x = new Filter;
153 x->action = do_action;
154 filters[pattern] = x;
156 ServerInstance->Log(DEFAULT,"m_filter: read configuration from "+filterfile);
161 virtual Version GetVersion()
163 // This is version 2 because version 1.x is the unreleased unrealircd module
164 return Version(2,0,0,2,VF_VENDOR);
169 // stuff down here is the module-factory stuff. For basic modules you can ignore this.
171 class ModuleFilterFactory : public ModuleFactory
174 ModuleFilterFactory()
178 ~ModuleFilterFactory()
182 virtual Module * CreateModule(InspIRCd* Me)
184 return new ModuleFilter(Me);
190 extern "C" void * init_module( void )
192 return new ModuleFilterFactory;