2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2004, 2008 Craig Edwards <craigedwards@brainbox.cc>
6 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
7 * Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
9 * This file is part of InspIRCd. InspIRCd is free software: you can
10 * redistribute it and/or modify it under the terms of the GNU General Public
11 * License as published by the Free Software Foundation, version 2.
13 * This program is distributed in the hope that it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
27 /* $ModDesc: Text (spam) filtering */
57 bool flag_part_message;
58 bool flag_quit_message;
61 bool flag_strip_color;
63 FilterResult(const std::string free, const std::string &rea, FilterAction act, long gt, const std::string &fla) :
64 freeform(free), reason(rea), action(act), gline_time(gt)
69 char FillFlags(const std::string &fl)
71 flag_no_opers = flag_part_message = flag_quit_message = flag_privmsg =
72 flag_notice = flag_strip_color = false;
74 for (std::string::const_iterator n = fl.begin(); n != fl.end(); ++n)
82 flag_part_message = true;
85 flag_quit_message = true;
94 flag_strip_color = true;
97 flag_no_opers = flag_part_message = flag_quit_message =
98 flag_privmsg = flag_notice = flag_strip_color = true;
108 std::string GetFlags()
112 flags.push_back('o');
113 if (flag_part_message)
114 flags.push_back('P');
115 if (flag_quit_message)
116 flags.push_back('q');
118 flags.push_back('p');
120 flags.push_back('n');
122 /* Order is important here, 'c' must be the last char in the string as it is unsupported
123 * on < 2.0.10, and the logic in FillFlags() stops parsing when it ecounters an unknown
126 if (flag_strip_color)
127 flags.push_back('c');
130 flags.push_back('-');
140 class CommandFilter : public Command
143 CommandFilter(Module* f)
144 : Command(f, "FILTER", 1, 5)
147 this->syntax = "<filter-definition> <action> <flags> [<gline-duration>] :<reason>";
149 CmdResult Handle(const std::vector<std::string>&, User*);
151 RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
153 return ROUTE_BROADCAST;
157 class ImplFilter : public FilterResult
162 ImplFilter(ModuleFilter* mymodule, const std::string &rea, FilterAction act, long glinetime, const std::string &pat, const std::string &flgs);
166 class ModuleFilter : public Module
169 RegexFactory* factory;
173 CommandFilter filtcommand;
174 dynamic_reference<RegexFactory> RegexEngine;
176 std::vector<ImplFilter> filters;
179 std::set<std::string> exemptfromfilter; // List of channel names excluded from filtering.
184 ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list);
185 FilterResult* FilterMatch(User* user, const std::string &text, int flags);
186 bool DeleteFilter(const std::string &freeform);
187 std::pair<bool, std::string> AddFilter(const std::string &freeform, FilterAction type, const std::string &reason, long duration, const std::string &flags);
188 ModResult OnUserPreNotice(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list);
189 void OnRehash(User* user);
190 Version GetVersion();
191 std::string EncodeFilter(FilterResult* filter);
192 FilterResult DecodeFilter(const std::string &data);
193 void OnSyncNetwork(Module* proto, void* opaque);
194 void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
195 ModResult OnStats(char symbol, User* user, string_list &results);
196 ModResult OnPreCommand(std::string &command, std::vector<std::string> ¶meters, LocalUser *user, bool validated, const std::string &original_line);
197 void OnUnloadModule(Module* mod);
198 bool AppliesToMe(User* user, FilterResult* filter, int flags);
200 static bool StringToFilterAction(const std::string& str, FilterAction& fa);
201 static std::string FilterActionToString(FilterAction fa);
204 CmdResult CommandFilter::Handle(const std::vector<std::string> ¶meters, User *user)
206 if (parameters.size() == 1)
208 /* Deleting a filter */
209 Module *me = creator;
210 if (static_cast<ModuleFilter *>(me)->DeleteFilter(parameters[0]))
212 user->WriteServ("NOTICE %s :*** Removed filter '%s'", user->nick.c_str(), parameters[0].c_str());
213 ServerInstance->SNO->WriteToSnoMask(IS_LOCAL(user) ? 'a' : 'A', "FILTER: "+user->nick+" removed filter '"+parameters[0]+"'");
218 user->WriteServ("NOTICE %s :*** Filter '%s' not found in list, try /stats s.", user->nick.c_str(), parameters[0].c_str());
224 /* Adding a filter */
225 if (parameters.size() >= 4)
227 const std::string& freeform = parameters[0];
229 const std::string& flags = parameters[2];
230 unsigned int reasonindex;
233 if (!ModuleFilter::StringToFilterAction(parameters[1], type))
235 user->WriteServ("NOTICE %s :*** Invalid filter type '%s'. Supported types are 'gline', 'none', 'block', 'silent' and 'kill'.", user->nick.c_str(), parameters[1].c_str());
239 if (type == FA_GLINE)
241 if (parameters.size() >= 5)
243 duration = ServerInstance->Duration(parameters[3]);
248 user->WriteServ("NOTICE %s :*** Not enough parameters: When setting a gline type filter, a gline duration must be specified as the third parameter.", user->nick.c_str());
257 Module *me = creator;
258 std::pair<bool, std::string> result = static_cast<ModuleFilter *>(me)->AddFilter(freeform, type, parameters[reasonindex], duration, flags);
261 user->WriteServ("NOTICE %s :*** Added filter '%s', type '%s'%s%s, flags '%s', reason: '%s'", user->nick.c_str(), freeform.c_str(),
262 parameters[1].c_str(), (duration ? ", duration " : ""), (duration ? parameters[3].c_str() : ""),
263 flags.c_str(), parameters[reasonindex].c_str());
265 ServerInstance->SNO->WriteToSnoMask(IS_LOCAL(user) ? 'a' : 'A', "FILTER: "+user->nick+" added filter '"+freeform+"', type '"+parameters[1]+"', "+(duration ? "duration "+parameters[3]+", " : "")+"flags '"+flags+"', reason: "+parameters[reasonindex]);
271 user->WriteServ("NOTICE %s :*** Filter '%s' could not be added: %s", user->nick.c_str(), freeform.c_str(), result.second.c_str());
277 user->WriteServ("NOTICE %s :*** Not enough parameters.", user->nick.c_str());
284 bool ModuleFilter::AppliesToMe(User* user, FilterResult* filter, int iflags)
286 if ((filter->flag_no_opers) && IS_OPER(user))
288 if ((iflags & FLAG_PRIVMSG) && (!filter->flag_privmsg))
290 if ((iflags & FLAG_NOTICE) && (!filter->flag_notice))
292 if ((iflags & FLAG_QUIT) && (!filter->flag_quit_message))
294 if ((iflags & FLAG_PART) && (!filter->flag_part_message))
299 ModuleFilter::ModuleFilter()
300 : initing(true), filtcommand(this), RegexEngine(this, "regex")
304 void ModuleFilter::init()
306 ServerInstance->Modules->AddService(filtcommand);
307 Implementation eventlist[] = { I_OnPreCommand, I_OnStats, I_OnSyncNetwork, I_OnDecodeMetaData, I_OnUserPreMessage, I_OnUserPreNotice, I_OnRehash, I_OnUnloadModule };
308 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
312 CullResult ModuleFilter::cull()
315 return Module::cull();
318 void ModuleFilter::FreeFilters()
320 for (std::vector<ImplFilter>::const_iterator i = filters.begin(); i != filters.end(); ++i)
326 ModResult ModuleFilter::OnUserPreMessage(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
329 return MOD_RES_PASSTHRU;
331 flags = FLAG_PRIVMSG;
332 return OnUserPreNotice(user,dest,target_type,text,status,exempt_list);
335 ModResult ModuleFilter::OnUserPreNotice(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
337 /* Leave ulines alone */
338 if ((ServerInstance->ULine(user->server)) || (!IS_LOCAL(user)))
339 return MOD_RES_PASSTHRU;
344 FilterResult* f = this->FilterMatch(user, text, flags);
348 if (target_type == TYPE_USER)
350 User* t = (User*)dest;
353 else if (target_type == TYPE_CHANNEL)
355 Channel* t = (Channel*)dest;
356 if (exemptfromfilter.find(t->name) != exemptfromfilter.end())
357 return MOD_RES_PASSTHRU;
361 if (f->action == FA_BLOCK)
363 ServerInstance->SNO->WriteGlobalSno('a', "FILTER: "+user->nick+" had their message filtered, target was "+target+": "+f->reason);
364 if (target_type == TYPE_CHANNEL)
365 user->WriteNumeric(404, "%s %s :Message to channel blocked and opers notified (%s)",user->nick.c_str(), target.c_str(), f->reason.c_str());
367 user->WriteServ("NOTICE "+user->nick+" :Your message to "+target+" was blocked and opers notified: "+f->reason);
369 else if (f->action == FA_SILENT)
371 if (target_type == TYPE_CHANNEL)
372 user->WriteNumeric(404, "%s %s :Message to channel blocked (%s)",user->nick.c_str(), target.c_str(), f->reason.c_str());
374 user->WriteServ("NOTICE "+user->nick+" :Your message to "+target+" was blocked: "+f->reason);
376 else if (f->action == FA_KILL)
378 ServerInstance->Users->QuitUser(user, "Filtered: " + f->reason);
380 else if (f->action == FA_GLINE)
382 GLine* gl = new GLine(ServerInstance->Time(), f->gline_time, ServerInstance->Config->ServerName.c_str(), f->reason.c_str(), "*", user->GetIPString());
383 if (ServerInstance->XLines->AddLine(gl,NULL))
385 ServerInstance->XLines->ApplyLines();
391 ServerInstance->Logs->Log("FILTER",DEFAULT,"FILTER: "+ user->nick + " had their message filtered, target was " + target + ": " + f->reason + " Action: " + ModuleFilter::FilterActionToString(f->action));
394 return MOD_RES_PASSTHRU;
397 ModResult ModuleFilter::OnPreCommand(std::string &command, std::vector<std::string> ¶meters, LocalUser *user, bool validated, const std::string &original_line)
399 if (validated && IS_LOCAL(user))
404 if (command == "QUIT")
406 /* QUIT with no reason: nothing to do */
407 if (parameters.size() < 1)
408 return MOD_RES_PASSTHRU;
413 else if (command == "PART")
415 /* PART with no reason: nothing to do */
416 if (parameters.size() < 2)
417 return MOD_RES_PASSTHRU;
419 if (exemptfromfilter.find(parameters[0]) != exemptfromfilter.end())
420 return MOD_RES_PASSTHRU;
426 /* We're only messing with PART and QUIT */
427 return MOD_RES_PASSTHRU;
429 FilterResult* f = this->FilterMatch(user, parameters[parting ? 1 : 0], flags);
431 /* PART or QUIT reason doesnt match a filter */
432 return MOD_RES_PASSTHRU;
434 /* We cant block a part or quit, so instead we change the reason to 'Reason filtered' */
435 parameters[parting ? 1 : 0] = "Reason filtered";
437 /* We're blocking, OR theyre quitting and its a KILL action
438 * (we cant kill someone whos already quitting, so filter them anyway)
440 if ((f->action == FA_BLOCK) || (((!parting) && (f->action == FA_KILL))) || (f->action == FA_SILENT))
442 return MOD_RES_PASSTHRU;
446 /* Are they parting, if so, kill is applicable */
447 if ((parting) && (f->action == FA_KILL))
449 user->WriteServ("NOTICE %s :*** Your PART message was filtered: %s", user->nick.c_str(), f->reason.c_str());
450 ServerInstance->Users->QuitUser(user, "Filtered: " + f->reason);
452 if (f->action == FA_GLINE)
454 /* Note: We gline *@IP so that if their host doesnt resolve the gline still applies. */
455 GLine* gl = new GLine(ServerInstance->Time(), f->gline_time, ServerInstance->Config->ServerName.c_str(), f->reason.c_str(), "*", user->GetIPString());
456 if (ServerInstance->XLines->AddLine(gl,NULL))
458 ServerInstance->XLines->ApplyLines();
466 return MOD_RES_PASSTHRU;
469 void ModuleFilter::OnRehash(User* user)
471 ConfigTagList tags = ServerInstance->Config->ConfTags("exemptfromfilter");
472 exemptfromfilter.clear();
473 for (ConfigIter i = tags.first; i != tags.second; ++i)
475 std::string chan = i->second->getString("channel");
477 exemptfromfilter.insert(chan);
480 std::string newrxengine = ServerInstance->Config->ConfValue("filteropts")->getString("engine");
482 factory = RegexEngine ? (RegexEngine.operator->()) : NULL;
484 if (newrxengine.empty())
485 RegexEngine.SetProvider("regex");
487 RegexEngine.SetProvider("regex/" + newrxengine);
491 if (newrxengine.empty())
492 ServerInstance->SNO->WriteGlobalSno('a', "WARNING: No regex engine loaded - Filter functionality disabled until this is corrected.");
494 ServerInstance->SNO->WriteGlobalSno('a', "WARNING: Regex engine '%s' is not loaded - Filter functionality disabled until this is corrected.", newrxengine.c_str());
501 if ((!initing) && (RegexEngine.operator->() != factory))
503 ServerInstance->SNO->WriteGlobalSno('a', "Dumping all filters due to regex engine change");
511 Version ModuleFilter::GetVersion()
513 return Version("Text (spam) filtering", VF_VENDOR | VF_COMMON, RegexEngine ? RegexEngine->name : "");
516 std::string ModuleFilter::EncodeFilter(FilterResult* filter)
518 std::ostringstream stream;
519 std::string x = filter->freeform;
521 /* Hax to allow spaces in the freeform without changing the design of the irc protocol */
522 for (std::string::iterator n = x.begin(); n != x.end(); n++)
526 stream << x << " " << FilterActionToString(filter->action) << " " << filter->GetFlags() << " " << filter->gline_time << " :" << filter->reason;
530 FilterResult ModuleFilter::DecodeFilter(const std::string &data)
532 std::string filteraction;
534 irc::tokenstream tokens(data);
535 tokens.GetToken(res.freeform);
536 tokens.GetToken(filteraction);
537 if (!StringToFilterAction(filteraction, res.action))
538 throw ModuleException("Invalid action: " + filteraction);
540 std::string filterflags;
541 tokens.GetToken(filterflags);
542 char c = res.FillFlags(filterflags);
544 throw ModuleException("Invalid flag: '" + std::string(1, c) + "'");
546 tokens.GetToken(res.gline_time);
547 tokens.GetToken(res.reason);
549 /* Hax to allow spaces in the freeform without changing the design of the irc protocol */
550 for (std::string::iterator n = res.freeform.begin(); n != res.freeform.end(); n++)
557 void ModuleFilter::OnSyncNetwork(Module* proto, void* opaque)
559 for (std::vector<ImplFilter>::iterator i = filters.begin(); i != filters.end(); ++i)
561 proto->ProtoSendMetaData(opaque, NULL, "filter", EncodeFilter(&(*i)));
565 void ModuleFilter::OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata)
567 if ((target == NULL) && (extname == "filter"))
571 FilterResult data = DecodeFilter(extdata);
572 this->AddFilter(data.freeform, data.action, data.reason, data.gline_time, data.GetFlags());
574 catch (ModuleException& e)
576 ServerInstance->Logs->Log("m_filter", DEBUG, "Error when unserializing filter: " + std::string(e.GetReason()));
581 ImplFilter::ImplFilter(ModuleFilter* mymodule, const std::string &rea, FilterAction act, long glinetime, const std::string &pat, const std::string &flgs)
582 : FilterResult(pat, rea, act, glinetime, flgs)
584 if (!mymodule->RegexEngine)
585 throw ModuleException("Regex module implementing '"+mymodule->RegexEngine.GetProvider()+"' is not loaded!");
586 regex = mymodule->RegexEngine->Create(pat);
589 FilterResult* ModuleFilter::FilterMatch(User* user, const std::string &text, int flgs)
591 static std::string stripped_text;
592 stripped_text.clear();
594 for (std::vector<ImplFilter>::iterator index = filters.begin(); index != filters.end(); index++)
596 FilterResult* filter = dynamic_cast<FilterResult*>(&(*index));
598 /* Skip ones that dont apply to us */
599 if (!AppliesToMe(user, filter, flgs))
602 if ((filter->flag_strip_color) && (stripped_text.empty()))
604 stripped_text = text;
605 InspIRCd::StripColor(stripped_text);
608 //ServerInstance->Logs->Log("m_filter", DEBUG, "Match '%s' against '%s'", text.c_str(), index->freeform.c_str());
609 if (index->regex->Matches(filter->flag_strip_color ? stripped_text : text))
611 //ServerInstance->Logs->Log("m_filter", DEBUG, "MATCH");
614 //ServerInstance->Logs->Log("m_filter", DEBUG, "NO MATCH");
619 bool ModuleFilter::DeleteFilter(const std::string &freeform)
621 for (std::vector<ImplFilter>::iterator i = filters.begin(); i != filters.end(); i++)
623 if (i->freeform == freeform)
633 std::pair<bool, std::string> ModuleFilter::AddFilter(const std::string &freeform, FilterAction type, const std::string &reason, long duration, const std::string &flgs)
635 for (std::vector<ImplFilter>::iterator i = filters.begin(); i != filters.end(); i++)
637 if (i->freeform == freeform)
639 return std::make_pair(false, "Filter already exists");
645 filters.push_back(ImplFilter(this, reason, type, duration, freeform, flgs));
647 catch (ModuleException &e)
649 ServerInstance->Logs->Log("m_filter", DEFAULT, "Error in regular expression '%s': %s", freeform.c_str(), e.GetReason());
650 return std::make_pair(false, e.GetReason());
652 return std::make_pair(true, "");
655 bool ModuleFilter::StringToFilterAction(const std::string& str, FilterAction& fa)
657 irc::string s(str.c_str());
661 else if (s == "block")
663 else if (s == "silent")
665 else if (s == "kill")
667 else if (s == "none")
675 std::string ModuleFilter::FilterActionToString(FilterAction fa)
679 case FA_GLINE: return "gline";
680 case FA_BLOCK: return "block";
681 case FA_SILENT: return "silent";
682 case FA_KILL: return "kill";
683 default: return "none";
687 void ModuleFilter::ReadFilters()
689 ConfigTagList tags = ServerInstance->Config->ConfTags("keyword");
690 for (ConfigIter i = tags.first; i != tags.second; ++i)
692 std::string pattern = i->second->getString("pattern");
693 this->DeleteFilter(pattern);
695 std::string reason = i->second->getString("reason");
696 std::string action = i->second->getString("action");
697 std::string flgs = i->second->getString("flags");
698 long gline_time = ServerInstance->Duration(i->second->getString("duration"));
703 if (!StringToFilterAction(action, fa))
708 filters.push_back(ImplFilter(this, reason, fa, gline_time, pattern, flgs));
709 ServerInstance->Logs->Log("m_filter", DEFAULT, "Regular expression %s loaded.", pattern.c_str());
711 catch (ModuleException &e)
713 ServerInstance->Logs->Log("m_filter", DEFAULT, "Error in regular expression '%s': %s", pattern.c_str(), e.GetReason());
718 ModResult ModuleFilter::OnStats(char symbol, User* user, string_list &results)
722 for (std::vector<ImplFilter>::iterator i = filters.begin(); i != filters.end(); i++)
724 results.push_back(ServerInstance->Config->ServerName+" 223 "+user->nick+" :"+RegexEngine.GetProvider()+":"+i->freeform+" "+i->GetFlags()+" "+FilterActionToString(i->action)+" "+ConvToStr(i->gline_time)+" :"+i->reason);
726 for (std::set<std::string>::iterator i = exemptfromfilter.begin(); i != exemptfromfilter.end(); ++i)
728 results.push_back(ServerInstance->Config->ServerName+" 223 "+user->nick+" :EXEMPT "+(*i));
731 return MOD_RES_PASSTHRU;
734 void ModuleFilter::OnUnloadModule(Module* mod)
736 // If the regex engine became unavailable or has changed, remove all filters
741 else if (RegexEngine.operator->() != factory)
743 factory = RegexEngine.operator->();
748 MODULE_INIT(ModuleFilter)