1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
18 /* $ModDesc: Text (spam) filtering */
20 static std::string RegexEngine = "";
21 static Module* rxengine = NULL;
31 class FilterResult : public classbase
41 bool flag_part_message;
42 bool flag_quit_message;
46 FilterResult(const std::string free, const std::string &rea, const std::string &act, long gt, const std::string &fla) :
47 freeform(free), reason(rea), action(act), gline_time(gt), flags(fla)
52 int FillFlags(const std::string &fl)
55 flag_no_opers = flag_part_message = flag_quit_message = flag_privmsg = flag_notice = false;
58 for (std::string::const_iterator n = flags.begin(); n != flags.end(); ++n, ++x)
66 flag_part_message = true;
69 flag_quit_message = true;
78 flag_no_opers = flag_part_message = flag_quit_message =
79 flag_privmsg = flag_notice = true;
93 virtual ~FilterResult()
100 class CommandFilter : public Command
104 CommandFilter(FilterBase* f, InspIRCd* Me, const std::string &ssource)
105 : Command(Me, reinterpret_cast<Module*>(f), "FILTER", "o", 1, 5), Base(f)
107 this->syntax = "<filter-definition> <action> <flags> [<gline-duration>] :<reason>";
109 CmdResult Handle(const std::vector<std::string>&, User*);
111 void TooFewParams(User* user, const std::string &extra_text)
113 user->WriteServ("NOTICE %s :*** Not enough parameters%s", user->nick.c_str(), extra_text.c_str());
116 RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
118 return ROUTE_BROADCAST;
122 class FilterBase : public Module
124 CommandFilter filtcommand;
127 std::vector<std::string> exemptfromfilter; // List of channel names excluded from filtering.
129 FilterBase(InspIRCd* Me, const std::string &source);
130 virtual ~FilterBase();
131 virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list);
132 virtual FilterResult* FilterMatch(User* user, const std::string &text, int flags) = 0;
133 virtual bool DeleteFilter(const std::string &freeform) = 0;
134 virtual void SyncFilters(Module* proto, void* opaque) = 0;
135 virtual void SendFilter(Module* proto, void* opaque, FilterResult* iter);
136 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;
137 virtual ModResult OnUserPreNotice(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list);
138 virtual void OnRehash(User* user);
139 virtual Version GetVersion();
140 std::string EncodeFilter(FilterResult* filter);
141 FilterResult DecodeFilter(const std::string &data);
142 virtual void OnSyncNetwork(Module* proto, void* opaque);
143 virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
144 virtual ModResult OnStats(char symbol, User* user, string_list &results) = 0;
145 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string> ¶meters, User *user, bool validated, const std::string &original_line);
146 bool AppliesToMe(User* user, FilterResult* filter, int flags);
147 void OnLoadModule(Module* mod, const std::string& name);
148 virtual void ReadFilters(ConfigReader &MyConf) = 0;
151 CmdResult CommandFilter::Handle(const std::vector<std::string> ¶meters, User *user)
153 if (parameters.size() == 1)
155 /* Deleting a filter */
156 if (Base->DeleteFilter(parameters[0]))
158 user->WriteServ("NOTICE %s :*** Removed filter '%s'", user->nick.c_str(), parameters[0].c_str());
159 ServerInstance->SNO->WriteToSnoMask(IS_LOCAL(user) ? 'a' : 'A', std::string("FILTER: ")+user->nick+" removed filter '"+parameters[0]+"'");
164 user->WriteServ("NOTICE %s :*** Filter '%s' not found in list, try /stats s.", user->nick.c_str(), parameters[0].c_str());
170 /* Adding a filter */
171 if (parameters.size() >= 4)
173 std::string freeform = parameters[0];
174 std::string type = parameters[1];
175 std::string flags = parameters[2];
180 if ((type != "gline") && (type != "none") && (type != "block") && (type != "kill") && (type != "silent"))
182 user->WriteServ("NOTICE %s :*** Invalid filter type '%s'. Supported types are 'gline', 'none', 'block', 'silent' and 'kill'.", user->nick.c_str(), type.c_str());
188 if (parameters.size() >= 5)
190 duration = ServerInstance->Duration(parameters[3]);
191 reason = parameters[4];
195 this->TooFewParams(user, ": When setting a gline type filter, a gline duration must be specified as the third parameter.");
201 reason = parameters[3];
203 std::pair<bool, std::string> result = Base->AddFilter(freeform, type, reason, duration, flags);
206 user->WriteServ("NOTICE %s :*** Added filter '%s', type '%s'%s%s, flags '%s', reason: '%s'", user->nick.c_str(), freeform.c_str(),
207 type.c_str(), (duration ? ", duration " : ""), (duration ? parameters[3].c_str() : ""),
208 flags.c_str(), reason.c_str());
210 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);
216 user->WriteServ("NOTICE %s :*** Filter '%s' could not be added: %s", user->nick.c_str(), freeform.c_str(), result.second.c_str());
222 this->TooFewParams(user, ".");
229 bool FilterBase::AppliesToMe(User* user, FilterResult* filter, int iflags)
231 if ((filter->flag_no_opers) && IS_OPER(user))
233 if ((iflags & FLAG_PRIVMSG) && (!filter->flag_privmsg))
235 if ((iflags & FLAG_NOTICE) && (!filter->flag_notice))
237 if ((iflags & FLAG_QUIT) && (!filter->flag_quit_message))
239 if ((iflags & FLAG_PART) && (!filter->flag_part_message))
244 FilterBase::FilterBase(InspIRCd* Me, const std::string &source) : Module(Me), filtcommand(this, Me, source)
246 Me->Modules->UseInterface("RegularExpression");
247 ServerInstance->AddCommand(&filtcommand);
248 Implementation eventlist[] = { I_OnPreCommand, I_OnStats, I_OnSyncNetwork, I_OnDecodeMetaData, I_OnUserPreMessage, I_OnUserPreNotice, I_OnRehash, I_OnLoadModule };
249 ServerInstance->Modules->Attach(eventlist, this, 8);
252 FilterBase::~FilterBase()
254 ServerInstance->Modules->DoneWithInterface("RegularExpression");
257 ModResult FilterBase::OnUserPreMessage(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
260 return MOD_RES_PASSTHRU;
262 flags = FLAG_PRIVMSG;
263 return OnUserPreNotice(user,dest,target_type,text,status,exempt_list);
266 ModResult FilterBase::OnUserPreNotice(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
268 /* Leave ulines alone */
269 if ((ServerInstance->ULine(user->server)) || (!IS_LOCAL(user)))
270 return MOD_RES_PASSTHRU;
275 FilterResult* f = this->FilterMatch(user, text, flags);
278 std::string target = "";
279 if (target_type == TYPE_USER)
281 User* t = (User*)dest;
282 target = std::string(t->nick);
284 else if (target_type == TYPE_CHANNEL)
286 Channel* t = (Channel*)dest;
287 target = std::string(t->name);
288 std::vector<std::string>::iterator i = find(exemptfromfilter.begin(), exemptfromfilter.end(), target);
289 if (i != exemptfromfilter.end()) return MOD_RES_PASSTHRU;
291 if (f->action == "block")
293 ServerInstance->SNO->WriteGlobalSno('a', std::string("FILTER: ")+user->nick+" had their message filtered, target was "+target+": "+f->reason);
294 if (target_type == TYPE_CHANNEL)
295 user->WriteNumeric(404, "%s %s :Message to channel blocked and opers notified (%s)",user->nick.c_str(), target.c_str(), f->reason.c_str());
297 user->WriteServ("NOTICE "+std::string(user->nick)+" :Your message to "+target+" was blocked and opers notified: "+f->reason);
299 if (f->action == "silent")
301 if (target_type == TYPE_CHANNEL)
302 user->WriteNumeric(404, "%s %s :Message to channel blocked (%s)",user->nick.c_str(), target.c_str(), f->reason.c_str());
304 user->WriteServ("NOTICE "+std::string(user->nick)+" :Your message to "+target+" was blocked: "+f->reason);
306 if (f->action == "kill")
308 ServerInstance->Users->QuitUser(user, "Filtered: " + f->reason);
310 if (f->action == "gline")
312 GLine* gl = new GLine(ServerInstance, ServerInstance->Time(), f->gline_time, ServerInstance->Config->ServerName, f->reason.c_str(), "*", user->GetIPString());
313 if (ServerInstance->XLines->AddLine(gl,NULL))
315 ServerInstance->XLines->ApplyLines();
321 ServerInstance->Logs->Log("FILTER",DEFAULT,"FILTER: "+ user->nick + " had their message filtered, target was " + target + ": " + f->reason + " Action: " + f->action);
324 return MOD_RES_PASSTHRU;
327 ModResult FilterBase::OnPreCommand(std::string &command, std::vector<std::string> ¶meters, User *user, bool validated, const std::string &original_line)
330 if (validated && IS_LOCAL(user))
332 std::string checkline;
333 int replacepoint = 0;
334 bool parting = false;
336 if (command == "QUIT")
338 /* QUIT with no reason: nothing to do */
339 if (parameters.size() < 1)
340 return MOD_RES_PASSTHRU;
342 checkline = parameters[0];
347 else if (command == "PART")
349 /* PART with no reason: nothing to do */
350 if (parameters.size() < 2)
351 return MOD_RES_PASSTHRU;
353 std::vector<std::string>::iterator i = find(exemptfromfilter.begin(), exemptfromfilter.end(), parameters[0]);
354 if (i != exemptfromfilter.end()) return MOD_RES_PASSTHRU;
355 checkline = parameters[1];
361 /* We're only messing with PART and QUIT */
362 return MOD_RES_PASSTHRU;
364 FilterResult* f = NULL;
367 f = this->FilterMatch(user, checkline, flags);
370 /* PART or QUIT reason doesnt match a filter */
371 return MOD_RES_PASSTHRU;
373 /* We cant block a part or quit, so instead we change the reason to 'Reason filtered' */
374 Command* c = ServerInstance->Parser->GetHandler(command);
377 std::vector<std::string> params;
378 for (int item = 0; item < (int)parameters.size(); item++)
379 params.push_back(parameters[item]);
380 params[replacepoint] = "Reason filtered";
382 /* We're blocking, OR theyre quitting and its a KILL action
383 * (we cant kill someone whos already quitting, so filter them anyway)
385 if ((f->action == "block") || (((!parting) && (f->action == "kill"))) || (f->action == "silent"))
387 c->Handle(params, user);
392 /* Are they parting, if so, kill is applicable */
393 if ((parting) && (f->action == "kill"))
395 user->WriteServ("NOTICE %s :*** Your PART message was filtered: %s", user->nick.c_str(), f->reason.c_str());
396 ServerInstance->Users->QuitUser(user, "Filtered: " + f->reason);
398 if (f->action == "gline")
400 /* Note: We gline *@IP so that if their host doesnt resolve the gline still applies. */
401 GLine* gl = new GLine(ServerInstance, ServerInstance->Time(), f->gline_time, ServerInstance->Config->ServerName, f->reason.c_str(), "*", user->GetIPString());
402 if (ServerInstance->XLines->AddLine(gl,NULL))
404 ServerInstance->XLines->ApplyLines();
412 return MOD_RES_PASSTHRU;
414 return MOD_RES_PASSTHRU;
417 void FilterBase::OnRehash(User* user)
419 ConfigReader MyConf(ServerInstance);
420 std::vector<std::string>().swap(exemptfromfilter);
421 for (int index = 0; index < MyConf.Enumerate("exemptfromfilter"); ++index)
423 std::string chan = MyConf.ReadValue("exemptfromfilter", "channel", index);
425 exemptfromfilter.push_back(chan);
428 std::string newrxengine = MyConf.ReadValue("filteropts", "engine", 0);
429 if (!RegexEngine.empty())
431 if (RegexEngine == newrxengine)
434 ServerInstance->SNO->WriteGlobalSno('a', "Dumping all filters due to regex engine change (was '%s', now '%s')", RegexEngine.c_str(), newrxengine.c_str());
435 //ServerInstance->XLines->DelAll("R");
439 RegexEngine = newrxengine;
440 modulelist* ml = ServerInstance->Modules->FindInterface("RegularExpression");
443 for (modulelist::iterator i = ml->begin(); i != ml->end(); ++i)
445 if (RegexNameRequest(this, *i).Send() == newrxengine)
447 ServerInstance->SNO->WriteGlobalSno('a', "Filter now using engine '%s'", RegexEngine.c_str());
454 ServerInstance->SNO->WriteGlobalSno('a', "WARNING: Regex engine '%s' is not loaded - Filter functionality disabled until this is corrected.", RegexEngine.c_str());
458 void FilterBase::OnLoadModule(Module* mod, const std::string& name)
460 if (ServerInstance->Modules->ModuleHasInterface(mod, "RegularExpression"))
462 std::string rxname = RegexNameRequest(this, mod).Send();
463 if (rxname == RegexEngine)
466 /* Force a rehash to make sure that any filters that couldnt be applied from the conf
467 * on startup or on load are applied right now.
469 ConfigReader Config(ServerInstance);
470 ServerInstance->SNO->WriteGlobalSno('a', "Found and activated regex module '%s' for m_filter.so.", RegexEngine.c_str());
477 Version FilterBase::GetVersion()
479 return Version("$Id$", VF_VENDOR | VF_COMMON, API_VERSION);
483 std::string FilterBase::EncodeFilter(FilterResult* filter)
485 std::ostringstream stream;
486 std::string x = filter->freeform;
488 /* Hax to allow spaces in the freeform without changing the design of the irc protocol */
489 for (std::string::iterator n = x.begin(); n != x.end(); n++)
493 stream << x << " " << filter->action << " " << (filter->flags.empty() ? "-" : filter->flags) << " " << filter->gline_time << " :" << filter->reason;
497 FilterResult FilterBase::DecodeFilter(const std::string &data)
500 irc::tokenstream tokens(data);
501 tokens.GetToken(res.freeform);
502 tokens.GetToken(res.action);
503 tokens.GetToken(res.flags);
504 if (res.flags == "-")
506 res.FillFlags(res.flags);
507 tokens.GetToken(res.gline_time);
508 tokens.GetToken(res.reason);
510 /* Hax to allow spaces in the freeform without changing the design of the irc protocol */
511 for (std::string::iterator n = res.freeform.begin(); n != res.freeform.end(); n++)
518 void FilterBase::OnSyncNetwork(Module* proto, void* opaque)
520 this->SyncFilters(proto, opaque);
523 void FilterBase::SendFilter(Module* proto, void* opaque, FilterResult* iter)
525 proto->ProtoSendMetaData(opaque, NULL, "filter", EncodeFilter(iter));
528 void FilterBase::OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata)
530 if ((target == NULL) && (extname == "filter"))
532 FilterResult data = DecodeFilter(extdata);
533 this->AddFilter(data.freeform, data.action, data.reason, data.gline_time, data.flags);
537 class ImplFilter : public FilterResult
542 ImplFilter(Module* mymodule, const std::string &rea, const std::string &act, long glinetime, const std::string &pat, const std::string &flgs)
543 : FilterResult(pat, rea, act, glinetime, flgs)
546 throw ModuleException("Regex module implementing '"+RegexEngine+"' is not loaded!");
548 regex = RegexFactoryRequest(mymodule, rxengine, pat).Create();
556 class ModuleFilter : public FilterBase
558 std::vector<ImplFilter> filters;
564 ModuleFilter(InspIRCd* Me)
565 : FilterBase(Me, "m_filter.so")
570 virtual ~ModuleFilter()
574 virtual FilterResult* FilterMatch(User* user, const std::string &text, int flgs)
576 for (std::vector<ImplFilter>::iterator index = filters.begin(); index != filters.end(); index++)
578 /* Skip ones that dont apply to us */
579 if (!FilterBase::AppliesToMe(user, dynamic_cast<FilterResult*>(&(*index)), flgs))
582 //ServerInstance->Logs->Log("m_filter", DEBUG, "Match '%s' against '%s'", text.c_str(), index->freeform.c_str());
583 if (index->regex->Matches(text))
585 //ServerInstance->Logs->Log("m_filter", DEBUG, "MATCH");
587 if (index != filters.begin())
589 /* Move to head of list for efficiency */
590 filters.erase(index);
591 filters.insert(filters.begin(), fr);
595 //ServerInstance->Logs->Log("m_filter", DEBUG, "NO MATCH");
600 virtual bool DeleteFilter(const std::string &freeform)
602 for (std::vector<ImplFilter>::iterator i = filters.begin(); i != filters.end(); i++)
604 if (i->freeform == freeform)
614 virtual void SyncFilters(Module* proto, void* opaque)
616 for (std::vector<ImplFilter>::iterator i = filters.begin(); i != filters.end(); i++)
618 this->SendFilter(proto, opaque, &(*i));
622 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)
624 for (std::vector<ImplFilter>::iterator i = filters.begin(); i != filters.end(); i++)
626 if (i->freeform == freeform)
628 return std::make_pair(false, "Filter already exists");
634 filters.push_back(ImplFilter(this, reason, type, duration, freeform, flgs));
636 catch (ModuleException &e)
638 ServerInstance->Logs->Log("m_filter", DEFAULT, "Error in regular expression '%s': %s", freeform.c_str(), e.GetReason());
639 return std::make_pair(false, e.GetReason());
641 return std::make_pair(true, "");
644 virtual void OnRehash(User* user)
646 ConfigReader MyConf(ServerInstance);
647 FilterBase::OnRehash(user);
651 void ReadFilters(ConfigReader &MyConf)
653 for (int index = 0; index < MyConf.Enumerate("keyword"); index++)
655 this->DeleteFilter(MyConf.ReadValue("keyword", "pattern", index));
657 std::string pattern = MyConf.ReadValue("keyword", "pattern", index);
658 std::string reason = MyConf.ReadValue("keyword", "reason", index);
659 std::string action = MyConf.ReadValue("keyword", "action", index);
660 std::string flgs = MyConf.ReadValue("keyword", "flags", index);
661 long gline_time = ServerInstance->Duration(MyConf.ReadValue("keyword", "duration", index));
669 filters.push_back(ImplFilter(this, reason, action, gline_time, pattern, flgs));
670 ServerInstance->Logs->Log("m_filter", DEFAULT, "Regular expression %s loaded.", pattern.c_str());
672 catch (ModuleException &e)
674 ServerInstance->Logs->Log("m_filter", DEFAULT, "Error in regular expression '%s': %s", pattern.c_str(), e.GetReason());
679 virtual ModResult OnStats(char symbol, User* user, string_list &results)
683 std::string sn = ServerInstance->Config->ServerName;
684 for (std::vector<ImplFilter>::iterator i = filters.begin(); i != filters.end(); i++)
686 results.push_back(sn+" 223 "+user->nick+" :"+RegexEngine+":"+i->freeform+" "+i->flags+" "+i->action+" "+ConvToStr(i->gline_time)+" :"+i->reason);
688 for (std::vector<std::string>::iterator i = exemptfromfilter.begin(); i != exemptfromfilter.end(); ++i)
690 results.push_back(sn+" 223 "+user->nick+" :EXEMPT "+(*i));
693 return MOD_RES_PASSTHRU;
697 MODULE_INIT(ModuleFilter)